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-18 12:00+0200\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
22 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
23 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
24 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31
25 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
37 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
38 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
39 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
40 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35
41 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
56 #: ../src/guestfs.pod:11
59 " guestfs_h *g = guestfs_create ();\n"
60 " guestfs_add_drive (g, \"guest.img\");\n"
61 " guestfs_launch (g);\n"
62 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
63 " guestfs_touch (g, \"/hello\");\n"
64 " guestfs_umount (g, \"/\");\n"
65 " guestfs_close (g);\n"
71 #: ../src/guestfs.pod:19
74 " cc prog.c -o prog -lguestfs\n"
76 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
82 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
83 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
84 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
85 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77
86 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
92 #: ../src/guestfs.pod:25
94 "Libguestfs is a library for accessing and modifying guest disk images. "
95 "Amongst the things this is good for: making batch configuration changes to "
96 "guests, getting disk used/free statistics (see also: virt-df), migrating "
97 "between virtualization systems (see also: virt-p2v), performing partial "
98 "backups, performing partial guest clones, cloning guests and changing "
99 "registry/UUID/hostname info, and much else besides."
104 #: ../src/guestfs.pod:33
106 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
107 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
108 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
114 #: ../src/guestfs.pod:38
116 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
117 "what filesystem is in each LV, etc.). It can also run commands in the "
118 "context of the guest. Also you can access filesystems over FUSE."
123 #: ../src/guestfs.pod:43
125 "Libguestfs is a library that can be linked with C and C++ management "
126 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
127 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
133 #: ../src/guestfs.pod:48
135 "You don't need to be root to use libguestfs, although obviously you do need "
136 "enough permissions to access the disk images."
141 #: ../src/guestfs.pod:51
143 "Libguestfs is a large API because it can do many things. For a gentle "
144 "introduction, please read the L</API OVERVIEW> section next."
149 #: ../src/guestfs.pod:54
151 "There are also some example programs in the L<guestfs-examples(3)> manual "
157 #: ../src/guestfs.pod:57
163 #: ../src/guestfs.pod:59
165 "This section provides a gentler overview of the libguestfs API. We also try "
166 "to group API calls together, where that may not be obvious from reading "
167 "about the individual calls in the main section of this manual."
172 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
189 #: ../src/guestfs.pod:73
190 msgid "The general structure of all libguestfs-using programs looks like this:"
195 #: ../src/guestfs.pod:76
198 " guestfs_h *g = guestfs_create ();\n"
204 #: ../src/guestfs.pod:78
207 " /* Call guestfs_add_drive additional times if there are\n"
208 " * multiple disk images.\n"
210 " guestfs_add_drive (g, \"guest.img\");\n"
216 #: ../src/guestfs.pod:83
219 " /* Most manipulation calls won't work until you've launched\n"
220 " * the handle 'g'. You have to do this _after_ adding drives\n"
221 " * and _before_ other commands.\n"
223 " guestfs_launch (g);\n"
229 #: ../src/guestfs.pod:89
232 " /* Now you can examine what partitions, LVs etc are available.\n"
234 " char **partitions = guestfs_list_partitions (g);\n"
235 " char **logvols = guestfs_lvs (g);\n"
241 #: ../src/guestfs.pod:94
244 " /* To access a filesystem in the image, you must mount it.\n"
246 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 " /* Now you can perform filesystem actions on the guest\n"
257 " guestfs_touch (g, \"/hello\");\n"
263 #: ../src/guestfs.pod:103
266 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
267 " * it is done automatically when you close the handle. See\n"
268 " * discussion of autosync in this page.\n"
270 " guestfs_sync (g);\n"
276 #: ../src/guestfs.pod:109
279 " /* Close the handle 'g'. */\n"
280 " guestfs_close (g);\n"
286 #: ../src/guestfs.pod:112
288 "The code above doesn't include any error checking. In real code you should "
289 "check return values carefully for errors. In general all functions that "
290 "return integers return C<-1> on error, and all functions that return "
291 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
292 "how to handle errors, and consult the documentation for each function call "
293 "below to see precisely how they return error indications. See L<guestfs-"
294 "examples(3)> for fully worked examples."
299 #: ../src/guestfs.pod:121
305 #: ../src/guestfs.pod:123
307 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
308 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
309 "actual block device, or simply an empty file of zeroes that you have created "
310 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
316 #: ../src/guestfs.pod:129
318 "The call you should use in modern code for adding drives is L</"
319 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
320 "specifying that the format is raw, do:"
325 #: ../src/guestfs.pod:133
328 " guestfs_add_drive_opts (g, filename,\n"
329 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
336 #: ../src/guestfs.pod:137
337 msgid "You can add a disk read-only using:"
342 #: ../src/guestfs.pod:139
345 " guestfs_add_drive_opts (g, filename,\n"
346 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
347 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
354 #: ../src/guestfs.pod:144
356 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
357 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
371 #: ../src/guestfs.pod:151
373 "You must add at least one disk image, and you may add multiple disk images. "
374 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
375 "first one you added), C</dev/sdb> (for the second one you added), etc."
380 #: ../src/guestfs.pod:156
382 "Once L</guestfs_launch> has been called you cannot add any more images. You "
383 "can call L</guestfs_list_devices> to get a list of the device names, in the "
384 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
389 #: ../src/guestfs.pod:161
394 #: ../src/guestfs.pod:163
396 "Before you can read or write files, create directories and so on in a disk "
397 "image that contains filesystems, you have to mount those filesystems using "
398 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
399 "a disk image contains (for example) one partition with a filesystem on that "
400 "partition, then you can mount it directly:"
404 #: ../src/guestfs.pod:170
407 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
412 #: ../src/guestfs.pod:172
414 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
415 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
416 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
417 "that these are libguestfs virtual devices, and are nothing to do with host "
422 #: ../src/guestfs.pod:178
424 "If you are given a disk image and you don't know what it contains then you "
425 "have to find out. Libguestfs can do that too: use L</"
426 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
427 "LVs, and either try mounting each to see what is mountable, or else examine "
428 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
429 "filesystems, use L</guestfs_list_filesystems>."
433 #: ../src/guestfs.pod:186
435 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
436 "L</INSPECTION> below). But you might find it easier to look at higher level "
437 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
441 #: ../src/guestfs.pod:191
443 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
444 "several other variations of the C<guestfs_mount_*> call."
449 #: ../src/guestfs.pod:194
450 msgid "FILESYSTEM ACCESS AND MODIFICATION"
455 #: ../src/guestfs.pod:196
457 "The majority of the libguestfs API consists of fairly low-level calls for "
458 "accessing and modifying the files, directories, symlinks etc on mounted "
459 "filesystems. There are over a hundred such calls which you can find listed "
460 "in detail below in this man page, and we don't even pretend to cover them "
461 "all in this overview."
466 #: ../src/guestfs.pod:202
468 "Specify filenames as full paths, starting with C<\"/\"> and including the "
474 #: ../src/guestfs.pod:205
476 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
477 "the file called C<\"etc/passwd\"> then you could do:"
482 #: ../src/guestfs.pod:208
485 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
491 #: ../src/guestfs.pod:210
493 "This would return C<data> as a newly allocated buffer containing the full "
494 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
495 "or C<NULL> if there was an error."
500 #: ../src/guestfs.pod:214
502 "As another example, to create a top-level directory on that filesystem "
503 "called C<\"var\"> you would do:"
508 #: ../src/guestfs.pod:217
511 " guestfs_mkdir (g, \"/var\");\n"
517 #: ../src/guestfs.pod:219
518 msgid "To create a symlink you could do:"
523 #: ../src/guestfs.pod:221
526 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
527 " \"/etc/rc3.d/S30portmap\");\n"
533 #: ../src/guestfs.pod:224
535 "Libguestfs will reject attempts to use relative paths and there is no "
536 "concept of a current working directory."
541 #: ../src/guestfs.pod:227
543 "Libguestfs can return errors in many situations: for example if the "
544 "filesystem isn't writable, or if a file or directory that you requested "
545 "doesn't exist. If you are using the C API (documented here) you have to "
546 "check for those error conditions after each call. (Other language bindings "
547 "turn these errors into exceptions)."
552 #: ../src/guestfs.pod:233
554 "File writes are affected by the per-handle umask, set by calling L</"
555 "guestfs_umask> and defaulting to 022. See L</UMASK>."
560 #: ../src/guestfs.pod:236
566 #: ../src/guestfs.pod:238
568 "Libguestfs contains API calls to read, create and modify partition tables on "
574 #: ../src/guestfs.pod:241
576 "In the common case where you want to create a single partition covering the "
577 "whole disk, you should use the L</guestfs_part_disk> call:"
582 #: ../src/guestfs.pod:245
585 " const char *parttype = \"mbr\";\n"
586 " if (disk_is_larger_than_2TB)\n"
587 " parttype = \"gpt\";\n"
588 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
594 #: ../src/guestfs.pod:250
596 "Obviously this effectively wipes anything that was on that disk image before."
601 #: ../src/guestfs.pod:253
607 #: ../src/guestfs.pod:255
609 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
610 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
611 "you familiarize yourself with the concepts of physical volumes, volume "
612 "groups and logical volumes."
617 #: ../src/guestfs.pod:260
619 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
620 "tldp.org/HOWTO/LVM-HOWTO/>."
625 #: ../src/guestfs.pod:263
630 #: ../src/guestfs.pod:265
632 "Use L</guestfs_cat> to download small, text only files. This call is "
633 "limited to files which are less than 2 MB and which cannot contain any ASCII "
634 "NUL (C<\\0>) characters. However the API is very simple to use."
639 #: ../src/guestfs.pod:269
641 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
642 "bit data, since it returns a (pointer, size) pair. However it is still "
643 "limited to \"small\" files, less than 2 MB."
648 #: ../src/guestfs.pod:273
650 "L</guestfs_download> can be used to download any file, with no limits on "
651 "content or size (even files larger than 4 GB)."
656 #: ../src/guestfs.pod:276
658 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
663 #: ../src/guestfs.pod:279
669 #: ../src/guestfs.pod:281
671 "It's often the case that you want to write a file or files to the disk image."
676 #: ../src/guestfs.pod:284
678 "To write a small file with fixed content, use L</guestfs_write>. To create "
679 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
680 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
681 "of other functions for creating test files, for example L</guestfs_fill> and "
682 "L</guestfs_fill_pattern>."
687 #: ../src/guestfs.pod:290
689 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
690 "file content or size (even files larger than 4 GB)."
695 #: ../src/guestfs.pod:293
697 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
702 #: ../src/guestfs.pod:295
704 "However the fastest way to upload I<large numbers of arbitrary files> is to "
705 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
706 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
707 "in a predictable way (eg. adding it last after all other drives) then you "
708 "can get the device name from L</guestfs_list_devices> and mount it directly "
709 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
710 "portable between kernel versions, and they don't support labels or UUIDs. "
711 "If you want to pre-build an image or you need to mount it using a label or "
712 "UUID, use an ISO image instead."
717 #: ../src/guestfs.pod:306
723 #: ../src/guestfs.pod:308
725 "There are various different commands for copying between files and devices "
726 "and in and out of the guest filesystem. These are summarised in the table "
732 #: ../src/guestfs.pod:314
733 msgid "B<file> to B<file>"
738 #: ../src/guestfs.pod:316
740 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
741 "directories recursively."
746 #: ../src/guestfs.pod:319
747 msgid "B<file or device> to B<file or device>"
752 #: ../src/guestfs.pod:321
754 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
755 "devices in the guest."
760 #: ../src/guestfs.pod:324
761 msgid "Example: duplicate the contents of an LV:"
766 #: ../src/guestfs.pod:326
769 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
775 #: ../src/guestfs.pod:328
777 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
778 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
779 "guestfs_copy_size>."
784 #: ../src/guestfs.pod:332
785 msgid "B<file on the host> to B<file or device>"
790 #: ../src/guestfs.pod:334
791 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
796 #: ../src/guestfs.pod:336
797 msgid "B<file or device> to B<file on the host>"
802 #: ../src/guestfs.pod:338
803 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
808 #: ../src/guestfs.pod:342
809 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
814 #: ../src/guestfs.pod:344
816 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
817 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
818 "appears you can only upload and download to files. However many Un*x-like "
819 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
820 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
821 "and arbitrary file descriptor N."
826 #: ../src/guestfs.pod:352
827 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
831 #: ../src/guestfs.pod:355
834 " guestfs_download (g, filename, \"/dev/stdout\");\n"
839 #: ../src/guestfs.pod:357
840 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
844 #: ../src/guestfs.pod:359
848 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
849 " guestfs_tar_out (g, \"/\", devfd);\n"
855 #: ../src/guestfs.pod:363
856 msgid "LISTING FILES"
861 #: ../src/guestfs.pod:365
863 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
864 "L<guestfish(1)>-equivalent command C<ll>)."
869 #: ../src/guestfs.pod:368
871 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
872 "programs, as a flat list of strings."
877 #: ../src/guestfs.pod:371
879 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
880 "directory, plus additional information about each one. It is more "
881 "equivalent to using the L<readdir(3)> call on a local filesystem."
886 #: ../src/guestfs.pod:375
888 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
893 #: ../src/guestfs.pod:378
894 msgid "RUNNING COMMANDS"
899 #: ../src/guestfs.pod:380
901 "Although libguestfs is primarily an API for manipulating files inside guest "
902 "images, we also provide some limited facilities for running commands inside "
908 #: ../src/guestfs.pod:384
909 msgid "There are many limitations to this:"
914 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
915 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
916 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
917 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
918 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
919 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
920 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
921 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
922 #: ../src/guestfs.pod:1753 ../src/guestfs.pod:1758 ../src/guestfs.pod:1762
923 #: ../src/guestfs.pod:1772 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012
924 #: ../src/guestfs.pod:2018 ../src/guestfs.pod:2026 ../src/guestfs.pod:2380
925 #: ../src/guestfs.pod:2386 ../src/guestfs.pod:2391 ../src/guestfs.pod:2397
926 #: ../src/guestfs.pod:2962 ../src/guestfs.pod:2966 ../src/guestfs.pod:2970
927 #: ../src/guestfs.pod:2974 ../src/guestfs-actions.pod:15
928 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
929 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
930 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600
931 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
932 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620
933 #: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628
934 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642
935 #: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784
936 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
937 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859
938 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868
939 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
940 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
941 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
942 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
943 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
944 #: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076
945 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
946 #: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096
947 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110
948 #: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118
949 #: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212
950 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222
951 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268
952 #: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351
953 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
954 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
955 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
956 #: ../tools/virt-win-reg.pl:548
962 #: ../src/guestfs.pod:390
964 "The kernel version that the command runs under will be different from what "
970 #: ../src/guestfs.pod:395
972 "If the command needs to communicate with daemons, then most likely they "
978 #: ../src/guestfs.pod:400
979 msgid "The command will be running in limited memory."
984 #: ../src/guestfs.pod:404
986 "The network may not be available unless you enable it (see L</"
987 "guestfs_set_network>)."
992 #: ../src/guestfs.pod:409
993 msgid "Only supports Linux guests (not Windows, BSD, etc)."
998 #: ../src/guestfs.pod:413
1000 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1005 #: ../src/guestfs.pod:418
1007 "For SELinux guests, you may need to enable SELinux and load policy first. "
1008 "See L</SELINUX> in this manpage."
1013 #: ../src/guestfs.pod:423
1015 "I<Security:> It is not safe to run commands from untrusted, possibly "
1016 "malicious guests. These commands may attempt to exploit your program by "
1017 "sending unexpected output. They could also try to exploit the Linux kernel "
1018 "or qemu provided by the libguestfs appliance. They could use the network "
1019 "provided by the libguestfs appliance to bypass ordinary network partitions "
1020 "and firewalls. They could use the elevated privileges or different SELinux "
1021 "context of your program to their advantage."
1026 #: ../src/guestfs.pod:432
1028 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1029 "(a script which runs when the guest next boots normally), and to have this "
1030 "script run the commands you want in the normal context of the running guest, "
1031 "network security and so on. For information about other security issues, "
1037 #: ../src/guestfs.pod:440
1039 "The two main API calls to run commands are L</guestfs_command> and L</"
1040 "guestfs_sh> (there are also variations)."
1045 #: ../src/guestfs.pod:443
1047 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1048 "shell globs, redirections, etc will work."
1053 #: ../src/guestfs.pod:446
1054 msgid "CONFIGURATION FILES"
1059 #: ../src/guestfs.pod:448
1061 "To read and write configuration files in Linux guest filesystems, we "
1062 "strongly recommend using Augeas. For example, Augeas understands how to "
1063 "read and write, say, a Linux shadow password file or X.org configuration "
1064 "file, and so avoids you having to write that code."
1069 #: ../src/guestfs.pod:453
1071 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1072 "document Augeas itself here because there is excellent documentation on the "
1073 "L<http://augeas.net/> website."
1078 #: ../src/guestfs.pod:457
1080 "If you don't want to use Augeas (you fool!) then try calling L</"
1081 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1087 #: ../src/guestfs.pod:461
1093 #: ../src/guestfs.pod:463
1095 "We support SELinux guests. To ensure that labeling happens correctly in "
1096 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1101 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1102 #: ../src/guestfs.pod:2425
1108 #: ../src/guestfs.pod:471
1109 msgid "Before launching, do:"
1114 #: ../src/guestfs.pod:473
1117 " guestfs_set_selinux (g, 1);\n"
1123 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1124 #: ../src/guestfs.pod:2450
1130 #: ../src/guestfs.pod:477
1132 "After mounting the guest's filesystem(s), load the policy. This is best "
1133 "done by running the L<load_policy(8)> command in the guest itself:"
1138 #: ../src/guestfs.pod:481
1141 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1147 #: ../src/guestfs.pod:483
1149 "(Older versions of C<load_policy> require you to specify the name of the "
1155 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1161 #: ../src/guestfs.pod:488
1163 "Optionally, set the security context for the API. The correct security "
1164 "context to use can only be known by inspecting the guest. As an example:"
1169 #: ../src/guestfs.pod:492
1172 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1178 #: ../src/guestfs.pod:496
1179 msgid "This will work for running commands and editing existing files."
1184 #: ../src/guestfs.pod:498
1186 "When new files are created, you may need to label them explicitly, for "
1187 "example by running the external command C<restorecon pathname>."
1192 #: ../src/guestfs.pod:502
1198 #: ../src/guestfs.pod:504
1200 "Certain calls are affected by the current file mode creation mask (the "
1201 "\"umask\"). In particular ones which create files or directories, such as "
1202 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1203 "either the default mode that the file is created with or modifies the mode "
1209 #: ../src/guestfs.pod:510
1211 "The default umask is C<022>, so files are created with modes such as C<0644> "
1212 "and directories with C<0755>."
1217 #: ../src/guestfs.pod:513
1219 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1220 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1221 "guestfs_chmod> after creating each file or directory."
1226 #: ../src/guestfs.pod:517
1227 msgid "For more information about umask, see L<umask(2)>."
1232 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1233 msgid "ENCRYPTED DISKS"
1238 #: ../src/guestfs.pod:521
1240 "Libguestfs allows you to access Linux guests which have been encrypted using "
1241 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1242 "standard. This includes nearly all whole disk encryption systems used by "
1243 "modern Linux guests."
1248 #: ../src/guestfs.pod:527
1250 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1251 "returns the string C<crypto_LUKS>)."
1256 #: ../src/guestfs.pod:530
1258 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1259 "will require the passphrase!"
1264 #: ../src/guestfs.pod:533
1266 "Opening a LUKS device creates a new device mapper device called C</dev/"
1267 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1268 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1269 "from and encrypted to the underlying block device respectively."
1274 #: ../src/guestfs.pod:539
1276 "LVM volume groups on the device can be made visible by calling L</"
1277 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1278 "(s) can now be mounted in the usual way."
1283 #: ../src/guestfs.pod:543
1285 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1286 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1287 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1288 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1289 "underlying encrypted block device)."
1294 #: ../src/guestfs.pod:550
1299 #: ../src/guestfs.pod:552
1301 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1302 "contains operating systems, an install CD or a live CD. (These APIs used to "
1303 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1304 "version 1.5.3 the most frequently used part of this library has been "
1305 "rewritten in C and moved into the core code)."
1310 #: ../src/guestfs.pod:559
1312 "Add all disks belonging to the unknown virtual machine and call L</"
1313 "guestfs_launch> in the usual way."
1318 #: ../src/guestfs.pod:562
1320 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1321 "and certain heuristics, and returns a list of operating systems that were "
1322 "found. An empty list means none were found. A single element is the root "
1323 "filesystem of the operating system. For dual- or multi-boot guests, "
1324 "multiple roots can be returned, each one corresponding to a separate "
1325 "operating system. (Multi-boot virtual machines are extremely rare in the "
1326 "world of virtualization, but since this scenario can happen, we have built "
1327 "libguestfs to deal with it.)"
1332 #: ../src/guestfs.pod:571
1334 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1335 "to get additional details about that operating system. For example, call L</"
1336 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1337 "Windows and Linux-based operating systems respectively."
1342 #: ../src/guestfs.pod:577
1344 "Un*x-like and Linux-based operating systems usually consist of several "
1345 "filesystems which are mounted at boot time (for example, a separate boot "
1346 "partition mounted on C</boot>). The inspection rules are able to detect how "
1347 "filesystems correspond to mount points. Call "
1348 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1349 "hash table like this example:"
1354 #: ../src/guestfs.pod:584
1357 " /boot => /dev/sda1\n"
1358 " / => /dev/vg_guest/lv_root\n"
1359 " /usr => /dev/vg_guest/lv_usr\n"
1365 #: ../src/guestfs.pod:588
1367 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1368 "filesystems as suggested."
1373 #: ../src/guestfs.pod:591
1375 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1376 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1381 #: ../src/guestfs.pod:595
1383 "Inspection currently only works for some common operating systems. "
1384 "Contributors are welcome to send patches for other operating systems that we "
1385 "currently cannot detect."
1390 #: ../src/guestfs.pod:599
1392 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1393 "for more details. The L</guestfs_inspect_os> function just ignores any "
1394 "encrypted devices."
1399 #: ../src/guestfs.pod:603
1401 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1402 "inspection and caches the results in the guest handle. Subsequent calls to "
1403 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1404 "read the disks. If you change the content of the guest disks, you can redo "
1405 "inspection by calling L</guestfs_inspect_os> again. (L</"
1406 "guestfs_inspect_list_applications> works a little differently from the other "
1407 "calls and does read the disks. See documentation for that function for "
1412 #: ../src/guestfs.pod:612
1413 msgid "INSPECTING INSTALL DISKS"
1417 #: ../src/guestfs.pod:614
1419 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1424 #: ../src/guestfs.pod:617
1426 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1427 "system, which currently can be C<installed> (a regular operating system) or "
1428 "C<installer> (some sort of install disk)."
1432 #: ../src/guestfs.pod:621
1434 "Further information is available about the operating system that can be "
1435 "installed using the regular inspection APIs like L</"
1436 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1440 #: ../src/guestfs.pod:626
1442 "Some additional information specific to installer disks is also available "
1443 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1444 "guestfs_inspect_is_multipart> calls."
1449 #: ../src/guestfs.pod:631
1450 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1455 #: ../src/guestfs.pod:633
1457 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1458 "ntfs-3g.org/> driver."
1463 #: ../src/guestfs.pod:636
1464 msgid "DRIVE LETTERS AND PATHS"
1469 #: ../src/guestfs.pod:638
1471 "DOS and Windows still use drive letters, and the filesystems are always "
1472 "treated as case insensitive by Windows itself, and therefore you might find "
1473 "a Windows configuration file referring to a path like C<c:\\windows"
1474 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1475 "might be referred to as C</WINDOWS/System32>."
1479 #: ../src/guestfs.pod:644
1481 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1482 "L</guestfs_inspect_get_drive_mappings>)"
1486 #: ../src/guestfs.pod:647
1488 "Dealing with separator characters (backslash vs forward slash) is outside "
1489 "the scope of libguestfs, but usually a simple character replacement will "
1494 #: ../src/guestfs.pod:651
1496 "To resolve the case insensitivity of paths, call L</"
1497 "guestfs_case_sensitive_path>."
1502 #: ../src/guestfs.pod:654
1503 msgid "ACCESSING THE WINDOWS REGISTRY"
1508 #: ../src/guestfs.pod:656
1510 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1511 "files, through the library C<hivex> which is part of the libguestfs project "
1512 "although ships as a separate tarball. You have to locate and download the "
1513 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1514 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1515 "reg(1)> for more help on this issue."
1520 #: ../src/guestfs.pod:664
1521 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1526 #: ../src/guestfs.pod:666
1528 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1529 "provide something which looks like a Linux symlink. The way it tries to do "
1530 "the rewriting is described here:"
1535 #: ../src/guestfs.pod:670
1537 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1543 #: ../src/guestfs.pod:672
1545 "The essential problem is that ntfs-3g simply does not have enough "
1546 "information to do a correct job. NTFS links can contain drive letters and "
1547 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1548 "It is almost certainly the case that libguestfs callers should ignore what "
1549 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1554 #: ../src/guestfs.pod:679
1556 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1557 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1558 "attribute, and read the raw reparse data from that (you can find the format "
1559 "documented in various places around the web)."
1564 #: ../src/guestfs.pod:684
1565 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1570 #: ../src/guestfs.pod:686
1572 "There are other useful extended attributes that can be read from ntfs-3g "
1573 "filesystems (using L</guestfs_getxattr>). See:"
1578 #: ../src/guestfs.pod:689
1580 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1585 #: ../src/guestfs.pod:691
1586 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1591 #: ../src/guestfs.pod:693
1593 "Although we don't want to discourage you from using the C API, we will "
1594 "mention here that the same API is also available in other languages."
1598 #: ../src/guestfs.pod:696
1600 "The API is broadly identical in all supported languages. This means that "
1601 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1602 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1603 "OCaml. In other words, a straightforward, predictable isomorphism between "
1609 #: ../src/guestfs.pod:702
1611 "Error messages are automatically transformed into exceptions if the language "
1617 #: ../src/guestfs.pod:705
1619 "We don't try to \"object orientify\" parts of the API in OO languages, "
1620 "although contributors are welcome to write higher level APIs above what we "
1621 "provide in their favourite languages if they wish."
1626 #: ../src/guestfs.pod:711
1632 #: ../src/guestfs.pod:713
1634 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1635 "identical to the C API. C++ classes and exceptions are not used."
1640 #: ../src/guestfs.pod:717
1646 #: ../src/guestfs.pod:719
1648 "The C# bindings are highly experimental. Please read the warnings at the "
1649 "top of C<csharp/Libguestfs.cs>."
1654 #: ../src/guestfs.pod:722
1660 #: ../src/guestfs.pod:724
1662 "This is the only language binding that is working but incomplete. Only "
1663 "calls which return simple integers have been bound in Haskell, and we are "
1664 "looking for help to complete this binding."
1669 #: ../src/guestfs.pod:728
1675 #: ../src/guestfs.pod:730
1677 "Full documentation is contained in the Javadoc which is distributed with "
1683 #: ../src/guestfs.pod:733
1688 #: ../src/guestfs.pod:735
1689 msgid "See L<guestfs-ocaml(3)>."
1694 #: ../src/guestfs.pod:737
1699 #: ../src/guestfs.pod:739
1700 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1705 #: ../src/guestfs.pod:741
1711 #: ../src/guestfs.pod:743
1713 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1714 "the php-libguestfs package for your distribution."
1719 #: ../src/guestfs.pod:746
1720 msgid "The PHP binding only works correctly on 64 bit machines."
1725 #: ../src/guestfs.pod:748
1730 #: ../src/guestfs.pod:750
1731 msgid "See L<guestfs-python(3)>."
1736 #: ../src/guestfs.pod:752
1741 #: ../src/guestfs.pod:754
1742 msgid "See L<guestfs-ruby(3)>."
1747 #: ../src/guestfs.pod:756
1748 msgid "B<shell scripts>"
1752 #: ../src/guestfs.pod:758
1753 msgid "See L<guestfish(1)>."
1758 #: ../src/guestfs.pod:762
1759 msgid "LIBGUESTFS GOTCHAS"
1764 #: ../src/guestfs.pod:764
1766 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1767 "system [...] that works in the way it is documented but is counterintuitive "
1768 "and almost invites mistakes.\""
1773 #: ../src/guestfs.pod:768
1775 "Since we developed libguestfs and the associated tools, there are several "
1776 "things we would have designed differently, but are now stuck with for "
1777 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1778 "release, you can expect these to change. Beware of them."
1783 #: ../src/guestfs.pod:776
1784 msgid "Autosync / forgetting to sync."
1788 #: ../src/guestfs.pod:778
1790 "I<Update:> Autosync is enabled by default for all API users starting from "
1791 "libguestfs 1.5.24. This section only applies to older versions."
1796 #: ../src/guestfs.pod:781
1798 "When modifying a filesystem from C or another language, you B<must> unmount "
1799 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1800 "libguestfs handle. You can also call:"
1805 #: ../src/guestfs.pod:785
1808 " guestfs_set_autosync (g, 1);\n"
1814 #: ../src/guestfs.pod:787
1816 "to have the unmount/sync done automatically for you when the handle 'g' is "
1817 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1822 #: ../src/guestfs.pod:791
1824 "If you forget to do this, then it is entirely possible that your changes "
1825 "won't be written out, or will be partially written, or (very rarely) that "
1826 "you'll get disk corruption."
1831 #: ../src/guestfs.pod:795
1833 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1834 "guestfish scripts that forget to sync will work just fine, which can make "
1835 "this very puzzling if you are trying to debug a problem."
1840 #: ../src/guestfs.pod:799
1841 msgid "Mount option C<-o sync> should not be the default."
1846 #: ../src/guestfs.pod:801
1848 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1849 "However C<-o sync> does not add any reliability benefit, but does have a "
1850 "very large performance impact."
1855 #: ../src/guestfs.pod:805
1857 "The work around is to use L</guestfs_mount_options> and set the mount "
1858 "options that you actually want to use."
1863 #: ../src/guestfs.pod:808
1864 msgid "Read-only should be the default."
1869 #: ../src/guestfs.pod:810
1871 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1872 "specify I<--rw> if you want to make changes to the image."
1877 #: ../src/guestfs.pod:813
1878 msgid "This would reduce the potential to corrupt live VM images."
1883 #: ../src/guestfs.pod:815
1885 "Note that many filesystems change the disk when you just mount and unmount, "
1886 "even if you didn't perform any writes. You need to use L</"
1887 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1892 #: ../src/guestfs.pod:819
1893 msgid "guestfish command line is hard to use."
1898 #: ../src/guestfs.pod:821
1900 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1901 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1902 "exist, so it fails. In earlier versions of guestfish the error message was "
1903 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1904 "we should have used C<guestfish -c command> to run commands."
1909 #: ../src/guestfs.pod:828
1910 msgid "guestfish megabyte modifiers don't work right on all commands"
1915 #: ../src/guestfs.pod:830
1917 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1918 "other modifiers). What guestfish actually does is to multiply the number "
1919 "part by the modifier part and pass the result to the C API. However this "
1920 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1921 "expecting some other unit (eg. megabytes)."
1926 #: ../src/guestfs.pod:837
1927 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1932 #: ../src/guestfs.pod:839
1935 " lvcreate LV VG 100M\n"
1941 #: ../src/guestfs.pod:841
1943 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1944 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1945 "megabytes * megabytes) logical volume. The error message you get from this "
1946 "is also a little obscure."
1951 #: ../src/guestfs.pod:846
1953 "This could be fixed in the generator by specially marking parameters and "
1954 "return values which take bytes or other units."
1959 #: ../src/guestfs.pod:849
1960 msgid "Ambiguity between devices and paths"
1965 #: ../src/guestfs.pod:851
1967 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1968 "sdb2>) and a similar pathname. A file might just happen to be called "
1969 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1974 #: ../src/guestfs.pod:856
1976 "In the current API we usually resolve this ambiguity by having two separate "
1977 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1978 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1979 "detecting if the path supplied begins with C</dev/>."
1984 #: ../src/guestfs.pod:862
1986 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1987 "make paths/devices into structured names. One way to do this would be to "
1988 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1989 "aspect of grub. Another way would be to use a structured type, equivalent "
1990 "to this OCaml type:"
1995 #: ../src/guestfs.pod:868
1998 " type path = Path of string | Device of int | Partition of int * int\n"
2004 #: ../src/guestfs.pod:870
2005 msgid "which would allow you to pass arguments like:"
2010 #: ../src/guestfs.pod:872
2013 " Path \"/foo/bar\"\n"
2014 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2015 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2016 " Path \"/dev/sdb2\" (* not a device *)\n"
2022 #: ../src/guestfs.pod:877
2024 "As you can see there are still problems to resolve even with this "
2025 "representation. Also consider how it might work in guestfish."
2030 #: ../src/guestfs.pod:882
2031 msgid "KEYS AND PASSPHRASES"
2036 #: ../src/guestfs.pod:884
2038 "Certain libguestfs calls take a parameter that contains sensitive key "
2039 "material, passed in as a C string."
2044 #: ../src/guestfs.pod:887
2046 "In the future we would hope to change the libguestfs implementation so that "
2047 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2048 "swap. However this is I<not> done at the moment, because of the complexity "
2049 "of such an implementation."
2054 #: ../src/guestfs.pod:892
2056 "Therefore you should be aware that any key parameter you pass to libguestfs "
2057 "might end up being written out to the swap partition. If this is a concern, "
2058 "scrub the swap partition or don't use libguestfs on encrypted devices."
2063 #: ../src/guestfs.pod:897
2064 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2069 #: ../src/guestfs.pod:899
2071 "All high-level libguestfs actions are synchronous. If you want to use "
2072 "libguestfs asynchronously then you must create a thread."
2077 #: ../src/guestfs.pod:902
2079 "Only use the handle from a single thread. Either use the handle exclusively "
2080 "from one thread, or provide your own mutex so that two threads cannot issue "
2081 "calls on the same handle at the same time."
2086 #: ../src/guestfs.pod:906
2088 "See the graphical program guestfs-browser for one possible architecture for "
2089 "multithreaded programs using libvirt and libguestfs."
2094 #: ../src/guestfs.pod:909
2099 #: ../src/guestfs.pod:911
2101 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2107 #: ../src/guestfs.pod:914
2109 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2110 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2115 #: ../src/guestfs.pod:917
2117 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2118 "to change the directories that libguestfs will search in. The value is a "
2119 "colon-separated list of paths. The current directory is I<not> searched "
2120 "unless the path contains an empty element or C<.>. For example "
2121 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2122 "then C</usr/lib/guestfs>."
2127 #: ../src/guestfs.pod:924
2128 msgid "QEMU WRAPPERS"
2133 #: ../src/guestfs.pod:926
2135 "If you want to compile your own qemu, run qemu from a non-standard location, "
2136 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2142 #: ../src/guestfs.pod:930
2144 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2145 "last command in the shell script (so that qemu replaces the shell and "
2146 "becomes the direct child of the libguestfs-using program). If you don't do "
2147 "this, then the qemu process won't be cleaned up correctly."
2152 #: ../src/guestfs.pod:935
2154 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2160 #: ../src/guestfs.pod:938
2164 " qemudir=/home/rjones/d/qemu\n"
2165 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2171 #: ../src/guestfs.pod:942
2173 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2174 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2180 #: ../src/guestfs.pod:946
2183 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2189 #: ../src/guestfs.pod:948
2191 "Note that libguestfs also calls qemu with the -help and -version options in "
2192 "order to determine features."
2196 #: ../src/guestfs.pod:951
2197 msgid "ATTACHING TO RUNNING DAEMONS"
2201 #: ../src/guestfs.pod:953
2203 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2204 "babies. Use with caution."
2208 #: ../src/guestfs.pod:956
2210 "I<Note (2):> This section explains how to attach to a running daemon from a "
2211 "low level perspective. For most users, simply using virt tools such as "
2212 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2216 #: ../src/guestfs.pod:960
2217 msgid "Using guestfs_set_attach_method"
2221 #: ../src/guestfs.pod:962
2223 "By calling L</guestfs_set_attach_method> you can change how the library "
2224 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2225 "ARCHITECTURE> for some background)."
2229 #: ../src/guestfs.pod:966
2231 "The normal attach method is C<appliance>, where a small appliance is created "
2232 "containing the daemon, and then the library connects to this."
2236 #: ../src/guestfs.pod:969
2238 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2239 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2240 "daemon over the Unix domain socket."
2244 #: ../src/guestfs.pod:973
2246 "The normal use for this is to connect to a running virtual machine that "
2247 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2248 "files inside the live virtual machine."
2252 #: ../src/guestfs.pod:977
2253 msgid "Using guestfs_add_domain with live flag"
2257 #: ../src/guestfs.pod:979
2259 "L</guestfs_add_domain> provides some help for getting the correct attach "
2260 "method. If you pass the C<live> option to this function, then (if the "
2261 "virtual machine is running) it will examine the libvirt XML looking for a "
2262 "virtio-serial channel to connect to:"
2266 #: ../src/guestfs.pod:985
2273 " <channel type='unix'>\n"
2274 " <source mode='bind' path='/path/to/socket'/>\n"
2275 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2284 #: ../src/guestfs.pod:997
2286 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2287 "method to C<unix:/path/to/socket>."
2291 #: ../src/guestfs.pod:1000
2293 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2294 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2295 "to attach to and modify live virtual machines."
2299 #: ../src/guestfs.pod:1004
2301 "The virtual machine needs to have been set up beforehand so that it has the "
2302 "virtio-serial channel and so that guestfsd is running inside it."
2307 #: ../src/guestfs.pod:1008
2308 msgid "ABI GUARANTEE"
2313 #: ../src/guestfs.pod:1010
2315 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2316 "actions as outlined in this section. Although we will deprecate some "
2317 "actions, for example if they get replaced by newer calls, we will keep the "
2318 "old actions forever. This allows you the developer to program in confidence "
2319 "against the libguestfs API."
2324 #: ../src/guestfs.pod:1016
2325 msgid "BLOCK DEVICE NAMING"
2330 #: ../src/guestfs.pod:1018
2332 "In the kernel there is now quite a profusion of schemata for naming block "
2333 "devices (in this context, by I<block device> I mean a physical or virtual "
2334 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2335 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2336 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2337 "for the old IDE driver (particularly for SATA devices) those devices also "
2338 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2339 "paravirtualized drivers. This has created several different naming systems, "
2340 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2345 #: ../src/guestfs.pod:1030
2347 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2348 "Linux kernel to access block devices. We can run a variety of appliances "
2349 "based on a variety of Linux kernels."
2354 #: ../src/guestfs.pod:1034
2356 "This causes a problem for libguestfs because many API calls use device or "
2357 "partition names. Working scripts and the recipe (example) scripts that we "
2358 "make available over the internet could fail if the naming scheme changes."
2363 #: ../src/guestfs.pod:1039
2365 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2366 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2367 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2368 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2373 #: ../src/guestfs.pod:1045
2375 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2376 "L</guestfs_list_partitions> and similar calls return the true names of the "
2377 "devices and partitions as known to the appliance."
2382 #: ../src/guestfs.pod:1050
2383 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2388 #: ../src/guestfs.pod:1052
2390 "Usually this translation is transparent. However in some (very rare) cases "
2391 "you may need to know the exact algorithm. Such cases include where you use "
2392 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2393 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2398 #: ../src/guestfs.pod:1058
2400 "The algorithm is applied only to I<parameters> which are known to be either "
2401 "device or partition names. Return values from functions such as L</"
2402 "guestfs_list_devices> are never changed."
2407 #: ../src/guestfs.pod:1066
2408 msgid "Is the string a parameter which is a device or partition name?"
2413 #: ../src/guestfs.pod:1070
2414 msgid "Does the string begin with C</dev/sd>?"
2419 #: ../src/guestfs.pod:1074
2421 "Does the named device exist? If so, we use that device. However if I<not> "
2422 "then we continue with this algorithm."
2427 #: ../src/guestfs.pod:1079
2428 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2433 #: ../src/guestfs.pod:1081
2434 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2439 #: ../src/guestfs.pod:1083
2440 msgid "If that named device exists, use it. If not, continue."
2445 #: ../src/guestfs.pod:1087
2446 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2451 #: ../src/guestfs.pod:1089
2452 msgid "If that named device exists, use it. If not, return an error."
2457 #: ../src/guestfs.pod:1093
2458 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2463 #: ../src/guestfs.pod:1095
2465 "Although the standard naming scheme and automatic translation is useful for "
2466 "simple programs and guestfish scripts, for larger programs it is best not to "
2467 "rely on this mechanism."
2472 #: ../src/guestfs.pod:1099
2474 "Where possible for maximum future portability programs using libguestfs "
2475 "should use these future-proof techniques:"
2480 #: ../src/guestfs.pod:1106
2482 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2483 "device names, and then use those names directly."
2488 #: ../src/guestfs.pod:1109
2490 "Since those device names exist by definition, they will never be translated."
2495 #: ../src/guestfs.pod:1114
2497 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2498 "filesystem labels."
2503 #: ../src/guestfs.pod:1119
2509 #: ../src/guestfs.pod:1121
2511 "This section discusses security implications of using libguestfs, "
2512 "particularly with untrusted or malicious guests or disk images."
2517 #: ../src/guestfs.pod:1124
2518 msgid "GENERAL SECURITY CONSIDERATIONS"
2523 #: ../src/guestfs.pod:1126
2525 "Be careful with any files or data that you download from a guest (by "
2526 "\"download\" we mean not just the L</guestfs_download> command but any "
2527 "command that reads files, filenames, directories or anything else from a "
2528 "disk image). An attacker could manipulate the data to fool your program "
2529 "into doing the wrong thing. Consider cases such as:"
2534 #: ../src/guestfs.pod:1136
2535 msgid "the data (file etc) not being present"
2540 #: ../src/guestfs.pod:1140
2541 msgid "being present but empty"
2546 #: ../src/guestfs.pod:1144
2547 msgid "being much larger than normal"
2552 #: ../src/guestfs.pod:1148
2553 msgid "containing arbitrary 8 bit data"
2558 #: ../src/guestfs.pod:1152
2559 msgid "being in an unexpected character encoding"
2564 #: ../src/guestfs.pod:1156
2565 msgid "containing homoglyphs."
2570 #: ../src/guestfs.pod:1160
2571 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2576 #: ../src/guestfs.pod:1162
2578 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2579 "(VFS) module can sometimes be escalated into exploits by deliberately "
2580 "creating a malicious, malformed filesystem. These exploits are very severe "
2581 "for two reasons. Firstly there are very many filesystem drivers in the "
2582 "kernel, and many of them are infrequently used and not much developer "
2583 "attention has been paid to the code. Linux userspace helps potential "
2584 "crackers by detecting the filesystem type and automatically choosing the "
2585 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2586 "the administrator. Secondly, a kernel-level exploit is like a local root "
2587 "exploit (worse in some ways), giving immediate and total access to the "
2588 "system right down to the hardware level."
2593 #: ../src/guestfs.pod:1175
2595 "That explains why you should never mount a filesystem from an untrusted "
2596 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2597 "inside a qemu virtual machine, usually running as a non-root user. The "
2598 "attacker would need to write a filesystem which first exploited the kernel, "
2599 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2600 "the libguestfs protocol, and finally to be as serious as the host kernel "
2601 "exploit it would need to escalate its privileges to root. This multi-step "
2602 "escalation, performed by a static piece of data, is thought to be extremely "
2603 "hard to do, although we never say 'never' about security issues."
2608 #: ../src/guestfs.pod:1186
2610 "In any case callers can reduce the attack surface by forcing the filesystem "
2611 "type when mounting (use L</guestfs_mount_vfs>)."
2616 #: ../src/guestfs.pod:1189
2617 msgid "PROTOCOL SECURITY"
2622 #: ../src/guestfs.pod:1191
2624 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2625 "defined upper message size. However a program that uses libguestfs must "
2626 "also take care - for example you can write a program that downloads a binary "
2627 "from a disk image and executes it locally, and no amount of protocol "
2628 "security will save you from the consequences."
2633 #: ../src/guestfs.pod:1197
2634 msgid "INSPECTION SECURITY"
2639 #: ../src/guestfs.pod:1199
2641 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2642 "directly from the guest, and these could contain any 8 bit data. Callers "
2643 "should be careful to escape these before printing them to a structured file "
2644 "(for example, use HTML escaping if creating a web page)."
2649 #: ../src/guestfs.pod:1205
2651 "Guest configuration may be altered in unusual ways by the administrator of "
2652 "the virtual machine, and may not reflect reality (particularly for untrusted "
2653 "or actively malicious guests). For example we parse the hostname from "
2654 "configuration files like C</etc/sysconfig/network> that we find in the "
2655 "guest, but the guest administrator can easily manipulate these files to "
2656 "provide the wrong hostname."
2661 #: ../src/guestfs.pod:1213
2663 "The inspection API parses guest configuration using two external libraries: "
2664 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2665 "designed to be robust in the face of malicious data, although denial of "
2666 "service attacks are still possible, for example with oversized configuration "
2672 #: ../src/guestfs.pod:1219
2673 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2678 #: ../src/guestfs.pod:1221
2680 "Be very cautious about running commands from the guest. By running a "
2681 "command in the guest, you are giving CPU time to a binary that you do not "
2682 "control, under the same user account as the library, albeit wrapped in qemu "
2683 "virtualization. More information and alternatives can be found in the "
2684 "section L</RUNNING COMMANDS>."
2689 #: ../src/guestfs.pod:1227
2690 msgid "CVE-2010-3851"
2695 #: ../src/guestfs.pod:1229
2696 msgid "https://bugzilla.redhat.com/642934"
2701 #: ../src/guestfs.pod:1231
2703 "This security bug concerns the automatic disk format detection that qemu "
2704 "does on disk images."
2709 #: ../src/guestfs.pod:1234
2711 "A raw disk image is just the raw bytes, there is no header. Other disk "
2712 "images like qcow2 contain a special header. Qemu deals with this by looking "
2713 "for one of the known headers, and if none is found then assuming the disk "
2714 "image must be raw."
2719 #: ../src/guestfs.pod:1239
2721 "This allows a guest which has been given a raw disk image to write some "
2722 "other header. At next boot (or when the disk image is accessed by "
2723 "libguestfs) qemu would do autodetection and think the disk image format was, "
2724 "say, qcow2 based on the header written by the guest."
2729 #: ../src/guestfs.pod:1244
2731 "This in itself would not be a problem, but qcow2 offers many features, one "
2732 "of which is to allow a disk image to refer to another image (called the "
2733 "\"backing disk\"). It does this by placing the path to the backing disk "
2734 "into the qcow2 header. This path is not validated and could point to any "
2735 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2736 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2737 "control of the attacker."
2742 #: ../src/guestfs.pod:1252
2744 "In libguestfs this is rather hard to exploit except under two circumstances:"
2749 #: ../src/guestfs.pod:1259
2750 msgid "You have enabled the network or have opened the disk in write mode."
2755 #: ../src/guestfs.pod:1263
2757 "You are also running untrusted code from the guest (see L</RUNNING "
2763 #: ../src/guestfs.pod:1268
2765 "The way to avoid this is to specify the expected disk format when adding "
2766 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2767 "should always do this if the disk is raw format, and it's a good idea for "
2773 #: ../src/guestfs.pod:1273
2775 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2776 "format is fetched from libvirt and passed through."
2781 #: ../src/guestfs.pod:1276
2783 "For libguestfs tools, use the I<--format> command line parameter as "
2789 #: ../src/guestfs.pod:1279
2790 msgid "CONNECTION MANAGEMENT"
2795 #: ../src/guestfs.pod:1281
2801 #: ../src/guestfs.pod:1283
2803 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2804 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2805 "handle and release all resources used."
2809 #: ../src/guestfs.pod:1287
2811 "For information on using multiple handles and threads, see the section L</"
2812 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2817 #: ../src/guestfs.pod:1290
2818 msgid "guestfs_create"
2823 #: ../src/guestfs.pod:1292
2826 " guestfs_h *guestfs_create (void);\n"
2832 #: ../src/guestfs.pod:1294
2833 msgid "Create a connection handle."
2837 #: ../src/guestfs.pod:1296
2839 "On success this returns a non-NULL pointer to a handle. On error it returns "
2844 #: ../src/guestfs.pod:1299
2846 "You have to \"configure\" the handle after creating it. This includes "
2847 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2848 "handle at least once."
2853 #: ../src/guestfs.pod:1303
2854 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2858 #: ../src/guestfs.pod:1305
2860 "You may also want to configure error handling for the handle. See the L</"
2861 "ERROR HANDLING> section below."
2866 #: ../src/guestfs.pod:1308
2867 msgid "guestfs_close"
2872 #: ../src/guestfs.pod:1310
2875 " void guestfs_close (guestfs_h *g);\n"
2881 #: ../src/guestfs.pod:1312
2882 msgid "This closes the connection handle and frees up all resources used."
2886 #: ../src/guestfs.pod:1314
2888 "If autosync was set on the handle and the handle was launched, then this "
2889 "implicitly calls various functions to unmount filesystems and sync the "
2890 "disk. See L</guestfs_set_autosync> for more details."
2894 #: ../src/guestfs.pod:1318
2895 msgid "If a close callback was set on the handle, then it is called."
2900 #: ../src/guestfs.pod:1320
2901 msgid "ERROR HANDLING"
2906 #: ../src/guestfs.pod:1322
2908 "API functions can return errors. For example, almost all functions that "
2909 "return C<int> will return C<-1> to indicate an error."
2914 #: ../src/guestfs.pod:1325
2916 "Additional information is available for errors: an error message string and "
2917 "optionally an error number (errno) if the thing that failed was a system "
2923 #: ../src/guestfs.pod:1329
2925 "You can get at the additional information about the last error on the handle "
2926 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2927 "up an error handler with L</guestfs_set_error_handler>."
2932 #: ../src/guestfs.pod:1334
2934 "When the handle is created, a default error handler is installed which "
2935 "prints the error message string to C<stderr>. For small short-running "
2936 "command line programs it is sufficient to do:"
2941 #: ../src/guestfs.pod:1338
2944 " if (guestfs_launch (g) == -1)\n"
2945 " exit (EXIT_FAILURE);\n"
2951 #: ../src/guestfs.pod:1341
2953 "since the default error handler will ensure that an error message has been "
2954 "printed to C<stderr> before the program exits."
2959 #: ../src/guestfs.pod:1344
2961 "For other programs the caller will almost certainly want to install an "
2962 "alternate error handler or do error handling in-line like this:"
2967 #: ../src/guestfs.pod:1347
2970 " g = guestfs_create ();\n"
2976 #: ../src/guestfs.pod:1349
2979 " /* This disables the default behaviour of printing errors\n"
2981 " guestfs_set_error_handler (g, NULL, NULL);\n"
2987 #: ../src/guestfs.pod:1353
2990 " if (guestfs_launch (g) == -1) {\n"
2991 " /* Examine the error message and print it etc. */\n"
2992 " char *msg = guestfs_last_error (g);\n"
2993 " int errnum = guestfs_last_errno (g);\n"
2994 " fprintf (stderr, \"%s\\n\", msg);\n"
3002 #: ../src/guestfs.pod:1361
3004 "Out of memory errors are handled differently. The default action is to call "
3005 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3006 "guestfs_set_out_of_memory_handler>."
3011 #: ../src/guestfs.pod:1365
3013 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3014 "because there is no handle if this happens there is no way to get additional "
3015 "error information. However L</guestfs_create> is supposed to be a "
3016 "lightweight operation which can only fail because of insufficient memory (it "
3017 "returns NULL in this case)."
3022 #: ../src/guestfs.pod:1371
3023 msgid "guestfs_last_error"
3028 #: ../src/guestfs.pod:1373
3031 " const char *guestfs_last_error (guestfs_h *g);\n"
3037 #: ../src/guestfs.pod:1375
3039 "This returns the last error message that happened on C<g>. If there has not "
3040 "been an error since the handle was created, then this returns C<NULL>."
3045 #: ../src/guestfs.pod:1379
3047 "The lifetime of the returned string is until the next error occurs, or L</"
3048 "guestfs_close> is called."
3053 #: ../src/guestfs.pod:1382
3054 msgid "guestfs_last_errno"
3059 #: ../src/guestfs.pod:1384
3062 " int guestfs_last_errno (guestfs_h *g);\n"
3068 #: ../src/guestfs.pod:1386
3069 msgid "This returns the last error number (errno) that happened on C<g>."
3074 #: ../src/guestfs.pod:1388
3075 msgid "If successful, an errno integer not equal to zero is returned."
3080 #: ../src/guestfs.pod:1390
3082 "If no error, this returns 0. This call can return 0 in three situations:"
3087 #: ../src/guestfs.pod:1397
3088 msgid "There has not been any error on the handle."
3093 #: ../src/guestfs.pod:1401
3095 "There has been an error but the errno was meaningless. This corresponds to "
3096 "the case where the error did not come from a failed system call, but for "
3097 "some other reason."
3102 #: ../src/guestfs.pod:1407
3104 "There was an error from a failed system call, but for some reason the errno "
3105 "was not captured and returned. This usually indicates a bug in libguestfs."
3110 #: ../src/guestfs.pod:1413
3112 "Libguestfs tries to convert the errno from inside the applicance into a "
3113 "corresponding errno for the caller (not entirely trivial: the appliance "
3114 "might be running a completely different operating system from the library "
3115 "and error numbers are not standardized across Un*xen). If this could not be "
3116 "done, then the error is translated to C<EINVAL>. In practice this should "
3117 "only happen in very rare circumstances."
3122 #: ../src/guestfs.pod:1421
3123 msgid "guestfs_set_error_handler"
3128 #: ../src/guestfs.pod:1423
3131 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3133 " const char *msg);\n"
3134 " void guestfs_set_error_handler (guestfs_h *g,\n"
3135 " guestfs_error_handler_cb cb,\n"
3142 #: ../src/guestfs.pod:1430
3144 "The callback C<cb> will be called if there is an error. The parameters "
3145 "passed to the callback are an opaque data pointer and the error message "
3151 #: ../src/guestfs.pod:1434
3153 "C<errno> is not passed to the callback. To get that the callback must call "
3154 "L</guestfs_last_errno>."
3159 #: ../src/guestfs.pod:1437
3161 "Note that the message string C<msg> is freed as soon as the callback "
3162 "function returns, so if you want to stash it somewhere you must make your "
3168 #: ../src/guestfs.pod:1441
3169 msgid "The default handler prints messages on C<stderr>."
3174 #: ../src/guestfs.pod:1443
3175 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3180 #: ../src/guestfs.pod:1445
3181 msgid "guestfs_get_error_handler"
3186 #: ../src/guestfs.pod:1447
3189 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3190 " void **opaque_rtn);\n"
3196 #: ../src/guestfs.pod:1450
3197 msgid "Returns the current error handler callback."
3202 #: ../src/guestfs.pod:1452
3203 msgid "guestfs_set_out_of_memory_handler"
3208 #: ../src/guestfs.pod:1454
3211 " typedef void (*guestfs_abort_cb) (void);\n"
3212 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3213 " guestfs_abort_cb);\n"
3219 #: ../src/guestfs.pod:1458
3221 "The callback C<cb> will be called if there is an out of memory situation. "
3222 "I<Note this callback must not return>."
3227 #: ../src/guestfs.pod:1461
3228 msgid "The default is to call L<abort(3)>."
3233 #: ../src/guestfs.pod:1463
3235 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3240 #: ../src/guestfs.pod:1466
3241 msgid "guestfs_get_out_of_memory_handler"
3246 #: ../src/guestfs.pod:1468
3249 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3255 #: ../src/guestfs.pod:1470
3256 msgid "This returns the current out of memory handler."
3261 #: ../src/guestfs.pod:1472
3267 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1008
3273 #: ../src/guestfs.pod:1476
3279 #: ../src/guestfs.pod:1478
3285 #: ../src/guestfs.pod:1480
3286 msgid "AVAILABILITY"
3291 #: ../src/guestfs.pod:1482
3292 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3297 #: ../src/guestfs.pod:1484
3299 "Using L</guestfs_available> you can test availability of the following "
3300 "groups of functions. This test queries the appliance to see if the "
3301 "appliance you are currently using supports the functionality."
3306 #: ../src/guestfs.pod:1489
3307 msgid "@AVAILABILITY@"
3312 #: ../src/guestfs.pod:1491
3313 msgid "GUESTFISH supported COMMAND"
3318 #: ../src/guestfs.pod:1493
3320 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3321 "prints out the available groups and whether they are supported by this build "
3322 "of libguestfs. Note however that you have to do C<run> first."
3327 #: ../src/guestfs.pod:1498
3328 msgid "SINGLE CALLS AT COMPILE TIME"
3333 #: ../src/guestfs.pod:1500
3335 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3336 "function, such as:"
3341 #: ../src/guestfs.pod:1503
3344 " #define LIBGUESTFS_HAVE_DD 1\n"
3350 #: ../src/guestfs.pod:1505
3351 msgid "if L</guestfs_dd> is available."
3356 #: ../src/guestfs.pod:1507
3358 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3359 "function is available at compile time, we recommended using build tools such "
3360 "as autoconf or cmake. For example in autotools you could use:"
3365 #: ../src/guestfs.pod:1512
3368 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3369 " AC_CHECK_FUNCS([guestfs_dd])\n"
3375 #: ../src/guestfs.pod:1515
3377 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3383 #: ../src/guestfs.pod:1518
3384 msgid "SINGLE CALLS AT RUN TIME"
3389 #: ../src/guestfs.pod:1520
3391 "Testing at compile time doesn't guarantee that a function really exists in "
3392 "the library. The reason is that you might be dynamically linked against a "
3393 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3394 "This situation unfortunately results in a segmentation fault, which is a "
3395 "shortcoming of the C dynamic linking system itself."
3400 #: ../src/guestfs.pod:1527
3402 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3403 "in this example program (note that you still need the compile time check as "
3409 #: ../src/guestfs.pod:1531
3412 " #include <stdio.h>\n"
3413 " #include <stdlib.h>\n"
3414 " #include <unistd.h>\n"
3415 " #include <dlfcn.h>\n"
3416 " #include <guestfs.h>\n"
3422 #: ../src/guestfs.pod:1537
3427 " #ifdef LIBGUESTFS_HAVE_DD\n"
3429 " int has_function;\n"
3435 #: ../src/guestfs.pod:1543
3438 " /* Test if the function guestfs_dd is really available. */\n"
3439 " dl = dlopen (NULL, RTLD_LAZY);\n"
3441 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3442 " exit (EXIT_FAILURE);\n"
3444 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3451 #: ../src/guestfs.pod:1552
3454 " if (!has_function)\n"
3455 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3457 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3458 " /* Now it's safe to call\n"
3459 " guestfs_dd (g, \"foo\", \"bar\");\n"
3463 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3471 #: ../src/guestfs.pod:1565
3473 "You may think the above is an awful lot of hassle, and it is. There are "
3474 "other ways outside of the C linking system to ensure that this kind of "
3475 "incompatibility never arises, such as using package versioning:"
3480 #: ../src/guestfs.pod:1570
3483 " Requires: libguestfs >= 1.0.80\n"
3489 #: ../src/guestfs.pod:1572
3490 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3495 #: ../src/guestfs.pod:1574
3497 "A recent feature of the API is the introduction of calls which take optional "
3498 "arguments. In C these are declared 3 ways. The main way is as a call which "
3499 "takes variable arguments (ie. C<...>), as in this example:"
3504 #: ../src/guestfs.pod:1579
3507 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3513 #: ../src/guestfs.pod:1581
3515 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3516 "call with no optional arguments specified:"
3521 #: ../src/guestfs.pod:1584
3524 " guestfs_add_drive_opts (g, filename, -1);\n"
3530 #: ../src/guestfs.pod:1586
3531 msgid "With a single optional argument:"
3536 #: ../src/guestfs.pod:1588
3539 " guestfs_add_drive_opts (g, filename,\n"
3540 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3547 #: ../src/guestfs.pod:1592
3553 #: ../src/guestfs.pod:1594
3556 " guestfs_add_drive_opts (g, filename,\n"
3557 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3558 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3565 #: ../src/guestfs.pod:1599
3567 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3573 #: ../src/guestfs.pod:1602
3574 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3579 #: ../src/guestfs.pod:1604
3581 "The second variant has the same name with the suffix C<_va>, which works the "
3582 "same way but takes a C<va_list>. See the C manual for details. For the "
3583 "example function, this is declared:"
3588 #: ../src/guestfs.pod:1608
3591 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3598 #: ../src/guestfs.pod:1611
3599 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3604 #: ../src/guestfs.pod:1613
3606 "The third variant is useful where you need to construct these calls. You "
3607 "pass in a structure where you fill in the optional fields. The structure "
3608 "has a bitmask as the first element which you must set to indicate which "
3609 "fields you have filled in. For our example function the structure and call "
3615 #: ../src/guestfs.pod:1619
3618 " struct guestfs_add_drive_opts_argv {\n"
3619 " uint64_t bitmask;\n"
3621 " const char *format;\n"
3624 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3625 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3631 #: ../src/guestfs.pod:1628
3632 msgid "You could call it like this:"
3637 #: ../src/guestfs.pod:1630
3640 " struct guestfs_add_drive_opts_argv optargs = {\n"
3641 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3642 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3644 " .format = \"qcow2\"\n"
3651 #: ../src/guestfs.pod:1637
3654 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3660 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3661 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3662 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3668 #: ../src/guestfs.pod:1645
3669 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3674 #: ../src/guestfs.pod:1650
3675 msgid "You do not need to fill in all fields of the structure."
3680 #: ../src/guestfs.pod:1654
3682 "There must be a one-to-one correspondence between fields of the structure "
3683 "that are filled in, and bits set in the bitmask."
3688 #: ../src/guestfs.pod:1659
3689 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3694 #: ../src/guestfs.pod:1661
3696 "In other languages, optional arguments are expressed in the way that is "
3697 "natural for that language. We refer you to the language-specific "
3698 "documentation for more details on that."
3703 #: ../src/guestfs.pod:1665
3704 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3709 #: ../src/guestfs.pod:1667
3710 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3714 #: ../src/guestfs.pod:1669
3716 "B<Note:> This section documents the generic event mechanism introduced in "
3717 "libguestfs 1.10, which you should use in new code if possible. The old "
3718 "functions C<guestfs_set_log_message_callback>, "
3719 "C<guestfs_set_subprocess_quit_callback>, "
3720 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3721 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3726 #: ../src/guestfs.pod:1677
3728 "Handles generate events when certain things happen, such as log messages "
3729 "being generated, progress messages during long-running operations, or the "
3730 "handle being closed. The API calls described below let you register a "
3731 "callback to be called when events happen. You can register multiple "
3732 "callbacks (for the same, different or overlapping sets of events), and "
3733 "individually remove callbacks. If callbacks are not removed, then they "
3734 "remain in force until the handle is closed."
3738 #: ../src/guestfs.pod:1685
3740 "In the current implementation, events are only generated synchronously: that "
3741 "means that events (and hence callbacks) can only happen while you are in the "
3742 "middle of making another libguestfs call. The callback is called in the "
3747 #: ../src/guestfs.pod:1690
3749 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3750 "unsigned integers, or a message buffer. Payloads are discussed later on."
3754 #: ../src/guestfs.pod:1694
3755 msgid "CLASSES OF EVENTS"
3759 #: ../src/guestfs.pod:1698
3760 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3764 #: ../src/guestfs.pod:1701
3766 "The callback function will be called while the handle is being closed "
3767 "(synchronously from L</guestfs_close>)."
3772 #: ../src/guestfs.pod:1704
3774 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3775 "handles that are open when the program exits. This means that this callback "
3776 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3777 "problems in higher-level languages (eg. if your HLL interpreter has already "
3778 "been cleaned up by the time this is called, and if your callback then jumps "
3779 "into some HLL function)."
3783 #: ../src/guestfs.pod:1711
3785 "If no callback is registered: the handle is closed without any callback "
3790 #: ../src/guestfs.pod:1714
3791 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3795 #: ../src/guestfs.pod:1717
3797 "The callback function will be called when the child process quits, either "
3798 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3799 "corresponds to a transition from any state to the CONFIG state)."
3803 #: ../src/guestfs.pod:1721 ../src/guestfs.pod:1730
3804 msgid "If no callback is registered: the event is ignored."
3808 #: ../src/guestfs.pod:1723
3809 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3813 #: ../src/guestfs.pod:1726
3815 "The callback function will be called when the child process becomes ready "
3816 "first time after it has been launched. (This corresponds to a transition "
3817 "from LAUNCHING to the READY state)."
3821 #: ../src/guestfs.pod:1732
3822 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3827 #: ../src/guestfs.pod:1735
3829 "Some long-running operations can generate progress messages. If this "
3830 "callback is registered, then it will be called each time a progress message "
3831 "is generated (usually two seconds after the operation started, and three "
3832 "times per second thereafter until it completes, although the frequency may "
3833 "change in future versions)."
3837 #: ../src/guestfs.pod:1741
3839 "The callback receives in the payload four unsigned 64 bit numbers which are "
3840 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3844 #: ../src/guestfs.pod:1744
3846 "The units of C<total> are not defined, although for some operations C<total> "
3847 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3848 "or megabytes), and C<position> may be the portion which has been transferred."
3853 #: ../src/guestfs.pod:1749
3854 msgid "The only defined and stable parts of the API are:"
3859 #: ../src/guestfs.pod:1755
3861 "The callback can display to the user some type of progress bar or indicator "
3862 "which shows the ratio of C<position>:C<total>."
3867 #: ../src/guestfs.pod:1760
3868 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3872 #: ../src/guestfs.pod:1764
3874 "If any progress notification is sent during a call, then a final progress "
3875 "notification is always sent when C<position> = C<total> (I<unless> the call "
3876 "fails with an error)."
3881 #: ../src/guestfs.pod:1768
3883 "This is to simplify caller code, so callers can easily set the progress "
3884 "indicator to \"100%\" at the end of the operation, without requiring special "
3885 "code to detect this case."
3889 #: ../src/guestfs.pod:1774
3891 "For some calls we are unable to estimate the progress of the call, but we "
3892 "can still generate progress messages to indicate activity. This is known as "
3893 "\"pulse mode\", and is directly supported by certain progress bar "
3894 "implementations (eg. GtkProgressBar)."
3898 #: ../src/guestfs.pod:1779
3900 "For these calls, zero or more progress messages are generated with "
3901 "C<position = 0> and C<total = 1>, followed by a final message with "
3902 "C<position = total = 1>."
3906 #: ../src/guestfs.pod:1783
3908 "As noted above, if the call fails with an error then the final message may "
3913 #: ../src/guestfs.pod:1788
3915 "The callback also receives the procedure number (C<proc_nr>) and serial "
3916 "number (C<serial>) of the call. These are only useful for debugging "
3917 "protocol issues, and the callback can normally ignore them. The callback "
3918 "may want to print these numbers in error messages or debugging messages."
3922 #: ../src/guestfs.pod:1794
3923 msgid "If no callback is registered: progress messages are discarded."
3927 #: ../src/guestfs.pod:1796
3928 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3932 #: ../src/guestfs.pod:1799
3934 "The callback function is called whenever a log message is generated by qemu, "
3935 "the appliance kernel, guestfsd (daemon), or utility programs."
3939 #: ../src/guestfs.pod:1802
3941 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3942 "guestfs_launch>) then additional debug messages are generated."
3946 #: ../src/guestfs.pod:1805 ../src/guestfs.pod:1819
3948 "If no callback is registered: the messages are discarded unless the verbose "
3949 "flag is set in which case they are sent to stderr. You can override the "
3950 "printing of verbose messages to stderr by setting up a callback."
3954 #: ../src/guestfs.pod:1810
3955 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3959 #: ../src/guestfs.pod:1813
3961 "The callback function is called whenever a log message is generated by the "
3962 "library part of libguestfs."
3966 #: ../src/guestfs.pod:1816
3968 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3969 "messages are generated."
3973 #: ../src/guestfs.pod:1824
3974 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3978 #: ../src/guestfs.pod:1827
3980 "The callback function is called whenever a trace message is generated. This "
3981 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3985 #: ../src/guestfs.pod:1830
3987 "If no callback is registered: the messages are sent to stderr. You can "
3988 "override the printing of trace messages to stderr by setting up a callback."
3992 #: ../src/guestfs.pod:1836
3993 msgid "guestfs_set_event_callback"
3997 #: ../src/guestfs.pod:1838
4000 " int guestfs_set_event_callback (guestfs_h *g,\n"
4001 " guestfs_event_callback cb,\n"
4002 " uint64_t event_bitmask,\n"
4009 #: ../src/guestfs.pod:1844
4011 "This function registers a callback (C<cb>) for all event classes in the "
4016 #: ../src/guestfs.pod:1847
4018 "For example, to register for all log message events, you could call this "
4019 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4020 "To register a single callback for all possible classes of events, use "
4021 "C<GUESTFS_EVENT_ALL>."
4025 #: ../src/guestfs.pod:1853
4026 msgid "C<flags> should always be passed as 0."
4030 #: ../src/guestfs.pod:1855
4032 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4033 "it for any purpose."
4037 #: ../src/guestfs.pod:1858
4039 "The return value is the event handle (an integer) which you can use to "
4040 "delete the callback (see below)."
4044 #: ../src/guestfs.pod:1861
4046 "If there is an error, this function returns C<-1>, and sets the error in the "
4047 "handle in the usual way (see L</guestfs_last_error> etc.)"
4051 #: ../src/guestfs.pod:1864
4053 "Callbacks remain in effect until they are deleted, or until the handle is "
4058 #: ../src/guestfs.pod:1867
4060 "In the case where multiple callbacks are registered for a particular event "
4061 "class, all of the callbacks are called. The order in which multiple "
4062 "callbacks are called is not defined."
4066 #: ../src/guestfs.pod:1871
4067 msgid "guestfs_delete_event_callback"
4071 #: ../src/guestfs.pod:1873
4074 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4079 #: ../src/guestfs.pod:1875
4081 "Delete a callback that was previously registered. C<event_handle> should be "
4082 "the integer that was returned by a previous call to "
4083 "C<guestfs_set_event_callback> on the same handle."
4087 #: ../src/guestfs.pod:1879
4088 msgid "guestfs_event_callback"
4092 #: ../src/guestfs.pod:1881
4095 " typedef void (*guestfs_event_callback) (\n"
4098 " uint64_t event,\n"
4099 " int event_handle,\n"
4101 " const char *buf, size_t buf_len,\n"
4102 " const uint64_t *array, size_t array_len);\n"
4107 #: ../src/guestfs.pod:1890
4109 "This is the type of the event callback function that you have to provide."
4113 #: ../src/guestfs.pod:1893
4115 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4116 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4117 "handle, and C<flags> which in the current API you should ignore."
4121 #: ../src/guestfs.pod:1897
4123 "The remaining parameters contain the event payload (if any). Each event may "
4124 "contain a payload, which usually relates to the event class, but for future "
4125 "proofing your code should be written to handle any payload for any event "
4130 #: ../src/guestfs.pod:1902
4132 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4133 "there is no message buffer). Note that this message buffer can contain "
4134 "arbitrary 8 bit data, including NUL bytes."
4138 #: ../src/guestfs.pod:1906
4140 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4141 "moment this is only used for progress messages."
4145 #: ../src/guestfs.pod:1909
4146 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4150 #: ../src/guestfs.pod:1911
4152 "One motivation for the generic event API was to allow GUI programs to "
4153 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4154 "unconditionally to C<stderr>."
4158 #: ../src/guestfs.pod:1915
4160 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4161 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4162 "messages are not events; you must capture error messages separately)."
4166 #: ../src/guestfs.pod:1920
4168 "Programs have to set up a callback to capture the classes of events of "
4173 #: ../src/guestfs.pod:1923
4177 " guestfs_set_event_callback\n"
4178 " (g, message_callback,\n"
4179 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4180 " GUESTFS_EVENT_TRACE,\n"
4181 " 0, NULL) == -1)\n"
4182 " if (eh == -1) {\n"
4183 " // handle error in the usual way\n"
4189 #: ../src/guestfs.pod:1933
4191 "The callback can then direct messages to the appropriate place. In this "
4192 "example, messages are directed to syslog:"
4196 #: ../src/guestfs.pod:1936
4200 " message_callback (\n"
4203 " uint64_t event,\n"
4204 " int event_handle,\n"
4206 " const char *buf, size_t buf_len,\n"
4207 " const uint64_t *array, size_t array_len)\n"
4209 " const int priority = LOG_USER|LOG_INFO;\n"
4210 " if (buf_len > 0)\n"
4211 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4218 #: ../src/guestfs.pod:1951
4219 msgid "PRIVATE DATA AREA"
4223 #: ../src/guestfs.pod:1953
4225 "You can attach named pieces of private data to the libguestfs handle, fetch "
4226 "them by name, and walk over them, for the lifetime of the handle. This is "
4227 "called the private data area and is only available from the C API."
4232 #: ../src/guestfs.pod:1958
4233 msgid "To attach a named piece of data, use the following call:"
4238 #: ../src/guestfs.pod:1960
4241 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4246 #: ../src/guestfs.pod:1962
4248 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4249 "pointer (which can be C<NULL>). Any previous item with the same key is "
4254 #: ../src/guestfs.pod:1966
4256 "You can use any C<key> you want, but your key should I<not> start with an "
4257 "underscore character. Keys beginning with an underscore character are "
4258 "reserved for internal libguestfs purposes (eg. for implementing language "
4259 "bindings). It is recommended that you prefix the key with some unique "
4260 "string to avoid collisions with other users."
4265 #: ../src/guestfs.pod:1972
4266 msgid "To retrieve the pointer, use:"
4271 #: ../src/guestfs.pod:1974
4274 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4280 #: ../src/guestfs.pod:1976
4282 "This function returns C<NULL> if either no data is found associated with "
4283 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4288 #: ../src/guestfs.pod:1980
4290 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4291 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4292 "all. In particular, libguestfs does I<not> try to free the data when the "
4293 "handle is closed. If the data must be freed, then the caller must either "
4294 "free it before calling L</guestfs_close> or must set up a close callback to "
4295 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4299 #: ../src/guestfs.pod:1987
4300 msgid "To walk over all entries, use these two functions:"
4304 #: ../src/guestfs.pod:1989
4307 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4312 #: ../src/guestfs.pod:1991
4315 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4320 #: ../src/guestfs.pod:1993
4322 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4323 "not have any particular meaning -- keys are not returned in any defined "
4324 "order). A pointer to the key is returned in C<*key_rtn> and the "
4325 "corresponding data pointer is returned from the function. C<NULL> is "
4326 "returned if there are no keys stored in the handle."
4330 #: ../src/guestfs.pod:1999
4332 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4333 "value of this function is also C<NULL> is there are no further entries to "
4338 #: ../src/guestfs.pod:2003
4339 msgid "Notes about walking over entries:"
4343 #: ../src/guestfs.pod:2009
4345 "You must not call C<guestfs_set_private> while walking over the entries."
4349 #: ../src/guestfs.pod:2014
4351 "The handle maintains an internal iterator which is reset when you call "
4352 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4353 "call C<guestfs_set_private>."
4357 #: ../src/guestfs.pod:2020
4358 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4362 #: ../src/guestfs.pod:2022
4365 " guestfs_set_private (g, key, NULL);\n"
4370 #: ../src/guestfs.pod:2024
4371 msgid "then that C<key> is not returned when walking."
4375 #: ../src/guestfs.pod:2028
4377 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4378 "C<guestfs_next_private> or C<guestfs_set_private>."
4382 #: ../src/guestfs.pod:2034
4384 "The following example code shows how to print all keys and data pointers "
4385 "that are associated with the handle C<g>:"
4389 #: ../src/guestfs.pod:2037
4392 " const char *key;\n"
4393 " void *data = guestfs_first_private (g, &key);\n"
4394 " while (data != NULL)\n"
4396 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4397 " data = guestfs_next_private (g, &key);\n"
4403 #: ../src/guestfs.pod:2045
4405 "More commonly you are only interested in keys that begin with an application-"
4406 "specific prefix C<foo_>. Modify the loop like so:"
4410 #: ../src/guestfs.pod:2048
4413 " const char *key;\n"
4414 " void *data = guestfs_first_private (g, &key);\n"
4415 " while (data != NULL)\n"
4417 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4418 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4419 " data = guestfs_next_private (g, &key);\n"
4425 #: ../src/guestfs.pod:2057
4427 "If you need to modify keys while walking, then you have to jump back to the "
4428 "beginning of the loop. For example, to delete all keys prefixed with "
4433 #: ../src/guestfs.pod:2061
4436 " const char *key;\n"
4439 " data = guestfs_first_private (g, &key);\n"
4440 " while (data != NULL)\n"
4442 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4444 " guestfs_set_private (g, key, NULL);\n"
4445 " /* note that 'key' pointer is now invalid, and so is\n"
4446 " the internal iterator */\n"
4449 " data = guestfs_next_private (g, &key);\n"
4455 #: ../src/guestfs.pod:2077
4457 "Note that the above loop is guaranteed to terminate because the keys are "
4458 "being deleted, but other manipulations of keys within the loop might not "
4459 "terminate unless you also maintain an indication of which keys have been "
4465 #: ../src/guestfs.pod:2082 ../src/guestfs.pod:2087
4471 #: ../src/guestfs.pod:2084
4473 "<!-- old anchor for the next section --> <a name="
4474 "\"state_machine_and_low_level_event_api\"/>"
4479 #: ../src/guestfs.pod:2089
4480 msgid "ARCHITECTURE"
4485 #: ../src/guestfs.pod:2091
4487 "Internally, libguestfs is implemented by running an appliance (a special "
4488 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4489 "process of the main program."
4494 #: ../src/guestfs.pod:2095
4497 " ___________________\n"
4499 " | main program |\n"
4501 " | | child process / appliance\n"
4502 " | | __________________________\n"
4504 " +-------------------+ RPC | +-----------------+ |\n"
4505 " | libguestfs <--------------------> guestfsd | |\n"
4506 " | | | +-----------------+ |\n"
4507 " \\___________________/ | | Linux kernel | |\n"
4508 " | +--^--------------+ |\n"
4509 " \\_________|________________/\n"
4515 " \\______________/\n"
4521 #: ../src/guestfs.pod:2115
4523 "The library, linked to the main program, creates the child process and hence "
4524 "the appliance in the L</guestfs_launch> function."
4529 #: ../src/guestfs.pod:2118
4531 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4532 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4533 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4534 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4535 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4536 "attached to the qemu process which translates device access by the "
4537 "appliance's Linux kernel into accesses to the image."
4542 #: ../src/guestfs.pod:2127
4544 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4545 "Although the disk image you are attached to might also be used by some "
4546 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4547 "care if both libguestfs's qemu process and your virtual machine are trying "
4548 "to update the disk image at the same time, since these usually results in "
4549 "massive disk corruption)."
4554 #: ../src/guestfs.pod:2134
4555 msgid "STATE MACHINE"
4560 #: ../src/guestfs.pod:2136
4561 msgid "libguestfs uses a state machine to model the child process:"
4566 #: ../src/guestfs.pod:2138
4578 " / | \\ \\ guestfs_launch\n"
4579 " / | _\\__V______\n"
4581 " / | | LAUNCHING |\n"
4582 " / | \\___________/\n"
4584 " / | guestfs_launch\n"
4586 " ______ / __|____V\n"
4587 " / \\ ------> / \\\n"
4588 " | BUSY | | READY |\n"
4589 " \\______/ <------ \\________/\n"
4595 #: ../src/guestfs.pod:2160
4597 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4598 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4599 "(3) alternating between READY and BUSY as commands are issued to, and "
4600 "carried out by, the child process."
4605 #: ../src/guestfs.pod:2165
4607 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4608 "asynchronously at any time (eg. due to some internal error), and that causes "
4609 "the state to transition back to CONFIG."
4614 #: ../src/guestfs.pod:2169
4616 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4617 "issued when in the CONFIG state."
4622 #: ../src/guestfs.pod:2172
4624 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4625 "L</guestfs_launch> blocks until the child process is READY to accept "
4626 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4627 "moves the state from CONFIG to LAUNCHING while it is running."
4632 #: ../src/guestfs.pod:2178
4634 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4635 "state. These API calls block waiting for the command to be carried out (ie. "
4636 "the state to transition to BUSY and then back to READY). There are no non-"
4637 "blocking versions, and no way to issue more than one command per handle at "
4643 #: ../src/guestfs.pod:2184
4645 "Finally, the child process sends asynchronous messages back to the main "
4646 "program, such as kernel log messages. You can register a callback to "
4647 "receive these messages."
4652 #: ../src/guestfs.pod:2188
4658 #: ../src/guestfs.pod:2190
4659 msgid "COMMUNICATION PROTOCOL"
4664 #: ../src/guestfs.pod:2192
4666 "Don't rely on using this protocol directly. This section documents how it "
4667 "currently works, but it may change at any time."
4672 #: ../src/guestfs.pod:2195
4674 "The protocol used to talk between the library and the daemon running inside "
4675 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4676 "1014, RFC 1832, RFC 4506)."
4681 #: ../src/guestfs.pod:2199
4683 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4684 "this file is automatically generated)."
4689 #: ../src/guestfs.pod:2202
4691 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4692 "and C<FileOut> parameters, which are handled with very simple request/reply "
4693 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4694 "parameters, which use the same request and reply messages, but they may also "
4695 "be followed by files sent using a chunked encoding."
4700 #: ../src/guestfs.pod:2209
4701 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4706 #: ../src/guestfs.pod:2211
4707 msgid "For ordinary functions, the request message is:"
4712 #: ../src/guestfs.pod:2213
4715 " total length (header + arguments,\n"
4716 " but not including the length word itself)\n"
4717 " struct guestfs_message_header (encoded as XDR)\n"
4718 " struct guestfs_<foo>_args (encoded as XDR)\n"
4724 #: ../src/guestfs.pod:2218
4726 "The total length field allows the daemon to allocate a fixed size buffer "
4727 "into which it slurps the rest of the message. As a result, the total length "
4728 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4729 "effective size of any request is limited to somewhere under this size."
4734 #: ../src/guestfs.pod:2224
4736 "Note also that many functions don't take any arguments, in which case the "
4737 "C<guestfs_I<foo>_args> is completely omitted."
4742 #: ../src/guestfs.pod:2227
4744 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4745 "receiver knows what type of args structure to expect, or none at all."
4750 #: ../src/guestfs.pod:2231
4752 "For functions that take optional arguments, the optional arguments are "
4753 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4754 "arguments. A bitmask in the header indicates which optional arguments are "
4755 "meaningful. The bitmask is also checked to see if it contains bits set "
4756 "which the daemon does not know about (eg. if more optional arguments were "
4757 "added in a later version of the library), and this causes the call to be "
4763 #: ../src/guestfs.pod:2239
4764 msgid "The reply message for ordinary functions is:"
4769 #: ../src/guestfs.pod:2241
4772 " total length (header + ret,\n"
4773 " but not including the length word itself)\n"
4774 " struct guestfs_message_header (encoded as XDR)\n"
4775 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4781 #: ../src/guestfs.pod:2246
4783 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4784 "functions that return no formal return values."
4789 #: ../src/guestfs.pod:2249
4791 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4796 #: ../src/guestfs.pod:2252
4798 "In the case of an error, a flag is set in the header, and the reply message "
4799 "is slightly changed:"
4804 #: ../src/guestfs.pod:2255
4807 " total length (header + error,\n"
4808 " but not including the length word itself)\n"
4809 " struct guestfs_message_header (encoded as XDR)\n"
4810 " struct guestfs_message_error (encoded as XDR)\n"
4816 #: ../src/guestfs.pod:2260
4818 "The C<guestfs_message_error> structure contains the error message as a "
4824 #: ../src/guestfs.pod:2263
4825 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4830 #: ../src/guestfs.pod:2265
4832 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4833 "The normal request message is sent (see above). However this is followed by "
4834 "a sequence of file chunks."
4839 #: ../src/guestfs.pod:2269
4842 " total length (header + arguments,\n"
4843 " but not including the length word itself,\n"
4844 " and not including the chunks)\n"
4845 " struct guestfs_message_header (encoded as XDR)\n"
4846 " struct guestfs_<foo>_args (encoded as XDR)\n"
4847 " sequence of chunks for FileIn param #0\n"
4848 " sequence of chunks for FileIn param #1 etc.\n"
4854 #: ../src/guestfs.pod:2277
4855 msgid "The \"sequence of chunks\" is:"
4860 #: ../src/guestfs.pod:2279
4863 " length of chunk (not including length word itself)\n"
4864 " struct guestfs_chunk (encoded as XDR)\n"
4865 " length of chunk\n"
4866 " struct guestfs_chunk (encoded as XDR)\n"
4868 " length of chunk\n"
4869 " struct guestfs_chunk (with data.data_len == 0)\n"
4875 #: ../src/guestfs.pod:2287
4877 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4878 "is set in the final chunk to indicate either successful completion or early "
4884 #: ../src/guestfs.pod:2291
4886 "At time of writing there are no functions that have more than one FileIn "
4887 "parameter. However this is (theoretically) supported, by sending the "
4888 "sequence of chunks for each FileIn parameter one after another (from left to "
4894 #: ../src/guestfs.pod:2296
4896 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4897 "transfer. The library does this by sending a chunk with a special flag set "
4898 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4899 "RPC, does I<not> send any reply, and goes back to reading the next request."
4904 #: ../src/guestfs.pod:2302
4906 "The daemon may also cancel. It does this by writing a special word "
4907 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4908 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4909 "cancel chunk). The special word is chosen so that even if cancellation "
4910 "happens right at the end of the transfer (after the library has finished "
4911 "writing and has started listening for the reply), the \"spurious\" cancel "
4912 "flag will not be confused with the reply message."
4917 #: ../src/guestfs.pod:2311
4919 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4920 "limit), and also files where the size is not known in advance (eg. from "
4921 "pipes or sockets). However the chunks are rather small "
4922 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4923 "to keep much in memory."
4928 #: ../src/guestfs.pod:2317
4929 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4934 #: ../src/guestfs.pod:2319
4936 "The protocol for FileOut parameters is exactly the same as for FileIn "
4937 "parameters, but with the roles of daemon and library reversed."
4942 #: ../src/guestfs.pod:2322
4945 " total length (header + ret,\n"
4946 " but not including the length word itself,\n"
4947 " and not including the chunks)\n"
4948 " struct guestfs_message_header (encoded as XDR)\n"
4949 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4950 " sequence of chunks for FileOut param #0\n"
4951 " sequence of chunks for FileOut param #1 etc.\n"
4957 #: ../src/guestfs.pod:2330
4958 msgid "INITIAL MESSAGE"
4963 #: ../src/guestfs.pod:2332
4965 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4966 "which indicates that the guest and daemon is alive. This is what L</"
4967 "guestfs_launch> waits for."
4972 #: ../src/guestfs.pod:2336
4973 msgid "PROGRESS NOTIFICATION MESSAGES"
4978 #: ../src/guestfs.pod:2338
4980 "The daemon may send progress notification messages at any time. These are "
4981 "distinguished by the normal length word being replaced by "
4982 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4986 #: ../src/guestfs.pod:2342
4988 "The library turns them into progress callbacks (see L</"
4989 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4995 #: ../src/guestfs.pod:2346
4997 "The daemon self-limits the frequency of progress messages it sends (see "
4998 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5004 #: ../src/guestfs.pod:2350
5005 msgid "LIBGUESTFS VERSION NUMBERS"
5010 #: ../src/guestfs.pod:2352
5012 "Since April 2010, libguestfs has started to make separate development and "
5013 "stable releases, along with corresponding branches in our git repository. "
5014 "These separate releases can be identified by version number:"
5019 #: ../src/guestfs.pod:2357
5022 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5023 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5029 " | `-------- sub-version\n"
5031 " `------ always '1' because we don't change the ABI\n"
5037 #: ../src/guestfs.pod:2368
5038 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5043 #: ../src/guestfs.pod:2370
5045 "As time passes we cherry pick fixes from the development branch and backport "
5046 "those into the stable branch, the effect being that the stable branch should "
5047 "get more stable and less buggy over time. So the stable releases are ideal "
5048 "for people who don't need new features but would just like the software to "
5054 #: ../src/guestfs.pod:2376
5055 msgid "Our criteria for backporting changes are:"
5060 #: ../src/guestfs.pod:2382
5062 "Documentation changes which don't affect any code are backported unless the "
5063 "documentation refers to a future feature which is not in stable."
5068 #: ../src/guestfs.pod:2388
5070 "Bug fixes which are not controversial, fix obvious problems, and have been "
5071 "well tested are backported."
5076 #: ../src/guestfs.pod:2393
5078 "Simple rearrangements of code which shouldn't affect how it works get "
5079 "backported. This is so that the code in the two branches doesn't get too "
5080 "far out of step, allowing us to backport future fixes more easily."
5085 #: ../src/guestfs.pod:2399
5087 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5088 "exceptional case: the new feature is required in order to implement an "
5089 "important bug fix."
5094 #: ../src/guestfs.pod:2405
5096 "A new stable branch starts when we think the new features in development are "
5097 "substantial and compelling enough over the current stable branch to warrant "
5098 "it. When that happens we create new stable and development versions 1.N.0 "
5099 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5100 "stable at this point, but by backporting fixes from development, that branch "
5101 "will stabilize over time."
5105 #: ../src/guestfs.pod:2413
5106 msgid "EXTENDING LIBGUESTFS"
5110 #: ../src/guestfs.pod:2415
5111 msgid "ADDING A NEW API ACTION"
5115 #: ../src/guestfs.pod:2417
5117 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5118 "documentation) are generated, and this makes it easy to extend the "
5123 #: ../src/guestfs.pod:2421
5124 msgid "To add a new API action there are two changes:"
5128 #: ../src/guestfs.pod:2427
5130 "You need to add a description of the call (name, parameters, return type, "
5131 "tests, documentation) to C<generator/generator_actions.ml>."
5135 #: ../src/guestfs.pod:2430
5137 "There are two sorts of API action, depending on whether the call goes "
5138 "through to the daemon in the appliance, or is serviced entirely by the "
5139 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5140 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5141 "an example of the latter, since a trace flag is maintained in the handle and "
5142 "all tracing is done on the library side."
5146 #: ../src/guestfs.pod:2438
5148 "Most new actions are of the first type, and get added to the "
5149 "C<daemon_functions> list. Each function has a unique procedure number used "
5150 "in the RPC protocol which is assigned to that action when we publish "
5151 "libguestfs and cannot be reused. Take the latest procedure number and "
5156 #: ../src/guestfs.pod:2444
5158 "For library-only actions of the second type, add to the "
5159 "C<non_daemon_functions> list. Since these functions are serviced by the "
5160 "library and do not travel over the RPC mechanism to the daemon, these "
5161 "functions do not need a procedure number, and so the procedure number is set "
5166 #: ../src/guestfs.pod:2452
5167 msgid "Implement the action (in C):"
5171 #: ../src/guestfs.pod:2454
5173 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5174 "C<daemon/> directory."
5178 #: ../src/guestfs.pod:2457
5180 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5181 "(note: double underscore) in the C<src/> directory."
5185 #: ../src/guestfs.pod:2460
5186 msgid "In either case, use another function as an example of what to do."
5190 #: ../src/guestfs.pod:2464
5191 msgid "After making these changes, use C<make> to compile."
5195 #: ../src/guestfs.pod:2466
5197 "Note that you don't need to implement the RPC, language bindings, manual "
5198 "pages or anything else. It's all automatically generated from the OCaml "
5203 #: ../src/guestfs.pod:2470
5204 msgid "ADDING TESTS FOR AN API ACTION"
5208 #: ../src/guestfs.pod:2472
5210 "You can supply zero or as many tests as you want per API call. The tests "
5211 "can either be added as part of the API description (C<generator/"
5212 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5213 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5214 "slower, so if possible use the first method."
5218 #: ../src/guestfs.pod:2478
5220 "The following describes the test environment used when you add an API test "
5221 "in C<generator_actions.ml>."
5225 #: ../src/guestfs.pod:2481
5226 msgid "The test environment has 4 block devices:"
5230 #: ../src/guestfs.pod:2485
5231 msgid "C</dev/sda> 500MB"
5235 #: ../src/guestfs.pod:2487
5236 msgid "General block device for testing."
5240 #: ../src/guestfs.pod:2489
5241 msgid "C</dev/sdb> 50MB"
5245 #: ../src/guestfs.pod:2491
5247 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5252 #: ../src/guestfs.pod:2494
5253 msgid "C</dev/sdc> 10MB"
5257 #: ../src/guestfs.pod:2496
5258 msgid "Used in a few tests where two block devices are needed."
5262 #: ../src/guestfs.pod:2498
5267 #: ../src/guestfs.pod:2500
5268 msgid "ISO with fixed content (see C<images/test.iso>)."
5272 #: ../src/guestfs.pod:2504
5274 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5275 "appliance and block devices are reused between tests. So don't try testing "
5276 "L</guestfs_kill_subprocess> :-x"
5280 #: ../src/guestfs.pod:2508
5282 "Each test starts with an initial scenario, selected using one of the "
5283 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5284 "initialize the disks mentioned above in a particular way as documented in "
5285 "C<generator_types.ml>. You should not assume anything about the previous "
5286 "contents of other disks that are not initialized."
5290 #: ../src/guestfs.pod:2514
5292 "You can add a prerequisite clause to any individual test. This is a run-"
5293 "time check, which, if it fails, causes the test to be skipped. Useful if "
5294 "testing a command which might not work on all variations of libguestfs "
5295 "builds. A test that has prerequisite of C<Always> means to run "
5300 #: ../src/guestfs.pod:2520
5302 "In addition, packagers can skip individual tests by setting environment "
5303 "variables before running C<make check>."
5307 #: ../src/guestfs.pod:2523
5310 " SKIP_TEST_<CMD>_<NUM>=1\n"
5315 #: ../src/guestfs.pod:2525
5316 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5320 #: ../src/guestfs.pod:2527
5325 #: ../src/guestfs.pod:2529
5328 " SKIP_TEST_<CMD>=1\n"
5333 #: ../src/guestfs.pod:2531
5334 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5338 #: ../src/guestfs.pod:2533
5339 msgid "Packagers can run only certain tests by setting for example:"
5343 #: ../src/guestfs.pod:2535
5346 " TEST_ONLY=\"vfs_type zerofree\"\n"
5351 #: ../src/guestfs.pod:2537
5353 "See C<capitests/tests.c> for more details of how these environment variables "
5358 #: ../src/guestfs.pod:2540
5359 msgid "DEBUGGING NEW API ACTIONS"
5363 #: ../src/guestfs.pod:2542
5364 msgid "Test new actions work before submitting them."
5368 #: ../src/guestfs.pod:2544
5369 msgid "You can use guestfish to try out new commands."
5373 #: ../src/guestfs.pod:2546
5375 "Debugging the daemon is a problem because it runs inside a minimal "
5376 "environment. However you can fprintf messages in the daemon to stderr, and "
5377 "they will show up if you use C<guestfish -v>."
5381 #: ../src/guestfs.pod:2550
5382 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5386 #: ../src/guestfs.pod:2552
5388 "Our C source code generally adheres to some basic code-formatting "
5389 "conventions. The existing code base is not totally consistent on this "
5390 "front, but we do prefer that contributed code be formatted similarly. In "
5391 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5392 "indentation level, and other than that, follow the K&R style."
5396 #: ../src/guestfs.pod:2558
5398 "If you use Emacs, add the following to one of one of your start-up files (e."
5399 "g., ~/.emacs), to help ensure that you get indentation right:"
5403 #: ../src/guestfs.pod:2561
5406 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5407 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5408 " (add-hook 'find-file-hook\n"
5409 " '(lambda () (if (and buffer-file-name\n"
5410 " (string-match \"/libguestfs\\\\>\"\n"
5411 " (buffer-file-name))\n"
5412 " (not (string-equal mode-name \"Change Log\"))\n"
5413 " (not (string-equal mode-name \"Makefile\")))\n"
5414 " (setq indent-tabs-mode nil))))\n"
5419 #: ../src/guestfs.pod:2571
5422 " ;;; When editing C sources in libguestfs, use this style.\n"
5423 " (defun libguestfs-c-mode ()\n"
5424 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5426 " (c-set-style \"K&R\")\n"
5427 " (setq c-indent-level 2)\n"
5428 " (setq c-basic-offset 2))\n"
5429 " (add-hook 'c-mode-hook\n"
5430 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5431 " (buffer-file-name))\n"
5432 " (libguestfs-c-mode))))\n"
5437 #: ../src/guestfs.pod:2583
5438 msgid "Enable warnings when compiling (and fix any problems this finds):"
5442 #: ../src/guestfs.pod:2586
5445 " ./configure --enable-gcc-warnings\n"
5450 #: ../src/guestfs.pod:2588
5451 msgid "Useful targets are:"
5455 #: ../src/guestfs.pod:2590
5458 " make syntax-check # checks the syntax of the C code\n"
5459 " make check # runs the test suite\n"
5464 #: ../src/guestfs.pod:2593
5465 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5469 #: ../src/guestfs.pod:2595
5471 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5472 "which are used to do shell quoting."
5476 #: ../src/guestfs.pod:2600
5481 #: ../src/guestfs.pod:2602
5483 "Simple shell quoted string. Any spaces or other shell characters are "
5488 #: ../src/guestfs.pod:2605
5493 #: ../src/guestfs.pod:2607
5495 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5501 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5502 msgid "For example:"
5506 #: ../src/guestfs.pod:2614
5509 " asprintf (&cmd, \"cat %R\", path);\n"
5514 #: ../src/guestfs.pod:2616
5515 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5519 #: ../src/guestfs.pod:2618
5521 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5522 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5523 "they are not passed via the shell (instead, straight to exec). You probably "
5524 "want to use the C<sysroot_path()> function however."
5528 #: ../src/guestfs.pod:2624
5529 msgid "SUBMITTING YOUR NEW API ACTIONS"
5533 #: ../src/guestfs.pod:2626
5535 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5536 "libguestfs> and CC to L<rjones@redhat.com>."
5540 #: ../src/guestfs.pod:2630
5541 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5545 #: ../src/guestfs.pod:2632
5546 msgid "We support i18n (gettext anyhow) in the library."
5550 #: ../src/guestfs.pod:2634
5552 "However many messages come from the daemon, and we don't translate those at "
5553 "the moment. One reason is that the appliance generally has all locale files "
5554 "removed from it, because they take up a lot of space. So we'd have to readd "
5555 "some of those, as well as copying our PO files into the appliance."
5559 #: ../src/guestfs.pod:2640
5561 "Debugging messages are never translated, since they are intended for the "
5566 #: ../src/guestfs.pod:2643
5567 msgid "SOURCE CODE SUBDIRECTORIES"
5571 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5814
5572 #: ../fish/guestfish-actions.pod:3908
5573 msgid "C<appliance>"
5577 #: ../src/guestfs.pod:2649
5578 msgid "The libguestfs appliance, build scripts and so on."
5582 #: ../src/guestfs.pod:2651
5583 msgid "C<capitests>"
5587 #: ../src/guestfs.pod:2653
5588 msgid "Automated tests of the C API."
5592 #: ../src/guestfs.pod:2655
5597 #: ../src/guestfs.pod:2657
5599 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5604 #: ../src/guestfs.pod:2660
5609 #: ../src/guestfs.pod:2662
5610 msgid "Outside contributions, experimental parts."
5614 #: ../src/guestfs.pod:2664
5619 #: ../src/guestfs.pod:2666
5621 "The daemon that runs inside the libguestfs appliance and carries out actions."
5625 #: ../src/guestfs.pod:2669
5630 #: ../src/guestfs.pod:2671
5631 msgid "L<virt-df(1)> command and documentation."
5635 #: ../src/guestfs.pod:2673
5640 #: ../src/guestfs.pod:2675
5641 msgid "C API example code."
5645 #: ../src/guestfs.pod:2677
5650 #: ../src/guestfs.pod:2679
5652 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5653 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5654 "L<virt-tar-out(1)>."
5658 #: ../src/guestfs.pod:2683
5663 #: ../src/guestfs.pod:2685
5665 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5669 #: ../src/guestfs.pod:2687
5670 msgid "C<generator>"
5674 #: ../src/guestfs.pod:2689
5676 "The crucially important generator, used to automatically generate large "
5677 "amounts of boilerplate C code for things like RPC and bindings."
5681 #: ../src/guestfs.pod:2692
5686 #: ../src/guestfs.pod:2694
5687 msgid "Files used by the test suite."
5691 #: ../src/guestfs.pod:2696
5692 msgid "Some \"phony\" guest images which we test against."
5696 #: ../src/guestfs.pod:2698
5697 msgid "C<inspector>"
5701 #: ../src/guestfs.pod:2700
5702 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5706 #: ../src/guestfs.pod:2702
5711 #: ../src/guestfs.pod:2704
5712 msgid "Logo used on the website. The fish is called Arthur by the way."
5716 #: ../src/guestfs.pod:2706
5721 #: ../src/guestfs.pod:2708
5722 msgid "M4 macros used by autoconf."
5726 #: ../src/guestfs.pod:2710
5731 #: ../src/guestfs.pod:2712
5732 msgid "Translations of simple gettext strings."
5736 #: ../src/guestfs.pod:2714
5741 #: ../src/guestfs.pod:2716
5743 "The build infrastructure and PO files for translations of manpages and POD "
5744 "files. Eventually this will be combined with the C<po> directory, but that "
5745 "is rather complicated."
5749 #: ../src/guestfs.pod:2720
5750 msgid "C<regressions>"
5754 #: ../src/guestfs.pod:2722
5755 msgid "Regression tests."
5759 #: ../src/guestfs.pod:2724
5764 #: ../src/guestfs.pod:2726
5765 msgid "L<virt-rescue(1)> command and documentation."
5769 #: ../src/guestfs.pod:2728
5774 #: ../src/guestfs.pod:2730
5775 msgid "Source code to the C library."
5779 #: ../src/guestfs.pod:2732
5784 #: ../src/guestfs.pod:2734
5785 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5789 #: ../src/guestfs.pod:2736
5790 msgid "C<test-tool>"
5794 #: ../src/guestfs.pod:2738
5796 "Test tool for end users to test if their qemu/kernel combination will work "
5801 #: ../src/guestfs.pod:2741
5806 #: ../src/guestfs.pod:2743
5811 #: ../src/guestfs.pod:2745
5816 #: ../src/guestfs.pod:2747
5821 #: ../src/guestfs.pod:2749
5826 #: ../src/guestfs.pod:2751
5831 #: ../src/guestfs.pod:2753
5836 #: ../src/guestfs.pod:2755
5841 #: ../src/guestfs.pod:2757
5842 msgid "Language bindings."
5846 #: ../src/guestfs.pod:2761
5852 #: ../src/guestfs.pod:2763
5853 msgid "PROTOCOL LIMITS"
5858 #: ../src/guestfs.pod:2765
5860 "Internally libguestfs uses a message-based protocol to pass API calls and "
5861 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5862 "plenty more detail about this). The maximum message size used by the "
5863 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5864 "aware of this limit. The API calls which may be affected are individually "
5865 "documented, with a link back to this section of the documentation."
5870 #: ../src/guestfs.pod:2773
5872 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5873 "a simple string. Because this string is at some point internally encoded as "
5874 "a message, the maximum size that it can return is slightly under 4 MB. If "
5875 "the requested file is larger than this then you will get an error."
5880 #: ../src/guestfs.pod:2779
5882 "In order to transfer large files into and out of the guest filesystem, you "
5883 "need to use particular calls that support this. The sections L</UPLOADING> "
5884 "and L</DOWNLOADING> document how to do this."
5889 #: ../src/guestfs.pod:2783
5891 "You might also consider mounting the disk image using our FUSE filesystem "
5892 "support (L<guestmount(1)>)."
5896 #: ../src/guestfs.pod:2786
5897 msgid "MAXIMUM NUMBER OF DISKS"
5901 #: ../src/guestfs.pod:2788
5902 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5906 #: ../src/guestfs.pod:2791
5908 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5909 "slots. However febootstrap only understands disks with names C</dev/vda> "
5910 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5915 #: ../src/guestfs.pod:2796
5917 "We are working to substantially raise this limit in future versions but it "
5918 "requires complex changes to qemu."
5922 #: ../src/guestfs.pod:2799
5924 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5925 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5926 "requires changes to qemu."
5930 #: ../src/guestfs.pod:2803
5931 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5935 #: ../src/guestfs.pod:2805
5936 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5940 #: ../src/guestfs.pod:2807
5942 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5943 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5947 #: ../src/guestfs.pod:2810
5949 "If you attach a disk with more than 15 partitions, the extra partitions are "
5950 "ignored by libguestfs."
5954 #: ../src/guestfs.pod:2813
5955 msgid "MAXIMUM SIZE OF A DISK"
5959 #: ../src/guestfs.pod:2815
5960 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5964 #: ../src/guestfs.pod:2817
5966 "We have tested block devices up to 1 exabyte (2**60 or "
5967 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5972 #: ../src/guestfs.pod:2821
5974 "Although libguestfs probably does not impose any limit, the underlying host "
5975 "storage will. If you store disk images on a host ext4 filesystem, then the "
5976 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5977 "TB). If you store disk images as host logical volumes then you are limited "
5978 "by the maximum size of an LV."
5982 #: ../src/guestfs.pod:2827
5984 "For the hugest disk image files, we recommend using XFS on the host for "
5989 #: ../src/guestfs.pod:2830
5990 msgid "MAXIMUM SIZE OF A PARTITION"
5994 #: ../src/guestfs.pod:2832
5996 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5997 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5998 "address a partition located beyond 2 TB on the disk."
6002 #: ../src/guestfs.pod:2836
6004 "It is recommended that you use GPT partitions on disks which are larger than "
6005 "this size. GPT uses 64 bit sector numbers and so can address partitions "
6006 "which are theoretically larger than the largest disk we could support."
6010 #: ../src/guestfs.pod:2841
6011 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
6015 #: ../src/guestfs.pod:2843
6017 "This depends on the filesystem type. libguestfs itself does not impose any "
6018 "known limit. Consult Wikipedia or the filesystem documentation to find out "
6019 "what these limits are."
6023 #: ../src/guestfs.pod:2847
6024 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
6028 #: ../src/guestfs.pod:2849
6030 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
6031 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
6032 "uploads and downloads."
6036 #: ../src/guestfs.pod:2853
6037 msgid "INSPECTION LIMITS"
6041 #: ../src/guestfs.pod:2855
6043 "The inspection code has several arbitrary limits on things like the size of "
6044 "Windows Registry hive it will read, and the length of product name. These "
6045 "are intended to stop a malicious guest from consuming arbitrary amounts of "
6046 "memory and disk space on the host, and should not be reached in practice. "
6047 "See the source code for more information."
6052 #: ../src/guestfs.pod:2861 ../fish/guestfish.pod:1015
6053 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
6054 msgid "ENVIRONMENT VARIABLES"
6059 #: ../src/guestfs.pod:2865 ../fish/guestfish.pod:1041
6060 msgid "LIBGUESTFS_APPEND"
6065 #: ../src/guestfs.pod:2867 ../fish/guestfish.pod:1043
6066 msgid "Pass additional options to the guest kernel."
6071 #: ../src/guestfs.pod:2869 ../fish/guestfish.pod:1045
6072 msgid "LIBGUESTFS_DEBUG"
6077 #: ../src/guestfs.pod:2871
6079 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
6080 "effect as calling C<guestfs_set_verbose (g, 1)>."
6085 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1050
6086 msgid "LIBGUESTFS_MEMSIZE"
6091 #: ../src/guestfs.pod:2876 ../fish/guestfish.pod:1052
6093 "Set the memory allocated to the qemu process, in megabytes. For example:"
6098 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1055
6101 " LIBGUESTFS_MEMSIZE=700\n"
6107 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1057
6108 msgid "LIBGUESTFS_PATH"
6112 #: ../src/guestfs.pod:2883
6114 "Set the path that libguestfs uses to search for a supermin appliance. See "
6115 "the discussion of paths in section L</PATH> above."
6120 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1062
6121 msgid "LIBGUESTFS_QEMU"
6126 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1064
6128 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
6129 "which was found at compile time by the configure script is used."
6134 #: ../src/guestfs.pod:2892
6135 msgid "See also L</QEMU WRAPPERS> above."
6140 #: ../src/guestfs.pod:2894 ../fish/guestfish.pod:1068
6141 msgid "LIBGUESTFS_TRACE"
6146 #: ../src/guestfs.pod:2896
6148 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
6149 "effect as calling C<guestfs_set_trace (g, 1)>."
6154 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1077
6159 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1079
6161 "Location of temporary directory, defaults to C</tmp> except for the cached "
6162 "supermin appliance which defaults to C</var/tmp>."
6166 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1082
6168 "If libguestfs was compiled to use the supermin appliance then the real "
6169 "appliance is cached in this directory, shared between all handles belonging "
6170 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6171 "use in case C</var/tmp> is not large enough."
6176 #: ../src/guestfs.pod:2912 ../fish/guestfish.pod:1149
6177 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267
6178 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6179 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
6180 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
6185 #: ../src/guestfs.pod:2914
6187 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6188 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6189 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6190 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6191 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6192 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6193 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6198 #: ../src/guestfs.pod:2941
6200 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6201 "(8)>, L<disktype(1)>."
6206 #: ../src/guestfs.pod:2948 ../tools/virt-win-reg.pl:587
6207 #: ../tools/virt-make-fs.pl:553
6213 #: ../src/guestfs.pod:2950
6214 msgid "To get a list of bugs against libguestfs use this link:"
6219 #: ../src/guestfs.pod:2952
6221 "L<https://bugzilla.redhat.com/buglist.cgi?"
6222 "component=libguestfs&product=Virtualization+Tools>"
6227 #: ../src/guestfs.pod:2954
6228 msgid "To report a new bug against libguestfs use this link:"
6233 #: ../src/guestfs.pod:2956
6235 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6236 "component=libguestfs&product=Virtualization+Tools>"
6241 #: ../src/guestfs.pod:2958
6242 msgid "When reporting a bug, please check:"
6247 #: ../src/guestfs.pod:2964
6248 msgid "That the bug hasn't been reported already."
6253 #: ../src/guestfs.pod:2968
6254 msgid "That you are testing a recent version."
6259 #: ../src/guestfs.pod:2972
6260 msgid "Describe the bug accurately, and give a way to reproduce it."
6265 #: ../src/guestfs.pod:2976
6267 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6273 #: ../src/guestfs.pod:2981 ../fish/guestfish.pod:1172
6274 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
6280 #: ../src/guestfs.pod:2983 ../fish/guestfish.pod:1174
6281 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
6282 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6287 #: ../src/guestfs.pod:2985 ../fish/guestfish.pod:1176
6288 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282
6289 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6290 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
6291 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
6296 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1178
6297 #: ../test-tool/libguestfs-test-tool.pod:99
6298 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6303 #: ../src/guestfs.pod:2990
6305 "This library is free software; you can redistribute it and/or modify it "
6306 "under the terms of the GNU Lesser General Public License as published by the "
6307 "Free Software Foundation; either version 2 of the License, or (at your "
6308 "option) any later version."
6313 #: ../src/guestfs.pod:2995
6315 "This library is distributed in the hope that it will be useful, but WITHOUT "
6316 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6317 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6323 #: ../src/guestfs.pod:3000
6325 "You should have received a copy of the GNU Lesser General Public License "
6326 "along with this library; if not, write to the Free Software Foundation, "
6327 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6332 #: ../src/guestfs-actions.pod:1
6333 msgid "guestfs_add_cdrom"
6338 #: ../src/guestfs-actions.pod:3
6342 " guestfs_add_cdrom (guestfs_h *g,\n"
6343 " const char *filename);\n"
6349 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6350 msgid "This function adds a virtual CD-ROM disk image to the guest."
6354 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6355 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6360 #: ../src/guestfs-actions.pod:17
6362 "This call checks for the existence of C<filename>. This stops you from "
6363 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6364 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6370 #: ../src/guestfs-actions.pod:24
6372 "If you just want to add an ISO file (often you use this as an efficient way "
6373 "to transfer large files into the guest), then you should probably use "
6374 "C<guestfs_add_drive_ro> instead."
6379 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6380 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6381 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6382 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6383 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6384 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6385 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6386 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6387 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6388 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6389 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6390 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6391 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6392 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6393 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6394 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6395 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
6396 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
6397 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
6398 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
6399 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
6400 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3459
6401 #: ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3499
6402 #: ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3668
6403 #: ../src/guestfs-actions.pod:3681 ../src/guestfs-actions.pod:3695
6404 #: ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3746
6405 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3838
6406 #: ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3878
6407 #: ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3933
6408 #: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:3971
6409 #: ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4018
6410 #: ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4070
6411 #: ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4098
6412 #: ../src/guestfs-actions.pod:4115 ../src/guestfs-actions.pod:4208
6413 #: ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4241
6414 #: ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4310
6415 #: ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4344
6416 #: ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4372
6417 #: ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4404
6418 #: ../src/guestfs-actions.pod:4424 ../src/guestfs-actions.pod:4482
6419 #: ../src/guestfs-actions.pod:4555 ../src/guestfs-actions.pod:4586
6420 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4624
6421 #: ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4653
6422 #: ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4681
6423 #: ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4731
6424 #: ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4766
6425 #: ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:4797
6426 #: ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883
6427 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4925
6428 #: ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4960
6429 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5151
6430 #: ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:5191
6431 #: ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5289
6432 #: ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5319
6433 #: ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5622
6434 #: ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5660
6435 #: ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5684
6436 #: ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5710
6437 #: ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5740
6438 #: ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:5780
6439 #: ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5829
6440 #: ../src/guestfs-actions.pod:5845 ../src/guestfs-actions.pod:5868
6441 #: ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905
6442 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5945
6443 #: ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5990
6444 #: ../src/guestfs-actions.pod:6014 ../src/guestfs-actions.pod:6033
6445 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6076
6446 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6110
6447 #: ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6170
6448 #: ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6304
6449 #: ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6437
6450 #: ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6463
6451 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6498
6452 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6524
6453 #: ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6598
6454 #: ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6631
6455 #: ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6664
6456 #: ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6697
6457 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6747
6458 #: ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6801
6459 #: ../src/guestfs-actions.pod:6819 ../src/guestfs-actions.pod:6853
6460 #: ../src/guestfs-actions.pod:6889 ../src/guestfs-actions.pod:7008
6461 #: ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7040
6462 #: ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7108
6463 #: ../src/guestfs-actions.pod:7153 ../src/guestfs-actions.pod:7186
6464 #: ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7266
6465 #: ../src/guestfs-actions.pod:7332 ../src/guestfs-actions.pod:7351
6466 #: ../src/guestfs-actions.pod:7380
6467 msgid "This function returns 0 on success or -1 on error."
6472 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6473 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6474 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6476 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6482 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6483 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6484 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
6485 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:7274
6486 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:31
6487 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6488 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6489 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3008
6490 #: ../fish/guestfish-actions.pod:4866 ../fish/guestfish-actions.pod:4963
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:136
6500 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
6501 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
6502 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3481
6503 #: ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:5847
6504 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6078
6505 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6666
6506 #: ../src/guestfs-actions.pod:7188
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:145
6531 #: ../src/guestfs-actions.pod:4443
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"
6551 #: ../src/guestfs-actions.pod:58
6553 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6554 "It works by connecting to libvirt, requesting the domain and domain XML from "
6555 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6561 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6563 "The number of disks added is returned. This operation is atomic: if an "
6564 "error is returned, then no disks are added."
6569 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6571 "This function does some minimal checks to make sure the libvirt domain is "
6572 "not running (unless C<readonly> is true). In a future version we will try "
6573 "to acquire the libvirt lock on each disk."
6578 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6580 "Disks must be accessible locally. This often means that adding disks from a "
6581 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6582 "unless those disks are accessible via the same device path locally too."
6586 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6588 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6589 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6590 "libvirt URI (or one set through an environment variable, see the libvirt "
6591 "documentation for full details)."
6595 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6597 "The optional C<live> flag controls whether this call will try to connect to "
6598 "a running virtual machine C<guestfsd> process if it sees a suitable "
6599 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6600 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6601 "DAEMONS> for more information."
6606 #: ../src/guestfs-actions.pod:88
6608 "The other optional parameters are passed directly through to "
6609 "C<guestfs_add_drive_opts>."
6614 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6615 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6616 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6617 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6618 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
6619 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
6620 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
6621 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2780
6622 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:4869
6623 #: ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5403
6624 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:6774
6625 #: ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7212
6626 #: ../src/guestfs-actions.pod:7225
6627 msgid "On error this function returns -1."
6632 #: ../src/guestfs-actions.pod:93
6633 msgid "(Added in 1.7.4)"
6638 #: ../src/guestfs-actions.pod:95
6639 msgid "guestfs_add_domain_va"
6644 #: ../src/guestfs-actions.pod:97
6648 " guestfs_add_domain_va (guestfs_h *g,\n"
6649 " const char *dom,\n"
6656 #: ../src/guestfs-actions.pod:102
6657 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6662 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6663 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6664 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4508
6665 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6670 #: ../src/guestfs-actions.pod:106
6671 msgid "guestfs_add_domain_argv"
6676 #: ../src/guestfs-actions.pod:108
6680 " guestfs_add_domain_argv (guestfs_h *g,\n"
6681 " const char *dom,\n"
6682 " const struct guestfs_add_domain_argv *optargs);\n"
6688 #: ../src/guestfs-actions.pod:113
6689 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6694 #: ../src/guestfs-actions.pod:117
6695 msgid "guestfs_add_drive"
6700 #: ../src/guestfs-actions.pod:119
6704 " guestfs_add_drive (guestfs_h *g,\n"
6705 " const char *filename);\n"
6711 #: ../src/guestfs-actions.pod:123
6713 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6714 "optional parameters, so the disk is added writable, with the format being "
6715 "detected automatically."
6720 #: ../src/guestfs-actions.pod:127
6722 "Automatic detection of the format opens you up to a potential security hole "
6723 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6724 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6725 "you should think about replacing calls to this function with calls to "
6726 "C<guestfs_add_drive_opts>, and specifying the format."
6731 #: ../src/guestfs-actions.pod:138
6732 msgid "guestfs_add_drive_opts"
6737 #: ../src/guestfs-actions.pod:140
6741 " guestfs_add_drive_opts (guestfs_h *g,\n"
6742 " const char *filename,\n"
6749 #: ../src/guestfs-actions.pod:150
6752 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6753 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6754 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6760 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6762 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6763 "The first time you call this function, the disk appears as C</dev/sda>, the "
6764 "second time as C</dev/sdb>, and so on."
6769 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6771 "You don't necessarily need to be root when using libguestfs. However you "
6772 "obviously do need sufficient permissions to access the filename for whatever "
6773 "operations you want to perform (ie. read access if you just want to read the "
6774 "image or write access if you want to modify the image)."
6779 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6780 msgid "This call checks that C<filename> exists."
6785 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4454
6786 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3019
6787 msgid "The optional arguments are:"
6792 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6798 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6800 "If true then the image is treated as read-only. Writes are still allowed, "
6801 "but they are stored in a temporary snapshot overlay which is discarded at "
6802 "the end. The disk that you add is not modified."
6807 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6813 #: ../src/guestfs-actions.pod:179
6815 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6816 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6817 "Possible formats include C<raw> and C<qcow2>."
6822 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6824 "Automatic detection of the format opens you up to a potential security hole "
6825 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6826 "RHBZ#642934. Specifying the format closes this security hole."
6831 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6837 #: ../src/guestfs-actions.pod:190
6839 "This rarely-used option lets you emulate the behaviour of the deprecated "
6840 "C<guestfs_add_drive_with_if> call (q.v.)"
6845 #: ../src/guestfs-actions.pod:197
6846 msgid "(Added in 1.5.23)"
6851 #: ../src/guestfs-actions.pod:199
6852 msgid "guestfs_add_drive_opts_va"
6857 #: ../src/guestfs-actions.pod:201
6861 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6862 " const char *filename,\n"
6869 #: ../src/guestfs-actions.pod:206
6870 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6875 #: ../src/guestfs-actions.pod:210
6876 msgid "guestfs_add_drive_opts_argv"
6881 #: ../src/guestfs-actions.pod:212
6885 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6886 " const char *filename,\n"
6887 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6893 #: ../src/guestfs-actions.pod:217
6894 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6899 #: ../src/guestfs-actions.pod:221
6900 msgid "guestfs_add_drive_ro"
6905 #: ../src/guestfs-actions.pod:223
6909 " guestfs_add_drive_ro (guestfs_h *g,\n"
6910 " const char *filename);\n"
6916 #: ../src/guestfs-actions.pod:227
6918 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6919 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6920 "disk is added read-only, with the format being detected automatically."
6925 #: ../src/guestfs-actions.pod:234
6926 msgid "(Added in 1.0.38)"
6931 #: ../src/guestfs-actions.pod:236
6932 msgid "guestfs_add_drive_ro_with_if"
6937 #: ../src/guestfs-actions.pod:238
6941 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6942 " const char *filename,\n"
6943 " const char *iface);\n"
6949 #: ../src/guestfs-actions.pod:243
6951 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6952 "QEMU interface emulation to use at run time."
6957 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6958 #: ../src/guestfs-actions.pod:2356
6959 msgid "(Added in 1.0.84)"
6964 #: ../src/guestfs-actions.pod:257
6965 msgid "guestfs_add_drive_with_if"
6970 #: ../src/guestfs-actions.pod:259
6974 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6975 " const char *filename,\n"
6976 " const char *iface);\n"
6982 #: ../src/guestfs-actions.pod:264
6984 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6985 "QEMU interface emulation to use at run time."
6990 #: ../src/guestfs-actions.pod:278
6991 msgid "guestfs_aug_clear"
6996 #: ../src/guestfs-actions.pod:280
7000 " guestfs_aug_clear (guestfs_h *g,\n"
7001 " const char *augpath);\n"
7007 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
7009 "Set the value associated with C<path> to C<NULL>. This is the same as the "
7010 "L<augtool(1)> C<clear> command."
7015 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
7016 msgid "(Added in 1.3.4)"
7021 #: ../src/guestfs-actions.pod:291
7022 msgid "guestfs_aug_close"
7027 #: ../src/guestfs-actions.pod:293
7031 " guestfs_aug_close (guestfs_h *g);\n"
7037 #: ../src/guestfs-actions.pod:296
7039 "Close the current Augeas handle and free up any resources used by it. After "
7040 "calling this, you have to call C<guestfs_aug_init> again before you can use "
7041 "any other Augeas functions."
7046 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
7047 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
7048 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
7049 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
7050 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
7051 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
7052 #: ../src/guestfs-actions.pod:5480
7053 msgid "(Added in 0.7)"
7058 #: ../src/guestfs-actions.pod:305
7059 msgid "guestfs_aug_defnode"
7064 #: ../src/guestfs-actions.pod:307
7067 " struct guestfs_int_bool *\n"
7068 " guestfs_aug_defnode (guestfs_h *g,\n"
7069 " const char *name,\n"
7070 " const char *expr,\n"
7071 " const char *val);\n"
7077 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
7079 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7084 #: ../src/guestfs-actions.pod:316
7086 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7087 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
7088 "containing that single node."
7093 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
7095 "On success this returns a pair containing the number of nodes in the "
7096 "nodeset, and a boolean flag if a node was created."
7101 #: ../src/guestfs-actions.pod:324
7103 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
7104 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
7109 #: ../src/guestfs-actions.pod:330
7110 msgid "guestfs_aug_defvar"
7115 #: ../src/guestfs-actions.pod:332
7119 " guestfs_aug_defvar (guestfs_h *g,\n"
7120 " const char *name,\n"
7121 " const char *expr);\n"
7127 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
7129 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7130 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7135 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
7137 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7138 "evaluates to something which is not a nodeset."
7143 #: ../src/guestfs-actions.pod:348
7144 msgid "guestfs_aug_get"
7149 #: ../src/guestfs-actions.pod:350
7153 " guestfs_aug_get (guestfs_h *g,\n"
7154 " const char *augpath);\n"
7160 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
7162 "Look up the value associated with C<path>. If C<path> matches exactly one "
7163 "node, the C<value> is returned."
7168 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
7169 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
7170 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
7171 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
7172 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
7173 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
7174 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
7175 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
7176 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
7177 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
7178 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2732
7179 #: ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2872
7180 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927
7181 #: ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3024
7182 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068
7183 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3990
7184 #: ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4270
7185 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5208
7186 #: ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5556
7187 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:6217
7188 #: ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6250
7189 #: ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6948
7190 #: ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6985
7191 #: ../src/guestfs-actions.pod:7165 ../src/guestfs-actions.pod:7437
7193 "This function returns a string, or NULL on error. I<The caller must free "
7194 "the returned string after use>."
7199 #: ../src/guestfs-actions.pod:362
7200 msgid "guestfs_aug_init"
7205 #: ../src/guestfs-actions.pod:364
7209 " guestfs_aug_init (guestfs_h *g,\n"
7210 " const char *root,\n"
7217 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7219 "Create a new Augeas handle for editing configuration files. If there was "
7220 "any previous Augeas handle associated with this guestfs session, then it is "
7226 #: ../src/guestfs-actions.pod:373
7227 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7232 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7234 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7239 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7241 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7242 "logical I<or> of the following integers:"
7247 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7248 msgid "C<AUG_SAVE_BACKUP> = 1"
7253 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7254 msgid "Keep the original file with a C<.augsave> extension."
7259 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7260 msgid "C<AUG_SAVE_NEWFILE> = 2"
7265 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7267 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7268 "original. Overrides C<AUG_SAVE_BACKUP>."
7273 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7274 msgid "C<AUG_TYPE_CHECK> = 4"
7279 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7280 msgid "Typecheck lenses (can be expensive)."
7285 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7286 msgid "C<AUG_NO_STDINC> = 8"
7291 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7292 msgid "Do not use standard load path for modules."
7297 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7298 msgid "C<AUG_SAVE_NOOP> = 16"
7303 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7304 msgid "Make save a no-op, just record what would have been changed."
7309 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7310 msgid "C<AUG_NO_LOAD> = 32"
7315 #: ../src/guestfs-actions.pod:408
7316 msgid "Do not load the tree in C<guestfs_aug_init>."
7321 #: ../src/guestfs-actions.pod:412
7322 msgid "To close the handle, you can call C<guestfs_aug_close>."
7327 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7328 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7333 #: ../src/guestfs-actions.pod:420
7334 msgid "guestfs_aug_insert"
7339 #: ../src/guestfs-actions.pod:422
7343 " guestfs_aug_insert (guestfs_h *g,\n"
7344 " const char *augpath,\n"
7345 " const char *label,\n"
7352 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7354 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7355 "or after C<path> (depending on the boolean flag C<before>)."
7360 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7362 "C<path> must match exactly one existing node in the tree, and C<label> must "
7363 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7368 #: ../src/guestfs-actions.pod:440
7369 msgid "guestfs_aug_load"
7374 #: ../src/guestfs-actions.pod:442
7378 " guestfs_aug_load (guestfs_h *g);\n"
7384 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7385 msgid "Load files into the tree."
7390 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7391 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7396 #: ../src/guestfs-actions.pod:454
7397 msgid "guestfs_aug_ls"
7402 #: ../src/guestfs-actions.pod:456
7406 " guestfs_aug_ls (guestfs_h *g,\n"
7407 " const char *augpath);\n"
7413 #: ../src/guestfs-actions.pod:460
7415 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7416 "sorting the resulting nodes into alphabetical order."
7421 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7422 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7423 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
7424 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
7425 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
7426 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
7427 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
7428 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
7429 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2981
7430 #: ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560
7431 #: ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3727
7432 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4830
7433 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5476
7434 #: ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:6290
7435 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6406
7436 #: ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6576
7437 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078
7438 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7290
7439 #: ../src/guestfs-actions.pod:7309 ../src/guestfs-actions.pod:7394
7440 #: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7459
7441 #: ../src/guestfs-actions.pod:7478
7443 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7444 ">), or NULL if there was an error. I<The caller must free the strings and "
7445 "the array after use>."
7450 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7451 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
7452 #: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3379
7453 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4023
7454 #: ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4243
7455 #: ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4834
7456 #: ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5686
7457 #: ../src/guestfs-actions.pod:5700 ../src/guestfs-actions.pod:5712
7458 #: ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6790
7459 #: ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:7042
7460 #: ../src/guestfs-actions.pod:7278
7461 msgid "(Added in 0.8)"
7466 #: ../src/guestfs-actions.pod:469
7467 msgid "guestfs_aug_match"
7472 #: ../src/guestfs-actions.pod:471
7476 " guestfs_aug_match (guestfs_h *g,\n"
7477 " const char *augpath);\n"
7483 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7485 "Returns a list of paths which match the path expression C<path>. The "
7486 "returned paths are sufficiently qualified so that they match exactly one "
7487 "node in the current tree."
7492 #: ../src/guestfs-actions.pod:485
7493 msgid "guestfs_aug_mv"
7498 #: ../src/guestfs-actions.pod:487
7502 " guestfs_aug_mv (guestfs_h *g,\n"
7503 " const char *src,\n"
7504 " const char *dest);\n"
7510 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7512 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7513 "C<dest> is overwritten if it exists."
7518 #: ../src/guestfs-actions.pod:499
7519 msgid "guestfs_aug_rm"
7524 #: ../src/guestfs-actions.pod:501
7528 " guestfs_aug_rm (guestfs_h *g,\n"
7529 " const char *augpath);\n"
7535 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7536 msgid "Remove C<path> and all of its children."
7541 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7542 msgid "On success this returns the number of entries which were removed."
7547 #: ../src/guestfs-actions.pod:513
7548 msgid "guestfs_aug_save"
7553 #: ../src/guestfs-actions.pod:515
7557 " guestfs_aug_save (guestfs_h *g);\n"
7563 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7564 msgid "This writes all pending changes to disk."
7569 #: ../src/guestfs-actions.pod:520
7571 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7577 #: ../src/guestfs-actions.pod:527
7578 msgid "guestfs_aug_set"
7583 #: ../src/guestfs-actions.pod:529
7587 " guestfs_aug_set (guestfs_h *g,\n"
7588 " const char *augpath,\n"
7589 " const char *val);\n"
7595 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7596 msgid "Set the value associated with C<path> to C<val>."
7601 #: ../src/guestfs-actions.pod:536
7603 "In the Augeas API, it is possible to clear a node by setting the value to "
7604 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7605 "this call. Instead you must use the C<guestfs_aug_clear> call."
7610 #: ../src/guestfs-actions.pod:545
7611 msgid "guestfs_available"
7616 #: ../src/guestfs-actions.pod:547
7620 " guestfs_available (guestfs_h *g,\n"
7621 " char *const *groups);\n"
7627 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7629 "This command is used to check the availability of some groups of "
7630 "functionality in the appliance, which not all builds of the libguestfs "
7631 "appliance will be able to provide."
7636 #: ../src/guestfs-actions.pod:555
7638 "The libguestfs groups, and the functions that those groups correspond to, "
7639 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7640 "runtime by calling C<guestfs_available_all_groups>."
7645 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7647 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7648 "\"]> would check for the availability of the Linux inotify functions and "
7649 "Augeas (configuration file editing) functions."
7654 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7655 msgid "The command returns no error if I<all> requested groups are available."
7660 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7662 "It fails with an error if one or more of the requested groups is unavailable "
7668 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7670 "If an unknown group name is included in the list of groups then an error is "
7676 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7682 #: ../src/guestfs-actions.pod:579
7683 msgid "You must call C<guestfs_launch> before calling this function."
7688 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7690 "The reason is because we don't know what groups are supported by the "
7691 "appliance/daemon until it is running and can be queried."
7696 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7698 "If a group of functions is available, this does not necessarily mean that "
7699 "they will work. You still have to check for errors when calling individual "
7700 "API functions even if they are available."
7705 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7707 "It is usually the job of distro packagers to build complete functionality "
7708 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7709 "with all requirements satisfied, will support everything."
7714 #: ../src/guestfs-actions.pod:601
7716 "This call was added in version C<1.0.80>. In previous versions of "
7717 "libguestfs all you could do would be to speculatively execute a command to "
7718 "find out if the daemon implemented it. See also C<guestfs_version>."
7723 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7724 msgid "(Added in 1.0.80)"
7729 #: ../src/guestfs-actions.pod:612
7730 msgid "guestfs_available_all_groups"
7735 #: ../src/guestfs-actions.pod:614
7739 " guestfs_available_all_groups (guestfs_h *g);\n"
7745 #: ../src/guestfs-actions.pod:617
7747 "This command returns a list of all optional groups that this daemon knows "
7748 "about. Note this returns both supported and unsupported groups. To find "
7749 "out which ones the daemon can actually support you have to call "
7750 "C<guestfs_available> on each member of the returned list."
7755 #: ../src/guestfs-actions.pod:623
7756 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7761 #: ../src/guestfs-actions.pod:629
7762 msgid "(Added in 1.3.15)"
7767 #: ../src/guestfs-actions.pod:631
7768 msgid "guestfs_base64_in"
7773 #: ../src/guestfs-actions.pod:633
7777 " guestfs_base64_in (guestfs_h *g,\n"
7778 " const char *base64file,\n"
7779 " const char *filename);\n"
7785 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7787 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7792 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7793 msgid "(Added in 1.3.5)"
7798 #: ../src/guestfs-actions.pod:645
7799 msgid "guestfs_base64_out"
7804 #: ../src/guestfs-actions.pod:647
7808 " guestfs_base64_out (guestfs_h *g,\n"
7809 " const char *filename,\n"
7810 " const char *base64file);\n"
7816 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7818 "This command downloads the contents of C<filename>, writing it out to local "
7819 "file C<base64file> encoded as base64."
7824 #: ../src/guestfs-actions.pod:659
7825 msgid "guestfs_blockdev_flushbufs"
7830 #: ../src/guestfs-actions.pod:661
7834 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7835 " const char *device);\n"
7841 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7843 "This tells the kernel to flush internal buffers associated with C<device>."
7848 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7849 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7850 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7851 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7852 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7853 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7854 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7855 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7856 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7857 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7858 msgid "This uses the L<blockdev(8)> command."
7863 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7864 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7865 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7866 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7867 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7868 msgid "(Added in 0.9.3)"
7873 #: ../src/guestfs-actions.pod:674
7874 msgid "guestfs_blockdev_getbsz"
7879 #: ../src/guestfs-actions.pod:676
7883 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7884 " const char *device);\n"
7890 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7891 msgid "This returns the block size of a device."
7896 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7897 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7899 "(Note this is different from both I<size in blocks> and I<filesystem block "
7905 #: ../src/guestfs-actions.pod:691
7906 msgid "guestfs_blockdev_getro"
7911 #: ../src/guestfs-actions.pod:693
7915 " guestfs_blockdev_getro (guestfs_h *g,\n"
7916 " const char *device);\n"
7922 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7924 "Returns a boolean indicating if the block device is read-only (true if read-"
7925 "only, false if not)."
7930 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7931 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7932 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7933 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7934 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7935 #: ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105
7936 #: ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3287
7937 #: ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3316
7938 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3346
7939 #: ../src/guestfs-actions.pod:3361 ../src/guestfs-actions.pod:3377
7940 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3404
7941 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3433
7942 #: ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:4979
7943 msgid "This function returns a C truth value on success or -1 on error."
7948 #: ../src/guestfs-actions.pod:706
7949 msgid "guestfs_blockdev_getsize64"
7954 #: ../src/guestfs-actions.pod:708
7958 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7959 " const char *device);\n"
7965 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7966 msgid "This returns the size of the device in bytes."
7971 #: ../src/guestfs-actions.pod:714
7972 msgid "See also C<guestfs_blockdev_getsz>."
7977 #: ../src/guestfs-actions.pod:722
7978 msgid "guestfs_blockdev_getss"
7983 #: ../src/guestfs-actions.pod:724
7987 " guestfs_blockdev_getss (guestfs_h *g,\n"
7988 " const char *device);\n"
7994 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7996 "This returns the size of sectors on a block device. Usually 512, but can be "
7997 "larger for modern devices."
8002 #: ../src/guestfs-actions.pod:731
8004 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
8010 #: ../src/guestfs-actions.pod:740
8011 msgid "guestfs_blockdev_getsz"
8016 #: ../src/guestfs-actions.pod:742
8020 " guestfs_blockdev_getsz (guestfs_h *g,\n"
8021 " const char *device);\n"
8027 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
8029 "This returns the size of the device in units of 512-byte sectors (even if "
8030 "the sectorsize isn't 512 bytes ... weird)."
8035 #: ../src/guestfs-actions.pod:749
8037 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
8038 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
8043 #: ../src/guestfs-actions.pod:759
8044 msgid "guestfs_blockdev_rereadpt"
8049 #: ../src/guestfs-actions.pod:761
8053 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
8054 " const char *device);\n"
8060 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
8061 msgid "Reread the partition table on C<device>."
8066 #: ../src/guestfs-actions.pod:773
8067 msgid "guestfs_blockdev_setbsz"
8072 #: ../src/guestfs-actions.pod:775
8076 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
8077 " const char *device,\n"
8078 " int blocksize);\n"
8084 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
8085 msgid "This sets the block size of a device."
8090 #: ../src/guestfs-actions.pod:791
8091 msgid "guestfs_blockdev_setro"
8096 #: ../src/guestfs-actions.pod:793
8100 " guestfs_blockdev_setro (guestfs_h *g,\n"
8101 " const char *device);\n"
8107 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
8108 msgid "Sets the block device named C<device> to read-only."
8113 #: ../src/guestfs-actions.pod:805
8114 msgid "guestfs_blockdev_setrw"
8119 #: ../src/guestfs-actions.pod:807
8123 " guestfs_blockdev_setrw (guestfs_h *g,\n"
8124 " const char *device);\n"
8130 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
8131 msgid "Sets the block device named C<device> to read-write."
8136 #: ../src/guestfs-actions.pod:819
8137 msgid "guestfs_case_sensitive_path"
8142 #: ../src/guestfs-actions.pod:821
8146 " guestfs_case_sensitive_path (guestfs_h *g,\n"
8147 " const char *path);\n"
8153 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
8155 "This can be used to resolve case insensitive paths on a filesystem which is "
8156 "case sensitive. The use case is to resolve paths which you have read from "
8157 "Windows configuration files or the Windows Registry, to the true path."
8162 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
8164 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8165 "(and probably others), which is that although the underlying filesystem is "
8166 "case-insensitive, the driver exports the filesystem to Linux as case-"
8172 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8174 "One consequence of this is that special directories such as C<c:\\windows> "
8175 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8176 "precise details of how they were created. In Windows itself this would not "
8182 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8184 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8190 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8192 "This function resolves the true case of each element in the path and returns "
8193 "the case-sensitive path."
8198 #: ../src/guestfs-actions.pod:847
8200 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8201 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8202 "how the directories were originally created under Windows)."
8207 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8208 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8213 #: ../src/guestfs-actions.pod:855
8214 msgid "See also C<guestfs_realpath>."
8219 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6970
8220 msgid "(Added in 1.0.75)"
8225 #: ../src/guestfs-actions.pod:862
8231 #: ../src/guestfs-actions.pod:864
8235 " guestfs_cat (guestfs_h *g,\n"
8236 " const char *path);\n"
8242 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5466
8243 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3667
8244 msgid "Return the contents of the file named C<path>."
8249 #: ../src/guestfs-actions.pod:870
8251 "Note that this function cannot correctly handle binary files (specifically, "
8252 "files containing C<\\0> character which is treated as end of string). For "
8253 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8254 "functions which have a more complex interface."
8259 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8260 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
8261 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
8262 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
8263 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
8264 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
8265 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
8266 #: ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5274
8267 #: ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5431
8268 #: ../src/guestfs-actions.pod:5455 ../src/guestfs-actions.pod:6355
8269 #: ../src/guestfs-actions.pod:6410 ../src/guestfs-actions.pod:6556
8270 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:7242
8271 #: ../src/guestfs-actions.pod:7268 ../src/guestfs-actions.pod:7294
8272 #: ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7398
8273 #: ../src/guestfs-actions.pod:7417 ../src/guestfs-actions.pod:7463
8274 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:587
8275 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8276 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8277 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8278 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8279 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8280 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8281 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3537
8282 #: ../fish/guestfish-actions.pod:3552 ../fish/guestfish-actions.pod:3628
8283 #: ../fish/guestfish-actions.pod:3645 ../fish/guestfish-actions.pod:3660
8284 #: ../fish/guestfish-actions.pod:4286 ../fish/guestfish-actions.pod:4332
8285 #: ../fish/guestfish-actions.pod:4417 ../fish/guestfish-actions.pod:4432
8286 #: ../fish/guestfish-actions.pod:4842 ../fish/guestfish-actions.pod:4860
8287 #: ../fish/guestfish-actions.pod:4877 ../fish/guestfish-actions.pod:4887
8288 #: ../fish/guestfish-actions.pod:4935 ../fish/guestfish-actions.pod:4945
8289 #: ../fish/guestfish-actions.pod:4974 ../fish/guestfish-actions.pod:4984
8291 "Because of the message protocol, there is a transfer limit of somewhere "
8292 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8297 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3564
8298 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3643
8299 #: ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:4136
8300 #: ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:5354
8301 #: ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:7129
8302 #: ../src/guestfs-actions.pod:7143
8303 msgid "(Added in 0.4)"
8308 #: ../src/guestfs-actions.pod:883
8309 msgid "guestfs_checksum"
8314 #: ../src/guestfs-actions.pod:885
8318 " guestfs_checksum (guestfs_h *g,\n"
8319 " const char *csumtype,\n"
8320 " const char *path);\n"
8326 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8328 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8333 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8335 "The type of checksum to compute is given by the C<csumtype> parameter which "
8336 "must have one of the following values:"
8341 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8347 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8349 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8355 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8361 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8362 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8367 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8373 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8374 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8379 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8385 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8386 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8391 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8397 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8398 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8403 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8409 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8410 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8415 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8421 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8422 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8427 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8428 msgid "The checksum is returned as a printable string."
8433 #: ../src/guestfs-actions.pod:931
8434 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8439 #: ../src/guestfs-actions.pod:933
8440 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8445 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8446 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3303
8447 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3393
8448 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:6826
8449 msgid "(Added in 1.0.2)"
8454 #: ../src/guestfs-actions.pod:940
8455 msgid "guestfs_checksum_device"
8460 #: ../src/guestfs-actions.pod:942
8464 " guestfs_checksum_device (guestfs_h *g,\n"
8465 " const char *csumtype,\n"
8466 " const char *device);\n"
8472 #: ../src/guestfs-actions.pod:947
8474 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8475 "device named C<device>. For the types of checksums supported see the "
8476 "C<guestfs_checksum> command."
8481 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4885
8482 #: ../src/guestfs-actions.pod:4944 ../src/guestfs-actions.pod:4981
8483 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175
8484 #: ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:6749
8485 #: ../src/guestfs-actions.pod:7155
8486 msgid "(Added in 1.3.2)"
8491 #: ../src/guestfs-actions.pod:956
8492 msgid "guestfs_checksums_out"
8497 #: ../src/guestfs-actions.pod:958
8501 " guestfs_checksums_out (guestfs_h *g,\n"
8502 " const char *csumtype,\n"
8503 " const char *directory,\n"
8504 " const char *sumsfile);\n"
8510 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8512 "This command computes the checksums of all regular files in C<directory> and "
8513 "then emits a list of those checksums to the local output file C<sumsfile>."
8518 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8520 "This can be used for verifying the integrity of a virtual machine. However "
8521 "to be properly secure you should pay attention to the output of the checksum "
8522 "command (it uses the ones from GNU coreutils). In particular when the "
8523 "filename is not printable, coreutils uses a special backslash syntax. For "
8524 "more information, see the GNU coreutils info file."
8529 #: ../src/guestfs-actions.pod:978
8530 msgid "(Added in 1.3.7)"
8535 #: ../src/guestfs-actions.pod:980
8536 msgid "guestfs_chmod"
8541 #: ../src/guestfs-actions.pod:982
8545 " guestfs_chmod (guestfs_h *g,\n"
8547 " const char *path);\n"
8553 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8555 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8561 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8563 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8564 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8570 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4387
8571 #: ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4603
8572 #: ../src/guestfs-actions.pod:4622 ../fish/guestfish-actions.pod:676
8573 #: ../fish/guestfish-actions.pod:2983 ../fish/guestfish-actions.pod:3112
8574 #: ../fish/guestfish-actions.pod:3122 ../fish/guestfish-actions.pod:3132
8575 msgid "The mode actually set is affected by the umask."
8580 #: ../src/guestfs-actions.pod:1000
8581 msgid "guestfs_chown"
8586 #: ../src/guestfs-actions.pod:1002
8590 " guestfs_chown (guestfs_h *g,\n"
8593 " const char *path);\n"
8599 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8600 msgid "Change the file owner to C<owner> and group to C<group>."
8605 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3495
8606 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2441
8608 "Only numeric uid and gid are supported. If you want to use names, you will "
8609 "need to locate and parse the password file yourself (Augeas support makes "
8610 "this relatively easy)."
8615 #: ../src/guestfs-actions.pod:1018
8616 msgid "guestfs_command"
8621 #: ../src/guestfs-actions.pod:1020
8625 " guestfs_command (guestfs_h *g,\n"
8626 " char *const *arguments);\n"
8632 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8634 "This call runs a command from the guest filesystem. The filesystem must be "
8635 "mounted, and must contain a compatible operating system (ie. something "
8636 "Linux, with the same or compatible processor architecture)."
8641 #: ../src/guestfs-actions.pod:1029
8643 "The single parameter is an argv-style list of arguments. The first element "
8644 "is the name of the program to run. Subsequent elements are parameters. The "
8645 "list must be non-empty (ie. must contain a program name). Note that the "
8646 "command runs directly, and is I<not> invoked via the shell (see "
8652 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8653 msgid "The return value is anything printed to I<stdout> by the command."
8658 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8660 "If the command returns a non-zero exit status, then this function returns an "
8661 "error message. The error message string is the content of I<stderr> from "
8667 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8669 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8670 "bin>. If you require a program from another location, you should provide "
8671 "the full path in the first parameter."
8676 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8678 "Shared libraries and data files required by the program must be available on "
8679 "filesystems which are mounted in the correct places. It is the caller's "
8680 "responsibility to ensure all filesystems that are needed are mounted at the "
8686 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8687 #: ../src/guestfs-actions.pod:1548
8688 msgid "(Added in 0.9.1)"
8693 #: ../src/guestfs-actions.pod:1062
8694 msgid "guestfs_command_lines"
8699 #: ../src/guestfs-actions.pod:1064
8703 " guestfs_command_lines (guestfs_h *g,\n"
8704 " char *const *arguments);\n"
8710 #: ../src/guestfs-actions.pod:1068
8712 "This is the same as C<guestfs_command>, but splits the result into a list of "
8718 #: ../src/guestfs-actions.pod:1071
8719 msgid "See also: C<guestfs_sh_lines>"
8724 #: ../src/guestfs-actions.pod:1082
8725 msgid "guestfs_config"
8730 #: ../src/guestfs-actions.pod:1084
8734 " guestfs_config (guestfs_h *g,\n"
8735 " const char *qemuparam,\n"
8736 " const char *qemuvalue);\n"
8741 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8743 "This can be used to add arbitrary qemu command line parameters of the form "
8744 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8745 "setting some parameters which would interfere with parameters that we use."
8750 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8751 msgid "The first character of C<param> string must be a C<-> (dash)."
8756 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8757 msgid "C<value> can be NULL."
8762 #: ../src/guestfs-actions.pod:1102
8763 msgid "guestfs_copy_size"
8768 #: ../src/guestfs-actions.pod:1104
8772 " guestfs_copy_size (guestfs_h *g,\n"
8773 " const char *src,\n"
8774 " const char *dest,\n"
8781 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8783 "This command copies exactly C<size> bytes from one source device or file "
8784 "C<src> to another destination device or file C<dest>."
8789 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8791 "Note this will fail if the source is too short or if the destination is not "
8796 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8797 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8798 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
8799 #: ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:6821
8800 #: ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:7334
8801 #: ../src/guestfs-actions.pod:7353
8803 "This long-running command can generate progress notification messages so "
8804 "that the caller can display a progress bar or indicator. To receive these "
8805 "messages, the caller must register a progress event callback. See L<guestfs"
8806 "(3)/GUESTFS_EVENT_PROGRESS>."
8811 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4163
8812 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7062
8813 #: ../src/guestfs-actions.pod:7082 ../src/guestfs-actions.pod:7168
8814 msgid "(Added in 1.0.87)"
8819 #: ../src/guestfs-actions.pod:1125
8825 #: ../src/guestfs-actions.pod:1127
8829 " guestfs_cp (guestfs_h *g,\n"
8830 " const char *src,\n"
8831 " const char *dest);\n"
8837 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8839 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8840 "destination filename or destination directory."
8845 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8846 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8847 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4848
8848 #: ../src/guestfs-actions.pod:5225
8849 msgid "(Added in 1.0.18)"
8854 #: ../src/guestfs-actions.pod:1139
8855 msgid "guestfs_cp_a"
8860 #: ../src/guestfs-actions.pod:1141
8864 " guestfs_cp_a (guestfs_h *g,\n"
8865 " const char *src,\n"
8866 " const char *dest);\n"
8872 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8874 "This copies a file or directory from C<src> to C<dest> recursively using the "
8880 #: ../src/guestfs-actions.pod:1153
8886 #: ../src/guestfs-actions.pod:1155
8890 " guestfs_dd (guestfs_h *g,\n"
8891 " const char *src,\n"
8892 " const char *dest);\n"
8898 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8900 "This command copies from one source device or file C<src> to another "
8901 "destination device or file C<dest>. Normally you would use this to copy to "
8902 "or from a device or partition, for example to duplicate a filesystem."
8907 #: ../src/guestfs-actions.pod:1165
8909 "If the destination is a device, it must be as large or larger than the "
8910 "source file or device, otherwise the copy will fail. This command cannot do "
8911 "partial copies (see C<guestfs_copy_size>)."
8916 #: ../src/guestfs-actions.pod:1173
8922 #: ../src/guestfs-actions.pod:1175
8926 " guestfs_df (guestfs_h *g);\n"
8932 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8933 msgid "This command runs the C<df> command to report disk space used."
8938 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8940 "This command is mostly useful for interactive sessions. It is I<not> "
8941 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8947 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8948 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8949 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8950 #: ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4748
8951 #: ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6583
8952 #: ../src/guestfs-actions.pod:7201 ../src/guestfs-actions.pod:7214
8953 #: ../src/guestfs-actions.pod:7227
8954 msgid "(Added in 1.0.54)"
8959 #: ../src/guestfs-actions.pod:1189
8960 msgid "guestfs_df_h"
8965 #: ../src/guestfs-actions.pod:1191
8969 " guestfs_df_h (guestfs_h *g);\n"
8975 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8977 "This command runs the C<df -h> command to report disk space used in human-"
8983 #: ../src/guestfs-actions.pod:1206
8984 msgid "guestfs_dmesg"
8989 #: ../src/guestfs-actions.pod:1208
8993 " guestfs_dmesg (guestfs_h *g);\n"
8999 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
9001 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
9002 "This is sometimes useful for extended debugging of problems."
9007 #: ../src/guestfs-actions.pod:1215
9009 "Another way to get the same information is to enable verbose messages with "
9010 "C<guestfs_set_verbose> or by setting the environment variable "
9011 "C<LIBGUESTFS_DEBUG=1> before running the program."
9016 #: ../src/guestfs-actions.pod:1225
9017 msgid "guestfs_download"
9022 #: ../src/guestfs-actions.pod:1227
9026 " guestfs_download (guestfs_h *g,\n"
9027 " const char *remotefilename,\n"
9028 " const char *filename);\n"
9034 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
9035 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
9037 "Download file C<remotefilename> and save it as C<filename> on the local "
9043 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6815
9044 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4590
9045 msgid "C<filename> can also be a named pipe."
9050 #: ../src/guestfs-actions.pod:1237
9051 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
9056 #: ../src/guestfs-actions.pod:1248
9057 msgid "guestfs_download_offset"
9062 #: ../src/guestfs-actions.pod:1250
9066 " guestfs_download_offset (guestfs_h *g,\n"
9067 " const char *remotefilename,\n"
9068 " const char *filename,\n"
9069 " int64_t offset,\n"
9076 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
9078 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
9079 "region must be within the file or device)."
9084 #: ../src/guestfs-actions.pod:1263
9086 "Note that there is no limit on the amount of data that can be downloaded "
9087 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
9088 "full amount unless an error occurs."
9093 #: ../src/guestfs-actions.pod:1268
9094 msgid "See also C<guestfs_download>, C<guestfs_pread>."
9099 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6860
9100 msgid "(Added in 1.5.17)"
9105 #: ../src/guestfs-actions.pod:1279
9106 msgid "guestfs_drop_caches"
9111 #: ../src/guestfs-actions.pod:1281
9115 " guestfs_drop_caches (guestfs_h *g,\n"
9116 " int whattodrop);\n"
9122 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
9124 "This instructs the guest kernel to drop its page cache, and/or dentries and "
9125 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
9126 "to drop, see L<http://linux-mm.org/Drop_Caches>"
9131 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
9132 msgid "Setting C<whattodrop> to 3 should drop everything."
9137 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
9139 "This automatically calls L<sync(2)> before the operation, so that the "
9140 "maximum guest memory is freed."
9145 #: ../src/guestfs-actions.pod:1299
9151 #: ../src/guestfs-actions.pod:1301
9155 " guestfs_du (guestfs_h *g,\n"
9156 " const char *path);\n"
9162 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
9164 "This command runs the C<du -s> command to estimate file space usage for "
9170 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
9172 "C<path> can be a file or a directory. If C<path> is a directory then the "
9173 "estimate includes the contents of the directory and all subdirectories "
9179 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9181 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9186 #: ../src/guestfs-actions.pod:1324
9187 msgid "guestfs_e2fsck_f"
9192 #: ../src/guestfs-actions.pod:1326
9196 " guestfs_e2fsck_f (guestfs_h *g,\n"
9197 " const char *device);\n"
9202 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
9204 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9205 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
9211 #: ../src/guestfs-actions.pod:1334
9213 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9214 "Normally you should use C<guestfs_fsck>."
9219 #: ../src/guestfs-actions.pod:1339
9220 msgid "(Added in 1.0.29)"
9225 #: ../src/guestfs-actions.pod:1341
9226 msgid "guestfs_echo_daemon"
9231 #: ../src/guestfs-actions.pod:1343
9235 " guestfs_echo_daemon (guestfs_h *g,\n"
9236 " char *const *words);\n"
9242 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
9244 "This command concatenates the list of C<words> passed with single spaces "
9245 "between them and returns the resulting string."
9250 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
9251 msgid "You can use this command to test the connection through to the daemon."
9256 #: ../src/guestfs-actions.pod:1352
9257 msgid "See also C<guestfs_ping_daemon>."
9262 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
9263 #: ../src/guestfs-actions.pod:6059
9264 msgid "(Added in 1.0.69)"
9269 #: ../src/guestfs-actions.pod:1359
9270 msgid "guestfs_egrep"
9275 #: ../src/guestfs-actions.pod:1361
9279 " guestfs_egrep (guestfs_h *g,\n"
9280 " const char *regex,\n"
9281 " const char *path);\n"
9287 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
9289 "This calls the external C<egrep> program and returns the matching lines."
9294 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
9295 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
9296 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
9297 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
9298 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
9299 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
9300 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3656
9301 #: ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3683
9302 #: ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:4683
9303 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5608
9304 #: ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6439
9305 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6465
9306 #: ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6500
9307 #: ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6526
9308 #: ../src/guestfs-actions.pod:7297 ../src/guestfs-actions.pod:7316
9309 #: ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7420
9310 #: ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7485
9311 msgid "(Added in 1.0.66)"
9316 #: ../src/guestfs-actions.pod:1378
9317 msgid "guestfs_egrepi"
9322 #: ../src/guestfs-actions.pod:1380
9326 " guestfs_egrepi (guestfs_h *g,\n"
9327 " const char *regex,\n"
9328 " const char *path);\n"
9334 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
9336 "This calls the external C<egrep -i> program and returns the matching lines."
9341 #: ../src/guestfs-actions.pod:1397
9342 msgid "guestfs_equal"
9347 #: ../src/guestfs-actions.pod:1399
9351 " guestfs_equal (guestfs_h *g,\n"
9352 " const char *file1,\n"
9353 " const char *file2);\n"
9359 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
9361 "This compares the two files C<file1> and C<file2> and returns true if their "
9362 "content is exactly equal, or false otherwise."
9367 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
9368 msgid "The external L<cmp(1)> program is used for the comparison."
9373 #: ../src/guestfs-actions.pod:1413
9374 msgid "guestfs_exists"
9379 #: ../src/guestfs-actions.pod:1415
9383 " guestfs_exists (guestfs_h *g,\n"
9384 " const char *path);\n"
9390 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
9392 "This returns C<true> if and only if there is a file, directory (or anything) "
9393 "with the given C<path> name."
9398 #: ../src/guestfs-actions.pod:1422
9399 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9404 #: ../src/guestfs-actions.pod:1428
9405 msgid "guestfs_fallocate"
9410 #: ../src/guestfs-actions.pod:1430
9414 " guestfs_fallocate (guestfs_h *g,\n"
9415 " const char *path,\n"
9422 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
9423 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9425 "This command preallocates a file (containing zero bytes) named C<path> of "
9426 "size C<len> bytes. If the file exists already, it is overwritten."
9431 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
9433 "Do not confuse this with the guestfish-specific C<alloc> command which "
9434 "allocates a file in the host and attaches it as a device."
9439 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
9441 "This function is deprecated. In new code, use the C<fallocate64> call "
9447 #: ../src/guestfs-actions.pod:1454
9448 msgid "guestfs_fallocate64"
9453 #: ../src/guestfs-actions.pod:1456
9457 " guestfs_fallocate64 (guestfs_h *g,\n"
9458 " const char *path,\n"
9465 #: ../src/guestfs-actions.pod:1465
9467 "Note that this call allocates disk blocks for the file. To create a sparse "
9468 "file use C<guestfs_truncate_size> instead."
9473 #: ../src/guestfs-actions.pod:1468
9475 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9476 "oversight it only allowed 30 bit lengths to be specified, effectively "
9477 "limiting the maximum size of files created through that call to 1GB."
9482 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
9484 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9485 "commands which create a file in the host and attach it as a device."
9490 #: ../src/guestfs-actions.pod:1479
9491 msgid "(Added in 1.3.17)"
9496 #: ../src/guestfs-actions.pod:1481
9497 msgid "guestfs_fgrep"
9502 #: ../src/guestfs-actions.pod:1483
9506 " guestfs_fgrep (guestfs_h *g,\n"
9507 " const char *pattern,\n"
9508 " const char *path);\n"
9514 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
9516 "This calls the external C<fgrep> program and returns the matching lines."
9521 #: ../src/guestfs-actions.pod:1500
9522 msgid "guestfs_fgrepi"
9527 #: ../src/guestfs-actions.pod:1502
9531 " guestfs_fgrepi (guestfs_h *g,\n"
9532 " const char *pattern,\n"
9533 " const char *path);\n"
9539 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
9541 "This calls the external C<fgrep -i> program and returns the matching lines."
9546 #: ../src/guestfs-actions.pod:1519
9547 msgid "guestfs_file"
9552 #: ../src/guestfs-actions.pod:1521
9556 " guestfs_file (guestfs_h *g,\n"
9557 " const char *path);\n"
9563 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
9565 "This call uses the standard L<file(1)> command to determine the type or "
9566 "contents of the file."
9571 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
9573 "This call will also transparently look inside various types of compressed "
9578 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
9580 "The exact command which runs is C<file -zb path>. Note in particular that "
9581 "the filename is not prepended to the output (the I<-b> option)."
9586 #: ../src/guestfs-actions.pod:1535
9588 "This command can also be used on C</dev/> devices (and partitions, LV "
9589 "names). You can for example use this to determine if a device contains a "
9590 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9595 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
9597 "If the C<path> does not begin with C</dev/> then this command only works for "
9598 "the content of regular files. For other file types (directory, symbolic "
9599 "link etc) it will just return the string C<directory> etc."
9604 #: ../src/guestfs-actions.pod:1550
9605 msgid "guestfs_file_architecture"
9610 #: ../src/guestfs-actions.pod:1552
9614 " guestfs_file_architecture (guestfs_h *g,\n"
9615 " const char *filename);\n"
9621 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
9623 "This detects the architecture of the binary C<filename>, and returns it if "
9629 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
9630 msgid "Currently defined architectures are:"
9635 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
9641 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9643 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9644 "irrespective of the precise processor requirements of the binary."
9649 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
9655 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
9656 msgid "64 bit x86-64."
9661 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
9667 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
9668 msgid "32 bit SPARC."
9673 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
9679 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
9680 msgid "64 bit SPARC V9 and above."
9685 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
9691 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
9692 msgid "Intel Itanium."
9697 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
9703 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
9704 msgid "32 bit Power PC."
9709 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
9715 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
9716 msgid "64 bit Power PC."
9721 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
9722 msgid "Libguestfs may return other architecture strings in future."
9727 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
9728 msgid "The function works on at least the following types of files:"
9733 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
9734 msgid "many types of Un*x and Linux binary"
9739 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
9740 msgid "many types of Un*x and Linux shared library"
9745 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
9746 msgid "Windows Win32 and Win64 binaries"
9751 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
9752 msgid "Windows Win32 and Win64 DLLs"
9757 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
9758 msgid "Win32 binaries and DLLs return C<i386>."
9763 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
9764 msgid "Win64 binaries and DLLs return C<x86_64>."
9769 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
9770 msgid "Linux kernel modules"
9775 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
9776 msgid "Linux new-style initrd images"
9781 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
9782 msgid "some non-x86 Linux vmlinuz kernels"
9787 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
9788 msgid "What it can't do currently:"
9793 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
9794 msgid "static libraries (libfoo.a)"
9799 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
9800 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9805 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
9806 msgid "x86 Linux vmlinuz kernels"
9811 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
9813 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9814 "compressed code, and are horribly hard to unpack. If you want to find the "
9815 "architecture of a kernel, use the architecture of the associated initrd or "
9816 "kernel module(s) instead."
9821 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
9822 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
9823 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2694
9824 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803
9825 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2930
9826 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3274
9827 #: ../src/guestfs-actions.pod:3406
9828 msgid "(Added in 1.5.3)"
9833 #: ../src/guestfs-actions.pod:1662
9834 msgid "guestfs_filesize"
9839 #: ../src/guestfs-actions.pod:1664
9843 " guestfs_filesize (guestfs_h *g,\n"
9844 " const char *file);\n"
9850 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
9851 msgid "This command returns the size of C<file> in bytes."
9856 #: ../src/guestfs-actions.pod:1670
9858 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9859 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9860 "devices, use C<guestfs_blockdev_getsize64>."
9865 #: ../src/guestfs-actions.pod:1676
9866 msgid "(Added in 1.0.82)"
9871 #: ../src/guestfs-actions.pod:1678
9872 msgid "guestfs_fill"
9877 #: ../src/guestfs-actions.pod:1680
9881 " guestfs_fill (guestfs_h *g,\n"
9884 " const char *path);\n"
9890 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
9892 "This command creates a new file called C<path>. The initial content of the "
9893 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9899 #: ../src/guestfs-actions.pod:1690
9901 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9902 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9903 "bytes use C<guestfs_fill_pattern>."
9908 #: ../src/guestfs-actions.pod:1702
9909 msgid "(Added in 1.0.79)"
9914 #: ../src/guestfs-actions.pod:1704
9915 msgid "guestfs_fill_pattern"
9920 #: ../src/guestfs-actions.pod:1706
9924 " guestfs_fill_pattern (guestfs_h *g,\n"
9925 " const char *pattern,\n"
9927 " const char *path);\n"
9933 #: ../src/guestfs-actions.pod:1712
9935 "This function is like C<guestfs_fill> except that it creates a new file of "
9936 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9937 "pattern is truncated if necessary to ensure the length of the file is "
9938 "exactly C<len> bytes."
9943 #: ../src/guestfs-actions.pod:1724
9944 msgid "(Added in 1.3.12)"
9949 #: ../src/guestfs-actions.pod:1726
9950 msgid "guestfs_find"
9955 #: ../src/guestfs-actions.pod:1728
9959 " guestfs_find (guestfs_h *g,\n"
9960 " const char *directory);\n"
9966 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
9968 "This command lists out all files and directories, recursively, starting at "
9969 "C<directory>. It is essentially equivalent to running the shell command "
9970 "C<find directory -print> but some post-processing happens on the output, "
9976 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9978 "This returns a list of strings I<without any prefix>. Thus if the directory "
9984 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
9995 #: ../src/guestfs-actions.pod:1744
9997 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
10002 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
10014 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
10015 msgid "If C<directory> is not a directory, then this command returns an error."
10020 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
10021 msgid "The returned list is sorted."
10026 #: ../src/guestfs-actions.pod:1757
10027 msgid "See also C<guestfs_find0>."
10032 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4100
10033 #: ../src/guestfs-actions.pod:5643
10034 msgid "(Added in 1.0.27)"
10039 #: ../src/guestfs-actions.pod:1768
10040 msgid "guestfs_find0"
10045 #: ../src/guestfs-actions.pod:1770
10049 " guestfs_find0 (guestfs_h *g,\n"
10050 " const char *directory,\n"
10051 " const char *files);\n"
10057 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
10059 "This command lists out all files and directories, recursively, starting at "
10060 "C<directory>, placing the resulting list in the external file called "
10066 #: ../src/guestfs-actions.pod:1779
10068 "This command works the same way as C<guestfs_find> with the following "
10074 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
10075 msgid "The resulting list is written to an external file."
10080 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
10082 "Items (filenames) in the result are separated by C<\\0> characters. See "
10083 "L<find(1)> option I<-print0>."
10088 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
10089 msgid "This command is not limited in the number of names that it can return."
10094 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
10095 msgid "The result list is not sorted."
10100 #: ../src/guestfs-actions.pod:1806
10101 msgid "(Added in 1.0.74)"
10106 #: ../src/guestfs-actions.pod:1808
10107 msgid "guestfs_findfs_label"
10112 #: ../src/guestfs-actions.pod:1810
10116 " guestfs_findfs_label (guestfs_h *g,\n"
10117 " const char *label);\n"
10123 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
10125 "This command searches the filesystems and returns the one which has the "
10126 "given label. An error is returned if no such filesystem can be found."
10131 #: ../src/guestfs-actions.pod:1818
10132 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
10137 #: ../src/guestfs-actions.pod:1825
10138 msgid "guestfs_findfs_uuid"
10143 #: ../src/guestfs-actions.pod:1827
10147 " guestfs_findfs_uuid (guestfs_h *g,\n"
10148 " const char *uuid);\n"
10154 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
10156 "This command searches the filesystems and returns the one which has the "
10157 "given UUID. An error is returned if no such filesystem can be found."
10162 #: ../src/guestfs-actions.pod:1835
10163 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10168 #: ../src/guestfs-actions.pod:1842
10169 msgid "guestfs_fsck"
10174 #: ../src/guestfs-actions.pod:1844
10178 " guestfs_fsck (guestfs_h *g,\n"
10179 " const char *fstype,\n"
10180 " const char *device);\n"
10186 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
10188 "This runs the filesystem checker (fsck) on C<device> which should have "
10189 "filesystem type C<fstype>."
10194 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
10196 "The returned integer is the status. See L<fsck(8)> for the list of status "
10197 "codes from C<fsck>."
10202 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
10203 msgid "Multiple status codes can be summed together."
10208 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
10210 "A non-zero return code can mean \"success\", for example if errors have been "
10211 "corrected on the filesystem."
10216 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
10217 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10222 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
10224 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10229 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7339
10230 msgid "(Added in 1.0.16)"
10235 #: ../src/guestfs-actions.pod:1881
10236 msgid "guestfs_get_append"
10241 #: ../src/guestfs-actions.pod:1883
10245 " guestfs_get_append (guestfs_h *g);\n"
10251 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
10253 "Return the additional kernel options which are added to the guest kernel "
10259 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
10260 msgid "If C<NULL> then no options are added."
10265 #: ../src/guestfs-actions.pod:1891
10267 "This function returns a string which may be NULL. There is no way to return "
10268 "an error from this function. The string is owned by the guest handle and "
10269 "must I<not> be freed."
10274 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5321
10275 #: ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:6201
10276 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236
10277 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:7010
10278 #: ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7382
10279 msgid "(Added in 1.0.26)"
10283 #: ../src/guestfs-actions.pod:1897
10284 msgid "guestfs_get_attach_method"
10288 #: ../src/guestfs-actions.pod:1899
10292 " guestfs_get_attach_method (guestfs_h *g);\n"
10297 #: ../src/guestfs-actions.pod:1902
10298 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10303 #: ../src/guestfs-actions.pod:1907
10304 msgid "guestfs_get_autosync"
10309 #: ../src/guestfs-actions.pod:1909
10313 " guestfs_get_autosync (guestfs_h *g);\n"
10319 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
10320 msgid "Get the autosync flag."
10325 #: ../src/guestfs-actions.pod:1918
10326 msgid "guestfs_get_direct"
10331 #: ../src/guestfs-actions.pod:1920
10335 " guestfs_get_direct (guestfs_h *g);\n"
10341 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
10342 msgid "Return the direct appliance mode flag."
10347 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5870
10348 msgid "(Added in 1.0.72)"
10353 #: ../src/guestfs-actions.pod:1929
10354 msgid "guestfs_get_e2label"
10359 #: ../src/guestfs-actions.pod:1931
10363 " guestfs_get_e2label (guestfs_h *g,\n"
10364 " const char *device);\n"
10370 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
10372 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10377 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
10379 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10384 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
10385 #: ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:5907
10386 msgid "(Added in 1.0.15)"
10391 #: ../src/guestfs-actions.pod:1950
10392 msgid "guestfs_get_e2uuid"
10397 #: ../src/guestfs-actions.pod:1952
10401 " guestfs_get_e2uuid (guestfs_h *g,\n"
10402 " const char *device);\n"
10408 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
10410 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10415 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
10417 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10422 #: ../src/guestfs-actions.pod:1971
10423 msgid "guestfs_get_memsize"
10428 #: ../src/guestfs-actions.pod:1973
10432 " guestfs_get_memsize (guestfs_h *g);\n"
10438 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
10440 "This gets the memory size in megabytes allocated to the qemu subprocess."
10445 #: ../src/guestfs-actions.pod:1979
10447 "If C<guestfs_set_memsize> was not called on this handle, and if "
10448 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10449 "value for memsize."
10454 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
10455 #: ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:6030
10456 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10457 #: ../fish/guestfish-actions.pod:3993 ../fish/guestfish-actions.pod:4080
10459 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10464 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4391
10465 #: ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4607
10466 #: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4638
10467 #: ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:4668
10468 #: ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5928
10469 #: ../src/guestfs-actions.pod:6175 ../src/guestfs-actions.pod:6776
10470 msgid "(Added in 1.0.55)"
10475 #: ../src/guestfs-actions.pod:1990
10476 msgid "guestfs_get_network"
10481 #: ../src/guestfs-actions.pod:1992
10485 " guestfs_get_network (guestfs_h *g);\n"
10491 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
10492 msgid "This returns the enable network flag."
10497 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5947
10498 msgid "(Added in 1.5.4)"
10503 #: ../src/guestfs-actions.pod:2001
10504 msgid "guestfs_get_path"
10509 #: ../src/guestfs-actions.pod:2003
10513 " guestfs_get_path (guestfs_h *g);\n"
10519 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
10520 msgid "Return the current search path."
10525 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
10527 "This is always non-NULL. If it wasn't set already, then this will return "
10528 "the default path."
10533 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
10535 "This function returns a string, or NULL on error. The string is owned by "
10536 "the guest handle and must I<not> be freed."
10541 #: ../src/guestfs-actions.pod:2016
10542 msgid "guestfs_get_pid"
10547 #: ../src/guestfs-actions.pod:2018
10551 " guestfs_get_pid (guestfs_h *g);\n"
10557 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
10559 "Return the process ID of the qemu subprocess. If there is no qemu "
10560 "subprocess, then this will return an error."
10565 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
10566 msgid "This is an internal call used for debugging and testing."
10571 #: ../src/guestfs-actions.pod:2028
10572 msgid "(Added in 1.0.56)"
10577 #: ../src/guestfs-actions.pod:2030
10578 msgid "guestfs_get_qemu"
10583 #: ../src/guestfs-actions.pod:2032
10587 " guestfs_get_qemu (guestfs_h *g);\n"
10593 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
10594 msgid "Return the current qemu binary."
10599 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
10601 "This is always non-NULL. If it wasn't set already, then this will return "
10602 "the default qemu binary name."
10607 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5992
10608 msgid "(Added in 1.0.6)"
10613 #: ../src/guestfs-actions.pod:2045
10614 msgid "guestfs_get_recovery_proc"
10619 #: ../src/guestfs-actions.pod:2047
10623 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10629 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
10630 msgid "Return the recovery process enabled flag."
10635 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3501
10636 #: ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:4198
10637 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:5251
10638 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:6016
10639 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6699
10640 #: ../src/guestfs-actions.pod:6891
10641 msgid "(Added in 1.0.77)"
10646 #: ../src/guestfs-actions.pod:2056
10647 msgid "guestfs_get_selinux"
10652 #: ../src/guestfs-actions.pod:2058
10656 " guestfs_get_selinux (guestfs_h *g);\n"
10662 #: ../src/guestfs-actions.pod:2061
10664 "This returns the current setting of the selinux flag which is passed to the "
10665 "appliance at boot time. See C<guestfs_set_selinux>."
10670 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
10671 #: ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6093
10672 msgid "(Added in 1.0.67)"
10677 #: ../src/guestfs-actions.pod:2071
10678 msgid "guestfs_get_state"
10683 #: ../src/guestfs-actions.pod:2073
10687 " guestfs_get_state (guestfs_h *g);\n"
10693 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
10695 "This returns the current state as an opaque integer. This is only useful "
10696 "for printing debug and internal error messages."
10701 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3299
10702 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3389
10703 #: ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:1409
10704 #: ../fish/guestfish-actions.pod:2323 ../fish/guestfish-actions.pod:2341
10705 #: ../fish/guestfish-actions.pod:2379 ../fish/guestfish-actions.pod:2395
10706 msgid "For more information on states, see L<guestfs(3)>."
10711 #: ../src/guestfs-actions.pod:2085
10712 msgid "guestfs_get_trace"
10717 #: ../src/guestfs-actions.pod:2087
10721 " guestfs_get_trace (guestfs_h *g);\n"
10727 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
10728 msgid "Return the command trace flag."
10733 #: ../src/guestfs-actions.pod:2096
10734 msgid "guestfs_get_umask"
10739 #: ../src/guestfs-actions.pod:2098
10743 " guestfs_get_umask (guestfs_h *g);\n"
10749 #: ../src/guestfs-actions.pod:2101
10751 "Return the current umask. By default the umask is C<022> unless it has been "
10752 "set by calling C<guestfs_umask>."
10757 #: ../src/guestfs-actions.pod:2108
10758 msgid "guestfs_get_verbose"
10763 #: ../src/guestfs-actions.pod:2110
10767 " guestfs_get_verbose (guestfs_h *g);\n"
10773 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
10774 msgid "This returns the verbose messages flag."
10779 #: ../src/guestfs-actions.pod:2119
10780 msgid "guestfs_getcon"
10785 #: ../src/guestfs-actions.pod:2121
10789 " guestfs_getcon (guestfs_h *g);\n"
10795 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
10796 msgid "This gets the SELinux security context of the daemon."
10801 #: ../src/guestfs-actions.pod:2126
10803 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10808 #: ../src/guestfs-actions.pod:2134
10809 msgid "guestfs_getxattr"
10814 #: ../src/guestfs-actions.pod:2136
10818 " guestfs_getxattr (guestfs_h *g,\n"
10819 " const char *path,\n"
10820 " const char *name,\n"
10821 " size_t *size_r);\n"
10827 #: ../src/guestfs-actions.pod:2142
10829 "Get a single extended attribute from file C<path> named C<name>. This call "
10830 "follows symlinks. If you want to lookup an extended attribute for the "
10831 "symlink itself, use C<guestfs_lgetxattr>."
10836 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3515
10838 "Normally it is better to get all extended attributes from a file in one go "
10839 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10840 "implementations are buggy and do not provide a way to list out attributes. "
10841 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10842 "extended attributes you want in advance and call this function."
10847 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3522
10848 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2460
10850 "Extended attribute values are blobs of binary data. If there is no extended "
10851 "attribute named C<name>, this returns an error."
10856 #: ../src/guestfs-actions.pod:2156
10857 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10862 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
10863 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:5244
10864 #: ../src/guestfs-actions.pod:5270 ../src/guestfs-actions.pod:5451
10866 "This function returns a buffer, or NULL on error. The size of the returned "
10867 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10872 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3531
10873 msgid "(Added in 1.7.24)"
10878 #: ../src/guestfs-actions.pod:2164
10879 msgid "guestfs_getxattrs"
10884 #: ../src/guestfs-actions.pod:2166
10887 " struct guestfs_xattr_list *\n"
10888 " guestfs_getxattrs (guestfs_h *g,\n"
10889 " const char *path);\n"
10895 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
10897 "This call lists the extended attributes of the file or directory C<path>."
10902 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
10904 "At the system call level, this is a combination of the L<listxattr(2)> and "
10905 "L<getxattr(2)> calls."
10910 #: ../src/guestfs-actions.pod:2176
10911 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10916 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3543
10917 #: ../src/guestfs-actions.pod:4194
10919 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10920 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10925 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3547
10926 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748
10927 #: ../src/guestfs-actions.pod:5624 ../src/guestfs-actions.pod:6112
10928 #: ../src/guestfs-actions.pod:7447
10929 msgid "(Added in 1.0.59)"
10934 #: ../src/guestfs-actions.pod:2184
10935 msgid "guestfs_glob_expand"
10940 #: ../src/guestfs-actions.pod:2186
10944 " guestfs_glob_expand (guestfs_h *g,\n"
10945 " const char *pattern);\n"
10951 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
10953 "This command searches for all the pathnames matching C<pattern> according to "
10954 "the wildcard expansion rules used by the shell."
10959 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
10961 "If no paths match, then this returns an empty list (note: not an error)."
10966 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
10968 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10969 "GLOB_BRACE>. See that manual page for more details."
10974 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6277
10975 #: ../src/guestfs-actions.pod:6294
10976 msgid "(Added in 1.0.50)"
10981 #: ../src/guestfs-actions.pod:2207
10982 msgid "guestfs_grep"
10987 #: ../src/guestfs-actions.pod:2209
10991 " guestfs_grep (guestfs_h *g,\n"
10992 " const char *regex,\n"
10993 " const char *path);\n"
10999 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
11000 msgid "This calls the external C<grep> program and returns the matching lines."
11005 #: ../src/guestfs-actions.pod:2226
11006 msgid "guestfs_grepi"
11011 #: ../src/guestfs-actions.pod:2228
11015 " guestfs_grepi (guestfs_h *g,\n"
11016 " const char *regex,\n"
11017 " const char *path);\n"
11023 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
11025 "This calls the external C<grep -i> program and returns the matching lines."
11030 #: ../src/guestfs-actions.pod:2245
11031 msgid "guestfs_grub_install"
11036 #: ../src/guestfs-actions.pod:2247
11040 " guestfs_grub_install (guestfs_h *g,\n"
11041 " const char *root,\n"
11042 " const char *device);\n"
11048 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
11050 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
11051 "the root directory being C<root>."
11056 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
11058 "Note: If grub-install reports the error \"No suitable drive was found in the "
11059 "generated device map.\" it may be that you need to create a C</boot/grub/"
11060 "device.map> file first that contains the mapping between grub device names "
11061 "and Linux device names. It is usually sufficient to create a file "
11067 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
11070 " (hd0) /dev/vda\n"
11076 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
11077 msgid "replacing C</dev/vda> with the name of the installation device."
11082 #: ../src/guestfs-actions.pod:2268
11083 msgid "(Added in 1.0.17)"
11088 #: ../src/guestfs-actions.pod:2270
11089 msgid "guestfs_head"
11094 #: ../src/guestfs-actions.pod:2272
11098 " guestfs_head (guestfs_h *g,\n"
11099 " const char *path);\n"
11105 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
11107 "This command returns up to the first 10 lines of a file as a list of strings."
11112 #: ../src/guestfs-actions.pod:2288
11113 msgid "guestfs_head_n"
11118 #: ../src/guestfs-actions.pod:2290
11122 " guestfs_head_n (guestfs_h *g,\n"
11124 " const char *path);\n"
11130 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
11132 "If the parameter C<nrlines> is a positive number, this returns the first "
11133 "C<nrlines> lines of the file C<path>."
11138 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
11140 "If the parameter C<nrlines> is a negative number, this returns lines from "
11141 "the file C<path>, excluding the last C<nrlines> lines."
11146 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6574
11147 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4430
11148 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
11153 #: ../src/guestfs-actions.pod:2312
11154 msgid "guestfs_hexdump"
11159 #: ../src/guestfs-actions.pod:2314
11163 " guestfs_hexdump (guestfs_h *g,\n"
11164 " const char *path);\n"
11170 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
11172 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11173 "readable, canonical hex dump of the file."
11178 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6358
11179 #: ../src/guestfs-actions.pod:6413
11180 msgid "(Added in 1.0.22)"
11185 #: ../src/guestfs-actions.pod:2329
11186 msgid "guestfs_initrd_cat"
11191 #: ../src/guestfs-actions.pod:2331
11195 " guestfs_initrd_cat (guestfs_h *g,\n"
11196 " const char *initrdpath,\n"
11197 " const char *filename,\n"
11198 " size_t *size_r);\n"
11204 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
11206 "This command unpacks the file C<filename> from the initrd file called "
11207 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11213 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
11215 "For example, in guestfish you could use the following command to examine the "
11216 "boot script (usually called C</init>) contained in a Linux initrd or "
11222 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
11225 " initrd-cat /boot/initrd-<version>.img init\n"
11231 #: ../src/guestfs-actions.pod:2347
11232 msgid "See also C<guestfs_initrd_list>."
11237 #: ../src/guestfs-actions.pod:2358
11238 msgid "guestfs_initrd_list"
11243 #: ../src/guestfs-actions.pod:2360
11247 " guestfs_initrd_list (guestfs_h *g,\n"
11248 " const char *path);\n"
11254 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
11255 msgid "This command lists out files contained in an initrd."
11260 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
11262 "The files are listed without any initial C</> character. The files are "
11263 "listed in the order they appear (not necessarily alphabetical). Directory "
11264 "names are listed as separate items."
11269 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
11271 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11272 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11278 #: ../src/guestfs-actions.pod:2380
11279 msgid "guestfs_inotify_add_watch"
11284 #: ../src/guestfs-actions.pod:2382
11288 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11289 " const char *path,\n"
11296 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
11297 msgid "Watch C<path> for the events listed in C<mask>."
11302 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
11304 "Note that if C<path> is a directory then events within that directory are "
11305 "watched, but this does I<not> happen recursively (in subdirectories)."
11310 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
11312 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11313 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11318 #: ../src/guestfs-actions.pod:2401
11319 msgid "guestfs_inotify_close"
11324 #: ../src/guestfs-actions.pod:2403
11328 " guestfs_inotify_close (guestfs_h *g);\n"
11334 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
11336 "This closes the inotify handle which was previously opened by inotify_init. "
11337 "It removes all watches, throws away any pending events, and deallocates all "
11343 #: ../src/guestfs-actions.pod:2414
11344 msgid "guestfs_inotify_files"
11349 #: ../src/guestfs-actions.pod:2416
11353 " guestfs_inotify_files (guestfs_h *g);\n"
11359 #: ../src/guestfs-actions.pod:2419
11361 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11362 "returns a list of pathnames of objects that were touched. The returned "
11363 "pathnames are sorted and deduplicated."
11368 #: ../src/guestfs-actions.pod:2429
11369 msgid "guestfs_inotify_init"
11374 #: ../src/guestfs-actions.pod:2431
11378 " guestfs_inotify_init (guestfs_h *g,\n"
11379 " int maxevents);\n"
11385 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
11387 "This command creates a new inotify handle. The inotify subsystem can be "
11388 "used to notify events which happen to objects in the guest filesystem."
11393 #: ../src/guestfs-actions.pod:2439
11395 "C<maxevents> is the maximum number of events which will be queued up between "
11396 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11397 "passed as C<0>, then the kernel (or previously set) default is used. For "
11398 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11399 "throws away events, but records the fact that it threw them away by setting "
11400 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11401 "C<guestfs_inotify_read>)."
11406 #: ../src/guestfs-actions.pod:2449
11408 "Before any events are generated, you have to add some watches to the "
11409 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11410 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11415 #: ../src/guestfs-actions.pod:2455
11417 "Queued up events should be read periodically by calling "
11418 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11419 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11420 "often enough then you risk the internal queue overflowing."
11425 #: ../src/guestfs-actions.pod:2462
11427 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11428 "This also removes any watches automatically."
11433 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
11435 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11436 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11437 "that there is one global inotify handle per libguestfs instance."
11442 #: ../src/guestfs-actions.pod:2475
11443 msgid "guestfs_inotify_read"
11448 #: ../src/guestfs-actions.pod:2477
11451 " struct guestfs_inotify_event_list *\n"
11452 " guestfs_inotify_read (guestfs_h *g);\n"
11458 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
11460 "Return the complete queue of events that have happened since the previous "
11466 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
11467 msgid "If no events have happened, this returns an empty list."
11472 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
11474 "I<Note>: In order to make sure that all events have been read, you must call "
11475 "this function repeatedly until it returns an empty list. The reason is that "
11476 "the call will read events up to the maximum appliance-to-host message size "
11477 "and leave remaining events in the queue."
11482 #: ../src/guestfs-actions.pod:2491
11484 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11485 "there was an error. I<The caller must call "
11486 "C<guestfs_free_inotify_event_list> after use>."
11491 #: ../src/guestfs-actions.pod:2497
11492 msgid "guestfs_inotify_rm_watch"
11497 #: ../src/guestfs-actions.pod:2499
11501 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11508 #: ../src/guestfs-actions.pod:2503
11510 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11515 #: ../src/guestfs-actions.pod:2510
11516 msgid "guestfs_inspect_get_arch"
11521 #: ../src/guestfs-actions.pod:2512
11525 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11526 " const char *root);\n"
11532 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
11533 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2676
11534 #: ../src/guestfs-actions.pod:2702 ../src/guestfs-actions.pod:2741
11535 #: ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2790
11536 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2854
11537 #: ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:2914
11538 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2993
11539 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3056
11540 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3096
11541 #: ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3132
11543 "This function should only be called with a root device string as returned by "
11544 "C<guestfs_inspect_os>."
11549 #: ../src/guestfs-actions.pod:2519
11551 "This returns the architecture of the inspected operating system. The "
11552 "possible return values are listed under C<guestfs_file_architecture>."
11557 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
11559 "If the architecture could not be determined, then the string C<unknown> is "
11565 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2619
11566 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2750
11567 #: ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2870
11568 #: ../src/guestfs-actions.pod:2901 ../src/guestfs-actions.pod:2925
11569 #: ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3022
11570 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3066
11571 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3103
11572 #: ../src/guestfs-actions.pod:3122 ../src/guestfs-actions.pod:3225
11573 #: ../src/guestfs-actions.pod:3266 ../fish/guestfish-actions.pod:1698
11574 #: ../fish/guestfish-actions.pod:1784 ../fish/guestfish-actions.pod:1872
11575 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:1908
11576 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2002
11577 #: ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2062
11578 #: ../fish/guestfish-actions.pod:2097 ../fish/guestfish-actions.pod:2113
11579 #: ../fish/guestfish-actions.pod:2129 ../fish/guestfish-actions.pod:2142
11580 #: ../fish/guestfish-actions.pod:2155 ../fish/guestfish-actions.pod:2170
11581 #: ../fish/guestfish-actions.pod:2269 ../fish/guestfish-actions.pod:2303
11582 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11587 #: ../src/guestfs-actions.pod:2533
11588 msgid "guestfs_inspect_get_distro"
11593 #: ../src/guestfs-actions.pod:2535
11597 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11598 " const char *root);\n"
11604 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
11606 "This returns the distro (distribution) of the inspected operating system."
11611 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
11612 msgid "Currently defined distros are:"
11617 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
11618 msgid "\"archlinux\""
11623 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
11624 msgid "Arch Linux."
11628 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
11633 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
11639 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
11645 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
11651 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
11657 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
11663 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
11669 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
11675 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
11676 msgid "\"linuxmint\""
11681 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
11682 msgid "Linux Mint."
11687 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
11688 msgid "\"mandriva\""
11693 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
11699 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
11705 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
11711 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
11717 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
11723 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
11724 msgid "\"redhat-based\""
11729 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
11730 msgid "Some Red Hat-derived distro."
11735 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
11740 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
11741 msgid "Red Hat Enterprise Linux."
11745 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
11746 msgid "\"scientificlinux\""
11750 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
11751 msgid "Scientific Linux."
11755 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
11756 msgid "\"slackware\""
11760 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
11766 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
11772 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
11778 #: ../src/guestfs-actions.pod:2605 ../src/guestfs-actions.pod:2721
11779 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:1770
11780 #: ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:2088
11781 msgid "\"unknown\""
11786 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1772
11787 msgid "The distro could not be determined."
11792 #: ../src/guestfs-actions.pod:2609 ../src/guestfs-actions.pod:3005
11793 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:2080
11794 msgid "\"windows\""
11799 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1776
11801 "Windows does not have distributions. This string is returned if the OS type "
11807 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2727
11808 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1781
11809 #: ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:2094
11811 "Future versions of libguestfs may return other strings here. The caller "
11812 "should be prepared to handle any string."
11816 #: ../src/guestfs-actions.pod:2626
11817 msgid "guestfs_inspect_get_drive_mappings"
11821 #: ../src/guestfs-actions.pod:2628
11825 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11826 " const char *root);\n"
11831 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1793
11833 "This call is useful for Windows which uses a primitive system of assigning "
11834 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11835 "Windows Registry to find out how disks/partitions are mapped to drive "
11836 "letters, and returns a hash table as in the example below:"
11840 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
11843 " C => /dev/vda2\n"
11844 " E => /dev/vdb1\n"
11845 " F => /dev/vdc1\n"
11850 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1803
11852 "Note that keys are drive letters. For Windows, the key is case insensitive "
11853 "and just contains the drive letter, without the customary colon separator "
11858 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
11860 "In future we may support other operating systems that also used drive "
11861 "letters, but the keys for those might not be case insensitive and might be "
11862 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11867 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
11869 "For Windows guests, currently only hard drive mappings are returned. "
11870 "Removable disks (eg. DVD-ROMs) are ignored."
11874 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1815
11876 "For guests that do not use drive mappings, or if the drive mappings could "
11877 "not be determined, this returns an empty hash table."
11881 #: ../src/guestfs-actions.pod:2660
11883 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11884 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11889 #: ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2840
11890 #: ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:4810
11891 #: ../src/guestfs-actions.pod:6715
11893 "This function returns a NULL-terminated array of strings, or NULL if there "
11894 "was an error. The array of strings will always have length C<2n+1>, where "
11895 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11896 "caller must free the strings and the array after use>."
11901 #: ../src/guestfs-actions.pod:2670
11902 msgid "guestfs_inspect_get_filesystems"
11907 #: ../src/guestfs-actions.pod:2672
11911 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11912 " const char *root);\n"
11918 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
11920 "This returns a list of all the filesystems that we think are associated with "
11921 "this operating system. This includes the root filesystem, other ordinary "
11922 "filesystems, and non-mounted devices like swap partitions."
11927 #: ../src/guestfs-actions.pod:2684 ../fish/guestfish-actions.pod:1834
11929 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11930 "to be shared between operating systems."
11935 #: ../src/guestfs-actions.pod:2687
11937 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11938 "C<guestfs_inspect_get_mountpoints>."
11942 #: ../src/guestfs-actions.pod:2696
11943 msgid "guestfs_inspect_get_format"
11947 #: ../src/guestfs-actions.pod:2698
11951 " guestfs_inspect_get_format (guestfs_h *g,\n"
11952 " const char *root);\n"
11957 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
11959 "This returns the format of the inspected operating system. You can use it "
11960 "to detect install images, live CDs and similar."
11964 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
11965 msgid "Currently defined formats are:"
11969 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1854
11970 msgid "\"installed\""
11974 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
11975 msgid "This is an installed operating system."
11979 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
11980 msgid "\"installer\""
11984 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
11986 "The disk image being inspected is not an installed operating system, but a "
11987 "I<bootable> install disk, live CD, or similar."
11991 #: ../src/guestfs-actions.pod:2723 ../fish/guestfish-actions.pod:1865
11992 msgid "The format of this disk image is not known."
11997 #: ../src/guestfs-actions.pod:2735
11998 msgid "guestfs_inspect_get_hostname"
12003 #: ../src/guestfs-actions.pod:2737
12007 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
12008 " const char *root);\n"
12014 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
12016 "This function returns the hostname of the operating system as found by "
12017 "inspection of the guest's configuration files."
12022 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1884
12024 "If the hostname could not be determined, then the string C<unknown> is "
12030 #: ../src/guestfs-actions.pod:2755
12031 msgid "(Added in 1.7.9)"
12036 #: ../src/guestfs-actions.pod:2757
12037 msgid "guestfs_inspect_get_major_version"
12042 #: ../src/guestfs-actions.pod:2759
12046 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
12047 " const char *root);\n"
12053 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
12055 "This returns the major version number of the inspected operating system."
12060 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1899
12062 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
12063 "popular public names used by the operating system. Notably the operating "
12064 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
12065 "1). You can find out the real versions corresponding to releases of Windows "
12066 "by consulting Wikipedia or MSDN."
12071 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2796
12072 #: ../fish/guestfish-actions.pod:1906 ../fish/guestfish-actions.pod:1920
12073 msgid "If the version could not be determined, then C<0> is returned."
12078 #: ../src/guestfs-actions.pod:2784
12079 msgid "guestfs_inspect_get_minor_version"
12084 #: ../src/guestfs-actions.pod:2786
12088 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
12089 " const char *root);\n"
12095 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1917
12097 "This returns the minor version number of the inspected operating system."
12102 #: ../src/guestfs-actions.pod:2798
12104 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12105 "C<guestfs_inspect_get_major_version>."
12110 #: ../src/guestfs-actions.pod:2805
12111 msgid "guestfs_inspect_get_mountpoints"
12116 #: ../src/guestfs-actions.pod:2807
12120 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
12121 " const char *root);\n"
12126 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1932
12128 "This returns a hash of where we think the filesystems associated with this "
12129 "operating system should be mounted. Callers should note that this is at "
12130 "best an educated guess made by reading configuration files such as C</etc/"
12131 "fstab>. I<In particular note> that this may return filesystems which are "
12132 "non-existent or not mountable and callers should be prepared to handle or "
12133 "ignore failures if they try to mount them."
12138 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:1941
12140 "Each element in the returned hashtable has a key which is the path of the "
12141 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
12142 "mounted there (eg. C</dev/sda1>)."
12147 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1946
12149 "Non-mounted devices such as swap devices are I<not> returned in this list."
12153 #: ../src/guestfs-actions.pod:2831
12155 "For operating systems like Windows which still use drive letters, this call "
12156 "will only return an entry for the first drive \"mounted on\" C</>. For "
12157 "information about the mapping of drive letters to partitions, see "
12158 "C<guestfs_inspect_get_drive_mappings>."
12163 #: ../src/guestfs-actions.pod:2837
12165 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12166 "C<guestfs_inspect_get_filesystems>."
12171 #: ../src/guestfs-actions.pod:2848
12172 msgid "guestfs_inspect_get_package_format"
12177 #: ../src/guestfs-actions.pod:2850
12181 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12182 " const char *root);\n"
12188 #: ../src/guestfs-actions.pod:2857
12190 "This function and C<guestfs_inspect_get_package_management> return the "
12191 "package format and package management tool used by the inspected operating "
12192 "system. For example for Fedora these functions would return C<rpm> (package "
12193 "format) and C<yum> (package management)."
12198 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1971
12200 "This returns the string C<unknown> if we could not determine the package "
12201 "format I<or> if the operating system does not have a real packaging system "
12207 #: ../src/guestfs-actions.pod:2867 ../fish/guestfish-actions.pod:1975
12209 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12210 "Future versions of libguestfs may return other strings."
12215 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
12216 msgid "(Added in 1.7.5)"
12221 #: ../src/guestfs-actions.pod:2877
12222 msgid "guestfs_inspect_get_package_management"
12227 #: ../src/guestfs-actions.pod:2879
12231 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12232 " const char *root);\n"
12238 #: ../src/guestfs-actions.pod:2886
12240 "C<guestfs_inspect_get_package_format> and this function return the package "
12241 "format and package management tool used by the inspected operating system. "
12242 "For example for Fedora these functions would return C<rpm> (package format) "
12243 "and C<yum> (package management)."
12248 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:1993
12250 "This returns the string C<unknown> if we could not determine the package "
12251 "management tool I<or> if the operating system does not have a real packaging "
12252 "system (eg. Windows)."
12257 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1997
12259 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12260 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12261 "libguestfs may return other strings."
12266 #: ../src/guestfs-actions.pod:2908
12267 msgid "guestfs_inspect_get_product_name"
12272 #: ../src/guestfs-actions.pod:2910
12276 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12277 " const char *root);\n"
12283 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2011
12285 "This returns the product name of the inspected operating system. The "
12286 "product name is generally some freeform string which can be displayed to the "
12287 "user, but should not be parsed by programs."
12292 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2016
12294 "If the product name could not be determined, then the string C<unknown> is "
12299 #: ../src/guestfs-actions.pod:2932
12300 msgid "guestfs_inspect_get_product_variant"
12304 #: ../src/guestfs-actions.pod:2934
12308 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12309 " const char *root);\n"
12314 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
12315 msgid "This returns the product variant of the inspected operating system."
12319 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2031
12321 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12322 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12323 "is usually a string such as C<Client> or C<Server> (other values are "
12324 "possible). This can be used to distinguish consumer and enterprise versions "
12325 "of Windows that have the same version number (for example, Windows 7 and "
12326 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12327 "the latter is C<Server>)."
12331 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2040
12333 "For enterprise Linux guests, in future we intend this to return the product "
12334 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12335 "implemented at present."
12339 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2044
12341 "If the product variant could not be determined, then the string C<unknown> "
12346 #: ../src/guestfs-actions.pod:2960
12348 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12349 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12354 #: ../src/guestfs-actions.pod:2967
12355 msgid "guestfs_inspect_get_roots"
12360 #: ../src/guestfs-actions.pod:2969
12364 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12370 #: ../src/guestfs-actions.pod:2972
12372 "This function is a convenient way to get the list of root devices, as "
12373 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12374 "the whole inspection process."
12379 #: ../src/guestfs-actions.pod:2976
12381 "This returns an empty list if either no root devices were found or the "
12382 "caller has not called C<guestfs_inspect_os>."
12387 #: ../src/guestfs-actions.pod:2985
12388 msgid "(Added in 1.7.3)"
12393 #: ../src/guestfs-actions.pod:2987
12394 msgid "guestfs_inspect_get_type"
12399 #: ../src/guestfs-actions.pod:2989
12403 " guestfs_inspect_get_type (guestfs_h *g,\n"
12404 " const char *root);\n"
12410 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2071
12412 "This returns the type of the inspected operating system. Currently defined "
12418 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
12424 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
12425 msgid "Any Linux-based operating system."
12430 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
12431 msgid "Any Microsoft Windows operating system."
12436 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
12437 msgid "\"freebsd\""
12442 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
12448 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2090
12449 msgid "The operating system type could not be determined."
12453 #: ../src/guestfs-actions.pod:3029
12454 msgid "guestfs_inspect_get_windows_current_control_set"
12458 #: ../src/guestfs-actions.pod:3031
12462 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12463 " const char *root);\n"
12468 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
12470 "This returns the Windows CurrentControlSet of the inspected guest. The "
12471 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12475 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2109
12477 "This call assumes that the guest is Windows and that the Registry could be "
12478 "examined by inspection. If this is not the case then an error is returned."
12483 #: ../src/guestfs-actions.pod:3050
12484 msgid "guestfs_inspect_get_windows_systemroot"
12489 #: ../src/guestfs-actions.pod:3052
12493 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12494 " const char *root);\n"
12500 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
12502 "This returns the Windows systemroot of the inspected guest. The systemroot "
12503 "is a directory path such as C</WINDOWS>."
12508 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2125
12510 "This call assumes that the guest is Windows and that the systemroot could be "
12511 "determined by inspection. If this is not the case then an error is returned."
12516 #: ../src/guestfs-actions.pod:3071
12517 msgid "(Added in 1.5.25)"
12521 #: ../src/guestfs-actions.pod:3073
12522 msgid "guestfs_inspect_is_live"
12526 #: ../src/guestfs-actions.pod:3075
12530 " guestfs_inspect_is_live (guestfs_h *g,\n"
12531 " const char *root);\n"
12536 #: ../src/guestfs-actions.pod:3082
12538 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12539 "disk), then this returns true if a live image was detected on the disk."
12543 #: ../src/guestfs-actions.pod:3090
12544 msgid "guestfs_inspect_is_multipart"
12548 #: ../src/guestfs-actions.pod:3092
12552 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12553 " const char *root);\n"
12558 #: ../src/guestfs-actions.pod:3099
12560 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12561 "disk), then this returns true if the disk is part of a set."
12565 #: ../src/guestfs-actions.pod:3107
12566 msgid "guestfs_inspect_is_netinst"
12570 #: ../src/guestfs-actions.pod:3109
12574 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12575 " const char *root);\n"
12580 #: ../src/guestfs-actions.pod:3116
12582 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12583 "disk), then this returns true if the disk is a network installer, ie. not a "
12584 "self-contained install CD but one which is likely to require network access "
12585 "to complete the install."
12590 #: ../src/guestfs-actions.pod:3126
12591 msgid "guestfs_inspect_list_applications"
12596 #: ../src/guestfs-actions.pod:3128
12599 " struct guestfs_application_list *\n"
12600 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12601 " const char *root);\n"
12607 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2179
12608 msgid "Return the list of applications installed in the operating system."
12613 #: ../src/guestfs-actions.pod:3137
12615 "I<Note:> This call works differently from other parts of the inspection "
12616 "API. You have to call C<guestfs_inspect_os>, then "
12617 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12618 "this. Listing applications is a significantly more difficult operation "
12619 "which requires access to the full filesystem. Also note that unlike the "
12620 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12621 "the libguestfs handle, this call actually reads parts of the mounted "
12622 "filesystems during the call."
12627 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
12629 "This returns an empty list if the inspection code was not able to determine "
12630 "the list of applications."
12635 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2194
12636 msgid "The application structure contains the following fields:"
12641 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2198
12642 msgid "C<app_name>"
12647 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
12649 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12650 "guests, this is the package name."
12655 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
12656 msgid "C<app_display_name>"
12661 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
12663 "The display name of the application, sometimes localized to the install "
12664 "language of the guest operating system."
12669 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
12671 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12672 "to display something can use C<app_name> instead."
12677 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2211
12678 msgid "C<app_epoch>"
12683 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
12685 "For package managers which use epochs, this contains the epoch of the "
12686 "package (an integer). If unavailable, this is returned as C<0>."
12691 #: ../src/guestfs-actions.pod:3172 ../fish/guestfish-actions.pod:2216
12692 msgid "C<app_version>"
12697 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
12699 "The version string of the application or package. If unavailable this is "
12700 "returned as an empty string C<\"\">."
12705 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
12706 msgid "C<app_release>"
12711 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
12713 "The release string of the application or package, for package managers that "
12714 "use this. If unavailable this is returned as an empty string C<\"\">."
12719 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2227
12720 msgid "C<app_install_path>"
12725 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
12727 "The installation path of the application (on operating systems such as "
12728 "Windows which use installation paths). This path is in the format used by "
12729 "the guest operating system, it is not a libguestfs path."
12734 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2234
12735 msgid "If unavailable this is returned as an empty string C<\"\">."
12740 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
12741 msgid "C<app_trans_path>"
12746 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
12748 "The install path translated into a libguestfs path. If unavailable this is "
12749 "returned as an empty string C<\"\">."
12754 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
12755 msgid "C<app_publisher>"
12760 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
12762 "The name of the publisher of the application, for package managers that use "
12763 "this. If unavailable this is returned as an empty string C<\"\">."
12768 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2247
12774 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
12776 "The URL (eg. upstream URL) of the application. If unavailable this is "
12777 "returned as an empty string C<\"\">."
12782 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2252
12783 msgid "C<app_source_package>"
12788 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
12790 "For packaging systems which support this, the name of the source package. "
12791 "If unavailable this is returned as an empty string C<\"\">."
12796 #: ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:2257
12797 msgid "C<app_summary>"
12802 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
12804 "A short (usually one line) description of the application or package. If "
12805 "unavailable this is returned as an empty string C<\"\">."
12810 #: ../src/guestfs-actions.pod:3218 ../fish/guestfish-actions.pod:2262
12811 msgid "C<app_description>"
12816 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
12818 "A longer description of the application or package. If unavailable this is "
12819 "returned as an empty string C<\"\">."
12824 #: ../src/guestfs-actions.pod:3227
12826 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12827 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12833 #: ../src/guestfs-actions.pod:3231
12834 msgid "(Added in 1.7.8)"
12839 #: ../src/guestfs-actions.pod:3233
12840 msgid "guestfs_inspect_os"
12845 #: ../src/guestfs-actions.pod:3235
12849 " guestfs_inspect_os (guestfs_h *g);\n"
12855 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2275
12857 "This function uses other libguestfs functions and certain heuristics to "
12858 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12859 "for operating systems."
12864 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2279
12865 msgid "The list returned is empty if no operating systems were found."
12870 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
12872 "If one operating system was found, then this returns a list with a single "
12873 "element, which is the name of the root filesystem of this operating system. "
12874 "It is also possible for this function to return a list containing more than "
12875 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12876 "element being the root filesystem of one of the operating systems."
12881 #: ../src/guestfs-actions.pod:3251
12883 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12884 "functions in order to query further information about each operating system, "
12885 "such as the name and version."
12890 #: ../src/guestfs-actions.pod:3256
12892 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12893 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12894 "the contents. This should be called with no disks currently mounted. The "
12895 "function may also use Augeas, so any existing Augeas handle will be closed."
12900 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2299
12902 "This function cannot decrypt encrypted disks. The caller must do that first "
12903 "(supplying the necessary keys) if the disk is encrypted."
12908 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3558
12909 #: ../src/guestfs-actions.pod:3620
12910 msgid "See also C<guestfs_list_filesystems>."
12915 #: ../src/guestfs-actions.pod:3276
12916 msgid "guestfs_is_blockdev"
12921 #: ../src/guestfs-actions.pod:3278
12925 " guestfs_is_blockdev (guestfs_h *g,\n"
12926 " const char *path);\n"
12932 #: ../src/guestfs-actions.pod:3282 ../fish/guestfish-actions.pod:2311
12934 "This returns C<true> if and only if there is a block device with the given "
12940 #: ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3314
12941 #: ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3359
12942 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3431
12943 #: ../src/guestfs-actions.pod:3446
12944 msgid "See also C<guestfs_stat>."
12949 #: ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3318
12950 #: ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3435
12951 #: ../src/guestfs-actions.pod:3450
12952 msgid "(Added in 1.5.10)"
12957 #: ../src/guestfs-actions.pod:3291
12958 msgid "guestfs_is_busy"
12963 #: ../src/guestfs-actions.pod:3293
12967 " guestfs_is_busy (guestfs_h *g);\n"
12973 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2320
12975 "This returns true iff this handle is busy processing a command (in the "
12981 #: ../src/guestfs-actions.pod:3305
12982 msgid "guestfs_is_chardev"
12987 #: ../src/guestfs-actions.pod:3307
12991 " guestfs_is_chardev (guestfs_h *g,\n"
12992 " const char *path);\n"
12998 #: ../src/guestfs-actions.pod:3311 ../fish/guestfish-actions.pod:2329
13000 "This returns C<true> if and only if there is a character device with the "
13001 "given C<path> name."
13006 #: ../src/guestfs-actions.pod:3320
13007 msgid "guestfs_is_config"
13012 #: ../src/guestfs-actions.pod:3322
13016 " guestfs_is_config (guestfs_h *g);\n"
13022 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2338
13024 "This returns true iff this handle is being configured (in the C<CONFIG> "
13030 #: ../src/guestfs-actions.pod:3334
13031 msgid "guestfs_is_dir"
13036 #: ../src/guestfs-actions.pod:3336
13040 " guestfs_is_dir (guestfs_h *g,\n"
13041 " const char *path);\n"
13047 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2347
13049 "This returns C<true> if and only if there is a directory with the given "
13050 "C<path> name. Note that it returns false for other objects like files."
13055 #: ../src/guestfs-actions.pod:3350
13056 msgid "guestfs_is_fifo"
13061 #: ../src/guestfs-actions.pod:3352
13065 " guestfs_is_fifo (guestfs_h *g,\n"
13066 " const char *path);\n"
13072 #: ../src/guestfs-actions.pod:3356 ../fish/guestfish-actions.pod:2357
13074 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
13075 "given C<path> name."
13080 #: ../src/guestfs-actions.pod:3365
13081 msgid "guestfs_is_file"
13086 #: ../src/guestfs-actions.pod:3367
13090 " guestfs_is_file (guestfs_h *g,\n"
13091 " const char *path);\n"
13097 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2366
13099 "This returns C<true> if and only if there is a regular file with the given "
13100 "C<path> name. Note that it returns false for other objects like directories."
13105 #: ../src/guestfs-actions.pod:3381
13106 msgid "guestfs_is_launching"
13111 #: ../src/guestfs-actions.pod:3383
13115 " guestfs_is_launching (guestfs_h *g);\n"
13121 #: ../src/guestfs-actions.pod:3386 ../fish/guestfish-actions.pod:2376
13123 "This returns true iff this handle is launching the subprocess (in the "
13124 "C<LAUNCHING> state)."
13129 #: ../src/guestfs-actions.pod:3395
13130 msgid "guestfs_is_lv"
13135 #: ../src/guestfs-actions.pod:3397
13139 " guestfs_is_lv (guestfs_h *g,\n"
13140 " const char *device);\n"
13146 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2385
13148 "This command tests whether C<device> is a logical volume, and returns true "
13149 "iff this is the case."
13154 #: ../src/guestfs-actions.pod:3408
13155 msgid "guestfs_is_ready"
13160 #: ../src/guestfs-actions.pod:3410
13164 " guestfs_is_ready (guestfs_h *g);\n"
13170 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:2392
13172 "This returns true iff this handle is ready to accept commands (in the "
13178 #: ../src/guestfs-actions.pod:3422
13179 msgid "guestfs_is_socket"
13184 #: ../src/guestfs-actions.pod:3424
13188 " guestfs_is_socket (guestfs_h *g,\n"
13189 " const char *path);\n"
13195 #: ../src/guestfs-actions.pod:3428 ../fish/guestfish-actions.pod:2401
13197 "This returns C<true> if and only if there is a Unix domain socket with the "
13198 "given C<path> name."
13203 #: ../src/guestfs-actions.pod:3437
13204 msgid "guestfs_is_symlink"
13209 #: ../src/guestfs-actions.pod:3439
13213 " guestfs_is_symlink (guestfs_h *g,\n"
13214 " const char *path);\n"
13220 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2410
13222 "This returns C<true> if and only if there is a symbolic link with the given "
13228 #: ../src/guestfs-actions.pod:3452
13229 msgid "guestfs_kill_subprocess"
13234 #: ../src/guestfs-actions.pod:3454
13238 " guestfs_kill_subprocess (guestfs_h *g);\n"
13244 #: ../src/guestfs-actions.pod:3457 ../fish/guestfish-actions.pod:2419
13245 msgid "This kills the qemu subprocess. You should never need to call this."
13250 #: ../src/guestfs-actions.pod:3463
13251 msgid "guestfs_launch"
13256 #: ../src/guestfs-actions.pod:3465
13260 " guestfs_launch (guestfs_h *g);\n"
13266 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
13268 "Internally libguestfs is implemented by running a virtual machine using "
13274 #: ../src/guestfs-actions.pod:3471 ../fish/guestfish-actions.pod:2430
13276 "You should call this after configuring the handle (eg. adding drives) but "
13277 "before performing any actions."
13282 #: ../src/guestfs-actions.pod:3483
13283 msgid "guestfs_lchown"
13288 #: ../src/guestfs-actions.pod:3485
13292 " guestfs_lchown (guestfs_h *g,\n"
13295 " const char *path);\n"
13301 #: ../src/guestfs-actions.pod:3491
13303 "Change the file owner to C<owner> and group to C<group>. This is like "
13304 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13305 "changed, not the target."
13310 #: ../src/guestfs-actions.pod:3503
13311 msgid "guestfs_lgetxattr"
13316 #: ../src/guestfs-actions.pod:3505
13320 " guestfs_lgetxattr (guestfs_h *g,\n"
13321 " const char *path,\n"
13322 " const char *name,\n"
13323 " size_t *size_r);\n"
13329 #: ../src/guestfs-actions.pod:3511 ../fish/guestfish-actions.pod:2449
13331 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13332 "is a symlink, then this call returns an extended attribute from the symlink."
13337 #: ../src/guestfs-actions.pod:3525
13338 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13343 #: ../src/guestfs-actions.pod:3533
13344 msgid "guestfs_lgetxattrs"
13349 #: ../src/guestfs-actions.pod:3535
13352 " struct guestfs_xattr_list *\n"
13353 " guestfs_lgetxattrs (guestfs_h *g,\n"
13354 " const char *path);\n"
13360 #: ../src/guestfs-actions.pod:3539
13362 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13363 "then it returns the extended attributes of the link itself."
13368 #: ../src/guestfs-actions.pod:3549
13369 msgid "guestfs_list_devices"
13374 #: ../src/guestfs-actions.pod:3551
13378 " guestfs_list_devices (guestfs_h *g);\n"
13384 #: ../src/guestfs-actions.pod:3554 ../fish/guestfish-actions.pod:2477
13385 msgid "List all the block devices."
13390 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
13391 msgid "The full block device names are returned, eg. C</dev/sda>."
13396 #: ../src/guestfs-actions.pod:3566
13397 msgid "guestfs_list_filesystems"
13402 #: ../src/guestfs-actions.pod:3568
13406 " guestfs_list_filesystems (guestfs_h *g);\n"
13412 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
13414 "This inspection command looks for filesystems on partitions, block devices "
13415 "and logical volumes, returning a list of devices containing filesystems and "
13421 #: ../src/guestfs-actions.pod:3575 ../fish/guestfish-actions.pod:2491
13423 "The return value is a hash, where the keys are the devices containing "
13424 "filesystems, and the values are the filesystem types. For example:"
13429 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2495
13432 " \"/dev/sda1\" => \"ntfs\"\n"
13433 " \"/dev/sda2\" => \"ext2\"\n"
13434 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13435 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13441 #: ../src/guestfs-actions.pod:3584 ../fish/guestfish-actions.pod:2500
13443 "The value can have the special value \"unknown\", meaning the content of the "
13444 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13449 #: ../src/guestfs-actions.pod:3588
13451 "This command runs other libguestfs commands, which might include "
13452 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13453 "soon after launch and only when nothing is mounted."
13458 #: ../src/guestfs-actions.pod:3592
13460 "Not all of the filesystems returned will be mountable. In particular, swap "
13461 "partitions are returned in the list. Also this command does not check that "
13462 "each filesystem found is valid and mountable, and some filesystems might be "
13463 "mountable but require special options. Filesystems may not all belong to a "
13464 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13469 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:5211
13470 msgid "(Added in 1.5.15)"
13475 #: ../src/guestfs-actions.pod:3608
13476 msgid "guestfs_list_partitions"
13481 #: ../src/guestfs-actions.pod:3610
13485 " guestfs_list_partitions (guestfs_h *g);\n"
13491 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2520
13492 msgid "List all the partitions detected on all block devices."
13497 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
13498 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13503 #: ../src/guestfs-actions.pod:3617
13505 "This does not return logical volumes. For that you will need to call "
13511 #: ../src/guestfs-actions.pod:3628
13517 #: ../src/guestfs-actions.pod:3630
13521 " guestfs_ll (guestfs_h *g,\n"
13522 " const char *directory);\n"
13528 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
13530 "List the files in C<directory> (relative to the root directory, there is no "
13531 "cwd) in the format of 'ls -la'."
13536 #: ../src/guestfs-actions.pod:3637 ../fish/guestfish-actions.pod:2536
13538 "This command is mostly useful for interactive sessions. It is I<not> "
13539 "intended that you try to parse the output string."
13544 #: ../src/guestfs-actions.pod:3645
13550 #: ../src/guestfs-actions.pod:3647
13554 " guestfs_ln (guestfs_h *g,\n"
13555 " const char *target,\n"
13556 " const char *linkname);\n"
13562 #: ../src/guestfs-actions.pod:3652 ../fish/guestfish-actions.pod:2543
13563 msgid "This command creates a hard link using the C<ln> command."
13568 #: ../src/guestfs-actions.pod:3658
13569 msgid "guestfs_ln_f"
13574 #: ../src/guestfs-actions.pod:3660
13578 " guestfs_ln_f (guestfs_h *g,\n"
13579 " const char *target,\n"
13580 " const char *linkname);\n"
13585 #: ../src/guestfs-actions.pod:3665 ../fish/guestfish-actions.pod:2549
13587 "This command creates a hard link using the C<ln -f> command. The I<-f> "
13588 "option removes the link (C<linkname>) if it exists already."
13593 #: ../src/guestfs-actions.pod:3672
13594 msgid "guestfs_ln_s"
13599 #: ../src/guestfs-actions.pod:3674
13603 " guestfs_ln_s (guestfs_h *g,\n"
13604 " const char *target,\n"
13605 " const char *linkname);\n"
13611 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2556
13612 msgid "This command creates a symbolic link using the C<ln -s> command."
13617 #: ../src/guestfs-actions.pod:3685
13618 msgid "guestfs_ln_sf"
13623 #: ../src/guestfs-actions.pod:3687
13627 " guestfs_ln_sf (guestfs_h *g,\n"
13628 " const char *target,\n"
13629 " const char *linkname);\n"
13634 #: ../src/guestfs-actions.pod:3692 ../fish/guestfish-actions.pod:2562
13636 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
13637 "option removes the link (C<linkname>) if it exists already."
13642 #: ../src/guestfs-actions.pod:3699
13643 msgid "guestfs_lremovexattr"
13648 #: ../src/guestfs-actions.pod:3701
13652 " guestfs_lremovexattr (guestfs_h *g,\n"
13653 " const char *xattr,\n"
13654 " const char *path);\n"
13660 #: ../src/guestfs-actions.pod:3706
13662 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13663 "link, then it removes an extended attribute of the link itself."
13668 #: ../src/guestfs-actions.pod:3714
13674 #: ../src/guestfs-actions.pod:3716
13678 " guestfs_ls (guestfs_h *g,\n"
13679 " const char *directory);\n"
13685 #: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2577
13687 "List the files in C<directory> (relative to the root directory, there is no "
13688 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13693 #: ../src/guestfs-actions.pod:3724
13695 "This command is mostly useful for interactive sessions. Programs should "
13696 "probably use C<guestfs_readdir> instead."
13701 #: ../src/guestfs-actions.pod:3733
13702 msgid "guestfs_lsetxattr"
13707 #: ../src/guestfs-actions.pod:3735
13711 " guestfs_lsetxattr (guestfs_h *g,\n"
13712 " const char *xattr,\n"
13713 " const char *val,\n"
13715 " const char *path);\n"
13721 #: ../src/guestfs-actions.pod:3742
13723 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13724 "then it sets an extended attribute of the link itself."
13729 #: ../src/guestfs-actions.pod:3750
13730 msgid "guestfs_lstat"
13735 #: ../src/guestfs-actions.pod:3752
13738 " struct guestfs_stat *\n"
13739 " guestfs_lstat (guestfs_h *g,\n"
13740 " const char *path);\n"
13746 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6314
13747 #: ../fish/guestfish-actions.pod:2596 ../fish/guestfish-actions.pod:4265
13748 msgid "Returns file information for the given C<path>."
13753 #: ../src/guestfs-actions.pod:3758
13755 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13756 "link, then the link is stat-ed, not the file it refers to."
13761 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2602
13762 msgid "This is the same as the C<lstat(2)> system call."
13767 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:6318
13769 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13770 "error. I<The caller must call C<guestfs_free_stat> after use>."
13775 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:6322
13776 #: ../src/guestfs-actions.pod:6340 ../src/guestfs-actions.pod:6721
13777 msgid "(Added in 0.9.2)"
13782 #: ../src/guestfs-actions.pod:3770
13783 msgid "guestfs_lstatlist"
13788 #: ../src/guestfs-actions.pod:3772
13791 " struct guestfs_stat_list *\n"
13792 " guestfs_lstatlist (guestfs_h *g,\n"
13793 " const char *path,\n"
13794 " char *const *names);\n"
13800 #: ../src/guestfs-actions.pod:3777
13802 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13803 "files, where all files are in the directory C<path>. C<names> is the list "
13804 "of files from this directory."
13809 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2612
13811 "On return you get a list of stat structs, with a one-to-one correspondence "
13812 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13813 "then the C<ino> field of that structure is set to C<-1>."
13818 #: ../src/guestfs-actions.pod:3786
13820 "This call is intended for programs that want to efficiently list a directory "
13821 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13822 "for a similarly efficient call for getting extended attributes. Very long "
13823 "directory listings might cause the protocol message size to be exceeded, "
13824 "causing this call to fail. The caller must split up such requests into "
13825 "smaller groups of names."
13830 #: ../src/guestfs-actions.pod:3794
13832 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13833 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13838 #: ../src/guestfs-actions.pod:3800
13839 msgid "guestfs_luks_add_key"
13844 #: ../src/guestfs-actions.pod:3802
13848 " guestfs_luks_add_key (guestfs_h *g,\n"
13849 " const char *device,\n"
13850 " const char *key,\n"
13851 " const char *newkey,\n"
13858 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2629
13860 "This command adds a new key on LUKS device C<device>. C<key> is any "
13861 "existing key, and is used to access the device. C<newkey> is the new key to "
13862 "add. C<keyslot> is the key slot that will be replaced."
13867 #: ../src/guestfs-actions.pod:3814
13869 "Note that if C<keyslot> already contains a key, then this command will "
13870 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13875 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3860
13876 #: ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3903
13877 #: ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:3954
13879 "This function takes a key or passphrase parameter which could contain "
13880 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13886 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3864
13887 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3907
13888 msgid "(Added in 1.5.2)"
13893 #: ../src/guestfs-actions.pod:3826
13894 msgid "guestfs_luks_close"
13899 #: ../src/guestfs-actions.pod:3828
13903 " guestfs_luks_close (guestfs_h *g,\n"
13904 " const char *device);\n"
13910 #: ../src/guestfs-actions.pod:3832
13912 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13913 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13914 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13915 "underlying block device."
13920 #: ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3939
13921 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4008
13922 #: ../src/guestfs-actions.pod:4056
13923 msgid "(Added in 1.5.1)"
13928 #: ../src/guestfs-actions.pod:3842
13929 msgid "guestfs_luks_format"
13934 #: ../src/guestfs-actions.pod:3844
13938 " guestfs_luks_format (guestfs_h *g,\n"
13939 " const char *device,\n"
13940 " const char *key,\n"
13947 #: ../src/guestfs-actions.pod:3850 ../fish/guestfish-actions.pod:2655
13949 "This command erases existing data on C<device> and formats the device as a "
13950 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13951 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13956 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880
13957 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4962
13958 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6149
13959 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6198
13960 #: ../src/guestfs-actions.pod:7358 ../fish/guestfish-actions.pod:2663
13961 #: ../fish/guestfish-actions.pod:2676 ../fish/guestfish-actions.pod:2760
13962 #: ../fish/guestfish-actions.pod:3334 ../fish/guestfish-actions.pod:3854
13963 #: ../fish/guestfish-actions.pod:4164 ../fish/guestfish-actions.pod:4180
13964 #: ../fish/guestfish-actions.pod:4195 ../fish/guestfish-actions.pod:4910
13966 "B<This command is dangerous. Without careful use you can easily destroy all "
13972 #: ../src/guestfs-actions.pod:3866
13973 msgid "guestfs_luks_format_cipher"
13978 #: ../src/guestfs-actions.pod:3868
13982 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13983 " const char *device,\n"
13984 " const char *key,\n"
13986 " const char *cipher);\n"
13992 #: ../src/guestfs-actions.pod:3875
13994 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13995 "set the C<cipher> used."
14000 #: ../src/guestfs-actions.pod:3889
14001 msgid "guestfs_luks_kill_slot"
14006 #: ../src/guestfs-actions.pod:3891
14010 " guestfs_luks_kill_slot (guestfs_h *g,\n"
14011 " const char *device,\n"
14012 " const char *key,\n"
14019 #: ../src/guestfs-actions.pod:3897 ../fish/guestfish-actions.pod:2683
14021 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
14022 "device C<device>. C<key> must be one of the I<other> keys."
14027 #: ../src/guestfs-actions.pod:3909
14028 msgid "guestfs_luks_open"
14033 #: ../src/guestfs-actions.pod:3911
14037 " guestfs_luks_open (guestfs_h *g,\n"
14038 " const char *device,\n"
14039 " const char *key,\n"
14040 " const char *mapname);\n"
14046 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
14048 "This command opens a block device which has been encrypted according to the "
14049 "Linux Unified Key Setup (LUKS) standard."
14054 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2697
14055 msgid "C<device> is the encrypted block device or partition."
14060 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
14062 "The caller must supply one of the keys associated with the LUKS block "
14063 "device, in the C<key> parameter."
14068 #: ../src/guestfs-actions.pod:3925 ../fish/guestfish-actions.pod:2702
14070 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
14071 "writes to this block device are decrypted from and encrypted to the "
14072 "underlying C<device> respectively."
14077 #: ../src/guestfs-actions.pod:3929
14079 "If this block device contains LVM volume groups, then calling "
14080 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
14086 #: ../src/guestfs-actions.pod:3941
14087 msgid "guestfs_luks_open_ro"
14092 #: ../src/guestfs-actions.pod:3943
14096 " guestfs_luks_open_ro (guestfs_h *g,\n"
14097 " const char *device,\n"
14098 " const char *key,\n"
14099 " const char *mapname);\n"
14105 #: ../src/guestfs-actions.pod:3949
14107 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
14113 #: ../src/guestfs-actions.pod:3960
14114 msgid "guestfs_lvcreate"
14119 #: ../src/guestfs-actions.pod:3962
14123 " guestfs_lvcreate (guestfs_h *g,\n"
14124 " const char *logvol,\n"
14125 " const char *volgroup,\n"
14132 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2727
14134 "This creates an LVM logical volume called C<logvol> on the volume group "
14135 "C<volgroup>, with C<size> megabytes."
14140 #: ../src/guestfs-actions.pod:3975
14141 msgid "guestfs_lvm_canonical_lv_name"
14146 #: ../src/guestfs-actions.pod:3977
14150 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
14151 " const char *lvname);\n"
14157 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2734
14159 "This converts alternative naming schemes for LVs that you might find to the "
14160 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14166 #: ../src/guestfs-actions.pod:3985 ../fish/guestfish-actions.pod:2738
14168 "This command returns an error if the C<lvname> parameter does not refer to a "
14174 #: ../src/guestfs-actions.pod:3988
14175 msgid "See also C<guestfs_is_lv>."
14180 #: ../src/guestfs-actions.pod:3993
14181 msgid "(Added in 1.5.24)"
14186 #: ../src/guestfs-actions.pod:3995
14187 msgid "guestfs_lvm_clear_filter"
14192 #: ../src/guestfs-actions.pod:3997
14196 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14202 #: ../src/guestfs-actions.pod:4000
14204 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14205 "see every block device."
14210 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4045
14211 #: ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2781
14213 "This command also clears the LVM cache and performs a volume group scan."
14218 #: ../src/guestfs-actions.pod:4010
14219 msgid "guestfs_lvm_remove_all"
14224 #: ../src/guestfs-actions.pod:4012
14228 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14234 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2757
14236 "This command removes all LVM logical volumes, volume groups and physical "
14242 #: ../src/guestfs-actions.pod:4025
14243 msgid "guestfs_lvm_set_filter"
14248 #: ../src/guestfs-actions.pod:4027
14252 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14253 " char *const *devices);\n"
14259 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2767
14261 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14262 "block devices in the list C<devices>, and will ignore all other attached "
14268 #: ../src/guestfs-actions.pod:4035 ../fish/guestfish-actions.pod:2771
14270 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14271 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14272 "there are two types of duplication possible: either cloned PVs/VGs which "
14273 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14274 "same name. In normal operation you cannot create this situation, but you "
14275 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14276 "inside the LVM metadata."
14281 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2784
14282 msgid "You can filter whole block devices or individual partitions."
14287 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
14289 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14290 "filesystem), even if you are not filtering out that VG."
14295 #: ../src/guestfs-actions.pod:4058
14296 msgid "guestfs_lvremove"
14301 #: ../src/guestfs-actions.pod:4060
14305 " guestfs_lvremove (guestfs_h *g,\n"
14306 " const char *device);\n"
14312 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
14314 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14315 "LV, such as C</dev/VG/LV>."
14320 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2797
14322 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14328 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:5308
14329 #: ../src/guestfs-actions.pod:7097
14330 msgid "(Added in 1.0.13)"
14335 #: ../src/guestfs-actions.pod:4074
14336 msgid "guestfs_lvrename"
14341 #: ../src/guestfs-actions.pod:4076
14345 " guestfs_lvrename (guestfs_h *g,\n"
14346 " const char *logvol,\n"
14347 " const char *newlogvol);\n"
14353 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2804
14354 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14359 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:7110
14360 msgid "(Added in 1.0.83)"
14365 #: ../src/guestfs-actions.pod:4087
14366 msgid "guestfs_lvresize"
14371 #: ../src/guestfs-actions.pod:4089
14375 " guestfs_lvresize (guestfs_h *g,\n"
14376 " const char *device,\n"
14383 #: ../src/guestfs-actions.pod:4094 ../fish/guestfish-actions.pod:2810
14385 "This resizes (expands or shrinks) an existing LVM logical volume to "
14386 "C<mbytes>. When reducing, data in the reduced part is lost."
14391 #: ../src/guestfs-actions.pod:4102
14392 msgid "guestfs_lvresize_free"
14397 #: ../src/guestfs-actions.pod:4104
14401 " guestfs_lvresize_free (guestfs_h *g,\n"
14402 " const char *lv,\n"
14409 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2818
14411 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14412 "remaining free space in the volume group. Commonly you would call this with "
14413 "pc = 100 which expands the logical volume as much as possible, using all "
14414 "remaining free space in the volume group."
14419 #: ../src/guestfs-actions.pod:4117
14420 msgid "(Added in 1.3.3)"
14425 #: ../src/guestfs-actions.pod:4119
14426 msgid "guestfs_lvs"
14431 #: ../src/guestfs-actions.pod:4121
14435 " guestfs_lvs (guestfs_h *g);\n"
14441 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
14443 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14449 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2831
14451 "This returns a list of the logical volume device names (eg. C</dev/"
14452 "VolGroup00/LogVol00>)."
14457 #: ../src/guestfs-actions.pod:4130
14458 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14463 #: ../src/guestfs-actions.pod:4138
14464 msgid "guestfs_lvs_full"
14469 #: ../src/guestfs-actions.pod:4140
14472 " struct guestfs_lvm_lv_list *\n"
14473 " guestfs_lvs_full (guestfs_h *g);\n"
14479 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:2840
14481 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14482 "(8)> command. The \"full\" version includes all fields."
14487 #: ../src/guestfs-actions.pod:4146
14489 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14490 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14495 #: ../src/guestfs-actions.pod:4152
14496 msgid "guestfs_lvuuid"
14501 #: ../src/guestfs-actions.pod:4154
14505 " guestfs_lvuuid (guestfs_h *g,\n"
14506 " const char *device);\n"
14512 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2847
14513 msgid "This command returns the UUID of the LVM LV C<device>."
14518 #: ../src/guestfs-actions.pod:4165
14519 msgid "guestfs_lxattrlist"
14524 #: ../src/guestfs-actions.pod:4167
14527 " struct guestfs_xattr_list *\n"
14528 " guestfs_lxattrlist (guestfs_h *g,\n"
14529 " const char *path,\n"
14530 " char *const *names);\n"
14536 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2853
14538 "This call allows you to get the extended attributes of multiple files, where "
14539 "all files are in the directory C<path>. C<names> is the list of files from "
14545 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2857
14547 "On return you get a flat list of xattr structs which must be interpreted "
14548 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14549 "C<attrval> in this struct is zero-length to indicate there was an error "
14550 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14551 "number (the number of following attributes for this file, which could be C<"
14552 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14553 "for the first named file. This repeats for the second and subsequent files."
14558 #: ../src/guestfs-actions.pod:4186
14560 "This call is intended for programs that want to efficiently list a directory "
14561 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14562 "a similarly efficient call for getting standard stats. Very long directory "
14563 "listings might cause the protocol message size to be exceeded, causing this "
14564 "call to fail. The caller must split up such requests into smaller groups of "
14570 #: ../src/guestfs-actions.pod:4200
14571 msgid "guestfs_mkdir"
14576 #: ../src/guestfs-actions.pod:4202
14580 " guestfs_mkdir (guestfs_h *g,\n"
14581 " const char *path);\n"
14587 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2879
14588 msgid "Create a directory named C<path>."
14593 #: ../src/guestfs-actions.pod:4212
14594 msgid "guestfs_mkdir_mode"
14599 #: ../src/guestfs-actions.pod:4214
14603 " guestfs_mkdir_mode (guestfs_h *g,\n"
14604 " const char *path,\n"
14611 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
14613 "This command creates a directory, setting the initial permissions of the "
14614 "directory to C<mode>."
14619 #: ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2888
14621 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14622 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14628 #: ../src/guestfs-actions.pod:4226
14629 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14634 #: ../src/guestfs-actions.pod:4232
14635 msgid "guestfs_mkdir_p"
14640 #: ../src/guestfs-actions.pod:4234
14644 " guestfs_mkdir_p (guestfs_h *g,\n"
14645 " const char *path);\n"
14651 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:2898
14653 "Create a directory named C<path>, creating any parent directories as "
14654 "necessary. This is like the C<mkdir -p> shell command."
14659 #: ../src/guestfs-actions.pod:4245
14660 msgid "guestfs_mkdtemp"
14665 #: ../src/guestfs-actions.pod:4247
14669 " guestfs_mkdtemp (guestfs_h *g,\n"
14670 " const char *template);\n"
14676 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
14678 "This command creates a temporary directory. The C<template> parameter "
14679 "should be a full pathname for the temporary directory name with the final "
14680 "six characters being \"XXXXXX\"."
14685 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
14687 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14688 "being suitable for Windows filesystems."
14693 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
14694 msgid "The name of the temporary directory that was created is returned."
14699 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
14700 msgid "The temporary directory is created with mode 0700 and is owned by root."
14705 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
14707 "The caller is responsible for deleting the temporary directory and its "
14708 "contents after use."
14713 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2922
14714 msgid "See also: L<mkdtemp(3)>"
14719 #: ../src/guestfs-actions.pod:4275
14720 msgid "guestfs_mke2fs_J"
14725 #: ../src/guestfs-actions.pod:4277
14729 " guestfs_mke2fs_J (guestfs_h *g,\n"
14730 " const char *fstype,\n"
14731 " int blocksize,\n"
14732 " const char *device,\n"
14733 " const char *journal);\n"
14739 #: ../src/guestfs-actions.pod:4284 ../fish/guestfish-actions.pod:2928
14741 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14742 "C<journal>. It is equivalent to the command:"
14747 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2932
14750 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14756 #: ../src/guestfs-actions.pod:4290
14757 msgid "See also C<guestfs_mke2journal>."
14762 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312
14763 #: ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346
14764 #: ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374
14765 #: ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4698
14766 msgid "(Added in 1.0.68)"
14771 #: ../src/guestfs-actions.pod:4296
14772 msgid "guestfs_mke2fs_JL"
14777 #: ../src/guestfs-actions.pod:4298
14781 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14782 " const char *fstype,\n"
14783 " int blocksize,\n"
14784 " const char *device,\n"
14785 " const char *label);\n"
14791 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2940
14793 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14794 "the journal labeled C<label>."
14799 #: ../src/guestfs-actions.pod:4308
14800 msgid "See also C<guestfs_mke2journal_L>."
14805 #: ../src/guestfs-actions.pod:4314
14806 msgid "guestfs_mke2fs_JU"
14811 #: ../src/guestfs-actions.pod:4316
14815 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14816 " const char *fstype,\n"
14817 " int blocksize,\n"
14818 " const char *device,\n"
14819 " const char *uuid);\n"
14825 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2949
14827 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14828 "the journal with UUID C<uuid>."
14833 #: ../src/guestfs-actions.pod:4326
14834 msgid "See also C<guestfs_mke2journal_U>."
14839 #: ../src/guestfs-actions.pod:4332
14840 msgid "guestfs_mke2journal"
14845 #: ../src/guestfs-actions.pod:4334
14849 " guestfs_mke2journal (guestfs_h *g,\n"
14850 " int blocksize,\n"
14851 " const char *device);\n"
14857 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
14859 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14865 #: ../src/guestfs-actions.pod:4342 ../fish/guestfish-actions.pod:2961
14868 " mke2fs -O journal_dev -b blocksize device\n"
14874 #: ../src/guestfs-actions.pod:4348
14875 msgid "guestfs_mke2journal_L"
14880 #: ../src/guestfs-actions.pod:4350
14884 " guestfs_mke2journal_L (guestfs_h *g,\n"
14885 " int blocksize,\n"
14886 " const char *label,\n"
14887 " const char *device);\n"
14893 #: ../src/guestfs-actions.pod:4356 ../fish/guestfish-actions.pod:2967
14894 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14899 #: ../src/guestfs-actions.pod:4362
14900 msgid "guestfs_mke2journal_U"
14905 #: ../src/guestfs-actions.pod:4364
14909 " guestfs_mke2journal_U (guestfs_h *g,\n"
14910 " int blocksize,\n"
14911 " const char *uuid,\n"
14912 " const char *device);\n"
14918 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2973
14919 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14924 #: ../src/guestfs-actions.pod:4376
14925 msgid "guestfs_mkfifo"
14930 #: ../src/guestfs-actions.pod:4378
14934 " guestfs_mkfifo (guestfs_h *g,\n"
14936 " const char *path);\n"
14942 #: ../src/guestfs-actions.pod:4383
14944 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14945 "is just a convenient wrapper around C<guestfs_mknod>."
14950 #: ../src/guestfs-actions.pod:4393
14951 msgid "guestfs_mkfs"
14956 #: ../src/guestfs-actions.pod:4395
14960 " guestfs_mkfs (guestfs_h *g,\n"
14961 " const char *fstype,\n"
14962 " const char *device);\n"
14968 #: ../src/guestfs-actions.pod:4400 ../fish/guestfish-actions.pod:2989
14970 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14971 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14976 #: ../src/guestfs-actions.pod:4408
14977 msgid "guestfs_mkfs_b"
14982 #: ../src/guestfs-actions.pod:4410
14986 " guestfs_mkfs_b (guestfs_h *g,\n"
14987 " const char *fstype,\n"
14988 " int blocksize,\n"
14989 " const char *device);\n"
14995 #: ../src/guestfs-actions.pod:4416
14997 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14998 "block size of the resulting filesystem. Supported block sizes depend on the "
14999 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
15004 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4464
15005 #: ../fish/guestfish-actions.pod:3002 ../fish/guestfish-actions.pod:3029
15007 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
15013 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:3005
15015 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
15020 #: ../src/guestfs-actions.pod:4435
15021 msgid "guestfs_mkfs_opts"
15026 #: ../src/guestfs-actions.pod:4437
15030 " guestfs_mkfs_opts (guestfs_h *g,\n"
15031 " const char *fstype,\n"
15032 " const char *device,\n"
15038 #: ../src/guestfs-actions.pod:4448
15041 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
15042 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
15048 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3016
15050 "This function creates a filesystem on C<device>. The filesystem type is "
15051 "C<fstype>, for example C<ext3>."
15056 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:3023
15057 msgid "C<blocksize>"
15062 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
15064 "The filesystem block size. Supported block sizes depend on the filesystem "
15065 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
15070 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:3032
15071 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
15075 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
15076 msgid "C<features>"
15080 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
15081 msgid "This passes the I<-O> parameter to the external mkfs program."
15085 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
15087 "For certain filesystem types, this allows extra filesystem features to be "
15088 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
15092 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3042
15094 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
15099 #: ../src/guestfs-actions.pod:4484
15100 msgid "(Added in 1.7.19)"
15105 #: ../src/guestfs-actions.pod:4486
15106 msgid "guestfs_mkfs_opts_va"
15111 #: ../src/guestfs-actions.pod:4488
15115 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
15116 " const char *fstype,\n"
15117 " const char *device,\n"
15118 " va_list args);\n"
15124 #: ../src/guestfs-actions.pod:4494
15125 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
15130 #: ../src/guestfs-actions.pod:4498
15131 msgid "guestfs_mkfs_opts_argv"
15136 #: ../src/guestfs-actions.pod:4500
15140 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
15141 " const char *fstype,\n"
15142 " const char *device,\n"
15143 " const struct guestfs_mkfs_opts_argv *optargs);\n"
15149 #: ../src/guestfs-actions.pod:4506
15150 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
15155 #: ../src/guestfs-actions.pod:4510
15156 msgid "guestfs_mkmountpoint"
15161 #: ../src/guestfs-actions.pod:4512
15165 " guestfs_mkmountpoint (guestfs_h *g,\n"
15166 " const char *exemptpath);\n"
15172 #: ../src/guestfs-actions.pod:4516
15174 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15175 "that can be used to create extra mountpoints before mounting the first "
15181 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3057
15183 "These calls are I<only> necessary in some very limited circumstances, mainly "
15184 "the case where you want to mount a mix of unrelated and/or read-only "
15185 "filesystems together."
15190 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3061
15192 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15193 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15194 "inside that. You can unpack this as follows in guestfish:"
15199 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3066
15202 " add-ro Fedora-11-i686-Live.iso\n"
15204 " mkmountpoint /cd\n"
15205 " mkmountpoint /sqsh\n"
15206 " mkmountpoint /ext3fs\n"
15207 " mount /dev/sda /cd\n"
15208 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15209 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15215 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3075
15216 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15221 #: ../src/guestfs-actions.pod:4540
15223 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15224 "may get unexpected errors if you try to mix these calls. It is safest to "
15225 "manually unmount filesystems and remove mountpoints after use."
15230 #: ../src/guestfs-actions.pod:4544
15232 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15233 "first, so for this to work for manual mountpoints, you must ensure that the "
15234 "innermost mountpoints have the longest pathnames, as in the example code "
15240 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3086
15242 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15246 #: ../src/guestfs-actions.pod:4551
15248 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15249 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15250 "can also trigger these issues."
15255 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4816
15256 #: ../src/guestfs-actions.pod:5726
15257 msgid "(Added in 1.0.62)"
15262 #: ../src/guestfs-actions.pod:4559
15263 msgid "guestfs_mknod"
15268 #: ../src/guestfs-actions.pod:4561
15272 " guestfs_mknod (guestfs_h *g,\n"
15276 " const char *path);\n"
15282 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
15284 "This call creates block or character special devices, or named pipes (FIFOs)."
15289 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3099
15291 "The C<mode> parameter should be the mode, using the standard constants. "
15292 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15293 "used when creating block and character special devices."
15298 #: ../src/guestfs-actions.pod:4576
15300 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15301 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15302 "regular file). These constants are available in the standard Linux header "
15303 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15304 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15305 "the appropriate constant for you."
15310 #: ../src/guestfs-actions.pod:4590
15311 msgid "guestfs_mknod_b"
15316 #: ../src/guestfs-actions.pod:4592
15320 " guestfs_mknod_b (guestfs_h *g,\n"
15324 " const char *path);\n"
15330 #: ../src/guestfs-actions.pod:4599
15332 "This call creates a block device node called C<path> with mode C<mode> and "
15333 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15334 "wrapper around C<guestfs_mknod>."
15339 #: ../src/guestfs-actions.pod:4609
15340 msgid "guestfs_mknod_c"
15345 #: ../src/guestfs-actions.pod:4611
15349 " guestfs_mknod_c (guestfs_h *g,\n"
15353 " const char *path);\n"
15359 #: ../src/guestfs-actions.pod:4618
15361 "This call creates a char device node called C<path> with mode C<mode> and "
15362 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15363 "wrapper around C<guestfs_mknod>."
15368 #: ../src/guestfs-actions.pod:4628
15369 msgid "guestfs_mkswap"
15374 #: ../src/guestfs-actions.pod:4630
15378 " guestfs_mkswap (guestfs_h *g,\n"
15379 " const char *device);\n"
15385 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3138
15386 msgid "Create a swap partition on C<device>."
15391 #: ../src/guestfs-actions.pod:4640
15392 msgid "guestfs_mkswap_L"
15397 #: ../src/guestfs-actions.pod:4642
15401 " guestfs_mkswap_L (guestfs_h *g,\n"
15402 " const char *label,\n"
15403 " const char *device);\n"
15409 #: ../src/guestfs-actions.pod:4647 ../fish/guestfish-actions.pod:3144
15410 msgid "Create a swap partition on C<device> with label C<label>."
15415 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
15417 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15418 "sda>), just to a partition. This appears to be a limitation of the kernel "
15424 #: ../src/guestfs-actions.pod:4657
15425 msgid "guestfs_mkswap_U"
15430 #: ../src/guestfs-actions.pod:4659
15434 " guestfs_mkswap_U (guestfs_h *g,\n"
15435 " const char *uuid,\n"
15436 " const char *device);\n"
15442 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3154
15443 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15448 #: ../src/guestfs-actions.pod:4670
15449 msgid "guestfs_mkswap_file"
15454 #: ../src/guestfs-actions.pod:4672
15458 " guestfs_mkswap_file (guestfs_h *g,\n"
15459 " const char *path);\n"
15465 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3160
15466 msgid "Create a swap file."
15471 #: ../src/guestfs-actions.pod:4678
15473 "This command just writes a swap file signature to an existing file. To "
15474 "create the file itself, use something like C<guestfs_fallocate>."
15479 #: ../src/guestfs-actions.pod:4685
15480 msgid "guestfs_modprobe"
15485 #: ../src/guestfs-actions.pod:4687
15489 " guestfs_modprobe (guestfs_h *g,\n"
15490 " const char *modulename);\n"
15496 #: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3169
15497 msgid "This loads a kernel module in the appliance."
15502 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
15504 "The kernel module must have been whitelisted when libguestfs was built (see "
15505 "C<appliance/kmod.whitelist.in> in the source)."
15510 #: ../src/guestfs-actions.pod:4700
15511 msgid "guestfs_mount"
15516 #: ../src/guestfs-actions.pod:4702
15520 " guestfs_mount (guestfs_h *g,\n"
15521 " const char *device,\n"
15522 " const char *mountpoint);\n"
15528 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3178
15530 "Mount a guest disk at a position in the filesystem. Block devices are named "
15531 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15532 "those block devices contain partitions, they will have the usual names (eg. "
15533 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15538 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3184
15540 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15541 "mounted on C</> before others can be mounted. Other filesystems can only be "
15542 "mounted on directories which already exist."
15547 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3189
15549 "The mounted filesystem is writable, if we have sufficient permissions on the "
15550 "underlying device."
15555 #: ../src/guestfs-actions.pod:4721
15557 "B<Important note:> When you use this call, the filesystem options C<sync> "
15558 "and C<noatime> are set implicitly. This was originally done because we "
15559 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15560 "very large negative performance impact and negligible effect on "
15561 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15562 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15563 "(use an empty string for the first parameter if you don't want any options)."
15568 #: ../src/guestfs-actions.pod:4735
15569 msgid "guestfs_mount_loop"
15574 #: ../src/guestfs-actions.pod:4737
15578 " guestfs_mount_loop (guestfs_h *g,\n"
15579 " const char *file,\n"
15580 " const char *mountpoint);\n"
15586 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3206
15588 "This command lets you mount C<file> (a filesystem image in a file) on a "
15589 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15595 #: ../src/guestfs-actions.pod:4750
15596 msgid "guestfs_mount_options"
15601 #: ../src/guestfs-actions.pod:4752
15605 " guestfs_mount_options (guestfs_h *g,\n"
15606 " const char *options,\n"
15607 " const char *device,\n"
15608 " const char *mountpoint);\n"
15614 #: ../src/guestfs-actions.pod:4758
15616 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15617 "the mount options as for the L<mount(8)> I<-o> flag."
15622 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3218
15624 "If the C<options> parameter is an empty string, then no options are passed "
15625 "(all options default to whatever the filesystem uses)."
15630 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4782
15631 #: ../src/guestfs-actions.pod:4799
15632 msgid "(Added in 1.0.10)"
15637 #: ../src/guestfs-actions.pod:4770
15638 msgid "guestfs_mount_ro"
15643 #: ../src/guestfs-actions.pod:4772
15647 " guestfs_mount_ro (guestfs_h *g,\n"
15648 " const char *device,\n"
15649 " const char *mountpoint);\n"
15655 #: ../src/guestfs-actions.pod:4777
15657 "This is the same as the C<guestfs_mount> command, but it mounts the "
15658 "filesystem with the read-only (I<-o ro>) flag."
15663 #: ../src/guestfs-actions.pod:4784
15664 msgid "guestfs_mount_vfs"
15669 #: ../src/guestfs-actions.pod:4786
15673 " guestfs_mount_vfs (guestfs_h *g,\n"
15674 " const char *options,\n"
15675 " const char *vfstype,\n"
15676 " const char *device,\n"
15677 " const char *mountpoint);\n"
15683 #: ../src/guestfs-actions.pod:4793
15685 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15686 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15692 #: ../src/guestfs-actions.pod:4801
15693 msgid "guestfs_mountpoints"
15698 #: ../src/guestfs-actions.pod:4803
15702 " guestfs_mountpoints (guestfs_h *g);\n"
15708 #: ../src/guestfs-actions.pod:4806
15710 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15711 "devices. This one returns a hash table (map) of device name to directory "
15712 "where the device is mounted."
15717 #: ../src/guestfs-actions.pod:4818
15718 msgid "guestfs_mounts"
15723 #: ../src/guestfs-actions.pod:4820
15727 " guestfs_mounts (guestfs_h *g);\n"
15733 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3249
15735 "This returns the list of currently mounted filesystems. It returns the list "
15736 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15741 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3252
15742 msgid "Some internal mounts are not shown."
15747 #: ../src/guestfs-actions.pod:4828
15748 msgid "See also: C<guestfs_mountpoints>"
15753 #: ../src/guestfs-actions.pod:4836
15759 #: ../src/guestfs-actions.pod:4838
15763 " guestfs_mv (guestfs_h *g,\n"
15764 " const char *src,\n"
15765 " const char *dest);\n"
15771 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3260
15773 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15774 "destination filename or destination directory."
15779 #: ../src/guestfs-actions.pod:4850
15780 msgid "guestfs_ntfs_3g_probe"
15785 #: ../src/guestfs-actions.pod:4852
15789 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15791 " const char *device);\n"
15797 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
15799 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15800 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15801 "write, and some cannot be mounted at all)."
15806 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
15808 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15809 "can be mounted read-write. Set it to false if you want to test if the "
15810 "volume can be mounted read-only."
15815 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
15817 "The return value is an integer which C<0> if the operation would succeed, or "
15818 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15823 #: ../src/guestfs-actions.pod:4871
15824 msgid "(Added in 1.0.43)"
15829 #: ../src/guestfs-actions.pod:4873
15830 msgid "guestfs_ntfsresize"
15835 #: ../src/guestfs-actions.pod:4875
15839 " guestfs_ntfsresize (guestfs_h *g,\n"
15840 " const char *device);\n"
15846 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3283
15848 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15849 "size of the underlying device. See also L<ntfsresize(8)>."
15854 #: ../src/guestfs-actions.pod:4887
15855 msgid "guestfs_ntfsresize_size"
15860 #: ../src/guestfs-actions.pod:4889
15864 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15865 " const char *device,\n"
15866 " int64_t size);\n"
15872 #: ../src/guestfs-actions.pod:4894
15874 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15875 "to specify the new size (in bytes) explicitly."
15880 #: ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:5335
15881 #: ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5674
15882 #: ../src/guestfs-actions.pod:7245
15883 msgid "(Added in 1.3.14)"
15888 #: ../src/guestfs-actions.pod:4901
15889 msgid "guestfs_part_add"
15894 #: ../src/guestfs-actions.pod:4903
15898 " guestfs_part_add (guestfs_h *g,\n"
15899 " const char *device,\n"
15900 " const char *prlogex,\n"
15901 " int64_t startsect,\n"
15902 " int64_t endsect);\n"
15908 #: ../src/guestfs-actions.pod:4910
15910 "This command adds a partition to C<device>. If there is no partition table "
15911 "on the device, call C<guestfs_part_init> first."
15916 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3301
15918 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15919 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15920 "C<logical>) and C<e> (or C<extended>) partition types."
15925 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3306
15927 "C<startsect> and C<endsect> are the start and end of the partition in "
15928 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15929 "from the end of the disk (C<-1> is the last sector)."
15934 #: ../src/guestfs-actions.pod:4922
15936 "Creating a partition which covers the whole disk is not so easy. Use "
15937 "C<guestfs_part_disk> to do that."
15942 #: ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:4965
15943 #: ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5096
15944 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5153
15945 #: ../src/guestfs-actions.pod:5193
15946 msgid "(Added in 1.0.78)"
15951 #: ../src/guestfs-actions.pod:4929
15952 msgid "guestfs_part_del"
15957 #: ../src/guestfs-actions.pod:4931
15961 " guestfs_part_del (guestfs_h *g,\n"
15962 " const char *device,\n"
15969 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3317
15970 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15975 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3319
15977 "Note that in the case of MBR partitioning, deleting an extended partition "
15978 "also deletes any logical partitions it contains."
15983 #: ../src/guestfs-actions.pod:4946
15984 msgid "guestfs_part_disk"
15989 #: ../src/guestfs-actions.pod:4948
15993 " guestfs_part_disk (guestfs_h *g,\n"
15994 " const char *device,\n"
15995 " const char *parttype);\n"
16001 #: ../src/guestfs-actions.pod:4953
16003 "This command is simply a combination of C<guestfs_part_init> followed by "
16004 "C<guestfs_part_add> to create a single primary partition covering the whole "
16010 #: ../src/guestfs-actions.pod:4957
16012 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
16013 "possible values are described in C<guestfs_part_init>."
16018 #: ../src/guestfs-actions.pod:4967
16019 msgid "guestfs_part_get_bootable"
16024 #: ../src/guestfs-actions.pod:4969
16028 " guestfs_part_get_bootable (guestfs_h *g,\n"
16029 " const char *device,\n"
16036 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3341
16038 "This command returns true if the partition C<partnum> on C<device> has the "
16039 "bootable flag set."
16044 #: ../src/guestfs-actions.pod:4977
16045 msgid "See also C<guestfs_part_set_bootable>."
16050 #: ../src/guestfs-actions.pod:4983
16051 msgid "guestfs_part_get_mbr_id"
16056 #: ../src/guestfs-actions.pod:4985
16060 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
16061 " const char *device,\n"
16068 #: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3350
16070 "Returns the MBR type byte (also known as the ID byte) from the numbered "
16071 "partition C<partnum>."
16076 #: ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5169
16078 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
16079 "undefined results for other partition table types (see "
16080 "C<guestfs_part_get_parttype>)."
16085 #: ../src/guestfs-actions.pod:5001
16086 msgid "guestfs_part_get_parttype"
16091 #: ../src/guestfs-actions.pod:5003
16095 " guestfs_part_get_parttype (guestfs_h *g,\n"
16096 " const char *device);\n"
16102 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3361
16104 "This command examines the partition table on C<device> and returns the "
16105 "partition table type (format) being used."
16110 #: ../src/guestfs-actions.pod:5010
16112 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
16113 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
16114 "possible, although unusual. See C<guestfs_part_init> for a full list."
16119 #: ../src/guestfs-actions.pod:5020
16120 msgid "guestfs_part_init"
16125 #: ../src/guestfs-actions.pod:5022
16129 " guestfs_part_init (guestfs_h *g,\n"
16130 " const char *device,\n"
16131 " const char *parttype);\n"
16137 #: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3373
16139 "This creates an empty partition table on C<device> of one of the partition "
16140 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
16141 "(for large disks)."
16146 #: ../src/guestfs-actions.pod:5031
16148 "Initially there are no partitions. Following this, you should call "
16149 "C<guestfs_part_add> for each partition required."
16154 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
16155 msgid "Possible values for C<parttype> are:"
16160 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
16161 msgid "B<efi> | B<gpt>"
16166 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
16167 msgid "Intel EFI / GPT partition table."
16172 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3388
16174 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16175 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16176 "the C<mbr> format."
16181 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3392
16182 msgid "B<mbr> | B<msdos>"
16187 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3394
16189 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16190 "Windows. This partition type will B<only> work for device sizes up to 2 "
16191 "TB. For large disks we recommend using C<gpt>."
16196 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
16198 "Other partition table types that may work but are not supported include:"
16203 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
16209 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
16210 msgid "AIX disk labels."
16215 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
16216 msgid "B<amiga> | B<rdb>"
16221 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
16222 msgid "Amiga \"Rigid Disk Block\" format."
16227 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
16233 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
16234 msgid "BSD disk labels."
16239 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
16245 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
16246 msgid "DASD, used on IBM mainframes."
16251 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
16257 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
16258 msgid "MIPS/SGI volumes."
16263 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
16269 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
16270 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16275 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
16281 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
16282 msgid "NEC PC-98 format, common in Japan apparently."
16287 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
16293 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
16294 msgid "Sun disk labels."
16299 #: ../src/guestfs-actions.pod:5098
16300 msgid "guestfs_part_list"
16305 #: ../src/guestfs-actions.pod:5100
16308 " struct guestfs_partition_list *\n"
16309 " guestfs_part_list (guestfs_h *g,\n"
16310 " const char *device);\n"
16316 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3444
16318 "This command parses the partition table on C<device> and returns the list of "
16319 "partitions found."
16324 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
16325 msgid "The fields in the returned structure are:"
16330 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3451
16331 msgid "B<part_num>"
16336 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3453
16337 msgid "Partition number, counting from 1."
16342 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3455
16343 msgid "B<part_start>"
16348 #: ../src/guestfs-actions.pod:5117
16350 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16351 "the device's sector size, see C<guestfs_blockdev_getss>."
16356 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
16357 msgid "B<part_end>"
16362 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
16363 msgid "End of the partition in bytes."
16368 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
16369 msgid "B<part_size>"
16374 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
16375 msgid "Size of the partition in bytes."
16380 #: ../src/guestfs-actions.pod:5130
16382 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16383 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16389 #: ../src/guestfs-actions.pod:5136
16390 msgid "guestfs_part_set_bootable"
16395 #: ../src/guestfs-actions.pod:5138
16399 " guestfs_part_set_bootable (guestfs_h *g,\n"
16400 " const char *device,\n"
16402 " int bootable);\n"
16408 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3474
16410 "This sets the bootable flag on partition numbered C<partnum> on device "
16411 "C<device>. Note that partitions are numbered from 1."
16416 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3477
16418 "The bootable flag is used by some operating systems (notably Windows) to "
16419 "determine which partition to boot from. It is by no means universally "
16425 #: ../src/guestfs-actions.pod:5155
16426 msgid "guestfs_part_set_mbr_id"
16431 #: ../src/guestfs-actions.pod:5157
16435 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16436 " const char *device,\n"
16444 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3485
16446 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16447 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16448 "documentation are in fact hexadecimal numbers, but usually documented "
16449 "without any leading \"0x\" which might be confusing."
16454 #: ../src/guestfs-actions.pod:5177
16455 msgid "guestfs_part_set_name"
16460 #: ../src/guestfs-actions.pod:5179
16464 " guestfs_part_set_name (guestfs_h *g,\n"
16465 " const char *device,\n"
16467 " const char *name);\n"
16473 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3499
16475 "This sets the partition name on partition numbered C<partnum> on device "
16476 "C<device>. Note that partitions are numbered from 1."
16481 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3502
16483 "The partition name can only be set on certain types of partition table. "
16484 "This works on C<gpt> but not on C<mbr> partitions."
16489 #: ../src/guestfs-actions.pod:5195
16490 msgid "guestfs_part_to_dev"
16495 #: ../src/guestfs-actions.pod:5197
16499 " guestfs_part_to_dev (guestfs_h *g,\n"
16500 " const char *partition);\n"
16506 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3509
16508 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16509 "partition number, returning the device name (eg. \"/dev/sdb\")."
16514 #: ../src/guestfs-actions.pod:5205
16516 "The named partition must exist, for example as a string returned from "
16517 "C<guestfs_list_partitions>."
16522 #: ../src/guestfs-actions.pod:5213
16523 msgid "guestfs_ping_daemon"
16528 #: ../src/guestfs-actions.pod:5215
16532 " guestfs_ping_daemon (guestfs_h *g);\n"
16538 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3520
16540 "This is a test probe into the guestfs daemon running inside the qemu "
16541 "subprocess. Calling this function checks that the daemon responds to the "
16542 "ping message, without affecting the daemon or attached block device(s) in "
16548 #: ../src/guestfs-actions.pod:5227
16549 msgid "guestfs_pread"
16554 #: ../src/guestfs-actions.pod:5229
16558 " guestfs_pread (guestfs_h *g,\n"
16559 " const char *path,\n"
16561 " int64_t offset,\n"
16562 " size_t *size_r);\n"
16568 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3529
16570 "This command lets you read part of a file. It reads C<count> bytes of the "
16571 "file, starting at C<offset>, from file C<path>."
16576 #: ../src/guestfs-actions.pod:5239 ../src/guestfs-actions.pod:5265
16577 #: ../fish/guestfish-actions.pod:3532 ../fish/guestfish-actions.pod:3547
16579 "This may read fewer bytes than requested. For further details see the "
16580 "L<pread(2)> system call."
16585 #: ../src/guestfs-actions.pod:5242
16586 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16591 #: ../src/guestfs-actions.pod:5253
16592 msgid "guestfs_pread_device"
16597 #: ../src/guestfs-actions.pod:5255
16601 " guestfs_pread_device (guestfs_h *g,\n"
16602 " const char *device,\n"
16604 " int64_t offset,\n"
16605 " size_t *size_r);\n"
16611 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3544
16613 "This command lets you read part of a file. It reads C<count> bytes of "
16614 "C<device>, starting at C<offset>."
16619 #: ../src/guestfs-actions.pod:5268
16620 msgid "See also C<guestfs_pread>."
16625 #: ../src/guestfs-actions.pod:5277
16626 msgid "(Added in 1.5.21)"
16631 #: ../src/guestfs-actions.pod:5279
16632 msgid "guestfs_pvcreate"
16637 #: ../src/guestfs-actions.pod:5281
16641 " guestfs_pvcreate (guestfs_h *g,\n"
16642 " const char *device);\n"
16648 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3559
16650 "This creates an LVM physical volume on the named C<device>, where C<device> "
16651 "should usually be a partition name such as C</dev/sda1>."
16656 #: ../src/guestfs-actions.pod:5293
16657 msgid "guestfs_pvremove"
16662 #: ../src/guestfs-actions.pod:5295
16666 " guestfs_pvremove (guestfs_h *g,\n"
16667 " const char *device);\n"
16673 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3567
16675 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16681 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3570
16683 "The implementation uses the C<pvremove> command which refuses to wipe "
16684 "physical volumes that contain any volume groups, so you have to remove those "
16690 #: ../src/guestfs-actions.pod:5310
16691 msgid "guestfs_pvresize"
16696 #: ../src/guestfs-actions.pod:5312
16700 " guestfs_pvresize (guestfs_h *g,\n"
16701 " const char *device);\n"
16707 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3578
16709 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16710 "the new size of the underlying device."
16715 #: ../src/guestfs-actions.pod:5323
16716 msgid "guestfs_pvresize_size"
16721 #: ../src/guestfs-actions.pod:5325
16725 " guestfs_pvresize_size (guestfs_h *g,\n"
16726 " const char *device,\n"
16727 " int64_t size);\n"
16733 #: ../src/guestfs-actions.pod:5330
16735 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16736 "specify the new size (in bytes) explicitly."
16741 #: ../src/guestfs-actions.pod:5337
16742 msgid "guestfs_pvs"
16747 #: ../src/guestfs-actions.pod:5339
16751 " guestfs_pvs (guestfs_h *g);\n"
16757 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3592
16759 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16765 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3595
16767 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16773 #: ../src/guestfs-actions.pod:5348
16774 msgid "See also C<guestfs_pvs_full>."
16779 #: ../src/guestfs-actions.pod:5356
16780 msgid "guestfs_pvs_full"
16785 #: ../src/guestfs-actions.pod:5358
16788 " struct guestfs_lvm_pv_list *\n"
16789 " guestfs_pvs_full (guestfs_h *g);\n"
16795 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3604
16797 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16798 "(8)> command. The \"full\" version includes all fields."
16803 #: ../src/guestfs-actions.pod:5364
16805 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16806 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16811 #: ../src/guestfs-actions.pod:5370
16812 msgid "guestfs_pvuuid"
16817 #: ../src/guestfs-actions.pod:5372
16821 " guestfs_pvuuid (guestfs_h *g,\n"
16822 " const char *device);\n"
16828 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3611
16829 msgid "This command returns the UUID of the LVM PV C<device>."
16834 #: ../src/guestfs-actions.pod:5383
16835 msgid "guestfs_pwrite"
16840 #: ../src/guestfs-actions.pod:5385
16844 " guestfs_pwrite (guestfs_h *g,\n"
16845 " const char *path,\n"
16846 " const char *content,\n"
16847 " size_t content_size,\n"
16848 " int64_t offset);\n"
16854 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3617
16856 "This command writes to part of a file. It writes the data buffer C<content> "
16857 "to the file C<path> starting at offset C<offset>."
16862 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3620
16864 "This command implements the L<pwrite(2)> system call, and like that system "
16865 "call it may not write the full data requested. The return value is the "
16866 "number of bytes that were actually written to the file. This could even be "
16867 "0, although short writes are unlikely for regular files in ordinary "
16873 #: ../src/guestfs-actions.pod:5401
16874 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16879 #: ../src/guestfs-actions.pod:5410
16880 msgid "guestfs_pwrite_device"
16885 #: ../src/guestfs-actions.pod:5412
16889 " guestfs_pwrite_device (guestfs_h *g,\n"
16890 " const char *device,\n"
16891 " const char *content,\n"
16892 " size_t content_size,\n"
16893 " int64_t offset);\n"
16899 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3635
16901 "This command writes to part of a device. It writes the data buffer "
16902 "C<content> to C<device> starting at offset C<offset>."
16907 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
16909 "This command implements the L<pwrite(2)> system call, and like that system "
16910 "call it may not write the full data requested (although short writes to disk "
16911 "devices and partitions are probably impossible with standard Linux kernels)."
16916 #: ../src/guestfs-actions.pod:5427
16917 msgid "See also C<guestfs_pwrite>."
16922 #: ../src/guestfs-actions.pod:5434
16923 msgid "(Added in 1.5.20)"
16928 #: ../src/guestfs-actions.pod:5436
16929 msgid "guestfs_read_file"
16934 #: ../src/guestfs-actions.pod:5438
16938 " guestfs_read_file (guestfs_h *g,\n"
16939 " const char *path,\n"
16940 " size_t *size_r);\n"
16946 #: ../src/guestfs-actions.pod:5443 ../fish/guestfish-actions.pod:3652
16947 msgid "This calls returns the contents of the file C<path> as a buffer."
16952 #: ../src/guestfs-actions.pod:5446
16954 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16955 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16956 "function is limited in the total size of file that can be handled."
16961 #: ../src/guestfs-actions.pod:5458
16962 msgid "(Added in 1.0.63)"
16967 #: ../src/guestfs-actions.pod:5460
16968 msgid "guestfs_read_lines"
16973 #: ../src/guestfs-actions.pod:5462
16977 " guestfs_read_lines (guestfs_h *g,\n"
16978 " const char *path);\n"
16984 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3669
16986 "The file contents are returned as a list of lines. Trailing C<LF> and "
16987 "C<CRLF> character sequences are I<not> returned."
16992 #: ../src/guestfs-actions.pod:5471
16994 "Note that this function cannot correctly handle binary files (specifically, "
16995 "files containing C<\\0> character which is treated as end of line). For "
16996 "those you need to use the C<guestfs_read_file> function which has a more "
16997 "complex interface."
17002 #: ../src/guestfs-actions.pod:5482
17003 msgid "guestfs_readdir"
17008 #: ../src/guestfs-actions.pod:5484
17011 " struct guestfs_dirent_list *\n"
17012 " guestfs_readdir (guestfs_h *g,\n"
17013 " const char *dir);\n"
17019 #: ../src/guestfs-actions.pod:5488 ../fish/guestfish-actions.pod:3681
17020 msgid "This returns the list of directory entries in directory C<dir>."
17025 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:3683
17027 "All entries in the directory are returned, including C<.> and C<..>. The "
17028 "entries are I<not> sorted, but returned in the same order as the underlying "
17034 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3687
17036 "Also this call returns basic file type information about each file. The "
17037 "C<ftyp> field will contain one of the following characters:"
17042 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
17048 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
17049 msgid "Block special"
17054 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
17060 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
17061 msgid "Char special"
17066 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
17072 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
17078 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
17084 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
17085 msgid "FIFO (named pipe)"
17090 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
17096 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
17097 msgid "Symbolic link"
17102 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
17108 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
17109 msgid "Regular file"
17114 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
17120 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
17126 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
17132 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
17133 msgid "Unknown file type"
17138 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
17144 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
17146 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
17151 #: ../src/guestfs-actions.pod:5538
17153 "This function is primarily intended for use by programs. To get a simple "
17154 "list of names, use C<guestfs_ls>. To get a printable directory for human "
17155 "consumption, use C<guestfs_ll>."
17160 #: ../src/guestfs-actions.pod:5542
17162 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17163 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17168 #: ../src/guestfs-actions.pod:5548
17169 msgid "guestfs_readlink"
17174 #: ../src/guestfs-actions.pod:5550
17178 " guestfs_readlink (guestfs_h *g,\n"
17179 " const char *path);\n"
17185 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3739
17186 msgid "This command reads the target of a symbolic link."
17191 #: ../src/guestfs-actions.pod:5561
17192 msgid "guestfs_readlinklist"
17197 #: ../src/guestfs-actions.pod:5563
17201 " guestfs_readlinklist (guestfs_h *g,\n"
17202 " const char *path,\n"
17203 " char *const *names);\n"
17209 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
17211 "This call allows you to do a C<readlink> operation on multiple files, where "
17212 "all files are in the directory C<path>. C<names> is the list of files from "
17218 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3749
17220 "On return you get a list of strings, with a one-to-one correspondence to the "
17221 "C<names> list. Each string is the value of the symbolic link."
17226 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3753
17228 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17229 "result string is the empty string C<\"\">. However the whole operation is "
17230 "completed even if there were C<readlink(2)> errors, and so you can call this "
17231 "function with names where you don't know if they are symbolic links already "
17232 "(albeit slightly less efficient)."
17237 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3760
17239 "This call is intended for programs that want to efficiently list a directory "
17240 "contents without making many round-trips. Very long directory listings "
17241 "might cause the protocol message size to be exceeded, causing this call to "
17242 "fail. The caller must split up such requests into smaller groups of names."
17247 #: ../src/guestfs-actions.pod:5596
17248 msgid "guestfs_realpath"
17253 #: ../src/guestfs-actions.pod:5598
17257 " guestfs_realpath (guestfs_h *g,\n"
17258 " const char *path);\n"
17264 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3771
17266 "Return the canonicalized absolute pathname of C<path>. The returned path "
17267 "has no C<.>, C<..> or symbolic link path elements."
17272 #: ../src/guestfs-actions.pod:5610
17273 msgid "guestfs_removexattr"
17278 #: ../src/guestfs-actions.pod:5612
17282 " guestfs_removexattr (guestfs_h *g,\n"
17283 " const char *xattr,\n"
17284 " const char *path);\n"
17290 #: ../src/guestfs-actions.pod:5617 ../fish/guestfish-actions.pod:3778
17292 "This call removes the extended attribute named C<xattr> of the file C<path>."
17297 #: ../src/guestfs-actions.pod:5620
17298 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17303 #: ../src/guestfs-actions.pod:5626
17304 msgid "guestfs_resize2fs"
17309 #: ../src/guestfs-actions.pod:5628
17313 " guestfs_resize2fs (guestfs_h *g,\n"
17314 " const char *device);\n"
17320 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3787
17322 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17323 "underlying device."
17328 #: ../src/guestfs-actions.pod:5635
17330 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17331 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17332 "sometimes gives an error about this and sometimes not. In any case, it is "
17333 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17337 #: ../src/guestfs-actions.pod:5645
17338 msgid "guestfs_resize2fs_M"
17342 #: ../src/guestfs-actions.pod:5647
17346 " guestfs_resize2fs_M (guestfs_h *g,\n"
17347 " const char *device);\n"
17352 #: ../src/guestfs-actions.pod:5651
17354 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17355 "resized to its minimum size. This works like the I<-M> option to the "
17356 "C<resize2fs> command."
17360 #: ../src/guestfs-actions.pod:5655
17362 "To get the resulting size of the filesystem you should call "
17363 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17364 "These two numbers, multiplied together, give the resulting size of the "
17365 "minimal filesystem in bytes."
17370 #: ../src/guestfs-actions.pod:5662
17371 msgid "guestfs_resize2fs_size"
17376 #: ../src/guestfs-actions.pod:5664
17380 " guestfs_resize2fs_size (guestfs_h *g,\n"
17381 " const char *device,\n"
17382 " int64_t size);\n"
17388 #: ../src/guestfs-actions.pod:5669
17390 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17391 "to specify the new size (in bytes) explicitly."
17396 #: ../src/guestfs-actions.pod:5676
17402 #: ../src/guestfs-actions.pod:5678
17406 " guestfs_rm (guestfs_h *g,\n"
17407 " const char *path);\n"
17413 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3820
17414 msgid "Remove the single file C<path>."
17419 #: ../src/guestfs-actions.pod:5688
17420 msgid "guestfs_rm_rf"
17425 #: ../src/guestfs-actions.pod:5690
17429 " guestfs_rm_rf (guestfs_h *g,\n"
17430 " const char *path);\n"
17436 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3826
17438 "Remove the file or directory C<path>, recursively removing the contents if "
17439 "its a directory. This is like the C<rm -rf> shell command."
17444 #: ../src/guestfs-actions.pod:5702
17445 msgid "guestfs_rmdir"
17450 #: ../src/guestfs-actions.pod:5704
17454 " guestfs_rmdir (guestfs_h *g,\n"
17455 " const char *path);\n"
17461 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3834
17462 msgid "Remove the single directory C<path>."
17467 #: ../src/guestfs-actions.pod:5714
17468 msgid "guestfs_rmmountpoint"
17473 #: ../src/guestfs-actions.pod:5716
17477 " guestfs_rmmountpoint (guestfs_h *g,\n"
17478 " const char *exemptpath);\n"
17484 #: ../src/guestfs-actions.pod:5720
17486 "This calls removes a mountpoint that was previously created with "
17487 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17492 #: ../src/guestfs-actions.pod:5728
17493 msgid "guestfs_scrub_device"
17498 #: ../src/guestfs-actions.pod:5730
17502 " guestfs_scrub_device (guestfs_h *g,\n"
17503 " const char *device);\n"
17509 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3848
17511 "This command writes patterns over C<device> to make data retrieval more "
17517 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5758
17518 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3851
17519 #: ../fish/guestfish-actions.pod:3866 ../fish/guestfish-actions.pod:3879
17521 "It is an interface to the L<scrub(1)> program. See that manual page for "
17527 #: ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:5763
17528 #: ../src/guestfs-actions.pod:5782
17529 msgid "(Added in 1.0.52)"
17534 #: ../src/guestfs-actions.pod:5747
17535 msgid "guestfs_scrub_file"
17540 #: ../src/guestfs-actions.pod:5749
17544 " guestfs_scrub_file (guestfs_h *g,\n"
17545 " const char *file);\n"
17551 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3861
17553 "This command writes patterns over a file to make data retrieval more "
17559 #: ../src/guestfs-actions.pod:5756 ../fish/guestfish-actions.pod:3864
17560 msgid "The file is I<removed> after scrubbing."
17565 #: ../src/guestfs-actions.pod:5765
17566 msgid "guestfs_scrub_freespace"
17571 #: ../src/guestfs-actions.pod:5767
17575 " guestfs_scrub_freespace (guestfs_h *g,\n"
17576 " const char *dir);\n"
17582 #: ../src/guestfs-actions.pod:5771
17584 "This command creates the directory C<dir> and then fills it with files until "
17585 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17586 "and deletes them. The intention is to scrub any free space on the partition "
17587 "containing C<dir>."
17592 #: ../src/guestfs-actions.pod:5784
17593 msgid "guestfs_set_append"
17598 #: ../src/guestfs-actions.pod:5786
17602 " guestfs_set_append (guestfs_h *g,\n"
17603 " const char *append);\n"
17609 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3888
17611 "This function is used to add additional options to the guest kernel command "
17617 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3891
17619 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17620 "environment variable."
17625 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3894
17627 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17628 "(libguestfs always adds a few of its own)."
17632 #: ../src/guestfs-actions.pod:5803
17633 msgid "guestfs_set_attach_method"
17637 #: ../src/guestfs-actions.pod:5805
17641 " guestfs_set_attach_method (guestfs_h *g,\n"
17642 " const char *attachmethod);\n"
17647 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3903
17649 "Set the method that libguestfs uses to connect to the back end guestfsd "
17650 "daemon. Possible methods are:"
17654 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3910
17656 "Launch an appliance and connect to it. This is the ordinary method and the "
17661 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3913
17662 msgid "C<unix:I<path>>"
17666 #: ../src/guestfs-actions.pod:5821 ../fish/guestfish-actions.pod:3915
17667 msgid "Connect to the Unix domain socket I<path>."
17671 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3917
17673 "This method lets you connect to an existing daemon or (using virtio-serial) "
17674 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17675 "RUNNING DAEMONS>."
17680 #: ../src/guestfs-actions.pod:5831
17681 msgid "guestfs_set_autosync"
17686 #: ../src/guestfs-actions.pod:5833
17690 " guestfs_set_autosync (guestfs_h *g,\n"
17691 " int autosync);\n"
17696 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3929
17698 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17699 "effort attempt to make filesystems consistent and synchronized when the "
17700 "handle is closed (also if the program exits without closing handles)."
17705 #: ../src/guestfs-actions.pod:5842 ../fish/guestfish-actions.pod:3934
17707 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17708 "disabled by default)."
17713 #: ../src/guestfs-actions.pod:5849
17714 msgid "guestfs_set_direct"
17719 #: ../src/guestfs-actions.pod:5851
17723 " guestfs_set_direct (guestfs_h *g,\n"
17730 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
17732 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17733 "passed directly through to the appliance once it is launched."
17738 #: ../src/guestfs-actions.pod:5859
17740 "One consequence of this is that log messages aren't caught by the library "
17741 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17747 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3951
17748 msgid "You probably don't want to use this unless you know what you are doing."
17753 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3954
17754 msgid "The default is disabled."
17759 #: ../src/guestfs-actions.pod:5872
17760 msgid "guestfs_set_e2label"
17765 #: ../src/guestfs-actions.pod:5874
17769 " guestfs_set_e2label (guestfs_h *g,\n"
17770 " const char *device,\n"
17771 " const char *label);\n"
17777 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3960
17779 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17780 "C<label>. Filesystem labels are limited to 16 characters."
17785 #: ../src/guestfs-actions.pod:5883
17787 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17788 "the existing label on a filesystem."
17793 #: ../src/guestfs-actions.pod:5890
17794 msgid "guestfs_set_e2uuid"
17799 #: ../src/guestfs-actions.pod:5892
17803 " guestfs_set_e2uuid (guestfs_h *g,\n"
17804 " const char *device,\n"
17805 " const char *uuid);\n"
17811 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3971
17813 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17814 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17815 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17820 #: ../src/guestfs-actions.pod:5902
17822 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17823 "the existing UUID of a filesystem."
17828 #: ../src/guestfs-actions.pod:5909
17829 msgid "guestfs_set_memsize"
17834 #: ../src/guestfs-actions.pod:5911
17838 " guestfs_set_memsize (guestfs_h *g,\n"
17845 #: ../src/guestfs-actions.pod:5915
17847 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17848 "This only has any effect if called before C<guestfs_launch>."
17853 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3989
17855 "You can also change this by setting the environment variable "
17856 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17861 #: ../src/guestfs-actions.pod:5930
17862 msgid "guestfs_set_network"
17867 #: ../src/guestfs-actions.pod:5932
17871 " guestfs_set_network (guestfs_h *g,\n"
17878 #: ../src/guestfs-actions.pod:5936 ../fish/guestfish-actions.pod:4002
17880 "If C<network> is true, then the network is enabled in the libguestfs "
17881 "appliance. The default is false."
17886 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:4005
17888 "This affects whether commands are able to access the network (see L<guestfs"
17889 "(3)/RUNNING COMMANDS>)."
17894 #: ../src/guestfs-actions.pod:5942
17896 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17902 #: ../src/guestfs-actions.pod:5949
17903 msgid "guestfs_set_path"
17908 #: ../src/guestfs-actions.pod:5951
17912 " guestfs_set_path (guestfs_h *g,\n"
17913 " const char *searchpath);\n"
17919 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4017
17920 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17925 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4019
17927 "The default is C<$libdir/guestfs> unless overridden by setting "
17928 "C<LIBGUESTFS_PATH> environment variable."
17933 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4022
17934 msgid "Setting C<path> to C<NULL> restores the default path."
17939 #: ../src/guestfs-actions.pod:5966
17940 msgid "guestfs_set_qemu"
17945 #: ../src/guestfs-actions.pod:5968
17949 " guestfs_set_qemu (guestfs_h *g,\n"
17950 " const char *qemu);\n"
17956 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
17957 msgid "Set the qemu binary that we will use."
17962 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
17964 "The default is chosen when the library was compiled by the configure script."
17969 #: ../src/guestfs-actions.pod:5977 ../fish/guestfish-actions.pod:4035
17971 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17977 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4038
17978 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17983 #: ../src/guestfs-actions.pod:5982 ../fish/guestfish-actions.pod:4040
17985 "Note that you should call this function as early as possible after creating "
17986 "the handle. This is because some pre-launch operations depend on testing "
17987 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17988 "don't retest features, and so you might see inconsistent results. Using the "
17989 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17990 "the qemu binary at the same time as the handle is created."
17995 #: ../src/guestfs-actions.pod:5994
17996 msgid "guestfs_set_recovery_proc"
18001 #: ../src/guestfs-actions.pod:5996
18005 " guestfs_set_recovery_proc (guestfs_h *g,\n"
18006 " int recoveryproc);\n"
18012 #: ../src/guestfs-actions.pod:6000
18014 "If this is called with the parameter C<false> then C<guestfs_launch> does "
18015 "not create a recovery process. The purpose of the recovery process is to "
18016 "stop runaway qemu processes in the case where the main program aborts "
18022 #: ../src/guestfs-actions.pod:6005
18024 "This only has any effect if called before C<guestfs_launch>, and the default "
18030 #: ../src/guestfs-actions.pod:6008 ../fish/guestfish-actions.pod:4062
18032 "About the only time when you would want to disable this is if the main "
18033 "process will fork itself into the background (\"daemonize\" itself). In "
18034 "this case the recovery process thinks that the main program has disappeared "
18035 "and so kills qemu, which is not very helpful."
18040 #: ../src/guestfs-actions.pod:6018
18041 msgid "guestfs_set_selinux"
18046 #: ../src/guestfs-actions.pod:6020
18050 " guestfs_set_selinux (guestfs_h *g,\n"
18057 #: ../src/guestfs-actions.pod:6024 ../fish/guestfish-actions.pod:4074
18059 "This sets the selinux flag that is passed to the appliance at boot time. "
18060 "The default is C<selinux=0> (disabled)."
18065 #: ../src/guestfs-actions.pod:6027 ../fish/guestfish-actions.pod:4077
18067 "Note that if SELinux is enabled, it is always in Permissive mode "
18068 "(C<enforcing=0>)."
18073 #: ../src/guestfs-actions.pod:6037
18074 msgid "guestfs_set_trace"
18079 #: ../src/guestfs-actions.pod:6039
18083 " guestfs_set_trace (guestfs_h *g,\n"
18089 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:4089
18091 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
18092 "return values are traced."
18097 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4092
18099 "If you want to trace C API calls into libguestfs (and other libraries) then "
18100 "possibly a better way is to use the external ltrace(1) command."
18105 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4096
18107 "Command traces are disabled unless the environment variable "
18108 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
18112 #: ../src/guestfs-actions.pod:6053
18114 "Trace messages are normally sent to C<stderr>, unless you register a "
18115 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18120 #: ../src/guestfs-actions.pod:6061
18121 msgid "guestfs_set_verbose"
18126 #: ../src/guestfs-actions.pod:6063
18130 " guestfs_set_verbose (guestfs_h *g,\n"
18136 #: ../src/guestfs-actions.pod:6067 ../fish/guestfish-actions.pod:4109
18137 msgid "If C<verbose> is true, this turns on verbose messages."
18142 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:4111
18144 "Verbose messages are disabled unless the environment variable "
18145 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
18149 #: ../src/guestfs-actions.pod:6072
18151 "Verbose messages are normally sent to C<stderr>, unless you register a "
18152 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
18157 #: ../src/guestfs-actions.pod:6080
18158 msgid "guestfs_setcon"
18163 #: ../src/guestfs-actions.pod:6082
18167 " guestfs_setcon (guestfs_h *g,\n"
18168 " const char *context);\n"
18174 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4122
18176 "This sets the SELinux security context of the daemon to the string "
18182 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4125
18183 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18188 #: ../src/guestfs-actions.pod:6095
18189 msgid "guestfs_setxattr"
18194 #: ../src/guestfs-actions.pod:6097
18198 " guestfs_setxattr (guestfs_h *g,\n"
18199 " const char *xattr,\n"
18200 " const char *val,\n"
18202 " const char *path);\n"
18208 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4131
18210 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18211 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18216 #: ../src/guestfs-actions.pod:6108
18217 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18222 #: ../src/guestfs-actions.pod:6114
18223 msgid "guestfs_sfdisk"
18228 #: ../src/guestfs-actions.pod:6116
18232 " guestfs_sfdisk (guestfs_h *g,\n"
18233 " const char *device,\n"
18237 " char *const *lines);\n"
18243 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4141
18245 "This is a direct interface to the L<sfdisk(8)> program for creating "
18246 "partitions on block devices."
18251 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4144
18252 msgid "C<device> should be a block device, for example C</dev/sda>."
18257 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
18259 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18260 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18261 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18262 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18263 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18264 "the kernel) cannot work out the right geometry and you will need to tell it."
18269 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
18271 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18272 "refer to the L<sfdisk(8)> manpage."
18277 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
18279 "To create a single partition occupying the whole disk, you would pass "
18280 "C<lines> as a single element list, when the single element being the string "
18286 #: ../src/guestfs-actions.pod:6144
18288 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18293 #: ../src/guestfs-actions.pod:6154
18294 msgid "guestfs_sfdiskM"
18299 #: ../src/guestfs-actions.pod:6156
18303 " guestfs_sfdiskM (guestfs_h *g,\n"
18304 " const char *device,\n"
18305 " char *const *lines);\n"
18311 #: ../src/guestfs-actions.pod:6161
18313 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18314 "partition sizes are specified in megabytes only (rounded to the nearest "
18315 "cylinder) and you don't need to specify the cyls, heads and sectors "
18316 "parameters which were rarely if ever used anyway."
18321 #: ../src/guestfs-actions.pod:6167
18323 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18324 "C<guestfs_part_disk>"
18329 #: ../src/guestfs-actions.pod:6177
18330 msgid "guestfs_sfdisk_N"
18335 #: ../src/guestfs-actions.pod:6179
18339 " guestfs_sfdisk_N (guestfs_h *g,\n"
18340 " const char *device,\n"
18345 " const char *line);\n"
18351 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4187
18353 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18354 "(note: C<n> counts from 1)."
18359 #: ../src/guestfs-actions.pod:6191
18361 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18362 "for the cyls/heads/sectors parameters."
18367 #: ../src/guestfs-actions.pod:6194
18368 msgid "See also: C<guestfs_part_add>"
18373 #: ../src/guestfs-actions.pod:6203
18374 msgid "guestfs_sfdisk_disk_geometry"
18379 #: ../src/guestfs-actions.pod:6205
18383 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18384 " const char *device);\n"
18390 #: ../src/guestfs-actions.pod:6209
18392 "This displays the disk geometry of C<device> read from the partition table. "
18393 "Especially in the case where the underlying block device has been resized, "
18394 "this can be different from the kernel's idea of the geometry (see "
18395 "C<guestfs_sfdisk_kernel_geometry>)."
18400 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6230
18401 #: ../fish/guestfish-actions.pod:4207 ../fish/guestfish-actions.pod:4216
18402 msgid "The result is in human-readable format, and not designed to be parsed."
18407 #: ../src/guestfs-actions.pod:6222
18408 msgid "guestfs_sfdisk_kernel_geometry"
18413 #: ../src/guestfs-actions.pod:6224
18417 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18418 " const char *device);\n"
18424 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4214
18425 msgid "This displays the kernel's idea of the geometry of C<device>."
18430 #: ../src/guestfs-actions.pod:6238
18431 msgid "guestfs_sfdisk_l"
18436 #: ../src/guestfs-actions.pod:6240
18440 " guestfs_sfdisk_l (guestfs_h *g,\n"
18441 " const char *device);\n"
18447 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4223
18449 "This displays the partition table on C<device>, in the human-readable output "
18450 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18455 #: ../src/guestfs-actions.pod:6248
18456 msgid "See also: C<guestfs_part_list>"
18461 #: ../src/guestfs-actions.pod:6255
18467 #: ../src/guestfs-actions.pod:6257
18471 " guestfs_sh (guestfs_h *g,\n"
18472 " const char *command);\n"
18478 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4233
18480 "This call runs a command from the guest filesystem via the guest's C</bin/"
18486 #: ../src/guestfs-actions.pod:6264
18487 msgid "This is like C<guestfs_command>, but passes the command to:"
18492 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4238
18495 " /bin/sh -c \"command\"\n"
18501 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4240
18503 "Depending on the guest's shell, this usually results in wildcards being "
18504 "expanded, shell expressions being interpolated and so on."
18509 #: ../src/guestfs-actions.pod:6272
18510 msgid "All the provisos about C<guestfs_command> apply to this call."
18515 #: ../src/guestfs-actions.pod:6279
18516 msgid "guestfs_sh_lines"
18521 #: ../src/guestfs-actions.pod:6281
18525 " guestfs_sh_lines (guestfs_h *g,\n"
18526 " const char *command);\n"
18532 #: ../src/guestfs-actions.pod:6285
18534 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18540 #: ../src/guestfs-actions.pod:6288
18541 msgid "See also: C<guestfs_command_lines>"
18546 #: ../src/guestfs-actions.pod:6296
18547 msgid "guestfs_sleep"
18552 #: ../src/guestfs-actions.pod:6298
18556 " guestfs_sleep (guestfs_h *g,\n"
18563 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4259
18564 msgid "Sleep for C<secs> seconds."
18569 #: ../src/guestfs-actions.pod:6306
18570 msgid "(Added in 1.0.41)"
18575 #: ../src/guestfs-actions.pod:6308 ../src/guestfs-structs.pod:109
18576 msgid "guestfs_stat"
18581 #: ../src/guestfs-actions.pod:6310
18584 " struct guestfs_stat *\n"
18585 " guestfs_stat (guestfs_h *g,\n"
18586 " const char *path);\n"
18592 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4267
18593 msgid "This is the same as the C<stat(2)> system call."
18598 #: ../src/guestfs-actions.pod:6324 ../src/guestfs-structs.pod:135
18599 msgid "guestfs_statvfs"
18604 #: ../src/guestfs-actions.pod:6326
18607 " struct guestfs_statvfs *\n"
18608 " guestfs_statvfs (guestfs_h *g,\n"
18609 " const char *path);\n"
18615 #: ../src/guestfs-actions.pod:6330 ../fish/guestfish-actions.pod:4273
18617 "Returns file system statistics for any mounted file system. C<path> should "
18618 "be a file or directory in the mounted file system (typically it is the mount "
18619 "point itself, but it doesn't need to be)."
18624 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4277
18625 msgid "This is the same as the C<statvfs(2)> system call."
18630 #: ../src/guestfs-actions.pod:6336
18632 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18633 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18638 #: ../src/guestfs-actions.pod:6342
18639 msgid "guestfs_strings"
18644 #: ../src/guestfs-actions.pod:6344
18648 " guestfs_strings (guestfs_h *g,\n"
18649 " const char *path);\n"
18655 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4283
18657 "This runs the L<strings(1)> command on a file and returns the list of "
18658 "printable strings found."
18663 #: ../src/guestfs-actions.pod:6360
18664 msgid "guestfs_strings_e"
18669 #: ../src/guestfs-actions.pod:6362
18673 " guestfs_strings_e (guestfs_h *g,\n"
18674 " const char *encoding,\n"
18675 " const char *path);\n"
18681 #: ../src/guestfs-actions.pod:6367
18683 "This is like the C<guestfs_strings> command, but allows you to specify the "
18684 "encoding of strings that are looked for in the source file C<path>."
18689 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4297
18690 msgid "Allowed encodings are:"
18695 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4301
18701 #: ../src/guestfs-actions.pod:6377
18703 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18704 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18709 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4306
18715 #: ../src/guestfs-actions.pod:6382 ../fish/guestfish-actions.pod:4308
18716 msgid "Single 8-bit-byte characters."
18721 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4310
18727 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
18728 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18733 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4315
18734 msgid "l (lower case letter L)"
18739 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4317
18741 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18742 "examining binaries in Windows guests."
18747 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4320
18753 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
18754 msgid "32-bit big endian such as UCS-4BE."
18759 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4324
18765 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4326
18766 msgid "32-bit little endian such as UCS-4LE."
18771 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4330
18772 msgid "The returned strings are transcoded to UTF-8."
18777 #: ../src/guestfs-actions.pod:6415
18778 msgid "guestfs_swapoff_device"
18783 #: ../src/guestfs-actions.pod:6417
18787 " guestfs_swapoff_device (guestfs_h *g,\n"
18788 " const char *device);\n"
18794 #: ../src/guestfs-actions.pod:6421
18796 "This command disables the libguestfs appliance swap device or partition "
18797 "named C<device>. See C<guestfs_swapon_device>."
18802 #: ../src/guestfs-actions.pod:6429
18803 msgid "guestfs_swapoff_file"
18808 #: ../src/guestfs-actions.pod:6431
18812 " guestfs_swapoff_file (guestfs_h *g,\n"
18813 " const char *file);\n"
18819 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4347
18820 msgid "This command disables the libguestfs appliance swap on file."
18825 #: ../src/guestfs-actions.pod:6441
18826 msgid "guestfs_swapoff_label"
18831 #: ../src/guestfs-actions.pod:6443
18835 " guestfs_swapoff_label (guestfs_h *g,\n"
18836 " const char *label);\n"
18842 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4353
18844 "This command disables the libguestfs appliance swap on labeled swap "
18850 #: ../src/guestfs-actions.pod:6454
18851 msgid "guestfs_swapoff_uuid"
18856 #: ../src/guestfs-actions.pod:6456
18860 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18861 " const char *uuid);\n"
18867 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4360
18869 "This command disables the libguestfs appliance swap partition with the given "
18875 #: ../src/guestfs-actions.pod:6467
18876 msgid "guestfs_swapon_device"
18881 #: ../src/guestfs-actions.pod:6469
18885 " guestfs_swapon_device (guestfs_h *g,\n"
18886 " const char *device);\n"
18892 #: ../src/guestfs-actions.pod:6473
18894 "This command enables the libguestfs appliance to use the swap device or "
18895 "partition named C<device>. The increased memory is made available for all "
18896 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18901 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4372
18903 "Note that you should not swap to existing guest swap partitions unless you "
18904 "know what you are doing. They may contain hibernation information, or other "
18905 "information that the guest doesn't want you to trash. You also risk leaking "
18906 "information about the host to the guest this way. Instead, attach a new "
18907 "host device to the guest and swap on that."
18912 #: ../src/guestfs-actions.pod:6489
18913 msgid "guestfs_swapon_file"
18918 #: ../src/guestfs-actions.pod:6491
18922 " guestfs_swapon_file (guestfs_h *g,\n"
18923 " const char *file);\n"
18929 #: ../src/guestfs-actions.pod:6495
18931 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18937 #: ../src/guestfs-actions.pod:6502
18938 msgid "guestfs_swapon_label"
18943 #: ../src/guestfs-actions.pod:6504
18947 " guestfs_swapon_label (guestfs_h *g,\n"
18948 " const char *label);\n"
18954 #: ../src/guestfs-actions.pod:6508
18956 "This command enables swap to a labeled swap partition. See "
18957 "C<guestfs_swapon_device> for other notes."
18962 #: ../src/guestfs-actions.pod:6515
18963 msgid "guestfs_swapon_uuid"
18968 #: ../src/guestfs-actions.pod:6517
18972 " guestfs_swapon_uuid (guestfs_h *g,\n"
18973 " const char *uuid);\n"
18979 #: ../src/guestfs-actions.pod:6521
18981 "This command enables swap to a swap partition with the given UUID. See "
18982 "C<guestfs_swapon_device> for other notes."
18987 #: ../src/guestfs-actions.pod:6528
18988 msgid "guestfs_sync"
18993 #: ../src/guestfs-actions.pod:6530
18997 " guestfs_sync (guestfs_h *g);\n"
19003 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4404
19005 "This syncs the disk, so that any writes are flushed through to the "
19006 "underlying disk image."
19011 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4407
19013 "You should always call this if you have modified a disk image, before "
19014 "closing the handle."
19019 #: ../src/guestfs-actions.pod:6543
19020 msgid "guestfs_tail"
19025 #: ../src/guestfs-actions.pod:6545
19029 " guestfs_tail (guestfs_h *g,\n"
19030 " const char *path);\n"
19036 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4414
19038 "This command returns up to the last 10 lines of a file as a list of strings."
19043 #: ../src/guestfs-actions.pod:6561
19044 msgid "guestfs_tail_n"
19049 #: ../src/guestfs-actions.pod:6563
19053 " guestfs_tail_n (guestfs_h *g,\n"
19055 " const char *path);\n"
19061 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4424
19063 "If the parameter C<nrlines> is a positive number, this returns the last "
19064 "C<nrlines> lines of the file C<path>."
19069 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4427
19071 "If the parameter C<nrlines> is a negative number, this returns lines from "
19072 "the file C<path>, starting with the C<-nrlines>th line."
19077 #: ../src/guestfs-actions.pod:6585
19078 msgid "guestfs_tar_in"
19083 #: ../src/guestfs-actions.pod:6587
19087 " guestfs_tar_in (guestfs_h *g,\n"
19088 " const char *tarfile,\n"
19089 " const char *directory);\n"
19095 #: ../src/guestfs-actions.pod:6592 ../fish/guestfish-actions.pod:4439
19097 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
19098 "tar file) into C<directory>."
19103 #: ../src/guestfs-actions.pod:6595
19105 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
19110 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6617
19111 #: ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6649
19112 msgid "(Added in 1.0.3)"
19117 #: ../src/guestfs-actions.pod:6602
19118 msgid "guestfs_tar_out"
19123 #: ../src/guestfs-actions.pod:6604
19127 " guestfs_tar_out (guestfs_h *g,\n"
19128 " const char *directory,\n"
19129 " const char *tarfile);\n"
19135 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4451
19137 "This command packs the contents of C<directory> and downloads it to local "
19143 #: ../src/guestfs-actions.pod:6612
19145 "To download a compressed tarball, use C<guestfs_tgz_out> or "
19146 "C<guestfs_txz_out>."
19151 #: ../src/guestfs-actions.pod:6619
19152 msgid "guestfs_tgz_in"
19157 #: ../src/guestfs-actions.pod:6621
19161 " guestfs_tgz_in (guestfs_h *g,\n"
19162 " const char *tarball,\n"
19163 " const char *directory);\n"
19169 #: ../src/guestfs-actions.pod:6626 ../fish/guestfish-actions.pod:4463
19171 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19172 "tar file) into C<directory>."
19177 #: ../src/guestfs-actions.pod:6629
19178 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19183 #: ../src/guestfs-actions.pod:6635
19184 msgid "guestfs_tgz_out"
19189 #: ../src/guestfs-actions.pod:6637
19193 " guestfs_tgz_out (guestfs_h *g,\n"
19194 " const char *directory,\n"
19195 " const char *tarball);\n"
19201 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4474
19203 "This command packs the contents of C<directory> and downloads it to local "
19209 #: ../src/guestfs-actions.pod:6645
19210 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19215 #: ../src/guestfs-actions.pod:6651
19216 msgid "guestfs_touch"
19221 #: ../src/guestfs-actions.pod:6653
19225 " guestfs_touch (guestfs_h *g,\n"
19226 " const char *path);\n"
19232 #: ../src/guestfs-actions.pod:6657 ../fish/guestfish-actions.pod:4485
19234 "Touch acts like the L<touch(1)> command. It can be used to update the "
19235 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19241 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4489
19243 "This command only works on regular files, and will fail on other file types "
19244 "such as directories, symbolic links, block special etc."
19249 #: ../src/guestfs-actions.pod:6668
19250 msgid "guestfs_truncate"
19255 #: ../src/guestfs-actions.pod:6670
19259 " guestfs_truncate (guestfs_h *g,\n"
19260 " const char *path);\n"
19266 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4496
19268 "This command truncates C<path> to a zero-length file. The file must exist "
19274 #: ../src/guestfs-actions.pod:6681
19275 msgid "guestfs_truncate_size"
19280 #: ../src/guestfs-actions.pod:6683
19284 " guestfs_truncate_size (guestfs_h *g,\n"
19285 " const char *path,\n"
19286 " int64_t size);\n"
19292 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4503
19294 "This command truncates C<path> to size C<size> bytes. The file must exist "
19300 #: ../src/guestfs-actions.pod:6691
19302 "If the current file size is less than C<size> then the file is extended to "
19303 "the required size with zero bytes. This creates a sparse file (ie. disk "
19304 "blocks are not allocated for the file until you write to it). To create a "
19305 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19310 #: ../src/guestfs-actions.pod:6701
19311 msgid "guestfs_tune2fs_l"
19316 #: ../src/guestfs-actions.pod:6703
19320 " guestfs_tune2fs_l (guestfs_h *g,\n"
19321 " const char *device);\n"
19327 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4516
19329 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19335 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4519
19337 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19338 "for more details. The list of fields returned isn't clearly defined, and "
19339 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19340 "and the filesystem itself."
19345 #: ../src/guestfs-actions.pod:6723
19346 msgid "guestfs_txz_in"
19351 #: ../src/guestfs-actions.pod:6725
19355 " guestfs_txz_in (guestfs_h *g,\n"
19356 " const char *tarball,\n"
19357 " const char *directory);\n"
19363 #: ../src/guestfs-actions.pod:6730 ../fish/guestfish-actions.pod:4528
19365 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19366 "tar file) into C<directory>."
19371 #: ../src/guestfs-actions.pod:6737
19372 msgid "guestfs_txz_out"
19377 #: ../src/guestfs-actions.pod:6739
19381 " guestfs_txz_out (guestfs_h *g,\n"
19382 " const char *directory,\n"
19383 " const char *tarball);\n"
19389 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4537
19391 "This command packs the contents of C<directory> and downloads it to local "
19392 "file C<tarball> (as an xz compressed tar archive)."
19397 #: ../src/guestfs-actions.pod:6751
19398 msgid "guestfs_umask"
19403 #: ../src/guestfs-actions.pod:6753
19407 " guestfs_umask (guestfs_h *g,\n"
19414 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
19416 "This function sets the mask used for creating new files and device nodes to "
19422 #: ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:4549
19424 "Typical umask values would be C<022> which creates new files with "
19425 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19426 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19431 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4554
19433 "The default umask is C<022>. This is important because it means that "
19434 "directories and device nodes will be created with C<0644> or C<0755> mode "
19435 "even if you specify C<0777>."
19440 #: ../src/guestfs-actions.pod:6769
19442 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19443 "C<guestfs_mkdir>."
19448 #: ../src/guestfs-actions.pod:6772 ../fish/guestfish-actions.pod:4561
19449 msgid "This call returns the previous umask."
19454 #: ../src/guestfs-actions.pod:6778
19455 msgid "guestfs_umount"
19460 #: ../src/guestfs-actions.pod:6780
19464 " guestfs_umount (guestfs_h *g,\n"
19465 " const char *pathordevice);\n"
19471 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4569
19473 "This unmounts the given filesystem. The filesystem may be specified either "
19474 "by its mountpoint (path) or the device which contains the filesystem."
19479 #: ../src/guestfs-actions.pod:6792
19480 msgid "guestfs_umount_all"
19485 #: ../src/guestfs-actions.pod:6794
19489 " guestfs_umount_all (guestfs_h *g);\n"
19495 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4579
19496 msgid "This unmounts all mounted filesystems."
19501 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4581
19502 msgid "Some internal mounts are not unmounted by this call."
19507 #: ../src/guestfs-actions.pod:6805
19508 msgid "guestfs_upload"
19513 #: ../src/guestfs-actions.pod:6807
19517 " guestfs_upload (guestfs_h *g,\n"
19518 " const char *filename,\n"
19519 " const char *remotefilename);\n"
19525 #: ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6836
19526 #: ../fish/guestfish-actions.pod:4587 ../fish/guestfish-actions.pod:4600
19527 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19532 #: ../src/guestfs-actions.pod:6817
19533 msgid "See also C<guestfs_download>."
19538 #: ../src/guestfs-actions.pod:6828
19539 msgid "guestfs_upload_offset"
19544 #: ../src/guestfs-actions.pod:6830
19548 " guestfs_upload_offset (guestfs_h *g,\n"
19549 " const char *filename,\n"
19550 " const char *remotefilename,\n"
19551 " int64_t offset);\n"
19557 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4603
19559 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19560 "The intention is to overwrite parts of existing files or devices, although "
19561 "if a non-existant file is specified then it is created with a \"hole\" "
19562 "before C<offset>. The size of the data written is implicit in the size of "
19563 "the source C<filename>."
19568 #: ../src/guestfs-actions.pod:6846
19570 "Note that there is no limit on the amount of data that can be uploaded with "
19571 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19572 "full amount unless an error occurs."
19577 #: ../src/guestfs-actions.pod:6851
19578 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19583 #: ../src/guestfs-actions.pod:6862
19584 msgid "guestfs_utimens"
19589 #: ../src/guestfs-actions.pod:6864
19593 " guestfs_utimens (guestfs_h *g,\n"
19594 " const char *path,\n"
19595 " int64_t atsecs,\n"
19596 " int64_t atnsecs,\n"
19597 " int64_t mtsecs,\n"
19598 " int64_t mtnsecs);\n"
19604 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4623
19605 msgid "This command sets the timestamps of a file with nanosecond precision."
19610 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4626
19612 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19618 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4629
19620 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19621 "nanoseconds from the epoch."
19626 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4632
19628 "If the C<*nsecs> field contains the special value C<-1> then the "
19629 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19630 "ignored in this case)."
19635 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4636
19637 "If the C<*nsecs> field contains the special value C<-2> then the "
19638 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19644 #: ../src/guestfs-actions.pod:6893 ../src/guestfs-structs.pod:175
19645 msgid "guestfs_version"
19650 #: ../src/guestfs-actions.pod:6895
19653 " struct guestfs_version *\n"
19654 " guestfs_version (guestfs_h *g);\n"
19660 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
19662 "Return the libguestfs version number that the program is linked against."
19667 #: ../src/guestfs-actions.pod:6901 ../fish/guestfish-actions.pod:4647
19669 "Note that because of dynamic linking this is not necessarily the version of "
19670 "libguestfs that you compiled against. You can compile the program, and then "
19671 "at runtime dynamically link against a completely different C<libguestfs.so> "
19677 #: ../src/guestfs-actions.pod:6906 ../fish/guestfish-actions.pod:4652
19679 "This call was added in version C<1.0.58>. In previous versions of "
19680 "libguestfs there was no way to get the version number. From C code you can "
19681 "use dynamic linker functions to find out if this symbol exists (if it "
19682 "doesn't, then it's an earlier version)."
19687 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4658
19689 "The call returns a structure with four elements. The first three (C<major>, "
19690 "C<minor> and C<release>) are numbers and correspond to the usual version "
19691 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19692 "but may be used for distro-specific information."
19697 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4664
19699 "To construct the original version string: C<$major.$minor.$release$extra>"
19704 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4667
19705 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19710 #: ../src/guestfs-actions.pod:6923
19712 "I<Note:> Don't use this call to test for availability of features. In "
19713 "enterprise distributions we backport features from later versions into "
19714 "earlier versions, making this an unreliable way to test for features. Use "
19715 "C<guestfs_available> instead."
19720 #: ../src/guestfs-actions.pod:6929
19722 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19723 "error. I<The caller must call C<guestfs_free_version> after use>."
19728 #: ../src/guestfs-actions.pod:6933
19729 msgid "(Added in 1.0.58)"
19734 #: ../src/guestfs-actions.pod:6935
19735 msgid "guestfs_vfs_label"
19740 #: ../src/guestfs-actions.pod:6937
19744 " guestfs_vfs_label (guestfs_h *g,\n"
19745 " const char *device);\n"
19751 #: ../src/guestfs-actions.pod:6941 ../fish/guestfish-actions.pod:4679
19752 msgid "This returns the filesystem label of the filesystem on C<device>."
19757 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4682
19758 msgid "If the filesystem is unlabeled, this returns the empty string."
19763 #: ../src/guestfs-actions.pod:6946
19764 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19769 #: ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:6988
19770 msgid "(Added in 1.3.18)"
19775 #: ../src/guestfs-actions.pod:6953
19776 msgid "guestfs_vfs_type"
19781 #: ../src/guestfs-actions.pod:6955
19785 " guestfs_vfs_type (guestfs_h *g,\n"
19786 " const char *device);\n"
19792 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4690
19794 "This command gets the filesystem type corresponding to the filesystem on "
19800 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4693
19802 "For most filesystems, the result is the name of the Linux VFS module which "
19803 "would be used to mount this filesystem if you mounted it without specifying "
19804 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19809 #: ../src/guestfs-actions.pod:6972
19810 msgid "guestfs_vfs_uuid"
19815 #: ../src/guestfs-actions.pod:6974
19819 " guestfs_vfs_uuid (guestfs_h *g,\n"
19820 " const char *device);\n"
19826 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4702
19827 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19832 #: ../src/guestfs-actions.pod:6981 ../fish/guestfish-actions.pod:4705
19833 msgid "If the filesystem does not have a UUID, this returns the empty string."
19838 #: ../src/guestfs-actions.pod:6983
19839 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19844 #: ../src/guestfs-actions.pod:6990
19845 msgid "guestfs_vg_activate"
19850 #: ../src/guestfs-actions.pod:6992
19854 " guestfs_vg_activate (guestfs_h *g,\n"
19856 " char *const *volgroups);\n"
19862 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
19864 "This command activates or (if C<activate> is false) deactivates all logical "
19865 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19866 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19867 "deactivated, then those devices disappear."
19872 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4719
19873 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19878 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4721
19880 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19881 "activated or deactivated."
19886 #: ../src/guestfs-actions.pod:7012
19887 msgid "guestfs_vg_activate_all"
19892 #: ../src/guestfs-actions.pod:7014
19896 " guestfs_vg_activate_all (guestfs_h *g,\n"
19897 " int activate);\n"
19903 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4728
19905 "This command activates or (if C<activate> is false) deactivates all logical "
19906 "volumes in all volume groups. If activated, then they are made known to the "
19907 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19908 "those devices disappear."
19913 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4734
19914 msgid "This command is the same as running C<vgchange -a y|n>"
19919 #: ../src/guestfs-actions.pod:7030
19920 msgid "guestfs_vgcreate"
19925 #: ../src/guestfs-actions.pod:7032
19929 " guestfs_vgcreate (guestfs_h *g,\n"
19930 " const char *volgroup,\n"
19931 " char *const *physvols);\n"
19937 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4740
19939 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19940 "of physical volumes C<physvols>."
19945 #: ../src/guestfs-actions.pod:7044
19946 msgid "guestfs_vglvuuids"
19951 #: ../src/guestfs-actions.pod:7046
19955 " guestfs_vglvuuids (guestfs_h *g,\n"
19956 " const char *vgname);\n"
19962 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4747
19964 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19965 "volumes created in this volume group."
19970 #: ../src/guestfs-actions.pod:7053
19972 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19973 "associate logical volumes and volume groups."
19978 #: ../src/guestfs-actions.pod:7056
19979 msgid "See also C<guestfs_vgpvuuids>."
19984 #: ../src/guestfs-actions.pod:7064
19985 msgid "guestfs_vgpvuuids"
19990 #: ../src/guestfs-actions.pod:7066
19994 " guestfs_vgpvuuids (guestfs_h *g,\n"
19995 " const char *vgname);\n"
20001 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4759
20003 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
20004 "volumes that this volume group resides on."
20009 #: ../src/guestfs-actions.pod:7073
20011 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
20012 "associate physical volumes and volume groups."
20017 #: ../src/guestfs-actions.pod:7076
20018 msgid "See also C<guestfs_vglvuuids>."
20023 #: ../src/guestfs-actions.pod:7084
20024 msgid "guestfs_vgremove"
20029 #: ../src/guestfs-actions.pod:7086
20033 " guestfs_vgremove (guestfs_h *g,\n"
20034 " const char *vgname);\n"
20040 #: ../src/guestfs-actions.pod:7090 ../fish/guestfish-actions.pod:4771
20041 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
20046 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4773
20048 "This also forcibly removes all logical volumes in the volume group (if any)."
20053 #: ../src/guestfs-actions.pod:7099
20054 msgid "guestfs_vgrename"
20059 #: ../src/guestfs-actions.pod:7101
20063 " guestfs_vgrename (guestfs_h *g,\n"
20064 " const char *volgroup,\n"
20065 " const char *newvolgroup);\n"
20071 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4780
20072 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
20077 #: ../src/guestfs-actions.pod:7112
20078 msgid "guestfs_vgs"
20083 #: ../src/guestfs-actions.pod:7114
20087 " guestfs_vgs (guestfs_h *g);\n"
20093 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4786
20095 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20101 #: ../src/guestfs-actions.pod:7120 ../fish/guestfish-actions.pod:4789
20103 "This returns a list of just the volume group names that were detected (eg. "
20109 #: ../src/guestfs-actions.pod:7123
20110 msgid "See also C<guestfs_vgs_full>."
20115 #: ../src/guestfs-actions.pod:7131
20116 msgid "guestfs_vgs_full"
20121 #: ../src/guestfs-actions.pod:7133
20124 " struct guestfs_lvm_vg_list *\n"
20125 " guestfs_vgs_full (guestfs_h *g);\n"
20131 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4798
20133 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
20134 "> command. The \"full\" version includes all fields."
20139 #: ../src/guestfs-actions.pod:7139
20141 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
20142 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
20147 #: ../src/guestfs-actions.pod:7145
20148 msgid "guestfs_vgscan"
20153 #: ../src/guestfs-actions.pod:7147
20157 " guestfs_vgscan (guestfs_h *g);\n"
20163 #: ../src/guestfs-actions.pod:7150 ../fish/guestfish-actions.pod:4805
20165 "This rescans all block devices and rebuilds the list of LVM physical "
20166 "volumes, volume groups and logical volumes."
20171 #: ../src/guestfs-actions.pod:7157
20172 msgid "guestfs_vguuid"
20177 #: ../src/guestfs-actions.pod:7159
20181 " guestfs_vguuid (guestfs_h *g,\n"
20182 " const char *vgname);\n"
20188 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4812
20189 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20194 #: ../src/guestfs-actions.pod:7170
20195 msgid "guestfs_wait_ready"
20200 #: ../src/guestfs-actions.pod:7172
20204 " guestfs_wait_ready (guestfs_h *g);\n"
20210 #: ../src/guestfs-actions.pod:7175
20211 msgid "This function is a no op."
20216 #: ../src/guestfs-actions.pod:7177
20218 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20219 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20220 "is no longer necessary because C<guestfs_launch> now does the waiting."
20225 #: ../src/guestfs-actions.pod:7182
20227 "If you see any calls to this function in code then you can just remove them, "
20228 "unless you want to retain compatibility with older versions of the API."
20233 #: ../src/guestfs-actions.pod:7190
20234 msgid "guestfs_wc_c"
20239 #: ../src/guestfs-actions.pod:7192
20243 " guestfs_wc_c (guestfs_h *g,\n"
20244 " const char *path);\n"
20250 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4818
20252 "This command counts the characters in a file, using the C<wc -c> external "
20258 #: ../src/guestfs-actions.pod:7203
20259 msgid "guestfs_wc_l"
20264 #: ../src/guestfs-actions.pod:7205
20268 " guestfs_wc_l (guestfs_h *g,\n"
20269 " const char *path);\n"
20275 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4825
20277 "This command counts the lines in a file, using the C<wc -l> external command."
20282 #: ../src/guestfs-actions.pod:7216
20283 msgid "guestfs_wc_w"
20288 #: ../src/guestfs-actions.pod:7218
20292 " guestfs_wc_w (guestfs_h *g,\n"
20293 " const char *path);\n"
20299 #: ../src/guestfs-actions.pod:7222 ../fish/guestfish-actions.pod:4832
20301 "This command counts the words in a file, using the C<wc -w> external command."
20306 #: ../src/guestfs-actions.pod:7229
20307 msgid "guestfs_write"
20312 #: ../src/guestfs-actions.pod:7231
20316 " guestfs_write (guestfs_h *g,\n"
20317 " const char *path,\n"
20318 " const char *content,\n"
20319 " size_t content_size);\n"
20325 #: ../src/guestfs-actions.pod:7237 ../fish/guestfish-actions.pod:4839
20327 "This call creates a file called C<path>. The content of the file is the "
20328 "string C<content> (which can contain any 8 bit data)."
20333 #: ../src/guestfs-actions.pod:7247
20334 msgid "guestfs_write_file"
20339 #: ../src/guestfs-actions.pod:7249
20343 " guestfs_write_file (guestfs_h *g,\n"
20344 " const char *path,\n"
20345 " const char *content,\n"
20352 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
20354 "This call creates a file called C<path>. The contents of the file is the "
20355 "string C<content> (which can contain any 8 bit data), with length C<size>."
20360 #: ../src/guestfs-actions.pod:7259 ../fish/guestfish-actions.pod:4853
20362 "As a special case, if C<size> is C<0> then the length is calculated using "
20363 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20368 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4857
20370 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20371 "I<not> work, even if the length is specified."
20376 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4863
20378 "This function is deprecated. In new code, use the C<write> call instead."
20383 #: ../src/guestfs-actions.pod:7280
20384 msgid "guestfs_zegrep"
20389 #: ../src/guestfs-actions.pod:7282
20393 " guestfs_zegrep (guestfs_h *g,\n"
20394 " const char *regex,\n"
20395 " const char *path);\n"
20401 #: ../src/guestfs-actions.pod:7287 ../fish/guestfish-actions.pod:4874
20403 "This calls the external C<zegrep> program and returns the matching lines."
20408 #: ../src/guestfs-actions.pod:7299
20409 msgid "guestfs_zegrepi"
20414 #: ../src/guestfs-actions.pod:7301
20418 " guestfs_zegrepi (guestfs_h *g,\n"
20419 " const char *regex,\n"
20420 " const char *path);\n"
20426 #: ../src/guestfs-actions.pod:7306 ../fish/guestfish-actions.pod:4884
20428 "This calls the external C<zegrep -i> program and returns the matching lines."
20433 #: ../src/guestfs-actions.pod:7318
20434 msgid "guestfs_zero"
20439 #: ../src/guestfs-actions.pod:7320
20443 " guestfs_zero (guestfs_h *g,\n"
20444 " const char *device);\n"
20450 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4894
20451 msgid "This command writes zeroes over the first few blocks of C<device>."
20456 #: ../src/guestfs-actions.pod:7326 ../fish/guestfish-actions.pod:4896
20458 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20459 "securely wipe the device). It should be sufficient to remove any partition "
20460 "tables, filesystem superblocks and so on."
20465 #: ../src/guestfs-actions.pod:7330
20466 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20471 #: ../src/guestfs-actions.pod:7341
20472 msgid "guestfs_zero_device"
20477 #: ../src/guestfs-actions.pod:7343
20481 " guestfs_zero_device (guestfs_h *g,\n"
20482 " const char *device);\n"
20488 #: ../src/guestfs-actions.pod:7347
20490 "This command writes zeroes over the entire C<device>. Compare with "
20491 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20496 #: ../src/guestfs-actions.pod:7361
20497 msgid "(Added in 1.3.1)"
20502 #: ../src/guestfs-actions.pod:7363
20503 msgid "guestfs_zerofree"
20508 #: ../src/guestfs-actions.pod:7365
20512 " guestfs_zerofree (guestfs_h *g,\n"
20513 " const char *device);\n"
20519 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
20521 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20522 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20523 "possible to compress the filesystem more effectively."
20528 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4922
20529 msgid "You should B<not> run this program if the filesystem is mounted."
20534 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4925
20536 "It is possible that using this program can damage the filesystem or data on "
20542 #: ../src/guestfs-actions.pod:7384
20543 msgid "guestfs_zfgrep"
20548 #: ../src/guestfs-actions.pod:7386
20552 " guestfs_zfgrep (guestfs_h *g,\n"
20553 " const char *pattern,\n"
20554 " const char *path);\n"
20560 #: ../src/guestfs-actions.pod:7391 ../fish/guestfish-actions.pod:4932
20562 "This calls the external C<zfgrep> program and returns the matching lines."
20567 #: ../src/guestfs-actions.pod:7403
20568 msgid "guestfs_zfgrepi"
20573 #: ../src/guestfs-actions.pod:7405
20577 " guestfs_zfgrepi (guestfs_h *g,\n"
20578 " const char *pattern,\n"
20579 " const char *path);\n"
20585 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4942
20587 "This calls the external C<zfgrep -i> program and returns the matching lines."
20592 #: ../src/guestfs-actions.pod:7422
20593 msgid "guestfs_zfile"
20598 #: ../src/guestfs-actions.pod:7424
20602 " guestfs_zfile (guestfs_h *g,\n"
20603 " const char *meth,\n"
20604 " const char *path);\n"
20610 #: ../src/guestfs-actions.pod:7429 ../fish/guestfish-actions.pod:4952
20612 "This command runs C<file> after first decompressing C<path> using C<method>."
20617 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4955
20618 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20623 #: ../src/guestfs-actions.pod:7434
20625 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20631 #: ../src/guestfs-actions.pod:7440 ../fish/guestfish-actions.pod:4960
20633 "This function is deprecated. In new code, use the C<file> call instead."
20638 #: ../src/guestfs-actions.pod:7449
20639 msgid "guestfs_zgrep"
20644 #: ../src/guestfs-actions.pod:7451
20648 " guestfs_zgrep (guestfs_h *g,\n"
20649 " const char *regex,\n"
20650 " const char *path);\n"
20656 #: ../src/guestfs-actions.pod:7456 ../fish/guestfish-actions.pod:4971
20658 "This calls the external C<zgrep> program and returns the matching lines."
20663 #: ../src/guestfs-actions.pod:7468
20664 msgid "guestfs_zgrepi"
20669 #: ../src/guestfs-actions.pod:7470
20673 " guestfs_zgrepi (guestfs_h *g,\n"
20674 " const char *regex,\n"
20675 " const char *path);\n"
20681 #: ../src/guestfs-actions.pod:7475 ../fish/guestfish-actions.pod:4981
20683 "This calls the external C<zgrep -i> program and returns the matching lines."
20688 #: ../src/guestfs-availability.pod:3
20694 #: ../src/guestfs-availability.pod:5
20696 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20697 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20698 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20699 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20700 "L</guestfs_aug_save> L</guestfs_aug_set>"
20705 #: ../src/guestfs-availability.pod:21
20711 #: ../src/guestfs-availability.pod:23
20713 "The following functions: L</guestfs_inotify_add_watch> L</"
20714 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20715 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20720 #: ../src/guestfs-availability.pod:31
20721 msgid "B<linuxfsuuid>"
20726 #: ../src/guestfs-availability.pod:33
20728 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20729 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20734 #: ../src/guestfs-availability.pod:40
20735 msgid "B<linuxmodules>"
20740 #: ../src/guestfs-availability.pod:42
20741 msgid "The following functions: L</guestfs_modprobe>"
20746 #: ../src/guestfs-availability.pod:45
20747 msgid "B<linuxxattrs>"
20752 #: ../src/guestfs-availability.pod:47
20754 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20755 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20756 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20757 "guestfs_setxattr>"
20762 #: ../src/guestfs-availability.pod:58
20768 #: ../src/guestfs-availability.pod:60
20770 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20771 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20772 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20777 #: ../src/guestfs-availability.pod:69
20783 #: ../src/guestfs-availability.pod:71
20785 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20786 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20787 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20788 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20789 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20790 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20791 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20796 #: ../src/guestfs-availability.pod:94
20802 #: ../src/guestfs-availability.pod:96
20804 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20805 "guestfs_mknod_b> L</guestfs_mknod_c>"
20810 #: ../src/guestfs-availability.pod:102
20816 #: ../src/guestfs-availability.pod:104
20817 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20822 #: ../src/guestfs-availability.pod:107
20823 msgid "B<ntfsprogs>"
20828 #: ../src/guestfs-availability.pod:109
20830 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20835 #: ../src/guestfs-availability.pod:113
20836 msgid "B<realpath>"
20841 #: ../src/guestfs-availability.pod:115
20842 msgid "The following functions: L</guestfs_realpath>"
20847 #: ../src/guestfs-availability.pod:118
20853 #: ../src/guestfs-availability.pod:120
20855 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20856 "guestfs_scrub_freespace>"
20861 #: ../src/guestfs-availability.pod:125
20867 #: ../src/guestfs-availability.pod:127
20868 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20873 #: ../src/guestfs-availability.pod:131
20879 #: ../src/guestfs-availability.pod:133
20880 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20885 #: ../src/guestfs-availability.pod:137
20886 msgid "B<zerofree>"
20891 #: ../src/guestfs-availability.pod:139
20892 msgid "The following functions: L</guestfs_zerofree>"
20897 #: ../src/guestfs-structs.pod:1
20898 msgid "guestfs_int_bool"
20903 #: ../src/guestfs-structs.pod:3
20906 " struct guestfs_int_bool {\n"
20915 #: ../src/guestfs-structs.pod:8
20918 " struct guestfs_int_bool_list {\n"
20919 " uint32_t len; /* Number of elements in list. */\n"
20920 " struct guestfs_int_bool *val; /* Elements. */\n"
20927 #: ../src/guestfs-structs.pod:13
20930 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20931 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20937 #: ../src/guestfs-structs.pod:16
20938 msgid "guestfs_lvm_pv"
20943 #: ../src/guestfs-structs.pod:18
20946 " struct guestfs_lvm_pv {\n"
20947 " char *pv_name;\n"
20948 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20949 " char pv_uuid[32];\n"
20951 " uint64_t pv_size;\n"
20952 " uint64_t dev_size;\n"
20953 " uint64_t pv_free;\n"
20954 " uint64_t pv_used;\n"
20955 " char *pv_attr;\n"
20956 " int64_t pv_pe_count;\n"
20957 " int64_t pv_pe_alloc_count;\n"
20958 " char *pv_tags;\n"
20959 " uint64_t pe_start;\n"
20960 " int64_t pv_mda_count;\n"
20961 " uint64_t pv_mda_free;\n"
20968 #: ../src/guestfs-structs.pod:36
20971 " struct guestfs_lvm_pv_list {\n"
20972 " uint32_t len; /* Number of elements in list. */\n"
20973 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20980 #: ../src/guestfs-structs.pod:41
20983 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20984 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20990 #: ../src/guestfs-structs.pod:44
20991 msgid "guestfs_lvm_vg"
20996 #: ../src/guestfs-structs.pod:46
20999 " struct guestfs_lvm_vg {\n"
21000 " char *vg_name;\n"
21001 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21002 " char vg_uuid[32];\n"
21004 " char *vg_attr;\n"
21005 " uint64_t vg_size;\n"
21006 " uint64_t vg_free;\n"
21007 " char *vg_sysid;\n"
21008 " uint64_t vg_extent_size;\n"
21009 " int64_t vg_extent_count;\n"
21010 " int64_t vg_free_count;\n"
21011 " int64_t max_lv;\n"
21012 " int64_t max_pv;\n"
21013 " int64_t pv_count;\n"
21014 " int64_t lv_count;\n"
21015 " int64_t snap_count;\n"
21016 " int64_t vg_seqno;\n"
21017 " char *vg_tags;\n"
21018 " int64_t vg_mda_count;\n"
21019 " uint64_t vg_mda_free;\n"
21026 #: ../src/guestfs-structs.pod:69
21029 " struct guestfs_lvm_vg_list {\n"
21030 " uint32_t len; /* Number of elements in list. */\n"
21031 " struct guestfs_lvm_vg *val; /* Elements. */\n"
21038 #: ../src/guestfs-structs.pod:74
21041 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
21042 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
21048 #: ../src/guestfs-structs.pod:77
21049 msgid "guestfs_lvm_lv"
21054 #: ../src/guestfs-structs.pod:79
21057 " struct guestfs_lvm_lv {\n"
21058 " char *lv_name;\n"
21059 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
21060 " char lv_uuid[32];\n"
21061 " char *lv_attr;\n"
21062 " int64_t lv_major;\n"
21063 " int64_t lv_minor;\n"
21064 " int64_t lv_kernel_major;\n"
21065 " int64_t lv_kernel_minor;\n"
21066 " uint64_t lv_size;\n"
21067 " int64_t seg_count;\n"
21069 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21070 " float snap_percent;\n"
21071 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
21072 " float copy_percent;\n"
21073 " char *move_pv;\n"
21074 " char *lv_tags;\n"
21075 " char *mirror_log;\n"
21076 " char *modules;\n"
21083 #: ../src/guestfs-structs.pod:101
21086 " struct guestfs_lvm_lv_list {\n"
21087 " uint32_t len; /* Number of elements in list. */\n"
21088 " struct guestfs_lvm_lv *val; /* Elements. */\n"
21095 #: ../src/guestfs-structs.pod:106
21098 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
21099 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
21105 #: ../src/guestfs-structs.pod:111
21108 " struct guestfs_stat {\n"
21112 " int64_t nlink;\n"
21117 " int64_t blksize;\n"
21118 " int64_t blocks;\n"
21119 " int64_t atime;\n"
21120 " int64_t mtime;\n"
21121 " int64_t ctime;\n"
21128 #: ../src/guestfs-structs.pod:127
21131 " struct guestfs_stat_list {\n"
21132 " uint32_t len; /* Number of elements in list. */\n"
21133 " struct guestfs_stat *val; /* Elements. */\n"
21140 #: ../src/guestfs-structs.pod:132
21143 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
21144 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
21150 #: ../src/guestfs-structs.pod:137
21153 " struct guestfs_statvfs {\n"
21154 " int64_t bsize;\n"
21155 " int64_t frsize;\n"
21156 " int64_t blocks;\n"
21157 " int64_t bfree;\n"
21158 " int64_t bavail;\n"
21159 " int64_t files;\n"
21160 " int64_t ffree;\n"
21161 " int64_t favail;\n"
21164 " int64_t namemax;\n"
21171 #: ../src/guestfs-structs.pod:151
21174 " struct guestfs_statvfs_list {\n"
21175 " uint32_t len; /* Number of elements in list. */\n"
21176 " struct guestfs_statvfs *val; /* Elements. */\n"
21183 #: ../src/guestfs-structs.pod:156
21186 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21187 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21193 #: ../src/guestfs-structs.pod:159
21194 msgid "guestfs_dirent"
21199 #: ../src/guestfs-structs.pod:161
21202 " struct guestfs_dirent {\n"
21212 #: ../src/guestfs-structs.pod:167
21215 " struct guestfs_dirent_list {\n"
21216 " uint32_t len; /* Number of elements in list. */\n"
21217 " struct guestfs_dirent *val; /* Elements. */\n"
21224 #: ../src/guestfs-structs.pod:172
21227 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21228 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21234 #: ../src/guestfs-structs.pod:177
21237 " struct guestfs_version {\n"
21238 " int64_t major;\n"
21239 " int64_t minor;\n"
21240 " int64_t release;\n"
21248 #: ../src/guestfs-structs.pod:184
21251 " struct guestfs_version_list {\n"
21252 " uint32_t len; /* Number of elements in list. */\n"
21253 " struct guestfs_version *val; /* Elements. */\n"
21260 #: ../src/guestfs-structs.pod:189
21263 " void guestfs_free_version (struct guestfs_free_version *);\n"
21264 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21270 #: ../src/guestfs-structs.pod:192
21271 msgid "guestfs_xattr"
21276 #: ../src/guestfs-structs.pod:194
21279 " struct guestfs_xattr {\n"
21280 " char *attrname;\n"
21281 " /* The next two fields describe a byte array. */\n"
21282 " uint32_t attrval_len;\n"
21283 " char *attrval;\n"
21290 #: ../src/guestfs-structs.pod:201
21293 " struct guestfs_xattr_list {\n"
21294 " uint32_t len; /* Number of elements in list. */\n"
21295 " struct guestfs_xattr *val; /* Elements. */\n"
21302 #: ../src/guestfs-structs.pod:206
21305 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21306 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21312 #: ../src/guestfs-structs.pod:209
21313 msgid "guestfs_inotify_event"
21318 #: ../src/guestfs-structs.pod:211
21321 " struct guestfs_inotify_event {\n"
21322 " int64_t in_wd;\n"
21323 " uint32_t in_mask;\n"
21324 " uint32_t in_cookie;\n"
21325 " char *in_name;\n"
21332 #: ../src/guestfs-structs.pod:218
21335 " struct guestfs_inotify_event_list {\n"
21336 " uint32_t len; /* Number of elements in list. */\n"
21337 " struct guestfs_inotify_event *val; /* Elements. */\n"
21344 #: ../src/guestfs-structs.pod:223
21347 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21348 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21354 #: ../src/guestfs-structs.pod:226
21355 msgid "guestfs_partition"
21360 #: ../src/guestfs-structs.pod:228
21363 " struct guestfs_partition {\n"
21364 " int32_t part_num;\n"
21365 " uint64_t part_start;\n"
21366 " uint64_t part_end;\n"
21367 " uint64_t part_size;\n"
21374 #: ../src/guestfs-structs.pod:235
21377 " struct guestfs_partition_list {\n"
21378 " uint32_t len; /* Number of elements in list. */\n"
21379 " struct guestfs_partition *val; /* Elements. */\n"
21386 #: ../src/guestfs-structs.pod:240
21389 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21390 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21396 #: ../src/guestfs-structs.pod:243
21397 msgid "guestfs_application"
21402 #: ../src/guestfs-structs.pod:245
21405 " struct guestfs_application {\n"
21406 " char *app_name;\n"
21407 " char *app_display_name;\n"
21408 " int32_t app_epoch;\n"
21409 " char *app_version;\n"
21410 " char *app_release;\n"
21411 " char *app_install_path;\n"
21412 " char *app_trans_path;\n"
21413 " char *app_publisher;\n"
21414 " char *app_url;\n"
21415 " char *app_source_package;\n"
21416 " char *app_summary;\n"
21417 " char *app_description;\n"
21424 #: ../src/guestfs-structs.pod:260
21427 " struct guestfs_application_list {\n"
21428 " uint32_t len; /* Number of elements in list. */\n"
21429 " struct guestfs_application *val; /* Elements. */\n"
21436 #: ../src/guestfs-structs.pod:265
21439 " void guestfs_free_application (struct guestfs_free_application *);\n"
21440 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21446 #: ../fish/guestfish.pod:5
21447 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21452 #: ../fish/guestfish.pod:9
21455 " guestfish [--options] [commands]\n"
21461 #: ../fish/guestfish.pod:11
21470 #: ../fish/guestfish.pod:13
21473 " guestfish [--ro|--rw] -a disk.img\n"
21479 #: ../fish/guestfish.pod:15
21482 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21488 #: ../fish/guestfish.pod:17
21491 " guestfish -d libvirt-domain\n"
21497 #: ../fish/guestfish.pod:19
21500 " guestfish [--ro|--rw] -a disk.img -i\n"
21506 #: ../fish/guestfish.pod:21
21509 " guestfish -d libvirt-domain -i\n"
21515 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21516 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21522 #: ../fish/guestfish.pod:25
21524 "Using guestfish in read/write mode on live virtual machines can be "
21525 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21526 "option to use guestfish safely if the disk image or virtual machine might be "
21532 #: ../fish/guestfish.pod:32
21534 "Guestfish is a shell and command-line tool for examining and modifying "
21535 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21536 "functionality of the guestfs API, see L<guestfs(3)>."
21541 #: ../fish/guestfish.pod:36
21543 "Guestfish gives you structured access to the libguestfs API, from shell "
21544 "scripts or the command line or interactively. If you want to rescue a "
21545 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21551 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
21552 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
21558 #: ../fish/guestfish.pod:43
21559 msgid "As an interactive shell"
21564 #: ../fish/guestfish.pod:45
21573 #: ../fish/guestfish.pod:47
21576 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21577 " editing virtual machine filesystems.\n"
21583 #: ../fish/guestfish.pod:50
21586 " Type: 'help' for a list of commands\n"
21587 " 'man' to read the manual\n"
21588 " 'quit' to quit the shell\n"
21594 #: ../fish/guestfish.pod:54
21597 " ><fs> add-ro disk.img\n"
21599 " ><fs> list-filesystems\n"
21600 " /dev/sda1: ext4\n"
21601 " /dev/vg_guest/lv_root: ext4\n"
21602 " /dev/vg_guest/lv_swap: swap\n"
21603 " ><fs> mount /dev/vg_guest/lv_root /\n"
21604 " ><fs> cat /etc/fstab\n"
21606 " # Created by anaconda\n"
21614 #: ../fish/guestfish.pod:67
21615 msgid "From shell scripts"
21620 #: ../fish/guestfish.pod:69
21621 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21626 #: ../fish/guestfish.pod:71
21629 " guestfish <<_EOF_\n"
21632 " mount /dev/vg_guest/lv_root /\n"
21633 " write /etc/motd \"Welcome, new users\"\n"
21640 #: ../fish/guestfish.pod:78
21641 msgid "List the LVM logical volumes in a disk image:"
21646 #: ../fish/guestfish.pod:80
21649 " guestfish -a disk.img --ro <<_EOF_\n"
21658 #: ../fish/guestfish.pod:85
21659 msgid "List all the filesystems in a disk image:"
21664 #: ../fish/guestfish.pod:87
21667 " guestfish -a disk.img --ro <<_EOF_\n"
21669 " list-filesystems\n"
21676 #: ../fish/guestfish.pod:92
21677 msgid "On one command line"
21682 #: ../fish/guestfish.pod:94
21683 msgid "Update C</etc/resolv.conf> in a guest:"
21688 #: ../fish/guestfish.pod:96
21692 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21693 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21699 #: ../fish/guestfish.pod:100
21700 msgid "Edit C</boot/grub/grub.conf> interactively:"
21705 #: ../fish/guestfish.pod:102
21708 " guestfish --rw --add disk.img \\\n"
21709 " --mount /dev/vg_guest/lv_root \\\n"
21710 " --mount /dev/sda1:/boot \\\n"
21711 " edit /boot/grub/grub.conf\n"
21717 #: ../fish/guestfish.pod:107
21718 msgid "Mount disks automatically"
21723 #: ../fish/guestfish.pod:109
21725 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21730 #: ../fish/guestfish.pod:112
21733 " guestfish --ro -a disk.img -i cat /etc/group\n"
21739 #: ../fish/guestfish.pod:114
21742 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21748 #: ../fish/guestfish.pod:116
21749 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21754 #: ../fish/guestfish.pod:118
21757 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21763 #: ../fish/guestfish.pod:120
21764 msgid "As a script interpreter"
21769 #: ../fish/guestfish.pod:122
21770 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21775 #: ../fish/guestfish.pod:124
21778 " #!/usr/bin/guestfish -f\n"
21779 " sparse test1.img 100M\n"
21781 " part-disk /dev/sda mbr\n"
21782 " mkfs ext2 /dev/sda1\n"
21788 #: ../fish/guestfish.pod:130
21789 msgid "Start with a prepared disk"
21794 #: ../fish/guestfish.pod:132
21796 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21797 "single ext2-formatted partition:"
21802 #: ../fish/guestfish.pod:135
21805 " guestfish -N fs\n"
21811 #: ../fish/guestfish.pod:137
21812 msgid "To list what is available do:"
21817 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
21820 " guestfish -N help | less\n"
21826 #: ../fish/guestfish.pod:141
21827 msgid "Remote control"
21832 #: ../fish/guestfish.pod:143
21835 " eval \"`guestfish --listen`\"\n"
21836 " guestfish --remote add-ro disk.img\n"
21837 " guestfish --remote run\n"
21838 " guestfish --remote lvs\n"
21844 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21845 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
21846 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
21847 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
21848 #: ../tools/virt-list-partitions.pl:54
21854 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21855 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21856 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
21857 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
21863 #: ../fish/guestfish.pod:154
21864 msgid "Displays general help on options."
21869 #: ../fish/guestfish.pod:156
21875 #: ../fish/guestfish.pod:158
21876 msgid "B<--cmd-help>"
21881 #: ../fish/guestfish.pod:160
21882 msgid "Lists all available guestfish commands."
21887 #: ../fish/guestfish.pod:162
21893 #: ../fish/guestfish.pod:164
21894 msgid "B<--cmd-help cmd>"
21899 #: ../fish/guestfish.pod:166
21900 msgid "Displays detailed help on a single command C<cmd>."
21905 #: ../fish/guestfish.pod:168
21906 msgid "B<-a image>"
21911 #: ../fish/guestfish.pod:170
21912 msgid "B<--add image>"
21917 #: ../fish/guestfish.pod:172
21918 msgid "Add a block device or virtual machine image to the shell."
21923 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21925 "The format of the disk image is auto-detected. To override this and force a "
21926 "particular format use the I<--format=..> option."
21930 #: ../fish/guestfish.pod:177
21932 "Using this flag is mostly equivalent to using the C<add> command, with "
21933 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21934 "the I<--format=...> flag was given."
21939 #: ../fish/guestfish.pod:181
21945 #: ../fish/guestfish.pod:183
21946 msgid "B<--connect URI>"
21951 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21953 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21954 "URI to use. The default is to use the default libvirt connection."
21959 #: ../fish/guestfish.pod:189
21965 #: ../fish/guestfish.pod:191
21967 "If using the I<--listen> option and a csh-like shell, use this option. See "
21968 "section L</REMOTE CONTROL AND CSH> below."
21973 #: ../fish/guestfish.pod:194
21974 msgid "B<-d libvirt-domain>"
21979 #: ../fish/guestfish.pod:196
21980 msgid "B<--domain libvirt-domain>"
21985 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21987 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21988 "used, then any libvirt domain can be used. However in write mode, only "
21989 "libvirt domains which are shut down can be named here."
21994 #: ../fish/guestfish.pod:202
21996 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21997 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21998 "if the I<--format:...> flag was given."
22003 #: ../fish/guestfish.pod:206
22009 #: ../fish/guestfish.pod:208
22010 msgid "B<--no-dest-paths>"
22015 #: ../fish/guestfish.pod:210
22017 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
22018 "to hit the tab key to complete paths on the guest filesystem, but this "
22019 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
22020 "allow this feature to be disabled."
22025 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
22026 msgid "B<--echo-keys>"
22031 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
22033 "When prompting for keys and passphrases, guestfish normally turns echoing "
22034 "off so you cannot see what you are typing. If you are not worried about "
22035 "Tempest attacks and there is no one else in the room you can specify this "
22036 "flag to see what you are typing."
22041 #: ../fish/guestfish.pod:222
22047 #: ../fish/guestfish.pod:224
22048 msgid "B<--file file>"
22053 #: ../fish/guestfish.pod:226
22054 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
22059 #: ../fish/guestfish.pod:229
22062 " #!/usr/bin/guestfish -f\n"
22068 #: ../fish/guestfish.pod:231
22069 msgid "B<--format=raw|qcow2|..>"
22074 #: ../fish/guestfish.pod:233
22075 msgid "B<--format>"
22080 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
22082 "The default for the I<-a> option is to auto-detect the format of the disk "
22083 "image. Using this forces the disk format for I<-a> options which follow on "
22084 "the command line. Using I<--format> with no argument switches back to auto-"
22085 "detection for subsequent I<-a> options."
22090 #: ../fish/guestfish.pod:242
22093 " guestfish --format=raw -a disk.img\n"
22099 #: ../fish/guestfish.pod:244
22100 msgid "forces raw format (no auto-detection) for C<disk.img>."
22105 #: ../fish/guestfish.pod:246
22108 " guestfish --format=raw -a disk.img --format -a another.img\n"
22114 #: ../fish/guestfish.pod:248
22116 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
22117 "detection for C<another.img>."
22122 #: ../fish/guestfish.pod:251
22124 "If you have untrusted raw-format guest disk images, you should use this "
22125 "option to specify the disk format. This avoids a possible security problem "
22126 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
22131 #: ../fish/guestfish.pod:256
22137 #: ../fish/guestfish.pod:258
22138 msgid "B<--inspector>"
22143 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
22145 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
22146 "system and mount filesystems as they would be mounted on the real virtual "
22152 #: ../fish/guestfish.pod:264
22153 msgid "Typical usage is either:"
22158 #: ../fish/guestfish.pod:266
22161 " guestfish -d myguest -i\n"
22167 #: ../fish/guestfish.pod:268
22168 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22173 #: ../fish/guestfish.pod:270
22176 " guestfish --ro -d myguest -i\n"
22182 #: ../fish/guestfish.pod:272
22183 msgid "(for active domains, readonly), or specify the block device directly:"
22188 #: ../fish/guestfish.pod:274
22191 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22197 #: ../fish/guestfish.pod:276
22199 "Note that the command line syntax changed slightly over older versions of "
22200 "guestfish. You can still use the old syntax:"
22205 #: ../fish/guestfish.pod:279
22208 " guestfish [--ro] -i disk.img\n"
22214 #: ../fish/guestfish.pod:281
22217 " guestfish [--ro] -i libvirt-domain\n"
22223 #: ../fish/guestfish.pod:283
22225 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22226 "then using other commands to mount the filesystems that were found."
22231 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
22232 msgid "B<--keys-from-stdin>"
22237 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
22239 "Read key or passphrase parameters from stdin. The default is to try to read "
22240 "passphrases from the user by opening C</dev/tty>."
22245 #: ../fish/guestfish.pod:292
22246 msgid "B<--listen>"
22251 #: ../fish/guestfish.pod:294
22253 "Fork into the background and listen for remote commands. See section L</"
22254 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22258 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
22263 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
22265 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22266 "ATTACHING TO RUNNING DAEMONS>)."
22270 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
22271 msgid "B<-m dev[:mountpoint[:options]]>"
22275 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
22276 msgid "B<--mount dev[:mountpoint[:options]]>"
22281 #: ../fish/guestfish.pod:306
22282 msgid "Mount the named partition or logical volume on the given mountpoint."
22287 #: ../fish/guestfish.pod:308
22288 msgid "If the mountpoint is omitted, it defaults to C</>."
22293 #: ../fish/guestfish.pod:310
22294 msgid "You have to mount something on C</> before most commands will work."
22299 #: ../fish/guestfish.pod:312
22301 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22307 #: ../fish/guestfish.pod:315
22309 "If you don't know what filesystems a disk image contains, you can either run "
22310 "guestfish without this option, then list the partitions, filesystems and LVs "
22311 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22312 "commands), or you can use the L<virt-filesystems(1)> program."
22316 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
22318 "The third (and rarely used) part of the mount parameter is the list of mount "
22319 "options used to mount the underlying filesystem. If this is not given, then "
22320 "the mount options are either the empty string or C<ro> (the latter if the "
22321 "I<--ro> flag is used). By specifying the mount options, you override this "
22322 "default choice. Probably the only time you would use this is to enable ACLs "
22323 "and/or extended attributes if the filesystem can support them:"
22327 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
22330 " -m /dev/sda1:/:acl,user_xattr\n"
22335 #: ../fish/guestfish.pod:331
22336 msgid "Using this flag is equivalent to using the C<mount-options> command."
22341 #: ../fish/guestfish.pod:333
22347 #: ../fish/guestfish.pod:335
22348 msgid "B<--no-sync>"
22353 #: ../fish/guestfish.pod:337
22355 "Disable autosync. This is enabled by default. See the discussion of "
22356 "autosync in the L<guestfs(3)> manpage."
22361 #: ../fish/guestfish.pod:340
22367 #: ../fish/guestfish.pod:342
22368 msgid "B<--new type>"
22373 #: ../fish/guestfish.pod:344
22379 #: ../fish/guestfish.pod:346
22381 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22382 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22383 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22389 #: ../fish/guestfish.pod:351
22390 msgid "B<--progress-bars>"
22395 #: ../fish/guestfish.pod:353
22396 msgid "Enable progress bars, even when guestfish is used non-interactively."
22401 #: ../fish/guestfish.pod:355
22403 "Progress bars are enabled by default when guestfish is used as an "
22404 "interactive shell."
22409 #: ../fish/guestfish.pod:358
22410 msgid "B<--no-progress-bars>"
22415 #: ../fish/guestfish.pod:360
22416 msgid "Disable progress bars."
22421 #: ../fish/guestfish.pod:362
22422 msgid "B<--remote[=pid]>"
22427 #: ../fish/guestfish.pod:364
22429 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22430 "CONTROL GUESTFISH OVER A SOCKET> below."
22435 #: ../fish/guestfish.pod:367
22441 #: ../fish/guestfish.pod:369
22447 #: ../fish/guestfish.pod:371
22449 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22450 "mounts are done read-only."
22455 #: ../fish/guestfish.pod:374
22457 "The option must always be used if the disk image or virtual machine might be "
22458 "running, and is generally recommended in cases where you don't need write "
22459 "access to the disk."
22464 #: ../fish/guestfish.pod:378
22466 "Note that prepared disk images created with I<-N> are not affected by this "
22467 "option. Also commands like C<add> are not affected - you have to specify "
22468 "the C<readonly:true> option explicitly if you need it."
22473 #: ../fish/guestfish.pod:382
22474 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22479 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
22480 msgid "B<--selinux>"
22485 #: ../fish/guestfish.pod:386
22486 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22491 #: ../fish/guestfish.pod:388
22497 #: ../fish/guestfish.pod:390
22498 msgid "B<--verbose>"
22503 #: ../fish/guestfish.pod:392
22505 "Enable very verbose messages. This is particularly useful if you find a bug."
22510 #: ../fish/guestfish.pod:395
22516 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
22517 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
22518 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
22519 #: ../tools/virt-list-partitions.pl:70
22520 msgid "B<--version>"
22525 #: ../fish/guestfish.pod:399
22526 msgid "Display the guestfish / libguestfs version number and exit."
22531 #: ../fish/guestfish.pod:401
22537 #: ../fish/guestfish.pod:403
22542 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
22544 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22545 "mounts are done read-write."
22549 #: ../fish/guestfish.pod:408
22550 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22555 #: ../fish/guestfish.pod:410
22561 #: ../fish/guestfish.pod:412
22562 msgid "Echo each command before executing it."
22567 #: ../fish/guestfish.pod:416
22568 msgid "COMMANDS ON COMMAND LINE"
22573 #: ../fish/guestfish.pod:418
22575 "Any additional (non-option) arguments are treated as commands to execute."
22580 #: ../fish/guestfish.pod:421
22582 "Commands to execute should be separated by a colon (C<:>), where the colon "
22583 "is a separate parameter. Thus:"
22588 #: ../fish/guestfish.pod:424
22591 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22597 #: ../fish/guestfish.pod:426
22599 "If there are no additional arguments, then we enter a shell, either an "
22600 "interactive shell with a prompt (if the input is a terminal) or a non-"
22601 "interactive shell."
22606 #: ../fish/guestfish.pod:430
22608 "In either command line mode or non-interactive shell, the first command that "
22609 "gives an error causes the whole shell to exit. In interactive mode (with a "
22610 "prompt) if a command fails, you can continue to enter commands."
22615 #: ../fish/guestfish.pod:435
22616 msgid "USING launch (OR run)"
22621 #: ../fish/guestfish.pod:437
22623 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22624 "then launch it, then mount any disks you need, and finally issue actions/"
22625 "commands. So the general order of the day is:"
22630 #: ../fish/guestfish.pod:445
22631 msgid "add or -a/--add"
22636 #: ../fish/guestfish.pod:449
22637 msgid "launch (aka run)"
22642 #: ../fish/guestfish.pod:453
22643 msgid "mount or -m/--mount"
22648 #: ../fish/guestfish.pod:457
22649 msgid "any other commands"
22654 #: ../fish/guestfish.pod:461
22656 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22657 "guest before mounting or performing any other commands."
22662 #: ../fish/guestfish.pod:464
22664 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22665 "I<--new> options were given then C<run> is done automatically, simply "
22666 "because guestfish can't perform the action you asked for without doing this."
22671 #: ../fish/guestfish.pod:469
22672 msgid "OPENING DISKS FOR READ AND WRITE"
22676 #: ../fish/guestfish.pod:471
22678 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22679 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22680 "I<-i> and I<-m> open disk images read-only or for writing."
22684 #: ../fish/guestfish.pod:476
22686 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
22687 "opening disk images supplied on the command line for write. To open a disk "
22688 "image read-only you have to do I<-a image --ro>."
22693 #: ../fish/guestfish.pod:480
22695 "This matters: If you accidentally open a live VM disk image writable then "
22696 "you will cause irreversible disk corruption."
22700 #: ../fish/guestfish.pod:483
22702 "By libguestfs 1.12 we intend to change the default the other way. Disk "
22703 "images will be opened read-only. You will have to either specify "
22704 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22705 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22706 "access for disk images specified by those other command line options."
22710 #: ../fish/guestfish.pod:490
22712 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22713 "which does nothing (it is already the default). However it is highly "
22714 "recommended that you use this option to indicate that you need write access, "
22715 "and prepare your scripts for the day when this option will be required for "
22721 #: ../fish/guestfish.pod:496
22723 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22724 "other libguestfs program apart from guestfish and guestmount."
22729 #: ../fish/guestfish.pod:499
22735 #: ../fish/guestfish.pod:501
22737 "You can quote ordinary parameters using either single or double quotes. For "
22743 #: ../fish/guestfish.pod:504
22746 " add \"file with a space.img\"\n"
22752 #: ../fish/guestfish.pod:506
22755 " rm '/file name'\n"
22761 #: ../fish/guestfish.pod:508
22770 #: ../fish/guestfish.pod:510
22772 "A few commands require a list of strings to be passed. For these, use a "
22773 "whitespace-separated list, enclosed in quotes. Strings containing "
22774 "whitespace to be passed through must be enclosed in single quotes. A "
22775 "literal single quote must be escaped with a backslash."
22780 #: ../fish/guestfish.pod:515
22783 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22784 " command \"/bin/echo 'foo bar'\"\n"
22785 " command \"/bin/echo \\'foo\\'\"\n"
22791 #: ../fish/guestfish.pod:519
22792 msgid "OPTIONAL ARGUMENTS"
22797 #: ../fish/guestfish.pod:521
22799 "Some commands take optional arguments. These arguments appear in this "
22800 "documentation as C<[argname:..]>. You can use them as in these examples:"
22805 #: ../fish/guestfish.pod:525
22808 " add-drive-opts filename\n"
22814 #: ../fish/guestfish.pod:527
22817 " add-drive-opts filename readonly:true\n"
22823 #: ../fish/guestfish.pod:529
22826 " add-drive-opts filename format:qcow2 readonly:false\n"
22832 #: ../fish/guestfish.pod:531
22834 "Each optional argument can appear at most once. All optional arguments must "
22835 "appear after the required ones."
22840 #: ../fish/guestfish.pod:534
22846 #: ../fish/guestfish.pod:536
22848 "This section applies to all commands which can take integers as parameters."
22853 #: ../fish/guestfish.pod:539
22854 msgid "SIZE SUFFIX"
22859 #: ../fish/guestfish.pod:541
22861 "When the command takes a parameter measured in bytes, you can use one of the "
22862 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22867 #: ../fish/guestfish.pod:547
22868 msgid "B<k> or B<K> or B<KiB>"
22873 #: ../fish/guestfish.pod:549
22874 msgid "The size in kilobytes (multiplied by 1024)."
22879 #: ../fish/guestfish.pod:551
22885 #: ../fish/guestfish.pod:553
22886 msgid "The size in SI 1000 byte units."
22891 #: ../fish/guestfish.pod:555
22892 msgid "B<M> or B<MiB>"
22897 #: ../fish/guestfish.pod:557
22898 msgid "The size in megabytes (multiplied by 1048576)."
22903 #: ../fish/guestfish.pod:559
22909 #: ../fish/guestfish.pod:561
22910 msgid "The size in SI 1000000 byte units."
22915 #: ../fish/guestfish.pod:563
22916 msgid "B<G> or B<GiB>"
22921 #: ../fish/guestfish.pod:565
22922 msgid "The size in gigabytes (multiplied by 2**30)."
22927 #: ../fish/guestfish.pod:567
22933 #: ../fish/guestfish.pod:569
22934 msgid "The size in SI 10**9 byte units."
22939 #: ../fish/guestfish.pod:571
22940 msgid "B<T> or B<TiB>"
22945 #: ../fish/guestfish.pod:573
22946 msgid "The size in terabytes (multiplied by 2**40)."
22951 #: ../fish/guestfish.pod:575
22957 #: ../fish/guestfish.pod:577
22958 msgid "The size in SI 10**12 byte units."
22963 #: ../fish/guestfish.pod:579
22964 msgid "B<P> or B<PiB>"
22969 #: ../fish/guestfish.pod:581
22970 msgid "The size in petabytes (multiplied by 2**50)."
22975 #: ../fish/guestfish.pod:583
22981 #: ../fish/guestfish.pod:585
22982 msgid "The size in SI 10**15 byte units."
22987 #: ../fish/guestfish.pod:587
22988 msgid "B<E> or B<EiB>"
22993 #: ../fish/guestfish.pod:589
22994 msgid "The size in exabytes (multiplied by 2**60)."
22999 #: ../fish/guestfish.pod:591
23005 #: ../fish/guestfish.pod:593
23006 msgid "The size in SI 10**18 byte units."
23011 #: ../fish/guestfish.pod:595
23012 msgid "B<Z> or B<ZiB>"
23017 #: ../fish/guestfish.pod:597
23018 msgid "The size in zettabytes (multiplied by 2**70)."
23023 #: ../fish/guestfish.pod:599
23029 #: ../fish/guestfish.pod:601
23030 msgid "The size in SI 10**21 byte units."
23035 #: ../fish/guestfish.pod:603
23036 msgid "B<Y> or B<YiB>"
23041 #: ../fish/guestfish.pod:605
23042 msgid "The size in yottabytes (multiplied by 2**80)."
23047 #: ../fish/guestfish.pod:607
23053 #: ../fish/guestfish.pod:609
23054 msgid "The size in SI 10**24 byte units."
23059 #: ../fish/guestfish.pod:615
23062 " truncate-size /file 1G\n"
23068 #: ../fish/guestfish.pod:617
23069 msgid "would truncate the file to 1 gigabyte."
23074 #: ../fish/guestfish.pod:619
23076 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
23077 "the parameter to L</memsize> is specified in megabytes already). Adding a "
23078 "suffix will probably not do what you expect."
23083 #: ../fish/guestfish.pod:623
23084 msgid "OCTAL AND HEXADECIMAL NUMBERS"
23089 #: ../fish/guestfish.pod:625
23091 "For specifying the radix (base) use the C convention: C<0> to prefix an "
23092 "octal number or C<0x> to prefix a hexadecimal number. For example:"
23097 #: ../fish/guestfish.pod:628
23100 " 1234 decimal number 1234\n"
23101 " 02322 octal number, equivalent to decimal 1234\n"
23102 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
23108 #: ../fish/guestfish.pod:632
23110 "When using the C<chmod> command, you almost always want to specify an octal "
23111 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
23112 "L<chmod(1)> program):"
23117 #: ../fish/guestfish.pod:636
23120 " chmod 0777 /public # OK\n"
23121 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
23127 #: ../fish/guestfish.pod:639
23129 "Commands that return numbers usually print them in decimal, but some "
23130 "commands print numbers in other radices (eg. C<umask> prints the mode in "
23131 "octal, preceeded by C<0>)."
23136 #: ../fish/guestfish.pod:643
23137 msgid "WILDCARDS AND GLOBBING"
23142 #: ../fish/guestfish.pod:645
23144 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
23145 "(globbing) by default. So for example the following will not do what you "
23151 #: ../fish/guestfish.pod:649
23160 #: ../fish/guestfish.pod:651
23162 "Assuming you don't have a directory called literally C</home/*> then the "
23163 "above command will return an error."
23168 #: ../fish/guestfish.pod:654
23169 msgid "To perform wildcard expansion, use the C<glob> command."
23174 #: ../fish/guestfish.pod:656
23177 " glob rm-rf /home/*\n"
23183 #: ../fish/guestfish.pod:658
23185 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23186 "many times), equivalent to:"
23191 #: ../fish/guestfish.pod:661
23194 " rm-rf /home/jim\n"
23195 " rm-rf /home/joe\n"
23196 " rm-rf /home/mary\n"
23202 #: ../fish/guestfish.pod:665
23203 msgid "C<glob> only works on simple guest paths and not on device names."
23208 #: ../fish/guestfish.pod:667
23210 "If you have several parameters, each containing a wildcard, then glob will "
23211 "perform a Cartesian product."
23216 #: ../fish/guestfish.pod:670
23222 #: ../fish/guestfish.pod:672
23224 "Any line which starts with a I<#> character is treated as a comment and "
23225 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23226 "a command. For example:"
23231 #: ../fish/guestfish.pod:676
23234 " # this is a comment\n"
23235 " # this is a comment\n"
23236 " foo # NOT a comment\n"
23242 #: ../fish/guestfish.pod:680
23243 msgid "Blank lines are also ignored."
23248 #: ../fish/guestfish.pod:682
23249 msgid "RUNNING COMMANDS LOCALLY"
23254 #: ../fish/guestfish.pod:684
23256 "Any line which starts with a I<!> character is treated as a command sent to "
23257 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23262 #: ../fish/guestfish.pod:688
23266 " tgz-out /remote local/remote-data.tar.gz\n"
23272 #: ../fish/guestfish.pod:691
23274 "will create a directory C<local> on the host, and then export the contents "
23275 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23276 "(See C<tgz-out>)."
23281 #: ../fish/guestfish.pod:695
23283 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23284 "effect, due to the way that subprocesses work in Unix."
23288 #: ../fish/guestfish.pod:698
23289 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23293 #: ../fish/guestfish.pod:700
23295 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23296 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23297 "and executed as guestfish commands."
23301 #: ../fish/guestfish.pod:704
23303 "Thus you can use shell script to construct arbitrary guestfish commands "
23304 "which are then parsed by guestfish."
23308 #: ../fish/guestfish.pod:707
23310 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23311 "through C</foo.100>) using guestfish commands alone. However this is simple "
23312 "if we use a shell script to create the guestfish commands for us:"
23316 #: ../fish/guestfish.pod:712
23319 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23324 #: ../fish/guestfish.pod:714
23325 msgid "or with names like C</foo.001>:"
23329 #: ../fish/guestfish.pod:716
23332 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23337 #: ../fish/guestfish.pod:718
23339 "When using guestfish interactively it can be helpful to just run the shell "
23340 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23341 "ordinary I<!> local command), see what guestfish commands it would run, and "
23342 "when you are happy with those prepend the C<E<lt>> character to run the "
23343 "guestfish commands for real."
23348 #: ../fish/guestfish.pod:724
23354 #: ../fish/guestfish.pod:726
23356 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23357 "command (a guestfish command) to the second command (any host command). For "
23363 #: ../fish/guestfish.pod:730
23366 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23372 #: ../fish/guestfish.pod:732
23374 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23375 "program). The above command would list all accounts in the guest filesystem "
23376 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23381 #: ../fish/guestfish.pod:737
23384 " hexdump /bin/ls | head\n"
23385 " list-devices | tail -1\n"
23386 " tgz-out / - | tar ztf -\n"
23392 #: ../fish/guestfish.pod:741
23394 "The space before the pipe symbol is required, any space after the pipe "
23395 "symbol is optional. Everything after the pipe symbol is just passed "
23396 "straight to the host shell, so it can contain redirections, globs and "
23397 "anything else that makes sense on the host side."
23402 #: ../fish/guestfish.pod:746
23404 "To use a literal argument which begins with a pipe symbol, you have to quote "
23410 #: ../fish/guestfish.pod:749
23419 #: ../fish/guestfish.pod:751
23420 msgid "HOME DIRECTORIES"
23425 #: ../fish/guestfish.pod:753
23427 "If a parameter starts with the character C<~> then the tilde may be expanded "
23428 "as a home directory path (either C<~> for the current user's home directory, "
23429 "or C<~user> for another user)."
23434 #: ../fish/guestfish.pod:757
23436 "Note that home directory expansion happens for users known I<on the host>, "
23437 "not in the guest filesystem."
23442 #: ../fish/guestfish.pod:760
23444 "To use a literal argument which begins with a tilde, you have to quote it, "
23450 #: ../fish/guestfish.pod:763
23459 #: ../fish/guestfish.pod:767
23461 "Libguestfs has some support for Linux guests encrypted according to the "
23462 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23463 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23464 "LUKS is supported."
23469 #: ../fish/guestfish.pod:772
23470 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23475 #: ../fish/guestfish.pod:774
23478 " ><fs> vfs-type /dev/sda2\n"
23485 #: ../fish/guestfish.pod:777
23487 "Then open those devices using L</luks-open>. This creates a device-mapper "
23488 "device called C</dev/mapper/luksdev>."
23493 #: ../fish/guestfish.pod:780
23496 " ><fs> luks-open /dev/sda2 luksdev\n"
23497 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23503 #: ../fish/guestfish.pod:783
23505 "Finally you have to tell LVM to scan for volume groups on the newly created "
23511 #: ../fish/guestfish.pod:786
23515 " vg-activate-all true\n"
23521 #: ../fish/guestfish.pod:789
23522 msgid "The logical volume(s) can now be mounted in the usual way."
23527 #: ../fish/guestfish.pod:791
23529 "Before closing a LUKS device you must unmount any logical volumes on it and "
23530 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23531 "one. Then you can close the mapper device:"
23536 #: ../fish/guestfish.pod:795
23539 " vg-activate false /dev/VG\n"
23540 " luks-close /dev/mapper/luksdev\n"
23546 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
23547 msgid "WINDOWS PATHS"
23551 #: ../fish/guestfish.pod:800
23553 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23554 "letters and paths (with some limitations). The following commands are "
23560 #: ../fish/guestfish.pod:804
23563 " file /WINDOWS/system32/config/system.LOG\n"
23569 #: ../fish/guestfish.pod:806
23572 " file win:\\windows\\system32\\config\\system.log\n"
23577 #: ../fish/guestfish.pod:808
23580 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23585 #: ../fish/guestfish.pod:810
23587 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23588 "where the drive is mounted, prepending that to the path, changing all "
23589 "backslash characters to forward slash, then resolving the result using L</"
23590 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23591 "the parameter might be rewritten like this:"
23595 #: ../fish/guestfish.pod:816
23598 " win:e:\\foo\\bar => /e/FOO/bar\n"
23603 #: ../fish/guestfish.pod:818
23604 msgid "This only works in argument positions that expect a path."
23609 #: ../fish/guestfish.pod:820
23610 msgid "UPLOADING AND DOWNLOADING FILES"
23615 #: ../fish/guestfish.pod:822
23617 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23618 "others which upload from or download to a local file, you can use the "
23619 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23624 #: ../fish/guestfish.pod:826
23633 #: ../fish/guestfish.pod:828
23635 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23640 #: ../fish/guestfish.pod:831
23643 " tar-out /etc - | tar tf -\n"
23649 #: ../fish/guestfish.pod:833
23651 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23652 "command (see L</PIPES>)."
23657 #: ../fish/guestfish.pod:836
23659 "When using C<-> to read from stdin, the input is read up to the end of "
23660 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23661 "some arbitrary end marker:"
23666 #: ../fish/guestfish.pod:840
23669 " upload -<<END /foo\n"
23679 #: ../fish/guestfish.pod:846
23681 "Any string of characters can be used instead of C<END>. The end marker must "
23682 "appear on a line of its own, without any preceeding or following characters "
23683 "(not even spaces)."
23688 #: ../fish/guestfish.pod:850
23690 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23691 "upload local files (so-called \"FileIn\" parameters in the generator)."
23696 #: ../fish/guestfish.pod:853
23697 msgid "EXIT ON ERROR BEHAVIOUR"
23702 #: ../fish/guestfish.pod:855
23704 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23705 "taking commands from a human over a tty), and will exit on the first error "
23706 "in non-interactive mode (scripts, commands given on the command line)."
23711 #: ../fish/guestfish.pod:860
23713 "If you prefix a command with a I<-> character, then that command will not "
23714 "cause guestfish to exit, even if that (one) command returns an error."
23719 #: ../fish/guestfish.pod:864
23720 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23725 #: ../fish/guestfish.pod:866
23727 "Guestfish can be remote-controlled over a socket. This is useful "
23728 "particularly in shell scripts where you want to make several different "
23729 "changes to a filesystem, but you don't want the overhead of starting up a "
23730 "guestfish process each time."
23735 #: ../fish/guestfish.pod:871
23736 msgid "Start a guestfish server process using:"
23741 #: ../fish/guestfish.pod:873
23744 " eval \"`guestfish --listen`\"\n"
23750 #: ../fish/guestfish.pod:875
23751 msgid "and then send it commands by doing:"
23756 #: ../fish/guestfish.pod:877
23759 " guestfish --remote cmd [...]\n"
23765 #: ../fish/guestfish.pod:879
23766 msgid "To cause the server to exit, send it the exit command:"
23771 #: ../fish/guestfish.pod:881
23774 " guestfish --remote exit\n"
23780 #: ../fish/guestfish.pod:883
23782 "Note that the server will normally exit if there is an error in a command. "
23783 "You can change this in the usual way. See section L</EXIT ON ERROR "
23789 #: ../fish/guestfish.pod:887
23790 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23795 #: ../fish/guestfish.pod:889
23797 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23798 "is how the I<--remote> option knows where to send the commands. You can "
23799 "have several guestfish listener processes running using:"
23804 #: ../fish/guestfish.pod:893
23807 " eval \"`guestfish --listen`\"\n"
23808 " pid1=$GUESTFISH_PID\n"
23809 " eval \"`guestfish --listen`\"\n"
23810 " pid2=$GUESTFISH_PID\n"
23812 " guestfish --remote=$pid1 cmd\n"
23813 " guestfish --remote=$pid2 cmd\n"
23819 #: ../fish/guestfish.pod:901
23820 msgid "REMOTE CONTROL AND CSH"
23825 #: ../fish/guestfish.pod:903
23827 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23833 #: ../fish/guestfish.pod:906
23836 " eval \"`guestfish --listen --csh`\"\n"
23842 #: ../fish/guestfish.pod:908
23843 msgid "REMOTE CONTROL DETAILS"
23848 #: ../fish/guestfish.pod:910
23850 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23851 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23852 "and C<$PID> is the process ID of the server."
23857 #: ../fish/guestfish.pod:914
23858 msgid "Guestfish client and server versions must match exactly."
23863 #: ../fish/guestfish.pod:916
23864 msgid "PREPARED DISK IMAGES"
23869 #: ../fish/guestfish.pod:918
23871 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23872 "preformatted disk images that guestfish can make for you to save typing. "
23873 "This is particularly useful for testing purposes. This option is used "
23874 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23875 "can be mixed with I<-a>)."
23880 #: ../fish/guestfish.pod:924
23882 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23883 "the second and so on. Existing files in the current directory are "
23889 #: ../fish/guestfish.pod:928
23891 "The type briefly describes how the disk should be sized, partitioned, how "
23892 "filesystem(s) should be created, and how content should be added. "
23893 "Optionally the type can be followed by extra parameters, separated by C<:> "
23894 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23895 "allocated disk, containing a single partition, with the partition formatted "
23896 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23902 #: ../fish/guestfish.pod:936
23903 msgid "To list the available types and any extra parameters they take, run:"
23908 #: ../fish/guestfish.pod:940
23910 "Note that the prepared filesystem is not mounted. You would usually have to "
23911 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23916 #: ../fish/guestfish.pod:944
23918 "If any I<-N> or I<--new> options are given, the guest is automatically "
23924 #: ../fish/guestfish.pod:949
23925 msgid "Create a 100MB disk with an ext4-formatted partition:"
23930 #: ../fish/guestfish.pod:951
23933 " guestfish -N fs:ext4\n"
23939 #: ../fish/guestfish.pod:953
23940 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23945 #: ../fish/guestfish.pod:955
23948 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23954 #: ../fish/guestfish.pod:957
23955 msgid "Create a blank 200MB disk:"
23960 #: ../fish/guestfish.pod:959
23963 " guestfish -N disk:200M\n"
23969 #: ../fish/guestfish.pod:961
23970 msgid "PROGRESS BARS"
23975 #: ../fish/guestfish.pod:963
23977 "Some (not all) long-running commands send progress notification messages as "
23978 "they are running. Guestfish turns these messages into progress bars."
23983 #: ../fish/guestfish.pod:967
23985 "When a command that supports progress bars takes longer than two seconds to "
23986 "run, and if progress bars are enabled, then you will see one appearing below "
23992 #: ../fish/guestfish.pod:971
23995 " ><fs> copy-size /large-file /another-file 2048M\n"
23996 " / 10% [#####-----------------------------------------] 00:30\n"
24002 #: ../fish/guestfish.pod:974
24004 "The spinner on the left hand side moves round once for every progress "
24005 "notification received from the backend. This is a (reasonably) golden "
24006 "assurance that the command is \"doing something\" even if the progress bar "
24007 "is not moving, because the command is able to send the progress "
24008 "notifications. When the bar reaches 100% and the command finishes, the "
24009 "spinner disappears."
24014 #: ../fish/guestfish.pod:981
24016 "Progress bars are enabled by default when guestfish is used interactively. "
24017 "You can enable them even for non-interactive modes using I<--progress-bars>, "
24018 "and you can disable them completely using I<--no-progress-bars>."
24023 #: ../fish/guestfish.pod:986
24024 msgid "GUESTFISH COMMANDS"
24029 #: ../fish/guestfish.pod:988
24031 "The commands in this section are guestfish convenience commands, in other "
24032 "words, they are not part of the L<guestfs(3)> API."
24037 #: ../fish/guestfish.pod:991
24043 #: ../fish/guestfish.pod:993
24053 #: ../fish/guestfish.pod:996
24054 msgid "Without any parameter, this provides general help."
24059 #: ../fish/guestfish.pod:998
24060 msgid "With a C<cmd> parameter, this displays detailed help for that command."
24065 #: ../fish/guestfish.pod:1000
24066 msgid "quit | exit"
24071 #: ../fish/guestfish.pod:1002
24072 msgid "This exits guestfish. You can also use C<^D> key."
24077 #: ../fish/guestfish.pod:1004
24078 msgid "@FISH_COMMANDS@"
24083 #: ../fish/guestfish.pod:1006
24089 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
24095 #: ../fish/guestfish.pod:1012
24097 "guestfish returns 0 if the commands completed without error, or 1 if there "
24103 #: ../fish/guestfish.pod:1019
24109 #: ../fish/guestfish.pod:1021
24111 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
24117 #: ../fish/guestfish.pod:1024
24118 msgid "GUESTFISH_PID"
24123 #: ../fish/guestfish.pod:1026
24125 "Used with the I<--remote> option to specify the remote guestfish process to "
24126 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
24131 #: ../fish/guestfish.pod:1030
24137 #: ../fish/guestfish.pod:1032
24139 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
24140 "not specified, the external L<hexedit(1)> program is used."
24145 #: ../fish/guestfish.pod:1036
24151 #: ../fish/guestfish.pod:1038
24153 "If compiled with GNU readline support, various files in the home directory "
24154 "can be used. See L</FILES>."
24159 #: ../fish/guestfish.pod:1047
24161 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24162 "effect as using the B<-v> option."
24167 #: ../fish/guestfish.pod:1059
24169 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24170 "the discussion of paths in L<guestfs(3)>."
24175 #: ../fish/guestfish.pod:1070
24176 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24181 #: ../fish/guestfish.pod:1072
24187 #: ../fish/guestfish.pod:1074
24189 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24195 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:252
24200 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:256
24201 msgid "$HOME/.libguestfs-tools.rc"
24205 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
24206 msgid "/etc/libguestfs-tools.conf"
24210 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
24212 "This configuration file controls the default read-only or read-write mode "
24213 "(I<--ro> or I<--rw>)."
24217 #: ../fish/guestfish.pod:1101
24218 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24223 #: ../fish/guestfish.pod:1103
24224 msgid "$HOME/.guestfish"
24229 #: ../fish/guestfish.pod:1105
24231 "If compiled with GNU readline support, then the command history is saved in "
24237 #: ../fish/guestfish.pod:1108
24238 msgid "$HOME/.inputrc"
24243 #: ../fish/guestfish.pod:1110
24244 msgid "/etc/inputrc"
24249 #: ../fish/guestfish.pod:1112
24251 "If compiled with GNU readline support, then these files can be used to "
24252 "configure readline. For further information, please see L<readline(3)/"
24253 "INITIALIZATION FILE>."
24258 #: ../fish/guestfish.pod:1116
24259 msgid "To write rules which only apply to guestfish, use:"
24264 #: ../fish/guestfish.pod:1118
24275 #: ../fish/guestfish.pod:1122
24277 "Variables that you can set in inputrc that change the behaviour of guestfish "
24278 "in useful ways include:"
24283 #: ../fish/guestfish.pod:1127
24284 msgid "completion-ignore-case (default: on)"
24289 #: ../fish/guestfish.pod:1129
24291 "By default, guestfish will ignore case when tab-completing paths on the "
24297 #: ../fish/guestfish.pod:1132
24300 " set completion-ignore-case off\n"
24306 #: ../fish/guestfish.pod:1134
24307 msgid "to make guestfish case sensitive."
24312 #: ../fish/guestfish.pod:1138
24318 #: ../fish/guestfish.pod:1140
24319 msgid "test2.img (etc)"
24323 #: ../fish/guestfish.pod:1142
24325 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
24326 "will be created in the file C<test1.img> in the current directory. The "
24327 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
24328 "the same name will be overwritten."
24332 #: ../fish/guestfish.pod:1151
24334 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24335 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24336 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24337 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24338 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24339 ">, L<hexedit(1)>."
24344 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
24345 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
24346 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
24347 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
24348 #: ../tools/virt-list-partitions.pl:277
24350 "This program is free software; you can redistribute it and/or modify it "
24351 "under the terms of the GNU General Public License as published by the Free "
24352 "Software Foundation; either version 2 of the License, or (at your option) "
24353 "any later version."
24358 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
24359 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
24360 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
24361 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
24362 #: ../tools/virt-list-partitions.pl:282
24364 "This program is distributed in the hope that it will be useful, but WITHOUT "
24365 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24366 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24372 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
24373 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
24374 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
24375 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
24376 #: ../tools/virt-list-partitions.pl:287
24378 "You should have received a copy of the GNU General Public License along with "
24379 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24380 "Ave, Cambridge, MA 02139, USA."
24385 #: ../fish/guestfish-actions.pod:1
24391 #: ../fish/guestfish-actions.pod:3
24394 " add-cdrom filename\n"
24400 #: ../fish/guestfish-actions.pod:15
24402 "This call checks for the existence of C<filename>. This stops you from "
24403 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24404 "and C<http:> URLs. To specify those, use the general L</config> call "
24410 #: ../fish/guestfish-actions.pod:22
24412 "If you just want to add an ISO file (often you use this as an efficient way "
24413 "to transfer large files into the guest), then you should probably use L</add-"
24414 "drive-ro> instead."
24419 #: ../fish/guestfish-actions.pod:35
24425 #: ../fish/guestfish-actions.pod:37
24430 #: ../fish/guestfish-actions.pod:39
24433 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24439 #: ../fish/guestfish-actions.pod:41
24441 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24442 "It works by connecting to libvirt, requesting the domain and domain XML from "
24443 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24448 #: ../fish/guestfish-actions.pod:71
24450 "The other optional parameters are passed directly through to L</add-drive-"
24456 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24457 #: ../fish/guestfish-actions.pod:3047
24459 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24464 #: ../fish/guestfish-actions.pod:76
24470 #: ../fish/guestfish-actions.pod:78
24473 " add-drive filename\n"
24479 #: ../fish/guestfish-actions.pod:80
24481 "This function is the equivalent of calling L</add-drive-opts> with no "
24482 "optional parameters, so the disk is added writable, with the format being "
24483 "detected automatically."
24488 #: ../fish/guestfish-actions.pod:84
24490 "Automatic detection of the format opens you up to a potential security hole "
24491 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24492 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24493 "you should think about replacing calls to this function with calls to L</add-"
24494 "drive-opts>, and specifying the format."
24499 #: ../fish/guestfish-actions.pod:91
24500 msgid "add-drive-opts"
24505 #: ../fish/guestfish-actions.pod:93
24511 #: ../fish/guestfish-actions.pod:95
24514 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24520 #: ../fish/guestfish-actions.pod:122
24522 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24523 "add-drive-ro>) then the format is automatically detected. Possible formats "
24524 "include C<raw> and C<qcow2>."
24529 #: ../fish/guestfish-actions.pod:133
24531 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24532 "add-drive-with-if> call (q.v.)"
24537 #: ../fish/guestfish-actions.pod:140
24538 msgid "add-drive-ro"
24543 #: ../fish/guestfish-actions.pod:142
24549 #: ../fish/guestfish-actions.pod:144
24552 " add-drive-ro filename\n"
24558 #: ../fish/guestfish-actions.pod:146
24560 "This function is the equivalent of calling L</add-drive-opts> with the "
24561 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24562 "is added read-only, with the format being detected automatically."
24567 #: ../fish/guestfish-actions.pod:151
24568 msgid "add-drive-ro-with-if"
24573 #: ../fish/guestfish-actions.pod:153
24576 " add-drive-ro-with-if filename iface\n"
24582 #: ../fish/guestfish-actions.pod:155
24584 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24585 "interface emulation to use at run time."
24590 #: ../fish/guestfish-actions.pod:165
24591 msgid "add-drive-with-if"
24596 #: ../fish/guestfish-actions.pod:167
24599 " add-drive-with-if filename iface\n"
24605 #: ../fish/guestfish-actions.pod:169
24607 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24608 "interface emulation to use at run time."
24613 #: ../fish/guestfish-actions.pod:179
24619 #: ../fish/guestfish-actions.pod:181
24622 " aug-clear augpath\n"
24628 #: ../fish/guestfish-actions.pod:186
24634 #: ../fish/guestfish-actions.pod:188
24643 #: ../fish/guestfish-actions.pod:190
24645 "Close the current Augeas handle and free up any resources used by it. After "
24646 "calling this, you have to call L</aug-init> again before you can use any "
24647 "other Augeas functions."
24652 #: ../fish/guestfish-actions.pod:195
24653 msgid "aug-defnode"
24658 #: ../fish/guestfish-actions.pod:197
24661 " aug-defnode name expr val\n"
24667 #: ../fish/guestfish-actions.pod:202
24669 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24670 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24671 "containing that single node."
24676 #: ../fish/guestfish-actions.pod:210
24682 #: ../fish/guestfish-actions.pod:212
24685 " aug-defvar name expr\n"
24691 #: ../fish/guestfish-actions.pod:221
24697 #: ../fish/guestfish-actions.pod:223
24700 " aug-get augpath\n"
24706 #: ../fish/guestfish-actions.pod:228
24712 #: ../fish/guestfish-actions.pod:230
24715 " aug-init root flags\n"
24721 #: ../fish/guestfish-actions.pod:236
24722 msgid "You must call this before using any other L</aug-*> commands."
24727 #: ../fish/guestfish-actions.pod:271
24728 msgid "Do not load the tree in L</aug-init>."
24733 #: ../fish/guestfish-actions.pod:275
24734 msgid "To close the handle, you can call L</aug-close>."
24739 #: ../fish/guestfish-actions.pod:279
24745 #: ../fish/guestfish-actions.pod:281
24748 " aug-insert augpath label true|false\n"
24754 #: ../fish/guestfish-actions.pod:291
24760 #: ../fish/guestfish-actions.pod:293
24769 #: ../fish/guestfish-actions.pod:300
24775 #: ../fish/guestfish-actions.pod:302
24778 " aug-ls augpath\n"
24784 #: ../fish/guestfish-actions.pod:304
24786 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24787 "resulting nodes into alphabetical order."
24792 #: ../fish/guestfish-actions.pod:307
24798 #: ../fish/guestfish-actions.pod:309
24801 " aug-match augpath\n"
24807 #: ../fish/guestfish-actions.pod:315
24813 #: ../fish/guestfish-actions.pod:317
24816 " aug-mv src dest\n"
24822 #: ../fish/guestfish-actions.pod:322
24828 #: ../fish/guestfish-actions.pod:324
24831 " aug-rm augpath\n"
24837 #: ../fish/guestfish-actions.pod:330
24843 #: ../fish/guestfish-actions.pod:332
24852 #: ../fish/guestfish-actions.pod:336
24854 "The flags which were passed to L</aug-init> affect exactly how files are "
24860 #: ../fish/guestfish-actions.pod:339
24866 #: ../fish/guestfish-actions.pod:341
24869 " aug-set augpath val\n"
24875 #: ../fish/guestfish-actions.pod:345
24877 "In the Augeas API, it is possible to clear a node by setting the value to "
24878 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24879 "this call. Instead you must use the L</aug-clear> call."
24884 #: ../fish/guestfish-actions.pod:350
24890 #: ../fish/guestfish-actions.pod:352
24893 " available 'groups ...'\n"
24899 #: ../fish/guestfish-actions.pod:358
24901 "The libguestfs groups, and the functions that those groups correspond to, "
24902 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24903 "runtime by calling L</available-all-groups>."
24908 #: ../fish/guestfish-actions.pod:382
24909 msgid "You must call L</launch> before calling this function."
24914 #: ../fish/guestfish-actions.pod:404
24916 "This call was added in version C<1.0.80>. In previous versions of "
24917 "libguestfs all you could do would be to speculatively execute a command to "
24918 "find out if the daemon implemented it. See also L</version>."
24923 #: ../fish/guestfish-actions.pod:411
24924 msgid "available-all-groups"
24929 #: ../fish/guestfish-actions.pod:413
24932 " available-all-groups\n"
24938 #: ../fish/guestfish-actions.pod:415
24940 "This command returns a list of all optional groups that this daemon knows "
24941 "about. Note this returns both supported and unsupported groups. To find "
24942 "out which ones the daemon can actually support you have to call L</"
24943 "available> on each member of the returned list."
24948 #: ../fish/guestfish-actions.pod:421
24949 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24954 #: ../fish/guestfish-actions.pod:423
24960 #: ../fish/guestfish-actions.pod:425
24963 " base64-in (base64file|-) filename\n"
24969 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24970 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24971 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24972 #: ../fish/guestfish-actions.pod:4445 ../fish/guestfish-actions.pod:4457
24973 #: ../fish/guestfish-actions.pod:4468 ../fish/guestfish-actions.pod:4479
24974 #: ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4540
24975 #: ../fish/guestfish-actions.pod:4594 ../fish/guestfish-actions.pod:4617
24976 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24981 #: ../fish/guestfish-actions.pod:432
24987 #: ../fish/guestfish-actions.pod:434
24990 " base64-out filename (base64file|-)\n"
24996 #: ../fish/guestfish-actions.pod:441
24997 msgid "blockdev-flushbufs"
25002 #: ../fish/guestfish-actions.pod:443
25005 " blockdev-flushbufs device\n"
25011 #: ../fish/guestfish-actions.pod:450
25012 msgid "blockdev-getbsz"
25017 #: ../fish/guestfish-actions.pod:452
25020 " blockdev-getbsz device\n"
25026 #: ../fish/guestfish-actions.pod:461
25027 msgid "blockdev-getro"
25032 #: ../fish/guestfish-actions.pod:463
25035 " blockdev-getro device\n"
25041 #: ../fish/guestfish-actions.pod:470
25042 msgid "blockdev-getsize64"
25047 #: ../fish/guestfish-actions.pod:472
25050 " blockdev-getsize64 device\n"
25056 #: ../fish/guestfish-actions.pod:476
25057 msgid "See also L</blockdev-getsz>."
25062 #: ../fish/guestfish-actions.pod:480
25063 msgid "blockdev-getss"
25068 #: ../fish/guestfish-actions.pod:482
25071 " blockdev-getss device\n"
25077 #: ../fish/guestfish-actions.pod:487
25079 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
25084 #: ../fish/guestfish-actions.pod:492
25085 msgid "blockdev-getsz"
25090 #: ../fish/guestfish-actions.pod:494
25093 " blockdev-getsz device\n"
25099 #: ../fish/guestfish-actions.pod:499
25101 "See also L</blockdev-getss> for the real sector size of the device, and L</"
25102 "blockdev-getsize64> for the more useful I<size in bytes>."
25107 #: ../fish/guestfish-actions.pod:505
25108 msgid "blockdev-rereadpt"
25113 #: ../fish/guestfish-actions.pod:507
25116 " blockdev-rereadpt device\n"
25122 #: ../fish/guestfish-actions.pod:513
25123 msgid "blockdev-setbsz"
25128 #: ../fish/guestfish-actions.pod:515
25131 " blockdev-setbsz device blocksize\n"
25137 #: ../fish/guestfish-actions.pod:524
25138 msgid "blockdev-setro"
25143 #: ../fish/guestfish-actions.pod:526
25146 " blockdev-setro device\n"
25152 #: ../fish/guestfish-actions.pod:532
25153 msgid "blockdev-setrw"
25158 #: ../fish/guestfish-actions.pod:534
25161 " blockdev-setrw device\n"
25167 #: ../fish/guestfish-actions.pod:540
25168 msgid "case-sensitive-path"
25173 #: ../fish/guestfish-actions.pod:542
25176 " case-sensitive-path path\n"
25182 #: ../fish/guestfish-actions.pod:566
25184 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25185 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25186 "the directories were originally created under Windows)."
25191 #: ../fish/guestfish-actions.pod:574
25192 msgid "See also L</realpath>."
25197 #: ../fish/guestfish-actions.pod:576
25203 #: ../fish/guestfish-actions.pod:578
25212 #: ../fish/guestfish-actions.pod:582
25214 "Note that this function cannot correctly handle binary files (specifically, "
25215 "files containing C<\\0> character which is treated as end of string). For "
25216 "those you need to use the L</read-file> or L</download> functions which have "
25217 "a more complex interface."
25222 #: ../fish/guestfish-actions.pod:590
25228 #: ../fish/guestfish-actions.pod:592
25231 " checksum csumtype path\n"
25237 #: ../fish/guestfish-actions.pod:635
25238 msgid "To get the checksum for a device, use L</checksum-device>."
25243 #: ../fish/guestfish-actions.pod:637
25244 msgid "To get the checksums for many files, use L</checksums-out>."
25249 #: ../fish/guestfish-actions.pod:639
25250 msgid "checksum-device"
25255 #: ../fish/guestfish-actions.pod:641
25258 " checksum-device csumtype device\n"
25264 #: ../fish/guestfish-actions.pod:643
25266 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25267 "device named C<device>. For the types of checksums supported see the L</"
25268 "checksum> command."
25273 #: ../fish/guestfish-actions.pod:647
25274 msgid "checksums-out"
25279 #: ../fish/guestfish-actions.pod:649
25282 " checksums-out csumtype directory (sumsfile|-)\n"
25288 #: ../fish/guestfish-actions.pod:665
25294 #: ../fish/guestfish-actions.pod:667
25297 " chmod mode path\n"
25303 #: ../fish/guestfish-actions.pod:678
25309 #: ../fish/guestfish-actions.pod:680
25312 " chown owner group path\n"
25318 #: ../fish/guestfish-actions.pod:688
25324 #: ../fish/guestfish-actions.pod:690
25327 " command 'arguments ...'\n"
25333 #: ../fish/guestfish-actions.pod:697
25335 "The single parameter is an argv-style list of arguments. The first element "
25336 "is the name of the program to run. Subsequent elements are parameters. The "
25337 "list must be non-empty (ie. must contain a program name). Note that the "
25338 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25343 #: ../fish/guestfish-actions.pod:725
25344 msgid "command-lines"
25349 #: ../fish/guestfish-actions.pod:727
25352 " command-lines 'arguments ...'\n"
25358 #: ../fish/guestfish-actions.pod:729
25360 "This is the same as L</command>, but splits the result into a list of lines."
25365 #: ../fish/guestfish-actions.pod:732
25366 msgid "See also: L</sh-lines>"
25371 #: ../fish/guestfish-actions.pod:737
25377 #: ../fish/guestfish-actions.pod:739
25380 " config qemuparam qemuvalue\n"
25386 #: ../fish/guestfish-actions.pod:750
25392 #: ../fish/guestfish-actions.pod:752
25395 " copy-size src dest size\n"
25401 #: ../fish/guestfish-actions.pod:760
25407 #: ../fish/guestfish-actions.pod:762
25416 #: ../fish/guestfish-actions.pod:767
25422 #: ../fish/guestfish-actions.pod:769
25431 #: ../fish/guestfish-actions.pod:774
25437 #: ../fish/guestfish-actions.pod:776
25446 #: ../fish/guestfish-actions.pod:783
25448 "If the destination is a device, it must be as large or larger than the "
25449 "source file or device, otherwise the copy will fail. This command cannot do "
25450 "partial copies (see L</copy-size>)."
25455 #: ../fish/guestfish-actions.pod:787
25461 #: ../fish/guestfish-actions.pod:789
25470 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25472 "This command is mostly useful for interactive sessions. It is I<not> "
25473 "intended that you try to parse the output string. Use L</statvfs> from "
25479 #: ../fish/guestfish-actions.pod:797
25485 #: ../fish/guestfish-actions.pod:799
25494 #: ../fish/guestfish-actions.pod:808
25500 #: ../fish/guestfish-actions.pod:810
25509 #: ../fish/guestfish-actions.pod:816
25511 "Another way to get the same information is to enable verbose messages with "
25512 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25513 "before running the program."
25518 #: ../fish/guestfish-actions.pod:821
25524 #: ../fish/guestfish-actions.pod:823
25527 " download remotefilename (filename|-)\n"
25533 #: ../fish/guestfish-actions.pod:830
25534 msgid "See also L</upload>, L</cat>."
25539 #: ../fish/guestfish-actions.pod:834
25540 msgid "download-offset"
25545 #: ../fish/guestfish-actions.pod:836
25548 " download-offset remotefilename (filename|-) offset size\n"
25554 #: ../fish/guestfish-actions.pod:844
25556 "Note that there is no limit on the amount of data that can be downloaded "
25557 "with this call, unlike with L</pread>, and this call always reads the full "
25558 "amount unless an error occurs."
25563 #: ../fish/guestfish-actions.pod:849
25564 msgid "See also L</download>, L</pread>."
25569 #: ../fish/guestfish-actions.pod:853
25570 msgid "drop-caches"
25575 #: ../fish/guestfish-actions.pod:855
25578 " drop-caches whattodrop\n"
25584 #: ../fish/guestfish-actions.pod:867
25590 #: ../fish/guestfish-actions.pod:869
25599 #: ../fish/guestfish-actions.pod:881
25605 #: ../fish/guestfish-actions.pod:883
25608 " e2fsck-f device\n"
25614 #: ../fish/guestfish-actions.pod:889
25616 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25617 "should use L</fsck>."
25622 #: ../fish/guestfish-actions.pod:892
25623 msgid "echo-daemon"
25628 #: ../fish/guestfish-actions.pod:894
25631 " echo-daemon 'words ...'\n"
25637 #: ../fish/guestfish-actions.pod:901
25638 msgid "See also L</ping-daemon>."
25643 #: ../fish/guestfish-actions.pod:903
25649 #: ../fish/guestfish-actions.pod:905
25652 " egrep regex path\n"
25658 #: ../fish/guestfish-actions.pod:913
25664 #: ../fish/guestfish-actions.pod:915
25667 " egrepi regex path\n"
25673 #: ../fish/guestfish-actions.pod:923
25679 #: ../fish/guestfish-actions.pod:925
25682 " equal file1 file2\n"
25688 #: ../fish/guestfish-actions.pod:932
25694 #: ../fish/guestfish-actions.pod:934
25703 #: ../fish/guestfish-actions.pod:939
25704 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25709 #: ../fish/guestfish-actions.pod:941
25715 #: ../fish/guestfish-actions.pod:943
25718 " fallocate path len\n"
25724 #: ../fish/guestfish-actions.pod:960
25725 msgid "fallocate64"
25730 #: ../fish/guestfish-actions.pod:962
25733 " fallocate64 path len\n"
25739 #: ../fish/guestfish-actions.pod:968
25741 "Note that this call allocates disk blocks for the file. To create a sparse "
25742 "file use L</truncate-size> instead."
25747 #: ../fish/guestfish-actions.pod:971
25749 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25750 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25751 "maximum size of files created through that call to 1GB."
25756 #: ../fish/guestfish-actions.pod:980
25762 #: ../fish/guestfish-actions.pod:982
25765 " fgrep pattern path\n"
25771 #: ../fish/guestfish-actions.pod:990
25777 #: ../fish/guestfish-actions.pod:992
25780 " fgrepi pattern path\n"
25786 #: ../fish/guestfish-actions.pod:1000
25792 #: ../fish/guestfish-actions.pod:1002
25801 #: ../fish/guestfish-actions.pod:1014
25803 "This command can also be used on C</dev/> devices (and partitions, LV "
25804 "names). You can for example use this to determine if a device contains a "
25805 "filesystem, although it's usually better to use L</vfs-type>."
25810 #: ../fish/guestfish-actions.pod:1024
25811 msgid "file-architecture"
25816 #: ../fish/guestfish-actions.pod:1026
25819 " file-architecture filename\n"
25825 #: ../fish/guestfish-actions.pod:1129
25831 #: ../fish/guestfish-actions.pod:1131
25840 #: ../fish/guestfish-actions.pod:1135
25842 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25843 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25848 #: ../fish/guestfish-actions.pod:1139
25854 #: ../fish/guestfish-actions.pod:1141
25857 " fill c len path\n"
25863 #: ../fish/guestfish-actions.pod:1147
25865 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25866 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25867 "L</fill-pattern>."
25872 #: ../fish/guestfish-actions.pod:1152
25873 msgid "fill-pattern"
25878 #: ../fish/guestfish-actions.pod:1154
25881 " fill-pattern pattern len path\n"
25887 #: ../fish/guestfish-actions.pod:1156
25889 "This function is like L</fill> except that it creates a new file of length "
25890 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25891 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25897 #: ../fish/guestfish-actions.pod:1161
25903 #: ../fish/guestfish-actions.pod:1163
25906 " find directory\n"
25912 #: ../fish/guestfish-actions.pod:1177
25913 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25918 #: ../fish/guestfish-actions.pod:1190
25919 msgid "See also L</find0>."
25924 #: ../fish/guestfish-actions.pod:1195
25930 #: ../fish/guestfish-actions.pod:1197
25933 " find0 directory (files|-)\n"
25939 #: ../fish/guestfish-actions.pod:1203
25941 "This command works the same way as L</find> with the following exceptions:"
25946 #: ../fish/guestfish-actions.pod:1230
25947 msgid "findfs-label"
25952 #: ../fish/guestfish-actions.pod:1232
25955 " findfs-label label\n"
25961 #: ../fish/guestfish-actions.pod:1238
25962 msgid "To find the label of a filesystem, use L</vfs-label>."
25967 #: ../fish/guestfish-actions.pod:1240
25968 msgid "findfs-uuid"
25973 #: ../fish/guestfish-actions.pod:1242
25976 " findfs-uuid uuid\n"
25982 #: ../fish/guestfish-actions.pod:1248
25983 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25988 #: ../fish/guestfish-actions.pod:1250
25994 #: ../fish/guestfish-actions.pod:1252
25997 " fsck fstype device\n"
26003 #: ../fish/guestfish-actions.pod:1282
26009 #: ../fish/guestfish-actions.pod:1284
26017 #: ../fish/guestfish-actions.pod:1291
26018 msgid "get-attach-method"
26022 #: ../fish/guestfish-actions.pod:1293
26025 " get-attach-method\n"
26030 #: ../fish/guestfish-actions.pod:1295
26031 msgid "Return the current attach method. See L</set-attach-method>."
26036 #: ../fish/guestfish-actions.pod:1297
26037 msgid "get-autosync"
26042 #: ../fish/guestfish-actions.pod:1299
26051 #: ../fish/guestfish-actions.pod:1303
26057 #: ../fish/guestfish-actions.pod:1305
26066 #: ../fish/guestfish-actions.pod:1309
26067 msgid "get-e2label"
26072 #: ../fish/guestfish-actions.pod:1311
26075 " get-e2label device\n"
26081 #: ../fish/guestfish-actions.pod:1323
26087 #: ../fish/guestfish-actions.pod:1325
26090 " get-e2uuid device\n"
26096 #: ../fish/guestfish-actions.pod:1337
26097 msgid "get-memsize"
26102 #: ../fish/guestfish-actions.pod:1339
26111 #: ../fish/guestfish-actions.pod:1344
26113 "If L</set-memsize> was not called on this handle, and if "
26114 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26115 "value for memsize."
26120 #: ../fish/guestfish-actions.pod:1351
26121 msgid "get-network"
26126 #: ../fish/guestfish-actions.pod:1353
26135 #: ../fish/guestfish-actions.pod:1357
26141 #: ../fish/guestfish-actions.pod:1359
26150 #: ../fish/guestfish-actions.pod:1366
26156 #: ../fish/guestfish-actions.pod:1368
26162 #: ../fish/guestfish-actions.pod:1370
26171 #: ../fish/guestfish-actions.pod:1377
26177 #: ../fish/guestfish-actions.pod:1379
26186 #: ../fish/guestfish-actions.pod:1386
26187 msgid "get-recovery-proc"
26192 #: ../fish/guestfish-actions.pod:1388
26195 " get-recovery-proc\n"
26201 #: ../fish/guestfish-actions.pod:1392
26202 msgid "get-selinux"
26207 #: ../fish/guestfish-actions.pod:1394
26216 #: ../fish/guestfish-actions.pod:1396
26218 "This returns the current setting of the selinux flag which is passed to the "
26219 "appliance at boot time. See L</set-selinux>."
26224 #: ../fish/guestfish-actions.pod:1402
26230 #: ../fish/guestfish-actions.pod:1404
26239 #: ../fish/guestfish-actions.pod:1411
26245 #: ../fish/guestfish-actions.pod:1413
26254 #: ../fish/guestfish-actions.pod:1417
26260 #: ../fish/guestfish-actions.pod:1419
26269 #: ../fish/guestfish-actions.pod:1421
26271 "Return the current umask. By default the umask is C<022> unless it has been "
26272 "set by calling L</umask>."
26277 #: ../fish/guestfish-actions.pod:1424
26278 msgid "get-verbose"
26283 #: ../fish/guestfish-actions.pod:1426
26292 #: ../fish/guestfish-actions.pod:1430
26298 #: ../fish/guestfish-actions.pod:1432
26307 #: ../fish/guestfish-actions.pod:1436
26308 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26313 #: ../fish/guestfish-actions.pod:1439
26319 #: ../fish/guestfish-actions.pod:1441
26322 " getxattr path name\n"
26328 #: ../fish/guestfish-actions.pod:1443
26330 "Get a single extended attribute from file C<path> named C<name>. This call "
26331 "follows symlinks. If you want to lookup an extended attribute for the "
26332 "symlink itself, use L</lgetxattr>."
26337 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2453
26339 "Normally it is better to get all extended attributes from a file in one go "
26340 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26341 "buggy and do not provide a way to list out attributes. For these "
26342 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26343 "attributes you want in advance and call this function."
26348 #: ../fish/guestfish-actions.pod:1457
26349 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26354 #: ../fish/guestfish-actions.pod:1459
26360 #: ../fish/guestfish-actions.pod:1461
26363 " getxattrs path\n"
26369 #: ../fish/guestfish-actions.pod:1469
26370 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26375 #: ../fish/guestfish-actions.pod:1471
26376 msgid "glob-expand"
26381 #: ../fish/guestfish-actions.pod:1473
26384 " glob-expand pattern\n"
26390 #: ../fish/guestfish-actions.pod:1486
26396 #: ../fish/guestfish-actions.pod:1488
26399 " grep regex path\n"
26405 #: ../fish/guestfish-actions.pod:1496
26411 #: ../fish/guestfish-actions.pod:1498
26414 " grepi regex path\n"
26420 #: ../fish/guestfish-actions.pod:1506
26421 msgid "grub-install"
26426 #: ../fish/guestfish-actions.pod:1508
26429 " grub-install root device\n"
26435 #: ../fish/guestfish-actions.pod:1524
26441 #: ../fish/guestfish-actions.pod:1526
26450 #: ../fish/guestfish-actions.pod:1534
26456 #: ../fish/guestfish-actions.pod:1536
26459 " head-n nrlines path\n"
26465 #: ../fish/guestfish-actions.pod:1549
26471 #: ../fish/guestfish-actions.pod:1551
26480 #: ../fish/guestfish-actions.pod:1559
26486 #: ../fish/guestfish-actions.pod:1561
26489 " initrd-cat initrdpath filename\n"
26495 #: ../fish/guestfish-actions.pod:1573
26496 msgid "See also L</initrd-list>."
26501 #: ../fish/guestfish-actions.pod:1578
26502 msgid "initrd-list"
26507 #: ../fish/guestfish-actions.pod:1580
26510 " initrd-list path\n"
26516 #: ../fish/guestfish-actions.pod:1592
26517 msgid "inotify-add-watch"
26522 #: ../fish/guestfish-actions.pod:1594
26525 " inotify-add-watch path mask\n"
26531 #: ../fish/guestfish-actions.pod:1606
26532 msgid "inotify-close"
26537 #: ../fish/guestfish-actions.pod:1608
26546 #: ../fish/guestfish-actions.pod:1614
26547 msgid "inotify-files"
26552 #: ../fish/guestfish-actions.pod:1616
26561 #: ../fish/guestfish-actions.pod:1618
26563 "This function is a helpful wrapper around L</inotify-read> which just "
26564 "returns a list of pathnames of objects that were touched. The returned "
26565 "pathnames are sorted and deduplicated."
26570 #: ../fish/guestfish-actions.pod:1622
26571 msgid "inotify-init"
26576 #: ../fish/guestfish-actions.pod:1624
26579 " inotify-init maxevents\n"
26585 #: ../fish/guestfish-actions.pod:1630
26587 "C<maxevents> is the maximum number of events which will be queued up between "
26588 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26589 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26590 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26591 "but records the fact that it threw them away by setting a flag "
26592 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26597 #: ../fish/guestfish-actions.pod:1640
26599 "Before any events are generated, you have to add some watches to the "
26600 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26601 "L</inotify-watch-all>."
26606 #: ../fish/guestfish-actions.pod:1646
26608 "Queued up events should be read periodically by calling L</inotify-read> (or "
26609 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26610 "If you don't read the events out often enough then you risk the internal "
26611 "queue overflowing."
26616 #: ../fish/guestfish-actions.pod:1653
26618 "The handle should be closed after use by calling L</inotify-close>. This "
26619 "also removes any watches automatically."
26624 #: ../fish/guestfish-actions.pod:1662
26625 msgid "inotify-read"
26630 #: ../fish/guestfish-actions.pod:1664
26639 #: ../fish/guestfish-actions.pod:1677
26640 msgid "inotify-rm-watch"
26645 #: ../fish/guestfish-actions.pod:1679
26648 " inotify-rm-watch wd\n"
26654 #: ../fish/guestfish-actions.pod:1681
26655 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26660 #: ../fish/guestfish-actions.pod:1684
26661 msgid "inspect-get-arch"
26666 #: ../fish/guestfish-actions.pod:1686
26669 " inspect-get-arch root\n"
26675 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26676 #: ../fish/guestfish-actions.pod:1790 ../fish/guestfish-actions.pod:1826
26677 #: ../fish/guestfish-actions.pod:1844 ../fish/guestfish-actions.pod:1878
26678 #: ../fish/guestfish-actions.pod:1893 ../fish/guestfish-actions.pod:1914
26679 #: ../fish/guestfish-actions.pod:1929 ../fish/guestfish-actions.pod:1962
26680 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:2008
26681 #: ../fish/guestfish-actions.pod:2025 ../fish/guestfish-actions.pod:2068
26682 #: ../fish/guestfish-actions.pod:2103 ../fish/guestfish-actions.pod:2119
26683 #: ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2148
26684 #: ../fish/guestfish-actions.pod:2161 ../fish/guestfish-actions.pod:2176
26686 "This function should only be called with a root device string as returned by "
26692 #: ../fish/guestfish-actions.pod:1691
26694 "This returns the architecture of the inspected operating system. The "
26695 "possible return values are listed under L</file-architecture>."
26700 #: ../fish/guestfish-actions.pod:1700
26701 msgid "inspect-get-distro"
26706 #: ../fish/guestfish-actions.pod:1702
26709 " inspect-get-distro root\n"
26714 #: ../fish/guestfish-actions.pod:1786
26715 msgid "inspect-get-drive-mappings"
26719 #: ../fish/guestfish-actions.pod:1788
26722 " inspect-get-drive-mappings root\n"
26727 #: ../fish/guestfish-actions.pod:1818
26729 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26730 "get-mountpoints>, L</inspect-get-filesystems>."
26735 #: ../fish/guestfish-actions.pod:1822
26736 msgid "inspect-get-filesystems"
26741 #: ../fish/guestfish-actions.pod:1824
26744 " inspect-get-filesystems root\n"
26750 #: ../fish/guestfish-actions.pod:1837
26752 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26753 "get-mountpoints>."
26757 #: ../fish/guestfish-actions.pod:1840
26758 msgid "inspect-get-format"
26762 #: ../fish/guestfish-actions.pod:1842
26765 " inspect-get-format root\n"
26771 #: ../fish/guestfish-actions.pod:1874
26772 msgid "inspect-get-hostname"
26777 #: ../fish/guestfish-actions.pod:1876
26780 " inspect-get-hostname root\n"
26786 #: ../fish/guestfish-actions.pod:1889
26787 msgid "inspect-get-major-version"
26792 #: ../fish/guestfish-actions.pod:1891
26795 " inspect-get-major-version root\n"
26801 #: ../fish/guestfish-actions.pod:1910
26802 msgid "inspect-get-minor-version"
26807 #: ../fish/guestfish-actions.pod:1912
26810 " inspect-get-minor-version root\n"
26816 #: ../fish/guestfish-actions.pod:1922
26818 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26819 "get-major-version>."
26824 #: ../fish/guestfish-actions.pod:1925
26825 msgid "inspect-get-mountpoints"
26830 #: ../fish/guestfish-actions.pod:1927
26833 " inspect-get-mountpoints root\n"
26838 #: ../fish/guestfish-actions.pod:1949
26840 "For operating systems like Windows which still use drive letters, this call "
26841 "will only return an entry for the first drive \"mounted on\" C</>. For "
26842 "information about the mapping of drive letters to partitions, see L</inspect-"
26843 "get-drive-mappings>."
26848 #: ../fish/guestfish-actions.pod:1955
26850 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26851 "get-filesystems>."
26856 #: ../fish/guestfish-actions.pod:1958
26857 msgid "inspect-get-package-format"
26862 #: ../fish/guestfish-actions.pod:1960
26865 " inspect-get-package-format root\n"
26871 #: ../fish/guestfish-actions.pod:1965
26873 "This function and L</inspect-get-package-management> return the package "
26874 "format and package management tool used by the inspected operating system. "
26875 "For example for Fedora these functions would return C<rpm> (package format) "
26876 "and C<yum> (package management)."
26881 #: ../fish/guestfish-actions.pod:1980
26882 msgid "inspect-get-package-management"
26887 #: ../fish/guestfish-actions.pod:1982
26890 " inspect-get-package-management root\n"
26896 #: ../fish/guestfish-actions.pod:1987
26898 "L</inspect-get-package-format> and this function return the package format "
26899 "and package management tool used by the inspected operating system. For "
26900 "example for Fedora these functions would return C<rpm> (package format) and "
26901 "C<yum> (package management)."
26906 #: ../fish/guestfish-actions.pod:2004
26907 msgid "inspect-get-product-name"
26912 #: ../fish/guestfish-actions.pod:2006
26915 " inspect-get-product-name root\n"
26920 #: ../fish/guestfish-actions.pod:2021
26921 msgid "inspect-get-product-variant"
26925 #: ../fish/guestfish-actions.pod:2023
26928 " inspect-get-product-variant root\n"
26933 #: ../fish/guestfish-actions.pod:2047
26935 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26936 "get-product-name>, L</inspect-get-major-version>."
26941 #: ../fish/guestfish-actions.pod:2051
26942 msgid "inspect-get-roots"
26947 #: ../fish/guestfish-actions.pod:2053
26950 " inspect-get-roots\n"
26956 #: ../fish/guestfish-actions.pod:2055
26958 "This function is a convenient way to get the list of root devices, as "
26959 "returned from a previous call to L</inspect-os>, but without redoing the "
26960 "whole inspection process."
26965 #: ../fish/guestfish-actions.pod:2059
26967 "This returns an empty list if either no root devices were found or the "
26968 "caller has not called L</inspect-os>."
26973 #: ../fish/guestfish-actions.pod:2064
26974 msgid "inspect-get-type"
26979 #: ../fish/guestfish-actions.pod:2066
26982 " inspect-get-type root\n"
26987 #: ../fish/guestfish-actions.pod:2099
26988 msgid "inspect-get-windows-current-control-set"
26992 #: ../fish/guestfish-actions.pod:2101
26995 " inspect-get-windows-current-control-set root\n"
27001 #: ../fish/guestfish-actions.pod:2115
27002 msgid "inspect-get-windows-systemroot"
27007 #: ../fish/guestfish-actions.pod:2117
27010 " inspect-get-windows-systemroot root\n"
27015 #: ../fish/guestfish-actions.pod:2131
27016 msgid "inspect-is-live"
27020 #: ../fish/guestfish-actions.pod:2133
27023 " inspect-is-live root\n"
27028 #: ../fish/guestfish-actions.pod:2138
27030 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27031 "then this returns true if a live image was detected on the disk."
27035 #: ../fish/guestfish-actions.pod:2144
27036 msgid "inspect-is-multipart"
27040 #: ../fish/guestfish-actions.pod:2146
27043 " inspect-is-multipart root\n"
27048 #: ../fish/guestfish-actions.pod:2151
27050 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27051 "then this returns true if the disk is part of a set."
27055 #: ../fish/guestfish-actions.pod:2157
27056 msgid "inspect-is-netinst"
27060 #: ../fish/guestfish-actions.pod:2159
27063 " inspect-is-netinst root\n"
27068 #: ../fish/guestfish-actions.pod:2164
27070 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
27071 "then this returns true if the disk is a network installer, ie. not a self-"
27072 "contained install CD but one which is likely to require network access to "
27073 "complete the install."
27078 #: ../fish/guestfish-actions.pod:2172
27079 msgid "inspect-list-applications"
27084 #: ../fish/guestfish-actions.pod:2174
27087 " inspect-list-applications root\n"
27093 #: ../fish/guestfish-actions.pod:2181
27095 "I<Note:> This call works differently from other parts of the inspection "
27096 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
27097 "then mount up the disks, before calling this. Listing applications is a "
27098 "significantly more difficult operation which requires access to the full "
27099 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
27100 "are just returning data cached in the libguestfs handle, this call actually "
27101 "reads parts of the mounted filesystems during the call."
27106 #: ../fish/guestfish-actions.pod:2271
27112 #: ../fish/guestfish-actions.pod:2273
27121 #: ../fish/guestfish-actions.pod:2288
27123 "You can pass the root string(s) returned to other L</inspect-get-*> "
27124 "functions in order to query further information about each operating system, "
27125 "such as the name and version."
27130 #: ../fish/guestfish-actions.pod:2293
27132 "This function uses other libguestfs features such as L</mount-ro> and L</"
27133 "umount-all> in order to mount and unmount filesystems and look at the "
27134 "contents. This should be called with no disks currently mounted. The "
27135 "function may also use Augeas, so any existing Augeas handle will be closed."
27140 #: ../fish/guestfish-actions.pod:2305 ../fish/guestfish-actions.pod:2481
27141 #: ../fish/guestfish-actions.pod:2527
27142 msgid "See also L</list-filesystems>."
27147 #: ../fish/guestfish-actions.pod:2307
27148 msgid "is-blockdev"
27153 #: ../fish/guestfish-actions.pod:2309
27156 " is-blockdev path\n"
27162 #: ../fish/guestfish-actions.pod:2314 ../fish/guestfish-actions.pod:2332
27163 #: ../fish/guestfish-actions.pod:2351 ../fish/guestfish-actions.pod:2360
27164 #: ../fish/guestfish-actions.pod:2370 ../fish/guestfish-actions.pod:2404
27165 #: ../fish/guestfish-actions.pod:2413
27166 msgid "See also L</stat>."
27171 #: ../fish/guestfish-actions.pod:2316
27177 #: ../fish/guestfish-actions.pod:2318
27186 #: ../fish/guestfish-actions.pod:2325
27192 #: ../fish/guestfish-actions.pod:2327
27195 " is-chardev path\n"
27201 #: ../fish/guestfish-actions.pod:2334
27207 #: ../fish/guestfish-actions.pod:2336
27216 #: ../fish/guestfish-actions.pod:2343
27222 #: ../fish/guestfish-actions.pod:2345
27231 #: ../fish/guestfish-actions.pod:2353
27237 #: ../fish/guestfish-actions.pod:2355
27246 #: ../fish/guestfish-actions.pod:2362
27252 #: ../fish/guestfish-actions.pod:2364
27261 #: ../fish/guestfish-actions.pod:2372
27262 msgid "is-launching"
27267 #: ../fish/guestfish-actions.pod:2374
27276 #: ../fish/guestfish-actions.pod:2381
27282 #: ../fish/guestfish-actions.pod:2383
27291 #: ../fish/guestfish-actions.pod:2388
27297 #: ../fish/guestfish-actions.pod:2390
27306 #: ../fish/guestfish-actions.pod:2397
27312 #: ../fish/guestfish-actions.pod:2399
27315 " is-socket path\n"
27321 #: ../fish/guestfish-actions.pod:2406
27327 #: ../fish/guestfish-actions.pod:2408
27330 " is-symlink path\n"
27336 #: ../fish/guestfish-actions.pod:2415
27337 msgid "kill-subprocess"
27342 #: ../fish/guestfish-actions.pod:2417
27345 " kill-subprocess\n"
27351 #: ../fish/guestfish-actions.pod:2421
27357 #: ../fish/guestfish-actions.pod:2423
27363 #: ../fish/guestfish-actions.pod:2425
27372 #: ../fish/guestfish-actions.pod:2433
27378 #: ../fish/guestfish-actions.pod:2435
27381 " lchown owner group path\n"
27387 #: ../fish/guestfish-actions.pod:2437
27389 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27390 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27396 #: ../fish/guestfish-actions.pod:2445
27402 #: ../fish/guestfish-actions.pod:2447
27405 " lgetxattr path name\n"
27411 #: ../fish/guestfish-actions.pod:2463
27412 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27417 #: ../fish/guestfish-actions.pod:2465
27423 #: ../fish/guestfish-actions.pod:2467
27426 " lgetxattrs path\n"
27432 #: ../fish/guestfish-actions.pod:2469
27434 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27435 "it returns the extended attributes of the link itself."
27440 #: ../fish/guestfish-actions.pod:2473
27441 msgid "list-devices"
27446 #: ../fish/guestfish-actions.pod:2475
27455 #: ../fish/guestfish-actions.pod:2483
27456 msgid "list-filesystems"
27461 #: ../fish/guestfish-actions.pod:2485
27464 " list-filesystems\n"
27470 #: ../fish/guestfish-actions.pod:2504
27472 "This command runs other libguestfs commands, which might include L</mount> "
27473 "and L</umount>, and therefore you should use this soon after launch and only "
27474 "when nothing is mounted."
27479 #: ../fish/guestfish-actions.pod:2508
27481 "Not all of the filesystems returned will be mountable. In particular, swap "
27482 "partitions are returned in the list. Also this command does not check that "
27483 "each filesystem found is valid and mountable, and some filesystems might be "
27484 "mountable but require special options. Filesystems may not all belong to a "
27485 "single logical operating system (use L</inspect-os> to look for OSes)."
27490 #: ../fish/guestfish-actions.pod:2516
27491 msgid "list-partitions"
27496 #: ../fish/guestfish-actions.pod:2518
27499 " list-partitions\n"
27505 #: ../fish/guestfish-actions.pod:2524
27507 "This does not return logical volumes. For that you will need to call L</"
27513 #: ../fish/guestfish-actions.pod:2529
27519 #: ../fish/guestfish-actions.pod:2531
27528 #: ../fish/guestfish-actions.pod:2539
27534 #: ../fish/guestfish-actions.pod:2541
27537 " ln target linkname\n"
27543 #: ../fish/guestfish-actions.pod:2545
27549 #: ../fish/guestfish-actions.pod:2547
27552 " ln-f target linkname\n"
27558 #: ../fish/guestfish-actions.pod:2552
27564 #: ../fish/guestfish-actions.pod:2554
27567 " ln-s target linkname\n"
27573 #: ../fish/guestfish-actions.pod:2558
27579 #: ../fish/guestfish-actions.pod:2560
27582 " ln-sf target linkname\n"
27588 #: ../fish/guestfish-actions.pod:2565
27589 msgid "lremovexattr"
27594 #: ../fish/guestfish-actions.pod:2567
27597 " lremovexattr xattr path\n"
27603 #: ../fish/guestfish-actions.pod:2569
27605 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27606 "it removes an extended attribute of the link itself."
27611 #: ../fish/guestfish-actions.pod:2573
27617 #: ../fish/guestfish-actions.pod:2575
27626 #: ../fish/guestfish-actions.pod:2581
27628 "This command is mostly useful for interactive sessions. Programs should "
27629 "probably use L</readdir> instead."
27634 #: ../fish/guestfish-actions.pod:2584
27640 #: ../fish/guestfish-actions.pod:2586
27643 " lsetxattr xattr val vallen path\n"
27649 #: ../fish/guestfish-actions.pod:2588
27651 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27652 "sets an extended attribute of the link itself."
27657 #: ../fish/guestfish-actions.pod:2592
27663 #: ../fish/guestfish-actions.pod:2594
27672 #: ../fish/guestfish-actions.pod:2598
27674 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27675 "the link is stat-ed, not the file it refers to."
27680 #: ../fish/guestfish-actions.pod:2604
27686 #: ../fish/guestfish-actions.pod:2606
27689 " lstatlist path 'names ...'\n"
27695 #: ../fish/guestfish-actions.pod:2608
27697 "This call allows you to perform the L</lstat> operation on multiple files, "
27698 "where all files are in the directory C<path>. C<names> is the list of files "
27699 "from this directory."
27704 #: ../fish/guestfish-actions.pod:2617
27706 "This call is intended for programs that want to efficiently list a directory "
27707 "contents without making many round-trips. See also L</lxattrlist> for a "
27708 "similarly efficient call for getting extended attributes. Very long "
27709 "directory listings might cause the protocol message size to be exceeded, "
27710 "causing this call to fail. The caller must split up such requests into "
27711 "smaller groups of names."
27716 #: ../fish/guestfish-actions.pod:2625
27717 msgid "luks-add-key"
27722 #: ../fish/guestfish-actions.pod:2627
27725 " luks-add-key device keyslot\n"
27731 #: ../fish/guestfish-actions.pod:2634
27733 "Note that if C<keyslot> already contains a key, then this command will "
27734 "fail. You have to use L</luks-kill-slot> first to remove that key."
27739 #: ../fish/guestfish-actions.pod:2638 ../fish/guestfish-actions.pod:2660
27740 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2687
27741 #: ../fish/guestfish-actions.pod:2710 ../fish/guestfish-actions.pod:2720
27743 "This command has one or more key or passphrase parameters. Guestfish will "
27744 "prompt for these separately."
27749 #: ../fish/guestfish-actions.pod:2641
27755 #: ../fish/guestfish-actions.pod:2643
27758 " luks-close device\n"
27764 #: ../fish/guestfish-actions.pod:2645
27766 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27767 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27768 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27774 #: ../fish/guestfish-actions.pod:2651
27775 msgid "luks-format"
27780 #: ../fish/guestfish-actions.pod:2653
27783 " luks-format device keyslot\n"
27789 #: ../fish/guestfish-actions.pod:2666
27790 msgid "luks-format-cipher"
27795 #: ../fish/guestfish-actions.pod:2668
27798 " luks-format-cipher device keyslot cipher\n"
27804 #: ../fish/guestfish-actions.pod:2670
27806 "This command is the same as L</luks-format> but it also allows you to set "
27807 "the C<cipher> used."
27812 #: ../fish/guestfish-actions.pod:2679
27813 msgid "luks-kill-slot"
27818 #: ../fish/guestfish-actions.pod:2681
27821 " luks-kill-slot device keyslot\n"
27827 #: ../fish/guestfish-actions.pod:2690
27833 #: ../fish/guestfish-actions.pod:2692
27836 " luks-open device mapname\n"
27842 #: ../fish/guestfish-actions.pod:2706
27844 "If this block device contains LVM volume groups, then calling L</vgscan> "
27845 "followed by L</vg-activate-all> will make them visible."
27850 #: ../fish/guestfish-actions.pod:2713
27851 msgid "luks-open-ro"
27856 #: ../fish/guestfish-actions.pod:2715
27859 " luks-open-ro device mapname\n"
27865 #: ../fish/guestfish-actions.pod:2717
27867 "This is the same as L</luks-open> except that a read-only mapping is created."
27872 #: ../fish/guestfish-actions.pod:2723
27878 #: ../fish/guestfish-actions.pod:2725
27881 " lvcreate logvol volgroup mbytes\n"
27887 #: ../fish/guestfish-actions.pod:2730
27888 msgid "lvm-canonical-lv-name"
27893 #: ../fish/guestfish-actions.pod:2732
27896 " lvm-canonical-lv-name lvname\n"
27902 #: ../fish/guestfish-actions.pod:2741
27903 msgid "See also L</is-lv>."
27908 #: ../fish/guestfish-actions.pod:2743
27909 msgid "lvm-clear-filter"
27914 #: ../fish/guestfish-actions.pod:2745
27917 " lvm-clear-filter\n"
27923 #: ../fish/guestfish-actions.pod:2747
27925 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27931 #: ../fish/guestfish-actions.pod:2753
27932 msgid "lvm-remove-all"
27937 #: ../fish/guestfish-actions.pod:2755
27940 " lvm-remove-all\n"
27946 #: ../fish/guestfish-actions.pod:2763
27947 msgid "lvm-set-filter"
27952 #: ../fish/guestfish-actions.pod:2765
27955 " lvm-set-filter 'devices ...'\n"
27961 #: ../fish/guestfish-actions.pod:2790
27967 #: ../fish/guestfish-actions.pod:2792
27970 " lvremove device\n"
27976 #: ../fish/guestfish-actions.pod:2800
27982 #: ../fish/guestfish-actions.pod:2802
27985 " lvrename logvol newlogvol\n"
27991 #: ../fish/guestfish-actions.pod:2806
27997 #: ../fish/guestfish-actions.pod:2808
28000 " lvresize device mbytes\n"
28006 #: ../fish/guestfish-actions.pod:2814
28007 msgid "lvresize-free"
28012 #: ../fish/guestfish-actions.pod:2816
28015 " lvresize-free lv percent\n"
28021 #: ../fish/guestfish-actions.pod:2824
28027 #: ../fish/guestfish-actions.pod:2826
28036 #: ../fish/guestfish-actions.pod:2834
28037 msgid "See also L</lvs-full>, L</list-filesystems>."
28042 #: ../fish/guestfish-actions.pod:2836
28048 #: ../fish/guestfish-actions.pod:2838
28057 #: ../fish/guestfish-actions.pod:2843
28063 #: ../fish/guestfish-actions.pod:2845
28072 #: ../fish/guestfish-actions.pod:2849
28078 #: ../fish/guestfish-actions.pod:2851
28081 " lxattrlist path 'names ...'\n"
28087 #: ../fish/guestfish-actions.pod:2867
28089 "This call is intended for programs that want to efficiently list a directory "
28090 "contents without making many round-trips. See also L</lstatlist> for a "
28091 "similarly efficient call for getting standard stats. Very long directory "
28092 "listings might cause the protocol message size to be exceeded, causing this "
28093 "call to fail. The caller must split up such requests into smaller groups of "
28099 #: ../fish/guestfish-actions.pod:2875
28105 #: ../fish/guestfish-actions.pod:2877
28114 #: ../fish/guestfish-actions.pod:2881
28120 #: ../fish/guestfish-actions.pod:2883
28123 " mkdir-mode path mode\n"
28129 #: ../fish/guestfish-actions.pod:2892
28130 msgid "See also L</mkdir>, L</umask>"
28135 #: ../fish/guestfish-actions.pod:2894
28141 #: ../fish/guestfish-actions.pod:2896
28150 #: ../fish/guestfish-actions.pod:2901
28156 #: ../fish/guestfish-actions.pod:2903
28159 " mkdtemp template\n"
28165 #: ../fish/guestfish-actions.pod:2924
28171 #: ../fish/guestfish-actions.pod:2926
28174 " mke2fs-J fstype blocksize device journal\n"
28180 #: ../fish/guestfish-actions.pod:2934
28181 msgid "See also L</mke2journal>."
28186 #: ../fish/guestfish-actions.pod:2936
28192 #: ../fish/guestfish-actions.pod:2938
28195 " mke2fs-JL fstype blocksize device label\n"
28201 #: ../fish/guestfish-actions.pod:2943
28202 msgid "See also L</mke2journal-L>."
28207 #: ../fish/guestfish-actions.pod:2945
28213 #: ../fish/guestfish-actions.pod:2947
28216 " mke2fs-JU fstype blocksize device uuid\n"
28222 #: ../fish/guestfish-actions.pod:2952
28223 msgid "See also L</mke2journal-U>."
28228 #: ../fish/guestfish-actions.pod:2954
28229 msgid "mke2journal"
28234 #: ../fish/guestfish-actions.pod:2956
28237 " mke2journal blocksize device\n"
28243 #: ../fish/guestfish-actions.pod:2963
28244 msgid "mke2journal-L"
28249 #: ../fish/guestfish-actions.pod:2965
28252 " mke2journal-L blocksize label device\n"
28258 #: ../fish/guestfish-actions.pod:2969
28259 msgid "mke2journal-U"
28264 #: ../fish/guestfish-actions.pod:2971
28267 " mke2journal-U blocksize uuid device\n"
28273 #: ../fish/guestfish-actions.pod:2975
28279 #: ../fish/guestfish-actions.pod:2977
28282 " mkfifo mode path\n"
28288 #: ../fish/guestfish-actions.pod:2979
28290 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28291 "is just a convenient wrapper around L</mknod>."
28296 #: ../fish/guestfish-actions.pod:2985
28302 #: ../fish/guestfish-actions.pod:2987
28305 " mkfs fstype device\n"
28311 #: ../fish/guestfish-actions.pod:2993
28317 #: ../fish/guestfish-actions.pod:2995
28320 " mkfs-b fstype blocksize device\n"
28326 #: ../fish/guestfish-actions.pod:2997
28328 "This call is similar to L</mkfs>, but it allows you to control the block "
28329 "size of the resulting filesystem. Supported block sizes depend on the "
28330 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28335 #: ../fish/guestfish-actions.pod:3012
28340 #: ../fish/guestfish-actions.pod:3014
28343 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28349 #: ../fish/guestfish-actions.pod:3049
28350 msgid "mkmountpoint"
28355 #: ../fish/guestfish-actions.pod:3051
28358 " mkmountpoint exemptpath\n"
28364 #: ../fish/guestfish-actions.pod:3053
28366 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28367 "to create extra mountpoints before mounting the first filesystem."
28372 #: ../fish/guestfish-actions.pod:3077
28374 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28375 "unexpected errors if you try to mix these calls. It is safest to manually "
28376 "unmount filesystems and remove mountpoints after use."
28381 #: ../fish/guestfish-actions.pod:3081
28383 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28384 "for this to work for manual mountpoints, you must ensure that the innermost "
28385 "mountpoints have the longest pathnames, as in the example code above."
28389 #: ../fish/guestfish-actions.pod:3088
28391 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28392 "L</umount-all> to be called when the handle is closed which can also trigger "
28398 #: ../fish/guestfish-actions.pod:3092
28404 #: ../fish/guestfish-actions.pod:3094
28407 " mknod mode devmajor devminor path\n"
28413 #: ../fish/guestfish-actions.pod:3104
28415 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28416 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28417 "regular file). These constants are available in the standard Linux header "
28418 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28419 "wrappers around this command which bitwise OR in the appropriate constant "
28425 #: ../fish/guestfish-actions.pod:3114
28431 #: ../fish/guestfish-actions.pod:3116
28434 " mknod-b mode devmajor devminor path\n"
28440 #: ../fish/guestfish-actions.pod:3118
28442 "This call creates a block device node called C<path> with mode C<mode> and "
28443 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28444 "wrapper around L</mknod>."
28449 #: ../fish/guestfish-actions.pod:3124
28455 #: ../fish/guestfish-actions.pod:3126
28458 " mknod-c mode devmajor devminor path\n"
28464 #: ../fish/guestfish-actions.pod:3128
28466 "This call creates a char device node called C<path> with mode C<mode> and "
28467 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28468 "wrapper around L</mknod>."
28473 #: ../fish/guestfish-actions.pod:3134
28479 #: ../fish/guestfish-actions.pod:3136
28488 #: ../fish/guestfish-actions.pod:3140
28494 #: ../fish/guestfish-actions.pod:3142
28497 " mkswap-L label device\n"
28503 #: ../fish/guestfish-actions.pod:3150
28509 #: ../fish/guestfish-actions.pod:3152
28512 " mkswap-U uuid device\n"
28518 #: ../fish/guestfish-actions.pod:3156
28519 msgid "mkswap-file"
28524 #: ../fish/guestfish-actions.pod:3158
28527 " mkswap-file path\n"
28533 #: ../fish/guestfish-actions.pod:3162
28535 "This command just writes a swap file signature to an existing file. To "
28536 "create the file itself, use something like L</fallocate>."
28541 #: ../fish/guestfish-actions.pod:3165
28547 #: ../fish/guestfish-actions.pod:3167
28550 " modprobe modulename\n"
28556 #: ../fish/guestfish-actions.pod:3174
28562 #: ../fish/guestfish-actions.pod:3176
28565 " mount device mountpoint\n"
28571 #: ../fish/guestfish-actions.pod:3192
28573 "B<Important note:> When you use this call, the filesystem options C<sync> "
28574 "and C<noatime> are set implicitly. This was originally done because we "
28575 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28576 "very large negative performance impact and negligible effect on "
28577 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28578 "code that needs performance, and instead use L</mount-options> (use an empty "
28579 "string for the first parameter if you don't want any options)."
28584 #: ../fish/guestfish-actions.pod:3202
28590 #: ../fish/guestfish-actions.pod:3204
28593 " mount-loop file mountpoint\n"
28599 #: ../fish/guestfish-actions.pod:3210
28600 msgid "mount-options"
28605 #: ../fish/guestfish-actions.pod:3212
28608 " mount-options options device mountpoint\n"
28614 #: ../fish/guestfish-actions.pod:3214
28616 "This is the same as the L</mount> command, but it allows you to set the "
28617 "mount options as for the L<mount(8)> I<-o> flag."
28622 #: ../fish/guestfish-actions.pod:3222
28628 #: ../fish/guestfish-actions.pod:3224
28631 " mount-ro device mountpoint\n"
28637 #: ../fish/guestfish-actions.pod:3226
28639 "This is the same as the L</mount> command, but it mounts the filesystem with "
28640 "the read-only (I<-o ro>) flag."
28645 #: ../fish/guestfish-actions.pod:3229
28651 #: ../fish/guestfish-actions.pod:3231
28654 " mount-vfs options vfstype device mountpoint\n"
28660 #: ../fish/guestfish-actions.pod:3233
28662 "This is the same as the L</mount> command, but it allows you to set both the "
28663 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28668 #: ../fish/guestfish-actions.pod:3237
28669 msgid "mountpoints"
28674 #: ../fish/guestfish-actions.pod:3239
28683 #: ../fish/guestfish-actions.pod:3241
28685 "This call is similar to L</mounts>. That call returns a list of devices. "
28686 "This one returns a hash table (map) of device name to directory where the "
28687 "device is mounted."
28692 #: ../fish/guestfish-actions.pod:3245
28698 #: ../fish/guestfish-actions.pod:3247
28707 #: ../fish/guestfish-actions.pod:3254
28708 msgid "See also: L</mountpoints>"
28713 #: ../fish/guestfish-actions.pod:3256
28719 #: ../fish/guestfish-actions.pod:3258
28728 #: ../fish/guestfish-actions.pod:3263
28729 msgid "ntfs-3g-probe"
28734 #: ../fish/guestfish-actions.pod:3265
28737 " ntfs-3g-probe true|false device\n"
28743 #: ../fish/guestfish-actions.pod:3279
28749 #: ../fish/guestfish-actions.pod:3281
28752 " ntfsresize device\n"
28758 #: ../fish/guestfish-actions.pod:3287
28759 msgid "ntfsresize-size"
28764 #: ../fish/guestfish-actions.pod:3289
28767 " ntfsresize-size device size\n"
28773 #: ../fish/guestfish-actions.pod:3291
28775 "This command is the same as L</ntfsresize> except that it allows you to "
28776 "specify the new size (in bytes) explicitly."
28781 #: ../fish/guestfish-actions.pod:3294
28787 #: ../fish/guestfish-actions.pod:3296
28790 " part-add device prlogex startsect endsect\n"
28796 #: ../fish/guestfish-actions.pod:3298
28798 "This command adds a partition to C<device>. If there is no partition table "
28799 "on the device, call L</part-init> first."
28804 #: ../fish/guestfish-actions.pod:3310
28806 "Creating a partition which covers the whole disk is not so easy. Use L</"
28807 "part-disk> to do that."
28812 #: ../fish/guestfish-actions.pod:3313
28818 #: ../fish/guestfish-actions.pod:3315
28821 " part-del device partnum\n"
28827 #: ../fish/guestfish-actions.pod:3323
28833 #: ../fish/guestfish-actions.pod:3325
28836 " part-disk device parttype\n"
28842 #: ../fish/guestfish-actions.pod:3327
28844 "This command is simply a combination of L</part-init> followed by L</part-"
28845 "add> to create a single primary partition covering the whole disk."
28850 #: ../fish/guestfish-actions.pod:3331
28852 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28853 "possible values are described in L</part-init>."
28858 #: ../fish/guestfish-actions.pod:3337
28859 msgid "part-get-bootable"
28864 #: ../fish/guestfish-actions.pod:3339
28867 " part-get-bootable device partnum\n"
28873 #: ../fish/guestfish-actions.pod:3344
28874 msgid "See also L</part-set-bootable>."
28879 #: ../fish/guestfish-actions.pod:3346
28880 msgid "part-get-mbr-id"
28885 #: ../fish/guestfish-actions.pod:3348
28888 " part-get-mbr-id device partnum\n"
28894 #: ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3491
28896 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28897 "undefined results for other partition table types (see L</part-get-"
28903 #: ../fish/guestfish-actions.pod:3357
28904 msgid "part-get-parttype"
28909 #: ../fish/guestfish-actions.pod:3359
28912 " part-get-parttype device\n"
28918 #: ../fish/guestfish-actions.pod:3364
28920 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28921 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28922 "possible, although unusual. See L</part-init> for a full list."
28927 #: ../fish/guestfish-actions.pod:3369
28933 #: ../fish/guestfish-actions.pod:3371
28936 " part-init device parttype\n"
28942 #: ../fish/guestfish-actions.pod:3377
28944 "Initially there are no partitions. Following this, you should call L</part-"
28945 "add> for each partition required."
28950 #: ../fish/guestfish-actions.pod:3440
28956 #: ../fish/guestfish-actions.pod:3442
28959 " part-list device\n"
28965 #: ../fish/guestfish-actions.pod:3457
28967 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28968 "the device's sector size, see L</blockdev-getss>."
28973 #: ../fish/guestfish-actions.pod:3470
28974 msgid "part-set-bootable"
28979 #: ../fish/guestfish-actions.pod:3472
28982 " part-set-bootable device partnum true|false\n"
28988 #: ../fish/guestfish-actions.pod:3481
28989 msgid "part-set-mbr-id"
28994 #: ../fish/guestfish-actions.pod:3483
28997 " part-set-mbr-id device partnum idbyte\n"
29003 #: ../fish/guestfish-actions.pod:3495
29004 msgid "part-set-name"
29009 #: ../fish/guestfish-actions.pod:3497
29012 " part-set-name device partnum name\n"
29018 #: ../fish/guestfish-actions.pod:3505
29019 msgid "part-to-dev"
29024 #: ../fish/guestfish-actions.pod:3507
29027 " part-to-dev partition\n"
29033 #: ../fish/guestfish-actions.pod:3513
29035 "The named partition must exist, for example as a string returned from L</"
29036 "list-partitions>."
29041 #: ../fish/guestfish-actions.pod:3516
29042 msgid "ping-daemon"
29047 #: ../fish/guestfish-actions.pod:3518
29056 #: ../fish/guestfish-actions.pod:3525
29062 #: ../fish/guestfish-actions.pod:3527
29065 " pread path count offset\n"
29071 #: ../fish/guestfish-actions.pod:3535
29072 msgid "See also L</pwrite>, L</pread-device>."
29077 #: ../fish/guestfish-actions.pod:3540
29078 msgid "pread-device"
29083 #: ../fish/guestfish-actions.pod:3542
29086 " pread-device device count offset\n"
29092 #: ../fish/guestfish-actions.pod:3550
29093 msgid "See also L</pread>."
29098 #: ../fish/guestfish-actions.pod:3555
29104 #: ../fish/guestfish-actions.pod:3557
29107 " pvcreate device\n"
29113 #: ../fish/guestfish-actions.pod:3563
29119 #: ../fish/guestfish-actions.pod:3565
29122 " pvremove device\n"
29128 #: ../fish/guestfish-actions.pod:3574
29134 #: ../fish/guestfish-actions.pod:3576
29137 " pvresize device\n"
29143 #: ../fish/guestfish-actions.pod:3581
29144 msgid "pvresize-size"
29149 #: ../fish/guestfish-actions.pod:3583
29152 " pvresize-size device size\n"
29158 #: ../fish/guestfish-actions.pod:3585
29160 "This command is the same as L</pvresize> except that it allows you to "
29161 "specify the new size (in bytes) explicitly."
29166 #: ../fish/guestfish-actions.pod:3588
29172 #: ../fish/guestfish-actions.pod:3590
29181 #: ../fish/guestfish-actions.pod:3598
29182 msgid "See also L</pvs-full>."
29187 #: ../fish/guestfish-actions.pod:3600
29193 #: ../fish/guestfish-actions.pod:3602
29202 #: ../fish/guestfish-actions.pod:3607
29208 #: ../fish/guestfish-actions.pod:3609
29217 #: ../fish/guestfish-actions.pod:3613
29223 #: ../fish/guestfish-actions.pod:3615
29226 " pwrite path content offset\n"
29232 #: ../fish/guestfish-actions.pod:3626
29233 msgid "See also L</pread>, L</pwrite-device>."
29238 #: ../fish/guestfish-actions.pod:3631
29239 msgid "pwrite-device"
29244 #: ../fish/guestfish-actions.pod:3633
29247 " pwrite-device device content offset\n"
29253 #: ../fish/guestfish-actions.pod:3643
29254 msgid "See also L</pwrite>."
29259 #: ../fish/guestfish-actions.pod:3648
29265 #: ../fish/guestfish-actions.pod:3650
29268 " read-file path\n"
29274 #: ../fish/guestfish-actions.pod:3655
29276 "Unlike L</cat>, this function can correctly handle files that contain "
29277 "embedded ASCII NUL characters. However unlike L</download>, this function "
29278 "is limited in the total size of file that can be handled."
29283 #: ../fish/guestfish-actions.pod:3663
29289 #: ../fish/guestfish-actions.pod:3665
29292 " read-lines path\n"
29298 #: ../fish/guestfish-actions.pod:3672
29300 "Note that this function cannot correctly handle binary files (specifically, "
29301 "files containing C<\\0> character which is treated as end of line). For "
29302 "those you need to use the L</read-file> function which has a more complex "
29308 #: ../fish/guestfish-actions.pod:3677
29314 #: ../fish/guestfish-actions.pod:3679
29323 #: ../fish/guestfish-actions.pod:3731
29325 "This function is primarily intended for use by programs. To get a simple "
29326 "list of names, use L</ls>. To get a printable directory for human "
29327 "consumption, use L</ll>."
29332 #: ../fish/guestfish-actions.pod:3735
29338 #: ../fish/guestfish-actions.pod:3737
29347 #: ../fish/guestfish-actions.pod:3741
29348 msgid "readlinklist"
29353 #: ../fish/guestfish-actions.pod:3743
29356 " readlinklist path 'names ...'\n"
29362 #: ../fish/guestfish-actions.pod:3767
29368 #: ../fish/guestfish-actions.pod:3769
29377 #: ../fish/guestfish-actions.pod:3774
29378 msgid "removexattr"
29383 #: ../fish/guestfish-actions.pod:3776
29386 " removexattr xattr path\n"
29392 #: ../fish/guestfish-actions.pod:3781
29393 msgid "See also: L</lremovexattr>, L<attr(5)>."
29398 #: ../fish/guestfish-actions.pod:3783
29404 #: ../fish/guestfish-actions.pod:3785
29407 " resize2fs device\n"
29413 #: ../fish/guestfish-actions.pod:3790
29415 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29416 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29417 "gives an error about this and sometimes not. In any case, it is always safe "
29418 "to call L</e2fsck-f> before calling this function."
29422 #: ../fish/guestfish-actions.pod:3796
29423 msgid "resize2fs-M"
29427 #: ../fish/guestfish-actions.pod:3798
29430 " resize2fs-M device\n"
29435 #: ../fish/guestfish-actions.pod:3800
29437 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29438 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
29443 #: ../fish/guestfish-actions.pod:3804
29445 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29446 "and read the C<Block size> and C<Block count> values. These two numbers, "
29447 "multiplied together, give the resulting size of the minimal filesystem in "
29453 #: ../fish/guestfish-actions.pod:3809
29454 msgid "resize2fs-size"
29459 #: ../fish/guestfish-actions.pod:3811
29462 " resize2fs-size device size\n"
29468 #: ../fish/guestfish-actions.pod:3813
29470 "This command is the same as L</resize2fs> except that it allows you to "
29471 "specify the new size (in bytes) explicitly."
29476 #: ../fish/guestfish-actions.pod:3816
29482 #: ../fish/guestfish-actions.pod:3818
29491 #: ../fish/guestfish-actions.pod:3822
29497 #: ../fish/guestfish-actions.pod:3824
29506 #: ../fish/guestfish-actions.pod:3830
29512 #: ../fish/guestfish-actions.pod:3832
29521 #: ../fish/guestfish-actions.pod:3836
29522 msgid "rmmountpoint"
29527 #: ../fish/guestfish-actions.pod:3838
29530 " rmmountpoint exemptpath\n"
29536 #: ../fish/guestfish-actions.pod:3840
29538 "This calls removes a mountpoint that was previously created with L</"
29539 "mkmountpoint>. See L</mkmountpoint> for full details."
29544 #: ../fish/guestfish-actions.pod:3844
29545 msgid "scrub-device"
29550 #: ../fish/guestfish-actions.pod:3846
29553 " scrub-device device\n"
29559 #: ../fish/guestfish-actions.pod:3857
29565 #: ../fish/guestfish-actions.pod:3859
29568 " scrub-file file\n"
29574 #: ../fish/guestfish-actions.pod:3869
29575 msgid "scrub-freespace"
29580 #: ../fish/guestfish-actions.pod:3871
29583 " scrub-freespace dir\n"
29589 #: ../fish/guestfish-actions.pod:3873
29591 "This command creates the directory C<dir> and then fills it with files until "
29592 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29593 "deletes them. The intention is to scrub any free space on the partition "
29594 "containing C<dir>."
29599 #: ../fish/guestfish-actions.pod:3882
29605 #: ../fish/guestfish-actions.pod:3884
29611 #: ../fish/guestfish-actions.pod:3886
29614 " set-append append\n"
29619 #: ../fish/guestfish-actions.pod:3897
29620 msgid "set-attach-method"
29624 #: ../fish/guestfish-actions.pod:3899
29625 msgid "attach-method"
29629 #: ../fish/guestfish-actions.pod:3901
29632 " set-attach-method attachmethod\n"
29638 #: ../fish/guestfish-actions.pod:3923
29639 msgid "set-autosync"
29644 #: ../fish/guestfish-actions.pod:3925
29650 #: ../fish/guestfish-actions.pod:3927
29653 " set-autosync true|false\n"
29659 #: ../fish/guestfish-actions.pod:3937
29665 #: ../fish/guestfish-actions.pod:3939
29671 #: ../fish/guestfish-actions.pod:3941
29674 " set-direct true|false\n"
29680 #: ../fish/guestfish-actions.pod:3947
29682 "One consequence of this is that log messages aren't caught by the library "
29683 "and handled by L</set-log-message-callback>, but go straight to stdout."
29688 #: ../fish/guestfish-actions.pod:3956
29689 msgid "set-e2label"
29694 #: ../fish/guestfish-actions.pod:3958
29697 " set-e2label device label\n"
29703 #: ../fish/guestfish-actions.pod:3964
29705 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29706 "label on a filesystem."
29711 #: ../fish/guestfish-actions.pod:3967
29717 #: ../fish/guestfish-actions.pod:3969
29720 " set-e2uuid device uuid\n"
29726 #: ../fish/guestfish-actions.pod:3976
29728 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29729 "UUID of a filesystem."
29734 #: ../fish/guestfish-actions.pod:3979
29735 msgid "set-memsize"
29740 #: ../fish/guestfish-actions.pod:3981
29746 #: ../fish/guestfish-actions.pod:3983
29749 " set-memsize memsize\n"
29755 #: ../fish/guestfish-actions.pod:3985
29757 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29758 "This only has any effect if called before L</launch>."
29763 #: ../fish/guestfish-actions.pod:3996
29764 msgid "set-network"
29769 #: ../fish/guestfish-actions.pod:3998
29775 #: ../fish/guestfish-actions.pod:4000
29778 " set-network true|false\n"
29784 #: ../fish/guestfish-actions.pod:4008
29786 "You must call this before calling L</launch>, otherwise it has no effect."
29791 #: ../fish/guestfish-actions.pod:4011
29797 #: ../fish/guestfish-actions.pod:4013
29803 #: ../fish/guestfish-actions.pod:4015
29806 " set-path searchpath\n"
29812 #: ../fish/guestfish-actions.pod:4024
29818 #: ../fish/guestfish-actions.pod:4026
29824 #: ../fish/guestfish-actions.pod:4028
29833 #: ../fish/guestfish-actions.pod:4048
29834 msgid "set-recovery-proc"
29839 #: ../fish/guestfish-actions.pod:4050
29840 msgid "recovery-proc"
29845 #: ../fish/guestfish-actions.pod:4052
29848 " set-recovery-proc true|false\n"
29854 #: ../fish/guestfish-actions.pod:4054
29856 "If this is called with the parameter C<false> then L</launch> does not "
29857 "create a recovery process. The purpose of the recovery process is to stop "
29858 "runaway qemu processes in the case where the main program aborts abruptly."
29863 #: ../fish/guestfish-actions.pod:4059
29865 "This only has any effect if called before L</launch>, and the default is "
29871 #: ../fish/guestfish-actions.pod:4068
29872 msgid "set-selinux"
29877 #: ../fish/guestfish-actions.pod:4070
29883 #: ../fish/guestfish-actions.pod:4072
29886 " set-selinux true|false\n"
29892 #: ../fish/guestfish-actions.pod:4083
29898 #: ../fish/guestfish-actions.pod:4085
29904 #: ../fish/guestfish-actions.pod:4087
29907 " set-trace true|false\n"
29912 #: ../fish/guestfish-actions.pod:4099
29914 "Trace messages are normally sent to C<stderr>, unless you register a "
29915 "callback to send them somewhere else (see L</set-event-callback>)."
29920 #: ../fish/guestfish-actions.pod:4103
29921 msgid "set-verbose"
29926 #: ../fish/guestfish-actions.pod:4105
29932 #: ../fish/guestfish-actions.pod:4107
29935 " set-verbose true|false\n"
29940 #: ../fish/guestfish-actions.pod:4114
29942 "Verbose messages are normally sent to C<stderr>, unless you register a "
29943 "callback to send them somewhere else (see L</set-event-callback>)."
29948 #: ../fish/guestfish-actions.pod:4118
29954 #: ../fish/guestfish-actions.pod:4120
29957 " setcon context\n"
29963 #: ../fish/guestfish-actions.pod:4127
29969 #: ../fish/guestfish-actions.pod:4129
29972 " setxattr xattr val vallen path\n"
29978 #: ../fish/guestfish-actions.pod:4135
29979 msgid "See also: L</lsetxattr>, L<attr(5)>."
29984 #: ../fish/guestfish-actions.pod:4137
29990 #: ../fish/guestfish-actions.pod:4139
29993 " sfdisk device cyls heads sectors 'lines ...'\n"
29999 #: ../fish/guestfish-actions.pod:4161
30000 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
30005 #: ../fish/guestfish-actions.pod:4167
30011 #: ../fish/guestfish-actions.pod:4169
30014 " sfdiskM device 'lines ...'\n"
30020 #: ../fish/guestfish-actions.pod:4171
30022 "This is a simplified interface to the L</sfdisk> command, where partition "
30023 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
30024 "you don't need to specify the cyls, heads and sectors parameters which were "
30025 "rarely if ever used anyway."
30030 #: ../fish/guestfish-actions.pod:4177
30031 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
30036 #: ../fish/guestfish-actions.pod:4183
30042 #: ../fish/guestfish-actions.pod:4185
30045 " sfdisk-N device partnum cyls heads sectors line\n"
30051 #: ../fish/guestfish-actions.pod:4190
30053 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
30054 "cyls/heads/sectors parameters."
30059 #: ../fish/guestfish-actions.pod:4193
30060 msgid "See also: L</part-add>"
30065 #: ../fish/guestfish-actions.pod:4198
30066 msgid "sfdisk-disk-geometry"
30071 #: ../fish/guestfish-actions.pod:4200
30074 " sfdisk-disk-geometry device\n"
30080 #: ../fish/guestfish-actions.pod:4202
30082 "This displays the disk geometry of C<device> read from the partition table. "
30083 "Especially in the case where the underlying block device has been resized, "
30084 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
30085 "kernel-geometry>)."
30090 #: ../fish/guestfish-actions.pod:4210
30091 msgid "sfdisk-kernel-geometry"
30096 #: ../fish/guestfish-actions.pod:4212
30099 " sfdisk-kernel-geometry device\n"
30105 #: ../fish/guestfish-actions.pod:4219
30111 #: ../fish/guestfish-actions.pod:4221
30114 " sfdisk-l device\n"
30120 #: ../fish/guestfish-actions.pod:4227
30121 msgid "See also: L</part-list>"
30126 #: ../fish/guestfish-actions.pod:4229
30132 #: ../fish/guestfish-actions.pod:4231
30141 #: ../fish/guestfish-actions.pod:4236
30142 msgid "This is like L</command>, but passes the command to:"
30147 #: ../fish/guestfish-actions.pod:4244
30148 msgid "All the provisos about L</command> apply to this call."
30153 #: ../fish/guestfish-actions.pod:4246
30159 #: ../fish/guestfish-actions.pod:4248
30162 " sh-lines command\n"
30168 #: ../fish/guestfish-actions.pod:4250
30169 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30174 #: ../fish/guestfish-actions.pod:4253
30175 msgid "See also: L</command-lines>"
30180 #: ../fish/guestfish-actions.pod:4255
30186 #: ../fish/guestfish-actions.pod:4257
30195 #: ../fish/guestfish-actions.pod:4261
30201 #: ../fish/guestfish-actions.pod:4263
30210 #: ../fish/guestfish-actions.pod:4269
30216 #: ../fish/guestfish-actions.pod:4271
30225 #: ../fish/guestfish-actions.pod:4279
30231 #: ../fish/guestfish-actions.pod:4281
30240 #: ../fish/guestfish-actions.pod:4289
30246 #: ../fish/guestfish-actions.pod:4291
30249 " strings-e encoding path\n"
30255 #: ../fish/guestfish-actions.pod:4293
30257 "This is like the L</strings> command, but allows you to specify the encoding "
30258 "of strings that are looked for in the source file C<path>."
30263 #: ../fish/guestfish-actions.pod:4303
30265 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30266 "ISO-8859-X (this is what L</strings> uses)."
30271 #: ../fish/guestfish-actions.pod:4335
30272 msgid "swapoff-device"
30277 #: ../fish/guestfish-actions.pod:4337
30280 " swapoff-device device\n"
30286 #: ../fish/guestfish-actions.pod:4339
30288 "This command disables the libguestfs appliance swap device or partition "
30289 "named C<device>. See L</swapon-device>."
30294 #: ../fish/guestfish-actions.pod:4343
30295 msgid "swapoff-file"
30300 #: ../fish/guestfish-actions.pod:4345
30303 " swapoff-file file\n"
30309 #: ../fish/guestfish-actions.pod:4349
30310 msgid "swapoff-label"
30315 #: ../fish/guestfish-actions.pod:4351
30318 " swapoff-label label\n"
30324 #: ../fish/guestfish-actions.pod:4356
30325 msgid "swapoff-uuid"
30330 #: ../fish/guestfish-actions.pod:4358
30333 " swapoff-uuid uuid\n"
30339 #: ../fish/guestfish-actions.pod:4363
30340 msgid "swapon-device"
30345 #: ../fish/guestfish-actions.pod:4365
30348 " swapon-device device\n"
30354 #: ../fish/guestfish-actions.pod:4367
30356 "This command enables the libguestfs appliance to use the swap device or "
30357 "partition named C<device>. The increased memory is made available for all "
30358 "commands, for example those run using L</command> or L</sh>."
30363 #: ../fish/guestfish-actions.pod:4379
30364 msgid "swapon-file"
30369 #: ../fish/guestfish-actions.pod:4381
30372 " swapon-file file\n"
30378 #: ../fish/guestfish-actions.pod:4383
30380 "This command enables swap to a file. See L</swapon-device> for other notes."
30385 #: ../fish/guestfish-actions.pod:4386
30386 msgid "swapon-label"
30391 #: ../fish/guestfish-actions.pod:4388
30394 " swapon-label label\n"
30400 #: ../fish/guestfish-actions.pod:4390
30402 "This command enables swap to a labeled swap partition. See L</swapon-"
30403 "device> for other notes."
30408 #: ../fish/guestfish-actions.pod:4393
30409 msgid "swapon-uuid"
30414 #: ../fish/guestfish-actions.pod:4395
30417 " swapon-uuid uuid\n"
30423 #: ../fish/guestfish-actions.pod:4397
30425 "This command enables swap to a swap partition with the given UUID. See L</"
30426 "swapon-device> for other notes."
30431 #: ../fish/guestfish-actions.pod:4400
30437 #: ../fish/guestfish-actions.pod:4402
30446 #: ../fish/guestfish-actions.pod:4410
30452 #: ../fish/guestfish-actions.pod:4412
30461 #: ../fish/guestfish-actions.pod:4420
30467 #: ../fish/guestfish-actions.pod:4422
30470 " tail-n nrlines path\n"
30476 #: ../fish/guestfish-actions.pod:4435
30482 #: ../fish/guestfish-actions.pod:4437
30485 " tar-in (tarfile|-) directory\n"
30491 #: ../fish/guestfish-actions.pod:4442
30492 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30497 #: ../fish/guestfish-actions.pod:4447
30503 #: ../fish/guestfish-actions.pod:4449
30506 " tar-out directory (tarfile|-)\n"
30512 #: ../fish/guestfish-actions.pod:4454
30513 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30518 #: ../fish/guestfish-actions.pod:4459
30524 #: ../fish/guestfish-actions.pod:4461
30527 " tgz-in (tarball|-) directory\n"
30533 #: ../fish/guestfish-actions.pod:4466
30534 msgid "To upload an uncompressed tarball, use L</tar-in>."
30539 #: ../fish/guestfish-actions.pod:4470
30545 #: ../fish/guestfish-actions.pod:4472
30548 " tgz-out directory (tarball|-)\n"
30554 #: ../fish/guestfish-actions.pod:4477
30555 msgid "To download an uncompressed tarball, use L</tar-out>."
30560 #: ../fish/guestfish-actions.pod:4481
30566 #: ../fish/guestfish-actions.pod:4483
30575 #: ../fish/guestfish-actions.pod:4492
30581 #: ../fish/guestfish-actions.pod:4494
30590 #: ../fish/guestfish-actions.pod:4499
30591 msgid "truncate-size"
30596 #: ../fish/guestfish-actions.pod:4501
30599 " truncate-size path size\n"
30605 #: ../fish/guestfish-actions.pod:4506
30607 "If the current file size is less than C<size> then the file is extended to "
30608 "the required size with zero bytes. This creates a sparse file (ie. disk "
30609 "blocks are not allocated for the file until you write to it). To create a "
30610 "non-sparse file of zeroes, use L</fallocate64> instead."
30615 #: ../fish/guestfish-actions.pod:4512
30621 #: ../fish/guestfish-actions.pod:4514
30624 " tune2fs-l device\n"
30630 #: ../fish/guestfish-actions.pod:4524
30636 #: ../fish/guestfish-actions.pod:4526
30639 " txz-in (tarball|-) directory\n"
30645 #: ../fish/guestfish-actions.pod:4533
30651 #: ../fish/guestfish-actions.pod:4535
30654 " txz-out directory (tarball|-)\n"
30660 #: ../fish/guestfish-actions.pod:4542
30666 #: ../fish/guestfish-actions.pod:4544
30675 #: ../fish/guestfish-actions.pod:4558
30676 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30681 #: ../fish/guestfish-actions.pod:4563
30687 #: ../fish/guestfish-actions.pod:4565
30693 #: ../fish/guestfish-actions.pod:4567
30696 " umount pathordevice\n"
30702 #: ../fish/guestfish-actions.pod:4573
30708 #: ../fish/guestfish-actions.pod:4575
30709 msgid "unmount-all"
30714 #: ../fish/guestfish-actions.pod:4577
30723 #: ../fish/guestfish-actions.pod:4583
30729 #: ../fish/guestfish-actions.pod:4585
30732 " upload (filename|-) remotefilename\n"
30738 #: ../fish/guestfish-actions.pod:4592
30739 msgid "See also L</download>."
30744 #: ../fish/guestfish-actions.pod:4596
30745 msgid "upload-offset"
30750 #: ../fish/guestfish-actions.pod:4598
30753 " upload-offset (filename|-) remotefilename offset\n"
30759 #: ../fish/guestfish-actions.pod:4610
30761 "Note that there is no limit on the amount of data that can be uploaded with "
30762 "this call, unlike with L</pwrite>, and this call always writes the full "
30763 "amount unless an error occurs."
30768 #: ../fish/guestfish-actions.pod:4615
30769 msgid "See also L</upload>, L</pwrite>."
30774 #: ../fish/guestfish-actions.pod:4619
30780 #: ../fish/guestfish-actions.pod:4621
30783 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30789 #: ../fish/guestfish-actions.pod:4640
30795 #: ../fish/guestfish-actions.pod:4642
30804 #: ../fish/guestfish-actions.pod:4669
30806 "I<Note:> Don't use this call to test for availability of features. In "
30807 "enterprise distributions we backport features from later versions into "
30808 "earlier versions, making this an unreliable way to test for features. Use "
30809 "L</available> instead."
30814 #: ../fish/guestfish-actions.pod:4675
30820 #: ../fish/guestfish-actions.pod:4677
30823 " vfs-label device\n"
30829 #: ../fish/guestfish-actions.pod:4684
30830 msgid "To find a filesystem from the label, use L</findfs-label>."
30835 #: ../fish/guestfish-actions.pod:4686
30841 #: ../fish/guestfish-actions.pod:4688
30844 " vfs-type device\n"
30850 #: ../fish/guestfish-actions.pod:4698
30856 #: ../fish/guestfish-actions.pod:4700
30859 " vfs-uuid device\n"
30865 #: ../fish/guestfish-actions.pod:4707
30866 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30871 #: ../fish/guestfish-actions.pod:4709
30872 msgid "vg-activate"
30877 #: ../fish/guestfish-actions.pod:4711
30880 " vg-activate true|false 'volgroups ...'\n"
30886 #: ../fish/guestfish-actions.pod:4724
30887 msgid "vg-activate-all"
30892 #: ../fish/guestfish-actions.pod:4726
30895 " vg-activate-all true|false\n"
30901 #: ../fish/guestfish-actions.pod:4736
30907 #: ../fish/guestfish-actions.pod:4738
30910 " vgcreate volgroup 'physvols ...'\n"
30916 #: ../fish/guestfish-actions.pod:4743
30922 #: ../fish/guestfish-actions.pod:4745
30925 " vglvuuids vgname\n"
30931 #: ../fish/guestfish-actions.pod:4750
30933 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30934 "logical volumes and volume groups."
30939 #: ../fish/guestfish-actions.pod:4753
30940 msgid "See also L</vgpvuuids>."
30945 #: ../fish/guestfish-actions.pod:4755
30951 #: ../fish/guestfish-actions.pod:4757
30954 " vgpvuuids vgname\n"
30960 #: ../fish/guestfish-actions.pod:4762
30962 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30963 "physical volumes and volume groups."
30968 #: ../fish/guestfish-actions.pod:4765
30969 msgid "See also L</vglvuuids>."
30974 #: ../fish/guestfish-actions.pod:4767
30980 #: ../fish/guestfish-actions.pod:4769
30983 " vgremove vgname\n"
30989 #: ../fish/guestfish-actions.pod:4776
30995 #: ../fish/guestfish-actions.pod:4778
30998 " vgrename volgroup newvolgroup\n"
31004 #: ../fish/guestfish-actions.pod:4782
31010 #: ../fish/guestfish-actions.pod:4784
31019 #: ../fish/guestfish-actions.pod:4792
31020 msgid "See also L</vgs-full>."
31025 #: ../fish/guestfish-actions.pod:4794
31031 #: ../fish/guestfish-actions.pod:4796
31040 #: ../fish/guestfish-actions.pod:4801
31046 #: ../fish/guestfish-actions.pod:4803
31055 #: ../fish/guestfish-actions.pod:4808
31061 #: ../fish/guestfish-actions.pod:4810
31070 #: ../fish/guestfish-actions.pod:4814
31076 #: ../fish/guestfish-actions.pod:4816
31085 #: ../fish/guestfish-actions.pod:4821
31091 #: ../fish/guestfish-actions.pod:4823
31100 #: ../fish/guestfish-actions.pod:4828
31106 #: ../fish/guestfish-actions.pod:4830
31115 #: ../fish/guestfish-actions.pod:4835
31121 #: ../fish/guestfish-actions.pod:4837
31124 " write path content\n"
31130 #: ../fish/guestfish-actions.pod:4845
31136 #: ../fish/guestfish-actions.pod:4847
31139 " write-file path content size\n"
31145 #: ../fish/guestfish-actions.pod:4870
31151 #: ../fish/guestfish-actions.pod:4872
31154 " zegrep regex path\n"
31160 #: ../fish/guestfish-actions.pod:4880
31166 #: ../fish/guestfish-actions.pod:4882
31169 " zegrepi regex path\n"
31175 #: ../fish/guestfish-actions.pod:4890
31181 #: ../fish/guestfish-actions.pod:4892
31190 #: ../fish/guestfish-actions.pod:4900
31191 msgid "See also: L</zero-device>, L</scrub-device>."
31196 #: ../fish/guestfish-actions.pod:4902
31197 msgid "zero-device"
31202 #: ../fish/guestfish-actions.pod:4904
31205 " zero-device device\n"
31211 #: ../fish/guestfish-actions.pod:4906
31213 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31214 "which just zeroes the first few blocks of a device."
31219 #: ../fish/guestfish-actions.pod:4913
31225 #: ../fish/guestfish-actions.pod:4915
31228 " zerofree device\n"
31234 #: ../fish/guestfish-actions.pod:4928
31240 #: ../fish/guestfish-actions.pod:4930
31243 " zfgrep pattern path\n"
31249 #: ../fish/guestfish-actions.pod:4938
31255 #: ../fish/guestfish-actions.pod:4940
31258 " zfgrepi pattern path\n"
31264 #: ../fish/guestfish-actions.pod:4948
31270 #: ../fish/guestfish-actions.pod:4950
31273 " zfile meth path\n"
31279 #: ../fish/guestfish-actions.pod:4957
31281 "Since 1.0.63, use L</file> instead which can now process compressed files."
31286 #: ../fish/guestfish-actions.pod:4967
31292 #: ../fish/guestfish-actions.pod:4969
31295 " zgrep regex path\n"
31301 #: ../fish/guestfish-actions.pod:4977
31307 #: ../fish/guestfish-actions.pod:4979
31310 " zgrepi regex path\n"
31316 #: ../fish/guestfish-commands.pod:1
31322 #: ../fish/guestfish-commands.pod:3
31328 #: ../fish/guestfish-commands.pod:5
31331 " alloc filename size\n"
31337 #: ../fish/guestfish-commands.pod:7
31339 "This creates an empty (zeroed) file of the given size, and then adds so it "
31340 "can be further examined."
31345 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31346 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31351 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31352 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31357 #: ../fish/guestfish-commands.pod:14
31359 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31360 "image, see L</PREPARED DISK IMAGES>."
31365 #: ../fish/guestfish-commands.pod:17
31371 #: ../fish/guestfish-commands.pod:19
31374 " copy-in local [local ...] /remotedir\n"
31380 #: ../fish/guestfish-commands.pod:21
31382 "C<copy-in> copies local files or directories recursively into the disk "
31383 "image, placing them in the directory called C</remotedir> (which must "
31384 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31385 "other commands as necessary."
31390 #: ../fish/guestfish-commands.pod:26
31392 "Multiple local files and directories can be specified, but the last "
31393 "parameter must always be a remote directory. Wildcards cannot be used."
31398 #: ../fish/guestfish-commands.pod:30
31404 #: ../fish/guestfish-commands.pod:32
31407 " copy-out remote [remote ...] localdir\n"
31413 #: ../fish/guestfish-commands.pod:34
31415 "C<copy-out> copies remote files or directories recursively out of the disk "
31416 "image, placing them on the host disk in a local directory called C<localdir> "
31417 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31418 "download>, L</tar-out> and other commands as necessary."
31423 #: ../fish/guestfish-commands.pod:40
31425 "Multiple remote files and directories can be specified, but the last "
31426 "parameter must always be a local directory. To download to the current "
31427 "directory, use C<.> as in:"
31432 #: ../fish/guestfish-commands.pod:44
31435 " copy-out /home .\n"
31441 #: ../fish/guestfish-commands.pod:46
31443 "Wildcards cannot be used in the ordinary command, but you can use them with "
31444 "the help of L</glob> like this:"
31449 #: ../fish/guestfish-commands.pod:49
31452 " glob copy-out /home/* .\n"
31458 #: ../fish/guestfish-commands.pod:51
31464 #: ../fish/guestfish-commands.pod:53
31467 " echo [params ...]\n"
31473 #: ../fish/guestfish-commands.pod:55
31474 msgid "This echos the parameters to the terminal."
31479 #: ../fish/guestfish-commands.pod:57
31485 #: ../fish/guestfish-commands.pod:59
31491 #: ../fish/guestfish-commands.pod:61
31497 #: ../fish/guestfish-commands.pod:63
31506 #: ../fish/guestfish-commands.pod:65
31508 "This is used to edit a file. It downloads the file, edits it locally using "
31509 "your editor, then uploads the result."
31514 #: ../fish/guestfish-commands.pod:68
31516 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31517 "or C<emacs> you will get those corresponding editors."
31522 #: ../fish/guestfish-commands.pod:72
31528 #: ../fish/guestfish-commands.pod:74
31531 " glob command args...\n"
31537 #: ../fish/guestfish-commands.pod:76
31539 "Expand wildcards in any paths in the args list, and run C<command> "
31540 "repeatedly on each matching path."
31545 #: ../fish/guestfish-commands.pod:79
31546 msgid "See L</WILDCARDS AND GLOBBING>."
31551 #: ../fish/guestfish-commands.pod:81
31557 #: ../fish/guestfish-commands.pod:83
31560 " hexedit <filename|device>\n"
31561 " hexedit <filename|device> <max>\n"
31562 " hexedit <filename|device> <start> <max>\n"
31568 #: ../fish/guestfish-commands.pod:87
31570 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31576 #: ../fish/guestfish-commands.pod:90
31578 "This command works by downloading potentially the whole file or device, "
31579 "editing it locally, then uploading it. If the file or device is large, you "
31580 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31581 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31582 "usual modifiers allowed such as C<1M> (1 megabyte)."
31587 #: ../fish/guestfish-commands.pod:97
31588 msgid "For example to edit the first few sectors of a disk you might do:"
31593 #: ../fish/guestfish-commands.pod:100
31596 " hexedit /dev/sda 1M\n"
31602 #: ../fish/guestfish-commands.pod:102
31604 "which would allow you to edit anywhere within the first megabyte of the disk."
31609 #: ../fish/guestfish-commands.pod:105
31610 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31615 #: ../fish/guestfish-commands.pod:107
31618 " hexedit /dev/sda1 0x400 0x400\n"
31624 #: ../fish/guestfish-commands.pod:109
31625 msgid "(assuming the superblock is in the standard location)."
31630 #: ../fish/guestfish-commands.pod:111
31632 "This command requires the external L<hexedit(1)> program. You can specify "
31633 "another program to use by setting the C<HEXEDITOR> environment variable."
31638 #: ../fish/guestfish-commands.pod:115
31639 msgid "See also L</hexdump>."
31644 #: ../fish/guestfish-commands.pod:117
31650 #: ../fish/guestfish-commands.pod:119
31659 #: ../fish/guestfish-commands.pod:121
31661 "Change the local directory, ie. the current directory of guestfish itself."
31666 #: ../fish/guestfish-commands.pod:124
31667 msgid "Note that C<!cd> won't do what you might expect."
31672 #: ../fish/guestfish-commands.pod:126
31678 #: ../fish/guestfish-commands.pod:128
31684 #: ../fish/guestfish-commands.pod:130
31693 #: ../fish/guestfish-commands.pod:132
31694 msgid "Opens the manual page for guestfish."
31699 #: ../fish/guestfish-commands.pod:134
31705 #: ../fish/guestfish-commands.pod:136
31711 #: ../fish/guestfish-commands.pod:138
31720 #: ../fish/guestfish-commands.pod:140
31729 #: ../fish/guestfish-commands.pod:142
31730 msgid "This is used to view a file."
31735 #: ../fish/guestfish-commands.pod:144
31737 "The default viewer is C<$PAGER>. However if you use the alternate command "
31738 "C<less> you will get the C<less> command specifically."
31743 #: ../fish/guestfish-commands.pod:147
31749 #: ../fish/guestfish-commands.pod:149
31758 #: ../fish/guestfish-commands.pod:151
31760 "Close and reopen the libguestfs handle. It is not necessary to use this "
31761 "normally, because the handle is closed properly when guestfish exits. "
31762 "However this is occasionally useful for testing."
31767 #: ../fish/guestfish-commands.pod:155
31773 #: ../fish/guestfish-commands.pod:157
31776 " sparse filename size\n"
31782 #: ../fish/guestfish-commands.pod:159
31784 "This creates an empty sparse file of the given size, and then adds so it can "
31785 "be further examined."
31790 #: ../fish/guestfish-commands.pod:162
31792 "In all respects it works the same as the L</alloc> command, except that the "
31793 "image file is allocated sparsely, which means that disk blocks are not "
31794 "assigned to the file until they are needed. Sparse disk files only use "
31795 "space when written to, but they are slower and there is a danger you could "
31796 "run out of real disk space during a write operation."
31801 #: ../fish/guestfish-commands.pod:172
31807 #: ../fish/guestfish-commands.pod:174
31816 #: ../fish/guestfish-commands.pod:176
31818 "This command returns a list of the optional groups known to the daemon, and "
31819 "indicates which ones are supported by this build of the libguestfs appliance."
31824 #: ../fish/guestfish-commands.pod:180
31825 msgid "See also L<guestfs(3)/AVAILABILITY>."
31830 #: ../fish/guestfish-commands.pod:182
31836 #: ../fish/guestfish-commands.pod:184
31839 " time command args...\n"
31845 #: ../fish/guestfish-commands.pod:186
31847 "Run the command as usual, but print the elapsed time afterwards. This can "
31848 "be useful for benchmarking operations."
31853 #: ../test-tool/libguestfs-test-tool.pod:5
31854 msgid "libguestfs-test-tool - End user tests for libguestfs"
31859 #: ../test-tool/libguestfs-test-tool.pod:9
31862 " libguestfs-test-tool [--options]\n"
31868 #: ../test-tool/libguestfs-test-tool.pod:13
31870 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31871 "and developers, to allow them to check basic libguestfs functionality is "
31872 "working. This is needed because libguestfs occasionally breaks for reasons "
31873 "beyond our control: usually because of changes in the underlying qemu or "
31874 "kernel packages, or the host environment."
31879 #: ../test-tool/libguestfs-test-tool.pod:20
31880 msgid "If you suspect a problem in libguestfs, then just run:"
31885 #: ../test-tool/libguestfs-test-tool.pod:22
31888 " libguestfs-test-tool\n"
31894 #: ../test-tool/libguestfs-test-tool.pod:24
31895 msgid "It will print lots of diagnostic messages."
31900 #: ../test-tool/libguestfs-test-tool.pod:26
31901 msgid "If it runs to completion successfully, you will see this near the end:"
31906 #: ../test-tool/libguestfs-test-tool.pod:28
31909 " ===== TEST FINISHED OK =====\n"
31915 #: ../test-tool/libguestfs-test-tool.pod:30
31916 msgid "and the test tool will exit with code 0."
31921 #: ../test-tool/libguestfs-test-tool.pod:32
31923 "If it fails (and/or exits with non-zero error code), please paste the "
31924 "B<complete, unedited> output of the test tool into a bug report. More "
31925 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31931 #: ../test-tool/libguestfs-test-tool.pod:41
31937 #: ../test-tool/libguestfs-test-tool.pod:43
31938 msgid "Display short usage information and exit."
31943 #: ../test-tool/libguestfs-test-tool.pod:45
31944 msgid "I<--qemu qemu_binary>"
31949 #: ../test-tool/libguestfs-test-tool.pod:47
31951 "If you have downloaded another qemu binary, point this option at the full "
31952 "path of the binary to try it."
31957 #: ../test-tool/libguestfs-test-tool.pod:50
31958 msgid "I<--qemudir qemu_source_dir>"
31963 #: ../test-tool/libguestfs-test-tool.pod:52
31965 "If you have compiled qemu from source, point this option at the source "
31966 "directory to try it."
31971 #: ../test-tool/libguestfs-test-tool.pod:55
31972 msgid "I<--timeout N>"
31977 #: ../test-tool/libguestfs-test-tool.pod:57
31979 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31980 "does not usually need to be adjusted unless your machine is very slow."
31985 #: ../test-tool/libguestfs-test-tool.pod:63
31986 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31991 #: ../test-tool/libguestfs-test-tool.pod:65
31993 "If you have compiled another version of qemu from source and would like to "
31994 "try that, then you can use the I<--qemudir> option to point to the qemu "
31995 "source directory."
32000 #: ../test-tool/libguestfs-test-tool.pod:69
32002 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
32003 "option to point to the binary."
32008 #: ../test-tool/libguestfs-test-tool.pod:72
32010 "When using an alternate qemu with libguestfs, usually you would need to "
32011 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
32012 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
32013 "use either of the I<--qemudir> or I<--qemu> options."
32018 #: ../test-tool/libguestfs-test-tool.pod:79
32020 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
32021 "I<1> if there was an error."
32026 #: ../test-tool/libguestfs-test-tool.pod:84
32028 "For the full list of environment variables which may affect libguestfs, "
32029 "please see the L<guestfs(3)> manual page."
32034 #: ../test-tool/libguestfs-test-tool.pod:89
32035 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
32040 #: ../fuse/guestmount.pod:5
32042 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
32047 #: ../fuse/guestmount.pod:9
32050 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
32056 #: ../fuse/guestmount.pod:11
32059 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
32065 #: ../fuse/guestmount.pod:13
32068 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
32074 #: ../fuse/guestmount.pod:17
32076 "You must I<not> use C<guestmount> in read-write mode on live virtual "
32077 "machines. If you do this, you risk disk corruption in the VM."
32082 #: ../fuse/guestmount.pod:22
32084 "The guestmount program can be used to mount virtual machine filesystems and "
32085 "other disk images on the host. It uses libguestfs for access to the guest "
32086 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
32087 "a mountable device."
32092 #: ../fuse/guestmount.pod:27
32094 "Along with other options, you have to give at least one device (I<-a> "
32095 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
32096 "option) or use the I<-i> inspection option. How this works is better "
32097 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
32103 #: ../fuse/guestmount.pod:33
32105 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
32106 "by you, and the filesystem will not be visible to any other users unless you "
32107 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
32108 "the filesystem, use the C<fusermount -u> command."
32113 #: ../fuse/guestmount.pod:41
32115 "For a typical Windows guest which has its main filesystem on the first "
32121 #: ../fuse/guestmount.pod:44
32124 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32130 #: ../fuse/guestmount.pod:46
32132 "For a typical Linux guest which has a /boot filesystem on the first "
32133 "partition, and the root filesystem on a logical volume:"
32138 #: ../fuse/guestmount.pod:49
32141 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32147 #: ../fuse/guestmount.pod:51
32148 msgid "To get libguestfs to detect guest mountpoints for you:"
32153 #: ../fuse/guestmount.pod:53
32156 " guestmount -a guest.img -i --ro /mnt\n"
32162 #: ../fuse/guestmount.pod:55
32163 msgid "For a libvirt guest called \"Guest\" you could do:"
32168 #: ../fuse/guestmount.pod:57
32171 " guestmount -d Guest -i --ro /mnt\n"
32177 #: ../fuse/guestmount.pod:59
32179 "If you don't know what filesystems are contained in a guest or disk image, "
32180 "use L<virt-filesystems(1)> first:"
32185 #: ../fuse/guestmount.pod:62
32188 " virt-filesystems MyGuest\n"
32194 #: ../fuse/guestmount.pod:64
32196 "If you want to trace the libguestfs calls but without excessive debugging "
32197 "information, we recommend:"
32202 #: ../fuse/guestmount.pod:67
32205 " guestmount [...] --trace /mnt\n"
32211 #: ../fuse/guestmount.pod:69
32212 msgid "If you want to debug the program, we recommend:"
32217 #: ../fuse/guestmount.pod:71
32220 " guestmount [...] --trace --verbose /mnt\n"
32226 #: ../fuse/guestmount.pod:77
32227 msgid "B<-a image> | B<--add image>"
32232 #: ../fuse/guestmount.pod:79
32233 msgid "Add a block device or virtual machine image."
32238 #: ../fuse/guestmount.pod:84
32239 msgid "B<-c URI> | B<--connect URI>"
32244 #: ../fuse/guestmount.pod:90
32245 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32250 #: ../fuse/guestmount.pod:96
32251 msgid "B<--dir-cache-timeout N>"
32256 #: ../fuse/guestmount.pod:98
32258 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32259 "seconds. The readdir cache [actually, there are several semi-independent "
32260 "caches] is populated after a readdir(2) call with the stat and extended "
32261 "attributes of the files in the directory, in anticipation that they will be "
32262 "requested soon after."
32267 #: ../fuse/guestmount.pod:104
32269 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32270 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32271 "requests, only cache existing ones."
32276 #: ../fuse/guestmount.pod:115
32277 msgid "B<--format=raw|qcow2|..> | B<--format>"
32282 #: ../fuse/guestmount.pod:122
32284 "If you have untrusted raw-format guest disk images, you should use this "
32285 "option to specify the disk format. This avoids a possible security problem "
32286 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32287 "guestfs_add_drive_opts>."
32292 #: ../fuse/guestmount.pod:127
32293 msgid "B<--fuse-help>"
32298 #: ../fuse/guestmount.pod:129
32299 msgid "Display help on special FUSE options (see I<-o> below)."
32304 #: ../fuse/guestmount.pod:133
32305 msgid "Display brief help and exit."
32310 #: ../fuse/guestmount.pod:135
32311 msgid "B<-i> | B<--inspector>"
32316 #: ../fuse/guestmount.pod:155
32318 "Mount the named partition or logical volume on the given mountpoint B<in the "
32319 "guest> (this has nothing to do with mountpoints in the host)."
32324 #: ../fuse/guestmount.pod:158
32326 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32327 "something on C</>."
32332 #: ../fuse/guestmount.pod:171
32333 msgid "B<-n> | B<--no-sync>"
32338 #: ../fuse/guestmount.pod:173
32340 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32341 "unmounted. If you specify this option, then we don't attempt to sync the "
32342 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32347 #: ../fuse/guestmount.pod:178
32348 msgid "B<-o option> | B<--option option>"
32353 #: ../fuse/guestmount.pod:180
32354 msgid "Pass extra options to FUSE."
32359 #: ../fuse/guestmount.pod:182
32361 "To get a list of all the extra options supported by FUSE, use the command "
32362 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32363 "of them are a good idea."
32368 #: ../fuse/guestmount.pod:186
32371 " guestmount --fuse-help\n"
32377 #: ../fuse/guestmount.pod:188
32378 msgid "Some potentially useful FUSE options:"
32383 #: ../fuse/guestmount.pod:192
32384 msgid "B<-o allow_other>"
32389 #: ../fuse/guestmount.pod:194
32390 msgid "Allow other users to see the filesystem."
32395 #: ../fuse/guestmount.pod:196
32396 msgid "B<-o attr_timeout=N>"
32401 #: ../fuse/guestmount.pod:198
32402 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32407 #: ../fuse/guestmount.pod:200
32408 msgid "B<-o kernel_cache>"
32413 #: ../fuse/guestmount.pod:202
32415 "Allow the kernel to cache files (reduces the number of reads that have to go "
32416 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32417 "afford the extra memory usage."
32422 #: ../fuse/guestmount.pod:206
32423 msgid "B<-o uid=N> B<-o gid=N>"
32428 #: ../fuse/guestmount.pod:208
32430 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32431 "the chosen values."
32436 #: ../fuse/guestmount.pod:213
32437 msgid "B<-r> | B<--ro>"
32442 #: ../fuse/guestmount.pod:215
32444 "Add devices and mount everything read-only. Also disallow writes and make "
32445 "the disk appear read-only to FUSE."
32450 #: ../fuse/guestmount.pod:218
32452 "This is highly recommended if you are not going to edit the guest disk. If "
32453 "the guest is running and this option is I<not> supplied, then there is a "
32454 "strong risk of disk corruption in the guest. We try to prevent this from "
32455 "happening, but it is not always possible."
32460 #: ../fuse/guestmount.pod:223
32461 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32466 #: ../fuse/guestmount.pod:227
32467 msgid "Enable SELinux support for the guest."
32472 #: ../fuse/guestmount.pod:229
32473 msgid "B<-v> | B<--verbose>"
32478 #: ../fuse/guestmount.pod:231
32479 msgid "Enable verbose messages from underlying libguestfs."
32484 #: ../fuse/guestmount.pod:233
32485 msgid "B<-V> | B<--version>"
32490 #: ../fuse/guestmount.pod:235
32491 msgid "Display the program version and exit."
32496 #: ../fuse/guestmount.pod:237
32497 msgid "B<-w> | B<--rw>"
32501 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
32502 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32507 #: ../fuse/guestmount.pod:244
32508 msgid "B<-x> | B<--trace>"
32513 #: ../fuse/guestmount.pod:246
32514 msgid "Trace libguestfs calls and entry into each FUSE function."
32519 #: ../fuse/guestmount.pod:248
32520 msgid "This also stops the daemon from forking into the background."
32525 #: ../fuse/guestmount.pod:269
32527 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32528 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32534 #: ../fuse/guestmount.pod:284
32535 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32540 #: ../tools/virt-edit.pl:34
32541 msgid "virt-edit - Edit a file in a virtual machine"
32546 #: ../tools/virt-edit.pl:38
32549 " virt-edit [--options] domname file\n"
32555 #: ../tools/virt-edit.pl:40
32558 " virt-edit [--options] disk.img [disk.img ...] file\n"
32564 #: ../tools/virt-edit.pl:42
32567 " virt-edit [domname|disk.img] file -e 'expr'\n"
32573 #: ../tools/virt-edit.pl:46
32575 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32576 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32577 "doing this, but doesn't catch all cases."
32582 #: ../tools/virt-edit.pl:52
32584 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32585 "the named virtual machine (or disk image)."
32589 #: ../tools/virt-edit.pl:55
32590 msgid "If you want to just view a file, use L<virt-cat(1)>."
32594 #: ../tools/virt-edit.pl:57
32596 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32597 "USING GUESTFISH> below)."
32601 #: ../tools/virt-edit.pl:60
32603 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32604 "files. L<guestfish(1)> can do that and much more."
32609 #: ../tools/virt-edit.pl:65
32610 msgid "Edit the named files interactively:"
32615 #: ../tools/virt-edit.pl:67
32618 " virt-edit mydomain /boot/grub/grub.conf\n"
32624 #: ../tools/virt-edit.pl:69
32627 " virt-edit mydomain /etc/passwd\n"
32632 #: ../tools/virt-edit.pl:71
32633 msgid "For Windows guests, some Windows paths are understood:"
32637 #: ../tools/virt-edit.pl:73
32640 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32646 #: ../tools/virt-edit.pl:75
32648 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32649 "below). To change the init default level to 5:"
32654 #: ../tools/virt-edit.pl:79
32657 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32663 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32664 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32665 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32666 msgid "Display brief help."
32671 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32672 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
32673 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
32674 msgid "Display version number and exit."
32679 #: ../tools/virt-edit.pl:105
32680 msgid "B<--backup extension> | B<-b extension>"
32685 #: ../tools/virt-edit.pl:107
32687 "Create a backup of the original file I<in the guest disk image>. The backup "
32688 "has the original filename with C<extension> added."
32693 #: ../tools/virt-edit.pl:110
32695 "Usually the first character of C<extension> would be a dot C<.> so you would "
32701 #: ../tools/virt-edit.pl:113
32704 " virt-edit -b .orig [etc]\n"
32710 #: ../tools/virt-edit.pl:115
32711 msgid "By default, no backup file is made."
32716 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32717 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32718 #: ../tools/virt-list-partitions.pl:78
32719 msgid "B<--connect URI> | B<-c URI>"
32724 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32725 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32726 #: ../tools/virt-list-partitions.pl:80
32728 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32729 "to the default libvirt hypervisor."
32734 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32735 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32736 #: ../tools/virt-list-partitions.pl:83
32738 "If you specify guest block devices directly, then libvirt is not used at all."
32743 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32744 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
32745 #: ../tools/virt-list-partitions.pl:90
32746 msgid "B<--format> raw"
32751 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32752 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32753 #: ../tools/virt-list-partitions.pl:92
32755 "Specify the format of disk images given on the command line. If this is "
32756 "omitted then the format is autodetected from the content of the disk image."
32761 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32762 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32763 #: ../tools/virt-list-partitions.pl:96
32765 "If disk images are requested from libvirt, then this program asks libvirt "
32766 "for this information. In this case, the value of the format parameter is "
32772 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32773 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32774 #: ../tools/virt-list-partitions.pl:100
32776 "If working with untrusted raw-format guest disk images, you should ensure "
32777 "the format is always specified."
32782 #: ../tools/virt-edit.pl:150
32783 msgid "B<--expr EXPR> | B<-e EXPR>"
32788 #: ../tools/virt-edit.pl:152
32790 "Instead of launching the external editor, non-interactively apply the Perl "
32791 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32797 #: ../tools/virt-edit.pl:156
32799 "Be careful to properly quote the expression to prevent it from being altered "
32805 #: ../tools/virt-edit.pl:280
32806 msgid "NON-INTERACTIVE EDITING"
32811 #: ../tools/virt-edit.pl:282
32813 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32814 "administrator can interactively edit the file."
32819 #: ../tools/virt-edit.pl:285
32821 "There are two ways also to use C<virt-edit> from scripts in order to make "
32822 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32823 "like this, it's less error-prone to write scripts directly using the "
32824 "libguestfs API and Augeas for configuration file editing.)"
32829 #: ../tools/virt-edit.pl:291
32831 "The first method is to temporarily set C<$EDITOR> to any script or program "
32832 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32833 "update C<tmpfile> in place however it likes."
32837 #: ../tools/virt-edit.pl:295
32839 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
32840 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32841 "instances of C<foo> with C<bar> in a file:"
32846 #: ../tools/virt-edit.pl:299
32849 " virt-edit domname filename -e 's/foo/bar/'\n"
32855 #: ../tools/virt-edit.pl:301
32857 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32858 "For example to delete root's password you could do:"
32863 #: ../tools/virt-edit.pl:304
32866 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32872 #: ../tools/virt-edit.pl:306
32874 "What really happens is that the snippet is evaluated as a Perl expression "
32875 "for each line of the file. The line, including the final C<\\n>, is passed "
32876 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32881 #: ../tools/virt-edit.pl:311
32883 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32884 "C<apache> user account from the password file you can do:"
32889 #: ../tools/virt-edit.pl:314
32892 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32898 #: ../tools/virt-edit.pl:316
32900 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32901 "the end of the file is rather difficult this way since there is no concept "
32902 "of \"last line of the file\" - your expression just doesn't get called "
32903 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32909 #: ../tools/virt-edit.pl:322
32911 "The variable C<$lineno> contains the current line number. As is "
32912 "traditional, the first line in the file is number C<1>."
32917 #: ../tools/virt-edit.pl:325
32919 "The return value from the expression is ignored, but the expression may call "
32920 "C<die> in order to abort the whole program, leaving the original file "
32926 #: ../tools/virt-edit.pl:329
32928 "Remember when matching the end of a line that C<$_> may contain the final C<"
32929 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32930 "newline then neither of these. Thus to match or substitute some text at the "
32931 "end of a line, use this regular expression:"
32936 #: ../tools/virt-edit.pl:334
32939 " /some text(\\r?\\n)?$/\n"
32945 #: ../tools/virt-edit.pl:336
32947 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32948 "$_> itself (since that would remove all newlines from the file):"
32953 #: ../tools/virt-edit.pl:340
32956 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32961 #: ../tools/virt-edit.pl:344
32963 "C<virt-edit> has a limited ability to understand Windows drive letters and "
32964 "paths (eg. C<E:\\foo\\bar.txt>)."
32968 #: ../tools/virt-edit.pl:347
32969 msgid "If and only if the guest is running Windows then:"
32973 #: ../tools/virt-edit.pl:353
32975 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
32976 "to the correct filesystem."
32980 #: ../tools/virt-edit.pl:358
32982 "Any backslash (C<\\>) characters in the path are replaced with forward "
32983 "slashes so that libguestfs can process it."
32987 #: ../tools/virt-edit.pl:363
32989 "The path is resolved case insensitively to locate the file that should be "
32994 #: ../tools/virt-edit.pl:368
32995 msgid "There are some known shortcomings:"
32999 #: ../tools/virt-edit.pl:374
33000 msgid "Some NTFS symbolic links may not be followed correctly."
33004 #: ../tools/virt-edit.pl:378
33005 msgid "NTFS junction points that cross filesystems are not followed."
33009 #: ../tools/virt-edit.pl:435
33010 msgid "USING GUESTFISH"
33014 #: ../tools/virt-edit.pl:437
33016 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
33017 "C<virt-edit> doesn't work."
33021 #: ../tools/virt-edit.pl:440
33022 msgid "Using C<virt-edit> is approximately equivalent to doing:"
33026 #: ../tools/virt-edit.pl:442
33029 " guestfish --rw -i -d domname edit /file\n"
33034 #: ../tools/virt-edit.pl:444
33036 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
33037 "path to the file."
33041 #: ../tools/virt-edit.pl:447
33043 "The command above uses libguestfs's guest inspection feature and so does not "
33044 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
33045 "disk images that don't contain guests. To edit a file on a disk image "
33050 #: ../tools/virt-edit.pl:452
33053 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
33058 #: ../tools/virt-edit.pl:454
33060 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
33061 "the disk image to edit, and C</file> is the full path to the file."
33065 #: ../tools/virt-edit.pl:458
33067 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
33068 "C<write> or C<upload> instead:"
33072 #: ../tools/virt-edit.pl:461
33075 " guestfish --rw -i -d domname touch /newfile\n"
33080 #: ../tools/virt-edit.pl:463
33083 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
33088 #: ../tools/virt-edit.pl:465
33091 " guestfish --rw -i -d domname upload localfile /newfile\n"
33096 #: ../tools/virt-edit.pl:467
33098 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
33102 #: ../tools/virt-edit.pl:470
33105 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
33111 #: ../tools/virt-edit.pl:480
33117 #: ../tools/virt-edit.pl:482
33119 "If set, this string is used as the editor. It may contain arguments, eg. C<"
33125 #: ../tools/virt-edit.pl:485
33126 msgid "If not set, C<vi> is used."
33131 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
33132 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
33133 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
33134 msgid "SHELL QUOTING"
33139 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
33140 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
33141 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
33143 "Libvirt guest names can contain arbitrary characters, some of which have "
33144 "meaning to the shell such as C<#> and space. You may need to quote or "
33145 "escape these characters on the command line. See the shell manual page L<sh"
33146 "(1)> for details."
33150 #: ../tools/virt-edit.pl:498
33152 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
33153 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
33154 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
33159 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
33160 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
33161 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
33167 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
33168 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
33169 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
33170 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33174 #: ../tools/virt-edit.pl:516
33175 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33180 #: ../tools/virt-win-reg.pl:37
33182 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33187 #: ../tools/virt-win-reg.pl:41
33190 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33196 #: ../tools/virt-win-reg.pl:43
33199 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33205 #: ../tools/virt-win-reg.pl:45
33208 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33214 #: ../tools/virt-win-reg.pl:47
33217 " virt-win-reg --merge domname [input.reg ...]\n"
33223 #: ../tools/virt-win-reg.pl:49
33226 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33231 #: ../tools/virt-win-reg.pl:53
33233 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
33234 "virtual machines. If you do this, you I<will> get irreversible disk "
33235 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33236 "but doesn't catch all cases."
33240 #: ../tools/virt-win-reg.pl:58
33242 "Modifying the Windows Registry is an inherently risky operation. The format "
33243 "is deliberately obscure and undocumented, and Registry changes can leave the "
33244 "system unbootable. Therefore when using the I<--merge> option, make sure "
33245 "you have a reliable backup first."
33250 #: ../tools/virt-win-reg.pl:65
33252 "This program can export and merge Windows Registry entries from a Windows "
33258 #: ../tools/virt-win-reg.pl:68
33260 "The first parameter is the libvirt guest name or the raw disk image of a "
33265 #: ../tools/virt-win-reg.pl:71
33267 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
33268 "exported (recursively). For example:"
33273 #: ../tools/virt-win-reg.pl:74
33276 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33282 #: ../tools/virt-win-reg.pl:76
33284 "You can also display single values from within registry keys, for example:"
33289 #: ../tools/virt-win-reg.pl:79
33292 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33293 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33294 " Windows 7 Enterprise\n"
33299 #: ../tools/virt-win-reg.pl:83
33301 "With I<--merge>, you can merge a textual regedit file into the Windows "
33307 #: ../tools/virt-win-reg.pl:86
33310 " $ virt-win-reg --merge Windows7 changes.reg\n"
33316 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33322 #: ../tools/virt-win-reg.pl:90
33324 "This program is only meant for simple access to the registry. If you want "
33325 "to do complicated things with the registry, we suggest you download the "
33326 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33327 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33328 "L<hivexregedit(1)>."
33333 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33339 #: ../tools/virt-win-reg.pl:122
33340 msgid "Enable debugging messages."
33345 #: ../tools/virt-win-reg.pl:157
33351 #: ../tools/virt-win-reg.pl:159
33353 "In merge mode, this merges a textual regedit file into the Windows Registry "
33354 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33355 "displays or exports Registry entries instead."
33359 #: ../tools/virt-win-reg.pl:163
33361 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
33362 "result in disk corruption. However exporting (without this flag) is always "
33368 #: ../tools/virt-win-reg.pl:171
33369 msgid "B<--encoding> UTF-16LE|ASCII"
33374 #: ../tools/virt-win-reg.pl:173
33376 "When merging (only), you may need to specify the encoding for strings to be "
33377 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33378 "(3)/ENCODING STRINGS>."
33383 #: ../tools/virt-win-reg.pl:177
33385 "The default is to use UTF-16LE, which should work with recent versions of "
33391 #: ../tools/virt-win-reg.pl:402
33392 msgid "SUPPORTED SYSTEMS"
33397 #: ../tools/virt-win-reg.pl:404
33399 "The program currently supports Windows NT-derived guests starting with "
33400 "Windows XP through to at least Windows 7."
33405 #: ../tools/virt-win-reg.pl:407
33407 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33408 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33409 "and C<HKEY_USERS\\.DEFAULT>."
33414 #: ../tools/virt-win-reg.pl:411
33416 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33422 #: ../tools/virt-win-reg.pl:414
33424 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33430 #: ../tools/virt-win-reg.pl:417
33436 #: ../tools/virt-win-reg.pl:419
33438 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33439 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33440 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33441 "Windows-style line endings, you may need to reencode the whole file before "
33442 "or after processing."
33446 #: ../tools/virt-win-reg.pl:425
33448 "To reencode a file from Windows format to Linux (before processing it with "
33449 "the I<--merge> option), you would do something like this:"
33454 #: ../tools/virt-win-reg.pl:428
33457 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33463 #: ../tools/virt-win-reg.pl:430
33465 "To go in the opposite direction, after exporting and before sending the file "
33466 "to a Windows user, do something like this:"
33471 #: ../tools/virt-win-reg.pl:433
33474 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33480 #: ../tools/virt-win-reg.pl:435
33481 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33486 #: ../tools/virt-win-reg.pl:437
33488 "If you are unsure about the current encoding, use the L<file(1)> command. "
33489 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33490 "style (CRLF) line endings, like this:"
33495 #: ../tools/virt-win-reg.pl:441
33498 " $ file software.reg\n"
33499 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33500 " with CRLF line terminators\n"
33505 #: ../tools/virt-win-reg.pl:445
33506 msgid "This file would need conversion before you could I<--merge> it."
33511 #: ../tools/virt-win-reg.pl:447
33512 msgid "CurrentControlSet etc."
33517 #: ../tools/virt-win-reg.pl:449
33519 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33520 "Registry at the level of the hive file, and therefore you cannot modify "
33526 #: ../tools/virt-win-reg.pl:453
33528 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33529 "circumstances it might refer to another control set. The way to find out is "
33530 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33535 #: ../tools/virt-win-reg.pl:457
33538 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33539 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33540 " \"Current\"=dword:00000001\n"
33541 " \"Default\"=dword:00000001\n"
33542 " \"Failed\"=dword:00000000\n"
33543 " \"LastKnownGood\"=dword:00000002\n"
33549 #: ../tools/virt-win-reg.pl:464
33550 msgid "\"Current\" is the one which Windows will choose when it boots."
33555 #: ../tools/virt-win-reg.pl:466
33557 "Similarly, other C<Current...> keys in the path may need to be replaced."
33562 #: ../tools/virt-win-reg.pl:469
33563 msgid "WINDOWS TIPS"
33568 #: ../tools/virt-win-reg.pl:471
33570 "Note that some of these tips modify the guest disk image. The guest I<must> "
33571 "be shut off, else you will get disk corruption."
33576 #: ../tools/virt-win-reg.pl:474
33577 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33582 #: ../tools/virt-win-reg.pl:476
33584 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33585 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33586 "is uploaded into C<C:\\>:"
33591 #: ../tools/virt-win-reg.pl:480
33594 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33600 #: ../tools/virt-win-reg.pl:482
33601 msgid "Prepare a regedit file containing the registry change:"
33606 #: ../tools/virt-win-reg.pl:484
33609 " cat > test.reg <<'EOF'\n"
33610 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33611 " \"Test\"=\"c:\\\\test.bat\"\n"
33618 #: ../tools/virt-win-reg.pl:489
33620 "In this example we use the key C<RunOnce> which means that the script will "
33621 "run precisely once when the first user logs in. If you want it to run every "
33622 "time a user logs in, replace C<RunOnce> with C<Run>."
33627 #: ../tools/virt-win-reg.pl:493
33628 msgid "Now update the registry:"
33633 #: ../tools/virt-win-reg.pl:495
33636 " virt-win-reg --merge WindowsGuest test.reg\n"
33642 #: ../tools/virt-win-reg.pl:497
33643 msgid "INSTALLING A SERVICE"
33648 #: ../tools/virt-win-reg.pl:499
33650 "This section assumes you are familiar with Windows services, and you either "
33651 "have a program which handles the Windows Service Control Protocol directly "
33652 "or you want to run any program using a service wrapper like SrvAny or the "
33658 #: ../tools/virt-win-reg.pl:504
33660 "First upload the program and optionally the service wrapper. In this case "
33661 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33666 #: ../tools/virt-win-reg.pl:508
33669 " guestfish -i -d WindowsGuest <<EOF\n"
33670 " upload rhsrvany.exe /rhsrvany.exe\n"
33671 " upload test.exe /test.exe\n"
33678 #: ../tools/virt-win-reg.pl:513
33680 "Prepare a regedit file containing the registry changes. In this example, "
33681 "the first registry change is needed for the service itself or the service "
33682 "wrapper (if used). The second registry change is only needed because I am "
33683 "using the RHSrvAny service wrapper."
33688 #: ../tools/virt-win-reg.pl:518
33691 " cat > service.reg <<'EOF'\n"
33692 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33693 " \"Type\"=dword:00000010\n"
33694 " \"Start\"=dword:00000002\n"
33695 " \"ErrorControl\"=dword:00000001\n"
33696 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33697 " \"DisplayName\"=\"RHSrvAny\"\n"
33698 " \"ObjectName\"=\"NetworkService\"\n"
33704 #: ../tools/virt-win-reg.pl:527
33707 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33708 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33709 " \"PWD\"=\"c:\\\\Temp\"\n"
33716 #: ../tools/virt-win-reg.pl:538
33718 "For use of C<ControlSet001> see the section above in this manual page. You "
33719 "may need to adjust this according to the control set that is in use by the "
33725 #: ../tools/virt-win-reg.pl:544
33727 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33728 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33729 "privileged account."
33734 #: ../tools/virt-win-reg.pl:550
33736 "For the meaning of the magic numbers, see this Microsoft KB article: "
33737 "L<http://support.microsoft.com/kb/103000>."
33742 #: ../tools/virt-win-reg.pl:555
33743 msgid "Update the registry:"
33748 #: ../tools/virt-win-reg.pl:557
33751 " virt-win-reg --merge WindowsGuest service.reg\n"
33757 #: ../tools/virt-win-reg.pl:561
33759 "Be careful when passing parameters containing C<\\> (backslash) in the "
33760 "shell. Usually you will have to use 'single quotes' or double backslashes "
33761 "(but not both) to protect them from the shell."
33766 #: ../tools/virt-win-reg.pl:565
33767 msgid "Paths and value names are case-insensitive."
33772 #: ../tools/virt-win-reg.pl:574
33774 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33775 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33776 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33781 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33783 "When reporting bugs, please enable debugging and capture the I<complete> "
33789 #: ../tools/virt-win-reg.pl:592
33792 " export LIBGUESTFS_DEBUG=1\n"
33793 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33799 #: ../tools/virt-win-reg.pl:595
33801 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33807 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
33808 msgid "Copyright (C) 2010 Red Hat Inc."
33813 #: ../tools/virt-list-filesystems.pl:32
33815 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33820 #: ../tools/virt-list-filesystems.pl:36
33823 " virt-list-filesystems [--options] domname\n"
33829 #: ../tools/virt-list-filesystems.pl:38
33832 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33838 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33840 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33846 #: ../tools/virt-list-filesystems.pl:45
33848 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33849 "are contained in a virtual machine or disk image."
33854 #: ../tools/virt-list-filesystems.pl:49
33856 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33857 "functionality. For more complex cases you should look at the L<guestfish(1)"
33863 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33864 msgid "B<-l> | B<--long>"
33869 #: ../tools/virt-list-filesystems.pl:108
33871 "With this option, C<virt-list-filesystems> displays the type of each "
33872 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33877 #: ../tools/virt-list-filesystems.pl:115
33878 msgid "B<-a> | B<--all>"
33883 #: ../tools/virt-list-filesystems.pl:117
33885 "Normally we only show mountable filesystems. If this option is given then "
33886 "swap devices are shown too."
33891 #: ../tools/virt-list-filesystems.pl:191
33893 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33894 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33895 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33900 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33901 msgid "Copyright (C) 2009 Red Hat Inc."
33906 #: ../tools/virt-tar.pl:33
33907 msgid "virt-tar - Extract or upload files to a virtual machine"
33912 #: ../tools/virt-tar.pl:37
33915 " virt-tar [--options] -x domname directory tarball\n"
33921 #: ../tools/virt-tar.pl:39
33924 " virt-tar [--options] -u domname tarball directory\n"
33930 #: ../tools/virt-tar.pl:41
33933 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33939 #: ../tools/virt-tar.pl:43
33942 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33947 #: ../tools/virt-tar.pl:47
33949 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
33950 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
33955 #: ../tools/virt-tar.pl:52
33956 msgid "Download C</home> from the VM into a local tarball:"
33961 #: ../tools/virt-tar.pl:54
33964 " virt-tar -x domname /home home.tar\n"
33970 #: ../tools/virt-tar.pl:56
33973 " virt-tar -zx domname /home home.tar.gz\n"
33979 #: ../tools/virt-tar.pl:58
33980 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33985 #: ../tools/virt-tar.pl:60
33988 " virt-tar -u domname uploadstuff.tar /tmp\n"
33994 #: ../tools/virt-tar.pl:62
33997 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34002 #: ../tools/virt-tar.pl:66
34004 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
34005 "virtual machines. If you do this, you risk disk corruption in the VM. "
34006 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34010 #: ../tools/virt-tar.pl:71
34012 "You can use I<-x> (extract) on live virtual machines, but you might get "
34013 "inconsistent results or errors if there is filesystem activity inside the "
34014 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34015 "work, but the only way to guarantee consistent results is if the virtual "
34016 "machine is shut down."
34021 #: ../tools/virt-tar.pl:79
34023 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34024 "parts of a guest filesystem. There are many possibilities: making backups, "
34025 "uploading data files, snooping on guest activity, fixing or customizing "
34031 #: ../tools/virt-tar.pl:84
34033 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34034 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34035 "should look at the L<guestfish(1)> tool."
34039 #: ../tools/virt-tar.pl:88
34041 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
34042 "its contents (recursively) from the virtual machine into a local tarball. "
34043 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
34044 "virtual machine. You cannot use these two options together."
34048 #: ../tools/virt-tar.pl:94
34050 "In addition, you may need to use the I<-z> (gZip) option to enable "
34051 "compression. When uploading, you have to specify I<-z> if the upload file "
34052 "is compressed because virt-tar won't detect this on its own."
34057 #: ../tools/virt-tar.pl:98
34059 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34060 "example it cannot do PKZip files or bzip2 compression. If you want that "
34061 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34062 "the L<libguestfs(3)> API)."
34067 #: ../tools/virt-tar.pl:156
34068 msgid "B<-x> | B<--extract> | B<--download>"
34073 #: ../tools/virt-tar.pl:158
34074 msgid "B<-u> | B<--upload>"
34078 #: ../tools/virt-tar.pl:160
34080 "Use I<-x> to extract (download) a directory from a virtual machine to a "
34085 #: ../tools/virt-tar.pl:163
34087 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
34088 "Please read the L</WARNING> section above before using this option."
34093 #: ../tools/virt-tar.pl:167
34094 msgid "You must specify exactly one of these options."
34099 #: ../tools/virt-tar.pl:173
34100 msgid "B<-z> | B<--gzip>"
34105 #: ../tools/virt-tar.pl:175
34106 msgid "Specify that the input or output tarball is gzip-compressed."
34110 #: ../tools/virt-tar.pl:288
34112 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34113 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34114 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34120 #: ../tools/virt-make-fs.pl:37
34121 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34126 #: ../tools/virt-make-fs.pl:41
34129 " virt-make-fs [--options] input.tar output.img\n"
34135 #: ../tools/virt-make-fs.pl:43
34138 " virt-make-fs [--options] input.tar.gz output.img\n"
34144 #: ../tools/virt-make-fs.pl:45
34147 " virt-make-fs [--options] directory output.img\n"
34153 #: ../tools/virt-make-fs.pl:49
34155 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34156 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34157 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34158 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34159 "you want to attach these filesystems to existing virtual machines (eg. to "
34160 "import large amounts of read-only data to a VM)."
34165 #: ../tools/virt-make-fs.pl:57
34166 msgid "Basic usage is:"
34171 #: ../tools/virt-make-fs.pl:59
34174 " virt-make-fs input output\n"
34180 #: ../tools/virt-make-fs.pl:61
34182 "where C<input> is either a directory containing files that you want to add, "
34183 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34184 "C<output> is a disk image. The input type is detected automatically. The "
34185 "output disk image defaults to a raw ext2 image unless you specify extra "
34186 "flags (see L</OPTIONS> below)."
34191 #: ../tools/virt-make-fs.pl:67
34192 msgid "EXTRA SPACE"
34196 #: ../tools/virt-make-fs.pl:69
34198 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34199 "the files that it contains, but might have extra space. Depending on how "
34200 "you are going to use the output, you might think this extra space is wasted "
34201 "and want to minimize it, or you might want to leave space so that more files "
34202 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34203 "but you can use the I<--size> flag to leave space in the filesystem if you "
34208 #: ../tools/virt-make-fs.pl:77
34210 "An alternative way to leave extra space but not make the output image any "
34211 "bigger is to use an alternative disk image format (instead of the default "
34212 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
34213 "image format (check your hypervisor supports this before using it). This "
34214 "allows you to choose a large I<--size> but the extra space won't actually be "
34215 "allocated in the image until you try to store something in it."
34219 #: ../tools/virt-make-fs.pl:85
34221 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34222 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34223 "to build another image from scratch."
34228 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34229 #: ../tools/virt-make-fs.pl:142
34235 #: ../tools/virt-make-fs.pl:91
34238 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34244 #: ../tools/virt-make-fs.pl:93
34245 msgid "FILESYSTEM TYPE"
34250 #: ../tools/virt-make-fs.pl:95
34252 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34253 "libguestfs supports can be used (but I<not> read-only formats like "
34254 "ISO9660). Here are some of the more common choices:"
34259 #: ../tools/virt-make-fs.pl:101
34265 #: ../tools/virt-make-fs.pl:103
34267 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34268 "you are not going to use the filesystem in a way that requires the journal, "
34269 "then this is just wasted overhead."
34274 #: ../tools/virt-make-fs.pl:107
34275 msgid "I<ntfs> or I<vfat>"
34280 #: ../tools/virt-make-fs.pl:109
34281 msgid "Useful if exporting data to a Windows guest."
34286 #: ../tools/virt-make-fs.pl:111
34288 "I<Note for vfat>: The tar archive or local directory must only contain files "
34289 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34290 "program running within libguestfs is unable to change the ownership of non-"
34291 "root files, since vfat itself does not support this."
34296 #: ../tools/virt-make-fs.pl:116
34302 #: ../tools/virt-make-fs.pl:118
34304 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34305 "total filesystem size."
34310 #: ../tools/virt-make-fs.pl:125
34313 " virt-make-fs --type=minix input minixfs.img\n"
34319 #: ../tools/virt-make-fs.pl:127
34320 msgid "TO PARTITION OR NOT TO PARTITION"
34325 #: ../tools/virt-make-fs.pl:129
34326 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34331 #: ../tools/virt-make-fs.pl:131
34333 "Adding a partition can make the disk image more compatible with certain "
34334 "virtualized operating systems which don't expect to see a filesystem "
34335 "directly located on a block device (Linux doesn't care and will happily "
34336 "handle both types)."
34341 #: ../tools/virt-make-fs.pl:136
34343 "On the other hand, if you have a partition table then the output image is no "
34344 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34345 "directly on a partitioned disk image. (However libguestfs tools such as "
34346 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34351 #: ../tools/virt-make-fs.pl:144
34352 msgid "Add an MBR partition:"
34357 #: ../tools/virt-make-fs.pl:146
34360 " virt-make-fs --partition -- input disk.img\n"
34366 #: ../tools/virt-make-fs.pl:148
34368 "If the output disk image could be terabyte-sized or larger, it's better to "
34369 "use an EFI/GPT-compatible partition table:"
34374 #: ../tools/virt-make-fs.pl:151
34377 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34383 #: ../tools/virt-make-fs.pl:179
34384 msgid "Enable debugging information."
34389 #: ../tools/virt-make-fs.pl:185
34390 msgid "B<--size=E<lt>NE<gt>>"
34395 #: ../tools/virt-make-fs.pl:187
34396 msgid "B<--size=+E<lt>NE<gt>>"
34401 #: ../tools/virt-make-fs.pl:189
34402 msgid "B<-s E<lt>NE<gt>>"
34407 #: ../tools/virt-make-fs.pl:191
34408 msgid "B<-s +E<lt>NE<gt>>"
34412 #: ../tools/virt-make-fs.pl:193
34414 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
34419 #: ../tools/virt-make-fs.pl:196
34421 "If this option is I<not> given, then the output image will be just large "
34422 "enough to contain all the files, with not much wasted space."
34427 #: ../tools/virt-make-fs.pl:199
34429 "To choose a fixed size output disk, specify an absolute number followed by b/"
34430 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34431 "Petabytes or Exabytes. This must be large enough to contain all the input "
34432 "files, else you will get an error."
34436 #: ../tools/virt-make-fs.pl:204
34438 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34439 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34440 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
34441 "the input files, and (approximately) an extra 200 MB free space."
34446 #: ../tools/virt-make-fs.pl:210
34448 "Note that virt-make-fs estimates free space, and therefore will not produce "
34449 "filesystems containing precisely the free space requested. (It is much more "
34450 "expensive and time-consuming to produce a filesystem which has precisely the "
34451 "desired free space)."
34456 #: ../tools/virt-make-fs.pl:219
34457 msgid "B<--format=E<lt>fmtE<gt>>"
34462 #: ../tools/virt-make-fs.pl:221
34463 msgid "B<-F E<lt>fmtE<gt>>"
34468 #: ../tools/virt-make-fs.pl:223
34469 msgid "Choose the output disk image format."
34474 #: ../tools/virt-make-fs.pl:225
34475 msgid "The default is C<raw> (raw disk image)."
34480 #: ../tools/virt-make-fs.pl:227
34482 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34483 "that would really make sense here is C<qcow2>."
34488 #: ../tools/virt-make-fs.pl:234
34489 msgid "B<--type=E<lt>fsE<gt>>"
34494 #: ../tools/virt-make-fs.pl:236
34495 msgid "B<-t E<lt>fsE<gt>>"
34500 #: ../tools/virt-make-fs.pl:238
34501 msgid "Choose the output filesystem type."
34506 #: ../tools/virt-make-fs.pl:240
34507 msgid "The default is C<ext2>."
34512 #: ../tools/virt-make-fs.pl:242
34514 "Any filesystem which is supported read-write by libguestfs can be used here."
34519 #: ../tools/virt-make-fs.pl:249
34520 msgid "B<--partition>"
34525 #: ../tools/virt-make-fs.pl:251
34526 msgid "B<--partition=E<lt>parttypeE<gt>>"
34531 #: ../tools/virt-make-fs.pl:253
34533 "If specified, this flag adds an MBR partition table to the output disk image."
34537 #: ../tools/virt-make-fs.pl:256
34539 "You can change the partition table type, eg. I<--partition=gpt> for large "
34544 #: ../tools/virt-make-fs.pl:259
34546 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
34547 "might consider the next parameter to be the partition type. For example:"
34552 #: ../tools/virt-make-fs.pl:263
34555 " virt-make-fs --partition input.tar ...\n"
34560 #: ../tools/virt-make-fs.pl:265
34562 "would cause virt-make-fs to think you wanted to use a partition type of "
34563 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
34564 "dash) between options and the input file argument:"
34569 #: ../tools/virt-make-fs.pl:269
34572 " virt-make-fs --partition -- input.tar ...\n"
34577 #: ../tools/virt-make-fs.pl:541
34579 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34580 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34581 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34586 #: ../tools/virt-make-fs.pl:558
34589 " export LIBGUESTFS_DEBUG=1\n"
34590 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34596 #: ../tools/virt-make-fs.pl:561
34598 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34604 #: ../tools/virt-list-partitions.pl:32
34606 "virt-list-partitions - List partitions in a virtual machine or disk image"
34611 #: ../tools/virt-list-partitions.pl:36
34614 " virt-list-partitions [--options] domname\n"
34620 #: ../tools/virt-list-partitions.pl:38
34623 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34629 #: ../tools/virt-list-partitions.pl:45
34631 "C<virt-list-partitions> is a command line tool to list the partitions that "
34632 "are contained in a virtual machine or disk image. It is mainly useful as a "
34633 "first step to using L<virt-resize(1)>."
34638 #: ../tools/virt-list-partitions.pl:50
34640 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34641 "functionality. For more complex cases you should look at the L<guestfish(1)"
34647 #: ../tools/virt-list-partitions.pl:107
34648 msgid "B<-h> | B<--human-readable>"
34653 #: ../tools/virt-list-partitions.pl:109
34654 msgid "Show sizes in human-readable form (eg. \"1G\")."
34659 #: ../tools/virt-list-partitions.pl:117
34661 "With this option, C<virt-list-partitions> displays the type and size of each "
34662 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34667 #: ../tools/virt-list-partitions.pl:124
34668 msgid "B<-t> | B<--total>"
34673 #: ../tools/virt-list-partitions.pl:126
34675 "Display the total size of each block device (as a separate row or rows)."
34680 #: ../tools/virt-list-partitions.pl:259
34682 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34683 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34684 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34689 #: ../tools/virt-list-partitions.pl:275
34690 msgid "Copyright (C) 2009-2010 Red Hat Inc."