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-04-09 18:35+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"
840 #: ../src/guestfs.pod:357
841 msgid "and you can write tar output to a pipe C<fd> by doing:"
845 #: ../src/guestfs.pod:359
849 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
850 " guestfs_tar_out (g, \"/\", devfd);\n"
856 #: ../src/guestfs.pod:363
857 msgid "LISTING FILES"
862 #: ../src/guestfs.pod:365
864 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
865 "L<guestfish(1)>-equivalent command C<ll>)."
870 #: ../src/guestfs.pod:368
872 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
873 "programs, as a flat list of strings."
878 #: ../src/guestfs.pod:371
880 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
881 "directory, plus additional information about each one. It is more "
882 "equivalent to using the L<readdir(3)> call on a local filesystem."
887 #: ../src/guestfs.pod:375
889 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
894 #: ../src/guestfs.pod:378
895 msgid "RUNNING COMMANDS"
900 #: ../src/guestfs.pod:380
902 "Although libguestfs is primarily an API for manipulating files inside guest "
903 "images, we also provide some limited facilities for running commands inside "
909 #: ../src/guestfs.pod:384
910 msgid "There are many limitations to this:"
915 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
916 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
917 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1088
918 #: ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101
919 #: ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136
920 #: ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166
921 #: ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178
922 #: ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669
923 #: ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779
924 #: ../src/guestfs.pod:1789 ../src/guestfs.pod:2023 ../src/guestfs.pod:2028
925 #: ../src/guestfs.pod:2034 ../src/guestfs.pod:2042 ../src/guestfs.pod:2396
926 #: ../src/guestfs.pod:2402 ../src/guestfs.pod:2407 ../src/guestfs.pod:2413
927 #: ../src/guestfs.pod:2878 ../src/guestfs.pod:2882 ../src/guestfs.pod:2886
928 #: ../src/guestfs.pod:2890 ../src/guestfs-actions.pod:15
929 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
930 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
931 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600
932 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
933 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620
934 #: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628
935 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642
936 #: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784
937 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
938 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859
939 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868
940 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
941 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
942 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
943 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
944 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
945 #: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076
946 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
947 #: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096
948 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110
949 #: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118
950 #: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212
951 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222
952 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268
953 #: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351
954 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
955 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
956 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
957 #: ../tools/virt-win-reg.pl:548
963 #: ../src/guestfs.pod:390
965 "The kernel version that the command runs under will be different from what "
971 #: ../src/guestfs.pod:395
973 "If the command needs to communicate with daemons, then most likely they "
979 #: ../src/guestfs.pod:400
980 msgid "The command will be running in limited memory."
985 #: ../src/guestfs.pod:404
987 "The network may not be available unless you enable it (see L</"
988 "guestfs_set_network>)."
993 #: ../src/guestfs.pod:409
994 msgid "Only supports Linux guests (not Windows, BSD, etc)."
999 #: ../src/guestfs.pod:413
1001 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1006 #: ../src/guestfs.pod:418
1008 "For SELinux guests, you may need to enable SELinux and load policy first. "
1009 "See L</SELINUX> in this manpage."
1014 #: ../src/guestfs.pod:423
1016 "I<Security:> It is not safe to run commands from untrusted, possibly "
1017 "malicious guests. These commands may attempt to exploit your program by "
1018 "sending unexpected output. They could also try to exploit the Linux kernel "
1019 "or qemu provided by the libguestfs appliance. They could use the network "
1020 "provided by the libguestfs appliance to bypass ordinary network partitions "
1021 "and firewalls. They could use the elevated privileges or different SELinux "
1022 "context of your program to their advantage."
1027 #: ../src/guestfs.pod:432
1029 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1030 "(a script which runs when the guest next boots normally), and to have this "
1031 "script run the commands you want in the normal context of the running guest, "
1032 "network security and so on. For information about other security issues, "
1038 #: ../src/guestfs.pod:440
1040 "The two main API calls to run commands are L</guestfs_command> and L</"
1041 "guestfs_sh> (there are also variations)."
1046 #: ../src/guestfs.pod:443
1048 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1049 "shell globs, redirections, etc will work."
1054 #: ../src/guestfs.pod:446
1055 msgid "CONFIGURATION FILES"
1060 #: ../src/guestfs.pod:448
1062 "To read and write configuration files in Linux guest filesystems, we "
1063 "strongly recommend using Augeas. For example, Augeas understands how to "
1064 "read and write, say, a Linux shadow password file or X.org configuration "
1065 "file, and so avoids you having to write that code."
1070 #: ../src/guestfs.pod:453
1072 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1073 "document Augeas itself here because there is excellent documentation on the "
1074 "L<http://augeas.net/> website."
1079 #: ../src/guestfs.pod:457
1081 "If you don't want to use Augeas (you fool!) then try calling L</"
1082 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1088 #: ../src/guestfs.pod:461
1094 #: ../src/guestfs.pod:463
1096 "We support SELinux guests. To ensure that labeling happens correctly in "
1097 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1102 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1103 #: ../src/guestfs.pod:2441
1109 #: ../src/guestfs.pod:471
1110 msgid "Before launching, do:"
1115 #: ../src/guestfs.pod:473
1118 " guestfs_set_selinux (g, 1);\n"
1124 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1125 #: ../src/guestfs.pod:2466
1131 #: ../src/guestfs.pod:477
1133 "After mounting the guest's filesystem(s), load the policy. This is best "
1134 "done by running the L<load_policy(8)> command in the guest itself:"
1139 #: ../src/guestfs.pod:481
1142 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1148 #: ../src/guestfs.pod:483
1150 "(Older versions of C<load_policy> require you to specify the name of the "
1156 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1162 #: ../src/guestfs.pod:488
1164 "Optionally, set the security context for the API. The correct security "
1165 "context to use can only be known by inspecting the guest. As an example:"
1170 #: ../src/guestfs.pod:492
1173 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1179 #: ../src/guestfs.pod:496
1180 msgid "This will work for running commands and editing existing files."
1185 #: ../src/guestfs.pod:498
1187 "When new files are created, you may need to label them explicitly, for "
1188 "example by running the external command C<restorecon pathname>."
1193 #: ../src/guestfs.pod:502
1199 #: ../src/guestfs.pod:504
1201 "Certain calls are affected by the current file mode creation mask (the "
1202 "\"umask\"). In particular ones which create files or directories, such as "
1203 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1204 "either the default mode that the file is created with or modifies the mode "
1210 #: ../src/guestfs.pod:510
1212 "The default umask is C<022>, so files are created with modes such as C<0644> "
1213 "and directories with C<0755>."
1218 #: ../src/guestfs.pod:513
1220 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1221 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1222 "guestfs_chmod> after creating each file or directory."
1227 #: ../src/guestfs.pod:517
1228 msgid "For more information about umask, see L<umask(2)>."
1233 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1234 msgid "ENCRYPTED DISKS"
1239 #: ../src/guestfs.pod:521
1241 "Libguestfs allows you to access Linux guests which have been encrypted using "
1242 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1243 "standard. This includes nearly all whole disk encryption systems used by "
1244 "modern Linux guests."
1249 #: ../src/guestfs.pod:527
1251 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1252 "returns the string C<crypto_LUKS>)."
1257 #: ../src/guestfs.pod:530
1259 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1260 "will require the passphrase!"
1265 #: ../src/guestfs.pod:533
1267 "Opening a LUKS device creates a new device mapper device called C</dev/"
1268 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1269 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1270 "from and encrypted to the underlying block device respectively."
1275 #: ../src/guestfs.pod:539
1277 "LVM volume groups on the device can be made visible by calling L</"
1278 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1279 "(s) can now be mounted in the usual way."
1284 #: ../src/guestfs.pod:543
1286 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1287 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1288 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1289 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1290 "underlying encrypted block device)."
1295 #: ../src/guestfs.pod:550
1300 #: ../src/guestfs.pod:552
1302 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1303 "contains operating systems, an install CD or a live CD. (These APIs used to "
1304 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1305 "version 1.5.3 the most frequently used part of this library has been "
1306 "rewritten in C and moved into the core code)."
1311 #: ../src/guestfs.pod:559
1313 "Add all disks belonging to the unknown virtual machine and call L</"
1314 "guestfs_launch> in the usual way."
1319 #: ../src/guestfs.pod:562
1321 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1322 "and certain heuristics, and returns a list of operating systems that were "
1323 "found. An empty list means none were found. A single element is the root "
1324 "filesystem of the operating system. For dual- or multi-boot guests, "
1325 "multiple roots can be returned, each one corresponding to a separate "
1326 "operating system. (Multi-boot virtual machines are extremely rare in the "
1327 "world of virtualization, but since this scenario can happen, we have built "
1328 "libguestfs to deal with it.)"
1333 #: ../src/guestfs.pod:571
1335 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1336 "to get additional details about that operating system. For example, call L</"
1337 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1338 "Windows and Linux-based operating systems respectively."
1343 #: ../src/guestfs.pod:577
1345 "Un*x-like and Linux-based operating systems usually consist of several "
1346 "filesystems which are mounted at boot time (for example, a separate boot "
1347 "partition mounted on C</boot>). The inspection rules are able to detect how "
1348 "filesystems correspond to mount points. Call "
1349 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1350 "hash table like this example:"
1355 #: ../src/guestfs.pod:584
1358 " /boot => /dev/sda1\n"
1359 " / => /dev/vg_guest/lv_root\n"
1360 " /usr => /dev/vg_guest/lv_usr\n"
1366 #: ../src/guestfs.pod:588
1368 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1369 "filesystems as suggested."
1374 #: ../src/guestfs.pod:591
1376 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1377 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1382 #: ../src/guestfs.pod:595
1384 "Inspection currently only works for some common operating systems. "
1385 "Contributors are welcome to send patches for other operating systems that we "
1386 "currently cannot detect."
1391 #: ../src/guestfs.pod:599
1393 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1394 "for more details. The L</guestfs_inspect_os> function just ignores any "
1395 "encrypted devices."
1400 #: ../src/guestfs.pod:603
1402 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1403 "inspection and caches the results in the guest handle. Subsequent calls to "
1404 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1405 "read the disks. If you change the content of the guest disks, you can redo "
1406 "inspection by calling L</guestfs_inspect_os> again. (L</"
1407 "guestfs_inspect_list_applications> works a little differently from the other "
1408 "calls and does read the disks. See documentation for that function for "
1413 #: ../src/guestfs.pod:612
1414 msgid "INSPECTING INSTALL DISKS"
1418 #: ../src/guestfs.pod:614
1420 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1425 #: ../src/guestfs.pod:617
1427 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1428 "system, which currently can be C<installed> (a regular operating system) or "
1429 "C<installer> (some sort of install disk)."
1433 #: ../src/guestfs.pod:621
1435 "Further information is available about the operating system that can be "
1436 "installed using the regular inspection APIs like L</"
1437 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1441 #: ../src/guestfs.pod:626
1443 "Some additional information specific to installer disks is also available "
1444 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1445 "guestfs_inspect_is_multipart> calls."
1450 #: ../src/guestfs.pod:631
1451 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1456 #: ../src/guestfs.pod:633
1458 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1459 "ntfs-3g.org/> driver."
1464 #: ../src/guestfs.pod:636
1465 msgid "DRIVE LETTERS AND PATHS"
1470 #: ../src/guestfs.pod:638
1472 "DOS and Windows still use drive letters, and the filesystems are always "
1473 "treated as case insensitive by Windows itself, and therefore you might find "
1474 "a Windows configuration file referring to a path like C<c:\\windows"
1475 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1476 "might be referred to as C</WINDOWS/System32>."
1481 #: ../src/guestfs.pod:644
1483 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1484 "libguestfs to read the appropriate Windows Registry and configuration files, "
1485 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1491 #: ../src/guestfs.pod:649
1493 "Replacing backslash characters with forward slash characters is also outside "
1494 "the scope of libguestfs, but something that you can easily do."
1499 #: ../src/guestfs.pod:652
1501 "Where we can help is in resolving the case insensitivity of paths. For "
1502 "this, call L</guestfs_case_sensitive_path>."
1507 #: ../src/guestfs.pod:655
1508 msgid "ACCESSING THE WINDOWS REGISTRY"
1513 #: ../src/guestfs.pod:657
1515 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1516 "files, through the library C<hivex> which is part of the libguestfs project "
1517 "although ships as a separate tarball. You have to locate and download the "
1518 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1519 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1520 "reg(1)> for more help on this issue."
1525 #: ../src/guestfs.pod:665
1526 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1531 #: ../src/guestfs.pod:667
1533 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1534 "provide something which looks like a Linux symlink. The way it tries to do "
1535 "the rewriting is described here:"
1540 #: ../src/guestfs.pod:671
1542 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1548 #: ../src/guestfs.pod:673
1550 "The essential problem is that ntfs-3g simply does not have enough "
1551 "information to do a correct job. NTFS links can contain drive letters and "
1552 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1553 "It is almost certainly the case that libguestfs callers should ignore what "
1554 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1559 #: ../src/guestfs.pod:680
1561 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1562 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1563 "attribute, and read the raw reparse data from that (you can find the format "
1564 "documented in various places around the web)."
1569 #: ../src/guestfs.pod:685
1570 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1575 #: ../src/guestfs.pod:687
1577 "There are other useful extended attributes that can be read from ntfs-3g "
1578 "filesystems (using L</guestfs_getxattr>). See:"
1583 #: ../src/guestfs.pod:690
1585 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1590 #: ../src/guestfs.pod:692
1591 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1596 #: ../src/guestfs.pod:694
1598 "Although we don't want to discourage you from using the C API, we will "
1599 "mention here that the same API is also available in other languages."
1603 #: ../src/guestfs.pod:697
1605 "The API is broadly identical in all supported languages. This means that "
1606 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1607 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1608 "OCaml. In other words, a straightforward, predictable isomorphism between "
1614 #: ../src/guestfs.pod:703
1616 "Error messages are automatically transformed into exceptions if the language "
1622 #: ../src/guestfs.pod:706
1624 "We don't try to \"object orientify\" parts of the API in OO languages, "
1625 "although contributors are welcome to write higher level APIs above what we "
1626 "provide in their favourite languages if they wish."
1631 #: ../src/guestfs.pod:712
1637 #: ../src/guestfs.pod:714
1639 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1640 "identical to the C API. C++ classes and exceptions are not used."
1645 #: ../src/guestfs.pod:718
1651 #: ../src/guestfs.pod:720
1653 "The C# bindings are highly experimental. Please read the warnings at the "
1654 "top of C<csharp/Libguestfs.cs>."
1659 #: ../src/guestfs.pod:723
1665 #: ../src/guestfs.pod:725
1667 "This is the only language binding that is working but incomplete. Only "
1668 "calls which return simple integers have been bound in Haskell, and we are "
1669 "looking for help to complete this binding."
1674 #: ../src/guestfs.pod:729
1680 #: ../src/guestfs.pod:731
1682 "Full documentation is contained in the Javadoc which is distributed with "
1688 #: ../src/guestfs.pod:734
1693 #: ../src/guestfs.pod:736
1694 msgid "See L<guestfs-ocaml(3)>."
1699 #: ../src/guestfs.pod:738
1704 #: ../src/guestfs.pod:740
1705 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1710 #: ../src/guestfs.pod:742
1716 #: ../src/guestfs.pod:744
1718 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1719 "the php-libguestfs package for your distribution."
1724 #: ../src/guestfs.pod:747
1725 msgid "The PHP binding only works correctly on 64 bit machines."
1730 #: ../src/guestfs.pod:749
1735 #: ../src/guestfs.pod:751
1736 msgid "See L<guestfs-python(3)>."
1741 #: ../src/guestfs.pod:753
1746 #: ../src/guestfs.pod:755
1747 msgid "See L<guestfs-ruby(3)>."
1752 #: ../src/guestfs.pod:757
1753 msgid "B<shell scripts>"
1757 #: ../src/guestfs.pod:759
1758 msgid "See L<guestfish(1)>."
1763 #: ../src/guestfs.pod:763
1764 msgid "LIBGUESTFS GOTCHAS"
1769 #: ../src/guestfs.pod:765
1771 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1772 "system [...] that works in the way it is documented but is counterintuitive "
1773 "and almost invites mistakes.\""
1778 #: ../src/guestfs.pod:769
1780 "Since we developed libguestfs and the associated tools, there are several "
1781 "things we would have designed differently, but are now stuck with for "
1782 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1783 "release, you can expect these to change. Beware of them."
1788 #: ../src/guestfs.pod:777
1789 msgid "Autosync / forgetting to sync."
1794 #: ../src/guestfs.pod:779
1796 "When modifying a filesystem from C or another language, you B<must> unmount "
1797 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1798 "libguestfs handle. You can also call:"
1803 #: ../src/guestfs.pod:783
1806 " guestfs_set_autosync (g, 1);\n"
1812 #: ../src/guestfs.pod:785
1814 "to have the unmount/sync done automatically for you when the handle 'g' is "
1815 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1820 #: ../src/guestfs.pod:789
1822 "If you forget to do this, then it is entirely possible that your changes "
1823 "won't be written out, or will be partially written, or (very rarely) that "
1824 "you'll get disk corruption."
1829 #: ../src/guestfs.pod:793
1831 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1832 "guestfish scripts that forget to sync will work just fine, which can make "
1833 "this very puzzling if you are trying to debug a problem."
1838 #: ../src/guestfs.pod:797
1840 "Update: Autosync is enabled by default for all API users starting from "
1841 "libguestfs 1.5.24."
1846 #: ../src/guestfs.pod:800
1847 msgid "Mount option C<-o sync> should not be the default."
1852 #: ../src/guestfs.pod:802
1854 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1855 "However C<-o sync> does not add any reliability benefit, but does have a "
1856 "very large performance impact."
1861 #: ../src/guestfs.pod:806
1863 "The work around is to use L</guestfs_mount_options> and set the mount "
1864 "options that you actually want to use."
1869 #: ../src/guestfs.pod:809
1870 msgid "Read-only should be the default."
1875 #: ../src/guestfs.pod:811
1877 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1878 "specify I<--rw> if you want to make changes to the image."
1883 #: ../src/guestfs.pod:814
1884 msgid "This would reduce the potential to corrupt live VM images."
1889 #: ../src/guestfs.pod:816
1891 "Note that many filesystems change the disk when you just mount and unmount, "
1892 "even if you didn't perform any writes. You need to use L</"
1893 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1898 #: ../src/guestfs.pod:820
1899 msgid "guestfish command line is hard to use."
1904 #: ../src/guestfs.pod:822
1906 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1907 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1908 "exist, so it fails. In earlier versions of guestfish the error message was "
1909 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1910 "we should have used C<guestfish -c command> to run commands."
1915 #: ../src/guestfs.pod:829
1916 msgid "guestfish megabyte modifiers don't work right on all commands"
1921 #: ../src/guestfs.pod:831
1923 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1924 "other modifiers). What guestfish actually does is to multiply the number "
1925 "part by the modifier part and pass the result to the C API. However this "
1926 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1927 "expecting some other unit (eg. megabytes)."
1932 #: ../src/guestfs.pod:838
1933 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1938 #: ../src/guestfs.pod:840
1941 " lvcreate LV VG 100M\n"
1947 #: ../src/guestfs.pod:842
1949 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1950 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1951 "megabytes * megabytes) logical volume. The error message you get from this "
1952 "is also a little obscure."
1957 #: ../src/guestfs.pod:847
1959 "This could be fixed in the generator by specially marking parameters and "
1960 "return values which take bytes or other units."
1965 #: ../src/guestfs.pod:850
1966 msgid "Ambiguity between devices and paths"
1971 #: ../src/guestfs.pod:852
1973 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1974 "sdb2>) and a similar pathname. A file might just happen to be called "
1975 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1980 #: ../src/guestfs.pod:857
1982 "In the current API we usually resolve this ambiguity by having two separate "
1983 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1984 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1985 "detecting if the path supplied begins with C</dev/>."
1990 #: ../src/guestfs.pod:863
1992 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1993 "make paths/devices into structured names. One way to do this would be to "
1994 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1995 "aspect of grub. Another way would be to use a structured type, equivalent "
1996 "to this OCaml type:"
2001 #: ../src/guestfs.pod:869
2004 " type path = Path of string | Device of int | Partition of int * int\n"
2010 #: ../src/guestfs.pod:871
2011 msgid "which would allow you to pass arguments like:"
2016 #: ../src/guestfs.pod:873
2019 " Path \"/foo/bar\"\n"
2020 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2021 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2022 " Path \"/dev/sdb2\" (* not a device *)\n"
2028 #: ../src/guestfs.pod:878
2030 "As you can see there are still problems to resolve even with this "
2031 "representation. Also consider how it might work in guestfish."
2036 #: ../src/guestfs.pod:883
2037 msgid "PROTOCOL LIMITS"
2042 #: ../src/guestfs.pod:885
2044 "Internally libguestfs uses a message-based protocol to pass API calls and "
2045 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2046 "plenty more detail about this). The maximum message size used by the "
2047 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2048 "aware of this limit. The API calls which may be affected are individually "
2049 "documented, with a link back to this section of the documentation."
2054 #: ../src/guestfs.pod:893
2056 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2057 "a simple string. Because this string is at some point internally encoded as "
2058 "a message, the maximum size that it can return is slightly under 4 MB. If "
2059 "the requested file is larger than this then you will get an error."
2064 #: ../src/guestfs.pod:899
2066 "In order to transfer large files into and out of the guest filesystem, you "
2067 "need to use particular calls that support this. The sections L</UPLOADING> "
2068 "and L</DOWNLOADING> document how to do this."
2073 #: ../src/guestfs.pod:903
2075 "You might also consider mounting the disk image using our FUSE filesystem "
2076 "support (L<guestmount(1)>)."
2081 #: ../src/guestfs.pod:906
2082 msgid "KEYS AND PASSPHRASES"
2087 #: ../src/guestfs.pod:908
2089 "Certain libguestfs calls take a parameter that contains sensitive key "
2090 "material, passed in as a C string."
2095 #: ../src/guestfs.pod:911
2097 "In the future we would hope to change the libguestfs implementation so that "
2098 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2099 "swap. However this is I<not> done at the moment, because of the complexity "
2100 "of such an implementation."
2105 #: ../src/guestfs.pod:916
2107 "Therefore you should be aware that any key parameter you pass to libguestfs "
2108 "might end up being written out to the swap partition. If this is a concern, "
2109 "scrub the swap partition or don't use libguestfs on encrypted devices."
2114 #: ../src/guestfs.pod:921
2115 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2120 #: ../src/guestfs.pod:923
2122 "All high-level libguestfs actions are synchronous. If you want to use "
2123 "libguestfs asynchronously then you must create a thread."
2128 #: ../src/guestfs.pod:926
2130 "Only use the handle from a single thread. Either use the handle exclusively "
2131 "from one thread, or provide your own mutex so that two threads cannot issue "
2132 "calls on the same handle at the same time."
2137 #: ../src/guestfs.pod:930
2139 "See the graphical program guestfs-browser for one possible architecture for "
2140 "multithreaded programs using libvirt and libguestfs."
2145 #: ../src/guestfs.pod:933
2150 #: ../src/guestfs.pod:935
2152 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2158 #: ../src/guestfs.pod:938
2160 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2161 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2166 #: ../src/guestfs.pod:941
2168 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2169 "to change the directories that libguestfs will search in. The value is a "
2170 "colon-separated list of paths. The current directory is I<not> searched "
2171 "unless the path contains an empty element or C<.>. For example "
2172 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2173 "then C</usr/lib/guestfs>."
2178 #: ../src/guestfs.pod:948
2179 msgid "QEMU WRAPPERS"
2184 #: ../src/guestfs.pod:950
2186 "If you want to compile your own qemu, run qemu from a non-standard location, "
2187 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2193 #: ../src/guestfs.pod:954
2195 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2196 "last command in the shell script (so that qemu replaces the shell and "
2197 "becomes the direct child of the libguestfs-using program). If you don't do "
2198 "this, then the qemu process won't be cleaned up correctly."
2203 #: ../src/guestfs.pod:959
2205 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2211 #: ../src/guestfs.pod:962
2215 " qemudir=/home/rjones/d/qemu\n"
2216 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2222 #: ../src/guestfs.pod:966
2224 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2225 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2231 #: ../src/guestfs.pod:970
2234 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2240 #: ../src/guestfs.pod:972
2242 "Note that libguestfs also calls qemu with the -help and -version options in "
2243 "order to determine features."
2247 #: ../src/guestfs.pod:975
2248 msgid "ATTACHING TO RUNNING DAEMONS"
2252 #: ../src/guestfs.pod:977
2254 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2255 "babies. Use with caution."
2259 #: ../src/guestfs.pod:980
2261 "I<Note (2):> This section explains how to attach to a running daemon from a "
2262 "low level perspective. For most users, simply using virt tools such as "
2263 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2267 #: ../src/guestfs.pod:984
2268 msgid "Using guestfs_set_attach_method"
2272 #: ../src/guestfs.pod:986
2274 "By calling L</guestfs_set_attach_method> you can change how the library "
2275 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2276 "ARCHITECTURE> for some background)."
2280 #: ../src/guestfs.pod:990
2282 "The normal attach method is C<appliance>, where a small appliance is created "
2283 "containing the daemon, and then the library connects to this."
2287 #: ../src/guestfs.pod:993
2289 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2290 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2291 "daemon over the Unix domain socket."
2295 #: ../src/guestfs.pod:997
2297 "The normal use for this is to connect to a running virtual machine that "
2298 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2299 "files inside the live virtual machine."
2303 #: ../src/guestfs.pod:1001
2304 msgid "Using guestfs_add_domain with live flag"
2308 #: ../src/guestfs.pod:1003
2310 "L</guestfs_add_domain> provides some help for getting the correct attach "
2311 "method. If you pass the C<live> option to this function, then (if the "
2312 "virtual machine is running) it will examine the libvirt XML looking for a "
2313 "virtio-serial channel to connect to:"
2317 #: ../src/guestfs.pod:1009
2324 " <channel type='unix'>\n"
2325 " <source mode='bind' path='/path/to/socket'/>\n"
2326 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2335 #: ../src/guestfs.pod:1021
2337 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2338 "method to C<unix:/path/to/socket>."
2342 #: ../src/guestfs.pod:1024
2344 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2345 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2346 "to attach to and modify live virtual machines."
2350 #: ../src/guestfs.pod:1028
2352 "The virtual machine needs to have been set up beforehand so that it has the "
2353 "virtio-serial channel and so that guestfsd is running inside it."
2358 #: ../src/guestfs.pod:1032
2359 msgid "ABI GUARANTEE"
2364 #: ../src/guestfs.pod:1034
2366 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2367 "actions as outlined in this section. Although we will deprecate some "
2368 "actions, for example if they get replaced by newer calls, we will keep the "
2369 "old actions forever. This allows you the developer to program in confidence "
2370 "against the libguestfs API."
2375 #: ../src/guestfs.pod:1040
2376 msgid "BLOCK DEVICE NAMING"
2381 #: ../src/guestfs.pod:1042
2383 "In the kernel there is now quite a profusion of schemata for naming block "
2384 "devices (in this context, by I<block device> I mean a physical or virtual "
2385 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2386 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2387 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2388 "for the old IDE driver (particularly for SATA devices) those devices also "
2389 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2390 "paravirtualized drivers. This has created several different naming systems, "
2391 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2396 #: ../src/guestfs.pod:1054
2398 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2399 "Linux kernel to access block devices. We can run a variety of appliances "
2400 "based on a variety of Linux kernels."
2405 #: ../src/guestfs.pod:1058
2407 "This causes a problem for libguestfs because many API calls use device or "
2408 "partition names. Working scripts and the recipe (example) scripts that we "
2409 "make available over the internet could fail if the naming scheme changes."
2414 #: ../src/guestfs.pod:1063
2416 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2417 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2418 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2419 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2424 #: ../src/guestfs.pod:1069
2426 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2427 "L</guestfs_list_partitions> and similar calls return the true names of the "
2428 "devices and partitions as known to the appliance."
2433 #: ../src/guestfs.pod:1074
2434 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2439 #: ../src/guestfs.pod:1076
2441 "Usually this translation is transparent. However in some (very rare) cases "
2442 "you may need to know the exact algorithm. Such cases include where you use "
2443 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2444 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2449 #: ../src/guestfs.pod:1082
2451 "The algorithm is applied only to I<parameters> which are known to be either "
2452 "device or partition names. Return values from functions such as L</"
2453 "guestfs_list_devices> are never changed."
2458 #: ../src/guestfs.pod:1090
2459 msgid "Is the string a parameter which is a device or partition name?"
2464 #: ../src/guestfs.pod:1094
2465 msgid "Does the string begin with C</dev/sd>?"
2470 #: ../src/guestfs.pod:1098
2472 "Does the named device exist? If so, we use that device. However if I<not> "
2473 "then we continue with this algorithm."
2478 #: ../src/guestfs.pod:1103
2479 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2484 #: ../src/guestfs.pod:1105
2485 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2490 #: ../src/guestfs.pod:1107
2491 msgid "If that named device exists, use it. If not, continue."
2496 #: ../src/guestfs.pod:1111
2497 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2502 #: ../src/guestfs.pod:1113
2503 msgid "If that named device exists, use it. If not, return an error."
2508 #: ../src/guestfs.pod:1117
2509 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2514 #: ../src/guestfs.pod:1119
2516 "Although the standard naming scheme and automatic translation is useful for "
2517 "simple programs and guestfish scripts, for larger programs it is best not to "
2518 "rely on this mechanism."
2523 #: ../src/guestfs.pod:1123
2525 "Where possible for maximum future portability programs using libguestfs "
2526 "should use these future-proof techniques:"
2531 #: ../src/guestfs.pod:1130
2533 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2534 "device names, and then use those names directly."
2539 #: ../src/guestfs.pod:1133
2541 "Since those device names exist by definition, they will never be translated."
2546 #: ../src/guestfs.pod:1138
2548 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2549 "filesystem labels."
2554 #: ../src/guestfs.pod:1143
2560 #: ../src/guestfs.pod:1145
2562 "This section discusses security implications of using libguestfs, "
2563 "particularly with untrusted or malicious guests or disk images."
2568 #: ../src/guestfs.pod:1148
2569 msgid "GENERAL SECURITY CONSIDERATIONS"
2574 #: ../src/guestfs.pod:1150
2576 "Be careful with any files or data that you download from a guest (by "
2577 "\"download\" we mean not just the L</guestfs_download> command but any "
2578 "command that reads files, filenames, directories or anything else from a "
2579 "disk image). An attacker could manipulate the data to fool your program "
2580 "into doing the wrong thing. Consider cases such as:"
2585 #: ../src/guestfs.pod:1160
2586 msgid "the data (file etc) not being present"
2591 #: ../src/guestfs.pod:1164
2592 msgid "being present but empty"
2597 #: ../src/guestfs.pod:1168
2598 msgid "being much larger than normal"
2603 #: ../src/guestfs.pod:1172
2604 msgid "containing arbitrary 8 bit data"
2609 #: ../src/guestfs.pod:1176
2610 msgid "being in an unexpected character encoding"
2615 #: ../src/guestfs.pod:1180
2616 msgid "containing homoglyphs."
2621 #: ../src/guestfs.pod:1184
2622 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2627 #: ../src/guestfs.pod:1186
2629 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2630 "(VFS) module can sometimes be escalated into exploits by deliberately "
2631 "creating a malicious, malformed filesystem. These exploits are very severe "
2632 "for two reasons. Firstly there are very many filesystem drivers in the "
2633 "kernel, and many of them are infrequently used and not much developer "
2634 "attention has been paid to the code. Linux userspace helps potential "
2635 "crackers by detecting the filesystem type and automatically choosing the "
2636 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2637 "the administrator. Secondly, a kernel-level exploit is like a local root "
2638 "exploit (worse in some ways), giving immediate and total access to the "
2639 "system right down to the hardware level."
2644 #: ../src/guestfs.pod:1199
2646 "That explains why you should never mount a filesystem from an untrusted "
2647 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2648 "inside a qemu virtual machine, usually running as a non-root user. The "
2649 "attacker would need to write a filesystem which first exploited the kernel, "
2650 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2651 "the libguestfs protocol, and finally to be as serious as the host kernel "
2652 "exploit it would need to escalate its privileges to root. This multi-step "
2653 "escalation, performed by a static piece of data, is thought to be extremely "
2654 "hard to do, although we never say 'never' about security issues."
2659 #: ../src/guestfs.pod:1210
2661 "In any case callers can reduce the attack surface by forcing the filesystem "
2662 "type when mounting (use L</guestfs_mount_vfs>)."
2667 #: ../src/guestfs.pod:1213
2668 msgid "PROTOCOL SECURITY"
2673 #: ../src/guestfs.pod:1215
2675 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2676 "defined upper message size. However a program that uses libguestfs must "
2677 "also take care - for example you can write a program that downloads a binary "
2678 "from a disk image and executes it locally, and no amount of protocol "
2679 "security will save you from the consequences."
2684 #: ../src/guestfs.pod:1221
2685 msgid "INSPECTION SECURITY"
2690 #: ../src/guestfs.pod:1223
2692 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2693 "directly from the guest, and these could contain any 8 bit data. Callers "
2694 "should be careful to escape these before printing them to a structured file "
2695 "(for example, use HTML escaping if creating a web page)."
2700 #: ../src/guestfs.pod:1229
2702 "Guest configuration may be altered in unusual ways by the administrator of "
2703 "the virtual machine, and may not reflect reality (particularly for untrusted "
2704 "or actively malicious guests). For example we parse the hostname from "
2705 "configuration files like C</etc/sysconfig/network> that we find in the "
2706 "guest, but the guest administrator can easily manipulate these files to "
2707 "provide the wrong hostname."
2712 #: ../src/guestfs.pod:1237
2714 "The inspection API parses guest configuration using two external libraries: "
2715 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2716 "designed to be robust in the face of malicious data, although denial of "
2717 "service attacks are still possible, for example with oversized configuration "
2723 #: ../src/guestfs.pod:1243
2724 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2729 #: ../src/guestfs.pod:1245
2731 "Be very cautious about running commands from the guest. By running a "
2732 "command in the guest, you are giving CPU time to a binary that you do not "
2733 "control, under the same user account as the library, albeit wrapped in qemu "
2734 "virtualization. More information and alternatives can be found in the "
2735 "section L</RUNNING COMMANDS>."
2740 #: ../src/guestfs.pod:1251
2741 msgid "CVE-2010-3851"
2746 #: ../src/guestfs.pod:1253
2747 msgid "https://bugzilla.redhat.com/642934"
2752 #: ../src/guestfs.pod:1255
2754 "This security bug concerns the automatic disk format detection that qemu "
2755 "does on disk images."
2760 #: ../src/guestfs.pod:1258
2762 "A raw disk image is just the raw bytes, there is no header. Other disk "
2763 "images like qcow2 contain a special header. Qemu deals with this by looking "
2764 "for one of the known headers, and if none is found then assuming the disk "
2765 "image must be raw."
2770 #: ../src/guestfs.pod:1263
2772 "This allows a guest which has been given a raw disk image to write some "
2773 "other header. At next boot (or when the disk image is accessed by "
2774 "libguestfs) qemu would do autodetection and think the disk image format was, "
2775 "say, qcow2 based on the header written by the guest."
2780 #: ../src/guestfs.pod:1268
2782 "This in itself would not be a problem, but qcow2 offers many features, one "
2783 "of which is to allow a disk image to refer to another image (called the "
2784 "\"backing disk\"). It does this by placing the path to the backing disk "
2785 "into the qcow2 header. This path is not validated and could point to any "
2786 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2787 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2788 "control of the attacker."
2793 #: ../src/guestfs.pod:1276
2795 "In libguestfs this is rather hard to exploit except under two circumstances:"
2800 #: ../src/guestfs.pod:1283
2801 msgid "You have enabled the network or have opened the disk in write mode."
2806 #: ../src/guestfs.pod:1287
2808 "You are also running untrusted code from the guest (see L</RUNNING "
2814 #: ../src/guestfs.pod:1292
2816 "The way to avoid this is to specify the expected disk format when adding "
2817 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2818 "should always do this if the disk is raw format, and it's a good idea for "
2824 #: ../src/guestfs.pod:1297
2826 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2827 "format is fetched from libvirt and passed through."
2832 #: ../src/guestfs.pod:1300
2834 "For libguestfs tools, use the I<--format> command line parameter as "
2840 #: ../src/guestfs.pod:1303
2841 msgid "CONNECTION MANAGEMENT"
2846 #: ../src/guestfs.pod:1305
2852 #: ../src/guestfs.pod:1307
2854 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2855 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2856 "handle and release all resources used."
2861 #: ../src/guestfs.pod:1311
2863 "For information on using multiple handles and threads, see the section L</"
2864 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2869 #: ../src/guestfs.pod:1314
2870 msgid "guestfs_create"
2875 #: ../src/guestfs.pod:1316
2878 " guestfs_h *guestfs_create (void);\n"
2884 #: ../src/guestfs.pod:1318
2885 msgid "Create a connection handle."
2890 #: ../src/guestfs.pod:1320
2892 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2893 "on the handle at least once."
2898 #: ../src/guestfs.pod:1323
2900 "This function returns a non-NULL pointer to a handle on success or NULL on "
2906 #: ../src/guestfs.pod:1326
2907 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2912 #: ../src/guestfs.pod:1328
2914 "You may also want to configure error handling for the handle. See L</ERROR "
2915 "HANDLING> section below."
2920 #: ../src/guestfs.pod:1331
2921 msgid "guestfs_close"
2926 #: ../src/guestfs.pod:1333
2929 " void guestfs_close (guestfs_h *g);\n"
2935 #: ../src/guestfs.pod:1335
2936 msgid "This closes the connection handle and frees up all resources used."
2941 #: ../src/guestfs.pod:1337
2942 msgid "ERROR HANDLING"
2947 #: ../src/guestfs.pod:1339
2949 "API functions can return errors. For example, almost all functions that "
2950 "return C<int> will return C<-1> to indicate an error."
2955 #: ../src/guestfs.pod:1342
2957 "Additional information is available for errors: an error message string and "
2958 "optionally an error number (errno) if the thing that failed was a system "
2964 #: ../src/guestfs.pod:1346
2966 "You can get at the additional information about the last error on the handle "
2967 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2968 "up an error handler with L</guestfs_set_error_handler>."
2973 #: ../src/guestfs.pod:1351
2975 "When the handle is created, a default error handler is installed which "
2976 "prints the error message string to C<stderr>. For small short-running "
2977 "command line programs it is sufficient to do:"
2982 #: ../src/guestfs.pod:1355
2985 " if (guestfs_launch (g) == -1)\n"
2986 " exit (EXIT_FAILURE);\n"
2992 #: ../src/guestfs.pod:1358
2994 "since the default error handler will ensure that an error message has been "
2995 "printed to C<stderr> before the program exits."
3000 #: ../src/guestfs.pod:1361
3002 "For other programs the caller will almost certainly want to install an "
3003 "alternate error handler or do error handling in-line like this:"
3008 #: ../src/guestfs.pod:1364
3011 " g = guestfs_create ();\n"
3017 #: ../src/guestfs.pod:1366
3020 " /* This disables the default behaviour of printing errors\n"
3022 " guestfs_set_error_handler (g, NULL, NULL);\n"
3028 #: ../src/guestfs.pod:1370
3031 " if (guestfs_launch (g) == -1) {\n"
3032 " /* Examine the error message and print it etc. */\n"
3033 " char *msg = guestfs_last_error (g);\n"
3034 " int errnum = guestfs_last_errno (g);\n"
3035 " fprintf (stderr, \"%s\\n\", msg);\n"
3043 #: ../src/guestfs.pod:1378
3045 "Out of memory errors are handled differently. The default action is to call "
3046 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3047 "guestfs_set_out_of_memory_handler>."
3052 #: ../src/guestfs.pod:1382
3054 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3055 "because there is no handle if this happens there is no way to get additional "
3056 "error information. However L</guestfs_create> is supposed to be a "
3057 "lightweight operation which can only fail because of insufficient memory (it "
3058 "returns NULL in this case)."
3063 #: ../src/guestfs.pod:1388
3064 msgid "guestfs_last_error"
3069 #: ../src/guestfs.pod:1390
3072 " const char *guestfs_last_error (guestfs_h *g);\n"
3078 #: ../src/guestfs.pod:1392
3080 "This returns the last error message that happened on C<g>. If there has not "
3081 "been an error since the handle was created, then this returns C<NULL>."
3086 #: ../src/guestfs.pod:1396
3088 "The lifetime of the returned string is until the next error occurs, or L</"
3089 "guestfs_close> is called."
3094 #: ../src/guestfs.pod:1399
3095 msgid "guestfs_last_errno"
3100 #: ../src/guestfs.pod:1401
3103 " int guestfs_last_errno (guestfs_h *g);\n"
3109 #: ../src/guestfs.pod:1403
3110 msgid "This returns the last error number (errno) that happened on C<g>."
3115 #: ../src/guestfs.pod:1405
3116 msgid "If successful, an errno integer not equal to zero is returned."
3121 #: ../src/guestfs.pod:1407
3123 "If no error, this returns 0. This call can return 0 in three situations:"
3128 #: ../src/guestfs.pod:1414
3129 msgid "There has not been any error on the handle."
3134 #: ../src/guestfs.pod:1418
3136 "There has been an error but the errno was meaningless. This corresponds to "
3137 "the case where the error did not come from a failed system call, but for "
3138 "some other reason."
3143 #: ../src/guestfs.pod:1424
3145 "There was an error from a failed system call, but for some reason the errno "
3146 "was not captured and returned. This usually indicates a bug in libguestfs."
3151 #: ../src/guestfs.pod:1430
3153 "Libguestfs tries to convert the errno from inside the applicance into a "
3154 "corresponding errno for the caller (not entirely trivial: the appliance "
3155 "might be running a completely different operating system from the library "
3156 "and error numbers are not standardized across Un*xen). If this could not be "
3157 "done, then the error is translated to C<EINVAL>. In practice this should "
3158 "only happen in very rare circumstances."
3163 #: ../src/guestfs.pod:1438
3164 msgid "guestfs_set_error_handler"
3169 #: ../src/guestfs.pod:1440
3172 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3174 " const char *msg);\n"
3175 " void guestfs_set_error_handler (guestfs_h *g,\n"
3176 " guestfs_error_handler_cb cb,\n"
3183 #: ../src/guestfs.pod:1447
3185 "The callback C<cb> will be called if there is an error. The parameters "
3186 "passed to the callback are an opaque data pointer and the error message "
3192 #: ../src/guestfs.pod:1451
3194 "C<errno> is not passed to the callback. To get that the callback must call "
3195 "L</guestfs_last_errno>."
3200 #: ../src/guestfs.pod:1454
3202 "Note that the message string C<msg> is freed as soon as the callback "
3203 "function returns, so if you want to stash it somewhere you must make your "
3209 #: ../src/guestfs.pod:1458
3210 msgid "The default handler prints messages on C<stderr>."
3215 #: ../src/guestfs.pod:1460
3216 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3221 #: ../src/guestfs.pod:1462
3222 msgid "guestfs_get_error_handler"
3227 #: ../src/guestfs.pod:1464
3230 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3231 " void **opaque_rtn);\n"
3237 #: ../src/guestfs.pod:1467
3238 msgid "Returns the current error handler callback."
3243 #: ../src/guestfs.pod:1469
3244 msgid "guestfs_set_out_of_memory_handler"
3249 #: ../src/guestfs.pod:1471
3252 " typedef void (*guestfs_abort_cb) (void);\n"
3253 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3254 " guestfs_abort_cb);\n"
3260 #: ../src/guestfs.pod:1475
3262 "The callback C<cb> will be called if there is an out of memory situation. "
3263 "I<Note this callback must not return>."
3268 #: ../src/guestfs.pod:1478
3269 msgid "The default is to call L<abort(3)>."
3274 #: ../src/guestfs.pod:1480
3276 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3281 #: ../src/guestfs.pod:1483
3282 msgid "guestfs_get_out_of_memory_handler"
3287 #: ../src/guestfs.pod:1485
3290 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3296 #: ../src/guestfs.pod:1487
3297 msgid "This returns the current out of memory handler."
3302 #: ../src/guestfs.pod:1489
3308 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
3314 #: ../src/guestfs.pod:1493
3320 #: ../src/guestfs.pod:1495
3326 #: ../src/guestfs.pod:1497
3327 msgid "AVAILABILITY"
3332 #: ../src/guestfs.pod:1499
3333 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3338 #: ../src/guestfs.pod:1501
3340 "Using L</guestfs_available> you can test availability of the following "
3341 "groups of functions. This test queries the appliance to see if the "
3342 "appliance you are currently using supports the functionality."
3347 #: ../src/guestfs.pod:1506
3348 msgid "@AVAILABILITY@"
3353 #: ../src/guestfs.pod:1508
3354 msgid "GUESTFISH supported COMMAND"
3359 #: ../src/guestfs.pod:1510
3361 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3362 "prints out the available groups and whether they are supported by this build "
3363 "of libguestfs. Note however that you have to do C<run> first."
3368 #: ../src/guestfs.pod:1515
3369 msgid "SINGLE CALLS AT COMPILE TIME"
3374 #: ../src/guestfs.pod:1517
3376 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3377 "function, such as:"
3382 #: ../src/guestfs.pod:1520
3385 " #define LIBGUESTFS_HAVE_DD 1\n"
3391 #: ../src/guestfs.pod:1522
3392 msgid "if L</guestfs_dd> is available."
3397 #: ../src/guestfs.pod:1524
3399 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3400 "function is available at compile time, we recommended using build tools such "
3401 "as autoconf or cmake. For example in autotools you could use:"
3406 #: ../src/guestfs.pod:1529
3409 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3410 " AC_CHECK_FUNCS([guestfs_dd])\n"
3416 #: ../src/guestfs.pod:1532
3418 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3424 #: ../src/guestfs.pod:1535
3425 msgid "SINGLE CALLS AT RUN TIME"
3430 #: ../src/guestfs.pod:1537
3432 "Testing at compile time doesn't guarantee that a function really exists in "
3433 "the library. The reason is that you might be dynamically linked against a "
3434 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3435 "This situation unfortunately results in a segmentation fault, which is a "
3436 "shortcoming of the C dynamic linking system itself."
3441 #: ../src/guestfs.pod:1544
3443 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3444 "in this example program (note that you still need the compile time check as "
3450 #: ../src/guestfs.pod:1548
3453 " #include <stdio.h>\n"
3454 " #include <stdlib.h>\n"
3455 " #include <unistd.h>\n"
3456 " #include <dlfcn.h>\n"
3457 " #include <guestfs.h>\n"
3463 #: ../src/guestfs.pod:1554
3468 " #ifdef LIBGUESTFS_HAVE_DD\n"
3470 " int has_function;\n"
3476 #: ../src/guestfs.pod:1560
3479 " /* Test if the function guestfs_dd is really available. */\n"
3480 " dl = dlopen (NULL, RTLD_LAZY);\n"
3482 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3483 " exit (EXIT_FAILURE);\n"
3485 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3492 #: ../src/guestfs.pod:1569
3495 " if (!has_function)\n"
3496 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3498 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3499 " /* Now it's safe to call\n"
3500 " guestfs_dd (g, \"foo\", \"bar\");\n"
3504 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3512 #: ../src/guestfs.pod:1582
3514 "You may think the above is an awful lot of hassle, and it is. There are "
3515 "other ways outside of the C linking system to ensure that this kind of "
3516 "incompatibility never arises, such as using package versioning:"
3521 #: ../src/guestfs.pod:1587
3524 " Requires: libguestfs >= 1.0.80\n"
3530 #: ../src/guestfs.pod:1589
3531 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3536 #: ../src/guestfs.pod:1591
3538 "A recent feature of the API is the introduction of calls which take optional "
3539 "arguments. In C these are declared 3 ways. The main way is as a call which "
3540 "takes variable arguments (ie. C<...>), as in this example:"
3545 #: ../src/guestfs.pod:1596
3548 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3554 #: ../src/guestfs.pod:1598
3556 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3557 "call with no optional arguments specified:"
3562 #: ../src/guestfs.pod:1601
3565 " guestfs_add_drive_opts (g, filename, -1);\n"
3571 #: ../src/guestfs.pod:1603
3572 msgid "With a single optional argument:"
3577 #: ../src/guestfs.pod:1605
3580 " guestfs_add_drive_opts (g, filename,\n"
3581 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3588 #: ../src/guestfs.pod:1609
3594 #: ../src/guestfs.pod:1611
3597 " guestfs_add_drive_opts (g, filename,\n"
3598 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3599 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3606 #: ../src/guestfs.pod:1616
3608 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3614 #: ../src/guestfs.pod:1619
3615 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3620 #: ../src/guestfs.pod:1621
3622 "The second variant has the same name with the suffix C<_va>, which works the "
3623 "same way but takes a C<va_list>. See the C manual for details. For the "
3624 "example function, this is declared:"
3629 #: ../src/guestfs.pod:1625
3632 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3639 #: ../src/guestfs.pod:1628
3640 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3645 #: ../src/guestfs.pod:1630
3647 "The third variant is useful where you need to construct these calls. You "
3648 "pass in a structure where you fill in the optional fields. The structure "
3649 "has a bitmask as the first element which you must set to indicate which "
3650 "fields you have filled in. For our example function the structure and call "
3656 #: ../src/guestfs.pod:1636
3659 " struct guestfs_add_drive_opts_argv {\n"
3660 " uint64_t bitmask;\n"
3662 " const char *format;\n"
3665 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3666 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3672 #: ../src/guestfs.pod:1645
3673 msgid "You could call it like this:"
3678 #: ../src/guestfs.pod:1647
3681 " struct guestfs_add_drive_opts_argv optargs = {\n"
3682 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3683 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3685 " .format = \"qcow2\"\n"
3692 #: ../src/guestfs.pod:1654
3695 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3701 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3702 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3703 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3709 #: ../src/guestfs.pod:1662
3710 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3715 #: ../src/guestfs.pod:1667
3716 msgid "You do not need to fill in all fields of the structure."
3721 #: ../src/guestfs.pod:1671
3723 "There must be a one-to-one correspondence between fields of the structure "
3724 "that are filled in, and bits set in the bitmask."
3729 #: ../src/guestfs.pod:1676
3730 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3735 #: ../src/guestfs.pod:1678
3737 "In other languages, optional arguments are expressed in the way that is "
3738 "natural for that language. We refer you to the language-specific "
3739 "documentation for more details on that."
3744 #: ../src/guestfs.pod:1682
3745 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3750 #: ../src/guestfs.pod:1684
3751 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3755 #: ../src/guestfs.pod:1686
3757 "B<Note:> This section documents the generic event mechanism introduced in "
3758 "libguestfs 1.10, which you should use in new code if possible. The old "
3759 "functions C<guestfs_set_log_message_callback>, "
3760 "C<guestfs_set_subprocess_quit_callback>, "
3761 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3762 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3767 #: ../src/guestfs.pod:1694
3769 "Handles generate events when certain things happen, such as log messages "
3770 "being generated, progress messages during long-running operations, or the "
3771 "handle being closed. The API calls described below let you register a "
3772 "callback to be called when events happen. You can register multiple "
3773 "callbacks (for the same, different or overlapping sets of events), and "
3774 "individually remove callbacks. If callbacks are not removed, then they "
3775 "remain in force until the handle is closed."
3779 #: ../src/guestfs.pod:1702
3781 "In the current implementation, events are only generated synchronously: that "
3782 "means that events (and hence callbacks) can only happen while you are in the "
3783 "middle of making another libguestfs call. The callback is called in the "
3788 #: ../src/guestfs.pod:1707
3790 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3791 "unsigned integers, or a message buffer. Payloads are discussed later on."
3795 #: ../src/guestfs.pod:1711
3796 msgid "CLASSES OF EVENTS"
3800 #: ../src/guestfs.pod:1715
3801 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3805 #: ../src/guestfs.pod:1718
3807 "The callback function will be called while the handle is being closed "
3808 "(synchronously from L</guestfs_close>)."
3813 #: ../src/guestfs.pod:1721
3815 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3816 "handles that are open when the program exits. This means that this callback "
3817 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3818 "problems in higher-level languages (eg. if your HLL interpreter has already "
3819 "been cleaned up by the time this is called, and if your callback then jumps "
3820 "into some HLL function)."
3824 #: ../src/guestfs.pod:1728
3826 "If no callback is registered: the handle is closed without any callback "
3831 #: ../src/guestfs.pod:1731
3832 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3836 #: ../src/guestfs.pod:1734
3838 "The callback function will be called when the child process quits, either "
3839 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3840 "corresponds to a transition from any state to the CONFIG state)."
3844 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3845 msgid "If no callback is registered: the event is ignored."
3849 #: ../src/guestfs.pod:1740
3850 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3854 #: ../src/guestfs.pod:1743
3856 "The callback function will be called when the child process becomes ready "
3857 "first time after it has been launched. (This corresponds to a transition "
3858 "from LAUNCHING to the READY state)."
3862 #: ../src/guestfs.pod:1749
3863 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3868 #: ../src/guestfs.pod:1752
3870 "Some long-running operations can generate progress messages. If this "
3871 "callback is registered, then it will be called each time a progress message "
3872 "is generated (usually two seconds after the operation started, and three "
3873 "times per second thereafter until it completes, although the frequency may "
3874 "change in future versions)."
3878 #: ../src/guestfs.pod:1758
3880 "The callback receives in the payload four unsigned 64 bit numbers which are "
3881 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3885 #: ../src/guestfs.pod:1761
3887 "The units of C<total> are not defined, although for some operations C<total> "
3888 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3889 "or megabytes), and C<position> may be the portion which has been transferred."
3894 #: ../src/guestfs.pod:1766
3895 msgid "The only defined and stable parts of the API are:"
3900 #: ../src/guestfs.pod:1772
3902 "The callback can display to the user some type of progress bar or indicator "
3903 "which shows the ratio of C<position>:C<total>."
3908 #: ../src/guestfs.pod:1777
3909 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3913 #: ../src/guestfs.pod:1781
3915 "If any progress notification is sent during a call, then a final progress "
3916 "notification is always sent when C<position> = C<total> (I<unless> the call "
3917 "fails with an error)."
3922 #: ../src/guestfs.pod:1785
3924 "This is to simplify caller code, so callers can easily set the progress "
3925 "indicator to \"100%\" at the end of the operation, without requiring special "
3926 "code to detect this case."
3930 #: ../src/guestfs.pod:1791
3932 "For some calls we are unable to estimate the progress of the call, but we "
3933 "can still generate progress messages to indicate activity. This is known as "
3934 "\"pulse mode\", and is directly supported by certain progress bar "
3935 "implementations (eg. GtkProgressBar)."
3939 #: ../src/guestfs.pod:1796
3941 "For these calls, zero or more progress messages are generated with "
3942 "C<position = 0> and C<total = 1>, followed by a final message with "
3943 "C<position = total = 1>."
3947 #: ../src/guestfs.pod:1800
3949 "As noted above, if the call fails with an error then the final message may "
3954 #: ../src/guestfs.pod:1805
3956 "The callback also receives the procedure number (C<proc_nr>) and serial "
3957 "number (C<serial>) of the call. These are only useful for debugging "
3958 "protocol issues, and the callback can normally ignore them. The callback "
3959 "may want to print these numbers in error messages or debugging messages."
3963 #: ../src/guestfs.pod:1811
3964 msgid "If no callback is registered: progress messages are discarded."
3968 #: ../src/guestfs.pod:1813
3969 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3973 #: ../src/guestfs.pod:1816
3975 "The callback function is called whenever a log message is generated by qemu, "
3976 "the appliance kernel, guestfsd (daemon), or utility programs."
3980 #: ../src/guestfs.pod:1819
3982 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3983 "guestfs_launch>) then additional debug messages are generated."
3987 #: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
3989 "If no callback is registered: the messages are discarded unless the verbose "
3990 "flag is set in which case they are sent to stderr. You can override the "
3991 "printing of verbose messages to stderr by setting up a callback."
3995 #: ../src/guestfs.pod:1827
3996 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
4000 #: ../src/guestfs.pod:1830
4002 "The callback function is called whenever a log message is generated by the "
4003 "library part of libguestfs."
4007 #: ../src/guestfs.pod:1833
4009 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
4010 "messages are generated."
4014 #: ../src/guestfs.pod:1841
4015 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
4019 #: ../src/guestfs.pod:1844
4021 "The callback function is called whenever a trace message is generated. This "
4022 "only applies if the trace flag (L</guestfs_set_trace>) is set."
4026 #: ../src/guestfs.pod:1847
4028 "If no callback is registered: the messages are sent to stderr. You can "
4029 "override the printing of trace messages to stderr by setting up a callback."
4033 #: ../src/guestfs.pod:1853
4034 msgid "guestfs_set_event_callback"
4038 #: ../src/guestfs.pod:1855
4041 " int guestfs_set_event_callback (guestfs_h *g,\n"
4042 " guestfs_event_callback cb,\n"
4043 " uint64_t event_bitmask,\n"
4050 #: ../src/guestfs.pod:1861
4052 "This function registers a callback (C<cb>) for all event classes in the "
4057 #: ../src/guestfs.pod:1864
4059 "For example, to register for all log message events, you could call this "
4060 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4061 "To register a single callback for all possible classes of events, use "
4062 "C<GUESTFS_EVENT_ALL>."
4066 #: ../src/guestfs.pod:1870
4067 msgid "C<flags> should always be passed as 0."
4071 #: ../src/guestfs.pod:1872
4073 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4074 "it for any purpose."
4078 #: ../src/guestfs.pod:1875
4080 "The return value is the event handle (an integer) which you can use to "
4081 "delete the callback (see below)."
4085 #: ../src/guestfs.pod:1878
4087 "If there is an error, this function returns C<-1>, and sets the error in the "
4088 "handle in the usual way (see L</guestfs_last_error> etc.)"
4092 #: ../src/guestfs.pod:1881
4094 "Callbacks remain in effect until they are deleted, or until the handle is "
4099 #: ../src/guestfs.pod:1884
4101 "In the case where multiple callbacks are registered for a particular event "
4102 "class, all of the callbacks are called. The order in which multiple "
4103 "callbacks are called is not defined."
4107 #: ../src/guestfs.pod:1888
4108 msgid "guestfs_delete_event_callback"
4112 #: ../src/guestfs.pod:1890
4115 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4120 #: ../src/guestfs.pod:1892
4122 "Delete a callback that was previously registered. C<event_handle> should be "
4123 "the integer that was returned by a previous call to "
4124 "C<guestfs_set_event_callback> on the same handle."
4128 #: ../src/guestfs.pod:1896
4129 msgid "guestfs_event_callback"
4133 #: ../src/guestfs.pod:1898
4136 " typedef void (*guestfs_event_callback) (\n"
4139 " uint64_t event,\n"
4140 " int event_handle,\n"
4142 " const char *buf, size_t buf_len,\n"
4143 " const uint64_t *array, size_t array_len);\n"
4148 #: ../src/guestfs.pod:1907
4150 "This is the type of the event callback function that you have to provide."
4154 #: ../src/guestfs.pod:1910
4156 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4157 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4158 "handle, and C<flags> which in the current API you should ignore."
4162 #: ../src/guestfs.pod:1914
4164 "The remaining parameters contain the event payload (if any). Each event may "
4165 "contain a payload, which usually relates to the event class, but for future "
4166 "proofing your code should be written to handle any payload for any event "
4171 #: ../src/guestfs.pod:1919
4173 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4174 "there is no message buffer). Note that this message buffer can contain "
4175 "arbitrary 8 bit data, including NUL bytes."
4179 #: ../src/guestfs.pod:1923
4181 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4182 "moment this is only used for progress messages."
4186 #: ../src/guestfs.pod:1926
4187 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4191 #: ../src/guestfs.pod:1928
4193 "One motivation for the generic event API was to allow GUI programs to "
4194 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4195 "unconditionally to C<stderr>."
4199 #: ../src/guestfs.pod:1932
4201 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4202 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4203 "messages are not events; you must capture error messages separately)."
4207 #: ../src/guestfs.pod:1937
4209 "Programs have to set up a callback to capture the classes of events of "
4214 #: ../src/guestfs.pod:1940
4218 " guestfs_set_event_callback\n"
4219 " (g, message_callback,\n"
4220 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4221 " GUESTFS_EVENT_TRACE,\n"
4222 " 0, NULL) == -1)\n"
4223 " if (eh == -1) {\n"
4224 " // handle error in the usual way\n"
4230 #: ../src/guestfs.pod:1950
4232 "The callback can then direct messages to the appropriate place. In this "
4233 "example, messages are directed to syslog:"
4237 #: ../src/guestfs.pod:1953
4241 " message_callback (\n"
4244 " uint64_t event,\n"
4245 " int event_handle,\n"
4247 " const char *buf, size_t buf_len,\n"
4248 " const uint64_t *array, size_t array_len)\n"
4250 " const int priority = LOG_USER|LOG_INFO;\n"
4251 " if (buf_len > 0)\n"
4252 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4259 #: ../src/guestfs.pod:1968
4260 msgid "PRIVATE DATA AREA"
4264 #: ../src/guestfs.pod:1970
4266 "You can attach named pieces of private data to the libguestfs handle, fetch "
4267 "them by name, and walk over them, for the lifetime of the handle. This is "
4268 "called the private data area and is only available from the C API."
4273 #: ../src/guestfs.pod:1975
4274 msgid "To attach a named piece of data, use the following call:"
4279 #: ../src/guestfs.pod:1977
4282 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4288 #: ../src/guestfs.pod:1979
4290 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4291 "pointer (which can be C<NULL>). Any previous item with the same name is "
4297 #: ../src/guestfs.pod:1983
4299 "You can use any C<key> you want, but names beginning with an underscore "
4300 "character are reserved for internal libguestfs purposes (for implementing "
4301 "language bindings). It is recommended to prefix the name with some unique "
4302 "string to avoid collisions with other users."
4307 #: ../src/guestfs.pod:1988
4308 msgid "To retrieve the pointer, use:"
4313 #: ../src/guestfs.pod:1990
4316 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4322 #: ../src/guestfs.pod:1992
4324 "This function returns C<NULL> if either no data is found associated with "
4325 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4330 #: ../src/guestfs.pod:1996
4332 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4333 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4334 "all. In particular, libguestfs does I<not> try to free the data when the "
4335 "handle is closed. If the data must be freed, then the caller must either "
4336 "free it before calling L</guestfs_close> or must set up a close callback to "
4337 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4341 #: ../src/guestfs.pod:2003
4342 msgid "To walk over all entries, use these two functions:"
4346 #: ../src/guestfs.pod:2005
4349 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4354 #: ../src/guestfs.pod:2007
4357 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4362 #: ../src/guestfs.pod:2009
4364 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4365 "not have any particular meaning -- keys are not returned in any defined "
4366 "order). A pointer to the key is returned in C<*key_rtn> and the "
4367 "corresponding data pointer is returned from the function. C<NULL> is "
4368 "returned if there are no keys stored in the handle."
4372 #: ../src/guestfs.pod:2015
4374 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4375 "value of this function is also C<NULL> is there are no further entries to "
4380 #: ../src/guestfs.pod:2019
4381 msgid "Notes about walking over entries:"
4385 #: ../src/guestfs.pod:2025
4387 "You must not call C<guestfs_set_private> while walking over the entries."
4391 #: ../src/guestfs.pod:2030
4393 "The handle maintains an internal iterator which is reset when you call "
4394 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4395 "call C<guestfs_set_private>."
4399 #: ../src/guestfs.pod:2036
4400 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4404 #: ../src/guestfs.pod:2038
4407 " guestfs_set_private (g, key, NULL);\n"
4412 #: ../src/guestfs.pod:2040
4413 msgid "then that C<key> is not returned when walking."
4417 #: ../src/guestfs.pod:2044
4419 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4420 "C<guestfs_next_private> or C<guestfs_set_private>."
4424 #: ../src/guestfs.pod:2050
4426 "The following example code shows how to print all keys and data pointers "
4427 "that are associated with the handle C<g>:"
4431 #: ../src/guestfs.pod:2053
4434 " const char *key;\n"
4435 " void *data = guestfs_first_private (g, &key);\n"
4436 " while (data != NULL)\n"
4438 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4439 " data = guestfs_next_private (g, &key);\n"
4445 #: ../src/guestfs.pod:2061
4447 "More commonly you are only interested in keys that begin with an application-"
4448 "specific prefix C<foo_>. Modify the loop like so:"
4452 #: ../src/guestfs.pod:2064
4455 " const char *key;\n"
4456 " void *data = guestfs_first_private (g, &key);\n"
4457 " while (data != NULL)\n"
4459 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4460 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4461 " data = guestfs_next_private (g, &key);\n"
4467 #: ../src/guestfs.pod:2073
4469 "If you need to modify keys while walking, then you have to jump back to the "
4470 "beginning of the loop. For example, to delete all keys prefixed with "
4475 #: ../src/guestfs.pod:2077
4478 " const char *key;\n"
4481 " data = guestfs_first_private (g, &key);\n"
4482 " while (data != NULL)\n"
4484 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4486 " guestfs_set_private (g, key, NULL);\n"
4487 " /* note that 'key' pointer is now invalid, and so is\n"
4488 " the internal iterator */\n"
4491 " data = guestfs_next_private (g, &key);\n"
4497 #: ../src/guestfs.pod:2093
4499 "Note that the above loop is guaranteed to terminate because the keys are "
4500 "being deleted, but other manipulations of keys within the loop might not "
4501 "terminate unless you also maintain an indication of which keys have been "
4507 #: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
4513 #: ../src/guestfs.pod:2100
4515 "<!-- old anchor for the next section --> <a name="
4516 "\"state_machine_and_low_level_event_api\"/>"
4521 #: ../src/guestfs.pod:2105
4522 msgid "ARCHITECTURE"
4527 #: ../src/guestfs.pod:2107
4529 "Internally, libguestfs is implemented by running an appliance (a special "
4530 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4531 "process of the main program."
4536 #: ../src/guestfs.pod:2111
4539 " ___________________\n"
4541 " | main program |\n"
4543 " | | child process / appliance\n"
4544 " | | __________________________\n"
4546 " +-------------------+ RPC | +-----------------+ |\n"
4547 " | libguestfs <--------------------> guestfsd | |\n"
4548 " | | | +-----------------+ |\n"
4549 " \\___________________/ | | Linux kernel | |\n"
4550 " | +--^--------------+ |\n"
4551 " \\_________|________________/\n"
4557 " \\______________/\n"
4563 #: ../src/guestfs.pod:2131
4565 "The library, linked to the main program, creates the child process and hence "
4566 "the appliance in the L</guestfs_launch> function."
4571 #: ../src/guestfs.pod:2134
4573 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4574 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4575 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4576 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4577 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4578 "attached to the qemu process which translates device access by the "
4579 "appliance's Linux kernel into accesses to the image."
4584 #: ../src/guestfs.pod:2143
4586 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4587 "Although the disk image you are attached to might also be used by some "
4588 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4589 "care if both libguestfs's qemu process and your virtual machine are trying "
4590 "to update the disk image at the same time, since these usually results in "
4591 "massive disk corruption)."
4596 #: ../src/guestfs.pod:2150
4597 msgid "STATE MACHINE"
4602 #: ../src/guestfs.pod:2152
4603 msgid "libguestfs uses a state machine to model the child process:"
4608 #: ../src/guestfs.pod:2154
4620 " / | \\ \\ guestfs_launch\n"
4621 " / | _\\__V______\n"
4623 " / | | LAUNCHING |\n"
4624 " / | \\___________/\n"
4626 " / | guestfs_launch\n"
4628 " ______ / __|____V\n"
4629 " / \\ ------> / \\\n"
4630 " | BUSY | | READY |\n"
4631 " \\______/ <------ \\________/\n"
4637 #: ../src/guestfs.pod:2176
4639 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4640 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4641 "(3) alternating between READY and BUSY as commands are issued to, and "
4642 "carried out by, the child process."
4647 #: ../src/guestfs.pod:2181
4649 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4650 "asynchronously at any time (eg. due to some internal error), and that causes "
4651 "the state to transition back to CONFIG."
4656 #: ../src/guestfs.pod:2185
4658 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4659 "issued when in the CONFIG state."
4664 #: ../src/guestfs.pod:2188
4666 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4667 "L</guestfs_launch> blocks until the child process is READY to accept "
4668 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4669 "moves the state from CONFIG to LAUNCHING while it is running."
4674 #: ../src/guestfs.pod:2194
4676 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4677 "state. These API calls block waiting for the command to be carried out (ie. "
4678 "the state to transition to BUSY and then back to READY). There are no non-"
4679 "blocking versions, and no way to issue more than one command per handle at "
4685 #: ../src/guestfs.pod:2200
4687 "Finally, the child process sends asynchronous messages back to the main "
4688 "program, such as kernel log messages. You can register a callback to "
4689 "receive these messages."
4694 #: ../src/guestfs.pod:2204
4700 #: ../src/guestfs.pod:2206
4701 msgid "COMMUNICATION PROTOCOL"
4706 #: ../src/guestfs.pod:2208
4708 "Don't rely on using this protocol directly. This section documents how it "
4709 "currently works, but it may change at any time."
4714 #: ../src/guestfs.pod:2211
4716 "The protocol used to talk between the library and the daemon running inside "
4717 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4718 "1014, RFC 1832, RFC 4506)."
4723 #: ../src/guestfs.pod:2215
4725 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4726 "this file is automatically generated)."
4731 #: ../src/guestfs.pod:2218
4733 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4734 "and C<FileOut> parameters, which are handled with very simple request/reply "
4735 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4736 "parameters, which use the same request and reply messages, but they may also "
4737 "be followed by files sent using a chunked encoding."
4742 #: ../src/guestfs.pod:2225
4743 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4748 #: ../src/guestfs.pod:2227
4749 msgid "For ordinary functions, the request message is:"
4754 #: ../src/guestfs.pod:2229
4757 " total length (header + arguments,\n"
4758 " but not including the length word itself)\n"
4759 " struct guestfs_message_header (encoded as XDR)\n"
4760 " struct guestfs_<foo>_args (encoded as XDR)\n"
4766 #: ../src/guestfs.pod:2234
4768 "The total length field allows the daemon to allocate a fixed size buffer "
4769 "into which it slurps the rest of the message. As a result, the total length "
4770 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4771 "effective size of any request is limited to somewhere under this size."
4776 #: ../src/guestfs.pod:2240
4778 "Note also that many functions don't take any arguments, in which case the "
4779 "C<guestfs_I<foo>_args> is completely omitted."
4784 #: ../src/guestfs.pod:2243
4786 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4787 "receiver knows what type of args structure to expect, or none at all."
4792 #: ../src/guestfs.pod:2247
4794 "For functions that take optional arguments, the optional arguments are "
4795 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4796 "arguments. A bitmask in the header indicates which optional arguments are "
4797 "meaningful. The bitmask is also checked to see if it contains bits set "
4798 "which the daemon does not know about (eg. if more optional arguments were "
4799 "added in a later version of the library), and this causes the call to be "
4805 #: ../src/guestfs.pod:2255
4806 msgid "The reply message for ordinary functions is:"
4811 #: ../src/guestfs.pod:2257
4814 " total length (header + ret,\n"
4815 " but not including the length word itself)\n"
4816 " struct guestfs_message_header (encoded as XDR)\n"
4817 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4823 #: ../src/guestfs.pod:2262
4825 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4826 "functions that return no formal return values."
4831 #: ../src/guestfs.pod:2265
4833 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4838 #: ../src/guestfs.pod:2268
4840 "In the case of an error, a flag is set in the header, and the reply message "
4841 "is slightly changed:"
4846 #: ../src/guestfs.pod:2271
4849 " total length (header + error,\n"
4850 " but not including the length word itself)\n"
4851 " struct guestfs_message_header (encoded as XDR)\n"
4852 " struct guestfs_message_error (encoded as XDR)\n"
4858 #: ../src/guestfs.pod:2276
4860 "The C<guestfs_message_error> structure contains the error message as a "
4866 #: ../src/guestfs.pod:2279
4867 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4872 #: ../src/guestfs.pod:2281
4874 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4875 "The normal request message is sent (see above). However this is followed by "
4876 "a sequence of file chunks."
4881 #: ../src/guestfs.pod:2285
4884 " total length (header + arguments,\n"
4885 " but not including the length word itself,\n"
4886 " and not including the chunks)\n"
4887 " struct guestfs_message_header (encoded as XDR)\n"
4888 " struct guestfs_<foo>_args (encoded as XDR)\n"
4889 " sequence of chunks for FileIn param #0\n"
4890 " sequence of chunks for FileIn param #1 etc.\n"
4896 #: ../src/guestfs.pod:2293
4897 msgid "The \"sequence of chunks\" is:"
4902 #: ../src/guestfs.pod:2295
4905 " length of chunk (not including length word itself)\n"
4906 " struct guestfs_chunk (encoded as XDR)\n"
4907 " length of chunk\n"
4908 " struct guestfs_chunk (encoded as XDR)\n"
4910 " length of chunk\n"
4911 " struct guestfs_chunk (with data.data_len == 0)\n"
4917 #: ../src/guestfs.pod:2303
4919 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4920 "is set in the final chunk to indicate either successful completion or early "
4926 #: ../src/guestfs.pod:2307
4928 "At time of writing there are no functions that have more than one FileIn "
4929 "parameter. However this is (theoretically) supported, by sending the "
4930 "sequence of chunks for each FileIn parameter one after another (from left to "
4936 #: ../src/guestfs.pod:2312
4938 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4939 "transfer. The library does this by sending a chunk with a special flag set "
4940 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4941 "RPC, does I<not> send any reply, and goes back to reading the next request."
4946 #: ../src/guestfs.pod:2318
4948 "The daemon may also cancel. It does this by writing a special word "
4949 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4950 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4951 "cancel chunk). The special word is chosen so that even if cancellation "
4952 "happens right at the end of the transfer (after the library has finished "
4953 "writing and has started listening for the reply), the \"spurious\" cancel "
4954 "flag will not be confused with the reply message."
4959 #: ../src/guestfs.pod:2327
4961 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4962 "limit), and also files where the size is not known in advance (eg. from "
4963 "pipes or sockets). However the chunks are rather small "
4964 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4965 "to keep much in memory."
4970 #: ../src/guestfs.pod:2333
4971 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4976 #: ../src/guestfs.pod:2335
4978 "The protocol for FileOut parameters is exactly the same as for FileIn "
4979 "parameters, but with the roles of daemon and library reversed."
4984 #: ../src/guestfs.pod:2338
4987 " total length (header + ret,\n"
4988 " but not including the length word itself,\n"
4989 " and not including the chunks)\n"
4990 " struct guestfs_message_header (encoded as XDR)\n"
4991 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4992 " sequence of chunks for FileOut param #0\n"
4993 " sequence of chunks for FileOut param #1 etc.\n"
4999 #: ../src/guestfs.pod:2346
5000 msgid "INITIAL MESSAGE"
5005 #: ../src/guestfs.pod:2348
5007 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
5008 "which indicates that the guest and daemon is alive. This is what L</"
5009 "guestfs_launch> waits for."
5014 #: ../src/guestfs.pod:2352
5015 msgid "PROGRESS NOTIFICATION MESSAGES"
5020 #: ../src/guestfs.pod:2354
5022 "The daemon may send progress notification messages at any time. These are "
5023 "distinguished by the normal length word being replaced by "
5024 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
5028 #: ../src/guestfs.pod:2358
5030 "The library turns them into progress callbacks (see L</"
5031 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5037 #: ../src/guestfs.pod:2362
5039 "The daemon self-limits the frequency of progress messages it sends (see "
5040 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5046 #: ../src/guestfs.pod:2366
5047 msgid "LIBGUESTFS VERSION NUMBERS"
5052 #: ../src/guestfs.pod:2368
5054 "Since April 2010, libguestfs has started to make separate development and "
5055 "stable releases, along with corresponding branches in our git repository. "
5056 "These separate releases can be identified by version number:"
5061 #: ../src/guestfs.pod:2373
5064 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5065 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5071 " | `-------- sub-version\n"
5073 " `------ always '1' because we don't change the ABI\n"
5079 #: ../src/guestfs.pod:2384
5080 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5085 #: ../src/guestfs.pod:2386
5087 "As time passes we cherry pick fixes from the development branch and backport "
5088 "those into the stable branch, the effect being that the stable branch should "
5089 "get more stable and less buggy over time. So the stable releases are ideal "
5090 "for people who don't need new features but would just like the software to "
5096 #: ../src/guestfs.pod:2392
5097 msgid "Our criteria for backporting changes are:"
5102 #: ../src/guestfs.pod:2398
5104 "Documentation changes which don't affect any code are backported unless the "
5105 "documentation refers to a future feature which is not in stable."
5110 #: ../src/guestfs.pod:2404
5112 "Bug fixes which are not controversial, fix obvious problems, and have been "
5113 "well tested are backported."
5118 #: ../src/guestfs.pod:2409
5120 "Simple rearrangements of code which shouldn't affect how it works get "
5121 "backported. This is so that the code in the two branches doesn't get too "
5122 "far out of step, allowing us to backport future fixes more easily."
5127 #: ../src/guestfs.pod:2415
5129 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5130 "exceptional case: the new feature is required in order to implement an "
5131 "important bug fix."
5136 #: ../src/guestfs.pod:2421
5138 "A new stable branch starts when we think the new features in development are "
5139 "substantial and compelling enough over the current stable branch to warrant "
5140 "it. When that happens we create new stable and development versions 1.N.0 "
5141 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5142 "stable at this point, but by backporting fixes from development, that branch "
5143 "will stabilize over time."
5147 #: ../src/guestfs.pod:2429
5148 msgid "EXTENDING LIBGUESTFS"
5152 #: ../src/guestfs.pod:2431
5153 msgid "ADDING A NEW API ACTION"
5157 #: ../src/guestfs.pod:2433
5159 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5160 "documentation) are generated, and this makes it easy to extend the "
5165 #: ../src/guestfs.pod:2437
5166 msgid "To add a new API action there are two changes:"
5170 #: ../src/guestfs.pod:2443
5172 "You need to add a description of the call (name, parameters, return type, "
5173 "tests, documentation) to C<generator/generator_actions.ml>."
5177 #: ../src/guestfs.pod:2446
5179 "There are two sorts of API action, depending on whether the call goes "
5180 "through to the daemon in the appliance, or is serviced entirely by the "
5181 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5182 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5183 "an example of the latter, since a trace flag is maintained in the handle and "
5184 "all tracing is done on the library side."
5188 #: ../src/guestfs.pod:2454
5190 "Most new actions are of the first type, and get added to the "
5191 "C<daemon_functions> list. Each function has a unique procedure number used "
5192 "in the RPC protocol which is assigned to that action when we publish "
5193 "libguestfs and cannot be reused. Take the latest procedure number and "
5198 #: ../src/guestfs.pod:2460
5200 "For library-only actions of the second type, add to the "
5201 "C<non_daemon_functions> list. Since these functions are serviced by the "
5202 "library and do not travel over the RPC mechanism to the daemon, these "
5203 "functions do not need a procedure number, and so the procedure number is set "
5208 #: ../src/guestfs.pod:2468
5209 msgid "Implement the action (in C):"
5213 #: ../src/guestfs.pod:2470
5215 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5216 "C<daemon/> directory."
5220 #: ../src/guestfs.pod:2473
5222 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5223 "(note: double underscore) in the C<src/> directory."
5227 #: ../src/guestfs.pod:2476
5228 msgid "In either case, use another function as an example of what to do."
5232 #: ../src/guestfs.pod:2480
5233 msgid "After making these changes, use C<make> to compile."
5237 #: ../src/guestfs.pod:2482
5239 "Note that you don't need to implement the RPC, language bindings, manual "
5240 "pages or anything else. It's all automatically generated from the OCaml "
5245 #: ../src/guestfs.pod:2486
5246 msgid "ADDING TESTS FOR AN API ACTION"
5250 #: ../src/guestfs.pod:2488
5252 "You can supply zero or as many tests as you want per API call. The tests "
5253 "can either be added as part of the API description (C<generator/"
5254 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5255 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5256 "slower, so if possible use the first method."
5260 #: ../src/guestfs.pod:2494
5262 "The following describes the test environment used when you add an API test "
5263 "in C<generator_actions.ml>."
5267 #: ../src/guestfs.pod:2497
5268 msgid "The test environment has 4 block devices:"
5272 #: ../src/guestfs.pod:2501
5273 msgid "C</dev/sda> 500MB"
5277 #: ../src/guestfs.pod:2503
5278 msgid "General block device for testing."
5282 #: ../src/guestfs.pod:2505
5283 msgid "C</dev/sdb> 50MB"
5287 #: ../src/guestfs.pod:2507
5289 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5294 #: ../src/guestfs.pod:2510
5295 msgid "C</dev/sdc> 10MB"
5299 #: ../src/guestfs.pod:2512
5300 msgid "Used in a few tests where two block devices are needed."
5304 #: ../src/guestfs.pod:2514
5309 #: ../src/guestfs.pod:2516
5310 msgid "ISO with fixed content (see C<images/test.iso>)."
5314 #: ../src/guestfs.pod:2520
5316 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5317 "appliance and block devices are reused between tests. So don't try testing "
5318 "L</guestfs_kill_subprocess> :-x"
5322 #: ../src/guestfs.pod:2524
5324 "Each test starts with an initial scenario, selected using one of the "
5325 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5326 "initialize the disks mentioned above in a particular way as documented in "
5327 "C<generator_types.ml>. You should not assume anything about the previous "
5328 "contents of other disks that are not initialized."
5332 #: ../src/guestfs.pod:2530
5334 "You can add a prerequisite clause to any individual test. This is a run-"
5335 "time check, which, if it fails, causes the test to be skipped. Useful if "
5336 "testing a command which might not work on all variations of libguestfs "
5337 "builds. A test that has prerequisite of C<Always> means to run "
5342 #: ../src/guestfs.pod:2536
5344 "In addition, packagers can skip individual tests by setting environment "
5345 "variables before running C<make check>."
5349 #: ../src/guestfs.pod:2539
5352 " SKIP_TEST_<CMD>_<NUM>=1\n"
5357 #: ../src/guestfs.pod:2541
5358 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5362 #: ../src/guestfs.pod:2543
5367 #: ../src/guestfs.pod:2545
5370 " SKIP_TEST_<CMD>=1\n"
5375 #: ../src/guestfs.pod:2547
5376 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5380 #: ../src/guestfs.pod:2549
5381 msgid "Packagers can run only certain tests by setting for example:"
5385 #: ../src/guestfs.pod:2551
5388 " TEST_ONLY=\"vfs_type zerofree\"\n"
5393 #: ../src/guestfs.pod:2553
5395 "See C<capitests/tests.c> for more details of how these environment variables "
5400 #: ../src/guestfs.pod:2556
5401 msgid "DEBUGGING NEW API ACTIONS"
5405 #: ../src/guestfs.pod:2558
5406 msgid "Test new actions work before submitting them."
5410 #: ../src/guestfs.pod:2560
5411 msgid "You can use guestfish to try out new commands."
5415 #: ../src/guestfs.pod:2562
5417 "Debugging the daemon is a problem because it runs inside a minimal "
5418 "environment. However you can fprintf messages in the daemon to stderr, and "
5419 "they will show up if you use C<guestfish -v>."
5423 #: ../src/guestfs.pod:2566
5424 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5428 #: ../src/guestfs.pod:2568
5430 "Our C source code generally adheres to some basic code-formatting "
5431 "conventions. The existing code base is not totally consistent on this "
5432 "front, but we do prefer that contributed code be formatted similarly. In "
5433 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5434 "indentation level, and other than that, follow the K&R style."
5438 #: ../src/guestfs.pod:2574
5440 "If you use Emacs, add the following to one of one of your start-up files (e."
5441 "g., ~/.emacs), to help ensure that you get indentation right:"
5445 #: ../src/guestfs.pod:2577
5448 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5449 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5450 " (add-hook 'find-file-hook\n"
5451 " '(lambda () (if (and buffer-file-name\n"
5452 " (string-match \"/libguestfs\\\\>\"\n"
5453 " (buffer-file-name))\n"
5454 " (not (string-equal mode-name \"Change Log\"))\n"
5455 " (not (string-equal mode-name \"Makefile\")))\n"
5456 " (setq indent-tabs-mode nil))))\n"
5461 #: ../src/guestfs.pod:2587
5464 " ;;; When editing C sources in libguestfs, use this style.\n"
5465 " (defun libguestfs-c-mode ()\n"
5466 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5468 " (c-set-style \"K&R\")\n"
5469 " (setq c-indent-level 2)\n"
5470 " (setq c-basic-offset 2))\n"
5471 " (add-hook 'c-mode-hook\n"
5472 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5473 " (buffer-file-name))\n"
5474 " (libguestfs-c-mode))))\n"
5479 #: ../src/guestfs.pod:2599
5480 msgid "Enable warnings when compiling (and fix any problems this finds):"
5484 #: ../src/guestfs.pod:2602
5487 " ./configure --enable-gcc-warnings\n"
5492 #: ../src/guestfs.pod:2604
5493 msgid "Useful targets are:"
5497 #: ../src/guestfs.pod:2606
5500 " make syntax-check # checks the syntax of the C code\n"
5501 " make check # runs the test suite\n"
5506 #: ../src/guestfs.pod:2609
5507 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5511 #: ../src/guestfs.pod:2611
5513 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5514 "which are used to do shell quoting."
5518 #: ../src/guestfs.pod:2616
5523 #: ../src/guestfs.pod:2618
5525 "Simple shell quoted string. Any spaces or other shell characters are "
5530 #: ../src/guestfs.pod:2621
5535 #: ../src/guestfs.pod:2623
5537 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5543 #: ../src/guestfs.pod:2628 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5544 msgid "For example:"
5548 #: ../src/guestfs.pod:2630
5551 " asprintf (&cmd, \"cat %R\", path);\n"
5556 #: ../src/guestfs.pod:2632
5557 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5561 #: ../src/guestfs.pod:2634
5563 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5564 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5565 "they are not passed via the shell (instead, straight to exec). You probably "
5566 "want to use the C<sysroot_path()> function however."
5570 #: ../src/guestfs.pod:2640
5571 msgid "SUBMITTING YOUR NEW API ACTIONS"
5575 #: ../src/guestfs.pod:2642
5577 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5578 "libguestfs> and CC to L<rjones@redhat.com>."
5582 #: ../src/guestfs.pod:2646
5583 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5587 #: ../src/guestfs.pod:2648
5588 msgid "We support i18n (gettext anyhow) in the library."
5592 #: ../src/guestfs.pod:2650
5594 "However many messages come from the daemon, and we don't translate those at "
5595 "the moment. One reason is that the appliance generally has all locale files "
5596 "removed from it, because they take up a lot of space. So we'd have to readd "
5597 "some of those, as well as copying our PO files into the appliance."
5601 #: ../src/guestfs.pod:2656
5603 "Debugging messages are never translated, since they are intended for the "
5608 #: ../src/guestfs.pod:2659
5609 msgid "SOURCE CODE SUBDIRECTORIES"
5613 #: ../src/guestfs.pod:2663 ../src/guestfs-actions.pod:5806
5614 #: ../fish/guestfish-actions.pod:3900
5615 msgid "C<appliance>"
5619 #: ../src/guestfs.pod:2665
5620 msgid "The libguestfs appliance, build scripts and so on."
5624 #: ../src/guestfs.pod:2667
5625 msgid "C<capitests>"
5629 #: ../src/guestfs.pod:2669
5630 msgid "Automated tests of the C API."
5634 #: ../src/guestfs.pod:2671
5639 #: ../src/guestfs.pod:2673
5641 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5646 #: ../src/guestfs.pod:2676
5651 #: ../src/guestfs.pod:2678
5652 msgid "Outside contributions, experimental parts."
5656 #: ../src/guestfs.pod:2680
5661 #: ../src/guestfs.pod:2682
5663 "The daemon that runs inside the libguestfs appliance and carries out actions."
5667 #: ../src/guestfs.pod:2685
5672 #: ../src/guestfs.pod:2687
5673 msgid "L<virt-df(1)> command and documentation."
5677 #: ../src/guestfs.pod:2689
5682 #: ../src/guestfs.pod:2691
5683 msgid "C API example code."
5687 #: ../src/guestfs.pod:2693
5692 #: ../src/guestfs.pod:2695
5694 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5695 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5696 "L<virt-tar-out(1)>."
5700 #: ../src/guestfs.pod:2699
5705 #: ../src/guestfs.pod:2701
5707 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5711 #: ../src/guestfs.pod:2703
5712 msgid "C<generator>"
5716 #: ../src/guestfs.pod:2705
5718 "The crucially important generator, used to automatically generate large "
5719 "amounts of boilerplate C code for things like RPC and bindings."
5723 #: ../src/guestfs.pod:2708
5728 #: ../src/guestfs.pod:2710
5729 msgid "Files used by the test suite."
5733 #: ../src/guestfs.pod:2712
5734 msgid "Some \"phony\" guest images which we test against."
5738 #: ../src/guestfs.pod:2714
5739 msgid "C<inspector>"
5743 #: ../src/guestfs.pod:2716
5744 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5748 #: ../src/guestfs.pod:2718
5753 #: ../src/guestfs.pod:2720
5754 msgid "Logo used on the website. The fish is called Arthur by the way."
5758 #: ../src/guestfs.pod:2722
5763 #: ../src/guestfs.pod:2724
5764 msgid "M4 macros used by autoconf."
5768 #: ../src/guestfs.pod:2726
5773 #: ../src/guestfs.pod:2728
5774 msgid "Translations of simple gettext strings."
5778 #: ../src/guestfs.pod:2730
5783 #: ../src/guestfs.pod:2732
5785 "The build infrastructure and PO files for translations of manpages and POD "
5786 "files. Eventually this will be combined with the C<po> directory, but that "
5787 "is rather complicated."
5791 #: ../src/guestfs.pod:2736
5792 msgid "C<regressions>"
5796 #: ../src/guestfs.pod:2738
5797 msgid "Regression tests."
5801 #: ../src/guestfs.pod:2740
5806 #: ../src/guestfs.pod:2742
5807 msgid "L<virt-rescue(1)> command and documentation."
5811 #: ../src/guestfs.pod:2744
5816 #: ../src/guestfs.pod:2746
5817 msgid "Source code to the C library."
5821 #: ../src/guestfs.pod:2748
5826 #: ../src/guestfs.pod:2750
5827 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5831 #: ../src/guestfs.pod:2752
5832 msgid "C<test-tool>"
5836 #: ../src/guestfs.pod:2754
5838 "Test tool for end users to test if their qemu/kernel combination will work "
5843 #: ../src/guestfs.pod:2757
5848 #: ../src/guestfs.pod:2759
5853 #: ../src/guestfs.pod:2761
5858 #: ../src/guestfs.pod:2763
5863 #: ../src/guestfs.pod:2765
5868 #: ../src/guestfs.pod:2767
5873 #: ../src/guestfs.pod:2769
5878 #: ../src/guestfs.pod:2771
5883 #: ../src/guestfs.pod:2773
5884 msgid "Language bindings."
5889 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1010
5890 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5891 msgid "ENVIRONMENT VARIABLES"
5896 #: ../src/guestfs.pod:2781 ../fish/guestfish.pod:1036
5897 msgid "LIBGUESTFS_APPEND"
5902 #: ../src/guestfs.pod:2783 ../fish/guestfish.pod:1038
5903 msgid "Pass additional options to the guest kernel."
5908 #: ../src/guestfs.pod:2785 ../fish/guestfish.pod:1040
5909 msgid "LIBGUESTFS_DEBUG"
5914 #: ../src/guestfs.pod:2787
5916 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5917 "effect as calling C<guestfs_set_verbose (g, 1)>."
5922 #: ../src/guestfs.pod:2790 ../fish/guestfish.pod:1045
5923 msgid "LIBGUESTFS_MEMSIZE"
5928 #: ../src/guestfs.pod:2792 ../fish/guestfish.pod:1047
5930 "Set the memory allocated to the qemu process, in megabytes. For example:"
5935 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1050
5938 " LIBGUESTFS_MEMSIZE=700\n"
5944 #: ../src/guestfs.pod:2797 ../fish/guestfish.pod:1052
5945 msgid "LIBGUESTFS_PATH"
5949 #: ../src/guestfs.pod:2799
5951 "Set the path that libguestfs uses to search for a supermin appliance. See "
5952 "the discussion of paths in section L</PATH> above."
5957 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1057
5958 msgid "LIBGUESTFS_QEMU"
5963 #: ../src/guestfs.pod:2804 ../fish/guestfish.pod:1059
5965 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5966 "which was found at compile time by the configure script is used."
5971 #: ../src/guestfs.pod:2808
5972 msgid "See also L</QEMU WRAPPERS> above."
5977 #: ../src/guestfs.pod:2810 ../fish/guestfish.pod:1063
5978 msgid "LIBGUESTFS_TRACE"
5983 #: ../src/guestfs.pod:2812
5985 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5986 "effect as calling C<guestfs_set_trace (g, 1)>."
5991 #: ../src/guestfs.pod:2815 ../fish/guestfish.pod:1072
5996 #: ../src/guestfs.pod:2817 ../fish/guestfish.pod:1074
5998 "Location of temporary directory, defaults to C</tmp> except for the cached "
5999 "supermin appliance which defaults to C</var/tmp>."
6003 #: ../src/guestfs.pod:2820 ../fish/guestfish.pod:1077
6005 "If libguestfs was compiled to use the supermin appliance then the real "
6006 "appliance is cached in this directory, shared between all handles belonging "
6007 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6008 "use in case C</var/tmp> is not large enough."
6013 #: ../src/guestfs.pod:2828 ../fish/guestfish.pod:1144
6014 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267
6015 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6016 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
6017 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
6022 #: ../src/guestfs.pod:2830
6024 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6025 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6026 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6027 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6028 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6029 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6030 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6035 #: ../src/guestfs.pod:2857
6037 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6038 "(8)>, L<disktype(1)>."
6043 #: ../src/guestfs.pod:2864 ../tools/virt-win-reg.pl:587
6044 #: ../tools/virt-make-fs.pl:553
6050 #: ../src/guestfs.pod:2866
6051 msgid "To get a list of bugs against libguestfs use this link:"
6056 #: ../src/guestfs.pod:2868
6058 "L<https://bugzilla.redhat.com/buglist.cgi?"
6059 "component=libguestfs&product=Virtualization+Tools>"
6064 #: ../src/guestfs.pod:2870
6065 msgid "To report a new bug against libguestfs use this link:"
6070 #: ../src/guestfs.pod:2872
6072 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6073 "component=libguestfs&product=Virtualization+Tools>"
6078 #: ../src/guestfs.pod:2874
6079 msgid "When reporting a bug, please check:"
6084 #: ../src/guestfs.pod:2880
6085 msgid "That the bug hasn't been reported already."
6090 #: ../src/guestfs.pod:2884
6091 msgid "That you are testing a recent version."
6096 #: ../src/guestfs.pod:2888
6097 msgid "Describe the bug accurately, and give a way to reproduce it."
6102 #: ../src/guestfs.pod:2892
6104 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6110 #: ../src/guestfs.pod:2897 ../fish/guestfish.pod:1167
6111 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
6117 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1169
6118 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
6119 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6124 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1171
6125 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282
6126 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6127 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
6128 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
6133 #: ../src/guestfs.pod:2903 ../fish/guestfish.pod:1173
6134 #: ../test-tool/libguestfs-test-tool.pod:99
6135 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6140 #: ../src/guestfs.pod:2906
6142 "This library is free software; you can redistribute it and/or modify it "
6143 "under the terms of the GNU Lesser General Public License as published by the "
6144 "Free Software Foundation; either version 2 of the License, or (at your "
6145 "option) any later version."
6150 #: ../src/guestfs.pod:2911
6152 "This library is distributed in the hope that it will be useful, but WITHOUT "
6153 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6154 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6160 #: ../src/guestfs.pod:2916
6162 "You should have received a copy of the GNU Lesser General Public License "
6163 "along with this library; if not, write to the Free Software Foundation, "
6164 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6169 #: ../src/guestfs-actions.pod:1
6170 msgid "guestfs_add_cdrom"
6175 #: ../src/guestfs-actions.pod:3
6179 " guestfs_add_cdrom (guestfs_h *g,\n"
6180 " const char *filename);\n"
6186 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6187 msgid "This function adds a virtual CD-ROM disk image to the guest."
6192 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6193 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
6198 #: ../src/guestfs-actions.pod:17
6200 "This call checks for the existence of C<filename>. This stops you from "
6201 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6202 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6208 #: ../src/guestfs-actions.pod:24
6210 "If you just want to add an ISO file (often you use this as an efficient way "
6211 "to transfer large files into the guest), then you should probably use "
6212 "C<guestfs_add_drive_ro> instead."
6217 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6218 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6219 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6220 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6221 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6222 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6223 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6224 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6225 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6226 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6227 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6228 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6229 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6230 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6231 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6232 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6233 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
6234 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
6235 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
6236 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
6237 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
6238 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3451
6239 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3491
6240 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3660
6241 #: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3687
6242 #: ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3738
6243 #: ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3830
6244 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3870
6245 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3925
6246 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3963
6247 #: ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010
6248 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4062
6249 #: ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4090
6250 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4200
6251 #: ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4233
6252 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4302
6253 #: ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4336
6254 #: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364
6255 #: ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4396
6256 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4474
6257 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4578
6258 #: ../src/guestfs-actions.pod:4597 ../src/guestfs-actions.pod:4616
6259 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4645
6260 #: ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4673
6261 #: ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4723
6262 #: ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4758
6263 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4789
6264 #: ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4875
6265 #: ../src/guestfs-actions.pod:4889 ../src/guestfs-actions.pod:4917
6266 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952
6267 #: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5143
6268 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5183
6269 #: ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5281
6270 #: ../src/guestfs-actions.pod:5298 ../src/guestfs-actions.pod:5311
6271 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5614
6272 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652
6273 #: ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5676
6274 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702
6275 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5732
6276 #: ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5772
6277 #: ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5821
6278 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5860
6279 #: ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5897
6280 #: ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5937
6281 #: ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5982
6282 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6025
6283 #: ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6068
6284 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6102
6285 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162
6286 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6296
6287 #: ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6429
6288 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6455
6289 #: ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6490
6290 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6516
6291 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6590
6292 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6623
6293 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656
6294 #: ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6689
6295 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739
6296 #: ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6793
6297 #: ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6845
6298 #: ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:7000
6299 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7032
6300 #: ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7100
6301 #: ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7178
6302 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7258
6303 #: ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7343
6304 #: ../src/guestfs-actions.pod:7372
6305 msgid "This function returns 0 on success or -1 on error."
6310 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6311 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6312 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6314 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6320 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6321 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6322 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
6323 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:7266
6324 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:31
6325 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6326 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6327 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3000
6328 #: ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4955
6330 "Deprecated functions will not be removed from the API, but the fact that "
6331 "they are deprecated indicates that there are problems with correct use of "
6337 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6338 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
6339 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
6340 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3473
6341 #: ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:5839
6342 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6070
6343 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6658
6344 #: ../src/guestfs-actions.pod:7180
6345 msgid "(Added in 0.3)"
6350 #: ../src/guestfs-actions.pod:41
6351 msgid "guestfs_add_domain"
6356 #: ../src/guestfs-actions.pod:43
6360 " guestfs_add_domain (guestfs_h *g,\n"
6361 " const char *dom,\n"
6368 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6369 #: ../src/guestfs-actions.pod:4435
6371 "You may supply a list of optional arguments to this call. Use zero or more "
6372 "of the following pairs of parameters, and terminate the list with C<-1> on "
6373 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6377 #: ../src/guestfs-actions.pod:53
6380 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6381 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6382 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6383 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6389 #: ../src/guestfs-actions.pod:58
6391 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6392 "It works by connecting to libvirt, requesting the domain and domain XML from "
6393 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6399 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6401 "The number of disks added is returned. This operation is atomic: if an "
6402 "error is returned, then no disks are added."
6407 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6409 "This function does some minimal checks to make sure the libvirt domain is "
6410 "not running (unless C<readonly> is true). In a future version we will try "
6411 "to acquire the libvirt lock on each disk."
6416 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6418 "Disks must be accessible locally. This often means that adding disks from a "
6419 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6420 "unless those disks are accessible via the same device path locally too."
6424 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6426 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6427 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6428 "libvirt URI (or one set through an environment variable, see the libvirt "
6429 "documentation for full details)."
6433 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6435 "The optional C<live> flag controls whether this call will try to connect to "
6436 "a running virtual machine C<guestfsd> process if it sees a suitable "
6437 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6438 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6439 "DAEMONS> for more information."
6444 #: ../src/guestfs-actions.pod:88
6446 "The other optional parameters are passed directly through to "
6447 "C<guestfs_add_drive_opts>."
6452 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6453 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6454 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6455 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6456 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
6457 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
6458 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
6459 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2772
6460 #: ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:4861
6461 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5395
6462 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:6766
6463 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7204
6464 #: ../src/guestfs-actions.pod:7217
6465 msgid "On error this function returns -1."
6470 #: ../src/guestfs-actions.pod:93
6471 msgid "(Added in 1.7.4)"
6476 #: ../src/guestfs-actions.pod:95
6477 msgid "guestfs_add_domain_va"
6482 #: ../src/guestfs-actions.pod:97
6486 " guestfs_add_domain_va (guestfs_h *g,\n"
6487 " const char *dom,\n"
6494 #: ../src/guestfs-actions.pod:102
6495 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6500 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6501 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6502 #: ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4500
6503 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6508 #: ../src/guestfs-actions.pod:106
6509 msgid "guestfs_add_domain_argv"
6514 #: ../src/guestfs-actions.pod:108
6518 " guestfs_add_domain_argv (guestfs_h *g,\n"
6519 " const char *dom,\n"
6520 " const struct guestfs_add_domain_argv *optargs);\n"
6526 #: ../src/guestfs-actions.pod:113
6527 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6532 #: ../src/guestfs-actions.pod:117
6533 msgid "guestfs_add_drive"
6538 #: ../src/guestfs-actions.pod:119
6542 " guestfs_add_drive (guestfs_h *g,\n"
6543 " const char *filename);\n"
6549 #: ../src/guestfs-actions.pod:123
6551 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6552 "optional parameters, so the disk is added writable, with the format being "
6553 "detected automatically."
6558 #: ../src/guestfs-actions.pod:127
6560 "Automatic detection of the format opens you up to a potential security hole "
6561 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6562 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6563 "you should think about replacing calls to this function with calls to "
6564 "C<guestfs_add_drive_opts>, and specifying the format."
6569 #: ../src/guestfs-actions.pod:138
6570 msgid "guestfs_add_drive_opts"
6575 #: ../src/guestfs-actions.pod:140
6579 " guestfs_add_drive_opts (guestfs_h *g,\n"
6580 " const char *filename,\n"
6587 #: ../src/guestfs-actions.pod:150
6590 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6591 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6592 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6598 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6600 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6601 "The first time you call this function, the disk appears as C</dev/sda>, the "
6602 "second time as C</dev/sdb>, and so on."
6607 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6609 "You don't necessarily need to be root when using libguestfs. However you "
6610 "obviously do need sufficient permissions to access the filename for whatever "
6611 "operations you want to perform (ie. read access if you just want to read the "
6612 "image or write access if you want to modify the image)."
6617 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6618 msgid "This call checks that C<filename> exists."
6623 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4446
6624 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3011
6625 msgid "The optional arguments are:"
6630 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6636 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6638 "If true then the image is treated as read-only. Writes are still allowed, "
6639 "but they are stored in a temporary snapshot overlay which is discarded at "
6640 "the end. The disk that you add is not modified."
6645 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6651 #: ../src/guestfs-actions.pod:179
6653 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6654 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6655 "Possible formats include C<raw> and C<qcow2>."
6660 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6662 "Automatic detection of the format opens you up to a potential security hole "
6663 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6664 "RHBZ#642934. Specifying the format closes this security hole."
6669 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6675 #: ../src/guestfs-actions.pod:190
6677 "This rarely-used option lets you emulate the behaviour of the deprecated "
6678 "C<guestfs_add_drive_with_if> call (q.v.)"
6683 #: ../src/guestfs-actions.pod:197
6684 msgid "(Added in 1.5.23)"
6689 #: ../src/guestfs-actions.pod:199
6690 msgid "guestfs_add_drive_opts_va"
6695 #: ../src/guestfs-actions.pod:201
6699 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6700 " const char *filename,\n"
6707 #: ../src/guestfs-actions.pod:206
6708 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6713 #: ../src/guestfs-actions.pod:210
6714 msgid "guestfs_add_drive_opts_argv"
6719 #: ../src/guestfs-actions.pod:212
6723 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6724 " const char *filename,\n"
6725 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6731 #: ../src/guestfs-actions.pod:217
6732 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6737 #: ../src/guestfs-actions.pod:221
6738 msgid "guestfs_add_drive_ro"
6743 #: ../src/guestfs-actions.pod:223
6747 " guestfs_add_drive_ro (guestfs_h *g,\n"
6748 " const char *filename);\n"
6754 #: ../src/guestfs-actions.pod:227
6756 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6757 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6758 "disk is added read-only, with the format being detected automatically."
6763 #: ../src/guestfs-actions.pod:234
6764 msgid "(Added in 1.0.38)"
6769 #: ../src/guestfs-actions.pod:236
6770 msgid "guestfs_add_drive_ro_with_if"
6775 #: ../src/guestfs-actions.pod:238
6779 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6780 " const char *filename,\n"
6781 " const char *iface);\n"
6787 #: ../src/guestfs-actions.pod:243
6789 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6790 "QEMU interface emulation to use at run time."
6795 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6796 #: ../src/guestfs-actions.pod:2356
6797 msgid "(Added in 1.0.84)"
6802 #: ../src/guestfs-actions.pod:257
6803 msgid "guestfs_add_drive_with_if"
6808 #: ../src/guestfs-actions.pod:259
6812 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6813 " const char *filename,\n"
6814 " const char *iface);\n"
6820 #: ../src/guestfs-actions.pod:264
6822 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6823 "QEMU interface emulation to use at run time."
6828 #: ../src/guestfs-actions.pod:278
6829 msgid "guestfs_aug_clear"
6834 #: ../src/guestfs-actions.pod:280
6838 " guestfs_aug_clear (guestfs_h *g,\n"
6839 " const char *augpath);\n"
6845 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6847 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6848 "L<augtool(1)> C<clear> command."
6853 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6854 msgid "(Added in 1.3.4)"
6859 #: ../src/guestfs-actions.pod:291
6860 msgid "guestfs_aug_close"
6865 #: ../src/guestfs-actions.pod:293
6869 " guestfs_aug_close (guestfs_h *g);\n"
6875 #: ../src/guestfs-actions.pod:296
6877 "Close the current Augeas handle and free up any resources used by it. After "
6878 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6879 "any other Augeas functions."
6884 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6885 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6886 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6887 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6888 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6889 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6890 #: ../src/guestfs-actions.pod:5472
6891 msgid "(Added in 0.7)"
6896 #: ../src/guestfs-actions.pod:305
6897 msgid "guestfs_aug_defnode"
6902 #: ../src/guestfs-actions.pod:307
6905 " struct guestfs_int_bool *\n"
6906 " guestfs_aug_defnode (guestfs_h *g,\n"
6907 " const char *name,\n"
6908 " const char *expr,\n"
6909 " const char *val);\n"
6915 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6917 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6922 #: ../src/guestfs-actions.pod:316
6924 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6925 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6926 "containing that single node."
6931 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6933 "On success this returns a pair containing the number of nodes in the "
6934 "nodeset, and a boolean flag if a node was created."
6939 #: ../src/guestfs-actions.pod:324
6941 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6942 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6947 #: ../src/guestfs-actions.pod:330
6948 msgid "guestfs_aug_defvar"
6953 #: ../src/guestfs-actions.pod:332
6957 " guestfs_aug_defvar (guestfs_h *g,\n"
6958 " const char *name,\n"
6959 " const char *expr);\n"
6965 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6967 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6968 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6973 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6975 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6976 "evaluates to something which is not a nodeset."
6981 #: ../src/guestfs-actions.pod:348
6982 msgid "guestfs_aug_get"
6987 #: ../src/guestfs-actions.pod:350
6991 " guestfs_aug_get (guestfs_h *g,\n"
6992 " const char *augpath);\n"
6998 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
7000 "Look up the value associated with C<path>. If C<path> matches exactly one "
7001 "node, the C<value> is returned."
7006 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
7007 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
7008 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
7009 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
7010 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
7011 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
7012 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
7013 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
7014 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
7015 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
7016 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
7017 #: ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2864
7018 #: ../src/guestfs-actions.pod:2895 ../src/guestfs-actions.pod:2919
7019 #: ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:3016
7020 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3060
7021 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3982
7022 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4262
7023 #: ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5200
7024 #: ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5548
7025 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6209
7026 #: ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6242
7027 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6940
7028 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6977
7029 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7429
7031 "This function returns a string, or NULL on error. I<The caller must free "
7032 "the returned string after use>."
7037 #: ../src/guestfs-actions.pod:362
7038 msgid "guestfs_aug_init"
7043 #: ../src/guestfs-actions.pod:364
7047 " guestfs_aug_init (guestfs_h *g,\n"
7048 " const char *root,\n"
7055 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7057 "Create a new Augeas handle for editing configuration files. If there was "
7058 "any previous Augeas handle associated with this guestfs session, then it is "
7064 #: ../src/guestfs-actions.pod:373
7065 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7070 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7072 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7077 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7079 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7080 "logical I<or> of the following integers:"
7085 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7086 msgid "C<AUG_SAVE_BACKUP> = 1"
7091 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7092 msgid "Keep the original file with a C<.augsave> extension."
7097 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7098 msgid "C<AUG_SAVE_NEWFILE> = 2"
7103 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7105 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7106 "original. Overrides C<AUG_SAVE_BACKUP>."
7111 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7112 msgid "C<AUG_TYPE_CHECK> = 4"
7117 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7118 msgid "Typecheck lenses (can be expensive)."
7123 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7124 msgid "C<AUG_NO_STDINC> = 8"
7129 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7130 msgid "Do not use standard load path for modules."
7135 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7136 msgid "C<AUG_SAVE_NOOP> = 16"
7141 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7142 msgid "Make save a no-op, just record what would have been changed."
7147 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7148 msgid "C<AUG_NO_LOAD> = 32"
7153 #: ../src/guestfs-actions.pod:408
7154 msgid "Do not load the tree in C<guestfs_aug_init>."
7159 #: ../src/guestfs-actions.pod:412
7160 msgid "To close the handle, you can call C<guestfs_aug_close>."
7165 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7166 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7171 #: ../src/guestfs-actions.pod:420
7172 msgid "guestfs_aug_insert"
7177 #: ../src/guestfs-actions.pod:422
7181 " guestfs_aug_insert (guestfs_h *g,\n"
7182 " const char *augpath,\n"
7183 " const char *label,\n"
7190 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7192 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7193 "or after C<path> (depending on the boolean flag C<before>)."
7198 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7200 "C<path> must match exactly one existing node in the tree, and C<label> must "
7201 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7206 #: ../src/guestfs-actions.pod:440
7207 msgid "guestfs_aug_load"
7212 #: ../src/guestfs-actions.pod:442
7216 " guestfs_aug_load (guestfs_h *g);\n"
7222 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7223 msgid "Load files into the tree."
7228 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7229 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7234 #: ../src/guestfs-actions.pod:454
7235 msgid "guestfs_aug_ls"
7240 #: ../src/guestfs-actions.pod:456
7244 " guestfs_aug_ls (guestfs_h *g,\n"
7245 " const char *augpath);\n"
7251 #: ../src/guestfs-actions.pod:460
7253 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7254 "sorting the resulting nodes into alphabetical order."
7259 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7260 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7261 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
7262 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
7263 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
7264 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
7265 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
7266 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
7267 #: ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2973
7268 #: ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:3552
7269 #: ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3719
7270 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4822
7271 #: ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5468
7272 #: ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:6282
7273 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6398
7274 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6568
7275 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7070
7276 #: ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7282
7277 #: ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7386
7278 #: ../src/guestfs-actions.pod:7405 ../src/guestfs-actions.pod:7451
7279 #: ../src/guestfs-actions.pod:7470
7281 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7282 ">), or NULL if there was an error. I<The caller must free the strings and "
7283 "the array after use>."
7288 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7289 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
7290 #: ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3371
7291 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4015
7292 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4235
7293 #: ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4826
7294 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5678
7295 #: ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5704
7296 #: ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6782
7297 #: ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7034
7298 #: ../src/guestfs-actions.pod:7270
7299 msgid "(Added in 0.8)"
7304 #: ../src/guestfs-actions.pod:469
7305 msgid "guestfs_aug_match"
7310 #: ../src/guestfs-actions.pod:471
7314 " guestfs_aug_match (guestfs_h *g,\n"
7315 " const char *augpath);\n"
7321 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7323 "Returns a list of paths which match the path expression C<path>. The "
7324 "returned paths are sufficiently qualified so that they match exactly one "
7325 "node in the current tree."
7330 #: ../src/guestfs-actions.pod:485
7331 msgid "guestfs_aug_mv"
7336 #: ../src/guestfs-actions.pod:487
7340 " guestfs_aug_mv (guestfs_h *g,\n"
7341 " const char *src,\n"
7342 " const char *dest);\n"
7348 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7350 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7351 "C<dest> is overwritten if it exists."
7356 #: ../src/guestfs-actions.pod:499
7357 msgid "guestfs_aug_rm"
7362 #: ../src/guestfs-actions.pod:501
7366 " guestfs_aug_rm (guestfs_h *g,\n"
7367 " const char *augpath);\n"
7373 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7374 msgid "Remove C<path> and all of its children."
7379 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7380 msgid "On success this returns the number of entries which were removed."
7385 #: ../src/guestfs-actions.pod:513
7386 msgid "guestfs_aug_save"
7391 #: ../src/guestfs-actions.pod:515
7395 " guestfs_aug_save (guestfs_h *g);\n"
7401 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7402 msgid "This writes all pending changes to disk."
7407 #: ../src/guestfs-actions.pod:520
7409 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7415 #: ../src/guestfs-actions.pod:527
7416 msgid "guestfs_aug_set"
7421 #: ../src/guestfs-actions.pod:529
7425 " guestfs_aug_set (guestfs_h *g,\n"
7426 " const char *augpath,\n"
7427 " const char *val);\n"
7433 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7434 msgid "Set the value associated with C<path> to C<val>."
7439 #: ../src/guestfs-actions.pod:536
7441 "In the Augeas API, it is possible to clear a node by setting the value to "
7442 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7443 "this call. Instead you must use the C<guestfs_aug_clear> call."
7448 #: ../src/guestfs-actions.pod:545
7449 msgid "guestfs_available"
7454 #: ../src/guestfs-actions.pod:547
7458 " guestfs_available (guestfs_h *g,\n"
7459 " char *const *groups);\n"
7465 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7467 "This command is used to check the availability of some groups of "
7468 "functionality in the appliance, which not all builds of the libguestfs "
7469 "appliance will be able to provide."
7474 #: ../src/guestfs-actions.pod:555
7476 "The libguestfs groups, and the functions that those groups correspond to, "
7477 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7478 "runtime by calling C<guestfs_available_all_groups>."
7483 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7485 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7486 "\"]> would check for the availability of the Linux inotify functions and "
7487 "Augeas (configuration file editing) functions."
7492 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7493 msgid "The command returns no error if I<all> requested groups are available."
7498 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7500 "It fails with an error if one or more of the requested groups is unavailable "
7506 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7508 "If an unknown group name is included in the list of groups then an error is "
7514 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7520 #: ../src/guestfs-actions.pod:579
7521 msgid "You must call C<guestfs_launch> before calling this function."
7526 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7528 "The reason is because we don't know what groups are supported by the "
7529 "appliance/daemon until it is running and can be queried."
7534 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7536 "If a group of functions is available, this does not necessarily mean that "
7537 "they will work. You still have to check for errors when calling individual "
7538 "API functions even if they are available."
7543 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7545 "It is usually the job of distro packagers to build complete functionality "
7546 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7547 "with all requirements satisfied, will support everything."
7552 #: ../src/guestfs-actions.pod:601
7554 "This call was added in version C<1.0.80>. In previous versions of "
7555 "libguestfs all you could do would be to speculatively execute a command to "
7556 "find out if the daemon implemented it. See also C<guestfs_version>."
7561 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7562 msgid "(Added in 1.0.80)"
7567 #: ../src/guestfs-actions.pod:612
7568 msgid "guestfs_available_all_groups"
7573 #: ../src/guestfs-actions.pod:614
7577 " guestfs_available_all_groups (guestfs_h *g);\n"
7583 #: ../src/guestfs-actions.pod:617
7585 "This command returns a list of all optional groups that this daemon knows "
7586 "about. Note this returns both supported and unsupported groups. To find "
7587 "out which ones the daemon can actually support you have to call "
7588 "C<guestfs_available> on each member of the returned list."
7593 #: ../src/guestfs-actions.pod:623
7594 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7599 #: ../src/guestfs-actions.pod:629
7600 msgid "(Added in 1.3.15)"
7605 #: ../src/guestfs-actions.pod:631
7606 msgid "guestfs_base64_in"
7611 #: ../src/guestfs-actions.pod:633
7615 " guestfs_base64_in (guestfs_h *g,\n"
7616 " const char *base64file,\n"
7617 " const char *filename);\n"
7623 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7625 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7630 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7631 msgid "(Added in 1.3.5)"
7636 #: ../src/guestfs-actions.pod:645
7637 msgid "guestfs_base64_out"
7642 #: ../src/guestfs-actions.pod:647
7646 " guestfs_base64_out (guestfs_h *g,\n"
7647 " const char *filename,\n"
7648 " const char *base64file);\n"
7654 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7656 "This command downloads the contents of C<filename>, writing it out to local "
7657 "file C<base64file> encoded as base64."
7662 #: ../src/guestfs-actions.pod:659
7663 msgid "guestfs_blockdev_flushbufs"
7668 #: ../src/guestfs-actions.pod:661
7672 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7673 " const char *device);\n"
7679 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7681 "This tells the kernel to flush internal buffers associated with C<device>."
7686 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7687 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7688 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7689 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7690 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7691 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7692 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7693 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7694 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7695 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7696 msgid "This uses the L<blockdev(8)> command."
7701 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7702 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7703 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7704 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7705 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7706 msgid "(Added in 0.9.3)"
7711 #: ../src/guestfs-actions.pod:674
7712 msgid "guestfs_blockdev_getbsz"
7717 #: ../src/guestfs-actions.pod:676
7721 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7722 " const char *device);\n"
7728 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7729 msgid "This returns the block size of a device."
7734 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7735 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7737 "(Note this is different from both I<size in blocks> and I<filesystem block "
7743 #: ../src/guestfs-actions.pod:691
7744 msgid "guestfs_blockdev_getro"
7749 #: ../src/guestfs-actions.pod:693
7753 " guestfs_blockdev_getro (guestfs_h *g,\n"
7754 " const char *device);\n"
7760 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7762 "Returns a boolean indicating if the block device is read-only (true if read-"
7763 "only, false if not)."
7768 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7769 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7770 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7771 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7772 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7773 #: ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3097
7774 #: ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3279
7775 #: ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3308
7776 #: ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3338
7777 #: ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3369
7778 #: ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3396
7779 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3425
7780 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:4971
7781 msgid "This function returns a C truth value on success or -1 on error."
7786 #: ../src/guestfs-actions.pod:706
7787 msgid "guestfs_blockdev_getsize64"
7792 #: ../src/guestfs-actions.pod:708
7796 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7797 " const char *device);\n"
7803 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7804 msgid "This returns the size of the device in bytes."
7809 #: ../src/guestfs-actions.pod:714
7810 msgid "See also C<guestfs_blockdev_getsz>."
7815 #: ../src/guestfs-actions.pod:722
7816 msgid "guestfs_blockdev_getss"
7821 #: ../src/guestfs-actions.pod:724
7825 " guestfs_blockdev_getss (guestfs_h *g,\n"
7826 " const char *device);\n"
7832 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7834 "This returns the size of sectors on a block device. Usually 512, but can be "
7835 "larger for modern devices."
7840 #: ../src/guestfs-actions.pod:731
7842 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7848 #: ../src/guestfs-actions.pod:740
7849 msgid "guestfs_blockdev_getsz"
7854 #: ../src/guestfs-actions.pod:742
7858 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7859 " const char *device);\n"
7865 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7867 "This returns the size of the device in units of 512-byte sectors (even if "
7868 "the sectorsize isn't 512 bytes ... weird)."
7873 #: ../src/guestfs-actions.pod:749
7875 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7876 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7881 #: ../src/guestfs-actions.pod:759
7882 msgid "guestfs_blockdev_rereadpt"
7887 #: ../src/guestfs-actions.pod:761
7891 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7892 " const char *device);\n"
7898 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7899 msgid "Reread the partition table on C<device>."
7904 #: ../src/guestfs-actions.pod:773
7905 msgid "guestfs_blockdev_setbsz"
7910 #: ../src/guestfs-actions.pod:775
7914 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7915 " const char *device,\n"
7916 " int blocksize);\n"
7922 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7923 msgid "This sets the block size of a device."
7928 #: ../src/guestfs-actions.pod:791
7929 msgid "guestfs_blockdev_setro"
7934 #: ../src/guestfs-actions.pod:793
7938 " guestfs_blockdev_setro (guestfs_h *g,\n"
7939 " const char *device);\n"
7945 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7946 msgid "Sets the block device named C<device> to read-only."
7951 #: ../src/guestfs-actions.pod:805
7952 msgid "guestfs_blockdev_setrw"
7957 #: ../src/guestfs-actions.pod:807
7961 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7962 " const char *device);\n"
7968 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7969 msgid "Sets the block device named C<device> to read-write."
7974 #: ../src/guestfs-actions.pod:819
7975 msgid "guestfs_case_sensitive_path"
7980 #: ../src/guestfs-actions.pod:821
7984 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7985 " const char *path);\n"
7991 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7993 "This can be used to resolve case insensitive paths on a filesystem which is "
7994 "case sensitive. The use case is to resolve paths which you have read from "
7995 "Windows configuration files or the Windows Registry, to the true path."
8000 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
8002 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8003 "(and probably others), which is that although the underlying filesystem is "
8004 "case-insensitive, the driver exports the filesystem to Linux as case-"
8010 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8012 "One consequence of this is that special directories such as C<c:\\windows> "
8013 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8014 "precise details of how they were created. In Windows itself this would not "
8020 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8022 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8028 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8030 "This function resolves the true case of each element in the path and returns "
8031 "the case-sensitive path."
8036 #: ../src/guestfs-actions.pod:847
8038 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8039 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8040 "how the directories were originally created under Windows)."
8045 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8046 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8051 #: ../src/guestfs-actions.pod:855
8052 msgid "See also C<guestfs_realpath>."
8057 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6962
8058 msgid "(Added in 1.0.75)"
8063 #: ../src/guestfs-actions.pod:862
8069 #: ../src/guestfs-actions.pod:864
8073 " guestfs_cat (guestfs_h *g,\n"
8074 " const char *path);\n"
8080 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5458
8081 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3659
8082 msgid "Return the contents of the file named C<path>."
8087 #: ../src/guestfs-actions.pod:870
8089 "Note that this function cannot correctly handle binary files (specifically, "
8090 "files containing C<\\0> character which is treated as end of string). For "
8091 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8092 "functions which have a more complex interface."
8097 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8098 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
8099 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
8100 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
8101 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
8102 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
8103 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
8104 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5266
8105 #: ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423
8106 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6347
8107 #: ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6548
8108 #: ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7234
8109 #: ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7286
8110 #: ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7390
8111 #: ../src/guestfs-actions.pod:7409 ../src/guestfs-actions.pod:7455
8112 #: ../src/guestfs-actions.pod:7474 ../fish/guestfish-actions.pod:587
8113 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8114 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8115 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8116 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8117 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8118 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8119 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3529
8120 #: ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3620
8121 #: ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652
8122 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4324
8123 #: ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4424
8124 #: ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4852
8125 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
8126 #: ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4937
8127 #: ../fish/guestfish-actions.pod:4966 ../fish/guestfish-actions.pod:4976
8129 "Because of the message protocol, there is a transfer limit of somewhere "
8130 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8135 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3556
8136 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3635
8137 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4128
8138 #: ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:5346
8139 #: ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:7121
8140 #: ../src/guestfs-actions.pod:7135
8141 msgid "(Added in 0.4)"
8146 #: ../src/guestfs-actions.pod:883
8147 msgid "guestfs_checksum"
8152 #: ../src/guestfs-actions.pod:885
8156 " guestfs_checksum (guestfs_h *g,\n"
8157 " const char *csumtype,\n"
8158 " const char *path);\n"
8164 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8166 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8171 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8173 "The type of checksum to compute is given by the C<csumtype> parameter which "
8174 "must have one of the following values:"
8179 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8185 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8187 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8193 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8199 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8200 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8205 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8211 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8212 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8217 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8223 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8224 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8229 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8235 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8236 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8241 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8247 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8248 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8253 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8259 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8260 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8265 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8266 msgid "The checksum is returned as a printable string."
8271 #: ../src/guestfs-actions.pod:931
8272 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8277 #: ../src/guestfs-actions.pod:933
8278 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8283 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8284 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3295
8285 #: ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3385
8286 #: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:6818
8287 msgid "(Added in 1.0.2)"
8292 #: ../src/guestfs-actions.pod:940
8293 msgid "guestfs_checksum_device"
8298 #: ../src/guestfs-actions.pod:942
8302 " guestfs_checksum_device (guestfs_h *g,\n"
8303 " const char *csumtype,\n"
8304 " const char *device);\n"
8310 #: ../src/guestfs-actions.pod:947
8312 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8313 "device named C<device>. For the types of checksums supported see the "
8314 "C<guestfs_checksum> command."
8319 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4877
8320 #: ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4973
8321 #: ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5167
8322 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741
8323 #: ../src/guestfs-actions.pod:7147
8324 msgid "(Added in 1.3.2)"
8329 #: ../src/guestfs-actions.pod:956
8330 msgid "guestfs_checksums_out"
8335 #: ../src/guestfs-actions.pod:958
8339 " guestfs_checksums_out (guestfs_h *g,\n"
8340 " const char *csumtype,\n"
8341 " const char *directory,\n"
8342 " const char *sumsfile);\n"
8348 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8350 "This command computes the checksums of all regular files in C<directory> and "
8351 "then emits a list of those checksums to the local output file C<sumsfile>."
8356 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8358 "This can be used for verifying the integrity of a virtual machine. However "
8359 "to be properly secure you should pay attention to the output of the checksum "
8360 "command (it uses the ones from GNU coreutils). In particular when the "
8361 "filename is not printable, coreutils uses a special backslash syntax. For "
8362 "more information, see the GNU coreutils info file."
8367 #: ../src/guestfs-actions.pod:978
8368 msgid "(Added in 1.3.7)"
8373 #: ../src/guestfs-actions.pod:980
8374 msgid "guestfs_chmod"
8379 #: ../src/guestfs-actions.pod:982
8383 " guestfs_chmod (guestfs_h *g,\n"
8385 " const char *path);\n"
8391 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8393 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8399 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8401 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8402 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8408 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4379
8409 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4595
8410 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:676
8411 #: ../fish/guestfish-actions.pod:2975 ../fish/guestfish-actions.pod:3104
8412 #: ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124
8413 msgid "The mode actually set is affected by the umask."
8418 #: ../src/guestfs-actions.pod:1000
8419 msgid "guestfs_chown"
8424 #: ../src/guestfs-actions.pod:1002
8428 " guestfs_chown (guestfs_h *g,\n"
8431 " const char *path);\n"
8437 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8438 msgid "Change the file owner to C<owner> and group to C<group>."
8443 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3487
8444 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2433
8446 "Only numeric uid and gid are supported. If you want to use names, you will "
8447 "need to locate and parse the password file yourself (Augeas support makes "
8448 "this relatively easy)."
8453 #: ../src/guestfs-actions.pod:1018
8454 msgid "guestfs_command"
8459 #: ../src/guestfs-actions.pod:1020
8463 " guestfs_command (guestfs_h *g,\n"
8464 " char *const *arguments);\n"
8470 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8472 "This call runs a command from the guest filesystem. The filesystem must be "
8473 "mounted, and must contain a compatible operating system (ie. something "
8474 "Linux, with the same or compatible processor architecture)."
8479 #: ../src/guestfs-actions.pod:1029
8481 "The single parameter is an argv-style list of arguments. The first element "
8482 "is the name of the program to run. Subsequent elements are parameters. The "
8483 "list must be non-empty (ie. must contain a program name). Note that the "
8484 "command runs directly, and is I<not> invoked via the shell (see "
8490 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8491 msgid "The return value is anything printed to I<stdout> by the command."
8496 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8498 "If the command returns a non-zero exit status, then this function returns an "
8499 "error message. The error message string is the content of I<stderr> from "
8505 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8507 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8508 "bin>. If you require a program from another location, you should provide "
8509 "the full path in the first parameter."
8514 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8516 "Shared libraries and data files required by the program must be available on "
8517 "filesystems which are mounted in the correct places. It is the caller's "
8518 "responsibility to ensure all filesystems that are needed are mounted at the "
8524 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8525 #: ../src/guestfs-actions.pod:1548
8526 msgid "(Added in 0.9.1)"
8531 #: ../src/guestfs-actions.pod:1062
8532 msgid "guestfs_command_lines"
8537 #: ../src/guestfs-actions.pod:1064
8541 " guestfs_command_lines (guestfs_h *g,\n"
8542 " char *const *arguments);\n"
8548 #: ../src/guestfs-actions.pod:1068
8550 "This is the same as C<guestfs_command>, but splits the result into a list of "
8556 #: ../src/guestfs-actions.pod:1071
8557 msgid "See also: C<guestfs_sh_lines>"
8562 #: ../src/guestfs-actions.pod:1082
8563 msgid "guestfs_config"
8568 #: ../src/guestfs-actions.pod:1084
8572 " guestfs_config (guestfs_h *g,\n"
8573 " const char *qemuparam,\n"
8574 " const char *qemuvalue);\n"
8580 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8582 "This can be used to add arbitrary qemu command line parameters of the form "
8583 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8584 "setting some parameters which would interfere with parameters that we use."
8589 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8590 msgid "The first character of C<param> string must be a C<-> (dash)."
8595 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8596 msgid "C<value> can be NULL."
8601 #: ../src/guestfs-actions.pod:1102
8602 msgid "guestfs_copy_size"
8607 #: ../src/guestfs-actions.pod:1104
8611 " guestfs_copy_size (guestfs_h *g,\n"
8612 " const char *src,\n"
8613 " const char *dest,\n"
8620 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8622 "This command copies exactly C<size> bytes from one source device or file "
8623 "C<src> to another destination device or file C<dest>."
8628 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8630 "Note this will fail if the source is too short or if the destination is not "
8635 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8636 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8637 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
8638 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:6813
8639 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:7326
8640 #: ../src/guestfs-actions.pod:7345
8642 "This long-running command can generate progress notification messages so "
8643 "that the caller can display a progress bar or indicator. To receive these "
8644 "messages, the caller must register a progress event callback. See L<guestfs"
8645 "(3)/GUESTFS_EVENT_PROGRESS>."
8650 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4155
8651 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:7054
8652 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7160
8653 msgid "(Added in 1.0.87)"
8658 #: ../src/guestfs-actions.pod:1125
8664 #: ../src/guestfs-actions.pod:1127
8668 " guestfs_cp (guestfs_h *g,\n"
8669 " const char *src,\n"
8670 " const char *dest);\n"
8676 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8678 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8679 "destination filename or destination directory."
8684 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8685 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8686 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4840
8687 #: ../src/guestfs-actions.pod:5217
8688 msgid "(Added in 1.0.18)"
8693 #: ../src/guestfs-actions.pod:1139
8694 msgid "guestfs_cp_a"
8699 #: ../src/guestfs-actions.pod:1141
8703 " guestfs_cp_a (guestfs_h *g,\n"
8704 " const char *src,\n"
8705 " const char *dest);\n"
8711 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8713 "This copies a file or directory from C<src> to C<dest> recursively using the "
8719 #: ../src/guestfs-actions.pod:1153
8725 #: ../src/guestfs-actions.pod:1155
8729 " guestfs_dd (guestfs_h *g,\n"
8730 " const char *src,\n"
8731 " const char *dest);\n"
8737 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8739 "This command copies from one source device or file C<src> to another "
8740 "destination device or file C<dest>. Normally you would use this to copy to "
8741 "or from a device or partition, for example to duplicate a filesystem."
8746 #: ../src/guestfs-actions.pod:1165
8748 "If the destination is a device, it must be as large or larger than the "
8749 "source file or device, otherwise the copy will fail. This command cannot do "
8750 "partial copies (see C<guestfs_copy_size>)."
8755 #: ../src/guestfs-actions.pod:1173
8761 #: ../src/guestfs-actions.pod:1175
8765 " guestfs_df (guestfs_h *g);\n"
8771 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8772 msgid "This command runs the C<df> command to report disk space used."
8777 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8779 "This command is mostly useful for interactive sessions. It is I<not> "
8780 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8786 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8787 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8788 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8789 #: ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4740
8790 #: ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6575
8791 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7206
8792 #: ../src/guestfs-actions.pod:7219
8793 msgid "(Added in 1.0.54)"
8798 #: ../src/guestfs-actions.pod:1189
8799 msgid "guestfs_df_h"
8804 #: ../src/guestfs-actions.pod:1191
8808 " guestfs_df_h (guestfs_h *g);\n"
8814 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8816 "This command runs the C<df -h> command to report disk space used in human-"
8822 #: ../src/guestfs-actions.pod:1206
8823 msgid "guestfs_dmesg"
8828 #: ../src/guestfs-actions.pod:1208
8832 " guestfs_dmesg (guestfs_h *g);\n"
8838 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8840 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8841 "This is sometimes useful for extended debugging of problems."
8846 #: ../src/guestfs-actions.pod:1215
8848 "Another way to get the same information is to enable verbose messages with "
8849 "C<guestfs_set_verbose> or by setting the environment variable "
8850 "C<LIBGUESTFS_DEBUG=1> before running the program."
8855 #: ../src/guestfs-actions.pod:1225
8856 msgid "guestfs_download"
8861 #: ../src/guestfs-actions.pod:1227
8865 " guestfs_download (guestfs_h *g,\n"
8866 " const char *remotefilename,\n"
8867 " const char *filename);\n"
8873 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8874 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8876 "Download file C<remotefilename> and save it as C<filename> on the local "
8882 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6807
8883 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4582
8884 msgid "C<filename> can also be a named pipe."
8889 #: ../src/guestfs-actions.pod:1237
8890 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8895 #: ../src/guestfs-actions.pod:1248
8896 msgid "guestfs_download_offset"
8901 #: ../src/guestfs-actions.pod:1250
8905 " guestfs_download_offset (guestfs_h *g,\n"
8906 " const char *remotefilename,\n"
8907 " const char *filename,\n"
8908 " int64_t offset,\n"
8915 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8917 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8918 "region must be within the file or device)."
8923 #: ../src/guestfs-actions.pod:1263
8925 "Note that there is no limit on the amount of data that can be downloaded "
8926 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8927 "full amount unless an error occurs."
8932 #: ../src/guestfs-actions.pod:1268
8933 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8938 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6852
8939 msgid "(Added in 1.5.17)"
8944 #: ../src/guestfs-actions.pod:1279
8945 msgid "guestfs_drop_caches"
8950 #: ../src/guestfs-actions.pod:1281
8954 " guestfs_drop_caches (guestfs_h *g,\n"
8955 " int whattodrop);\n"
8961 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8963 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8964 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8965 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8970 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8971 msgid "Setting C<whattodrop> to 3 should drop everything."
8976 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8978 "This automatically calls L<sync(2)> before the operation, so that the "
8979 "maximum guest memory is freed."
8984 #: ../src/guestfs-actions.pod:1299
8990 #: ../src/guestfs-actions.pod:1301
8994 " guestfs_du (guestfs_h *g,\n"
8995 " const char *path);\n"
9001 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
9003 "This command runs the C<du -s> command to estimate file space usage for "
9009 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
9011 "C<path> can be a file or a directory. If C<path> is a directory then the "
9012 "estimate includes the contents of the directory and all subdirectories "
9018 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9020 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9025 #: ../src/guestfs-actions.pod:1324
9026 msgid "guestfs_e2fsck_f"
9031 #: ../src/guestfs-actions.pod:1326
9035 " guestfs_e2fsck_f (guestfs_h *g,\n"
9036 " const char *device);\n"
9042 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
9044 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9045 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
9051 #: ../src/guestfs-actions.pod:1334
9053 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9054 "Normally you should use C<guestfs_fsck>."
9059 #: ../src/guestfs-actions.pod:1339
9060 msgid "(Added in 1.0.29)"
9065 #: ../src/guestfs-actions.pod:1341
9066 msgid "guestfs_echo_daemon"
9071 #: ../src/guestfs-actions.pod:1343
9075 " guestfs_echo_daemon (guestfs_h *g,\n"
9076 " char *const *words);\n"
9082 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
9084 "This command concatenates the list of C<words> passed with single spaces "
9085 "between them and returns the resulting string."
9090 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
9091 msgid "You can use this command to test the connection through to the daemon."
9096 #: ../src/guestfs-actions.pod:1352
9097 msgid "See also C<guestfs_ping_daemon>."
9102 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
9103 #: ../src/guestfs-actions.pod:6051
9104 msgid "(Added in 1.0.69)"
9109 #: ../src/guestfs-actions.pod:1359
9110 msgid "guestfs_egrep"
9115 #: ../src/guestfs-actions.pod:1361
9119 " guestfs_egrep (guestfs_h *g,\n"
9120 " const char *regex,\n"
9121 " const char *path);\n"
9127 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
9129 "This calls the external C<egrep> program and returns the matching lines."
9134 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
9135 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
9136 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
9137 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
9138 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
9139 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
9140 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3648
9141 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675
9142 #: ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:4675
9143 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5600
9144 #: ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6431
9145 #: ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6457
9146 #: ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492
9147 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518
9148 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7308
9149 #: ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7412
9150 #: ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7477
9151 msgid "(Added in 1.0.66)"
9156 #: ../src/guestfs-actions.pod:1378
9157 msgid "guestfs_egrepi"
9162 #: ../src/guestfs-actions.pod:1380
9166 " guestfs_egrepi (guestfs_h *g,\n"
9167 " const char *regex,\n"
9168 " const char *path);\n"
9174 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
9176 "This calls the external C<egrep -i> program and returns the matching lines."
9181 #: ../src/guestfs-actions.pod:1397
9182 msgid "guestfs_equal"
9187 #: ../src/guestfs-actions.pod:1399
9191 " guestfs_equal (guestfs_h *g,\n"
9192 " const char *file1,\n"
9193 " const char *file2);\n"
9199 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
9201 "This compares the two files C<file1> and C<file2> and returns true if their "
9202 "content is exactly equal, or false otherwise."
9207 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
9208 msgid "The external L<cmp(1)> program is used for the comparison."
9213 #: ../src/guestfs-actions.pod:1413
9214 msgid "guestfs_exists"
9219 #: ../src/guestfs-actions.pod:1415
9223 " guestfs_exists (guestfs_h *g,\n"
9224 " const char *path);\n"
9230 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
9232 "This returns C<true> if and only if there is a file, directory (or anything) "
9233 "with the given C<path> name."
9238 #: ../src/guestfs-actions.pod:1422
9239 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9244 #: ../src/guestfs-actions.pod:1428
9245 msgid "guestfs_fallocate"
9250 #: ../src/guestfs-actions.pod:1430
9254 " guestfs_fallocate (guestfs_h *g,\n"
9255 " const char *path,\n"
9262 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
9263 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9265 "This command preallocates a file (containing zero bytes) named C<path> of "
9266 "size C<len> bytes. If the file exists already, it is overwritten."
9271 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
9273 "Do not confuse this with the guestfish-specific C<alloc> command which "
9274 "allocates a file in the host and attaches it as a device."
9279 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
9281 "This function is deprecated. In new code, use the C<fallocate64> call "
9287 #: ../src/guestfs-actions.pod:1454
9288 msgid "guestfs_fallocate64"
9293 #: ../src/guestfs-actions.pod:1456
9297 " guestfs_fallocate64 (guestfs_h *g,\n"
9298 " const char *path,\n"
9305 #: ../src/guestfs-actions.pod:1465
9307 "Note that this call allocates disk blocks for the file. To create a sparse "
9308 "file use C<guestfs_truncate_size> instead."
9313 #: ../src/guestfs-actions.pod:1468
9315 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9316 "oversight it only allowed 30 bit lengths to be specified, effectively "
9317 "limiting the maximum size of files created through that call to 1GB."
9322 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
9324 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9325 "commands which create a file in the host and attach it as a device."
9330 #: ../src/guestfs-actions.pod:1479
9331 msgid "(Added in 1.3.17)"
9336 #: ../src/guestfs-actions.pod:1481
9337 msgid "guestfs_fgrep"
9342 #: ../src/guestfs-actions.pod:1483
9346 " guestfs_fgrep (guestfs_h *g,\n"
9347 " const char *pattern,\n"
9348 " const char *path);\n"
9354 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
9356 "This calls the external C<fgrep> program and returns the matching lines."
9361 #: ../src/guestfs-actions.pod:1500
9362 msgid "guestfs_fgrepi"
9367 #: ../src/guestfs-actions.pod:1502
9371 " guestfs_fgrepi (guestfs_h *g,\n"
9372 " const char *pattern,\n"
9373 " const char *path);\n"
9379 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
9381 "This calls the external C<fgrep -i> program and returns the matching lines."
9386 #: ../src/guestfs-actions.pod:1519
9387 msgid "guestfs_file"
9392 #: ../src/guestfs-actions.pod:1521
9396 " guestfs_file (guestfs_h *g,\n"
9397 " const char *path);\n"
9403 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
9405 "This call uses the standard L<file(1)> command to determine the type or "
9406 "contents of the file."
9411 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
9413 "This call will also transparently look inside various types of compressed "
9419 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
9421 "The exact command which runs is C<file -zb path>. Note in particular that "
9422 "the filename is not prepended to the output (the C<-b> option)."
9427 #: ../src/guestfs-actions.pod:1535
9429 "This command can also be used on C</dev/> devices (and partitions, LV "
9430 "names). You can for example use this to determine if a device contains a "
9431 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9436 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
9438 "If the C<path> does not begin with C</dev/> then this command only works for "
9439 "the content of regular files. For other file types (directory, symbolic "
9440 "link etc) it will just return the string C<directory> etc."
9445 #: ../src/guestfs-actions.pod:1550
9446 msgid "guestfs_file_architecture"
9451 #: ../src/guestfs-actions.pod:1552
9455 " guestfs_file_architecture (guestfs_h *g,\n"
9456 " const char *filename);\n"
9462 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
9464 "This detects the architecture of the binary C<filename>, and returns it if "
9470 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
9471 msgid "Currently defined architectures are:"
9476 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
9482 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9484 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9485 "irrespective of the precise processor requirements of the binary."
9490 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
9496 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
9497 msgid "64 bit x86-64."
9502 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
9508 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
9509 msgid "32 bit SPARC."
9514 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
9520 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
9521 msgid "64 bit SPARC V9 and above."
9526 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
9532 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
9533 msgid "Intel Itanium."
9538 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
9544 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
9545 msgid "32 bit Power PC."
9550 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
9556 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
9557 msgid "64 bit Power PC."
9562 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
9563 msgid "Libguestfs may return other architecture strings in future."
9568 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
9569 msgid "The function works on at least the following types of files:"
9574 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
9575 msgid "many types of Un*x and Linux binary"
9580 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
9581 msgid "many types of Un*x and Linux shared library"
9586 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
9587 msgid "Windows Win32 and Win64 binaries"
9592 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
9593 msgid "Windows Win32 and Win64 DLLs"
9598 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
9599 msgid "Win32 binaries and DLLs return C<i386>."
9604 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
9605 msgid "Win64 binaries and DLLs return C<x86_64>."
9610 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
9611 msgid "Linux kernel modules"
9616 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
9617 msgid "Linux new-style initrd images"
9622 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
9623 msgid "some non-x86 Linux vmlinuz kernels"
9628 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
9629 msgid "What it can't do currently:"
9634 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
9635 msgid "static libraries (libfoo.a)"
9640 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
9641 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9646 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
9647 msgid "x86 Linux vmlinuz kernels"
9652 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
9654 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9655 "compressed code, and are horribly hard to unpack. If you want to find the "
9656 "architecture of a kernel, use the architecture of the associated initrd or "
9657 "kernel module(s) instead."
9662 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
9663 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
9664 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686
9665 #: ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795
9666 #: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922
9667 #: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266
9668 #: ../src/guestfs-actions.pod:3398
9669 msgid "(Added in 1.5.3)"
9674 #: ../src/guestfs-actions.pod:1662
9675 msgid "guestfs_filesize"
9680 #: ../src/guestfs-actions.pod:1664
9684 " guestfs_filesize (guestfs_h *g,\n"
9685 " const char *file);\n"
9691 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
9692 msgid "This command returns the size of C<file> in bytes."
9697 #: ../src/guestfs-actions.pod:1670
9699 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9700 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9701 "devices, use C<guestfs_blockdev_getsize64>."
9706 #: ../src/guestfs-actions.pod:1676
9707 msgid "(Added in 1.0.82)"
9712 #: ../src/guestfs-actions.pod:1678
9713 msgid "guestfs_fill"
9718 #: ../src/guestfs-actions.pod:1680
9722 " guestfs_fill (guestfs_h *g,\n"
9725 " const char *path);\n"
9731 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
9733 "This command creates a new file called C<path>. The initial content of the "
9734 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9740 #: ../src/guestfs-actions.pod:1690
9742 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9743 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9744 "bytes use C<guestfs_fill_pattern>."
9749 #: ../src/guestfs-actions.pod:1702
9750 msgid "(Added in 1.0.79)"
9755 #: ../src/guestfs-actions.pod:1704
9756 msgid "guestfs_fill_pattern"
9761 #: ../src/guestfs-actions.pod:1706
9765 " guestfs_fill_pattern (guestfs_h *g,\n"
9766 " const char *pattern,\n"
9768 " const char *path);\n"
9774 #: ../src/guestfs-actions.pod:1712
9776 "This function is like C<guestfs_fill> except that it creates a new file of "
9777 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9778 "pattern is truncated if necessary to ensure the length of the file is "
9779 "exactly C<len> bytes."
9784 #: ../src/guestfs-actions.pod:1724
9785 msgid "(Added in 1.3.12)"
9790 #: ../src/guestfs-actions.pod:1726
9791 msgid "guestfs_find"
9796 #: ../src/guestfs-actions.pod:1728
9800 " guestfs_find (guestfs_h *g,\n"
9801 " const char *directory);\n"
9807 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
9809 "This command lists out all files and directories, recursively, starting at "
9810 "C<directory>. It is essentially equivalent to running the shell command "
9811 "C<find directory -print> but some post-processing happens on the output, "
9817 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9819 "This returns a list of strings I<without any prefix>. Thus if the directory "
9825 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
9836 #: ../src/guestfs-actions.pod:1744
9838 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9843 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
9855 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
9856 msgid "If C<directory> is not a directory, then this command returns an error."
9861 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
9862 msgid "The returned list is sorted."
9867 #: ../src/guestfs-actions.pod:1757
9868 msgid "See also C<guestfs_find0>."
9873 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092
9874 #: ../src/guestfs-actions.pod:5635
9875 msgid "(Added in 1.0.27)"
9880 #: ../src/guestfs-actions.pod:1768
9881 msgid "guestfs_find0"
9886 #: ../src/guestfs-actions.pod:1770
9890 " guestfs_find0 (guestfs_h *g,\n"
9891 " const char *directory,\n"
9892 " const char *files);\n"
9898 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
9900 "This command lists out all files and directories, recursively, starting at "
9901 "C<directory>, placing the resulting list in the external file called "
9907 #: ../src/guestfs-actions.pod:1779
9909 "This command works the same way as C<guestfs_find> with the following "
9915 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
9916 msgid "The resulting list is written to an external file."
9921 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9923 "Items (filenames) in the result are separated by C<\\0> characters. See "
9924 "L<find(1)> option I<-print0>."
9929 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9930 msgid "This command is not limited in the number of names that it can return."
9935 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9936 msgid "The result list is not sorted."
9941 #: ../src/guestfs-actions.pod:1806
9942 msgid "(Added in 1.0.74)"
9947 #: ../src/guestfs-actions.pod:1808
9948 msgid "guestfs_findfs_label"
9953 #: ../src/guestfs-actions.pod:1810
9957 " guestfs_findfs_label (guestfs_h *g,\n"
9958 " const char *label);\n"
9964 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9966 "This command searches the filesystems and returns the one which has the "
9967 "given label. An error is returned if no such filesystem can be found."
9972 #: ../src/guestfs-actions.pod:1818
9973 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9978 #: ../src/guestfs-actions.pod:1825
9979 msgid "guestfs_findfs_uuid"
9984 #: ../src/guestfs-actions.pod:1827
9988 " guestfs_findfs_uuid (guestfs_h *g,\n"
9989 " const char *uuid);\n"
9995 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9997 "This command searches the filesystems and returns the one which has the "
9998 "given UUID. An error is returned if no such filesystem can be found."
10003 #: ../src/guestfs-actions.pod:1835
10004 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10009 #: ../src/guestfs-actions.pod:1842
10010 msgid "guestfs_fsck"
10015 #: ../src/guestfs-actions.pod:1844
10019 " guestfs_fsck (guestfs_h *g,\n"
10020 " const char *fstype,\n"
10021 " const char *device);\n"
10027 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
10029 "This runs the filesystem checker (fsck) on C<device> which should have "
10030 "filesystem type C<fstype>."
10035 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
10037 "The returned integer is the status. See L<fsck(8)> for the list of status "
10038 "codes from C<fsck>."
10043 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
10044 msgid "Multiple status codes can be summed together."
10049 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
10051 "A non-zero return code can mean \"success\", for example if errors have been "
10052 "corrected on the filesystem."
10057 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
10058 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10063 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
10065 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10070 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331
10071 msgid "(Added in 1.0.16)"
10076 #: ../src/guestfs-actions.pod:1881
10077 msgid "guestfs_get_append"
10082 #: ../src/guestfs-actions.pod:1883
10086 " guestfs_get_append (guestfs_h *g);\n"
10092 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
10094 "Return the additional kernel options which are added to the guest kernel "
10100 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
10101 msgid "If C<NULL> then no options are added."
10106 #: ../src/guestfs-actions.pod:1891
10108 "This function returns a string which may be NULL. There is no way to return "
10109 "an error from this function. The string is owned by the guest handle and "
10110 "must I<not> be freed."
10115 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313
10116 #: ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193
10117 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228
10118 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002
10119 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374
10120 msgid "(Added in 1.0.26)"
10124 #: ../src/guestfs-actions.pod:1897
10125 msgid "guestfs_get_attach_method"
10129 #: ../src/guestfs-actions.pod:1899
10133 " guestfs_get_attach_method (guestfs_h *g);\n"
10138 #: ../src/guestfs-actions.pod:1902
10139 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10144 #: ../src/guestfs-actions.pod:1907
10145 msgid "guestfs_get_autosync"
10150 #: ../src/guestfs-actions.pod:1909
10154 " guestfs_get_autosync (guestfs_h *g);\n"
10160 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
10161 msgid "Get the autosync flag."
10166 #: ../src/guestfs-actions.pod:1918
10167 msgid "guestfs_get_direct"
10172 #: ../src/guestfs-actions.pod:1920
10176 " guestfs_get_direct (guestfs_h *g);\n"
10182 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
10183 msgid "Return the direct appliance mode flag."
10188 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862
10189 msgid "(Added in 1.0.72)"
10194 #: ../src/guestfs-actions.pod:1929
10195 msgid "guestfs_get_e2label"
10200 #: ../src/guestfs-actions.pod:1931
10204 " guestfs_get_e2label (guestfs_h *g,\n"
10205 " const char *device);\n"
10211 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
10213 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10218 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
10220 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10225 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
10226 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899
10227 msgid "(Added in 1.0.15)"
10232 #: ../src/guestfs-actions.pod:1950
10233 msgid "guestfs_get_e2uuid"
10238 #: ../src/guestfs-actions.pod:1952
10242 " guestfs_get_e2uuid (guestfs_h *g,\n"
10243 " const char *device);\n"
10249 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
10251 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10256 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
10258 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10263 #: ../src/guestfs-actions.pod:1971
10264 msgid "guestfs_get_memsize"
10269 #: ../src/guestfs-actions.pod:1973
10273 " guestfs_get_memsize (guestfs_h *g);\n"
10279 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
10281 "This gets the memory size in megabytes allocated to the qemu subprocess."
10286 #: ../src/guestfs-actions.pod:1979
10288 "If C<guestfs_set_memsize> was not called on this handle, and if "
10289 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10290 "value for memsize."
10295 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
10296 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022
10297 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10298 #: ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072
10300 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10305 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383
10306 #: ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599
10307 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630
10308 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660
10309 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920
10310 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768
10311 msgid "(Added in 1.0.55)"
10316 #: ../src/guestfs-actions.pod:1990
10317 msgid "guestfs_get_network"
10322 #: ../src/guestfs-actions.pod:1992
10326 " guestfs_get_network (guestfs_h *g);\n"
10332 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
10333 msgid "This returns the enable network flag."
10338 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939
10339 msgid "(Added in 1.5.4)"
10344 #: ../src/guestfs-actions.pod:2001
10345 msgid "guestfs_get_path"
10350 #: ../src/guestfs-actions.pod:2003
10354 " guestfs_get_path (guestfs_h *g);\n"
10360 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
10361 msgid "Return the current search path."
10366 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
10368 "This is always non-NULL. If it wasn't set already, then this will return "
10369 "the default path."
10374 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
10376 "This function returns a string, or NULL on error. The string is owned by "
10377 "the guest handle and must I<not> be freed."
10382 #: ../src/guestfs-actions.pod:2016
10383 msgid "guestfs_get_pid"
10388 #: ../src/guestfs-actions.pod:2018
10392 " guestfs_get_pid (guestfs_h *g);\n"
10398 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
10400 "Return the process ID of the qemu subprocess. If there is no qemu "
10401 "subprocess, then this will return an error."
10406 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
10407 msgid "This is an internal call used for debugging and testing."
10412 #: ../src/guestfs-actions.pod:2028
10413 msgid "(Added in 1.0.56)"
10418 #: ../src/guestfs-actions.pod:2030
10419 msgid "guestfs_get_qemu"
10424 #: ../src/guestfs-actions.pod:2032
10428 " guestfs_get_qemu (guestfs_h *g);\n"
10434 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
10435 msgid "Return the current qemu binary."
10440 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
10442 "This is always non-NULL. If it wasn't set already, then this will return "
10443 "the default qemu binary name."
10448 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984
10449 msgid "(Added in 1.0.6)"
10454 #: ../src/guestfs-actions.pod:2045
10455 msgid "guestfs_get_recovery_proc"
10460 #: ../src/guestfs-actions.pod:2047
10464 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10470 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
10471 msgid "Return the recovery process enabled flag."
10476 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493
10477 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190
10478 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243
10479 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008
10480 #: ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691
10481 #: ../src/guestfs-actions.pod:6883
10482 msgid "(Added in 1.0.77)"
10487 #: ../src/guestfs-actions.pod:2056
10488 msgid "guestfs_get_selinux"
10493 #: ../src/guestfs-actions.pod:2058
10497 " guestfs_get_selinux (guestfs_h *g);\n"
10503 #: ../src/guestfs-actions.pod:2061
10505 "This returns the current setting of the selinux flag which is passed to the "
10506 "appliance at boot time. See C<guestfs_set_selinux>."
10511 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
10512 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085
10513 msgid "(Added in 1.0.67)"
10518 #: ../src/guestfs-actions.pod:2071
10519 msgid "guestfs_get_state"
10524 #: ../src/guestfs-actions.pod:2073
10528 " guestfs_get_state (guestfs_h *g);\n"
10534 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
10536 "This returns the current state as an opaque integer. This is only useful "
10537 "for printing debug and internal error messages."
10542 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291
10543 #: ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381
10544 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409
10545 #: ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333
10546 #: ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387
10547 msgid "For more information on states, see L<guestfs(3)>."
10552 #: ../src/guestfs-actions.pod:2085
10553 msgid "guestfs_get_trace"
10558 #: ../src/guestfs-actions.pod:2087
10562 " guestfs_get_trace (guestfs_h *g);\n"
10568 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
10569 msgid "Return the command trace flag."
10574 #: ../src/guestfs-actions.pod:2096
10575 msgid "guestfs_get_umask"
10580 #: ../src/guestfs-actions.pod:2098
10584 " guestfs_get_umask (guestfs_h *g);\n"
10590 #: ../src/guestfs-actions.pod:2101
10592 "Return the current umask. By default the umask is C<022> unless it has been "
10593 "set by calling C<guestfs_umask>."
10598 #: ../src/guestfs-actions.pod:2108
10599 msgid "guestfs_get_verbose"
10604 #: ../src/guestfs-actions.pod:2110
10608 " guestfs_get_verbose (guestfs_h *g);\n"
10614 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
10615 msgid "This returns the verbose messages flag."
10620 #: ../src/guestfs-actions.pod:2119
10621 msgid "guestfs_getcon"
10626 #: ../src/guestfs-actions.pod:2121
10630 " guestfs_getcon (guestfs_h *g);\n"
10636 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
10637 msgid "This gets the SELinux security context of the daemon."
10642 #: ../src/guestfs-actions.pod:2126
10644 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10649 #: ../src/guestfs-actions.pod:2134
10650 msgid "guestfs_getxattr"
10655 #: ../src/guestfs-actions.pod:2136
10659 " guestfs_getxattr (guestfs_h *g,\n"
10660 " const char *path,\n"
10661 " const char *name,\n"
10662 " size_t *size_r);\n"
10668 #: ../src/guestfs-actions.pod:2142
10670 "Get a single extended attribute from file C<path> named C<name>. This call "
10671 "follows symlinks. If you want to lookup an extended attribute for the "
10672 "symlink itself, use C<guestfs_lgetxattr>."
10677 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507
10679 "Normally it is better to get all extended attributes from a file in one go "
10680 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10681 "implementations are buggy and do not provide a way to list out attributes. "
10682 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10683 "extended attributes you want in advance and call this function."
10688 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514
10689 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452
10691 "Extended attribute values are blobs of binary data. If there is no extended "
10692 "attribute named C<name>, this returns an error."
10697 #: ../src/guestfs-actions.pod:2156
10698 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10703 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
10704 #: ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236
10705 #: ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443
10707 "This function returns a buffer, or NULL on error. The size of the returned "
10708 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10713 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523
10714 msgid "(Added in 1.7.24)"
10719 #: ../src/guestfs-actions.pod:2164
10720 msgid "guestfs_getxattrs"
10725 #: ../src/guestfs-actions.pod:2166
10728 " struct guestfs_xattr_list *\n"
10729 " guestfs_getxattrs (guestfs_h *g,\n"
10730 " const char *path);\n"
10736 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
10738 "This call lists the extended attributes of the file or directory C<path>."
10743 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
10745 "At the system call level, this is a combination of the L<listxattr(2)> and "
10746 "L<getxattr(2)> calls."
10751 #: ../src/guestfs-actions.pod:2176
10752 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10757 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535
10758 #: ../src/guestfs-actions.pod:4186
10760 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10761 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10766 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539
10767 #: ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740
10768 #: ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104
10769 #: ../src/guestfs-actions.pod:7439
10770 msgid "(Added in 1.0.59)"
10775 #: ../src/guestfs-actions.pod:2184
10776 msgid "guestfs_glob_expand"
10781 #: ../src/guestfs-actions.pod:2186
10785 " guestfs_glob_expand (guestfs_h *g,\n"
10786 " const char *pattern);\n"
10792 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
10794 "This command searches for all the pathnames matching C<pattern> according to "
10795 "the wildcard expansion rules used by the shell."
10800 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
10802 "If no paths match, then this returns an empty list (note: not an error)."
10807 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
10809 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10810 "GLOB_BRACE>. See that manual page for more details."
10815 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269
10816 #: ../src/guestfs-actions.pod:6286
10817 msgid "(Added in 1.0.50)"
10822 #: ../src/guestfs-actions.pod:2207
10823 msgid "guestfs_grep"
10828 #: ../src/guestfs-actions.pod:2209
10832 " guestfs_grep (guestfs_h *g,\n"
10833 " const char *regex,\n"
10834 " const char *path);\n"
10840 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
10841 msgid "This calls the external C<grep> program and returns the matching lines."
10846 #: ../src/guestfs-actions.pod:2226
10847 msgid "guestfs_grepi"
10852 #: ../src/guestfs-actions.pod:2228
10856 " guestfs_grepi (guestfs_h *g,\n"
10857 " const char *regex,\n"
10858 " const char *path);\n"
10864 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
10866 "This calls the external C<grep -i> program and returns the matching lines."
10871 #: ../src/guestfs-actions.pod:2245
10872 msgid "guestfs_grub_install"
10877 #: ../src/guestfs-actions.pod:2247
10881 " guestfs_grub_install (guestfs_h *g,\n"
10882 " const char *root,\n"
10883 " const char *device);\n"
10889 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
10891 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10892 "the root directory being C<root>."
10897 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
10899 "Note: If grub-install reports the error \"No suitable drive was found in the "
10900 "generated device map.\" it may be that you need to create a C</boot/grub/"
10901 "device.map> file first that contains the mapping between grub device names "
10902 "and Linux device names. It is usually sufficient to create a file "
10908 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
10911 " (hd0) /dev/vda\n"
10917 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
10918 msgid "replacing C</dev/vda> with the name of the installation device."
10923 #: ../src/guestfs-actions.pod:2268
10924 msgid "(Added in 1.0.17)"
10929 #: ../src/guestfs-actions.pod:2270
10930 msgid "guestfs_head"
10935 #: ../src/guestfs-actions.pod:2272
10939 " guestfs_head (guestfs_h *g,\n"
10940 " const char *path);\n"
10946 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
10948 "This command returns up to the first 10 lines of a file as a list of strings."
10953 #: ../src/guestfs-actions.pod:2288
10954 msgid "guestfs_head_n"
10959 #: ../src/guestfs-actions.pod:2290
10963 " guestfs_head_n (guestfs_h *g,\n"
10965 " const char *path);\n"
10971 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
10973 "If the parameter C<nrlines> is a positive number, this returns the first "
10974 "C<nrlines> lines of the file C<path>."
10979 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
10981 "If the parameter C<nrlines> is a negative number, this returns lines from "
10982 "the file C<path>, excluding the last C<nrlines> lines."
10987 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566
10988 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422
10989 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10994 #: ../src/guestfs-actions.pod:2312
10995 msgid "guestfs_hexdump"
11000 #: ../src/guestfs-actions.pod:2314
11004 " guestfs_hexdump (guestfs_h *g,\n"
11005 " const char *path);\n"
11011 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
11013 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11014 "readable, canonical hex dump of the file."
11019 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350
11020 #: ../src/guestfs-actions.pod:6405
11021 msgid "(Added in 1.0.22)"
11026 #: ../src/guestfs-actions.pod:2329
11027 msgid "guestfs_initrd_cat"
11032 #: ../src/guestfs-actions.pod:2331
11036 " guestfs_initrd_cat (guestfs_h *g,\n"
11037 " const char *initrdpath,\n"
11038 " const char *filename,\n"
11039 " size_t *size_r);\n"
11045 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
11047 "This command unpacks the file C<filename> from the initrd file called "
11048 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11054 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
11056 "For example, in guestfish you could use the following command to examine the "
11057 "boot script (usually called C</init>) contained in a Linux initrd or "
11063 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
11066 " initrd-cat /boot/initrd-<version>.img init\n"
11072 #: ../src/guestfs-actions.pod:2347
11073 msgid "See also C<guestfs_initrd_list>."
11078 #: ../src/guestfs-actions.pod:2358
11079 msgid "guestfs_initrd_list"
11084 #: ../src/guestfs-actions.pod:2360
11088 " guestfs_initrd_list (guestfs_h *g,\n"
11089 " const char *path);\n"
11095 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
11096 msgid "This command lists out files contained in an initrd."
11101 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
11103 "The files are listed without any initial C</> character. The files are "
11104 "listed in the order they appear (not necessarily alphabetical). Directory "
11105 "names are listed as separate items."
11110 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
11112 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11113 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11119 #: ../src/guestfs-actions.pod:2380
11120 msgid "guestfs_inotify_add_watch"
11125 #: ../src/guestfs-actions.pod:2382
11129 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11130 " const char *path,\n"
11137 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
11138 msgid "Watch C<path> for the events listed in C<mask>."
11143 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
11145 "Note that if C<path> is a directory then events within that directory are "
11146 "watched, but this does I<not> happen recursively (in subdirectories)."
11151 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
11153 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11154 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11159 #: ../src/guestfs-actions.pod:2401
11160 msgid "guestfs_inotify_close"
11165 #: ../src/guestfs-actions.pod:2403
11169 " guestfs_inotify_close (guestfs_h *g);\n"
11175 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
11177 "This closes the inotify handle which was previously opened by inotify_init. "
11178 "It removes all watches, throws away any pending events, and deallocates all "
11184 #: ../src/guestfs-actions.pod:2414
11185 msgid "guestfs_inotify_files"
11190 #: ../src/guestfs-actions.pod:2416
11194 " guestfs_inotify_files (guestfs_h *g);\n"
11200 #: ../src/guestfs-actions.pod:2419
11202 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11203 "returns a list of pathnames of objects that were touched. The returned "
11204 "pathnames are sorted and deduplicated."
11209 #: ../src/guestfs-actions.pod:2429
11210 msgid "guestfs_inotify_init"
11215 #: ../src/guestfs-actions.pod:2431
11219 " guestfs_inotify_init (guestfs_h *g,\n"
11220 " int maxevents);\n"
11226 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
11228 "This command creates a new inotify handle. The inotify subsystem can be "
11229 "used to notify events which happen to objects in the guest filesystem."
11234 #: ../src/guestfs-actions.pod:2439
11236 "C<maxevents> is the maximum number of events which will be queued up between "
11237 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11238 "passed as C<0>, then the kernel (or previously set) default is used. For "
11239 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11240 "throws away events, but records the fact that it threw them away by setting "
11241 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11242 "C<guestfs_inotify_read>)."
11247 #: ../src/guestfs-actions.pod:2449
11249 "Before any events are generated, you have to add some watches to the "
11250 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11251 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11256 #: ../src/guestfs-actions.pod:2455
11258 "Queued up events should be read periodically by calling "
11259 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11260 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11261 "often enough then you risk the internal queue overflowing."
11266 #: ../src/guestfs-actions.pod:2462
11268 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11269 "This also removes any watches automatically."
11274 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
11276 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11277 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11278 "that there is one global inotify handle per libguestfs instance."
11283 #: ../src/guestfs-actions.pod:2475
11284 msgid "guestfs_inotify_read"
11289 #: ../src/guestfs-actions.pod:2477
11292 " struct guestfs_inotify_event_list *\n"
11293 " guestfs_inotify_read (guestfs_h *g);\n"
11299 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
11301 "Return the complete queue of events that have happened since the previous "
11307 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
11308 msgid "If no events have happened, this returns an empty list."
11313 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
11315 "I<Note>: In order to make sure that all events have been read, you must call "
11316 "this function repeatedly until it returns an empty list. The reason is that "
11317 "the call will read events up to the maximum appliance-to-host message size "
11318 "and leave remaining events in the queue."
11323 #: ../src/guestfs-actions.pod:2491
11325 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11326 "there was an error. I<The caller must call "
11327 "C<guestfs_free_inotify_event_list> after use>."
11332 #: ../src/guestfs-actions.pod:2497
11333 msgid "guestfs_inotify_rm_watch"
11338 #: ../src/guestfs-actions.pod:2499
11342 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11349 #: ../src/guestfs-actions.pod:2503
11351 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11356 #: ../src/guestfs-actions.pod:2510
11357 msgid "guestfs_inspect_get_arch"
11362 #: ../src/guestfs-actions.pod:2512
11366 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11367 " const char *root);\n"
11373 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
11374 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668
11375 #: ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733
11376 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782
11377 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846
11378 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
11379 #: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985
11380 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048
11381 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088
11382 #: ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124
11384 "This function should only be called with a root device string as returned by "
11385 "C<guestfs_inspect_os>."
11390 #: ../src/guestfs-actions.pod:2519
11392 "This returns the architecture of the inspected operating system. The "
11393 "possible return values are listed under C<guestfs_file_architecture>."
11398 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
11400 "If the architecture could not be determined, then the string C<unknown> is "
11406 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611
11407 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742
11408 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862
11409 #: ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917
11410 #: ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014
11411 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058
11412 #: ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095
11413 #: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217
11414 #: ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698
11415 #: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864
11416 #: ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900
11417 #: ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994
11418 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054
11419 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105
11420 #: ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134
11421 #: ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162
11422 #: ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295
11423 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11428 #: ../src/guestfs-actions.pod:2533
11429 msgid "guestfs_inspect_get_distro"
11434 #: ../src/guestfs-actions.pod:2535
11438 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11439 " const char *root);\n"
11445 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
11447 "This returns the distro (distribution) of the inspected operating system."
11452 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
11453 msgid "Currently defined distros are:"
11458 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
11459 msgid "\"archlinux\""
11464 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
11465 msgid "Arch Linux."
11470 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
11476 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
11482 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
11488 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
11494 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
11500 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
11506 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
11507 msgid "\"linuxmint\""
11512 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
11513 msgid "Linux Mint."
11518 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
11519 msgid "\"mandriva\""
11524 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
11530 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
11536 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
11542 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
11548 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
11554 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
11555 msgid "\"redhat-based\""
11560 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
11561 msgid "Some Red Hat-derived distro."
11566 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
11572 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
11573 msgid "Red Hat Enterprise Linux and some derivatives."
11577 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
11578 msgid "\"slackware\""
11582 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
11588 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
11594 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
11600 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713
11601 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762
11602 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080
11603 msgid "\"unknown\""
11608 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
11609 msgid "The distro could not be determined."
11614 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997
11615 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072
11616 msgid "\"windows\""
11621 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
11623 "Windows does not have distributions. This string is returned if the OS type "
11629 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719
11630 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773
11631 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086
11633 "Future versions of libguestfs may return other strings here. The caller "
11634 "should be prepared to handle any string."
11638 #: ../src/guestfs-actions.pod:2618
11639 msgid "guestfs_inspect_get_drive_mappings"
11643 #: ../src/guestfs-actions.pod:2620
11647 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11648 " const char *root);\n"
11653 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
11655 "This call is useful for Windows which uses a primitive system of assigning "
11656 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11657 "Windows Registry to find out how disks/partitions are mapped to drive "
11658 "letters, and returns a hash table as in the example below:"
11662 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791
11665 " C => /dev/vda2\n"
11666 " E => /dev/vdb1\n"
11667 " F => /dev/vdc1\n"
11672 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
11674 "Note that keys are drive letters. For Windows, the key is case insensitive "
11675 "and just contains the drive letter, without the customary colon separator "
11680 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
11682 "In future we may support other operating systems that also used drive "
11683 "letters, but the keys for those might not be case insensitive and might be "
11684 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11689 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
11691 "For Windows guests, currently only hard drive mappings are returned. "
11692 "Removable disks (eg. DVD-ROMs) are ignored."
11696 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
11698 "For guests that do not use drive mappings, or if the drive mappings could "
11699 "not be determined, this returns an empty hash table."
11703 #: ../src/guestfs-actions.pod:2652
11705 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11706 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11711 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832
11712 #: ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802
11713 #: ../src/guestfs-actions.pod:6707
11715 "This function returns a NULL-terminated array of strings, or NULL if there "
11716 "was an error. The array of strings will always have length C<2n+1>, where "
11717 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11718 "caller must free the strings and the array after use>."
11723 #: ../src/guestfs-actions.pod:2662
11724 msgid "guestfs_inspect_get_filesystems"
11729 #: ../src/guestfs-actions.pod:2664
11733 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11734 " const char *root);\n"
11740 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
11742 "This returns a list of all the filesystems that we think are associated with "
11743 "this operating system. This includes the root filesystem, other ordinary "
11744 "filesystems, and non-mounted devices like swap partitions."
11749 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
11751 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11752 "to be shared between operating systems."
11757 #: ../src/guestfs-actions.pod:2679
11759 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11760 "C<guestfs_inspect_get_mountpoints>."
11764 #: ../src/guestfs-actions.pod:2688
11765 msgid "guestfs_inspect_get_format"
11769 #: ../src/guestfs-actions.pod:2690
11773 " guestfs_inspect_get_format (guestfs_h *g,\n"
11774 " const char *root);\n"
11779 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839
11781 "This returns the format of the inspected operating system. You can use it "
11782 "to detect install images, live CDs and similar."
11786 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842
11787 msgid "Currently defined formats are:"
11791 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846
11792 msgid "\"installed\""
11796 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848
11797 msgid "This is an installed operating system."
11801 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
11802 msgid "\"installer\""
11806 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
11808 "The disk image being inspected is not an installed operating system, but a "
11809 "I<bootable> install disk, live CD, or similar."
11813 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
11814 msgid "The format of this disk image is not known."
11819 #: ../src/guestfs-actions.pod:2727
11820 msgid "guestfs_inspect_get_hostname"
11825 #: ../src/guestfs-actions.pod:2729
11829 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11830 " const char *root);\n"
11836 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
11838 "This function returns the hostname of the operating system as found by "
11839 "inspection of the guest's configuration files."
11844 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876
11846 "If the hostname could not be determined, then the string C<unknown> is "
11852 #: ../src/guestfs-actions.pod:2747
11853 msgid "(Added in 1.7.9)"
11858 #: ../src/guestfs-actions.pod:2749
11859 msgid "guestfs_inspect_get_major_version"
11864 #: ../src/guestfs-actions.pod:2751
11868 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11869 " const char *root);\n"
11875 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888
11877 "This returns the major version number of the inspected operating system."
11882 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891
11884 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11885 "popular public names used by the operating system. Notably the operating "
11886 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11887 "1). You can find out the real versions corresponding to releases of Windows "
11888 "by consulting Wikipedia or MSDN."
11893 #: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788
11894 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912
11895 msgid "If the version could not be determined, then C<0> is returned."
11900 #: ../src/guestfs-actions.pod:2776
11901 msgid "guestfs_inspect_get_minor_version"
11906 #: ../src/guestfs-actions.pod:2778
11910 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11911 " const char *root);\n"
11917 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909
11919 "This returns the minor version number of the inspected operating system."
11924 #: ../src/guestfs-actions.pod:2790
11926 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11927 "C<guestfs_inspect_get_major_version>."
11932 #: ../src/guestfs-actions.pod:2797
11933 msgid "guestfs_inspect_get_mountpoints"
11938 #: ../src/guestfs-actions.pod:2799
11942 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11943 " const char *root);\n"
11948 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924
11950 "This returns a hash of where we think the filesystems associated with this "
11951 "operating system should be mounted. Callers should note that this is at "
11952 "best an educated guess made by reading configuration files such as C</etc/"
11953 "fstab>. I<In particular note> that this may return filesystems which are "
11954 "non-existent or not mountable and callers should be prepared to handle or "
11955 "ignore failures if they try to mount them."
11960 #: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933
11962 "Each element in the returned hashtable has a key which is the path of the "
11963 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11964 "mounted there (eg. C</dev/sda1>)."
11969 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
11971 "Non-mounted devices such as swap devices are I<not> returned in this list."
11975 #: ../src/guestfs-actions.pod:2823
11977 "For operating systems like Windows which still use drive letters, this call "
11978 "will only return an entry for the first drive \"mounted on\" C</>. For "
11979 "information about the mapping of drive letters to partitions, see "
11980 "C<guestfs_inspect_get_drive_mappings>."
11985 #: ../src/guestfs-actions.pod:2829
11987 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11988 "C<guestfs_inspect_get_filesystems>."
11993 #: ../src/guestfs-actions.pod:2840
11994 msgid "guestfs_inspect_get_package_format"
11999 #: ../src/guestfs-actions.pod:2842
12003 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12004 " const char *root);\n"
12010 #: ../src/guestfs-actions.pod:2849
12012 "This function and C<guestfs_inspect_get_package_management> return the "
12013 "package format and package management tool used by the inspected operating "
12014 "system. For example for Fedora these functions would return C<rpm> (package "
12015 "format) and C<yum> (package management)."
12020 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963
12022 "This returns the string C<unknown> if we could not determine the package "
12023 "format I<or> if the operating system does not have a real packaging system "
12029 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967
12031 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12032 "Future versions of libguestfs may return other strings."
12037 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898
12038 msgid "(Added in 1.7.5)"
12043 #: ../src/guestfs-actions.pod:2869
12044 msgid "guestfs_inspect_get_package_management"
12049 #: ../src/guestfs-actions.pod:2871
12053 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12054 " const char *root);\n"
12060 #: ../src/guestfs-actions.pod:2878
12062 "C<guestfs_inspect_get_package_format> and this function return the package "
12063 "format and package management tool used by the inspected operating system. "
12064 "For example for Fedora these functions would return C<rpm> (package format) "
12065 "and C<yum> (package management)."
12070 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985
12072 "This returns the string C<unknown> if we could not determine the package "
12073 "management tool I<or> if the operating system does not have a real packaging "
12074 "system (eg. Windows)."
12079 #: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989
12081 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12082 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12083 "libguestfs may return other strings."
12088 #: ../src/guestfs-actions.pod:2900
12089 msgid "guestfs_inspect_get_product_name"
12094 #: ../src/guestfs-actions.pod:2902
12098 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12099 " const char *root);\n"
12105 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003
12107 "This returns the product name of the inspected operating system. The "
12108 "product name is generally some freeform string which can be displayed to the "
12109 "user, but should not be parsed by programs."
12114 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
12116 "If the product name could not be determined, then the string C<unknown> is "
12121 #: ../src/guestfs-actions.pod:2924
12122 msgid "guestfs_inspect_get_product_variant"
12126 #: ../src/guestfs-actions.pod:2926
12130 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12131 " const char *root);\n"
12136 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020
12137 msgid "This returns the product variant of the inspected operating system."
12141 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023
12143 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12144 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12145 "is usually a string such as C<Client> or C<Server> (other values are "
12146 "possible). This can be used to distinguish consumer and enterprise versions "
12147 "of Windows that have the same version number (for example, Windows 7 and "
12148 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12149 "the latter is C<Server>)."
12153 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032
12155 "For enterprise Linux guests, in future we intend this to return the product "
12156 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12157 "implemented at present."
12161 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036
12163 "If the product variant could not be determined, then the string C<unknown> "
12168 #: ../src/guestfs-actions.pod:2952
12170 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12171 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12176 #: ../src/guestfs-actions.pod:2959
12177 msgid "guestfs_inspect_get_roots"
12182 #: ../src/guestfs-actions.pod:2961
12186 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12192 #: ../src/guestfs-actions.pod:2964
12194 "This function is a convenient way to get the list of root devices, as "
12195 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12196 "the whole inspection process."
12201 #: ../src/guestfs-actions.pod:2968
12203 "This returns an empty list if either no root devices were found or the "
12204 "caller has not called C<guestfs_inspect_os>."
12209 #: ../src/guestfs-actions.pod:2977
12210 msgid "(Added in 1.7.3)"
12215 #: ../src/guestfs-actions.pod:2979
12216 msgid "guestfs_inspect_get_type"
12221 #: ../src/guestfs-actions.pod:2981
12225 " guestfs_inspect_get_type (guestfs_h *g,\n"
12226 " const char *root);\n"
12232 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063
12234 "This returns the type of the inspected operating system. Currently defined "
12240 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
12246 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070
12247 msgid "Any Linux-based operating system."
12252 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074
12253 msgid "Any Microsoft Windows operating system."
12258 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
12259 msgid "\"freebsd\""
12264 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
12270 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
12271 msgid "The operating system type could not be determined."
12275 #: ../src/guestfs-actions.pod:3021
12276 msgid "guestfs_inspect_get_windows_current_control_set"
12280 #: ../src/guestfs-actions.pod:3023
12284 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12285 " const char *root);\n"
12290 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098
12292 "This returns the Windows CurrentControlSet of the inspected guest. The "
12293 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12297 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101
12299 "This call assumes that the guest is Windows and that the Registry could be "
12300 "examined by inspection. If this is not the case then an error is returned."
12305 #: ../src/guestfs-actions.pod:3042
12306 msgid "guestfs_inspect_get_windows_systemroot"
12311 #: ../src/guestfs-actions.pod:3044
12315 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12316 " const char *root);\n"
12322 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2114
12324 "This returns the Windows systemroot of the inspected guest. The systemroot "
12325 "is a directory path such as C</WINDOWS>."
12330 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2117
12332 "This call assumes that the guest is Windows and that the systemroot could be "
12333 "determined by inspection. If this is not the case then an error is returned."
12338 #: ../src/guestfs-actions.pod:3063
12339 msgid "(Added in 1.5.25)"
12343 #: ../src/guestfs-actions.pod:3065
12344 msgid "guestfs_inspect_is_live"
12348 #: ../src/guestfs-actions.pod:3067
12352 " guestfs_inspect_is_live (guestfs_h *g,\n"
12353 " const char *root);\n"
12358 #: ../src/guestfs-actions.pod:3074
12360 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12361 "disk), then this returns true if a live image was detected on the disk."
12365 #: ../src/guestfs-actions.pod:3082
12366 msgid "guestfs_inspect_is_multipart"
12370 #: ../src/guestfs-actions.pod:3084
12374 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12375 " const char *root);\n"
12380 #: ../src/guestfs-actions.pod:3091
12382 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12383 "disk), then this returns true if the disk is part of a set."
12387 #: ../src/guestfs-actions.pod:3099
12388 msgid "guestfs_inspect_is_netinst"
12392 #: ../src/guestfs-actions.pod:3101
12396 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12397 " const char *root);\n"
12402 #: ../src/guestfs-actions.pod:3108
12404 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12405 "disk), then this returns true if the disk is a network installer, ie. not a "
12406 "self-contained install CD but one which is likely to require network access "
12407 "to complete the install."
12412 #: ../src/guestfs-actions.pod:3118
12413 msgid "guestfs_inspect_list_applications"
12418 #: ../src/guestfs-actions.pod:3120
12421 " struct guestfs_application_list *\n"
12422 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12423 " const char *root);\n"
12429 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2171
12430 msgid "Return the list of applications installed in the operating system."
12435 #: ../src/guestfs-actions.pod:3129
12437 "I<Note:> This call works differently from other parts of the inspection "
12438 "API. You have to call C<guestfs_inspect_os>, then "
12439 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12440 "this. Listing applications is a significantly more difficult operation "
12441 "which requires access to the full filesystem. Also note that unlike the "
12442 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12443 "the libguestfs handle, this call actually reads parts of the mounted "
12444 "filesystems during the call."
12449 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2183
12451 "This returns an empty list if the inspection code was not able to determine "
12452 "the list of applications."
12457 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2186
12458 msgid "The application structure contains the following fields:"
12463 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2190
12464 msgid "C<app_name>"
12469 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2192
12471 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12472 "guests, this is the package name."
12477 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
12478 msgid "C<app_display_name>"
12483 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
12485 "The display name of the application, sometimes localized to the install "
12486 "language of the guest operating system."
12491 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
12493 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12494 "to display something can use C<app_name> instead."
12499 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
12500 msgid "C<app_epoch>"
12505 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
12507 "For package managers which use epochs, this contains the epoch of the "
12508 "package (an integer). If unavailable, this is returned as C<0>."
12513 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
12514 msgid "C<app_version>"
12519 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
12521 "The version string of the application or package. If unavailable this is "
12522 "returned as an empty string C<\"\">."
12527 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
12528 msgid "C<app_release>"
12533 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
12535 "The release string of the application or package, for package managers that "
12536 "use this. If unavailable this is returned as an empty string C<\"\">."
12541 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2219
12542 msgid "C<app_install_path>"
12547 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
12549 "The installation path of the application (on operating systems such as "
12550 "Windows which use installation paths). This path is in the format used by "
12551 "the guest operating system, it is not a libguestfs path."
12556 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
12557 msgid "If unavailable this is returned as an empty string C<\"\">."
12562 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2228
12563 msgid "C<app_trans_path>"
12568 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2230
12570 "The install path translated into a libguestfs path. If unavailable this is "
12571 "returned as an empty string C<\"\">."
12576 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
12577 msgid "C<app_publisher>"
12582 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
12584 "The name of the publisher of the application, for package managers that use "
12585 "this. If unavailable this is returned as an empty string C<\"\">."
12590 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2239
12596 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
12598 "The URL (eg. upstream URL) of the application. If unavailable this is "
12599 "returned as an empty string C<\"\">."
12604 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
12605 msgid "C<app_source_package>"
12610 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
12612 "For packaging systems which support this, the name of the source package. "
12613 "If unavailable this is returned as an empty string C<\"\">."
12618 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
12619 msgid "C<app_summary>"
12624 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
12626 "A short (usually one line) description of the application or package. If "
12627 "unavailable this is returned as an empty string C<\"\">."
12632 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
12633 msgid "C<app_description>"
12638 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
12640 "A longer description of the application or package. If unavailable this is "
12641 "returned as an empty string C<\"\">."
12646 #: ../src/guestfs-actions.pod:3219
12648 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12649 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12655 #: ../src/guestfs-actions.pod:3223
12656 msgid "(Added in 1.7.8)"
12661 #: ../src/guestfs-actions.pod:3225
12662 msgid "guestfs_inspect_os"
12667 #: ../src/guestfs-actions.pod:3227
12671 " guestfs_inspect_os (guestfs_h *g);\n"
12677 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2267
12679 "This function uses other libguestfs functions and certain heuristics to "
12680 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12681 "for operating systems."
12686 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2271
12687 msgid "The list returned is empty if no operating systems were found."
12692 #: ../src/guestfs-actions.pod:3236 ../fish/guestfish-actions.pod:2273
12694 "If one operating system was found, then this returns a list with a single "
12695 "element, which is the name of the root filesystem of this operating system. "
12696 "It is also possible for this function to return a list containing more than "
12697 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12698 "element being the root filesystem of one of the operating systems."
12703 #: ../src/guestfs-actions.pod:3243
12705 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12706 "functions in order to query further information about each operating system, "
12707 "such as the name and version."
12712 #: ../src/guestfs-actions.pod:3248
12714 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12715 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12716 "the contents. This should be called with no disks currently mounted. The "
12717 "function may also use Augeas, so any existing Augeas handle will be closed."
12722 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2291
12724 "This function cannot decrypt encrypted disks. The caller must do that first "
12725 "(supplying the necessary keys) if the disk is encrypted."
12730 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3550
12731 #: ../src/guestfs-actions.pod:3612
12732 msgid "See also C<guestfs_list_filesystems>."
12737 #: ../src/guestfs-actions.pod:3268
12738 msgid "guestfs_is_blockdev"
12743 #: ../src/guestfs-actions.pod:3270
12747 " guestfs_is_blockdev (guestfs_h *g,\n"
12748 " const char *path);\n"
12754 #: ../src/guestfs-actions.pod:3274 ../fish/guestfish-actions.pod:2303
12756 "This returns C<true> if and only if there is a block device with the given "
12762 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3306
12763 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351
12764 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3423
12765 #: ../src/guestfs-actions.pod:3438
12766 msgid "See also C<guestfs_stat>."
12771 #: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3310
12772 #: ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3427
12773 #: ../src/guestfs-actions.pod:3442
12774 msgid "(Added in 1.5.10)"
12779 #: ../src/guestfs-actions.pod:3283
12780 msgid "guestfs_is_busy"
12785 #: ../src/guestfs-actions.pod:3285
12789 " guestfs_is_busy (guestfs_h *g);\n"
12795 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2312
12797 "This returns true iff this handle is busy processing a command (in the "
12803 #: ../src/guestfs-actions.pod:3297
12804 msgid "guestfs_is_chardev"
12809 #: ../src/guestfs-actions.pod:3299
12813 " guestfs_is_chardev (guestfs_h *g,\n"
12814 " const char *path);\n"
12820 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2321
12822 "This returns C<true> if and only if there is a character device with the "
12823 "given C<path> name."
12828 #: ../src/guestfs-actions.pod:3312
12829 msgid "guestfs_is_config"
12834 #: ../src/guestfs-actions.pod:3314
12838 " guestfs_is_config (guestfs_h *g);\n"
12844 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2330
12846 "This returns true iff this handle is being configured (in the C<CONFIG> "
12852 #: ../src/guestfs-actions.pod:3326
12853 msgid "guestfs_is_dir"
12858 #: ../src/guestfs-actions.pod:3328
12862 " guestfs_is_dir (guestfs_h *g,\n"
12863 " const char *path);\n"
12869 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2339
12871 "This returns C<true> if and only if there is a directory with the given "
12872 "C<path> name. Note that it returns false for other objects like files."
12877 #: ../src/guestfs-actions.pod:3342
12878 msgid "guestfs_is_fifo"
12883 #: ../src/guestfs-actions.pod:3344
12887 " guestfs_is_fifo (guestfs_h *g,\n"
12888 " const char *path);\n"
12894 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2349
12896 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12897 "given C<path> name."
12902 #: ../src/guestfs-actions.pod:3357
12903 msgid "guestfs_is_file"
12908 #: ../src/guestfs-actions.pod:3359
12912 " guestfs_is_file (guestfs_h *g,\n"
12913 " const char *path);\n"
12919 #: ../src/guestfs-actions.pod:3363 ../fish/guestfish-actions.pod:2358
12921 "This returns C<true> if and only if there is a regular file with the given "
12922 "C<path> name. Note that it returns false for other objects like directories."
12927 #: ../src/guestfs-actions.pod:3373
12928 msgid "guestfs_is_launching"
12933 #: ../src/guestfs-actions.pod:3375
12937 " guestfs_is_launching (guestfs_h *g);\n"
12943 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2368
12945 "This returns true iff this handle is launching the subprocess (in the "
12946 "C<LAUNCHING> state)."
12951 #: ../src/guestfs-actions.pod:3387
12952 msgid "guestfs_is_lv"
12957 #: ../src/guestfs-actions.pod:3389
12961 " guestfs_is_lv (guestfs_h *g,\n"
12962 " const char *device);\n"
12968 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2377
12970 "This command tests whether C<device> is a logical volume, and returns true "
12971 "iff this is the case."
12976 #: ../src/guestfs-actions.pod:3400
12977 msgid "guestfs_is_ready"
12982 #: ../src/guestfs-actions.pod:3402
12986 " guestfs_is_ready (guestfs_h *g);\n"
12992 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2384
12994 "This returns true iff this handle is ready to accept commands (in the "
13000 #: ../src/guestfs-actions.pod:3414
13001 msgid "guestfs_is_socket"
13006 #: ../src/guestfs-actions.pod:3416
13010 " guestfs_is_socket (guestfs_h *g,\n"
13011 " const char *path);\n"
13017 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2393
13019 "This returns C<true> if and only if there is a Unix domain socket with the "
13020 "given C<path> name."
13025 #: ../src/guestfs-actions.pod:3429
13026 msgid "guestfs_is_symlink"
13031 #: ../src/guestfs-actions.pod:3431
13035 " guestfs_is_symlink (guestfs_h *g,\n"
13036 " const char *path);\n"
13042 #: ../src/guestfs-actions.pod:3435 ../fish/guestfish-actions.pod:2402
13044 "This returns C<true> if and only if there is a symbolic link with the given "
13050 #: ../src/guestfs-actions.pod:3444
13051 msgid "guestfs_kill_subprocess"
13056 #: ../src/guestfs-actions.pod:3446
13060 " guestfs_kill_subprocess (guestfs_h *g);\n"
13066 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2411
13067 msgid "This kills the qemu subprocess. You should never need to call this."
13072 #: ../src/guestfs-actions.pod:3455
13073 msgid "guestfs_launch"
13078 #: ../src/guestfs-actions.pod:3457
13082 " guestfs_launch (guestfs_h *g);\n"
13088 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2419
13090 "Internally libguestfs is implemented by running a virtual machine using "
13096 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2422
13098 "You should call this after configuring the handle (eg. adding drives) but "
13099 "before performing any actions."
13104 #: ../src/guestfs-actions.pod:3475
13105 msgid "guestfs_lchown"
13110 #: ../src/guestfs-actions.pod:3477
13114 " guestfs_lchown (guestfs_h *g,\n"
13117 " const char *path);\n"
13123 #: ../src/guestfs-actions.pod:3483
13125 "Change the file owner to C<owner> and group to C<group>. This is like "
13126 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13127 "changed, not the target."
13132 #: ../src/guestfs-actions.pod:3495
13133 msgid "guestfs_lgetxattr"
13138 #: ../src/guestfs-actions.pod:3497
13142 " guestfs_lgetxattr (guestfs_h *g,\n"
13143 " const char *path,\n"
13144 " const char *name,\n"
13145 " size_t *size_r);\n"
13151 #: ../src/guestfs-actions.pod:3503 ../fish/guestfish-actions.pod:2441
13153 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13154 "is a symlink, then this call returns an extended attribute from the symlink."
13159 #: ../src/guestfs-actions.pod:3517
13160 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13165 #: ../src/guestfs-actions.pod:3525
13166 msgid "guestfs_lgetxattrs"
13171 #: ../src/guestfs-actions.pod:3527
13174 " struct guestfs_xattr_list *\n"
13175 " guestfs_lgetxattrs (guestfs_h *g,\n"
13176 " const char *path);\n"
13182 #: ../src/guestfs-actions.pod:3531
13184 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13185 "then it returns the extended attributes of the link itself."
13190 #: ../src/guestfs-actions.pod:3541
13191 msgid "guestfs_list_devices"
13196 #: ../src/guestfs-actions.pod:3543
13200 " guestfs_list_devices (guestfs_h *g);\n"
13206 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2469
13207 msgid "List all the block devices."
13212 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2471
13213 msgid "The full block device names are returned, eg. C</dev/sda>."
13218 #: ../src/guestfs-actions.pod:3558
13219 msgid "guestfs_list_filesystems"
13224 #: ../src/guestfs-actions.pod:3560
13228 " guestfs_list_filesystems (guestfs_h *g);\n"
13234 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2479
13236 "This inspection command looks for filesystems on partitions, block devices "
13237 "and logical volumes, returning a list of devices containing filesystems and "
13243 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2483
13245 "The return value is a hash, where the keys are the devices containing "
13246 "filesystems, and the values are the filesystem types. For example:"
13251 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
13254 " \"/dev/sda1\" => \"ntfs\"\n"
13255 " \"/dev/sda2\" => \"ext2\"\n"
13256 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13257 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13263 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
13265 "The value can have the special value \"unknown\", meaning the content of the "
13266 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13271 #: ../src/guestfs-actions.pod:3580
13273 "This command runs other libguestfs commands, which might include "
13274 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13275 "soon after launch and only when nothing is mounted."
13280 #: ../src/guestfs-actions.pod:3584
13282 "Not all of the filesystems returned will be mountable. In particular, swap "
13283 "partitions are returned in the list. Also this command does not check that "
13284 "each filesystem found is valid and mountable, and some filesystems might be "
13285 "mountable but require special options. Filesystems may not all belong to a "
13286 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13291 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:5203
13292 msgid "(Added in 1.5.15)"
13297 #: ../src/guestfs-actions.pod:3600
13298 msgid "guestfs_list_partitions"
13303 #: ../src/guestfs-actions.pod:3602
13307 " guestfs_list_partitions (guestfs_h *g);\n"
13313 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
13314 msgid "List all the partitions detected on all block devices."
13319 #: ../src/guestfs-actions.pod:3607 ../fish/guestfish-actions.pod:2514
13320 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13325 #: ../src/guestfs-actions.pod:3609
13327 "This does not return logical volumes. For that you will need to call "
13333 #: ../src/guestfs-actions.pod:3620
13339 #: ../src/guestfs-actions.pod:3622
13343 " guestfs_ll (guestfs_h *g,\n"
13344 " const char *directory);\n"
13350 #: ../src/guestfs-actions.pod:3626 ../fish/guestfish-actions.pod:2525
13352 "List the files in C<directory> (relative to the root directory, there is no "
13353 "cwd) in the format of 'ls -la'."
13358 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2528
13360 "This command is mostly useful for interactive sessions. It is I<not> "
13361 "intended that you try to parse the output string."
13366 #: ../src/guestfs-actions.pod:3637
13372 #: ../src/guestfs-actions.pod:3639
13376 " guestfs_ln (guestfs_h *g,\n"
13377 " const char *target,\n"
13378 " const char *linkname);\n"
13384 #: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2535
13385 msgid "This command creates a hard link using the C<ln> command."
13390 #: ../src/guestfs-actions.pod:3650
13391 msgid "guestfs_ln_f"
13396 #: ../src/guestfs-actions.pod:3652
13400 " guestfs_ln_f (guestfs_h *g,\n"
13401 " const char *target,\n"
13402 " const char *linkname);\n"
13408 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2541
13410 "This command creates a hard link using the C<ln -f> command. The C<-f> "
13411 "option removes the link (C<linkname>) if it exists already."
13416 #: ../src/guestfs-actions.pod:3664
13417 msgid "guestfs_ln_s"
13422 #: ../src/guestfs-actions.pod:3666
13426 " guestfs_ln_s (guestfs_h *g,\n"
13427 " const char *target,\n"
13428 " const char *linkname);\n"
13434 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2548
13435 msgid "This command creates a symbolic link using the C<ln -s> command."
13440 #: ../src/guestfs-actions.pod:3677
13441 msgid "guestfs_ln_sf"
13446 #: ../src/guestfs-actions.pod:3679
13450 " guestfs_ln_sf (guestfs_h *g,\n"
13451 " const char *target,\n"
13452 " const char *linkname);\n"
13458 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2554
13460 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
13461 "option removes the link (C<linkname>) if it exists already."
13466 #: ../src/guestfs-actions.pod:3691
13467 msgid "guestfs_lremovexattr"
13472 #: ../src/guestfs-actions.pod:3693
13476 " guestfs_lremovexattr (guestfs_h *g,\n"
13477 " const char *xattr,\n"
13478 " const char *path);\n"
13484 #: ../src/guestfs-actions.pod:3698
13486 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13487 "link, then it removes an extended attribute of the link itself."
13492 #: ../src/guestfs-actions.pod:3706
13498 #: ../src/guestfs-actions.pod:3708
13502 " guestfs_ls (guestfs_h *g,\n"
13503 " const char *directory);\n"
13509 #: ../src/guestfs-actions.pod:3712 ../fish/guestfish-actions.pod:2569
13511 "List the files in C<directory> (relative to the root directory, there is no "
13512 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13517 #: ../src/guestfs-actions.pod:3716
13519 "This command is mostly useful for interactive sessions. Programs should "
13520 "probably use C<guestfs_readdir> instead."
13525 #: ../src/guestfs-actions.pod:3725
13526 msgid "guestfs_lsetxattr"
13531 #: ../src/guestfs-actions.pod:3727
13535 " guestfs_lsetxattr (guestfs_h *g,\n"
13536 " const char *xattr,\n"
13537 " const char *val,\n"
13539 " const char *path);\n"
13545 #: ../src/guestfs-actions.pod:3734
13547 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13548 "then it sets an extended attribute of the link itself."
13553 #: ../src/guestfs-actions.pod:3742
13554 msgid "guestfs_lstat"
13559 #: ../src/guestfs-actions.pod:3744
13562 " struct guestfs_stat *\n"
13563 " guestfs_lstat (guestfs_h *g,\n"
13564 " const char *path);\n"
13570 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:6306
13571 #: ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:4257
13572 msgid "Returns file information for the given C<path>."
13577 #: ../src/guestfs-actions.pod:3750
13579 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13580 "link, then the link is stat-ed, not the file it refers to."
13585 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2594
13586 msgid "This is the same as the C<lstat(2)> system call."
13591 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6310
13593 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13594 "error. I<The caller must call C<guestfs_free_stat> after use>."
13599 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:6314
13600 #: ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6713
13601 msgid "(Added in 0.9.2)"
13606 #: ../src/guestfs-actions.pod:3762
13607 msgid "guestfs_lstatlist"
13612 #: ../src/guestfs-actions.pod:3764
13615 " struct guestfs_stat_list *\n"
13616 " guestfs_lstatlist (guestfs_h *g,\n"
13617 " const char *path,\n"
13618 " char *const *names);\n"
13624 #: ../src/guestfs-actions.pod:3769
13626 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13627 "files, where all files are in the directory C<path>. C<names> is the list "
13628 "of files from this directory."
13633 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2604
13635 "On return you get a list of stat structs, with a one-to-one correspondence "
13636 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13637 "then the C<ino> field of that structure is set to C<-1>."
13642 #: ../src/guestfs-actions.pod:3778
13644 "This call is intended for programs that want to efficiently list a directory "
13645 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13646 "for a similarly efficient call for getting extended attributes. Very long "
13647 "directory listings might cause the protocol message size to be exceeded, "
13648 "causing this call to fail. The caller must split up such requests into "
13649 "smaller groups of names."
13654 #: ../src/guestfs-actions.pod:3786
13656 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13657 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13662 #: ../src/guestfs-actions.pod:3792
13663 msgid "guestfs_luks_add_key"
13668 #: ../src/guestfs-actions.pod:3794
13672 " guestfs_luks_add_key (guestfs_h *g,\n"
13673 " const char *device,\n"
13674 " const char *key,\n"
13675 " const char *newkey,\n"
13682 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2621
13684 "This command adds a new key on LUKS device C<device>. C<key> is any "
13685 "existing key, and is used to access the device. C<newkey> is the new key to "
13686 "add. C<keyslot> is the key slot that will be replaced."
13691 #: ../src/guestfs-actions.pod:3806
13693 "Note that if C<keyslot> already contains a key, then this command will "
13694 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13699 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3852
13700 #: ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3895
13701 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3946
13703 "This function takes a key or passphrase parameter which could contain "
13704 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13710 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3856
13711 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3899
13712 msgid "(Added in 1.5.2)"
13717 #: ../src/guestfs-actions.pod:3818
13718 msgid "guestfs_luks_close"
13723 #: ../src/guestfs-actions.pod:3820
13727 " guestfs_luks_close (guestfs_h *g,\n"
13728 " const char *device);\n"
13734 #: ../src/guestfs-actions.pod:3824
13736 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13737 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13738 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13739 "underlying block device."
13744 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3931
13745 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4000
13746 #: ../src/guestfs-actions.pod:4048
13747 msgid "(Added in 1.5.1)"
13752 #: ../src/guestfs-actions.pod:3834
13753 msgid "guestfs_luks_format"
13758 #: ../src/guestfs-actions.pod:3836
13762 " guestfs_luks_format (guestfs_h *g,\n"
13763 " const char *device,\n"
13764 " const char *key,\n"
13771 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2647
13773 "This command erases existing data on C<device> and formats the device as a "
13774 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13775 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13780 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3872
13781 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4954
13782 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:6141
13783 #: ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6190
13784 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:2655
13785 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2752
13786 #: ../fish/guestfish-actions.pod:3326 ../fish/guestfish-actions.pod:3846
13787 #: ../fish/guestfish-actions.pod:4156 ../fish/guestfish-actions.pod:4172
13788 #: ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4902
13790 "B<This command is dangerous. Without careful use you can easily destroy all "
13796 #: ../src/guestfs-actions.pod:3858
13797 msgid "guestfs_luks_format_cipher"
13802 #: ../src/guestfs-actions.pod:3860
13806 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13807 " const char *device,\n"
13808 " const char *key,\n"
13810 " const char *cipher);\n"
13816 #: ../src/guestfs-actions.pod:3867
13818 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13819 "set the C<cipher> used."
13824 #: ../src/guestfs-actions.pod:3881
13825 msgid "guestfs_luks_kill_slot"
13830 #: ../src/guestfs-actions.pod:3883
13834 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13835 " const char *device,\n"
13836 " const char *key,\n"
13843 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2675
13845 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13846 "device C<device>. C<key> must be one of the I<other> keys."
13851 #: ../src/guestfs-actions.pod:3901
13852 msgid "guestfs_luks_open"
13857 #: ../src/guestfs-actions.pod:3903
13861 " guestfs_luks_open (guestfs_h *g,\n"
13862 " const char *device,\n"
13863 " const char *key,\n"
13864 " const char *mapname);\n"
13870 #: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:2686
13872 "This command opens a block device which has been encrypted according to the "
13873 "Linux Unified Key Setup (LUKS) standard."
13878 #: ../src/guestfs-actions.pod:3912 ../fish/guestfish-actions.pod:2689
13879 msgid "C<device> is the encrypted block device or partition."
13884 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
13886 "The caller must supply one of the keys associated with the LUKS block "
13887 "device, in the C<key> parameter."
13892 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
13894 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13895 "writes to this block device are decrypted from and encrypted to the "
13896 "underlying C<device> respectively."
13901 #: ../src/guestfs-actions.pod:3921
13903 "If this block device contains LVM volume groups, then calling "
13904 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13910 #: ../src/guestfs-actions.pod:3933
13911 msgid "guestfs_luks_open_ro"
13916 #: ../src/guestfs-actions.pod:3935
13920 " guestfs_luks_open_ro (guestfs_h *g,\n"
13921 " const char *device,\n"
13922 " const char *key,\n"
13923 " const char *mapname);\n"
13929 #: ../src/guestfs-actions.pod:3941
13931 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13937 #: ../src/guestfs-actions.pod:3952
13938 msgid "guestfs_lvcreate"
13943 #: ../src/guestfs-actions.pod:3954
13947 " guestfs_lvcreate (guestfs_h *g,\n"
13948 " const char *logvol,\n"
13949 " const char *volgroup,\n"
13956 #: ../src/guestfs-actions.pod:3960 ../fish/guestfish-actions.pod:2719
13958 "This creates an LVM logical volume called C<logvol> on the volume group "
13959 "C<volgroup>, with C<size> megabytes."
13964 #: ../src/guestfs-actions.pod:3967
13965 msgid "guestfs_lvm_canonical_lv_name"
13970 #: ../src/guestfs-actions.pod:3969
13974 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13975 " const char *lvname);\n"
13981 #: ../src/guestfs-actions.pod:3973 ../fish/guestfish-actions.pod:2726
13983 "This converts alternative naming schemes for LVs that you might find to the "
13984 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13990 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2730
13992 "This command returns an error if the C<lvname> parameter does not refer to a "
13998 #: ../src/guestfs-actions.pod:3980
13999 msgid "See also C<guestfs_is_lv>."
14004 #: ../src/guestfs-actions.pod:3985
14005 msgid "(Added in 1.5.24)"
14010 #: ../src/guestfs-actions.pod:3987
14011 msgid "guestfs_lvm_clear_filter"
14016 #: ../src/guestfs-actions.pod:3989
14020 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14026 #: ../src/guestfs-actions.pod:3992
14028 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14029 "see every block device."
14034 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4037
14035 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2773
14037 "This command also clears the LVM cache and performs a volume group scan."
14042 #: ../src/guestfs-actions.pod:4002
14043 msgid "guestfs_lvm_remove_all"
14048 #: ../src/guestfs-actions.pod:4004
14052 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14058 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2749
14060 "This command removes all LVM logical volumes, volume groups and physical "
14066 #: ../src/guestfs-actions.pod:4017
14067 msgid "guestfs_lvm_set_filter"
14072 #: ../src/guestfs-actions.pod:4019
14076 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14077 " char *const *devices);\n"
14083 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2759
14085 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14086 "block devices in the list C<devices>, and will ignore all other attached "
14092 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2763
14094 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14095 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14096 "there are two types of duplication possible: either cloned PVs/VGs which "
14097 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14098 "same name. In normal operation you cannot create this situation, but you "
14099 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14100 "inside the LVM metadata."
14105 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2776
14106 msgid "You can filter whole block devices or individual partitions."
14111 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2778
14113 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14114 "filesystem), even if you are not filtering out that VG."
14119 #: ../src/guestfs-actions.pod:4050
14120 msgid "guestfs_lvremove"
14125 #: ../src/guestfs-actions.pod:4052
14129 " guestfs_lvremove (guestfs_h *g,\n"
14130 " const char *device);\n"
14136 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2786
14138 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14139 "LV, such as C</dev/VG/LV>."
14144 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2789
14146 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14152 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:5300
14153 #: ../src/guestfs-actions.pod:7089
14154 msgid "(Added in 1.0.13)"
14159 #: ../src/guestfs-actions.pod:4066
14160 msgid "guestfs_lvrename"
14165 #: ../src/guestfs-actions.pod:4068
14169 " guestfs_lvrename (guestfs_h *g,\n"
14170 " const char *logvol,\n"
14171 " const char *newlogvol);\n"
14177 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2796
14178 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14183 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:7102
14184 msgid "(Added in 1.0.83)"
14189 #: ../src/guestfs-actions.pod:4079
14190 msgid "guestfs_lvresize"
14195 #: ../src/guestfs-actions.pod:4081
14199 " guestfs_lvresize (guestfs_h *g,\n"
14200 " const char *device,\n"
14207 #: ../src/guestfs-actions.pod:4086 ../fish/guestfish-actions.pod:2802
14209 "This resizes (expands or shrinks) an existing LVM logical volume to "
14210 "C<mbytes>. When reducing, data in the reduced part is lost."
14215 #: ../src/guestfs-actions.pod:4094
14216 msgid "guestfs_lvresize_free"
14221 #: ../src/guestfs-actions.pod:4096
14225 " guestfs_lvresize_free (guestfs_h *g,\n"
14226 " const char *lv,\n"
14233 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2810
14235 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14236 "remaining free space in the volume group. Commonly you would call this with "
14237 "pc = 100 which expands the logical volume as much as possible, using all "
14238 "remaining free space in the volume group."
14243 #: ../src/guestfs-actions.pod:4109
14244 msgid "(Added in 1.3.3)"
14249 #: ../src/guestfs-actions.pod:4111
14250 msgid "guestfs_lvs"
14255 #: ../src/guestfs-actions.pod:4113
14259 " guestfs_lvs (guestfs_h *g);\n"
14265 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2820
14267 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14273 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2823
14275 "This returns a list of the logical volume device names (eg. C</dev/"
14276 "VolGroup00/LogVol00>)."
14281 #: ../src/guestfs-actions.pod:4122
14282 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14287 #: ../src/guestfs-actions.pod:4130
14288 msgid "guestfs_lvs_full"
14293 #: ../src/guestfs-actions.pod:4132
14296 " struct guestfs_lvm_lv_list *\n"
14297 " guestfs_lvs_full (guestfs_h *g);\n"
14303 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2832
14305 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14306 "(8)> command. The \"full\" version includes all fields."
14311 #: ../src/guestfs-actions.pod:4138
14313 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14314 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14319 #: ../src/guestfs-actions.pod:4144
14320 msgid "guestfs_lvuuid"
14325 #: ../src/guestfs-actions.pod:4146
14329 " guestfs_lvuuid (guestfs_h *g,\n"
14330 " const char *device);\n"
14336 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2839
14337 msgid "This command returns the UUID of the LVM LV C<device>."
14342 #: ../src/guestfs-actions.pod:4157
14343 msgid "guestfs_lxattrlist"
14348 #: ../src/guestfs-actions.pod:4159
14351 " struct guestfs_xattr_list *\n"
14352 " guestfs_lxattrlist (guestfs_h *g,\n"
14353 " const char *path,\n"
14354 " char *const *names);\n"
14360 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2845
14362 "This call allows you to get the extended attributes of multiple files, where "
14363 "all files are in the directory C<path>. C<names> is the list of files from "
14369 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:2849
14371 "On return you get a flat list of xattr structs which must be interpreted "
14372 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14373 "C<attrval> in this struct is zero-length to indicate there was an error "
14374 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14375 "number (the number of following attributes for this file, which could be C<"
14376 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14377 "for the first named file. This repeats for the second and subsequent files."
14382 #: ../src/guestfs-actions.pod:4178
14384 "This call is intended for programs that want to efficiently list a directory "
14385 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14386 "a similarly efficient call for getting standard stats. Very long directory "
14387 "listings might cause the protocol message size to be exceeded, causing this "
14388 "call to fail. The caller must split up such requests into smaller groups of "
14394 #: ../src/guestfs-actions.pod:4192
14395 msgid "guestfs_mkdir"
14400 #: ../src/guestfs-actions.pod:4194
14404 " guestfs_mkdir (guestfs_h *g,\n"
14405 " const char *path);\n"
14411 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2871
14412 msgid "Create a directory named C<path>."
14417 #: ../src/guestfs-actions.pod:4204
14418 msgid "guestfs_mkdir_mode"
14423 #: ../src/guestfs-actions.pod:4206
14427 " guestfs_mkdir_mode (guestfs_h *g,\n"
14428 " const char *path,\n"
14435 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2877
14437 "This command creates a directory, setting the initial permissions of the "
14438 "directory to C<mode>."
14443 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2880
14445 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14446 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14452 #: ../src/guestfs-actions.pod:4218
14453 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14458 #: ../src/guestfs-actions.pod:4224
14459 msgid "guestfs_mkdir_p"
14464 #: ../src/guestfs-actions.pod:4226
14468 " guestfs_mkdir_p (guestfs_h *g,\n"
14469 " const char *path);\n"
14475 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2890
14477 "Create a directory named C<path>, creating any parent directories as "
14478 "necessary. This is like the C<mkdir -p> shell command."
14483 #: ../src/guestfs-actions.pod:4237
14484 msgid "guestfs_mkdtemp"
14489 #: ../src/guestfs-actions.pod:4239
14493 " guestfs_mkdtemp (guestfs_h *g,\n"
14494 " const char *template);\n"
14500 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2897
14502 "This command creates a temporary directory. The C<template> parameter "
14503 "should be a full pathname for the temporary directory name with the final "
14504 "six characters being \"XXXXXX\"."
14509 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
14511 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14512 "being suitable for Windows filesystems."
14517 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
14518 msgid "The name of the temporary directory that was created is returned."
14523 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2908
14524 msgid "The temporary directory is created with mode 0700 and is owned by root."
14529 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2911
14531 "The caller is responsible for deleting the temporary directory and its "
14532 "contents after use."
14537 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2914
14538 msgid "See also: L<mkdtemp(3)>"
14543 #: ../src/guestfs-actions.pod:4267
14544 msgid "guestfs_mke2fs_J"
14549 #: ../src/guestfs-actions.pod:4269
14553 " guestfs_mke2fs_J (guestfs_h *g,\n"
14554 " const char *fstype,\n"
14555 " int blocksize,\n"
14556 " const char *device,\n"
14557 " const char *journal);\n"
14563 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2920
14565 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14566 "C<journal>. It is equivalent to the command:"
14571 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2924
14574 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14580 #: ../src/guestfs-actions.pod:4282
14581 msgid "See also C<guestfs_mke2journal>."
14586 #: ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:4304
14587 #: ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4338
14588 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366
14589 #: ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4690
14590 msgid "(Added in 1.0.68)"
14595 #: ../src/guestfs-actions.pod:4288
14596 msgid "guestfs_mke2fs_JL"
14601 #: ../src/guestfs-actions.pod:4290
14605 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14606 " const char *fstype,\n"
14607 " int blocksize,\n"
14608 " const char *device,\n"
14609 " const char *label);\n"
14615 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2932
14617 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14618 "the journal labeled C<label>."
14623 #: ../src/guestfs-actions.pod:4300
14624 msgid "See also C<guestfs_mke2journal_L>."
14629 #: ../src/guestfs-actions.pod:4306
14630 msgid "guestfs_mke2fs_JU"
14635 #: ../src/guestfs-actions.pod:4308
14639 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14640 " const char *fstype,\n"
14641 " int blocksize,\n"
14642 " const char *device,\n"
14643 " const char *uuid);\n"
14649 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2941
14651 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14652 "the journal with UUID C<uuid>."
14657 #: ../src/guestfs-actions.pod:4318
14658 msgid "See also C<guestfs_mke2journal_U>."
14663 #: ../src/guestfs-actions.pod:4324
14664 msgid "guestfs_mke2journal"
14669 #: ../src/guestfs-actions.pod:4326
14673 " guestfs_mke2journal (guestfs_h *g,\n"
14674 " int blocksize,\n"
14675 " const char *device);\n"
14681 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2950
14683 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14689 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2953
14692 " mke2fs -O journal_dev -b blocksize device\n"
14698 #: ../src/guestfs-actions.pod:4340
14699 msgid "guestfs_mke2journal_L"
14704 #: ../src/guestfs-actions.pod:4342
14708 " guestfs_mke2journal_L (guestfs_h *g,\n"
14709 " int blocksize,\n"
14710 " const char *label,\n"
14711 " const char *device);\n"
14717 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2959
14718 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14723 #: ../src/guestfs-actions.pod:4354
14724 msgid "guestfs_mke2journal_U"
14729 #: ../src/guestfs-actions.pod:4356
14733 " guestfs_mke2journal_U (guestfs_h *g,\n"
14734 " int blocksize,\n"
14735 " const char *uuid,\n"
14736 " const char *device);\n"
14742 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2965
14743 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14748 #: ../src/guestfs-actions.pod:4368
14749 msgid "guestfs_mkfifo"
14754 #: ../src/guestfs-actions.pod:4370
14758 " guestfs_mkfifo (guestfs_h *g,\n"
14760 " const char *path);\n"
14766 #: ../src/guestfs-actions.pod:4375
14768 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14769 "is just a convenient wrapper around C<guestfs_mknod>."
14774 #: ../src/guestfs-actions.pod:4385
14775 msgid "guestfs_mkfs"
14780 #: ../src/guestfs-actions.pod:4387
14784 " guestfs_mkfs (guestfs_h *g,\n"
14785 " const char *fstype,\n"
14786 " const char *device);\n"
14792 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2981
14794 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14795 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14800 #: ../src/guestfs-actions.pod:4400
14801 msgid "guestfs_mkfs_b"
14806 #: ../src/guestfs-actions.pod:4402
14810 " guestfs_mkfs_b (guestfs_h *g,\n"
14811 " const char *fstype,\n"
14812 " int blocksize,\n"
14813 " const char *device);\n"
14819 #: ../src/guestfs-actions.pod:4408
14821 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14822 "block size of the resulting filesystem. Supported block sizes depend on the "
14823 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14828 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4456
14829 #: ../fish/guestfish-actions.pod:2994 ../fish/guestfish-actions.pod:3021
14831 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14837 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2997
14839 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14844 #: ../src/guestfs-actions.pod:4427
14845 msgid "guestfs_mkfs_opts"
14850 #: ../src/guestfs-actions.pod:4429
14854 " guestfs_mkfs_opts (guestfs_h *g,\n"
14855 " const char *fstype,\n"
14856 " const char *device,\n"
14862 #: ../src/guestfs-actions.pod:4440
14865 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14866 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14872 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3008
14874 "This function creates a filesystem on C<device>. The filesystem type is "
14875 "C<fstype>, for example C<ext3>."
14880 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3015
14881 msgid "C<blocksize>"
14886 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3017
14888 "The filesystem block size. Supported block sizes depend on the filesystem "
14889 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14894 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3024
14895 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14899 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:3026
14900 msgid "C<features>"
14904 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3028
14905 msgid "This passes the C<-O> parameter to the external mkfs program."
14909 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:3030
14911 "For certain filesystem types, this allows extra filesystem features to be "
14912 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14916 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
14918 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14923 #: ../src/guestfs-actions.pod:4476
14924 msgid "(Added in 1.7.19)"
14929 #: ../src/guestfs-actions.pod:4478
14930 msgid "guestfs_mkfs_opts_va"
14935 #: ../src/guestfs-actions.pod:4480
14939 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14940 " const char *fstype,\n"
14941 " const char *device,\n"
14942 " va_list args);\n"
14948 #: ../src/guestfs-actions.pod:4486
14949 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14954 #: ../src/guestfs-actions.pod:4490
14955 msgid "guestfs_mkfs_opts_argv"
14960 #: ../src/guestfs-actions.pod:4492
14964 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14965 " const char *fstype,\n"
14966 " const char *device,\n"
14967 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14973 #: ../src/guestfs-actions.pod:4498
14974 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14979 #: ../src/guestfs-actions.pod:4502
14980 msgid "guestfs_mkmountpoint"
14985 #: ../src/guestfs-actions.pod:4504
14989 " guestfs_mkmountpoint (guestfs_h *g,\n"
14990 " const char *exemptpath);\n"
14996 #: ../src/guestfs-actions.pod:4508
14998 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14999 "that can be used to create extra mountpoints before mounting the first "
15005 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3049
15007 "These calls are I<only> necessary in some very limited circumstances, mainly "
15008 "the case where you want to mount a mix of unrelated and/or read-only "
15009 "filesystems together."
15014 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3053
15016 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15017 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15018 "inside that. You can unpack this as follows in guestfish:"
15023 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
15026 " add-ro Fedora-11-i686-Live.iso\n"
15028 " mkmountpoint /cd\n"
15029 " mkmountpoint /sqsh\n"
15030 " mkmountpoint /ext3fs\n"
15031 " mount /dev/sda /cd\n"
15032 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15033 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15039 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3067
15040 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15045 #: ../src/guestfs-actions.pod:4532
15047 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15048 "may get unexpected errors if you try to mix these calls. It is safest to "
15049 "manually unmount filesystems and remove mountpoints after use."
15054 #: ../src/guestfs-actions.pod:4536
15056 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15057 "first, so for this to work for manual mountpoints, you must ensure that the "
15058 "innermost mountpoints have the longest pathnames, as in the example code "
15064 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3078
15066 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15070 #: ../src/guestfs-actions.pod:4543
15072 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15073 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15074 "can also trigger these issues."
15079 #: ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4808
15080 #: ../src/guestfs-actions.pod:5718
15081 msgid "(Added in 1.0.62)"
15086 #: ../src/guestfs-actions.pod:4551
15087 msgid "guestfs_mknod"
15092 #: ../src/guestfs-actions.pod:4553
15096 " guestfs_mknod (guestfs_h *g,\n"
15100 " const char *path);\n"
15106 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3088
15108 "This call creates block or character special devices, or named pipes (FIFOs)."
15113 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3091
15115 "The C<mode> parameter should be the mode, using the standard constants. "
15116 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15117 "used when creating block and character special devices."
15122 #: ../src/guestfs-actions.pod:4568
15124 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15125 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15126 "regular file). These constants are available in the standard Linux header "
15127 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15128 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15129 "the appropriate constant for you."
15134 #: ../src/guestfs-actions.pod:4582
15135 msgid "guestfs_mknod_b"
15140 #: ../src/guestfs-actions.pod:4584
15144 " guestfs_mknod_b (guestfs_h *g,\n"
15148 " const char *path);\n"
15154 #: ../src/guestfs-actions.pod:4591
15156 "This call creates a block device node called C<path> with mode C<mode> and "
15157 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15158 "wrapper around C<guestfs_mknod>."
15163 #: ../src/guestfs-actions.pod:4601
15164 msgid "guestfs_mknod_c"
15169 #: ../src/guestfs-actions.pod:4603
15173 " guestfs_mknod_c (guestfs_h *g,\n"
15177 " const char *path);\n"
15183 #: ../src/guestfs-actions.pod:4610
15185 "This call creates a char device node called C<path> with mode C<mode> and "
15186 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15187 "wrapper around C<guestfs_mknod>."
15192 #: ../src/guestfs-actions.pod:4620
15193 msgid "guestfs_mkswap"
15198 #: ../src/guestfs-actions.pod:4622
15202 " guestfs_mkswap (guestfs_h *g,\n"
15203 " const char *device);\n"
15209 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3130
15210 msgid "Create a swap partition on C<device>."
15215 #: ../src/guestfs-actions.pod:4632
15216 msgid "guestfs_mkswap_L"
15221 #: ../src/guestfs-actions.pod:4634
15225 " guestfs_mkswap_L (guestfs_h *g,\n"
15226 " const char *label,\n"
15227 " const char *device);\n"
15233 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3136
15234 msgid "Create a swap partition on C<device> with label C<label>."
15239 #: ../src/guestfs-actions.pod:4641 ../fish/guestfish-actions.pod:3138
15241 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15242 "sda>), just to a partition. This appears to be a limitation of the kernel "
15248 #: ../src/guestfs-actions.pod:4649
15249 msgid "guestfs_mkswap_U"
15254 #: ../src/guestfs-actions.pod:4651
15258 " guestfs_mkswap_U (guestfs_h *g,\n"
15259 " const char *uuid,\n"
15260 " const char *device);\n"
15266 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3146
15267 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15272 #: ../src/guestfs-actions.pod:4662
15273 msgid "guestfs_mkswap_file"
15278 #: ../src/guestfs-actions.pod:4664
15282 " guestfs_mkswap_file (guestfs_h *g,\n"
15283 " const char *path);\n"
15289 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3152
15290 msgid "Create a swap file."
15295 #: ../src/guestfs-actions.pod:4670
15297 "This command just writes a swap file signature to an existing file. To "
15298 "create the file itself, use something like C<guestfs_fallocate>."
15303 #: ../src/guestfs-actions.pod:4677
15304 msgid "guestfs_modprobe"
15309 #: ../src/guestfs-actions.pod:4679
15313 " guestfs_modprobe (guestfs_h *g,\n"
15314 " const char *modulename);\n"
15320 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3161
15321 msgid "This loads a kernel module in the appliance."
15326 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3163
15328 "The kernel module must have been whitelisted when libguestfs was built (see "
15329 "C<appliance/kmod.whitelist.in> in the source)."
15334 #: ../src/guestfs-actions.pod:4692
15335 msgid "guestfs_mount"
15340 #: ../src/guestfs-actions.pod:4694
15344 " guestfs_mount (guestfs_h *g,\n"
15345 " const char *device,\n"
15346 " const char *mountpoint);\n"
15352 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3170
15354 "Mount a guest disk at a position in the filesystem. Block devices are named "
15355 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15356 "those block devices contain partitions, they will have the usual names (eg. "
15357 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15362 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3176
15364 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15365 "mounted on C</> before others can be mounted. Other filesystems can only be "
15366 "mounted on directories which already exist."
15371 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
15373 "The mounted filesystem is writable, if we have sufficient permissions on the "
15374 "underlying device."
15379 #: ../src/guestfs-actions.pod:4713
15381 "B<Important note:> When you use this call, the filesystem options C<sync> "
15382 "and C<noatime> are set implicitly. This was originally done because we "
15383 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15384 "very large negative performance impact and negligible effect on "
15385 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15386 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15387 "(use an empty string for the first parameter if you don't want any options)."
15392 #: ../src/guestfs-actions.pod:4727
15393 msgid "guestfs_mount_loop"
15398 #: ../src/guestfs-actions.pod:4729
15402 " guestfs_mount_loop (guestfs_h *g,\n"
15403 " const char *file,\n"
15404 " const char *mountpoint);\n"
15410 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3198
15412 "This command lets you mount C<file> (a filesystem image in a file) on a "
15413 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15419 #: ../src/guestfs-actions.pod:4742
15420 msgid "guestfs_mount_options"
15425 #: ../src/guestfs-actions.pod:4744
15429 " guestfs_mount_options (guestfs_h *g,\n"
15430 " const char *options,\n"
15431 " const char *device,\n"
15432 " const char *mountpoint);\n"
15438 #: ../src/guestfs-actions.pod:4750
15440 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15441 "the mount options as for the L<mount(8)> I<-o> flag."
15446 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3210
15448 "If the C<options> parameter is an empty string, then no options are passed "
15449 "(all options default to whatever the filesystem uses)."
15454 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4774
15455 #: ../src/guestfs-actions.pod:4791
15456 msgid "(Added in 1.0.10)"
15461 #: ../src/guestfs-actions.pod:4762
15462 msgid "guestfs_mount_ro"
15467 #: ../src/guestfs-actions.pod:4764
15471 " guestfs_mount_ro (guestfs_h *g,\n"
15472 " const char *device,\n"
15473 " const char *mountpoint);\n"
15479 #: ../src/guestfs-actions.pod:4769
15481 "This is the same as the C<guestfs_mount> command, but it mounts the "
15482 "filesystem with the read-only (I<-o ro>) flag."
15487 #: ../src/guestfs-actions.pod:4776
15488 msgid "guestfs_mount_vfs"
15493 #: ../src/guestfs-actions.pod:4778
15497 " guestfs_mount_vfs (guestfs_h *g,\n"
15498 " const char *options,\n"
15499 " const char *vfstype,\n"
15500 " const char *device,\n"
15501 " const char *mountpoint);\n"
15507 #: ../src/guestfs-actions.pod:4785
15509 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15510 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15516 #: ../src/guestfs-actions.pod:4793
15517 msgid "guestfs_mountpoints"
15522 #: ../src/guestfs-actions.pod:4795
15526 " guestfs_mountpoints (guestfs_h *g);\n"
15532 #: ../src/guestfs-actions.pod:4798
15534 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15535 "devices. This one returns a hash table (map) of device name to directory "
15536 "where the device is mounted."
15541 #: ../src/guestfs-actions.pod:4810
15542 msgid "guestfs_mounts"
15547 #: ../src/guestfs-actions.pod:4812
15551 " guestfs_mounts (guestfs_h *g);\n"
15557 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3241
15559 "This returns the list of currently mounted filesystems. It returns the list "
15560 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15565 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3244
15566 msgid "Some internal mounts are not shown."
15571 #: ../src/guestfs-actions.pod:4820
15572 msgid "See also: C<guestfs_mountpoints>"
15577 #: ../src/guestfs-actions.pod:4828
15583 #: ../src/guestfs-actions.pod:4830
15587 " guestfs_mv (guestfs_h *g,\n"
15588 " const char *src,\n"
15589 " const char *dest);\n"
15595 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3252
15597 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15598 "destination filename or destination directory."
15603 #: ../src/guestfs-actions.pod:4842
15604 msgid "guestfs_ntfs_3g_probe"
15609 #: ../src/guestfs-actions.pod:4844
15613 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15615 " const char *device);\n"
15621 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3259
15623 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15624 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15625 "write, and some cannot be mounted at all)."
15630 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3263
15632 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15633 "can be mounted read-write. Set it to false if you want to test if the "
15634 "volume can be mounted read-only."
15639 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
15641 "The return value is an integer which C<0> if the operation would succeed, or "
15642 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15647 #: ../src/guestfs-actions.pod:4863
15648 msgid "(Added in 1.0.43)"
15653 #: ../src/guestfs-actions.pod:4865
15654 msgid "guestfs_ntfsresize"
15659 #: ../src/guestfs-actions.pod:4867
15663 " guestfs_ntfsresize (guestfs_h *g,\n"
15664 " const char *device);\n"
15670 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3275
15672 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15673 "size of the underlying device. See also L<ntfsresize(8)>."
15678 #: ../src/guestfs-actions.pod:4879
15679 msgid "guestfs_ntfsresize_size"
15684 #: ../src/guestfs-actions.pod:4881
15688 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15689 " const char *device,\n"
15690 " int64_t size);\n"
15696 #: ../src/guestfs-actions.pod:4886
15698 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15699 "to specify the new size (in bytes) explicitly."
15704 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5327
15705 #: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5666
15706 #: ../src/guestfs-actions.pod:7237
15707 msgid "(Added in 1.3.14)"
15712 #: ../src/guestfs-actions.pod:4893
15713 msgid "guestfs_part_add"
15718 #: ../src/guestfs-actions.pod:4895
15722 " guestfs_part_add (guestfs_h *g,\n"
15723 " const char *device,\n"
15724 " const char *prlogex,\n"
15725 " int64_t startsect,\n"
15726 " int64_t endsect);\n"
15732 #: ../src/guestfs-actions.pod:4902
15734 "This command adds a partition to C<device>. If there is no partition table "
15735 "on the device, call C<guestfs_part_init> first."
15740 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
15742 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15743 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15744 "C<logical>) and C<e> (or C<extended>) partition types."
15749 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3298
15751 "C<startsect> and C<endsect> are the start and end of the partition in "
15752 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15753 "from the end of the disk (C<-1> is the last sector)."
15758 #: ../src/guestfs-actions.pod:4914
15760 "Creating a partition which covers the whole disk is not so easy. Use "
15761 "C<guestfs_part_disk> to do that."
15766 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4957
15767 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5088
15768 #: ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5145
15769 #: ../src/guestfs-actions.pod:5185
15770 msgid "(Added in 1.0.78)"
15775 #: ../src/guestfs-actions.pod:4921
15776 msgid "guestfs_part_del"
15781 #: ../src/guestfs-actions.pod:4923
15785 " guestfs_part_del (guestfs_h *g,\n"
15786 " const char *device,\n"
15793 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3309
15794 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15799 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
15801 "Note that in the case of MBR partitioning, deleting an extended partition "
15802 "also deletes any logical partitions it contains."
15807 #: ../src/guestfs-actions.pod:4938
15808 msgid "guestfs_part_disk"
15813 #: ../src/guestfs-actions.pod:4940
15817 " guestfs_part_disk (guestfs_h *g,\n"
15818 " const char *device,\n"
15819 " const char *parttype);\n"
15825 #: ../src/guestfs-actions.pod:4945
15827 "This command is simply a combination of C<guestfs_part_init> followed by "
15828 "C<guestfs_part_add> to create a single primary partition covering the whole "
15834 #: ../src/guestfs-actions.pod:4949
15836 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15837 "possible values are described in C<guestfs_part_init>."
15842 #: ../src/guestfs-actions.pod:4959
15843 msgid "guestfs_part_get_bootable"
15848 #: ../src/guestfs-actions.pod:4961
15852 " guestfs_part_get_bootable (guestfs_h *g,\n"
15853 " const char *device,\n"
15860 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3333
15862 "This command returns true if the partition C<partnum> on C<device> has the "
15863 "bootable flag set."
15868 #: ../src/guestfs-actions.pod:4969
15869 msgid "See also C<guestfs_part_set_bootable>."
15874 #: ../src/guestfs-actions.pod:4975
15875 msgid "guestfs_part_get_mbr_id"
15880 #: ../src/guestfs-actions.pod:4977
15884 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15885 " const char *device,\n"
15892 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3342
15894 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15895 "partition C<partnum>."
15900 #: ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5161
15902 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15903 "undefined results for other partition table types (see "
15904 "C<guestfs_part_get_parttype>)."
15909 #: ../src/guestfs-actions.pod:4993
15910 msgid "guestfs_part_get_parttype"
15915 #: ../src/guestfs-actions.pod:4995
15919 " guestfs_part_get_parttype (guestfs_h *g,\n"
15920 " const char *device);\n"
15926 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3353
15928 "This command examines the partition table on C<device> and returns the "
15929 "partition table type (format) being used."
15934 #: ../src/guestfs-actions.pod:5002
15936 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15937 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15938 "possible, although unusual. See C<guestfs_part_init> for a full list."
15943 #: ../src/guestfs-actions.pod:5012
15944 msgid "guestfs_part_init"
15949 #: ../src/guestfs-actions.pod:5014
15953 " guestfs_part_init (guestfs_h *g,\n"
15954 " const char *device,\n"
15955 " const char *parttype);\n"
15961 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3365
15963 "This creates an empty partition table on C<device> of one of the partition "
15964 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15965 "(for large disks)."
15970 #: ../src/guestfs-actions.pod:5023
15972 "Initially there are no partitions. Following this, you should call "
15973 "C<guestfs_part_add> for each partition required."
15978 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3372
15979 msgid "Possible values for C<parttype> are:"
15984 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3376
15985 msgid "B<efi> | B<gpt>"
15990 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3378
15991 msgid "Intel EFI / GPT partition table."
15996 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
15998 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15999 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16000 "the C<mbr> format."
16005 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
16006 msgid "B<mbr> | B<msdos>"
16011 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
16013 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16014 "Windows. This partition type will B<only> work for device sizes up to 2 "
16015 "TB. For large disks we recommend using C<gpt>."
16020 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
16022 "Other partition table types that may work but are not supported include:"
16027 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
16033 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3400
16034 msgid "AIX disk labels."
16039 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
16040 msgid "B<amiga> | B<rdb>"
16045 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
16046 msgid "Amiga \"Rigid Disk Block\" format."
16051 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
16057 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
16058 msgid "BSD disk labels."
16063 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
16069 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
16070 msgid "DASD, used on IBM mainframes."
16075 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
16081 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
16082 msgid "MIPS/SGI volumes."
16087 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
16093 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
16094 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16099 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
16105 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
16106 msgid "NEC PC-98 format, common in Japan apparently."
16111 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
16117 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
16118 msgid "Sun disk labels."
16123 #: ../src/guestfs-actions.pod:5090
16124 msgid "guestfs_part_list"
16129 #: ../src/guestfs-actions.pod:5092
16132 " struct guestfs_partition_list *\n"
16133 " guestfs_part_list (guestfs_h *g,\n"
16134 " const char *device);\n"
16140 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3436
16142 "This command parses the partition table on C<device> and returns the list of "
16143 "partitions found."
16148 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3439
16149 msgid "The fields in the returned structure are:"
16154 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3443
16155 msgid "B<part_num>"
16160 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3445
16161 msgid "Partition number, counting from 1."
16166 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
16167 msgid "B<part_start>"
16172 #: ../src/guestfs-actions.pod:5109
16174 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16175 "the device's sector size, see C<guestfs_blockdev_getss>."
16180 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3452
16181 msgid "B<part_end>"
16186 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3454
16187 msgid "End of the partition in bytes."
16192 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3456
16193 msgid "B<part_size>"
16198 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3458
16199 msgid "Size of the partition in bytes."
16204 #: ../src/guestfs-actions.pod:5122
16206 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16207 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16213 #: ../src/guestfs-actions.pod:5128
16214 msgid "guestfs_part_set_bootable"
16219 #: ../src/guestfs-actions.pod:5130
16223 " guestfs_part_set_bootable (guestfs_h *g,\n"
16224 " const char *device,\n"
16226 " int bootable);\n"
16232 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3466
16234 "This sets the bootable flag on partition numbered C<partnum> on device "
16235 "C<device>. Note that partitions are numbered from 1."
16240 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3469
16242 "The bootable flag is used by some operating systems (notably Windows) to "
16243 "determine which partition to boot from. It is by no means universally "
16249 #: ../src/guestfs-actions.pod:5147
16250 msgid "guestfs_part_set_mbr_id"
16255 #: ../src/guestfs-actions.pod:5149
16259 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16260 " const char *device,\n"
16268 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3477
16270 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16271 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16272 "documentation are in fact hexadecimal numbers, but usually documented "
16273 "without any leading \"0x\" which might be confusing."
16278 #: ../src/guestfs-actions.pod:5169
16279 msgid "guestfs_part_set_name"
16284 #: ../src/guestfs-actions.pod:5171
16288 " guestfs_part_set_name (guestfs_h *g,\n"
16289 " const char *device,\n"
16291 " const char *name);\n"
16297 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3491
16299 "This sets the partition name on partition numbered C<partnum> on device "
16300 "C<device>. Note that partitions are numbered from 1."
16305 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3494
16307 "The partition name can only be set on certain types of partition table. "
16308 "This works on C<gpt> but not on C<mbr> partitions."
16313 #: ../src/guestfs-actions.pod:5187
16314 msgid "guestfs_part_to_dev"
16319 #: ../src/guestfs-actions.pod:5189
16323 " guestfs_part_to_dev (guestfs_h *g,\n"
16324 " const char *partition);\n"
16330 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3501
16332 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16333 "partition number, returning the device name (eg. \"/dev/sdb\")."
16338 #: ../src/guestfs-actions.pod:5197
16340 "The named partition must exist, for example as a string returned from "
16341 "C<guestfs_list_partitions>."
16346 #: ../src/guestfs-actions.pod:5205
16347 msgid "guestfs_ping_daemon"
16352 #: ../src/guestfs-actions.pod:5207
16356 " guestfs_ping_daemon (guestfs_h *g);\n"
16362 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3512
16364 "This is a test probe into the guestfs daemon running inside the qemu "
16365 "subprocess. Calling this function checks that the daemon responds to the "
16366 "ping message, without affecting the daemon or attached block device(s) in "
16372 #: ../src/guestfs-actions.pod:5219
16373 msgid "guestfs_pread"
16378 #: ../src/guestfs-actions.pod:5221
16382 " guestfs_pread (guestfs_h *g,\n"
16383 " const char *path,\n"
16385 " int64_t offset,\n"
16386 " size_t *size_r);\n"
16392 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3521
16394 "This command lets you read part of a file. It reads C<count> bytes of the "
16395 "file, starting at C<offset>, from file C<path>."
16400 #: ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5257
16401 #: ../fish/guestfish-actions.pod:3524 ../fish/guestfish-actions.pod:3539
16403 "This may read fewer bytes than requested. For further details see the "
16404 "L<pread(2)> system call."
16409 #: ../src/guestfs-actions.pod:5234
16410 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16415 #: ../src/guestfs-actions.pod:5245
16416 msgid "guestfs_pread_device"
16421 #: ../src/guestfs-actions.pod:5247
16425 " guestfs_pread_device (guestfs_h *g,\n"
16426 " const char *device,\n"
16428 " int64_t offset,\n"
16429 " size_t *size_r);\n"
16435 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3536
16437 "This command lets you read part of a file. It reads C<count> bytes of "
16438 "C<device>, starting at C<offset>."
16443 #: ../src/guestfs-actions.pod:5260
16444 msgid "See also C<guestfs_pread>."
16449 #: ../src/guestfs-actions.pod:5269
16450 msgid "(Added in 1.5.21)"
16455 #: ../src/guestfs-actions.pod:5271
16456 msgid "guestfs_pvcreate"
16461 #: ../src/guestfs-actions.pod:5273
16465 " guestfs_pvcreate (guestfs_h *g,\n"
16466 " const char *device);\n"
16472 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3551
16474 "This creates an LVM physical volume on the named C<device>, where C<device> "
16475 "should usually be a partition name such as C</dev/sda1>."
16480 #: ../src/guestfs-actions.pod:5285
16481 msgid "guestfs_pvremove"
16486 #: ../src/guestfs-actions.pod:5287
16490 " guestfs_pvremove (guestfs_h *g,\n"
16491 " const char *device);\n"
16497 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3559
16499 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16505 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3562
16507 "The implementation uses the C<pvremove> command which refuses to wipe "
16508 "physical volumes that contain any volume groups, so you have to remove those "
16514 #: ../src/guestfs-actions.pod:5302
16515 msgid "guestfs_pvresize"
16520 #: ../src/guestfs-actions.pod:5304
16524 " guestfs_pvresize (guestfs_h *g,\n"
16525 " const char *device);\n"
16531 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3570
16533 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16534 "the new size of the underlying device."
16539 #: ../src/guestfs-actions.pod:5315
16540 msgid "guestfs_pvresize_size"
16545 #: ../src/guestfs-actions.pod:5317
16549 " guestfs_pvresize_size (guestfs_h *g,\n"
16550 " const char *device,\n"
16551 " int64_t size);\n"
16557 #: ../src/guestfs-actions.pod:5322
16559 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16560 "specify the new size (in bytes) explicitly."
16565 #: ../src/guestfs-actions.pod:5329
16566 msgid "guestfs_pvs"
16571 #: ../src/guestfs-actions.pod:5331
16575 " guestfs_pvs (guestfs_h *g);\n"
16581 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3584
16583 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16589 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3587
16591 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16597 #: ../src/guestfs-actions.pod:5340
16598 msgid "See also C<guestfs_pvs_full>."
16603 #: ../src/guestfs-actions.pod:5348
16604 msgid "guestfs_pvs_full"
16609 #: ../src/guestfs-actions.pod:5350
16612 " struct guestfs_lvm_pv_list *\n"
16613 " guestfs_pvs_full (guestfs_h *g);\n"
16619 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3596
16621 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16622 "(8)> command. The \"full\" version includes all fields."
16627 #: ../src/guestfs-actions.pod:5356
16629 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16630 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16635 #: ../src/guestfs-actions.pod:5362
16636 msgid "guestfs_pvuuid"
16641 #: ../src/guestfs-actions.pod:5364
16645 " guestfs_pvuuid (guestfs_h *g,\n"
16646 " const char *device);\n"
16652 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3603
16653 msgid "This command returns the UUID of the LVM PV C<device>."
16658 #: ../src/guestfs-actions.pod:5375
16659 msgid "guestfs_pwrite"
16664 #: ../src/guestfs-actions.pod:5377
16668 " guestfs_pwrite (guestfs_h *g,\n"
16669 " const char *path,\n"
16670 " const char *content,\n"
16671 " size_t content_size,\n"
16672 " int64_t offset);\n"
16678 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3609
16680 "This command writes to part of a file. It writes the data buffer C<content> "
16681 "to the file C<path> starting at offset C<offset>."
16686 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3612
16688 "This command implements the L<pwrite(2)> system call, and like that system "
16689 "call it may not write the full data requested. The return value is the "
16690 "number of bytes that were actually written to the file. This could even be "
16691 "0, although short writes are unlikely for regular files in ordinary "
16697 #: ../src/guestfs-actions.pod:5393
16698 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16703 #: ../src/guestfs-actions.pod:5402
16704 msgid "guestfs_pwrite_device"
16709 #: ../src/guestfs-actions.pod:5404
16713 " guestfs_pwrite_device (guestfs_h *g,\n"
16714 " const char *device,\n"
16715 " const char *content,\n"
16716 " size_t content_size,\n"
16717 " int64_t offset);\n"
16723 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3627
16725 "This command writes to part of a device. It writes the data buffer "
16726 "C<content> to C<device> starting at offset C<offset>."
16731 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
16733 "This command implements the L<pwrite(2)> system call, and like that system "
16734 "call it may not write the full data requested (although short writes to disk "
16735 "devices and partitions are probably impossible with standard Linux kernels)."
16740 #: ../src/guestfs-actions.pod:5419
16741 msgid "See also C<guestfs_pwrite>."
16746 #: ../src/guestfs-actions.pod:5426
16747 msgid "(Added in 1.5.20)"
16752 #: ../src/guestfs-actions.pod:5428
16753 msgid "guestfs_read_file"
16758 #: ../src/guestfs-actions.pod:5430
16762 " guestfs_read_file (guestfs_h *g,\n"
16763 " const char *path,\n"
16764 " size_t *size_r);\n"
16770 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3644
16771 msgid "This calls returns the contents of the file C<path> as a buffer."
16776 #: ../src/guestfs-actions.pod:5438
16778 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16779 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16780 "function is limited in the total size of file that can be handled."
16785 #: ../src/guestfs-actions.pod:5450
16786 msgid "(Added in 1.0.63)"
16791 #: ../src/guestfs-actions.pod:5452
16792 msgid "guestfs_read_lines"
16797 #: ../src/guestfs-actions.pod:5454
16801 " guestfs_read_lines (guestfs_h *g,\n"
16802 " const char *path);\n"
16808 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3661
16810 "The file contents are returned as a list of lines. Trailing C<LF> and "
16811 "C<CRLF> character sequences are I<not> returned."
16816 #: ../src/guestfs-actions.pod:5463
16818 "Note that this function cannot correctly handle binary files (specifically, "
16819 "files containing C<\\0> character which is treated as end of line). For "
16820 "those you need to use the C<guestfs_read_file> function which has a more "
16821 "complex interface."
16826 #: ../src/guestfs-actions.pod:5474
16827 msgid "guestfs_readdir"
16832 #: ../src/guestfs-actions.pod:5476
16835 " struct guestfs_dirent_list *\n"
16836 " guestfs_readdir (guestfs_h *g,\n"
16837 " const char *dir);\n"
16843 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3673
16844 msgid "This returns the list of directory entries in directory C<dir>."
16849 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3675
16851 "All entries in the directory are returned, including C<.> and C<..>. The "
16852 "entries are I<not> sorted, but returned in the same order as the underlying "
16858 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3679
16860 "Also this call returns basic file type information about each file. The "
16861 "C<ftyp> field will contain one of the following characters:"
16866 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3684
16872 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3686
16873 msgid "Block special"
16878 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3688
16884 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3690
16885 msgid "Char special"
16890 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
16896 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
16902 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
16908 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
16909 msgid "FIFO (named pipe)"
16914 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
16920 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
16921 msgid "Symbolic link"
16926 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
16932 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
16933 msgid "Regular file"
16938 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
16944 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
16950 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
16956 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
16957 msgid "Unknown file type"
16962 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
16968 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
16970 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16975 #: ../src/guestfs-actions.pod:5530
16977 "This function is primarily intended for use by programs. To get a simple "
16978 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16979 "consumption, use C<guestfs_ll>."
16984 #: ../src/guestfs-actions.pod:5534
16986 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16987 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16992 #: ../src/guestfs-actions.pod:5540
16993 msgid "guestfs_readlink"
16998 #: ../src/guestfs-actions.pod:5542
17002 " guestfs_readlink (guestfs_h *g,\n"
17003 " const char *path);\n"
17009 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3731
17010 msgid "This command reads the target of a symbolic link."
17015 #: ../src/guestfs-actions.pod:5553
17016 msgid "guestfs_readlinklist"
17021 #: ../src/guestfs-actions.pod:5555
17025 " guestfs_readlinklist (guestfs_h *g,\n"
17026 " const char *path,\n"
17027 " char *const *names);\n"
17033 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3737
17035 "This call allows you to do a C<readlink> operation on multiple files, where "
17036 "all files are in the directory C<path>. C<names> is the list of files from "
17042 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3741
17044 "On return you get a list of strings, with a one-to-one correspondence to the "
17045 "C<names> list. Each string is the value of the symbolic link."
17050 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
17052 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17053 "result string is the empty string C<\"\">. However the whole operation is "
17054 "completed even if there were C<readlink(2)> errors, and so you can call this "
17055 "function with names where you don't know if they are symbolic links already "
17056 "(albeit slightly less efficient)."
17061 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3752
17063 "This call is intended for programs that want to efficiently list a directory "
17064 "contents without making many round-trips. Very long directory listings "
17065 "might cause the protocol message size to be exceeded, causing this call to "
17066 "fail. The caller must split up such requests into smaller groups of names."
17071 #: ../src/guestfs-actions.pod:5588
17072 msgid "guestfs_realpath"
17077 #: ../src/guestfs-actions.pod:5590
17081 " guestfs_realpath (guestfs_h *g,\n"
17082 " const char *path);\n"
17088 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3763
17090 "Return the canonicalized absolute pathname of C<path>. The returned path "
17091 "has no C<.>, C<..> or symbolic link path elements."
17096 #: ../src/guestfs-actions.pod:5602
17097 msgid "guestfs_removexattr"
17102 #: ../src/guestfs-actions.pod:5604
17106 " guestfs_removexattr (guestfs_h *g,\n"
17107 " const char *xattr,\n"
17108 " const char *path);\n"
17114 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3770
17116 "This call removes the extended attribute named C<xattr> of the file C<path>."
17121 #: ../src/guestfs-actions.pod:5612
17122 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17127 #: ../src/guestfs-actions.pod:5618
17128 msgid "guestfs_resize2fs"
17133 #: ../src/guestfs-actions.pod:5620
17137 " guestfs_resize2fs (guestfs_h *g,\n"
17138 " const char *device);\n"
17144 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3779
17146 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17147 "underlying device."
17152 #: ../src/guestfs-actions.pod:5627
17154 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17155 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17156 "sometimes gives an error about this and sometimes not. In any case, it is "
17157 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17161 #: ../src/guestfs-actions.pod:5637
17162 msgid "guestfs_resize2fs_M"
17166 #: ../src/guestfs-actions.pod:5639
17170 " guestfs_resize2fs_M (guestfs_h *g,\n"
17171 " const char *device);\n"
17176 #: ../src/guestfs-actions.pod:5643
17178 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17179 "resized to its minimum size. This works like the C<-M> option to the "
17180 "C<resize2fs> command."
17184 #: ../src/guestfs-actions.pod:5647
17186 "To get the resulting size of the filesystem you should call "
17187 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17188 "These two numbers, multiplied together, give the resulting size of the "
17189 "minimal filesystem in bytes."
17194 #: ../src/guestfs-actions.pod:5654
17195 msgid "guestfs_resize2fs_size"
17200 #: ../src/guestfs-actions.pod:5656
17204 " guestfs_resize2fs_size (guestfs_h *g,\n"
17205 " const char *device,\n"
17206 " int64_t size);\n"
17212 #: ../src/guestfs-actions.pod:5661
17214 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17215 "to specify the new size (in bytes) explicitly."
17220 #: ../src/guestfs-actions.pod:5668
17226 #: ../src/guestfs-actions.pod:5670
17230 " guestfs_rm (guestfs_h *g,\n"
17231 " const char *path);\n"
17237 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3812
17238 msgid "Remove the single file C<path>."
17243 #: ../src/guestfs-actions.pod:5680
17244 msgid "guestfs_rm_rf"
17249 #: ../src/guestfs-actions.pod:5682
17253 " guestfs_rm_rf (guestfs_h *g,\n"
17254 " const char *path);\n"
17260 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3818
17262 "Remove the file or directory C<path>, recursively removing the contents if "
17263 "its a directory. This is like the C<rm -rf> shell command."
17268 #: ../src/guestfs-actions.pod:5694
17269 msgid "guestfs_rmdir"
17274 #: ../src/guestfs-actions.pod:5696
17278 " guestfs_rmdir (guestfs_h *g,\n"
17279 " const char *path);\n"
17285 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3826
17286 msgid "Remove the single directory C<path>."
17291 #: ../src/guestfs-actions.pod:5706
17292 msgid "guestfs_rmmountpoint"
17297 #: ../src/guestfs-actions.pod:5708
17301 " guestfs_rmmountpoint (guestfs_h *g,\n"
17302 " const char *exemptpath);\n"
17308 #: ../src/guestfs-actions.pod:5712
17310 "This calls removes a mountpoint that was previously created with "
17311 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17316 #: ../src/guestfs-actions.pod:5720
17317 msgid "guestfs_scrub_device"
17322 #: ../src/guestfs-actions.pod:5722
17326 " guestfs_scrub_device (guestfs_h *g,\n"
17327 " const char *device);\n"
17333 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3840
17335 "This command writes patterns over C<device> to make data retrieval more "
17341 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5750
17342 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3843
17343 #: ../fish/guestfish-actions.pod:3858 ../fish/guestfish-actions.pod:3871
17345 "It is an interface to the L<scrub(1)> program. See that manual page for "
17351 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5755
17352 #: ../src/guestfs-actions.pod:5774
17353 msgid "(Added in 1.0.52)"
17358 #: ../src/guestfs-actions.pod:5739
17359 msgid "guestfs_scrub_file"
17364 #: ../src/guestfs-actions.pod:5741
17368 " guestfs_scrub_file (guestfs_h *g,\n"
17369 " const char *file);\n"
17375 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3853
17377 "This command writes patterns over a file to make data retrieval more "
17383 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3856
17384 msgid "The file is I<removed> after scrubbing."
17389 #: ../src/guestfs-actions.pod:5757
17390 msgid "guestfs_scrub_freespace"
17395 #: ../src/guestfs-actions.pod:5759
17399 " guestfs_scrub_freespace (guestfs_h *g,\n"
17400 " const char *dir);\n"
17406 #: ../src/guestfs-actions.pod:5763
17408 "This command creates the directory C<dir> and then fills it with files until "
17409 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17410 "and deletes them. The intention is to scrub any free space on the partition "
17411 "containing C<dir>."
17416 #: ../src/guestfs-actions.pod:5776
17417 msgid "guestfs_set_append"
17422 #: ../src/guestfs-actions.pod:5778
17426 " guestfs_set_append (guestfs_h *g,\n"
17427 " const char *append);\n"
17433 #: ../src/guestfs-actions.pod:5782 ../fish/guestfish-actions.pod:3880
17435 "This function is used to add additional options to the guest kernel command "
17441 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3883
17443 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17444 "environment variable."
17449 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3886
17451 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17452 "(libguestfs always adds a few of its own)."
17456 #: ../src/guestfs-actions.pod:5795
17457 msgid "guestfs_set_attach_method"
17461 #: ../src/guestfs-actions.pod:5797
17465 " guestfs_set_attach_method (guestfs_h *g,\n"
17466 " const char *attachmethod);\n"
17471 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3895
17473 "Set the method that libguestfs uses to connect to the back end guestfsd "
17474 "daemon. Possible methods are:"
17478 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
17480 "Launch an appliance and connect to it. This is the ordinary method and the "
17485 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
17486 msgid "C<unix:I<path>>"
17490 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
17491 msgid "Connect to the Unix domain socket I<path>."
17495 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3909
17497 "This method lets you connect to an existing daemon or (using virtio-serial) "
17498 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17499 "RUNNING DAEMONS>."
17504 #: ../src/guestfs-actions.pod:5823
17505 msgid "guestfs_set_autosync"
17510 #: ../src/guestfs-actions.pod:5825
17514 " guestfs_set_autosync (guestfs_h *g,\n"
17515 " int autosync);\n"
17520 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3921
17522 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17523 "effort attempt to make filesystems consistent and synchronized when the "
17524 "handle is closed (also if the program exits without closing handles)."
17529 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3926
17531 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17532 "disabled by default)."
17537 #: ../src/guestfs-actions.pod:5841
17538 msgid "guestfs_set_direct"
17543 #: ../src/guestfs-actions.pod:5843
17547 " guestfs_set_direct (guestfs_h *g,\n"
17554 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3935
17556 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17557 "passed directly through to the appliance once it is launched."
17562 #: ../src/guestfs-actions.pod:5851
17564 "One consequence of this is that log messages aren't caught by the library "
17565 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17571 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
17572 msgid "You probably don't want to use this unless you know what you are doing."
17577 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3946
17578 msgid "The default is disabled."
17583 #: ../src/guestfs-actions.pod:5864
17584 msgid "guestfs_set_e2label"
17589 #: ../src/guestfs-actions.pod:5866
17593 " guestfs_set_e2label (guestfs_h *g,\n"
17594 " const char *device,\n"
17595 " const char *label);\n"
17601 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3952
17603 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17604 "C<label>. Filesystem labels are limited to 16 characters."
17609 #: ../src/guestfs-actions.pod:5875
17611 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17612 "the existing label on a filesystem."
17617 #: ../src/guestfs-actions.pod:5882
17618 msgid "guestfs_set_e2uuid"
17623 #: ../src/guestfs-actions.pod:5884
17627 " guestfs_set_e2uuid (guestfs_h *g,\n"
17628 " const char *device,\n"
17629 " const char *uuid);\n"
17635 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3963
17637 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17638 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17639 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17644 #: ../src/guestfs-actions.pod:5894
17646 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17647 "the existing UUID of a filesystem."
17652 #: ../src/guestfs-actions.pod:5901
17653 msgid "guestfs_set_memsize"
17658 #: ../src/guestfs-actions.pod:5903
17662 " guestfs_set_memsize (guestfs_h *g,\n"
17669 #: ../src/guestfs-actions.pod:5907
17671 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17672 "This only has any effect if called before C<guestfs_launch>."
17677 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3981
17679 "You can also change this by setting the environment variable "
17680 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17685 #: ../src/guestfs-actions.pod:5922
17686 msgid "guestfs_set_network"
17691 #: ../src/guestfs-actions.pod:5924
17695 " guestfs_set_network (guestfs_h *g,\n"
17702 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3994
17704 "If C<network> is true, then the network is enabled in the libguestfs "
17705 "appliance. The default is false."
17710 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3997
17712 "This affects whether commands are able to access the network (see L<guestfs"
17713 "(3)/RUNNING COMMANDS>)."
17718 #: ../src/guestfs-actions.pod:5934
17720 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17726 #: ../src/guestfs-actions.pod:5941
17727 msgid "guestfs_set_path"
17732 #: ../src/guestfs-actions.pod:5943
17736 " guestfs_set_path (guestfs_h *g,\n"
17737 " const char *searchpath);\n"
17743 #: ../src/guestfs-actions.pod:5947 ../fish/guestfish-actions.pod:4009
17744 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17749 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4011
17751 "The default is C<$libdir/guestfs> unless overridden by setting "
17752 "C<LIBGUESTFS_PATH> environment variable."
17757 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4014
17758 msgid "Setting C<path> to C<NULL> restores the default path."
17763 #: ../src/guestfs-actions.pod:5958
17764 msgid "guestfs_set_qemu"
17769 #: ../src/guestfs-actions.pod:5960
17773 " guestfs_set_qemu (guestfs_h *g,\n"
17774 " const char *qemu);\n"
17780 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4022
17781 msgid "Set the qemu binary that we will use."
17786 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4024
17788 "The default is chosen when the library was compiled by the configure script."
17793 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4027
17795 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17801 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
17802 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17807 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
17809 "Note that you should call this function as early as possible after creating "
17810 "the handle. This is because some pre-launch operations depend on testing "
17811 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17812 "don't retest features, and so you might see inconsistent results. Using the "
17813 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17814 "the qemu binary at the same time as the handle is created."
17819 #: ../src/guestfs-actions.pod:5986
17820 msgid "guestfs_set_recovery_proc"
17825 #: ../src/guestfs-actions.pod:5988
17829 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17830 " int recoveryproc);\n"
17836 #: ../src/guestfs-actions.pod:5992
17838 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17839 "not create a recovery process. The purpose of the recovery process is to "
17840 "stop runaway qemu processes in the case where the main program aborts "
17846 #: ../src/guestfs-actions.pod:5997
17848 "This only has any effect if called before C<guestfs_launch>, and the default "
17854 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4054
17856 "About the only time when you would want to disable this is if the main "
17857 "process will fork itself into the background (\"daemonize\" itself). In "
17858 "this case the recovery process thinks that the main program has disappeared "
17859 "and so kills qemu, which is not very helpful."
17864 #: ../src/guestfs-actions.pod:6010
17865 msgid "guestfs_set_selinux"
17870 #: ../src/guestfs-actions.pod:6012
17874 " guestfs_set_selinux (guestfs_h *g,\n"
17881 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4066
17883 "This sets the selinux flag that is passed to the appliance at boot time. "
17884 "The default is C<selinux=0> (disabled)."
17889 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4069
17891 "Note that if SELinux is enabled, it is always in Permissive mode "
17892 "(C<enforcing=0>)."
17897 #: ../src/guestfs-actions.pod:6029
17898 msgid "guestfs_set_trace"
17903 #: ../src/guestfs-actions.pod:6031
17907 " guestfs_set_trace (guestfs_h *g,\n"
17913 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4081
17915 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17916 "return values are traced."
17921 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4084
17923 "If you want to trace C API calls into libguestfs (and other libraries) then "
17924 "possibly a better way is to use the external ltrace(1) command."
17929 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4088
17931 "Command traces are disabled unless the environment variable "
17932 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17936 #: ../src/guestfs-actions.pod:6045
17938 "Trace messages are normally sent to C<stderr>, unless you register a "
17939 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17944 #: ../src/guestfs-actions.pod:6053
17945 msgid "guestfs_set_verbose"
17950 #: ../src/guestfs-actions.pod:6055
17954 " guestfs_set_verbose (guestfs_h *g,\n"
17960 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4101
17961 msgid "If C<verbose> is true, this turns on verbose messages."
17966 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4103
17968 "Verbose messages are disabled unless the environment variable "
17969 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17973 #: ../src/guestfs-actions.pod:6064
17975 "Verbose messages are normally sent to C<stderr>, unless you register a "
17976 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17981 #: ../src/guestfs-actions.pod:6072
17982 msgid "guestfs_setcon"
17987 #: ../src/guestfs-actions.pod:6074
17991 " guestfs_setcon (guestfs_h *g,\n"
17992 " const char *context);\n"
17998 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4114
18000 "This sets the SELinux security context of the daemon to the string "
18006 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4117
18007 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18012 #: ../src/guestfs-actions.pod:6087
18013 msgid "guestfs_setxattr"
18018 #: ../src/guestfs-actions.pod:6089
18022 " guestfs_setxattr (guestfs_h *g,\n"
18023 " const char *xattr,\n"
18024 " const char *val,\n"
18026 " const char *path);\n"
18032 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4123
18034 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18035 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18040 #: ../src/guestfs-actions.pod:6100
18041 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18046 #: ../src/guestfs-actions.pod:6106
18047 msgid "guestfs_sfdisk"
18052 #: ../src/guestfs-actions.pod:6108
18056 " guestfs_sfdisk (guestfs_h *g,\n"
18057 " const char *device,\n"
18061 " char *const *lines);\n"
18067 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4133
18069 "This is a direct interface to the L<sfdisk(8)> program for creating "
18070 "partitions on block devices."
18075 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4136
18076 msgid "C<device> should be a block device, for example C</dev/sda>."
18081 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4138
18083 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18084 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18085 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18086 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18087 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18088 "the kernel) cannot work out the right geometry and you will need to tell it."
18093 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
18095 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18096 "refer to the L<sfdisk(8)> manpage."
18101 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4149
18103 "To create a single partition occupying the whole disk, you would pass "
18104 "C<lines> as a single element list, when the single element being the string "
18110 #: ../src/guestfs-actions.pod:6136
18112 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18117 #: ../src/guestfs-actions.pod:6146
18118 msgid "guestfs_sfdiskM"
18123 #: ../src/guestfs-actions.pod:6148
18127 " guestfs_sfdiskM (guestfs_h *g,\n"
18128 " const char *device,\n"
18129 " char *const *lines);\n"
18135 #: ../src/guestfs-actions.pod:6153
18137 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18138 "partition sizes are specified in megabytes only (rounded to the nearest "
18139 "cylinder) and you don't need to specify the cyls, heads and sectors "
18140 "parameters which were rarely if ever used anyway."
18145 #: ../src/guestfs-actions.pod:6159
18147 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18148 "C<guestfs_part_disk>"
18153 #: ../src/guestfs-actions.pod:6169
18154 msgid "guestfs_sfdisk_N"
18159 #: ../src/guestfs-actions.pod:6171
18163 " guestfs_sfdisk_N (guestfs_h *g,\n"
18164 " const char *device,\n"
18169 " const char *line);\n"
18175 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4179
18177 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18178 "(note: C<n> counts from 1)."
18183 #: ../src/guestfs-actions.pod:6183
18185 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18186 "for the cyls/heads/sectors parameters."
18191 #: ../src/guestfs-actions.pod:6186
18192 msgid "See also: C<guestfs_part_add>"
18197 #: ../src/guestfs-actions.pod:6195
18198 msgid "guestfs_sfdisk_disk_geometry"
18203 #: ../src/guestfs-actions.pod:6197
18207 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18208 " const char *device);\n"
18214 #: ../src/guestfs-actions.pod:6201
18216 "This displays the disk geometry of C<device> read from the partition table. "
18217 "Especially in the case where the underlying block device has been resized, "
18218 "this can be different from the kernel's idea of the geometry (see "
18219 "C<guestfs_sfdisk_kernel_geometry>)."
18224 #: ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6222
18225 #: ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4208
18226 msgid "The result is in human-readable format, and not designed to be parsed."
18231 #: ../src/guestfs-actions.pod:6214
18232 msgid "guestfs_sfdisk_kernel_geometry"
18237 #: ../src/guestfs-actions.pod:6216
18241 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18242 " const char *device);\n"
18248 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4206
18249 msgid "This displays the kernel's idea of the geometry of C<device>."
18254 #: ../src/guestfs-actions.pod:6230
18255 msgid "guestfs_sfdisk_l"
18260 #: ../src/guestfs-actions.pod:6232
18264 " guestfs_sfdisk_l (guestfs_h *g,\n"
18265 " const char *device);\n"
18271 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4215
18273 "This displays the partition table on C<device>, in the human-readable output "
18274 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18279 #: ../src/guestfs-actions.pod:6240
18280 msgid "See also: C<guestfs_part_list>"
18285 #: ../src/guestfs-actions.pod:6247
18291 #: ../src/guestfs-actions.pod:6249
18295 " guestfs_sh (guestfs_h *g,\n"
18296 " const char *command);\n"
18302 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4225
18304 "This call runs a command from the guest filesystem via the guest's C</bin/"
18310 #: ../src/guestfs-actions.pod:6256
18311 msgid "This is like C<guestfs_command>, but passes the command to:"
18316 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4230
18319 " /bin/sh -c \"command\"\n"
18325 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4232
18327 "Depending on the guest's shell, this usually results in wildcards being "
18328 "expanded, shell expressions being interpolated and so on."
18333 #: ../src/guestfs-actions.pod:6264
18334 msgid "All the provisos about C<guestfs_command> apply to this call."
18339 #: ../src/guestfs-actions.pod:6271
18340 msgid "guestfs_sh_lines"
18345 #: ../src/guestfs-actions.pod:6273
18349 " guestfs_sh_lines (guestfs_h *g,\n"
18350 " const char *command);\n"
18356 #: ../src/guestfs-actions.pod:6277
18358 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18364 #: ../src/guestfs-actions.pod:6280
18365 msgid "See also: C<guestfs_command_lines>"
18370 #: ../src/guestfs-actions.pod:6288
18371 msgid "guestfs_sleep"
18376 #: ../src/guestfs-actions.pod:6290
18380 " guestfs_sleep (guestfs_h *g,\n"
18387 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4251
18388 msgid "Sleep for C<secs> seconds."
18393 #: ../src/guestfs-actions.pod:6298
18394 msgid "(Added in 1.0.41)"
18399 #: ../src/guestfs-actions.pod:6300 ../src/guestfs-structs.pod:109
18400 msgid "guestfs_stat"
18405 #: ../src/guestfs-actions.pod:6302
18408 " struct guestfs_stat *\n"
18409 " guestfs_stat (guestfs_h *g,\n"
18410 " const char *path);\n"
18416 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4259
18417 msgid "This is the same as the C<stat(2)> system call."
18422 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-structs.pod:135
18423 msgid "guestfs_statvfs"
18428 #: ../src/guestfs-actions.pod:6318
18431 " struct guestfs_statvfs *\n"
18432 " guestfs_statvfs (guestfs_h *g,\n"
18433 " const char *path);\n"
18439 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4265
18441 "Returns file system statistics for any mounted file system. C<path> should "
18442 "be a file or directory in the mounted file system (typically it is the mount "
18443 "point itself, but it doesn't need to be)."
18448 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4269
18449 msgid "This is the same as the C<statvfs(2)> system call."
18454 #: ../src/guestfs-actions.pod:6328
18456 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18457 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18462 #: ../src/guestfs-actions.pod:6334
18463 msgid "guestfs_strings"
18468 #: ../src/guestfs-actions.pod:6336
18472 " guestfs_strings (guestfs_h *g,\n"
18473 " const char *path);\n"
18479 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4275
18481 "This runs the L<strings(1)> command on a file and returns the list of "
18482 "printable strings found."
18487 #: ../src/guestfs-actions.pod:6352
18488 msgid "guestfs_strings_e"
18493 #: ../src/guestfs-actions.pod:6354
18497 " guestfs_strings_e (guestfs_h *g,\n"
18498 " const char *encoding,\n"
18499 " const char *path);\n"
18505 #: ../src/guestfs-actions.pod:6359
18507 "This is like the C<guestfs_strings> command, but allows you to specify the "
18508 "encoding of strings that are looked for in the source file C<path>."
18513 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4289
18514 msgid "Allowed encodings are:"
18519 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4293
18525 #: ../src/guestfs-actions.pod:6369
18527 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18528 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18533 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4298
18539 #: ../src/guestfs-actions.pod:6374 ../fish/guestfish-actions.pod:4300
18540 msgid "Single 8-bit-byte characters."
18545 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4302
18551 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4304
18552 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18557 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4307
18558 msgid "l (lower case letter L)"
18563 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4309
18565 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18566 "examining binaries in Windows guests."
18571 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
18577 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4314
18578 msgid "32-bit big endian such as UCS-4BE."
18583 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4316
18589 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4318
18590 msgid "32-bit little endian such as UCS-4LE."
18595 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
18596 msgid "The returned strings are transcoded to UTF-8."
18601 #: ../src/guestfs-actions.pod:6407
18602 msgid "guestfs_swapoff_device"
18607 #: ../src/guestfs-actions.pod:6409
18611 " guestfs_swapoff_device (guestfs_h *g,\n"
18612 " const char *device);\n"
18618 #: ../src/guestfs-actions.pod:6413
18620 "This command disables the libguestfs appliance swap device or partition "
18621 "named C<device>. See C<guestfs_swapon_device>."
18626 #: ../src/guestfs-actions.pod:6421
18627 msgid "guestfs_swapoff_file"
18632 #: ../src/guestfs-actions.pod:6423
18636 " guestfs_swapoff_file (guestfs_h *g,\n"
18637 " const char *file);\n"
18643 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4339
18644 msgid "This command disables the libguestfs appliance swap on file."
18649 #: ../src/guestfs-actions.pod:6433
18650 msgid "guestfs_swapoff_label"
18655 #: ../src/guestfs-actions.pod:6435
18659 " guestfs_swapoff_label (guestfs_h *g,\n"
18660 " const char *label);\n"
18666 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4345
18668 "This command disables the libguestfs appliance swap on labeled swap "
18674 #: ../src/guestfs-actions.pod:6446
18675 msgid "guestfs_swapoff_uuid"
18680 #: ../src/guestfs-actions.pod:6448
18684 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18685 " const char *uuid);\n"
18691 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4352
18693 "This command disables the libguestfs appliance swap partition with the given "
18699 #: ../src/guestfs-actions.pod:6459
18700 msgid "guestfs_swapon_device"
18705 #: ../src/guestfs-actions.pod:6461
18709 " guestfs_swapon_device (guestfs_h *g,\n"
18710 " const char *device);\n"
18716 #: ../src/guestfs-actions.pod:6465
18718 "This command enables the libguestfs appliance to use the swap device or "
18719 "partition named C<device>. The increased memory is made available for all "
18720 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18725 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4364
18727 "Note that you should not swap to existing guest swap partitions unless you "
18728 "know what you are doing. They may contain hibernation information, or other "
18729 "information that the guest doesn't want you to trash. You also risk leaking "
18730 "information about the host to the guest this way. Instead, attach a new "
18731 "host device to the guest and swap on that."
18736 #: ../src/guestfs-actions.pod:6481
18737 msgid "guestfs_swapon_file"
18742 #: ../src/guestfs-actions.pod:6483
18746 " guestfs_swapon_file (guestfs_h *g,\n"
18747 " const char *file);\n"
18753 #: ../src/guestfs-actions.pod:6487
18755 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18761 #: ../src/guestfs-actions.pod:6494
18762 msgid "guestfs_swapon_label"
18767 #: ../src/guestfs-actions.pod:6496
18771 " guestfs_swapon_label (guestfs_h *g,\n"
18772 " const char *label);\n"
18778 #: ../src/guestfs-actions.pod:6500
18780 "This command enables swap to a labeled swap partition. See "
18781 "C<guestfs_swapon_device> for other notes."
18786 #: ../src/guestfs-actions.pod:6507
18787 msgid "guestfs_swapon_uuid"
18792 #: ../src/guestfs-actions.pod:6509
18796 " guestfs_swapon_uuid (guestfs_h *g,\n"
18797 " const char *uuid);\n"
18803 #: ../src/guestfs-actions.pod:6513
18805 "This command enables swap to a swap partition with the given UUID. See "
18806 "C<guestfs_swapon_device> for other notes."
18811 #: ../src/guestfs-actions.pod:6520
18812 msgid "guestfs_sync"
18817 #: ../src/guestfs-actions.pod:6522
18821 " guestfs_sync (guestfs_h *g);\n"
18827 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4396
18829 "This syncs the disk, so that any writes are flushed through to the "
18830 "underlying disk image."
18835 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4399
18837 "You should always call this if you have modified a disk image, before "
18838 "closing the handle."
18843 #: ../src/guestfs-actions.pod:6535
18844 msgid "guestfs_tail"
18849 #: ../src/guestfs-actions.pod:6537
18853 " guestfs_tail (guestfs_h *g,\n"
18854 " const char *path);\n"
18860 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4406
18862 "This command returns up to the last 10 lines of a file as a list of strings."
18867 #: ../src/guestfs-actions.pod:6553
18868 msgid "guestfs_tail_n"
18873 #: ../src/guestfs-actions.pod:6555
18877 " guestfs_tail_n (guestfs_h *g,\n"
18879 " const char *path);\n"
18885 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4416
18887 "If the parameter C<nrlines> is a positive number, this returns the last "
18888 "C<nrlines> lines of the file C<path>."
18893 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4419
18895 "If the parameter C<nrlines> is a negative number, this returns lines from "
18896 "the file C<path>, starting with the C<-nrlines>th line."
18901 #: ../src/guestfs-actions.pod:6577
18902 msgid "guestfs_tar_in"
18907 #: ../src/guestfs-actions.pod:6579
18911 " guestfs_tar_in (guestfs_h *g,\n"
18912 " const char *tarfile,\n"
18913 " const char *directory);\n"
18919 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4431
18921 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18922 "tar file) into C<directory>."
18927 #: ../src/guestfs-actions.pod:6587
18929 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18934 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6609
18935 #: ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6641
18936 msgid "(Added in 1.0.3)"
18941 #: ../src/guestfs-actions.pod:6594
18942 msgid "guestfs_tar_out"
18947 #: ../src/guestfs-actions.pod:6596
18951 " guestfs_tar_out (guestfs_h *g,\n"
18952 " const char *directory,\n"
18953 " const char *tarfile);\n"
18959 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4443
18961 "This command packs the contents of C<directory> and downloads it to local "
18967 #: ../src/guestfs-actions.pod:6604
18969 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18970 "C<guestfs_txz_out>."
18975 #: ../src/guestfs-actions.pod:6611
18976 msgid "guestfs_tgz_in"
18981 #: ../src/guestfs-actions.pod:6613
18985 " guestfs_tgz_in (guestfs_h *g,\n"
18986 " const char *tarball,\n"
18987 " const char *directory);\n"
18993 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4455
18995 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18996 "tar file) into C<directory>."
19001 #: ../src/guestfs-actions.pod:6621
19002 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19007 #: ../src/guestfs-actions.pod:6627
19008 msgid "guestfs_tgz_out"
19013 #: ../src/guestfs-actions.pod:6629
19017 " guestfs_tgz_out (guestfs_h *g,\n"
19018 " const char *directory,\n"
19019 " const char *tarball);\n"
19025 #: ../src/guestfs-actions.pod:6634 ../fish/guestfish-actions.pod:4466
19027 "This command packs the contents of C<directory> and downloads it to local "
19033 #: ../src/guestfs-actions.pod:6637
19034 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19039 #: ../src/guestfs-actions.pod:6643
19040 msgid "guestfs_touch"
19045 #: ../src/guestfs-actions.pod:6645
19049 " guestfs_touch (guestfs_h *g,\n"
19050 " const char *path);\n"
19056 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4477
19058 "Touch acts like the L<touch(1)> command. It can be used to update the "
19059 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19065 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4481
19067 "This command only works on regular files, and will fail on other file types "
19068 "such as directories, symbolic links, block special etc."
19073 #: ../src/guestfs-actions.pod:6660
19074 msgid "guestfs_truncate"
19079 #: ../src/guestfs-actions.pod:6662
19083 " guestfs_truncate (guestfs_h *g,\n"
19084 " const char *path);\n"
19090 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4488
19092 "This command truncates C<path> to a zero-length file. The file must exist "
19098 #: ../src/guestfs-actions.pod:6673
19099 msgid "guestfs_truncate_size"
19104 #: ../src/guestfs-actions.pod:6675
19108 " guestfs_truncate_size (guestfs_h *g,\n"
19109 " const char *path,\n"
19110 " int64_t size);\n"
19116 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4495
19118 "This command truncates C<path> to size C<size> bytes. The file must exist "
19124 #: ../src/guestfs-actions.pod:6683
19126 "If the current file size is less than C<size> then the file is extended to "
19127 "the required size with zero bytes. This creates a sparse file (ie. disk "
19128 "blocks are not allocated for the file until you write to it). To create a "
19129 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19134 #: ../src/guestfs-actions.pod:6693
19135 msgid "guestfs_tune2fs_l"
19140 #: ../src/guestfs-actions.pod:6695
19144 " guestfs_tune2fs_l (guestfs_h *g,\n"
19145 " const char *device);\n"
19151 #: ../src/guestfs-actions.pod:6699 ../fish/guestfish-actions.pod:4508
19153 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19159 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4511
19161 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19162 "for more details. The list of fields returned isn't clearly defined, and "
19163 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19164 "and the filesystem itself."
19169 #: ../src/guestfs-actions.pod:6715
19170 msgid "guestfs_txz_in"
19175 #: ../src/guestfs-actions.pod:6717
19179 " guestfs_txz_in (guestfs_h *g,\n"
19180 " const char *tarball,\n"
19181 " const char *directory);\n"
19187 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4520
19189 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19190 "tar file) into C<directory>."
19195 #: ../src/guestfs-actions.pod:6729
19196 msgid "guestfs_txz_out"
19201 #: ../src/guestfs-actions.pod:6731
19205 " guestfs_txz_out (guestfs_h *g,\n"
19206 " const char *directory,\n"
19207 " const char *tarball);\n"
19213 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4529
19215 "This command packs the contents of C<directory> and downloads it to local "
19216 "file C<tarball> (as an xz compressed tar archive)."
19221 #: ../src/guestfs-actions.pod:6743
19222 msgid "guestfs_umask"
19227 #: ../src/guestfs-actions.pod:6745
19231 " guestfs_umask (guestfs_h *g,\n"
19238 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4538
19240 "This function sets the mask used for creating new files and device nodes to "
19246 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4541
19248 "Typical umask values would be C<022> which creates new files with "
19249 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19250 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19255 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
19257 "The default umask is C<022>. This is important because it means that "
19258 "directories and device nodes will be created with C<0644> or C<0755> mode "
19259 "even if you specify C<0777>."
19264 #: ../src/guestfs-actions.pod:6761
19266 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19267 "C<guestfs_mkdir>."
19272 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4553
19273 msgid "This call returns the previous umask."
19278 #: ../src/guestfs-actions.pod:6770
19279 msgid "guestfs_umount"
19284 #: ../src/guestfs-actions.pod:6772
19288 " guestfs_umount (guestfs_h *g,\n"
19289 " const char *pathordevice);\n"
19295 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4561
19297 "This unmounts the given filesystem. The filesystem may be specified either "
19298 "by its mountpoint (path) or the device which contains the filesystem."
19303 #: ../src/guestfs-actions.pod:6784
19304 msgid "guestfs_umount_all"
19309 #: ../src/guestfs-actions.pod:6786
19313 " guestfs_umount_all (guestfs_h *g);\n"
19319 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4571
19320 msgid "This unmounts all mounted filesystems."
19325 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4573
19326 msgid "Some internal mounts are not unmounted by this call."
19331 #: ../src/guestfs-actions.pod:6797
19332 msgid "guestfs_upload"
19337 #: ../src/guestfs-actions.pod:6799
19341 " guestfs_upload (guestfs_h *g,\n"
19342 " const char *filename,\n"
19343 " const char *remotefilename);\n"
19349 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828
19350 #: ../fish/guestfish-actions.pod:4579 ../fish/guestfish-actions.pod:4592
19351 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19356 #: ../src/guestfs-actions.pod:6809
19357 msgid "See also C<guestfs_download>."
19362 #: ../src/guestfs-actions.pod:6820
19363 msgid "guestfs_upload_offset"
19368 #: ../src/guestfs-actions.pod:6822
19372 " guestfs_upload_offset (guestfs_h *g,\n"
19373 " const char *filename,\n"
19374 " const char *remotefilename,\n"
19375 " int64_t offset);\n"
19381 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4595
19383 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19384 "The intention is to overwrite parts of existing files or devices, although "
19385 "if a non-existant file is specified then it is created with a \"hole\" "
19386 "before C<offset>. The size of the data written is implicit in the size of "
19387 "the source C<filename>."
19392 #: ../src/guestfs-actions.pod:6838
19394 "Note that there is no limit on the amount of data that can be uploaded with "
19395 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19396 "full amount unless an error occurs."
19401 #: ../src/guestfs-actions.pod:6843
19402 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19407 #: ../src/guestfs-actions.pod:6854
19408 msgid "guestfs_utimens"
19413 #: ../src/guestfs-actions.pod:6856
19417 " guestfs_utimens (guestfs_h *g,\n"
19418 " const char *path,\n"
19419 " int64_t atsecs,\n"
19420 " int64_t atnsecs,\n"
19421 " int64_t mtsecs,\n"
19422 " int64_t mtnsecs);\n"
19428 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4615
19429 msgid "This command sets the timestamps of a file with nanosecond precision."
19434 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4618
19436 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19442 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4621
19444 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19445 "nanoseconds from the epoch."
19450 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4624
19452 "If the C<*nsecs> field contains the special value C<-1> then the "
19453 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19454 "ignored in this case)."
19459 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628
19461 "If the C<*nsecs> field contains the special value C<-2> then the "
19462 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19468 #: ../src/guestfs-actions.pod:6885 ../src/guestfs-structs.pod:175
19469 msgid "guestfs_version"
19474 #: ../src/guestfs-actions.pod:6887
19477 " struct guestfs_version *\n"
19478 " guestfs_version (guestfs_h *g);\n"
19484 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4636
19486 "Return the libguestfs version number that the program is linked against."
19491 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4639
19493 "Note that because of dynamic linking this is not necessarily the version of "
19494 "libguestfs that you compiled against. You can compile the program, and then "
19495 "at runtime dynamically link against a completely different C<libguestfs.so> "
19501 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
19503 "This call was added in version C<1.0.58>. In previous versions of "
19504 "libguestfs there was no way to get the version number. From C code you can "
19505 "use dynamic linker functions to find out if this symbol exists (if it "
19506 "doesn't, then it's an earlier version)."
19511 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4650
19513 "The call returns a structure with four elements. The first three (C<major>, "
19514 "C<minor> and C<release>) are numbers and correspond to the usual version "
19515 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19516 "but may be used for distro-specific information."
19521 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4656
19523 "To construct the original version string: C<$major.$minor.$release$extra>"
19528 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4659
19529 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19534 #: ../src/guestfs-actions.pod:6915
19536 "I<Note:> Don't use this call to test for availability of features. In "
19537 "enterprise distributions we backport features from later versions into "
19538 "earlier versions, making this an unreliable way to test for features. Use "
19539 "C<guestfs_available> instead."
19544 #: ../src/guestfs-actions.pod:6921
19546 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19547 "error. I<The caller must call C<guestfs_free_version> after use>."
19552 #: ../src/guestfs-actions.pod:6925
19553 msgid "(Added in 1.0.58)"
19558 #: ../src/guestfs-actions.pod:6927
19559 msgid "guestfs_vfs_label"
19564 #: ../src/guestfs-actions.pod:6929
19568 " guestfs_vfs_label (guestfs_h *g,\n"
19569 " const char *device);\n"
19575 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4671
19576 msgid "This returns the filesystem label of the filesystem on C<device>."
19581 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4674
19582 msgid "If the filesystem is unlabeled, this returns the empty string."
19587 #: ../src/guestfs-actions.pod:6938
19588 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19593 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6980
19594 msgid "(Added in 1.3.18)"
19599 #: ../src/guestfs-actions.pod:6945
19600 msgid "guestfs_vfs_type"
19605 #: ../src/guestfs-actions.pod:6947
19609 " guestfs_vfs_type (guestfs_h *g,\n"
19610 " const char *device);\n"
19616 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4682
19618 "This command gets the filesystem type corresponding to the filesystem on "
19624 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4685
19626 "For most filesystems, the result is the name of the Linux VFS module which "
19627 "would be used to mount this filesystem if you mounted it without specifying "
19628 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19633 #: ../src/guestfs-actions.pod:6964
19634 msgid "guestfs_vfs_uuid"
19639 #: ../src/guestfs-actions.pod:6966
19643 " guestfs_vfs_uuid (guestfs_h *g,\n"
19644 " const char *device);\n"
19650 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4694
19651 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19656 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4697
19657 msgid "If the filesystem does not have a UUID, this returns the empty string."
19662 #: ../src/guestfs-actions.pod:6975
19663 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19668 #: ../src/guestfs-actions.pod:6982
19669 msgid "guestfs_vg_activate"
19674 #: ../src/guestfs-actions.pod:6984
19678 " guestfs_vg_activate (guestfs_h *g,\n"
19680 " char *const *volgroups);\n"
19686 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4705
19688 "This command activates or (if C<activate> is false) deactivates all logical "
19689 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19690 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19691 "deactivated, then those devices disappear."
19696 #: ../src/guestfs-actions.pod:6995 ../fish/guestfish-actions.pod:4711
19697 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19702 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
19704 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19705 "activated or deactivated."
19710 #: ../src/guestfs-actions.pod:7004
19711 msgid "guestfs_vg_activate_all"
19716 #: ../src/guestfs-actions.pod:7006
19720 " guestfs_vg_activate_all (guestfs_h *g,\n"
19721 " int activate);\n"
19727 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4720
19729 "This command activates or (if C<activate> is false) deactivates all logical "
19730 "volumes in all volume groups. If activated, then they are made known to the "
19731 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19732 "those devices disappear."
19737 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4726
19738 msgid "This command is the same as running C<vgchange -a y|n>"
19743 #: ../src/guestfs-actions.pod:7022
19744 msgid "guestfs_vgcreate"
19749 #: ../src/guestfs-actions.pod:7024
19753 " guestfs_vgcreate (guestfs_h *g,\n"
19754 " const char *volgroup,\n"
19755 " char *const *physvols);\n"
19761 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4732
19763 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19764 "of physical volumes C<physvols>."
19769 #: ../src/guestfs-actions.pod:7036
19770 msgid "guestfs_vglvuuids"
19775 #: ../src/guestfs-actions.pod:7038
19779 " guestfs_vglvuuids (guestfs_h *g,\n"
19780 " const char *vgname);\n"
19786 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4739
19788 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19789 "volumes created in this volume group."
19794 #: ../src/guestfs-actions.pod:7045
19796 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19797 "associate logical volumes and volume groups."
19802 #: ../src/guestfs-actions.pod:7048
19803 msgid "See also C<guestfs_vgpvuuids>."
19808 #: ../src/guestfs-actions.pod:7056
19809 msgid "guestfs_vgpvuuids"
19814 #: ../src/guestfs-actions.pod:7058
19818 " guestfs_vgpvuuids (guestfs_h *g,\n"
19819 " const char *vgname);\n"
19825 #: ../src/guestfs-actions.pod:7062 ../fish/guestfish-actions.pod:4751
19827 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19828 "volumes that this volume group resides on."
19833 #: ../src/guestfs-actions.pod:7065
19835 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
19836 "associate physical volumes and volume groups."
19841 #: ../src/guestfs-actions.pod:7068
19842 msgid "See also C<guestfs_vglvuuids>."
19847 #: ../src/guestfs-actions.pod:7076
19848 msgid "guestfs_vgremove"
19853 #: ../src/guestfs-actions.pod:7078
19857 " guestfs_vgremove (guestfs_h *g,\n"
19858 " const char *vgname);\n"
19864 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4763
19865 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19870 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4765
19872 "This also forcibly removes all logical volumes in the volume group (if any)."
19877 #: ../src/guestfs-actions.pod:7091
19878 msgid "guestfs_vgrename"
19883 #: ../src/guestfs-actions.pod:7093
19887 " guestfs_vgrename (guestfs_h *g,\n"
19888 " const char *volgroup,\n"
19889 " const char *newvolgroup);\n"
19895 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4772
19896 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19901 #: ../src/guestfs-actions.pod:7104
19902 msgid "guestfs_vgs"
19907 #: ../src/guestfs-actions.pod:7106
19911 " guestfs_vgs (guestfs_h *g);\n"
19917 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4778
19919 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19925 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4781
19927 "This returns a list of just the volume group names that were detected (eg. "
19933 #: ../src/guestfs-actions.pod:7115
19934 msgid "See also C<guestfs_vgs_full>."
19939 #: ../src/guestfs-actions.pod:7123
19940 msgid "guestfs_vgs_full"
19945 #: ../src/guestfs-actions.pod:7125
19948 " struct guestfs_lvm_vg_list *\n"
19949 " guestfs_vgs_full (guestfs_h *g);\n"
19955 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4790
19957 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19958 "> command. The \"full\" version includes all fields."
19963 #: ../src/guestfs-actions.pod:7131
19965 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
19966 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
19971 #: ../src/guestfs-actions.pod:7137
19972 msgid "guestfs_vgscan"
19977 #: ../src/guestfs-actions.pod:7139
19981 " guestfs_vgscan (guestfs_h *g);\n"
19987 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4797
19989 "This rescans all block devices and rebuilds the list of LVM physical "
19990 "volumes, volume groups and logical volumes."
19995 #: ../src/guestfs-actions.pod:7149
19996 msgid "guestfs_vguuid"
20001 #: ../src/guestfs-actions.pod:7151
20005 " guestfs_vguuid (guestfs_h *g,\n"
20006 " const char *vgname);\n"
20012 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4804
20013 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20018 #: ../src/guestfs-actions.pod:7162
20019 msgid "guestfs_wait_ready"
20024 #: ../src/guestfs-actions.pod:7164
20028 " guestfs_wait_ready (guestfs_h *g);\n"
20034 #: ../src/guestfs-actions.pod:7167
20035 msgid "This function is a no op."
20040 #: ../src/guestfs-actions.pod:7169
20042 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20043 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20044 "is no longer necessary because C<guestfs_launch> now does the waiting."
20049 #: ../src/guestfs-actions.pod:7174
20051 "If you see any calls to this function in code then you can just remove them, "
20052 "unless you want to retain compatibility with older versions of the API."
20057 #: ../src/guestfs-actions.pod:7182
20058 msgid "guestfs_wc_c"
20063 #: ../src/guestfs-actions.pod:7184
20067 " guestfs_wc_c (guestfs_h *g,\n"
20068 " const char *path);\n"
20074 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4810
20076 "This command counts the characters in a file, using the C<wc -c> external "
20082 #: ../src/guestfs-actions.pod:7195
20083 msgid "guestfs_wc_l"
20088 #: ../src/guestfs-actions.pod:7197
20092 " guestfs_wc_l (guestfs_h *g,\n"
20093 " const char *path);\n"
20099 #: ../src/guestfs-actions.pod:7201 ../fish/guestfish-actions.pod:4817
20101 "This command counts the lines in a file, using the C<wc -l> external command."
20106 #: ../src/guestfs-actions.pod:7208
20107 msgid "guestfs_wc_w"
20112 #: ../src/guestfs-actions.pod:7210
20116 " guestfs_wc_w (guestfs_h *g,\n"
20117 " const char *path);\n"
20123 #: ../src/guestfs-actions.pod:7214 ../fish/guestfish-actions.pod:4824
20125 "This command counts the words in a file, using the C<wc -w> external command."
20130 #: ../src/guestfs-actions.pod:7221
20131 msgid "guestfs_write"
20136 #: ../src/guestfs-actions.pod:7223
20140 " guestfs_write (guestfs_h *g,\n"
20141 " const char *path,\n"
20142 " const char *content,\n"
20143 " size_t content_size);\n"
20149 #: ../src/guestfs-actions.pod:7229 ../fish/guestfish-actions.pod:4831
20151 "This call creates a file called C<path>. The content of the file is the "
20152 "string C<content> (which can contain any 8 bit data)."
20157 #: ../src/guestfs-actions.pod:7239
20158 msgid "guestfs_write_file"
20163 #: ../src/guestfs-actions.pod:7241
20167 " guestfs_write_file (guestfs_h *g,\n"
20168 " const char *path,\n"
20169 " const char *content,\n"
20176 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4841
20178 "This call creates a file called C<path>. The contents of the file is the "
20179 "string C<content> (which can contain any 8 bit data), with length C<size>."
20184 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4845
20186 "As a special case, if C<size> is C<0> then the length is calculated using "
20187 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20192 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
20194 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20195 "I<not> work, even if the length is specified."
20200 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4855
20202 "This function is deprecated. In new code, use the C<write> call instead."
20207 #: ../src/guestfs-actions.pod:7272
20208 msgid "guestfs_zegrep"
20213 #: ../src/guestfs-actions.pod:7274
20217 " guestfs_zegrep (guestfs_h *g,\n"
20218 " const char *regex,\n"
20219 " const char *path);\n"
20225 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4866
20227 "This calls the external C<zegrep> program and returns the matching lines."
20232 #: ../src/guestfs-actions.pod:7291
20233 msgid "guestfs_zegrepi"
20238 #: ../src/guestfs-actions.pod:7293
20242 " guestfs_zegrepi (guestfs_h *g,\n"
20243 " const char *regex,\n"
20244 " const char *path);\n"
20250 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4876
20252 "This calls the external C<zegrep -i> program and returns the matching lines."
20257 #: ../src/guestfs-actions.pod:7310
20258 msgid "guestfs_zero"
20263 #: ../src/guestfs-actions.pod:7312
20267 " guestfs_zero (guestfs_h *g,\n"
20268 " const char *device);\n"
20274 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4886
20275 msgid "This command writes zeroes over the first few blocks of C<device>."
20280 #: ../src/guestfs-actions.pod:7318 ../fish/guestfish-actions.pod:4888
20282 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20283 "securely wipe the device). It should be sufficient to remove any partition "
20284 "tables, filesystem superblocks and so on."
20289 #: ../src/guestfs-actions.pod:7322
20290 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20295 #: ../src/guestfs-actions.pod:7333
20296 msgid "guestfs_zero_device"
20301 #: ../src/guestfs-actions.pod:7335
20305 " guestfs_zero_device (guestfs_h *g,\n"
20306 " const char *device);\n"
20312 #: ../src/guestfs-actions.pod:7339
20314 "This command writes zeroes over the entire C<device>. Compare with "
20315 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20320 #: ../src/guestfs-actions.pod:7353
20321 msgid "(Added in 1.3.1)"
20326 #: ../src/guestfs-actions.pod:7355
20327 msgid "guestfs_zerofree"
20332 #: ../src/guestfs-actions.pod:7357
20336 " guestfs_zerofree (guestfs_h *g,\n"
20337 " const char *device);\n"
20343 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4909
20345 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20346 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20347 "possible to compress the filesystem more effectively."
20352 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4914
20353 msgid "You should B<not> run this program if the filesystem is mounted."
20358 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
20360 "It is possible that using this program can damage the filesystem or data on "
20366 #: ../src/guestfs-actions.pod:7376
20367 msgid "guestfs_zfgrep"
20372 #: ../src/guestfs-actions.pod:7378
20376 " guestfs_zfgrep (guestfs_h *g,\n"
20377 " const char *pattern,\n"
20378 " const char *path);\n"
20384 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4924
20386 "This calls the external C<zfgrep> program and returns the matching lines."
20391 #: ../src/guestfs-actions.pod:7395
20392 msgid "guestfs_zfgrepi"
20397 #: ../src/guestfs-actions.pod:7397
20401 " guestfs_zfgrepi (guestfs_h *g,\n"
20402 " const char *pattern,\n"
20403 " const char *path);\n"
20409 #: ../src/guestfs-actions.pod:7402 ../fish/guestfish-actions.pod:4934
20411 "This calls the external C<zfgrep -i> program and returns the matching lines."
20416 #: ../src/guestfs-actions.pod:7414
20417 msgid "guestfs_zfile"
20422 #: ../src/guestfs-actions.pod:7416
20426 " guestfs_zfile (guestfs_h *g,\n"
20427 " const char *meth,\n"
20428 " const char *path);\n"
20434 #: ../src/guestfs-actions.pod:7421 ../fish/guestfish-actions.pod:4944
20436 "This command runs C<file> after first decompressing C<path> using C<method>."
20441 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4947
20442 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20447 #: ../src/guestfs-actions.pod:7426
20449 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20455 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4952
20457 "This function is deprecated. In new code, use the C<file> call instead."
20462 #: ../src/guestfs-actions.pod:7441
20463 msgid "guestfs_zgrep"
20468 #: ../src/guestfs-actions.pod:7443
20472 " guestfs_zgrep (guestfs_h *g,\n"
20473 " const char *regex,\n"
20474 " const char *path);\n"
20480 #: ../src/guestfs-actions.pod:7448 ../fish/guestfish-actions.pod:4963
20482 "This calls the external C<zgrep> program and returns the matching lines."
20487 #: ../src/guestfs-actions.pod:7460
20488 msgid "guestfs_zgrepi"
20493 #: ../src/guestfs-actions.pod:7462
20497 " guestfs_zgrepi (guestfs_h *g,\n"
20498 " const char *regex,\n"
20499 " const char *path);\n"
20505 #: ../src/guestfs-actions.pod:7467 ../fish/guestfish-actions.pod:4973
20507 "This calls the external C<zgrep -i> program and returns the matching lines."
20512 #: ../src/guestfs-availability.pod:3
20518 #: ../src/guestfs-availability.pod:5
20520 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20521 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20522 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20523 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20524 "L</guestfs_aug_save> L</guestfs_aug_set>"
20529 #: ../src/guestfs-availability.pod:21
20535 #: ../src/guestfs-availability.pod:23
20537 "The following functions: L</guestfs_inotify_add_watch> L</"
20538 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20539 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20544 #: ../src/guestfs-availability.pod:31
20545 msgid "B<linuxfsuuid>"
20550 #: ../src/guestfs-availability.pod:33
20552 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20553 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20558 #: ../src/guestfs-availability.pod:40
20559 msgid "B<linuxmodules>"
20564 #: ../src/guestfs-availability.pod:42
20565 msgid "The following functions: L</guestfs_modprobe>"
20570 #: ../src/guestfs-availability.pod:45
20571 msgid "B<linuxxattrs>"
20576 #: ../src/guestfs-availability.pod:47
20578 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20579 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20580 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20581 "guestfs_setxattr>"
20586 #: ../src/guestfs-availability.pod:58
20592 #: ../src/guestfs-availability.pod:60
20594 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20595 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20596 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20601 #: ../src/guestfs-availability.pod:69
20607 #: ../src/guestfs-availability.pod:71
20609 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20610 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20611 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20612 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20613 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20614 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20615 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20620 #: ../src/guestfs-availability.pod:94
20626 #: ../src/guestfs-availability.pod:96
20628 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20629 "guestfs_mknod_b> L</guestfs_mknod_c>"
20634 #: ../src/guestfs-availability.pod:102
20640 #: ../src/guestfs-availability.pod:104
20641 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20646 #: ../src/guestfs-availability.pod:107
20647 msgid "B<ntfsprogs>"
20652 #: ../src/guestfs-availability.pod:109
20654 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20659 #: ../src/guestfs-availability.pod:113
20660 msgid "B<realpath>"
20665 #: ../src/guestfs-availability.pod:115
20666 msgid "The following functions: L</guestfs_realpath>"
20671 #: ../src/guestfs-availability.pod:118
20677 #: ../src/guestfs-availability.pod:120
20679 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20680 "guestfs_scrub_freespace>"
20685 #: ../src/guestfs-availability.pod:125
20691 #: ../src/guestfs-availability.pod:127
20692 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20697 #: ../src/guestfs-availability.pod:131
20703 #: ../src/guestfs-availability.pod:133
20704 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20709 #: ../src/guestfs-availability.pod:137
20710 msgid "B<zerofree>"
20715 #: ../src/guestfs-availability.pod:139
20716 msgid "The following functions: L</guestfs_zerofree>"
20721 #: ../src/guestfs-structs.pod:1
20722 msgid "guestfs_int_bool"
20727 #: ../src/guestfs-structs.pod:3
20730 " struct guestfs_int_bool {\n"
20739 #: ../src/guestfs-structs.pod:8
20742 " struct guestfs_int_bool_list {\n"
20743 " uint32_t len; /* Number of elements in list. */\n"
20744 " struct guestfs_int_bool *val; /* Elements. */\n"
20751 #: ../src/guestfs-structs.pod:13
20754 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20755 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20761 #: ../src/guestfs-structs.pod:16
20762 msgid "guestfs_lvm_pv"
20767 #: ../src/guestfs-structs.pod:18
20770 " struct guestfs_lvm_pv {\n"
20771 " char *pv_name;\n"
20772 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20773 " char pv_uuid[32];\n"
20775 " uint64_t pv_size;\n"
20776 " uint64_t dev_size;\n"
20777 " uint64_t pv_free;\n"
20778 " uint64_t pv_used;\n"
20779 " char *pv_attr;\n"
20780 " int64_t pv_pe_count;\n"
20781 " int64_t pv_pe_alloc_count;\n"
20782 " char *pv_tags;\n"
20783 " uint64_t pe_start;\n"
20784 " int64_t pv_mda_count;\n"
20785 " uint64_t pv_mda_free;\n"
20792 #: ../src/guestfs-structs.pod:36
20795 " struct guestfs_lvm_pv_list {\n"
20796 " uint32_t len; /* Number of elements in list. */\n"
20797 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20804 #: ../src/guestfs-structs.pod:41
20807 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20808 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20814 #: ../src/guestfs-structs.pod:44
20815 msgid "guestfs_lvm_vg"
20820 #: ../src/guestfs-structs.pod:46
20823 " struct guestfs_lvm_vg {\n"
20824 " char *vg_name;\n"
20825 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20826 " char vg_uuid[32];\n"
20828 " char *vg_attr;\n"
20829 " uint64_t vg_size;\n"
20830 " uint64_t vg_free;\n"
20831 " char *vg_sysid;\n"
20832 " uint64_t vg_extent_size;\n"
20833 " int64_t vg_extent_count;\n"
20834 " int64_t vg_free_count;\n"
20835 " int64_t max_lv;\n"
20836 " int64_t max_pv;\n"
20837 " int64_t pv_count;\n"
20838 " int64_t lv_count;\n"
20839 " int64_t snap_count;\n"
20840 " int64_t vg_seqno;\n"
20841 " char *vg_tags;\n"
20842 " int64_t vg_mda_count;\n"
20843 " uint64_t vg_mda_free;\n"
20850 #: ../src/guestfs-structs.pod:69
20853 " struct guestfs_lvm_vg_list {\n"
20854 " uint32_t len; /* Number of elements in list. */\n"
20855 " struct guestfs_lvm_vg *val; /* Elements. */\n"
20862 #: ../src/guestfs-structs.pod:74
20865 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
20866 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
20872 #: ../src/guestfs-structs.pod:77
20873 msgid "guestfs_lvm_lv"
20878 #: ../src/guestfs-structs.pod:79
20881 " struct guestfs_lvm_lv {\n"
20882 " char *lv_name;\n"
20883 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20884 " char lv_uuid[32];\n"
20885 " char *lv_attr;\n"
20886 " int64_t lv_major;\n"
20887 " int64_t lv_minor;\n"
20888 " int64_t lv_kernel_major;\n"
20889 " int64_t lv_kernel_minor;\n"
20890 " uint64_t lv_size;\n"
20891 " int64_t seg_count;\n"
20893 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20894 " float snap_percent;\n"
20895 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20896 " float copy_percent;\n"
20897 " char *move_pv;\n"
20898 " char *lv_tags;\n"
20899 " char *mirror_log;\n"
20900 " char *modules;\n"
20907 #: ../src/guestfs-structs.pod:101
20910 " struct guestfs_lvm_lv_list {\n"
20911 " uint32_t len; /* Number of elements in list. */\n"
20912 " struct guestfs_lvm_lv *val; /* Elements. */\n"
20919 #: ../src/guestfs-structs.pod:106
20922 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
20923 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
20929 #: ../src/guestfs-structs.pod:111
20932 " struct guestfs_stat {\n"
20936 " int64_t nlink;\n"
20941 " int64_t blksize;\n"
20942 " int64_t blocks;\n"
20943 " int64_t atime;\n"
20944 " int64_t mtime;\n"
20945 " int64_t ctime;\n"
20952 #: ../src/guestfs-structs.pod:127
20955 " struct guestfs_stat_list {\n"
20956 " uint32_t len; /* Number of elements in list. */\n"
20957 " struct guestfs_stat *val; /* Elements. */\n"
20964 #: ../src/guestfs-structs.pod:132
20967 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
20968 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
20974 #: ../src/guestfs-structs.pod:137
20977 " struct guestfs_statvfs {\n"
20978 " int64_t bsize;\n"
20979 " int64_t frsize;\n"
20980 " int64_t blocks;\n"
20981 " int64_t bfree;\n"
20982 " int64_t bavail;\n"
20983 " int64_t files;\n"
20984 " int64_t ffree;\n"
20985 " int64_t favail;\n"
20988 " int64_t namemax;\n"
20995 #: ../src/guestfs-structs.pod:151
20998 " struct guestfs_statvfs_list {\n"
20999 " uint32_t len; /* Number of elements in list. */\n"
21000 " struct guestfs_statvfs *val; /* Elements. */\n"
21007 #: ../src/guestfs-structs.pod:156
21010 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21011 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21017 #: ../src/guestfs-structs.pod:159
21018 msgid "guestfs_dirent"
21023 #: ../src/guestfs-structs.pod:161
21026 " struct guestfs_dirent {\n"
21036 #: ../src/guestfs-structs.pod:167
21039 " struct guestfs_dirent_list {\n"
21040 " uint32_t len; /* Number of elements in list. */\n"
21041 " struct guestfs_dirent *val; /* Elements. */\n"
21048 #: ../src/guestfs-structs.pod:172
21051 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21052 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21058 #: ../src/guestfs-structs.pod:177
21061 " struct guestfs_version {\n"
21062 " int64_t major;\n"
21063 " int64_t minor;\n"
21064 " int64_t release;\n"
21072 #: ../src/guestfs-structs.pod:184
21075 " struct guestfs_version_list {\n"
21076 " uint32_t len; /* Number of elements in list. */\n"
21077 " struct guestfs_version *val; /* Elements. */\n"
21084 #: ../src/guestfs-structs.pod:189
21087 " void guestfs_free_version (struct guestfs_free_version *);\n"
21088 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21094 #: ../src/guestfs-structs.pod:192
21095 msgid "guestfs_xattr"
21100 #: ../src/guestfs-structs.pod:194
21103 " struct guestfs_xattr {\n"
21104 " char *attrname;\n"
21105 " /* The next two fields describe a byte array. */\n"
21106 " uint32_t attrval_len;\n"
21107 " char *attrval;\n"
21114 #: ../src/guestfs-structs.pod:201
21117 " struct guestfs_xattr_list {\n"
21118 " uint32_t len; /* Number of elements in list. */\n"
21119 " struct guestfs_xattr *val; /* Elements. */\n"
21126 #: ../src/guestfs-structs.pod:206
21129 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21130 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21136 #: ../src/guestfs-structs.pod:209
21137 msgid "guestfs_inotify_event"
21142 #: ../src/guestfs-structs.pod:211
21145 " struct guestfs_inotify_event {\n"
21146 " int64_t in_wd;\n"
21147 " uint32_t in_mask;\n"
21148 " uint32_t in_cookie;\n"
21149 " char *in_name;\n"
21156 #: ../src/guestfs-structs.pod:218
21159 " struct guestfs_inotify_event_list {\n"
21160 " uint32_t len; /* Number of elements in list. */\n"
21161 " struct guestfs_inotify_event *val; /* Elements. */\n"
21168 #: ../src/guestfs-structs.pod:223
21171 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21172 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21178 #: ../src/guestfs-structs.pod:226
21179 msgid "guestfs_partition"
21184 #: ../src/guestfs-structs.pod:228
21187 " struct guestfs_partition {\n"
21188 " int32_t part_num;\n"
21189 " uint64_t part_start;\n"
21190 " uint64_t part_end;\n"
21191 " uint64_t part_size;\n"
21198 #: ../src/guestfs-structs.pod:235
21201 " struct guestfs_partition_list {\n"
21202 " uint32_t len; /* Number of elements in list. */\n"
21203 " struct guestfs_partition *val; /* Elements. */\n"
21210 #: ../src/guestfs-structs.pod:240
21213 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21214 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21220 #: ../src/guestfs-structs.pod:243
21221 msgid "guestfs_application"
21226 #: ../src/guestfs-structs.pod:245
21229 " struct guestfs_application {\n"
21230 " char *app_name;\n"
21231 " char *app_display_name;\n"
21232 " int32_t app_epoch;\n"
21233 " char *app_version;\n"
21234 " char *app_release;\n"
21235 " char *app_install_path;\n"
21236 " char *app_trans_path;\n"
21237 " char *app_publisher;\n"
21238 " char *app_url;\n"
21239 " char *app_source_package;\n"
21240 " char *app_summary;\n"
21241 " char *app_description;\n"
21248 #: ../src/guestfs-structs.pod:260
21251 " struct guestfs_application_list {\n"
21252 " uint32_t len; /* Number of elements in list. */\n"
21253 " struct guestfs_application *val; /* Elements. */\n"
21260 #: ../src/guestfs-structs.pod:265
21263 " void guestfs_free_application (struct guestfs_free_application *);\n"
21264 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21270 #: ../fish/guestfish.pod:5
21271 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21276 #: ../fish/guestfish.pod:9
21279 " guestfish [--options] [commands]\n"
21285 #: ../fish/guestfish.pod:11
21294 #: ../fish/guestfish.pod:13
21297 " guestfish [--ro|--rw] -a disk.img\n"
21303 #: ../fish/guestfish.pod:15
21306 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21312 #: ../fish/guestfish.pod:17
21315 " guestfish -d libvirt-domain\n"
21321 #: ../fish/guestfish.pod:19
21324 " guestfish [--ro|--rw] -a disk.img -i\n"
21330 #: ../fish/guestfish.pod:21
21333 " guestfish -d libvirt-domain -i\n"
21339 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21340 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21346 #: ../fish/guestfish.pod:25
21348 "Using guestfish in read/write mode on live virtual machines can be "
21349 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21350 "option to use guestfish safely if the disk image or virtual machine might be "
21356 #: ../fish/guestfish.pod:32
21358 "Guestfish is a shell and command-line tool for examining and modifying "
21359 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21360 "functionality of the guestfs API, see L<guestfs(3)>."
21365 #: ../fish/guestfish.pod:36
21367 "Guestfish gives you structured access to the libguestfs API, from shell "
21368 "scripts or the command line or interactively. If you want to rescue a "
21369 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21375 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942
21376 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
21382 #: ../fish/guestfish.pod:43
21383 msgid "As an interactive shell"
21388 #: ../fish/guestfish.pod:45
21397 #: ../fish/guestfish.pod:47
21400 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21401 " editing virtual machine filesystems.\n"
21407 #: ../fish/guestfish.pod:50
21410 " Type: 'help' for a list of commands\n"
21411 " 'man' to read the manual\n"
21412 " 'quit' to quit the shell\n"
21418 #: ../fish/guestfish.pod:54
21421 " ><fs> add-ro disk.img\n"
21423 " ><fs> list-filesystems\n"
21424 " /dev/sda1: ext4\n"
21425 " /dev/vg_guest/lv_root: ext4\n"
21426 " /dev/vg_guest/lv_swap: swap\n"
21427 " ><fs> mount /dev/vg_guest/lv_root /\n"
21428 " ><fs> cat /etc/fstab\n"
21430 " # Created by anaconda\n"
21438 #: ../fish/guestfish.pod:67
21439 msgid "From shell scripts"
21444 #: ../fish/guestfish.pod:69
21445 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21450 #: ../fish/guestfish.pod:71
21453 " guestfish <<_EOF_\n"
21456 " mount /dev/vg_guest/lv_root /\n"
21457 " write /etc/motd \"Welcome, new users\"\n"
21464 #: ../fish/guestfish.pod:78
21465 msgid "List the LVM logical volumes in a disk image:"
21470 #: ../fish/guestfish.pod:80
21473 " guestfish -a disk.img --ro <<_EOF_\n"
21482 #: ../fish/guestfish.pod:85
21483 msgid "List all the filesystems in a disk image:"
21488 #: ../fish/guestfish.pod:87
21491 " guestfish -a disk.img --ro <<_EOF_\n"
21493 " list-filesystems\n"
21500 #: ../fish/guestfish.pod:92
21501 msgid "On one command line"
21506 #: ../fish/guestfish.pod:94
21507 msgid "Update C</etc/resolv.conf> in a guest:"
21512 #: ../fish/guestfish.pod:96
21516 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21517 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21523 #: ../fish/guestfish.pod:100
21524 msgid "Edit C</boot/grub/grub.conf> interactively:"
21529 #: ../fish/guestfish.pod:102
21532 " guestfish --rw --add disk.img \\\n"
21533 " --mount /dev/vg_guest/lv_root \\\n"
21534 " --mount /dev/sda1:/boot \\\n"
21535 " edit /boot/grub/grub.conf\n"
21541 #: ../fish/guestfish.pod:107
21542 msgid "Mount disks automatically"
21547 #: ../fish/guestfish.pod:109
21549 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21554 #: ../fish/guestfish.pod:112
21557 " guestfish --ro -a disk.img -i cat /etc/group\n"
21563 #: ../fish/guestfish.pod:114
21566 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21572 #: ../fish/guestfish.pod:116
21573 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21578 #: ../fish/guestfish.pod:118
21581 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21587 #: ../fish/guestfish.pod:120
21588 msgid "As a script interpreter"
21593 #: ../fish/guestfish.pod:122
21594 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21599 #: ../fish/guestfish.pod:124
21602 " #!/usr/bin/guestfish -f\n"
21603 " sparse test1.img 100M\n"
21605 " part-disk /dev/sda mbr\n"
21606 " mkfs ext2 /dev/sda1\n"
21612 #: ../fish/guestfish.pod:130
21613 msgid "Start with a prepared disk"
21618 #: ../fish/guestfish.pod:132
21620 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21621 "single ext2-formatted partition:"
21626 #: ../fish/guestfish.pod:135
21629 " guestfish -N fs\n"
21635 #: ../fish/guestfish.pod:137
21636 msgid "To list what is available do:"
21641 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
21644 " guestfish -N help | less\n"
21650 #: ../fish/guestfish.pod:141
21651 msgid "Remote control"
21656 #: ../fish/guestfish.pod:143
21659 " eval \"`guestfish --listen`\"\n"
21660 " guestfish --remote add-ro disk.img\n"
21661 " guestfish --remote run\n"
21662 " guestfish --remote lvs\n"
21668 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21669 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
21670 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
21671 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
21672 #: ../tools/virt-list-partitions.pl:54
21678 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21679 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21680 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
21681 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
21687 #: ../fish/guestfish.pod:154
21688 msgid "Displays general help on options."
21693 #: ../fish/guestfish.pod:156
21699 #: ../fish/guestfish.pod:158
21700 msgid "B<--cmd-help>"
21705 #: ../fish/guestfish.pod:160
21706 msgid "Lists all available guestfish commands."
21711 #: ../fish/guestfish.pod:162
21717 #: ../fish/guestfish.pod:164
21718 msgid "B<--cmd-help cmd>"
21723 #: ../fish/guestfish.pod:166
21724 msgid "Displays detailed help on a single command C<cmd>."
21729 #: ../fish/guestfish.pod:168
21730 msgid "B<-a image>"
21735 #: ../fish/guestfish.pod:170
21736 msgid "B<--add image>"
21741 #: ../fish/guestfish.pod:172
21742 msgid "Add a block device or virtual machine image to the shell."
21747 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21749 "The format of the disk image is auto-detected. To override this and force a "
21750 "particular format use the I<--format=..> option."
21755 #: ../fish/guestfish.pod:177
21757 "Using this flag is mostly equivalent to using the C<add> command, with "
21758 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21759 "the I<--format:...> flag was given."
21764 #: ../fish/guestfish.pod:181
21770 #: ../fish/guestfish.pod:183
21771 msgid "B<--connect URI>"
21776 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21778 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21779 "URI to use. The default is to use the default libvirt connection."
21784 #: ../fish/guestfish.pod:189
21790 #: ../fish/guestfish.pod:191
21792 "If using the I<--listen> option and a csh-like shell, use this option. See "
21793 "section L</REMOTE CONTROL AND CSH> below."
21798 #: ../fish/guestfish.pod:194
21799 msgid "B<-d libvirt-domain>"
21804 #: ../fish/guestfish.pod:196
21805 msgid "B<--domain libvirt-domain>"
21810 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21812 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21813 "used, then any libvirt domain can be used. However in write mode, only "
21814 "libvirt domains which are shut down can be named here."
21819 #: ../fish/guestfish.pod:202
21821 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21822 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21823 "if the I<--format:...> flag was given."
21828 #: ../fish/guestfish.pod:206
21834 #: ../fish/guestfish.pod:208
21835 msgid "B<--no-dest-paths>"
21840 #: ../fish/guestfish.pod:210
21842 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21843 "to hit the tab key to complete paths on the guest filesystem, but this "
21844 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21845 "allow this feature to be disabled."
21850 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
21851 msgid "B<--echo-keys>"
21856 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
21858 "When prompting for keys and passphrases, guestfish normally turns echoing "
21859 "off so you cannot see what you are typing. If you are not worried about "
21860 "Tempest attacks and there is no one else in the room you can specify this "
21861 "flag to see what you are typing."
21866 #: ../fish/guestfish.pod:222
21872 #: ../fish/guestfish.pod:224
21873 msgid "B<--file file>"
21878 #: ../fish/guestfish.pod:226
21879 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21884 #: ../fish/guestfish.pod:229
21887 " #!/usr/bin/guestfish -f\n"
21893 #: ../fish/guestfish.pod:231
21894 msgid "B<--format=raw|qcow2|..>"
21899 #: ../fish/guestfish.pod:233
21900 msgid "B<--format>"
21905 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
21907 "The default for the I<-a> option is to auto-detect the format of the disk "
21908 "image. Using this forces the disk format for I<-a> options which follow on "
21909 "the command line. Using I<--format> with no argument switches back to auto-"
21910 "detection for subsequent I<-a> options."
21915 #: ../fish/guestfish.pod:242
21918 " guestfish --format=raw -a disk.img\n"
21924 #: ../fish/guestfish.pod:244
21925 msgid "forces raw format (no auto-detection) for C<disk.img>."
21930 #: ../fish/guestfish.pod:246
21933 " guestfish --format=raw -a disk.img --format -a another.img\n"
21939 #: ../fish/guestfish.pod:248
21941 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
21942 "detection for C<another.img>."
21947 #: ../fish/guestfish.pod:251
21949 "If you have untrusted raw-format guest disk images, you should use this "
21950 "option to specify the disk format. This avoids a possible security problem "
21951 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21956 #: ../fish/guestfish.pod:256
21962 #: ../fish/guestfish.pod:258
21963 msgid "B<--inspector>"
21968 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
21970 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21971 "system and mount filesystems as they would be mounted on the real virtual "
21977 #: ../fish/guestfish.pod:264
21978 msgid "Typical usage is either:"
21983 #: ../fish/guestfish.pod:266
21986 " guestfish -d myguest -i\n"
21992 #: ../fish/guestfish.pod:268
21993 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21998 #: ../fish/guestfish.pod:270
22001 " guestfish --ro -d myguest -i\n"
22007 #: ../fish/guestfish.pod:272
22008 msgid "(for active domains, readonly), or specify the block device directly:"
22013 #: ../fish/guestfish.pod:274
22016 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22022 #: ../fish/guestfish.pod:276
22024 "Note that the command line syntax changed slightly over older versions of "
22025 "guestfish. You can still use the old syntax:"
22030 #: ../fish/guestfish.pod:279
22033 " guestfish [--ro] -i disk.img\n"
22039 #: ../fish/guestfish.pod:281
22042 " guestfish [--ro] -i libvirt-domain\n"
22048 #: ../fish/guestfish.pod:283
22050 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22051 "then using other commands to mount the filesystems that were found."
22056 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
22057 msgid "B<--keys-from-stdin>"
22062 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
22064 "Read key or passphrase parameters from stdin. The default is to try to read "
22065 "passphrases from the user by opening C</dev/tty>."
22070 #: ../fish/guestfish.pod:292
22071 msgid "B<--listen>"
22076 #: ../fish/guestfish.pod:294
22078 "Fork into the background and listen for remote commands. See section L</"
22079 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22083 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
22088 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
22090 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22091 "ATTACHING TO RUNNING DAEMONS>)."
22095 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
22096 msgid "B<-m dev[:mountpoint[:options]]>"
22100 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
22101 msgid "B<--mount dev[:mountpoint[:options]]>"
22106 #: ../fish/guestfish.pod:306
22107 msgid "Mount the named partition or logical volume on the given mountpoint."
22112 #: ../fish/guestfish.pod:308
22113 msgid "If the mountpoint is omitted, it defaults to C</>."
22118 #: ../fish/guestfish.pod:310
22119 msgid "You have to mount something on C</> before most commands will work."
22124 #: ../fish/guestfish.pod:312
22126 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22132 #: ../fish/guestfish.pod:315
22134 "If you don't know what filesystems a disk image contains, you can either run "
22135 "guestfish without this option, then list the partitions, filesystems and LVs "
22136 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22137 "commands), or you can use the L<virt-filesystems(1)> program."
22141 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
22143 "The third (and rarely used) part of the mount parameter is the list of mount "
22144 "options used to mount the underlying filesystem. If this is not given, then "
22145 "the mount options are either the empty string or C<ro> (the latter if the "
22146 "I<--ro> flag is used). By specifying the mount options, you override this "
22147 "default choice. Probably the only time you would use this is to enable ACLs "
22148 "and/or extended attributes if the filesystem can support them:"
22152 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
22155 " -m /dev/sda1:/:acl,user_xattr\n"
22160 #: ../fish/guestfish.pod:331
22161 msgid "Using this flag is equivalent to using the C<mount-options> command."
22166 #: ../fish/guestfish.pod:333
22172 #: ../fish/guestfish.pod:335
22173 msgid "B<--no-sync>"
22178 #: ../fish/guestfish.pod:337
22180 "Disable autosync. This is enabled by default. See the discussion of "
22181 "autosync in the L<guestfs(3)> manpage."
22186 #: ../fish/guestfish.pod:340
22192 #: ../fish/guestfish.pod:342
22193 msgid "B<--new type>"
22198 #: ../fish/guestfish.pod:344
22204 #: ../fish/guestfish.pod:346
22206 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22207 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22208 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22214 #: ../fish/guestfish.pod:351
22215 msgid "B<--progress-bars>"
22220 #: ../fish/guestfish.pod:353
22221 msgid "Enable progress bars, even when guestfish is used non-interactively."
22226 #: ../fish/guestfish.pod:355
22228 "Progress bars are enabled by default when guestfish is used as an "
22229 "interactive shell."
22234 #: ../fish/guestfish.pod:358
22235 msgid "B<--no-progress-bars>"
22240 #: ../fish/guestfish.pod:360
22241 msgid "Disable progress bars."
22246 #: ../fish/guestfish.pod:362
22247 msgid "B<--remote[=pid]>"
22252 #: ../fish/guestfish.pod:364
22254 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22255 "CONTROL GUESTFISH OVER A SOCKET> below."
22260 #: ../fish/guestfish.pod:367
22266 #: ../fish/guestfish.pod:369
22272 #: ../fish/guestfish.pod:371
22274 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22275 "mounts are done read-only."
22280 #: ../fish/guestfish.pod:374
22282 "The option must always be used if the disk image or virtual machine might be "
22283 "running, and is generally recommended in cases where you don't need write "
22284 "access to the disk."
22289 #: ../fish/guestfish.pod:378
22291 "Note that prepared disk images created with I<-N> are not affected by this "
22292 "option. Also commands like C<add> are not affected - you have to specify "
22293 "the C<readonly:true> option explicitly if you need it."
22298 #: ../fish/guestfish.pod:382
22299 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22304 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
22305 msgid "B<--selinux>"
22310 #: ../fish/guestfish.pod:386
22311 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22316 #: ../fish/guestfish.pod:388
22322 #: ../fish/guestfish.pod:390
22323 msgid "B<--verbose>"
22328 #: ../fish/guestfish.pod:392
22330 "Enable very verbose messages. This is particularly useful if you find a bug."
22335 #: ../fish/guestfish.pod:395
22341 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
22342 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
22343 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
22344 #: ../tools/virt-list-partitions.pl:70
22345 msgid "B<--version>"
22350 #: ../fish/guestfish.pod:399
22351 msgid "Display the guestfish / libguestfs version number and exit."
22356 #: ../fish/guestfish.pod:401
22362 #: ../fish/guestfish.pod:403
22367 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
22369 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22370 "mounts are done read-write."
22374 #: ../fish/guestfish.pod:408
22375 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22380 #: ../fish/guestfish.pod:410
22386 #: ../fish/guestfish.pod:412
22387 msgid "Echo each command before executing it."
22392 #: ../fish/guestfish.pod:416
22393 msgid "COMMANDS ON COMMAND LINE"
22398 #: ../fish/guestfish.pod:418
22400 "Any additional (non-option) arguments are treated as commands to execute."
22405 #: ../fish/guestfish.pod:421
22407 "Commands to execute should be separated by a colon (C<:>), where the colon "
22408 "is a separate parameter. Thus:"
22413 #: ../fish/guestfish.pod:424
22416 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22422 #: ../fish/guestfish.pod:426
22424 "If there are no additional arguments, then we enter a shell, either an "
22425 "interactive shell with a prompt (if the input is a terminal) or a non-"
22426 "interactive shell."
22431 #: ../fish/guestfish.pod:430
22433 "In either command line mode or non-interactive shell, the first command that "
22434 "gives an error causes the whole shell to exit. In interactive mode (with a "
22435 "prompt) if a command fails, you can continue to enter commands."
22440 #: ../fish/guestfish.pod:435
22441 msgid "USING launch (OR run)"
22446 #: ../fish/guestfish.pod:437
22448 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22449 "then launch it, then mount any disks you need, and finally issue actions/"
22450 "commands. So the general order of the day is:"
22455 #: ../fish/guestfish.pod:445
22456 msgid "add or -a/--add"
22461 #: ../fish/guestfish.pod:449
22462 msgid "launch (aka run)"
22467 #: ../fish/guestfish.pod:453
22468 msgid "mount or -m/--mount"
22473 #: ../fish/guestfish.pod:457
22474 msgid "any other commands"
22479 #: ../fish/guestfish.pod:461
22481 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22482 "guest before mounting or performing any other commands."
22487 #: ../fish/guestfish.pod:464
22489 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22490 "I<--new> options were given then C<run> is done automatically, simply "
22491 "because guestfish can't perform the action you asked for without doing this."
22496 #: ../fish/guestfish.pod:469
22497 msgid "OPENING DISKS FOR READ AND WRITE"
22501 #: ../fish/guestfish.pod:471
22503 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22504 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22505 "I<-i> and I<-m> open disk images read-only or for writing."
22509 #: ../fish/guestfish.pod:476
22511 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
22512 "opening disk images supplied on the command line for write. To open a disk "
22513 "image read-only you have to do I<-a image --ro>."
22518 #: ../fish/guestfish.pod:480
22520 "This matters: If you accidentally open a live VM disk image writable then "
22521 "you will cause irreversible disk corruption."
22525 #: ../fish/guestfish.pod:483
22527 "By libguestfs 1.10 we intend to change the default the other way. Disk "
22528 "images will be opened read-only. You will have to either specify "
22529 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22530 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22531 "access for disk images specified by those other command line options."
22535 #: ../fish/guestfish.pod:490
22537 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22538 "which does nothing (it is already the default). However it is highly "
22539 "recommended that you use this option to indicate that you need write access, "
22540 "and prepare your scripts for the day when this option will be required for "
22546 #: ../fish/guestfish.pod:496
22548 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22549 "other libguestfs program apart from guestfish and guestmount."
22554 #: ../fish/guestfish.pod:499
22560 #: ../fish/guestfish.pod:501
22562 "You can quote ordinary parameters using either single or double quotes. For "
22568 #: ../fish/guestfish.pod:504
22571 " add \"file with a space.img\"\n"
22577 #: ../fish/guestfish.pod:506
22580 " rm '/file name'\n"
22586 #: ../fish/guestfish.pod:508
22595 #: ../fish/guestfish.pod:510
22597 "A few commands require a list of strings to be passed. For these, use a "
22598 "whitespace-separated list, enclosed in quotes. Strings containing "
22599 "whitespace to be passed through must be enclosed in single quotes. A "
22600 "literal single quote must be escaped with a backslash."
22605 #: ../fish/guestfish.pod:515
22608 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22609 " command \"/bin/echo 'foo bar'\"\n"
22610 " command \"/bin/echo \\'foo\\'\"\n"
22616 #: ../fish/guestfish.pod:519
22617 msgid "OPTIONAL ARGUMENTS"
22622 #: ../fish/guestfish.pod:521
22624 "Some commands take optional arguments. These arguments appear in this "
22625 "documentation as C<[argname:..]>. You can use them as in these examples:"
22630 #: ../fish/guestfish.pod:525
22633 " add-drive-opts filename\n"
22639 #: ../fish/guestfish.pod:527
22642 " add-drive-opts filename readonly:true\n"
22648 #: ../fish/guestfish.pod:529
22651 " add-drive-opts filename format:qcow2 readonly:false\n"
22657 #: ../fish/guestfish.pod:531
22659 "Each optional argument can appear at most once. All optional arguments must "
22660 "appear after the required ones."
22665 #: ../fish/guestfish.pod:534
22671 #: ../fish/guestfish.pod:536
22673 "This section applies to all commands which can take integers as parameters."
22678 #: ../fish/guestfish.pod:539
22679 msgid "SIZE SUFFIX"
22684 #: ../fish/guestfish.pod:541
22686 "When the command takes a parameter measured in bytes, you can use one of the "
22687 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22692 #: ../fish/guestfish.pod:547
22693 msgid "B<k> or B<K> or B<KiB>"
22698 #: ../fish/guestfish.pod:549
22699 msgid "The size in kilobytes (multiplied by 1024)."
22704 #: ../fish/guestfish.pod:551
22710 #: ../fish/guestfish.pod:553
22711 msgid "The size in SI 1000 byte units."
22716 #: ../fish/guestfish.pod:555
22717 msgid "B<M> or B<MiB>"
22722 #: ../fish/guestfish.pod:557
22723 msgid "The size in megabytes (multiplied by 1048576)."
22728 #: ../fish/guestfish.pod:559
22734 #: ../fish/guestfish.pod:561
22735 msgid "The size in SI 1000000 byte units."
22740 #: ../fish/guestfish.pod:563
22741 msgid "B<G> or B<GiB>"
22746 #: ../fish/guestfish.pod:565
22747 msgid "The size in gigabytes (multiplied by 2**30)."
22752 #: ../fish/guestfish.pod:567
22758 #: ../fish/guestfish.pod:569
22759 msgid "The size in SI 10**9 byte units."
22764 #: ../fish/guestfish.pod:571
22765 msgid "B<T> or B<TiB>"
22770 #: ../fish/guestfish.pod:573
22771 msgid "The size in terabytes (multiplied by 2**40)."
22776 #: ../fish/guestfish.pod:575
22782 #: ../fish/guestfish.pod:577
22783 msgid "The size in SI 10**12 byte units."
22788 #: ../fish/guestfish.pod:579
22789 msgid "B<P> or B<PiB>"
22794 #: ../fish/guestfish.pod:581
22795 msgid "The size in petabytes (multiplied by 2**50)."
22800 #: ../fish/guestfish.pod:583
22806 #: ../fish/guestfish.pod:585
22807 msgid "The size in SI 10**15 byte units."
22812 #: ../fish/guestfish.pod:587
22813 msgid "B<E> or B<EiB>"
22818 #: ../fish/guestfish.pod:589
22819 msgid "The size in exabytes (multiplied by 2**60)."
22824 #: ../fish/guestfish.pod:591
22830 #: ../fish/guestfish.pod:593
22831 msgid "The size in SI 10**18 byte units."
22836 #: ../fish/guestfish.pod:595
22837 msgid "B<Z> or B<ZiB>"
22842 #: ../fish/guestfish.pod:597
22843 msgid "The size in zettabytes (multiplied by 2**70)."
22848 #: ../fish/guestfish.pod:599
22854 #: ../fish/guestfish.pod:601
22855 msgid "The size in SI 10**21 byte units."
22860 #: ../fish/guestfish.pod:603
22861 msgid "B<Y> or B<YiB>"
22866 #: ../fish/guestfish.pod:605
22867 msgid "The size in yottabytes (multiplied by 2**80)."
22872 #: ../fish/guestfish.pod:607
22878 #: ../fish/guestfish.pod:609
22879 msgid "The size in SI 10**24 byte units."
22884 #: ../fish/guestfish.pod:615
22887 " truncate-size /file 1G\n"
22893 #: ../fish/guestfish.pod:617
22894 msgid "would truncate the file to 1 gigabyte."
22899 #: ../fish/guestfish.pod:619
22901 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22902 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22903 "suffix will probably not do what you expect."
22908 #: ../fish/guestfish.pod:623
22909 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22914 #: ../fish/guestfish.pod:625
22916 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22917 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22922 #: ../fish/guestfish.pod:628
22925 " 1234 decimal number 1234\n"
22926 " 02322 octal number, equivalent to decimal 1234\n"
22927 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22933 #: ../fish/guestfish.pod:632
22935 "When using the C<chmod> command, you almost always want to specify an octal "
22936 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22937 "L<chmod(1)> program):"
22942 #: ../fish/guestfish.pod:636
22945 " chmod 0777 /public # OK\n"
22946 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22952 #: ../fish/guestfish.pod:639
22954 "Commands that return numbers usually print them in decimal, but some "
22955 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22956 "octal, preceeded by C<0>)."
22961 #: ../fish/guestfish.pod:643
22962 msgid "WILDCARDS AND GLOBBING"
22967 #: ../fish/guestfish.pod:645
22969 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22970 "(globbing) by default. So for example the following will not do what you "
22976 #: ../fish/guestfish.pod:649
22985 #: ../fish/guestfish.pod:651
22987 "Assuming you don't have a directory called literally C</home/*> then the "
22988 "above command will return an error."
22993 #: ../fish/guestfish.pod:654
22994 msgid "To perform wildcard expansion, use the C<glob> command."
22999 #: ../fish/guestfish.pod:656
23002 " glob rm-rf /home/*\n"
23008 #: ../fish/guestfish.pod:658
23010 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23011 "many times), equivalent to:"
23016 #: ../fish/guestfish.pod:661
23019 " rm-rf /home/jim\n"
23020 " rm-rf /home/joe\n"
23021 " rm-rf /home/mary\n"
23027 #: ../fish/guestfish.pod:665
23028 msgid "C<glob> only works on simple guest paths and not on device names."
23033 #: ../fish/guestfish.pod:667
23035 "If you have several parameters, each containing a wildcard, then glob will "
23036 "perform a Cartesian product."
23041 #: ../fish/guestfish.pod:670
23047 #: ../fish/guestfish.pod:672
23049 "Any line which starts with a I<#> character is treated as a comment and "
23050 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23051 "a command. For example:"
23056 #: ../fish/guestfish.pod:676
23059 " # this is a comment\n"
23060 " # this is a comment\n"
23061 " foo # NOT a comment\n"
23067 #: ../fish/guestfish.pod:680
23068 msgid "Blank lines are also ignored."
23073 #: ../fish/guestfish.pod:682
23074 msgid "RUNNING COMMANDS LOCALLY"
23079 #: ../fish/guestfish.pod:684
23081 "Any line which starts with a I<!> character is treated as a command sent to "
23082 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23087 #: ../fish/guestfish.pod:688
23091 " tgz-out /remote local/remote-data.tar.gz\n"
23097 #: ../fish/guestfish.pod:691
23099 "will create a directory C<local> on the host, and then export the contents "
23100 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23101 "(See C<tgz-out>)."
23106 #: ../fish/guestfish.pod:695
23108 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23109 "effect, due to the way that subprocesses work in Unix."
23113 #: ../fish/guestfish.pod:698
23114 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23118 #: ../fish/guestfish.pod:700
23120 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23121 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23122 "and executed as guestfish commands."
23126 #: ../fish/guestfish.pod:704
23128 "Thus you can use shell script to construct arbitrary guestfish commands "
23129 "which are then parsed by guestfish."
23133 #: ../fish/guestfish.pod:707
23135 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23136 "through C</foo.100>) using guestfish commands alone. However this is simple "
23137 "if we use a shell script to create the guestfish commands for us:"
23141 #: ../fish/guestfish.pod:712
23144 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23149 #: ../fish/guestfish.pod:714
23150 msgid "or with names like C</foo.001>:"
23154 #: ../fish/guestfish.pod:716
23157 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23162 #: ../fish/guestfish.pod:718
23164 "When using guestfish interactively it can be helpful to just run the shell "
23165 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23166 "ordinary I<!> local command), see what guestfish commands it would run, and "
23167 "when you are happy with those prepend the C<E<lt>> character to run the "
23168 "guestfish commands for real."
23173 #: ../fish/guestfish.pod:724
23179 #: ../fish/guestfish.pod:726
23181 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23182 "command (a guestfish command) to the second command (any host command). For "
23188 #: ../fish/guestfish.pod:730
23191 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23197 #: ../fish/guestfish.pod:732
23199 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23200 "program). The above command would list all accounts in the guest filesystem "
23201 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23206 #: ../fish/guestfish.pod:737
23209 " hexdump /bin/ls | head\n"
23210 " list-devices | tail -1\n"
23211 " tgz-out / - | tar ztf -\n"
23217 #: ../fish/guestfish.pod:741
23219 "The space before the pipe symbol is required, any space after the pipe "
23220 "symbol is optional. Everything after the pipe symbol is just passed "
23221 "straight to the host shell, so it can contain redirections, globs and "
23222 "anything else that makes sense on the host side."
23227 #: ../fish/guestfish.pod:746
23229 "To use a literal argument which begins with a pipe symbol, you have to quote "
23235 #: ../fish/guestfish.pod:749
23244 #: ../fish/guestfish.pod:751
23245 msgid "HOME DIRECTORIES"
23250 #: ../fish/guestfish.pod:753
23252 "If a parameter starts with the character C<~> then the tilde may be expanded "
23253 "as a home directory path (either C<~> for the current user's home directory, "
23254 "or C<~user> for another user)."
23259 #: ../fish/guestfish.pod:757
23261 "Note that home directory expansion happens for users known I<on the host>, "
23262 "not in the guest filesystem."
23267 #: ../fish/guestfish.pod:760
23269 "To use a literal argument which begins with a tilde, you have to quote it, "
23275 #: ../fish/guestfish.pod:763
23284 #: ../fish/guestfish.pod:767
23286 "Libguestfs has some support for Linux guests encrypted according to the "
23287 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23288 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23289 "LUKS is supported."
23294 #: ../fish/guestfish.pod:772
23295 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23300 #: ../fish/guestfish.pod:774
23303 " ><fs> vfs-type /dev/sda2\n"
23310 #: ../fish/guestfish.pod:777
23312 "Then open those devices using L</luks-open>. This creates a device-mapper "
23313 "device called C</dev/mapper/luksdev>."
23318 #: ../fish/guestfish.pod:780
23321 " ><fs> luks-open /dev/sda2 luksdev\n"
23322 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23328 #: ../fish/guestfish.pod:783
23330 "Finally you have to tell LVM to scan for volume groups on the newly created "
23336 #: ../fish/guestfish.pod:786
23340 " vg-activate-all true\n"
23346 #: ../fish/guestfish.pod:789
23347 msgid "The logical volume(s) can now be mounted in the usual way."
23352 #: ../fish/guestfish.pod:791
23354 "Before closing a LUKS device you must unmount any logical volumes on it and "
23355 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23356 "one. Then you can close the mapper device:"
23361 #: ../fish/guestfish.pod:795
23364 " vg-activate false /dev/VG\n"
23365 " luks-close /dev/mapper/luksdev\n"
23371 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
23372 msgid "WINDOWS PATHS"
23377 #: ../fish/guestfish.pod:800
23379 "If a path is prefixed with C<win:> then you can use Windows-style paths "
23380 "(with some limitations). The following commands are equivalent:"
23385 #: ../fish/guestfish.pod:803
23388 " file /WINDOWS/system32/config/system.LOG\n"
23394 #: ../fish/guestfish.pod:805
23397 " file win:/windows/system32/config/system.log\n"
23403 #: ../fish/guestfish.pod:807
23406 " file win:\\windows\\system32\\config\\system.log\n"
23412 #: ../fish/guestfish.pod:809
23415 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
23421 #: ../fish/guestfish.pod:811
23423 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
23424 "handles case insensitivity like Windows would. This only works in argument "
23425 "positions that expect a path."
23430 #: ../fish/guestfish.pod:815
23431 msgid "UPLOADING AND DOWNLOADING FILES"
23436 #: ../fish/guestfish.pod:817
23438 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23439 "others which upload from or download to a local file, you can use the "
23440 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23445 #: ../fish/guestfish.pod:821
23454 #: ../fish/guestfish.pod:823
23456 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23461 #: ../fish/guestfish.pod:826
23464 " tar-out /etc - | tar tf -\n"
23470 #: ../fish/guestfish.pod:828
23472 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23473 "command (see L</PIPES>)."
23478 #: ../fish/guestfish.pod:831
23480 "When using C<-> to read from stdin, the input is read up to the end of "
23481 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23482 "some arbitrary end marker:"
23487 #: ../fish/guestfish.pod:835
23490 " upload -<<END /foo\n"
23500 #: ../fish/guestfish.pod:841
23502 "Any string of characters can be used instead of C<END>. The end marker must "
23503 "appear on a line of its own, without any preceeding or following characters "
23504 "(not even spaces)."
23509 #: ../fish/guestfish.pod:845
23511 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23512 "upload local files (so-called \"FileIn\" parameters in the generator)."
23517 #: ../fish/guestfish.pod:848
23518 msgid "EXIT ON ERROR BEHAVIOUR"
23523 #: ../fish/guestfish.pod:850
23525 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23526 "taking commands from a human over a tty), and will exit on the first error "
23527 "in non-interactive mode (scripts, commands given on the command line)."
23532 #: ../fish/guestfish.pod:855
23534 "If you prefix a command with a I<-> character, then that command will not "
23535 "cause guestfish to exit, even if that (one) command returns an error."
23540 #: ../fish/guestfish.pod:859
23541 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23546 #: ../fish/guestfish.pod:861
23548 "Guestfish can be remote-controlled over a socket. This is useful "
23549 "particularly in shell scripts where you want to make several different "
23550 "changes to a filesystem, but you don't want the overhead of starting up a "
23551 "guestfish process each time."
23556 #: ../fish/guestfish.pod:866
23557 msgid "Start a guestfish server process using:"
23562 #: ../fish/guestfish.pod:868
23565 " eval \"`guestfish --listen`\"\n"
23571 #: ../fish/guestfish.pod:870
23572 msgid "and then send it commands by doing:"
23577 #: ../fish/guestfish.pod:872
23580 " guestfish --remote cmd [...]\n"
23586 #: ../fish/guestfish.pod:874
23587 msgid "To cause the server to exit, send it the exit command:"
23592 #: ../fish/guestfish.pod:876
23595 " guestfish --remote exit\n"
23601 #: ../fish/guestfish.pod:878
23603 "Note that the server will normally exit if there is an error in a command. "
23604 "You can change this in the usual way. See section L</EXIT ON ERROR "
23610 #: ../fish/guestfish.pod:882
23611 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23616 #: ../fish/guestfish.pod:884
23618 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23619 "is how the I<--remote> option knows where to send the commands. You can "
23620 "have several guestfish listener processes running using:"
23625 #: ../fish/guestfish.pod:888
23628 " eval \"`guestfish --listen`\"\n"
23629 " pid1=$GUESTFISH_PID\n"
23630 " eval \"`guestfish --listen`\"\n"
23631 " pid2=$GUESTFISH_PID\n"
23633 " guestfish --remote=$pid1 cmd\n"
23634 " guestfish --remote=$pid2 cmd\n"
23640 #: ../fish/guestfish.pod:896
23641 msgid "REMOTE CONTROL AND CSH"
23646 #: ../fish/guestfish.pod:898
23648 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23654 #: ../fish/guestfish.pod:901
23657 " eval \"`guestfish --listen --csh`\"\n"
23663 #: ../fish/guestfish.pod:903
23664 msgid "REMOTE CONTROL DETAILS"
23669 #: ../fish/guestfish.pod:905
23671 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23672 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23673 "and C<$PID> is the process ID of the server."
23678 #: ../fish/guestfish.pod:909
23679 msgid "Guestfish client and server versions must match exactly."
23684 #: ../fish/guestfish.pod:911
23685 msgid "PREPARED DISK IMAGES"
23690 #: ../fish/guestfish.pod:913
23692 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23693 "preformatted disk images that guestfish can make for you to save typing. "
23694 "This is particularly useful for testing purposes. This option is used "
23695 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23696 "can be mixed with I<-a>)."
23701 #: ../fish/guestfish.pod:919
23703 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23704 "the second and so on. Existing files in the current directory are "
23710 #: ../fish/guestfish.pod:923
23712 "The type briefly describes how the disk should be sized, partitioned, how "
23713 "filesystem(s) should be created, and how content should be added. "
23714 "Optionally the type can be followed by extra parameters, separated by C<:> "
23715 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23716 "allocated disk, containing a single partition, with the partition formatted "
23717 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23723 #: ../fish/guestfish.pod:931
23724 msgid "To list the available types and any extra parameters they take, run:"
23729 #: ../fish/guestfish.pod:935
23731 "Note that the prepared filesystem is not mounted. You would usually have to "
23732 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23737 #: ../fish/guestfish.pod:939
23739 "If any I<-N> or I<--new> options are given, the guest is automatically "
23745 #: ../fish/guestfish.pod:944
23746 msgid "Create a 100MB disk with an ext4-formatted partition:"
23751 #: ../fish/guestfish.pod:946
23754 " guestfish -N fs:ext4\n"
23760 #: ../fish/guestfish.pod:948
23761 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23766 #: ../fish/guestfish.pod:950
23769 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23775 #: ../fish/guestfish.pod:952
23776 msgid "Create a blank 200MB disk:"
23781 #: ../fish/guestfish.pod:954
23784 " guestfish -N disk:200M\n"
23790 #: ../fish/guestfish.pod:956
23791 msgid "PROGRESS BARS"
23796 #: ../fish/guestfish.pod:958
23798 "Some (not all) long-running commands send progress notification messages as "
23799 "they are running. Guestfish turns these messages into progress bars."
23804 #: ../fish/guestfish.pod:962
23806 "When a command that supports progress bars takes longer than two seconds to "
23807 "run, and if progress bars are enabled, then you will see one appearing below "
23813 #: ../fish/guestfish.pod:966
23816 " ><fs> copy-size /large-file /another-file 2048M\n"
23817 " / 10% [#####-----------------------------------------] 00:30\n"
23823 #: ../fish/guestfish.pod:969
23825 "The spinner on the left hand side moves round once for every progress "
23826 "notification received from the backend. This is a (reasonably) golden "
23827 "assurance that the command is \"doing something\" even if the progress bar "
23828 "is not moving, because the command is able to send the progress "
23829 "notifications. When the bar reaches 100% and the command finishes, the "
23830 "spinner disappears."
23835 #: ../fish/guestfish.pod:976
23837 "Progress bars are enabled by default when guestfish is used interactively. "
23838 "You can enable them even for non-interactive modes using I<--progress-bars>, "
23839 "and you can disable them completely using I<--no-progress-bars>."
23844 #: ../fish/guestfish.pod:981
23845 msgid "GUESTFISH COMMANDS"
23850 #: ../fish/guestfish.pod:983
23852 "The commands in this section are guestfish convenience commands, in other "
23853 "words, they are not part of the L<guestfs(3)> API."
23858 #: ../fish/guestfish.pod:986
23864 #: ../fish/guestfish.pod:988
23874 #: ../fish/guestfish.pod:991
23875 msgid "Without any parameter, this provides general help."
23880 #: ../fish/guestfish.pod:993
23881 msgid "With a C<cmd> parameter, this displays detailed help for that command."
23886 #: ../fish/guestfish.pod:995
23887 msgid "quit | exit"
23892 #: ../fish/guestfish.pod:997
23893 msgid "This exits guestfish. You can also use C<^D> key."
23898 #: ../fish/guestfish.pod:999
23899 msgid "@FISH_COMMANDS@"
23904 #: ../fish/guestfish.pod:1001
23910 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:77
23916 #: ../fish/guestfish.pod:1007
23918 "guestfish returns 0 if the commands completed without error, or 1 if there "
23924 #: ../fish/guestfish.pod:1014
23930 #: ../fish/guestfish.pod:1016
23932 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23938 #: ../fish/guestfish.pod:1019
23939 msgid "GUESTFISH_PID"
23944 #: ../fish/guestfish.pod:1021
23946 "Used with the I<--remote> option to specify the remote guestfish process to "
23947 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23952 #: ../fish/guestfish.pod:1025
23958 #: ../fish/guestfish.pod:1027
23960 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23961 "not specified, the external L<hexedit(1)> program is used."
23966 #: ../fish/guestfish.pod:1031
23972 #: ../fish/guestfish.pod:1033
23974 "If compiled with GNU readline support, various files in the home directory "
23975 "can be used. See L</FILES>."
23980 #: ../fish/guestfish.pod:1042
23982 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23983 "effect as using the B<-v> option."
23988 #: ../fish/guestfish.pod:1054
23990 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23991 "the discussion of paths in L<guestfs(3)>."
23996 #: ../fish/guestfish.pod:1065
23997 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24002 #: ../fish/guestfish.pod:1067
24008 #: ../fish/guestfish.pod:1069
24010 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24016 #: ../fish/guestfish.pod:1085 ../fuse/guestmount.pod:252
24021 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
24022 msgid "$HOME/.libguestfs-tools.rc"
24026 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
24027 msgid "/etc/libguestfs-tools.conf"
24031 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
24033 "This configuration file controls the default read-only or read-write mode "
24034 "(I<--ro> or I<--rw>)."
24038 #: ../fish/guestfish.pod:1096
24039 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24044 #: ../fish/guestfish.pod:1098
24045 msgid "$HOME/.guestfish"
24050 #: ../fish/guestfish.pod:1100
24052 "If compiled with GNU readline support, then the command history is saved in "
24058 #: ../fish/guestfish.pod:1103
24059 msgid "$HOME/.inputrc"
24064 #: ../fish/guestfish.pod:1105
24065 msgid "/etc/inputrc"
24070 #: ../fish/guestfish.pod:1107
24072 "If compiled with GNU readline support, then these files can be used to "
24073 "configure readline. For further information, please see L<readline(3)/"
24074 "INITIALIZATION FILE>."
24079 #: ../fish/guestfish.pod:1111
24080 msgid "To write rules which only apply to guestfish, use:"
24085 #: ../fish/guestfish.pod:1113
24096 #: ../fish/guestfish.pod:1117
24098 "Variables that you can set in inputrc that change the behaviour of guestfish "
24099 "in useful ways include:"
24104 #: ../fish/guestfish.pod:1122
24105 msgid "completion-ignore-case (default: on)"
24110 #: ../fish/guestfish.pod:1124
24112 "By default, guestfish will ignore case when tab-completing paths on the "
24118 #: ../fish/guestfish.pod:1127
24121 " set completion-ignore-case off\n"
24127 #: ../fish/guestfish.pod:1129
24128 msgid "to make guestfish case sensitive."
24133 #: ../fish/guestfish.pod:1133
24139 #: ../fish/guestfish.pod:1135
24140 msgid "test2.img (etc)"
24145 #: ../fish/guestfish.pod:1137
24147 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
24148 "will be created in the file C<test1.img> in the current directory. The "
24149 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
24150 "the same name will be overwritten."
24154 #: ../fish/guestfish.pod:1146
24156 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24157 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24158 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24159 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24160 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24161 ">, L<hexedit(1)>."
24166 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:102
24167 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
24168 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
24169 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
24170 #: ../tools/virt-list-partitions.pl:277
24172 "This program is free software; you can redistribute it and/or modify it "
24173 "under the terms of the GNU General Public License as published by the Free "
24174 "Software Foundation; either version 2 of the License, or (at your option) "
24175 "any later version."
24180 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:107
24181 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
24182 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
24183 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
24184 #: ../tools/virt-list-partitions.pl:282
24186 "This program is distributed in the hope that it will be useful, but WITHOUT "
24187 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24188 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24194 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:112
24195 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
24196 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
24197 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
24198 #: ../tools/virt-list-partitions.pl:287
24200 "You should have received a copy of the GNU General Public License along with "
24201 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24202 "Ave, Cambridge, MA 02139, USA."
24207 #: ../fish/guestfish-actions.pod:1
24213 #: ../fish/guestfish-actions.pod:3
24216 " add-cdrom filename\n"
24222 #: ../fish/guestfish-actions.pod:15
24224 "This call checks for the existence of C<filename>. This stops you from "
24225 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24226 "and C<http:> URLs. To specify those, use the general L</config> call "
24232 #: ../fish/guestfish-actions.pod:22
24234 "If you just want to add an ISO file (often you use this as an efficient way "
24235 "to transfer large files into the guest), then you should probably use L</add-"
24236 "drive-ro> instead."
24241 #: ../fish/guestfish-actions.pod:35
24247 #: ../fish/guestfish-actions.pod:37
24252 #: ../fish/guestfish-actions.pod:39
24255 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24261 #: ../fish/guestfish-actions.pod:41
24263 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24264 "It works by connecting to libvirt, requesting the domain and domain XML from "
24265 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24270 #: ../fish/guestfish-actions.pod:71
24272 "The other optional parameters are passed directly through to L</add-drive-"
24278 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24279 #: ../fish/guestfish-actions.pod:3039
24281 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24286 #: ../fish/guestfish-actions.pod:76
24292 #: ../fish/guestfish-actions.pod:78
24295 " add-drive filename\n"
24301 #: ../fish/guestfish-actions.pod:80
24303 "This function is the equivalent of calling L</add-drive-opts> with no "
24304 "optional parameters, so the disk is added writable, with the format being "
24305 "detected automatically."
24310 #: ../fish/guestfish-actions.pod:84
24312 "Automatic detection of the format opens you up to a potential security hole "
24313 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24314 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24315 "you should think about replacing calls to this function with calls to L</add-"
24316 "drive-opts>, and specifying the format."
24321 #: ../fish/guestfish-actions.pod:91
24322 msgid "add-drive-opts"
24327 #: ../fish/guestfish-actions.pod:93
24333 #: ../fish/guestfish-actions.pod:95
24336 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24342 #: ../fish/guestfish-actions.pod:122
24344 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24345 "add-drive-ro>) then the format is automatically detected. Possible formats "
24346 "include C<raw> and C<qcow2>."
24351 #: ../fish/guestfish-actions.pod:133
24353 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24354 "add-drive-with-if> call (q.v.)"
24359 #: ../fish/guestfish-actions.pod:140
24360 msgid "add-drive-ro"
24365 #: ../fish/guestfish-actions.pod:142
24371 #: ../fish/guestfish-actions.pod:144
24374 " add-drive-ro filename\n"
24380 #: ../fish/guestfish-actions.pod:146
24382 "This function is the equivalent of calling L</add-drive-opts> with the "
24383 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24384 "is added read-only, with the format being detected automatically."
24389 #: ../fish/guestfish-actions.pod:151
24390 msgid "add-drive-ro-with-if"
24395 #: ../fish/guestfish-actions.pod:153
24398 " add-drive-ro-with-if filename iface\n"
24404 #: ../fish/guestfish-actions.pod:155
24406 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24407 "interface emulation to use at run time."
24412 #: ../fish/guestfish-actions.pod:165
24413 msgid "add-drive-with-if"
24418 #: ../fish/guestfish-actions.pod:167
24421 " add-drive-with-if filename iface\n"
24427 #: ../fish/guestfish-actions.pod:169
24429 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24430 "interface emulation to use at run time."
24435 #: ../fish/guestfish-actions.pod:179
24441 #: ../fish/guestfish-actions.pod:181
24444 " aug-clear augpath\n"
24450 #: ../fish/guestfish-actions.pod:186
24456 #: ../fish/guestfish-actions.pod:188
24465 #: ../fish/guestfish-actions.pod:190
24467 "Close the current Augeas handle and free up any resources used by it. After "
24468 "calling this, you have to call L</aug-init> again before you can use any "
24469 "other Augeas functions."
24474 #: ../fish/guestfish-actions.pod:195
24475 msgid "aug-defnode"
24480 #: ../fish/guestfish-actions.pod:197
24483 " aug-defnode name expr val\n"
24489 #: ../fish/guestfish-actions.pod:202
24491 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24492 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24493 "containing that single node."
24498 #: ../fish/guestfish-actions.pod:210
24504 #: ../fish/guestfish-actions.pod:212
24507 " aug-defvar name expr\n"
24513 #: ../fish/guestfish-actions.pod:221
24519 #: ../fish/guestfish-actions.pod:223
24522 " aug-get augpath\n"
24528 #: ../fish/guestfish-actions.pod:228
24534 #: ../fish/guestfish-actions.pod:230
24537 " aug-init root flags\n"
24543 #: ../fish/guestfish-actions.pod:236
24544 msgid "You must call this before using any other L</aug-*> commands."
24549 #: ../fish/guestfish-actions.pod:271
24550 msgid "Do not load the tree in L</aug-init>."
24555 #: ../fish/guestfish-actions.pod:275
24556 msgid "To close the handle, you can call L</aug-close>."
24561 #: ../fish/guestfish-actions.pod:279
24567 #: ../fish/guestfish-actions.pod:281
24570 " aug-insert augpath label true|false\n"
24576 #: ../fish/guestfish-actions.pod:291
24582 #: ../fish/guestfish-actions.pod:293
24591 #: ../fish/guestfish-actions.pod:300
24597 #: ../fish/guestfish-actions.pod:302
24600 " aug-ls augpath\n"
24606 #: ../fish/guestfish-actions.pod:304
24608 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24609 "resulting nodes into alphabetical order."
24614 #: ../fish/guestfish-actions.pod:307
24620 #: ../fish/guestfish-actions.pod:309
24623 " aug-match augpath\n"
24629 #: ../fish/guestfish-actions.pod:315
24635 #: ../fish/guestfish-actions.pod:317
24638 " aug-mv src dest\n"
24644 #: ../fish/guestfish-actions.pod:322
24650 #: ../fish/guestfish-actions.pod:324
24653 " aug-rm augpath\n"
24659 #: ../fish/guestfish-actions.pod:330
24665 #: ../fish/guestfish-actions.pod:332
24674 #: ../fish/guestfish-actions.pod:336
24676 "The flags which were passed to L</aug-init> affect exactly how files are "
24682 #: ../fish/guestfish-actions.pod:339
24688 #: ../fish/guestfish-actions.pod:341
24691 " aug-set augpath val\n"
24697 #: ../fish/guestfish-actions.pod:345
24699 "In the Augeas API, it is possible to clear a node by setting the value to "
24700 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24701 "this call. Instead you must use the L</aug-clear> call."
24706 #: ../fish/guestfish-actions.pod:350
24712 #: ../fish/guestfish-actions.pod:352
24715 " available 'groups ...'\n"
24721 #: ../fish/guestfish-actions.pod:358
24723 "The libguestfs groups, and the functions that those groups correspond to, "
24724 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24725 "runtime by calling L</available-all-groups>."
24730 #: ../fish/guestfish-actions.pod:382
24731 msgid "You must call L</launch> before calling this function."
24736 #: ../fish/guestfish-actions.pod:404
24738 "This call was added in version C<1.0.80>. In previous versions of "
24739 "libguestfs all you could do would be to speculatively execute a command to "
24740 "find out if the daemon implemented it. See also L</version>."
24745 #: ../fish/guestfish-actions.pod:411
24746 msgid "available-all-groups"
24751 #: ../fish/guestfish-actions.pod:413
24754 " available-all-groups\n"
24760 #: ../fish/guestfish-actions.pod:415
24762 "This command returns a list of all optional groups that this daemon knows "
24763 "about. Note this returns both supported and unsupported groups. To find "
24764 "out which ones the daemon can actually support you have to call L</"
24765 "available> on each member of the returned list."
24770 #: ../fish/guestfish-actions.pod:421
24771 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24776 #: ../fish/guestfish-actions.pod:423
24782 #: ../fish/guestfish-actions.pod:425
24785 " base64-in (base64file|-) filename\n"
24791 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24792 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24793 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24794 #: ../fish/guestfish-actions.pod:4437 ../fish/guestfish-actions.pod:4449
24795 #: ../fish/guestfish-actions.pod:4460 ../fish/guestfish-actions.pod:4471
24796 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4532
24797 #: ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4609
24798 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24803 #: ../fish/guestfish-actions.pod:432
24809 #: ../fish/guestfish-actions.pod:434
24812 " base64-out filename (base64file|-)\n"
24818 #: ../fish/guestfish-actions.pod:441
24819 msgid "blockdev-flushbufs"
24824 #: ../fish/guestfish-actions.pod:443
24827 " blockdev-flushbufs device\n"
24833 #: ../fish/guestfish-actions.pod:450
24834 msgid "blockdev-getbsz"
24839 #: ../fish/guestfish-actions.pod:452
24842 " blockdev-getbsz device\n"
24848 #: ../fish/guestfish-actions.pod:461
24849 msgid "blockdev-getro"
24854 #: ../fish/guestfish-actions.pod:463
24857 " blockdev-getro device\n"
24863 #: ../fish/guestfish-actions.pod:470
24864 msgid "blockdev-getsize64"
24869 #: ../fish/guestfish-actions.pod:472
24872 " blockdev-getsize64 device\n"
24878 #: ../fish/guestfish-actions.pod:476
24879 msgid "See also L</blockdev-getsz>."
24884 #: ../fish/guestfish-actions.pod:480
24885 msgid "blockdev-getss"
24890 #: ../fish/guestfish-actions.pod:482
24893 " blockdev-getss device\n"
24899 #: ../fish/guestfish-actions.pod:487
24901 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
24906 #: ../fish/guestfish-actions.pod:492
24907 msgid "blockdev-getsz"
24912 #: ../fish/guestfish-actions.pod:494
24915 " blockdev-getsz device\n"
24921 #: ../fish/guestfish-actions.pod:499
24923 "See also L</blockdev-getss> for the real sector size of the device, and L</"
24924 "blockdev-getsize64> for the more useful I<size in bytes>."
24929 #: ../fish/guestfish-actions.pod:505
24930 msgid "blockdev-rereadpt"
24935 #: ../fish/guestfish-actions.pod:507
24938 " blockdev-rereadpt device\n"
24944 #: ../fish/guestfish-actions.pod:513
24945 msgid "blockdev-setbsz"
24950 #: ../fish/guestfish-actions.pod:515
24953 " blockdev-setbsz device blocksize\n"
24959 #: ../fish/guestfish-actions.pod:524
24960 msgid "blockdev-setro"
24965 #: ../fish/guestfish-actions.pod:526
24968 " blockdev-setro device\n"
24974 #: ../fish/guestfish-actions.pod:532
24975 msgid "blockdev-setrw"
24980 #: ../fish/guestfish-actions.pod:534
24983 " blockdev-setrw device\n"
24989 #: ../fish/guestfish-actions.pod:540
24990 msgid "case-sensitive-path"
24995 #: ../fish/guestfish-actions.pod:542
24998 " case-sensitive-path path\n"
25004 #: ../fish/guestfish-actions.pod:566
25006 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25007 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25008 "the directories were originally created under Windows)."
25013 #: ../fish/guestfish-actions.pod:574
25014 msgid "See also L</realpath>."
25019 #: ../fish/guestfish-actions.pod:576
25025 #: ../fish/guestfish-actions.pod:578
25034 #: ../fish/guestfish-actions.pod:582
25036 "Note that this function cannot correctly handle binary files (specifically, "
25037 "files containing C<\\0> character which is treated as end of string). For "
25038 "those you need to use the L</read-file> or L</download> functions which have "
25039 "a more complex interface."
25044 #: ../fish/guestfish-actions.pod:590
25050 #: ../fish/guestfish-actions.pod:592
25053 " checksum csumtype path\n"
25059 #: ../fish/guestfish-actions.pod:635
25060 msgid "To get the checksum for a device, use L</checksum-device>."
25065 #: ../fish/guestfish-actions.pod:637
25066 msgid "To get the checksums for many files, use L</checksums-out>."
25071 #: ../fish/guestfish-actions.pod:639
25072 msgid "checksum-device"
25077 #: ../fish/guestfish-actions.pod:641
25080 " checksum-device csumtype device\n"
25086 #: ../fish/guestfish-actions.pod:643
25088 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25089 "device named C<device>. For the types of checksums supported see the L</"
25090 "checksum> command."
25095 #: ../fish/guestfish-actions.pod:647
25096 msgid "checksums-out"
25101 #: ../fish/guestfish-actions.pod:649
25104 " checksums-out csumtype directory (sumsfile|-)\n"
25110 #: ../fish/guestfish-actions.pod:665
25116 #: ../fish/guestfish-actions.pod:667
25119 " chmod mode path\n"
25125 #: ../fish/guestfish-actions.pod:678
25131 #: ../fish/guestfish-actions.pod:680
25134 " chown owner group path\n"
25140 #: ../fish/guestfish-actions.pod:688
25146 #: ../fish/guestfish-actions.pod:690
25149 " command 'arguments ...'\n"
25155 #: ../fish/guestfish-actions.pod:697
25157 "The single parameter is an argv-style list of arguments. The first element "
25158 "is the name of the program to run. Subsequent elements are parameters. The "
25159 "list must be non-empty (ie. must contain a program name). Note that the "
25160 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25165 #: ../fish/guestfish-actions.pod:725
25166 msgid "command-lines"
25171 #: ../fish/guestfish-actions.pod:727
25174 " command-lines 'arguments ...'\n"
25180 #: ../fish/guestfish-actions.pod:729
25182 "This is the same as L</command>, but splits the result into a list of lines."
25187 #: ../fish/guestfish-actions.pod:732
25188 msgid "See also: L</sh-lines>"
25193 #: ../fish/guestfish-actions.pod:737
25199 #: ../fish/guestfish-actions.pod:739
25202 " config qemuparam qemuvalue\n"
25208 #: ../fish/guestfish-actions.pod:750
25214 #: ../fish/guestfish-actions.pod:752
25217 " copy-size src dest size\n"
25223 #: ../fish/guestfish-actions.pod:760
25229 #: ../fish/guestfish-actions.pod:762
25238 #: ../fish/guestfish-actions.pod:767
25244 #: ../fish/guestfish-actions.pod:769
25253 #: ../fish/guestfish-actions.pod:774
25259 #: ../fish/guestfish-actions.pod:776
25268 #: ../fish/guestfish-actions.pod:783
25270 "If the destination is a device, it must be as large or larger than the "
25271 "source file or device, otherwise the copy will fail. This command cannot do "
25272 "partial copies (see L</copy-size>)."
25277 #: ../fish/guestfish-actions.pod:787
25283 #: ../fish/guestfish-actions.pod:789
25292 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25294 "This command is mostly useful for interactive sessions. It is I<not> "
25295 "intended that you try to parse the output string. Use L</statvfs> from "
25301 #: ../fish/guestfish-actions.pod:797
25307 #: ../fish/guestfish-actions.pod:799
25316 #: ../fish/guestfish-actions.pod:808
25322 #: ../fish/guestfish-actions.pod:810
25331 #: ../fish/guestfish-actions.pod:816
25333 "Another way to get the same information is to enable verbose messages with "
25334 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25335 "before running the program."
25340 #: ../fish/guestfish-actions.pod:821
25346 #: ../fish/guestfish-actions.pod:823
25349 " download remotefilename (filename|-)\n"
25355 #: ../fish/guestfish-actions.pod:830
25356 msgid "See also L</upload>, L</cat>."
25361 #: ../fish/guestfish-actions.pod:834
25362 msgid "download-offset"
25367 #: ../fish/guestfish-actions.pod:836
25370 " download-offset remotefilename (filename|-) offset size\n"
25376 #: ../fish/guestfish-actions.pod:844
25378 "Note that there is no limit on the amount of data that can be downloaded "
25379 "with this call, unlike with L</pread>, and this call always reads the full "
25380 "amount unless an error occurs."
25385 #: ../fish/guestfish-actions.pod:849
25386 msgid "See also L</download>, L</pread>."
25391 #: ../fish/guestfish-actions.pod:853
25392 msgid "drop-caches"
25397 #: ../fish/guestfish-actions.pod:855
25400 " drop-caches whattodrop\n"
25406 #: ../fish/guestfish-actions.pod:867
25412 #: ../fish/guestfish-actions.pod:869
25421 #: ../fish/guestfish-actions.pod:881
25427 #: ../fish/guestfish-actions.pod:883
25430 " e2fsck-f device\n"
25436 #: ../fish/guestfish-actions.pod:889
25438 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25439 "should use L</fsck>."
25444 #: ../fish/guestfish-actions.pod:892
25445 msgid "echo-daemon"
25450 #: ../fish/guestfish-actions.pod:894
25453 " echo-daemon 'words ...'\n"
25459 #: ../fish/guestfish-actions.pod:901
25460 msgid "See also L</ping-daemon>."
25465 #: ../fish/guestfish-actions.pod:903
25471 #: ../fish/guestfish-actions.pod:905
25474 " egrep regex path\n"
25480 #: ../fish/guestfish-actions.pod:913
25486 #: ../fish/guestfish-actions.pod:915
25489 " egrepi regex path\n"
25495 #: ../fish/guestfish-actions.pod:923
25501 #: ../fish/guestfish-actions.pod:925
25504 " equal file1 file2\n"
25510 #: ../fish/guestfish-actions.pod:932
25516 #: ../fish/guestfish-actions.pod:934
25525 #: ../fish/guestfish-actions.pod:939
25526 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25531 #: ../fish/guestfish-actions.pod:941
25537 #: ../fish/guestfish-actions.pod:943
25540 " fallocate path len\n"
25546 #: ../fish/guestfish-actions.pod:960
25547 msgid "fallocate64"
25552 #: ../fish/guestfish-actions.pod:962
25555 " fallocate64 path len\n"
25561 #: ../fish/guestfish-actions.pod:968
25563 "Note that this call allocates disk blocks for the file. To create a sparse "
25564 "file use L</truncate-size> instead."
25569 #: ../fish/guestfish-actions.pod:971
25571 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25572 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25573 "maximum size of files created through that call to 1GB."
25578 #: ../fish/guestfish-actions.pod:980
25584 #: ../fish/guestfish-actions.pod:982
25587 " fgrep pattern path\n"
25593 #: ../fish/guestfish-actions.pod:990
25599 #: ../fish/guestfish-actions.pod:992
25602 " fgrepi pattern path\n"
25608 #: ../fish/guestfish-actions.pod:1000
25614 #: ../fish/guestfish-actions.pod:1002
25623 #: ../fish/guestfish-actions.pod:1014
25625 "This command can also be used on C</dev/> devices (and partitions, LV "
25626 "names). You can for example use this to determine if a device contains a "
25627 "filesystem, although it's usually better to use L</vfs-type>."
25632 #: ../fish/guestfish-actions.pod:1024
25633 msgid "file-architecture"
25638 #: ../fish/guestfish-actions.pod:1026
25641 " file-architecture filename\n"
25647 #: ../fish/guestfish-actions.pod:1129
25653 #: ../fish/guestfish-actions.pod:1131
25662 #: ../fish/guestfish-actions.pod:1135
25664 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25665 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25670 #: ../fish/guestfish-actions.pod:1139
25676 #: ../fish/guestfish-actions.pod:1141
25679 " fill c len path\n"
25685 #: ../fish/guestfish-actions.pod:1147
25687 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25688 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25689 "L</fill-pattern>."
25694 #: ../fish/guestfish-actions.pod:1152
25695 msgid "fill-pattern"
25700 #: ../fish/guestfish-actions.pod:1154
25703 " fill-pattern pattern len path\n"
25709 #: ../fish/guestfish-actions.pod:1156
25711 "This function is like L</fill> except that it creates a new file of length "
25712 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25713 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25719 #: ../fish/guestfish-actions.pod:1161
25725 #: ../fish/guestfish-actions.pod:1163
25728 " find directory\n"
25734 #: ../fish/guestfish-actions.pod:1177
25735 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25740 #: ../fish/guestfish-actions.pod:1190
25741 msgid "See also L</find0>."
25746 #: ../fish/guestfish-actions.pod:1195
25752 #: ../fish/guestfish-actions.pod:1197
25755 " find0 directory (files|-)\n"
25761 #: ../fish/guestfish-actions.pod:1203
25763 "This command works the same way as L</find> with the following exceptions:"
25768 #: ../fish/guestfish-actions.pod:1230
25769 msgid "findfs-label"
25774 #: ../fish/guestfish-actions.pod:1232
25777 " findfs-label label\n"
25783 #: ../fish/guestfish-actions.pod:1238
25784 msgid "To find the label of a filesystem, use L</vfs-label>."
25789 #: ../fish/guestfish-actions.pod:1240
25790 msgid "findfs-uuid"
25795 #: ../fish/guestfish-actions.pod:1242
25798 " findfs-uuid uuid\n"
25804 #: ../fish/guestfish-actions.pod:1248
25805 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25810 #: ../fish/guestfish-actions.pod:1250
25816 #: ../fish/guestfish-actions.pod:1252
25819 " fsck fstype device\n"
25825 #: ../fish/guestfish-actions.pod:1282
25831 #: ../fish/guestfish-actions.pod:1284
25839 #: ../fish/guestfish-actions.pod:1291
25840 msgid "get-attach-method"
25844 #: ../fish/guestfish-actions.pod:1293
25847 " get-attach-method\n"
25852 #: ../fish/guestfish-actions.pod:1295
25853 msgid "Return the current attach method. See L</set-attach-method>."
25858 #: ../fish/guestfish-actions.pod:1297
25859 msgid "get-autosync"
25864 #: ../fish/guestfish-actions.pod:1299
25873 #: ../fish/guestfish-actions.pod:1303
25879 #: ../fish/guestfish-actions.pod:1305
25888 #: ../fish/guestfish-actions.pod:1309
25889 msgid "get-e2label"
25894 #: ../fish/guestfish-actions.pod:1311
25897 " get-e2label device\n"
25903 #: ../fish/guestfish-actions.pod:1323
25909 #: ../fish/guestfish-actions.pod:1325
25912 " get-e2uuid device\n"
25918 #: ../fish/guestfish-actions.pod:1337
25919 msgid "get-memsize"
25924 #: ../fish/guestfish-actions.pod:1339
25933 #: ../fish/guestfish-actions.pod:1344
25935 "If L</set-memsize> was not called on this handle, and if "
25936 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
25937 "value for memsize."
25942 #: ../fish/guestfish-actions.pod:1351
25943 msgid "get-network"
25948 #: ../fish/guestfish-actions.pod:1353
25957 #: ../fish/guestfish-actions.pod:1357
25963 #: ../fish/guestfish-actions.pod:1359
25972 #: ../fish/guestfish-actions.pod:1366
25978 #: ../fish/guestfish-actions.pod:1368
25984 #: ../fish/guestfish-actions.pod:1370
25993 #: ../fish/guestfish-actions.pod:1377
25999 #: ../fish/guestfish-actions.pod:1379
26008 #: ../fish/guestfish-actions.pod:1386
26009 msgid "get-recovery-proc"
26014 #: ../fish/guestfish-actions.pod:1388
26017 " get-recovery-proc\n"
26023 #: ../fish/guestfish-actions.pod:1392
26024 msgid "get-selinux"
26029 #: ../fish/guestfish-actions.pod:1394
26038 #: ../fish/guestfish-actions.pod:1396
26040 "This returns the current setting of the selinux flag which is passed to the "
26041 "appliance at boot time. See L</set-selinux>."
26046 #: ../fish/guestfish-actions.pod:1402
26052 #: ../fish/guestfish-actions.pod:1404
26061 #: ../fish/guestfish-actions.pod:1411
26067 #: ../fish/guestfish-actions.pod:1413
26076 #: ../fish/guestfish-actions.pod:1417
26082 #: ../fish/guestfish-actions.pod:1419
26091 #: ../fish/guestfish-actions.pod:1421
26093 "Return the current umask. By default the umask is C<022> unless it has been "
26094 "set by calling L</umask>."
26099 #: ../fish/guestfish-actions.pod:1424
26100 msgid "get-verbose"
26105 #: ../fish/guestfish-actions.pod:1426
26114 #: ../fish/guestfish-actions.pod:1430
26120 #: ../fish/guestfish-actions.pod:1432
26129 #: ../fish/guestfish-actions.pod:1436
26130 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26135 #: ../fish/guestfish-actions.pod:1439
26141 #: ../fish/guestfish-actions.pod:1441
26144 " getxattr path name\n"
26150 #: ../fish/guestfish-actions.pod:1443
26152 "Get a single extended attribute from file C<path> named C<name>. This call "
26153 "follows symlinks. If you want to lookup an extended attribute for the "
26154 "symlink itself, use L</lgetxattr>."
26159 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2445
26161 "Normally it is better to get all extended attributes from a file in one go "
26162 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26163 "buggy and do not provide a way to list out attributes. For these "
26164 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26165 "attributes you want in advance and call this function."
26170 #: ../fish/guestfish-actions.pod:1457
26171 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26176 #: ../fish/guestfish-actions.pod:1459
26182 #: ../fish/guestfish-actions.pod:1461
26185 " getxattrs path\n"
26191 #: ../fish/guestfish-actions.pod:1469
26192 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26197 #: ../fish/guestfish-actions.pod:1471
26198 msgid "glob-expand"
26203 #: ../fish/guestfish-actions.pod:1473
26206 " glob-expand pattern\n"
26212 #: ../fish/guestfish-actions.pod:1486
26218 #: ../fish/guestfish-actions.pod:1488
26221 " grep regex path\n"
26227 #: ../fish/guestfish-actions.pod:1496
26233 #: ../fish/guestfish-actions.pod:1498
26236 " grepi regex path\n"
26242 #: ../fish/guestfish-actions.pod:1506
26243 msgid "grub-install"
26248 #: ../fish/guestfish-actions.pod:1508
26251 " grub-install root device\n"
26257 #: ../fish/guestfish-actions.pod:1524
26263 #: ../fish/guestfish-actions.pod:1526
26272 #: ../fish/guestfish-actions.pod:1534
26278 #: ../fish/guestfish-actions.pod:1536
26281 " head-n nrlines path\n"
26287 #: ../fish/guestfish-actions.pod:1549
26293 #: ../fish/guestfish-actions.pod:1551
26302 #: ../fish/guestfish-actions.pod:1559
26308 #: ../fish/guestfish-actions.pod:1561
26311 " initrd-cat initrdpath filename\n"
26317 #: ../fish/guestfish-actions.pod:1573
26318 msgid "See also L</initrd-list>."
26323 #: ../fish/guestfish-actions.pod:1578
26324 msgid "initrd-list"
26329 #: ../fish/guestfish-actions.pod:1580
26332 " initrd-list path\n"
26338 #: ../fish/guestfish-actions.pod:1592
26339 msgid "inotify-add-watch"
26344 #: ../fish/guestfish-actions.pod:1594
26347 " inotify-add-watch path mask\n"
26353 #: ../fish/guestfish-actions.pod:1606
26354 msgid "inotify-close"
26359 #: ../fish/guestfish-actions.pod:1608
26368 #: ../fish/guestfish-actions.pod:1614
26369 msgid "inotify-files"
26374 #: ../fish/guestfish-actions.pod:1616
26383 #: ../fish/guestfish-actions.pod:1618
26385 "This function is a helpful wrapper around L</inotify-read> which just "
26386 "returns a list of pathnames of objects that were touched. The returned "
26387 "pathnames are sorted and deduplicated."
26392 #: ../fish/guestfish-actions.pod:1622
26393 msgid "inotify-init"
26398 #: ../fish/guestfish-actions.pod:1624
26401 " inotify-init maxevents\n"
26407 #: ../fish/guestfish-actions.pod:1630
26409 "C<maxevents> is the maximum number of events which will be queued up between "
26410 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26411 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26412 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26413 "but records the fact that it threw them away by setting a flag "
26414 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26419 #: ../fish/guestfish-actions.pod:1640
26421 "Before any events are generated, you have to add some watches to the "
26422 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26423 "L</inotify-watch-all>."
26428 #: ../fish/guestfish-actions.pod:1646
26430 "Queued up events should be read periodically by calling L</inotify-read> (or "
26431 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26432 "If you don't read the events out often enough then you risk the internal "
26433 "queue overflowing."
26438 #: ../fish/guestfish-actions.pod:1653
26440 "The handle should be closed after use by calling L</inotify-close>. This "
26441 "also removes any watches automatically."
26446 #: ../fish/guestfish-actions.pod:1662
26447 msgid "inotify-read"
26452 #: ../fish/guestfish-actions.pod:1664
26461 #: ../fish/guestfish-actions.pod:1677
26462 msgid "inotify-rm-watch"
26467 #: ../fish/guestfish-actions.pod:1679
26470 " inotify-rm-watch wd\n"
26476 #: ../fish/guestfish-actions.pod:1681
26477 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26482 #: ../fish/guestfish-actions.pod:1684
26483 msgid "inspect-get-arch"
26488 #: ../fish/guestfish-actions.pod:1686
26491 " inspect-get-arch root\n"
26497 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26498 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1818
26499 #: ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1870
26500 #: ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1906
26501 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1954
26502 #: ../fish/guestfish-actions.pod:1976 ../fish/guestfish-actions.pod:2000
26503 #: ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2060
26504 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2111
26505 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2140
26506 #: ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2168
26508 "This function should only be called with a root device string as returned by "
26514 #: ../fish/guestfish-actions.pod:1691
26516 "This returns the architecture of the inspected operating system. The "
26517 "possible return values are listed under L</file-architecture>."
26522 #: ../fish/guestfish-actions.pod:1700
26523 msgid "inspect-get-distro"
26528 #: ../fish/guestfish-actions.pod:1702
26531 " inspect-get-distro root\n"
26536 #: ../fish/guestfish-actions.pod:1778
26537 msgid "inspect-get-drive-mappings"
26541 #: ../fish/guestfish-actions.pod:1780
26544 " inspect-get-drive-mappings root\n"
26549 #: ../fish/guestfish-actions.pod:1810
26551 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26552 "get-mountpoints>, L</inspect-get-filesystems>."
26557 #: ../fish/guestfish-actions.pod:1814
26558 msgid "inspect-get-filesystems"
26563 #: ../fish/guestfish-actions.pod:1816
26566 " inspect-get-filesystems root\n"
26572 #: ../fish/guestfish-actions.pod:1829
26574 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26575 "get-mountpoints>."
26579 #: ../fish/guestfish-actions.pod:1832
26580 msgid "inspect-get-format"
26584 #: ../fish/guestfish-actions.pod:1834
26587 " inspect-get-format root\n"
26593 #: ../fish/guestfish-actions.pod:1866
26594 msgid "inspect-get-hostname"
26599 #: ../fish/guestfish-actions.pod:1868
26602 " inspect-get-hostname root\n"
26608 #: ../fish/guestfish-actions.pod:1881
26609 msgid "inspect-get-major-version"
26614 #: ../fish/guestfish-actions.pod:1883
26617 " inspect-get-major-version root\n"
26623 #: ../fish/guestfish-actions.pod:1902
26624 msgid "inspect-get-minor-version"
26629 #: ../fish/guestfish-actions.pod:1904
26632 " inspect-get-minor-version root\n"
26638 #: ../fish/guestfish-actions.pod:1914
26640 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26641 "get-major-version>."
26646 #: ../fish/guestfish-actions.pod:1917
26647 msgid "inspect-get-mountpoints"
26652 #: ../fish/guestfish-actions.pod:1919
26655 " inspect-get-mountpoints root\n"
26660 #: ../fish/guestfish-actions.pod:1941
26662 "For operating systems like Windows which still use drive letters, this call "
26663 "will only return an entry for the first drive \"mounted on\" C</>. For "
26664 "information about the mapping of drive letters to partitions, see L</inspect-"
26665 "get-drive-mappings>."
26670 #: ../fish/guestfish-actions.pod:1947
26672 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26673 "get-filesystems>."
26678 #: ../fish/guestfish-actions.pod:1950
26679 msgid "inspect-get-package-format"
26684 #: ../fish/guestfish-actions.pod:1952
26687 " inspect-get-package-format root\n"
26693 #: ../fish/guestfish-actions.pod:1957
26695 "This function and L</inspect-get-package-management> return the package "
26696 "format and package management tool used by the inspected operating system. "
26697 "For example for Fedora these functions would return C<rpm> (package format) "
26698 "and C<yum> (package management)."
26703 #: ../fish/guestfish-actions.pod:1972
26704 msgid "inspect-get-package-management"
26709 #: ../fish/guestfish-actions.pod:1974
26712 " inspect-get-package-management root\n"
26718 #: ../fish/guestfish-actions.pod:1979
26720 "L</inspect-get-package-format> and this function return the package format "
26721 "and package management tool used by the inspected operating system. For "
26722 "example for Fedora these functions would return C<rpm> (package format) and "
26723 "C<yum> (package management)."
26728 #: ../fish/guestfish-actions.pod:1996
26729 msgid "inspect-get-product-name"
26734 #: ../fish/guestfish-actions.pod:1998
26737 " inspect-get-product-name root\n"
26742 #: ../fish/guestfish-actions.pod:2013
26743 msgid "inspect-get-product-variant"
26747 #: ../fish/guestfish-actions.pod:2015
26750 " inspect-get-product-variant root\n"
26755 #: ../fish/guestfish-actions.pod:2039
26757 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26758 "get-product-name>, L</inspect-get-major-version>."
26763 #: ../fish/guestfish-actions.pod:2043
26764 msgid "inspect-get-roots"
26769 #: ../fish/guestfish-actions.pod:2045
26772 " inspect-get-roots\n"
26778 #: ../fish/guestfish-actions.pod:2047
26780 "This function is a convenient way to get the list of root devices, as "
26781 "returned from a previous call to L</inspect-os>, but without redoing the "
26782 "whole inspection process."
26787 #: ../fish/guestfish-actions.pod:2051
26789 "This returns an empty list if either no root devices were found or the "
26790 "caller has not called L</inspect-os>."
26795 #: ../fish/guestfish-actions.pod:2056
26796 msgid "inspect-get-type"
26801 #: ../fish/guestfish-actions.pod:2058
26804 " inspect-get-type root\n"
26809 #: ../fish/guestfish-actions.pod:2091
26810 msgid "inspect-get-windows-current-control-set"
26814 #: ../fish/guestfish-actions.pod:2093
26817 " inspect-get-windows-current-control-set root\n"
26823 #: ../fish/guestfish-actions.pod:2107
26824 msgid "inspect-get-windows-systemroot"
26829 #: ../fish/guestfish-actions.pod:2109
26832 " inspect-get-windows-systemroot root\n"
26837 #: ../fish/guestfish-actions.pod:2123
26838 msgid "inspect-is-live"
26842 #: ../fish/guestfish-actions.pod:2125
26845 " inspect-is-live root\n"
26850 #: ../fish/guestfish-actions.pod:2130
26852 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26853 "then this returns true if a live image was detected on the disk."
26857 #: ../fish/guestfish-actions.pod:2136
26858 msgid "inspect-is-multipart"
26862 #: ../fish/guestfish-actions.pod:2138
26865 " inspect-is-multipart root\n"
26870 #: ../fish/guestfish-actions.pod:2143
26872 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26873 "then this returns true if the disk is part of a set."
26877 #: ../fish/guestfish-actions.pod:2149
26878 msgid "inspect-is-netinst"
26882 #: ../fish/guestfish-actions.pod:2151
26885 " inspect-is-netinst root\n"
26890 #: ../fish/guestfish-actions.pod:2156
26892 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26893 "then this returns true if the disk is a network installer, ie. not a self-"
26894 "contained install CD but one which is likely to require network access to "
26895 "complete the install."
26900 #: ../fish/guestfish-actions.pod:2164
26901 msgid "inspect-list-applications"
26906 #: ../fish/guestfish-actions.pod:2166
26909 " inspect-list-applications root\n"
26915 #: ../fish/guestfish-actions.pod:2173
26917 "I<Note:> This call works differently from other parts of the inspection "
26918 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
26919 "then mount up the disks, before calling this. Listing applications is a "
26920 "significantly more difficult operation which requires access to the full "
26921 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
26922 "are just returning data cached in the libguestfs handle, this call actually "
26923 "reads parts of the mounted filesystems during the call."
26928 #: ../fish/guestfish-actions.pod:2263
26934 #: ../fish/guestfish-actions.pod:2265
26943 #: ../fish/guestfish-actions.pod:2280
26945 "You can pass the root string(s) returned to other L</inspect-get-*> "
26946 "functions in order to query further information about each operating system, "
26947 "such as the name and version."
26952 #: ../fish/guestfish-actions.pod:2285
26954 "This function uses other libguestfs features such as L</mount-ro> and L</"
26955 "umount-all> in order to mount and unmount filesystems and look at the "
26956 "contents. This should be called with no disks currently mounted. The "
26957 "function may also use Augeas, so any existing Augeas handle will be closed."
26962 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2473
26963 #: ../fish/guestfish-actions.pod:2519
26964 msgid "See also L</list-filesystems>."
26969 #: ../fish/guestfish-actions.pod:2299
26970 msgid "is-blockdev"
26975 #: ../fish/guestfish-actions.pod:2301
26978 " is-blockdev path\n"
26984 #: ../fish/guestfish-actions.pod:2306 ../fish/guestfish-actions.pod:2324
26985 #: ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2352
26986 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2396
26987 #: ../fish/guestfish-actions.pod:2405
26988 msgid "See also L</stat>."
26993 #: ../fish/guestfish-actions.pod:2308
26999 #: ../fish/guestfish-actions.pod:2310
27008 #: ../fish/guestfish-actions.pod:2317
27014 #: ../fish/guestfish-actions.pod:2319
27017 " is-chardev path\n"
27023 #: ../fish/guestfish-actions.pod:2326
27029 #: ../fish/guestfish-actions.pod:2328
27038 #: ../fish/guestfish-actions.pod:2335
27044 #: ../fish/guestfish-actions.pod:2337
27053 #: ../fish/guestfish-actions.pod:2345
27059 #: ../fish/guestfish-actions.pod:2347
27068 #: ../fish/guestfish-actions.pod:2354
27074 #: ../fish/guestfish-actions.pod:2356
27083 #: ../fish/guestfish-actions.pod:2364
27084 msgid "is-launching"
27089 #: ../fish/guestfish-actions.pod:2366
27098 #: ../fish/guestfish-actions.pod:2373
27104 #: ../fish/guestfish-actions.pod:2375
27113 #: ../fish/guestfish-actions.pod:2380
27119 #: ../fish/guestfish-actions.pod:2382
27128 #: ../fish/guestfish-actions.pod:2389
27134 #: ../fish/guestfish-actions.pod:2391
27137 " is-socket path\n"
27143 #: ../fish/guestfish-actions.pod:2398
27149 #: ../fish/guestfish-actions.pod:2400
27152 " is-symlink path\n"
27158 #: ../fish/guestfish-actions.pod:2407
27159 msgid "kill-subprocess"
27164 #: ../fish/guestfish-actions.pod:2409
27167 " kill-subprocess\n"
27173 #: ../fish/guestfish-actions.pod:2413
27179 #: ../fish/guestfish-actions.pod:2415
27185 #: ../fish/guestfish-actions.pod:2417
27194 #: ../fish/guestfish-actions.pod:2425
27200 #: ../fish/guestfish-actions.pod:2427
27203 " lchown owner group path\n"
27209 #: ../fish/guestfish-actions.pod:2429
27211 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27212 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27218 #: ../fish/guestfish-actions.pod:2437
27224 #: ../fish/guestfish-actions.pod:2439
27227 " lgetxattr path name\n"
27233 #: ../fish/guestfish-actions.pod:2455
27234 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27239 #: ../fish/guestfish-actions.pod:2457
27245 #: ../fish/guestfish-actions.pod:2459
27248 " lgetxattrs path\n"
27254 #: ../fish/guestfish-actions.pod:2461
27256 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27257 "it returns the extended attributes of the link itself."
27262 #: ../fish/guestfish-actions.pod:2465
27263 msgid "list-devices"
27268 #: ../fish/guestfish-actions.pod:2467
27277 #: ../fish/guestfish-actions.pod:2475
27278 msgid "list-filesystems"
27283 #: ../fish/guestfish-actions.pod:2477
27286 " list-filesystems\n"
27292 #: ../fish/guestfish-actions.pod:2496
27294 "This command runs other libguestfs commands, which might include L</mount> "
27295 "and L</umount>, and therefore you should use this soon after launch and only "
27296 "when nothing is mounted."
27301 #: ../fish/guestfish-actions.pod:2500
27303 "Not all of the filesystems returned will be mountable. In particular, swap "
27304 "partitions are returned in the list. Also this command does not check that "
27305 "each filesystem found is valid and mountable, and some filesystems might be "
27306 "mountable but require special options. Filesystems may not all belong to a "
27307 "single logical operating system (use L</inspect-os> to look for OSes)."
27312 #: ../fish/guestfish-actions.pod:2508
27313 msgid "list-partitions"
27318 #: ../fish/guestfish-actions.pod:2510
27321 " list-partitions\n"
27327 #: ../fish/guestfish-actions.pod:2516
27329 "This does not return logical volumes. For that you will need to call L</"
27335 #: ../fish/guestfish-actions.pod:2521
27341 #: ../fish/guestfish-actions.pod:2523
27350 #: ../fish/guestfish-actions.pod:2531
27356 #: ../fish/guestfish-actions.pod:2533
27359 " ln target linkname\n"
27365 #: ../fish/guestfish-actions.pod:2537
27371 #: ../fish/guestfish-actions.pod:2539
27374 " ln-f target linkname\n"
27380 #: ../fish/guestfish-actions.pod:2544
27386 #: ../fish/guestfish-actions.pod:2546
27389 " ln-s target linkname\n"
27395 #: ../fish/guestfish-actions.pod:2550
27401 #: ../fish/guestfish-actions.pod:2552
27404 " ln-sf target linkname\n"
27410 #: ../fish/guestfish-actions.pod:2557
27411 msgid "lremovexattr"
27416 #: ../fish/guestfish-actions.pod:2559
27419 " lremovexattr xattr path\n"
27425 #: ../fish/guestfish-actions.pod:2561
27427 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27428 "it removes an extended attribute of the link itself."
27433 #: ../fish/guestfish-actions.pod:2565
27439 #: ../fish/guestfish-actions.pod:2567
27448 #: ../fish/guestfish-actions.pod:2573
27450 "This command is mostly useful for interactive sessions. Programs should "
27451 "probably use L</readdir> instead."
27456 #: ../fish/guestfish-actions.pod:2576
27462 #: ../fish/guestfish-actions.pod:2578
27465 " lsetxattr xattr val vallen path\n"
27471 #: ../fish/guestfish-actions.pod:2580
27473 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27474 "sets an extended attribute of the link itself."
27479 #: ../fish/guestfish-actions.pod:2584
27485 #: ../fish/guestfish-actions.pod:2586
27494 #: ../fish/guestfish-actions.pod:2590
27496 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27497 "the link is stat-ed, not the file it refers to."
27502 #: ../fish/guestfish-actions.pod:2596
27508 #: ../fish/guestfish-actions.pod:2598
27511 " lstatlist path 'names ...'\n"
27517 #: ../fish/guestfish-actions.pod:2600
27519 "This call allows you to perform the L</lstat> operation on multiple files, "
27520 "where all files are in the directory C<path>. C<names> is the list of files "
27521 "from this directory."
27526 #: ../fish/guestfish-actions.pod:2609
27528 "This call is intended for programs that want to efficiently list a directory "
27529 "contents without making many round-trips. See also L</lxattrlist> for a "
27530 "similarly efficient call for getting extended attributes. Very long "
27531 "directory listings might cause the protocol message size to be exceeded, "
27532 "causing this call to fail. The caller must split up such requests into "
27533 "smaller groups of names."
27538 #: ../fish/guestfish-actions.pod:2617
27539 msgid "luks-add-key"
27544 #: ../fish/guestfish-actions.pod:2619
27547 " luks-add-key device keyslot\n"
27553 #: ../fish/guestfish-actions.pod:2626
27555 "Note that if C<keyslot> already contains a key, then this command will "
27556 "fail. You have to use L</luks-kill-slot> first to remove that key."
27561 #: ../fish/guestfish-actions.pod:2630 ../fish/guestfish-actions.pod:2652
27562 #: ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2679
27563 #: ../fish/guestfish-actions.pod:2702 ../fish/guestfish-actions.pod:2712
27565 "This command has one or more key or passphrase parameters. Guestfish will "
27566 "prompt for these separately."
27571 #: ../fish/guestfish-actions.pod:2633
27577 #: ../fish/guestfish-actions.pod:2635
27580 " luks-close device\n"
27586 #: ../fish/guestfish-actions.pod:2637
27588 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27589 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27590 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27596 #: ../fish/guestfish-actions.pod:2643
27597 msgid "luks-format"
27602 #: ../fish/guestfish-actions.pod:2645
27605 " luks-format device keyslot\n"
27611 #: ../fish/guestfish-actions.pod:2658
27612 msgid "luks-format-cipher"
27617 #: ../fish/guestfish-actions.pod:2660
27620 " luks-format-cipher device keyslot cipher\n"
27626 #: ../fish/guestfish-actions.pod:2662
27628 "This command is the same as L</luks-format> but it also allows you to set "
27629 "the C<cipher> used."
27634 #: ../fish/guestfish-actions.pod:2671
27635 msgid "luks-kill-slot"
27640 #: ../fish/guestfish-actions.pod:2673
27643 " luks-kill-slot device keyslot\n"
27649 #: ../fish/guestfish-actions.pod:2682
27655 #: ../fish/guestfish-actions.pod:2684
27658 " luks-open device mapname\n"
27664 #: ../fish/guestfish-actions.pod:2698
27666 "If this block device contains LVM volume groups, then calling L</vgscan> "
27667 "followed by L</vg-activate-all> will make them visible."
27672 #: ../fish/guestfish-actions.pod:2705
27673 msgid "luks-open-ro"
27678 #: ../fish/guestfish-actions.pod:2707
27681 " luks-open-ro device mapname\n"
27687 #: ../fish/guestfish-actions.pod:2709
27689 "This is the same as L</luks-open> except that a read-only mapping is created."
27694 #: ../fish/guestfish-actions.pod:2715
27700 #: ../fish/guestfish-actions.pod:2717
27703 " lvcreate logvol volgroup mbytes\n"
27709 #: ../fish/guestfish-actions.pod:2722
27710 msgid "lvm-canonical-lv-name"
27715 #: ../fish/guestfish-actions.pod:2724
27718 " lvm-canonical-lv-name lvname\n"
27724 #: ../fish/guestfish-actions.pod:2733
27725 msgid "See also L</is-lv>."
27730 #: ../fish/guestfish-actions.pod:2735
27731 msgid "lvm-clear-filter"
27736 #: ../fish/guestfish-actions.pod:2737
27739 " lvm-clear-filter\n"
27745 #: ../fish/guestfish-actions.pod:2739
27747 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27753 #: ../fish/guestfish-actions.pod:2745
27754 msgid "lvm-remove-all"
27759 #: ../fish/guestfish-actions.pod:2747
27762 " lvm-remove-all\n"
27768 #: ../fish/guestfish-actions.pod:2755
27769 msgid "lvm-set-filter"
27774 #: ../fish/guestfish-actions.pod:2757
27777 " lvm-set-filter 'devices ...'\n"
27783 #: ../fish/guestfish-actions.pod:2782
27789 #: ../fish/guestfish-actions.pod:2784
27792 " lvremove device\n"
27798 #: ../fish/guestfish-actions.pod:2792
27804 #: ../fish/guestfish-actions.pod:2794
27807 " lvrename logvol newlogvol\n"
27813 #: ../fish/guestfish-actions.pod:2798
27819 #: ../fish/guestfish-actions.pod:2800
27822 " lvresize device mbytes\n"
27828 #: ../fish/guestfish-actions.pod:2806
27829 msgid "lvresize-free"
27834 #: ../fish/guestfish-actions.pod:2808
27837 " lvresize-free lv percent\n"
27843 #: ../fish/guestfish-actions.pod:2816
27849 #: ../fish/guestfish-actions.pod:2818
27858 #: ../fish/guestfish-actions.pod:2826
27859 msgid "See also L</lvs-full>, L</list-filesystems>."
27864 #: ../fish/guestfish-actions.pod:2828
27870 #: ../fish/guestfish-actions.pod:2830
27879 #: ../fish/guestfish-actions.pod:2835
27885 #: ../fish/guestfish-actions.pod:2837
27894 #: ../fish/guestfish-actions.pod:2841
27900 #: ../fish/guestfish-actions.pod:2843
27903 " lxattrlist path 'names ...'\n"
27909 #: ../fish/guestfish-actions.pod:2859
27911 "This call is intended for programs that want to efficiently list a directory "
27912 "contents without making many round-trips. See also L</lstatlist> for a "
27913 "similarly efficient call for getting standard stats. Very long directory "
27914 "listings might cause the protocol message size to be exceeded, causing this "
27915 "call to fail. The caller must split up such requests into smaller groups of "
27921 #: ../fish/guestfish-actions.pod:2867
27927 #: ../fish/guestfish-actions.pod:2869
27936 #: ../fish/guestfish-actions.pod:2873
27942 #: ../fish/guestfish-actions.pod:2875
27945 " mkdir-mode path mode\n"
27951 #: ../fish/guestfish-actions.pod:2884
27952 msgid "See also L</mkdir>, L</umask>"
27957 #: ../fish/guestfish-actions.pod:2886
27963 #: ../fish/guestfish-actions.pod:2888
27972 #: ../fish/guestfish-actions.pod:2893
27978 #: ../fish/guestfish-actions.pod:2895
27981 " mkdtemp template\n"
27987 #: ../fish/guestfish-actions.pod:2916
27993 #: ../fish/guestfish-actions.pod:2918
27996 " mke2fs-J fstype blocksize device journal\n"
28002 #: ../fish/guestfish-actions.pod:2926
28003 msgid "See also L</mke2journal>."
28008 #: ../fish/guestfish-actions.pod:2928
28014 #: ../fish/guestfish-actions.pod:2930
28017 " mke2fs-JL fstype blocksize device label\n"
28023 #: ../fish/guestfish-actions.pod:2935
28024 msgid "See also L</mke2journal-L>."
28029 #: ../fish/guestfish-actions.pod:2937
28035 #: ../fish/guestfish-actions.pod:2939
28038 " mke2fs-JU fstype blocksize device uuid\n"
28044 #: ../fish/guestfish-actions.pod:2944
28045 msgid "See also L</mke2journal-U>."
28050 #: ../fish/guestfish-actions.pod:2946
28051 msgid "mke2journal"
28056 #: ../fish/guestfish-actions.pod:2948
28059 " mke2journal blocksize device\n"
28065 #: ../fish/guestfish-actions.pod:2955
28066 msgid "mke2journal-L"
28071 #: ../fish/guestfish-actions.pod:2957
28074 " mke2journal-L blocksize label device\n"
28080 #: ../fish/guestfish-actions.pod:2961
28081 msgid "mke2journal-U"
28086 #: ../fish/guestfish-actions.pod:2963
28089 " mke2journal-U blocksize uuid device\n"
28095 #: ../fish/guestfish-actions.pod:2967
28101 #: ../fish/guestfish-actions.pod:2969
28104 " mkfifo mode path\n"
28110 #: ../fish/guestfish-actions.pod:2971
28112 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28113 "is just a convenient wrapper around L</mknod>."
28118 #: ../fish/guestfish-actions.pod:2977
28124 #: ../fish/guestfish-actions.pod:2979
28127 " mkfs fstype device\n"
28133 #: ../fish/guestfish-actions.pod:2985
28139 #: ../fish/guestfish-actions.pod:2987
28142 " mkfs-b fstype blocksize device\n"
28148 #: ../fish/guestfish-actions.pod:2989
28150 "This call is similar to L</mkfs>, but it allows you to control the block "
28151 "size of the resulting filesystem. Supported block sizes depend on the "
28152 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28157 #: ../fish/guestfish-actions.pod:3004
28162 #: ../fish/guestfish-actions.pod:3006
28165 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28171 #: ../fish/guestfish-actions.pod:3041
28172 msgid "mkmountpoint"
28177 #: ../fish/guestfish-actions.pod:3043
28180 " mkmountpoint exemptpath\n"
28186 #: ../fish/guestfish-actions.pod:3045
28188 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28189 "to create extra mountpoints before mounting the first filesystem."
28194 #: ../fish/guestfish-actions.pod:3069
28196 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28197 "unexpected errors if you try to mix these calls. It is safest to manually "
28198 "unmount filesystems and remove mountpoints after use."
28203 #: ../fish/guestfish-actions.pod:3073
28205 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28206 "for this to work for manual mountpoints, you must ensure that the innermost "
28207 "mountpoints have the longest pathnames, as in the example code above."
28211 #: ../fish/guestfish-actions.pod:3080
28213 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28214 "L</umount-all> to be called when the handle is closed which can also trigger "
28220 #: ../fish/guestfish-actions.pod:3084
28226 #: ../fish/guestfish-actions.pod:3086
28229 " mknod mode devmajor devminor path\n"
28235 #: ../fish/guestfish-actions.pod:3096
28237 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28238 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28239 "regular file). These constants are available in the standard Linux header "
28240 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28241 "wrappers around this command which bitwise OR in the appropriate constant "
28247 #: ../fish/guestfish-actions.pod:3106
28253 #: ../fish/guestfish-actions.pod:3108
28256 " mknod-b mode devmajor devminor path\n"
28262 #: ../fish/guestfish-actions.pod:3110
28264 "This call creates a block device node called C<path> with mode C<mode> and "
28265 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28266 "wrapper around L</mknod>."
28271 #: ../fish/guestfish-actions.pod:3116
28277 #: ../fish/guestfish-actions.pod:3118
28280 " mknod-c mode devmajor devminor path\n"
28286 #: ../fish/guestfish-actions.pod:3120
28288 "This call creates a char device node called C<path> with mode C<mode> and "
28289 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28290 "wrapper around L</mknod>."
28295 #: ../fish/guestfish-actions.pod:3126
28301 #: ../fish/guestfish-actions.pod:3128
28310 #: ../fish/guestfish-actions.pod:3132
28316 #: ../fish/guestfish-actions.pod:3134
28319 " mkswap-L label device\n"
28325 #: ../fish/guestfish-actions.pod:3142
28331 #: ../fish/guestfish-actions.pod:3144
28334 " mkswap-U uuid device\n"
28340 #: ../fish/guestfish-actions.pod:3148
28341 msgid "mkswap-file"
28346 #: ../fish/guestfish-actions.pod:3150
28349 " mkswap-file path\n"
28355 #: ../fish/guestfish-actions.pod:3154
28357 "This command just writes a swap file signature to an existing file. To "
28358 "create the file itself, use something like L</fallocate>."
28363 #: ../fish/guestfish-actions.pod:3157
28369 #: ../fish/guestfish-actions.pod:3159
28372 " modprobe modulename\n"
28378 #: ../fish/guestfish-actions.pod:3166
28384 #: ../fish/guestfish-actions.pod:3168
28387 " mount device mountpoint\n"
28393 #: ../fish/guestfish-actions.pod:3184
28395 "B<Important note:> When you use this call, the filesystem options C<sync> "
28396 "and C<noatime> are set implicitly. This was originally done because we "
28397 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28398 "very large negative performance impact and negligible effect on "
28399 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28400 "code that needs performance, and instead use L</mount-options> (use an empty "
28401 "string for the first parameter if you don't want any options)."
28406 #: ../fish/guestfish-actions.pod:3194
28412 #: ../fish/guestfish-actions.pod:3196
28415 " mount-loop file mountpoint\n"
28421 #: ../fish/guestfish-actions.pod:3202
28422 msgid "mount-options"
28427 #: ../fish/guestfish-actions.pod:3204
28430 " mount-options options device mountpoint\n"
28436 #: ../fish/guestfish-actions.pod:3206
28438 "This is the same as the L</mount> command, but it allows you to set the "
28439 "mount options as for the L<mount(8)> I<-o> flag."
28444 #: ../fish/guestfish-actions.pod:3214
28450 #: ../fish/guestfish-actions.pod:3216
28453 " mount-ro device mountpoint\n"
28459 #: ../fish/guestfish-actions.pod:3218
28461 "This is the same as the L</mount> command, but it mounts the filesystem with "
28462 "the read-only (I<-o ro>) flag."
28467 #: ../fish/guestfish-actions.pod:3221
28473 #: ../fish/guestfish-actions.pod:3223
28476 " mount-vfs options vfstype device mountpoint\n"
28482 #: ../fish/guestfish-actions.pod:3225
28484 "This is the same as the L</mount> command, but it allows you to set both the "
28485 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28490 #: ../fish/guestfish-actions.pod:3229
28491 msgid "mountpoints"
28496 #: ../fish/guestfish-actions.pod:3231
28505 #: ../fish/guestfish-actions.pod:3233
28507 "This call is similar to L</mounts>. That call returns a list of devices. "
28508 "This one returns a hash table (map) of device name to directory where the "
28509 "device is mounted."
28514 #: ../fish/guestfish-actions.pod:3237
28520 #: ../fish/guestfish-actions.pod:3239
28529 #: ../fish/guestfish-actions.pod:3246
28530 msgid "See also: L</mountpoints>"
28535 #: ../fish/guestfish-actions.pod:3248
28541 #: ../fish/guestfish-actions.pod:3250
28550 #: ../fish/guestfish-actions.pod:3255
28551 msgid "ntfs-3g-probe"
28556 #: ../fish/guestfish-actions.pod:3257
28559 " ntfs-3g-probe true|false device\n"
28565 #: ../fish/guestfish-actions.pod:3271
28571 #: ../fish/guestfish-actions.pod:3273
28574 " ntfsresize device\n"
28580 #: ../fish/guestfish-actions.pod:3279
28581 msgid "ntfsresize-size"
28586 #: ../fish/guestfish-actions.pod:3281
28589 " ntfsresize-size device size\n"
28595 #: ../fish/guestfish-actions.pod:3283
28597 "This command is the same as L</ntfsresize> except that it allows you to "
28598 "specify the new size (in bytes) explicitly."
28603 #: ../fish/guestfish-actions.pod:3286
28609 #: ../fish/guestfish-actions.pod:3288
28612 " part-add device prlogex startsect endsect\n"
28618 #: ../fish/guestfish-actions.pod:3290
28620 "This command adds a partition to C<device>. If there is no partition table "
28621 "on the device, call L</part-init> first."
28626 #: ../fish/guestfish-actions.pod:3302
28628 "Creating a partition which covers the whole disk is not so easy. Use L</"
28629 "part-disk> to do that."
28634 #: ../fish/guestfish-actions.pod:3305
28640 #: ../fish/guestfish-actions.pod:3307
28643 " part-del device partnum\n"
28649 #: ../fish/guestfish-actions.pod:3315
28655 #: ../fish/guestfish-actions.pod:3317
28658 " part-disk device parttype\n"
28664 #: ../fish/guestfish-actions.pod:3319
28666 "This command is simply a combination of L</part-init> followed by L</part-"
28667 "add> to create a single primary partition covering the whole disk."
28672 #: ../fish/guestfish-actions.pod:3323
28674 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28675 "possible values are described in L</part-init>."
28680 #: ../fish/guestfish-actions.pod:3329
28681 msgid "part-get-bootable"
28686 #: ../fish/guestfish-actions.pod:3331
28689 " part-get-bootable device partnum\n"
28695 #: ../fish/guestfish-actions.pod:3336
28696 msgid "See also L</part-set-bootable>."
28701 #: ../fish/guestfish-actions.pod:3338
28702 msgid "part-get-mbr-id"
28707 #: ../fish/guestfish-actions.pod:3340
28710 " part-get-mbr-id device partnum\n"
28716 #: ../fish/guestfish-actions.pod:3345 ../fish/guestfish-actions.pod:3483
28718 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28719 "undefined results for other partition table types (see L</part-get-"
28725 #: ../fish/guestfish-actions.pod:3349
28726 msgid "part-get-parttype"
28731 #: ../fish/guestfish-actions.pod:3351
28734 " part-get-parttype device\n"
28740 #: ../fish/guestfish-actions.pod:3356
28742 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28743 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28744 "possible, although unusual. See L</part-init> for a full list."
28749 #: ../fish/guestfish-actions.pod:3361
28755 #: ../fish/guestfish-actions.pod:3363
28758 " part-init device parttype\n"
28764 #: ../fish/guestfish-actions.pod:3369
28766 "Initially there are no partitions. Following this, you should call L</part-"
28767 "add> for each partition required."
28772 #: ../fish/guestfish-actions.pod:3432
28778 #: ../fish/guestfish-actions.pod:3434
28781 " part-list device\n"
28787 #: ../fish/guestfish-actions.pod:3449
28789 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28790 "the device's sector size, see L</blockdev-getss>."
28795 #: ../fish/guestfish-actions.pod:3462
28796 msgid "part-set-bootable"
28801 #: ../fish/guestfish-actions.pod:3464
28804 " part-set-bootable device partnum true|false\n"
28810 #: ../fish/guestfish-actions.pod:3473
28811 msgid "part-set-mbr-id"
28816 #: ../fish/guestfish-actions.pod:3475
28819 " part-set-mbr-id device partnum idbyte\n"
28825 #: ../fish/guestfish-actions.pod:3487
28826 msgid "part-set-name"
28831 #: ../fish/guestfish-actions.pod:3489
28834 " part-set-name device partnum name\n"
28840 #: ../fish/guestfish-actions.pod:3497
28841 msgid "part-to-dev"
28846 #: ../fish/guestfish-actions.pod:3499
28849 " part-to-dev partition\n"
28855 #: ../fish/guestfish-actions.pod:3505
28857 "The named partition must exist, for example as a string returned from L</"
28858 "list-partitions>."
28863 #: ../fish/guestfish-actions.pod:3508
28864 msgid "ping-daemon"
28869 #: ../fish/guestfish-actions.pod:3510
28878 #: ../fish/guestfish-actions.pod:3517
28884 #: ../fish/guestfish-actions.pod:3519
28887 " pread path count offset\n"
28893 #: ../fish/guestfish-actions.pod:3527
28894 msgid "See also L</pwrite>, L</pread-device>."
28899 #: ../fish/guestfish-actions.pod:3532
28900 msgid "pread-device"
28905 #: ../fish/guestfish-actions.pod:3534
28908 " pread-device device count offset\n"
28914 #: ../fish/guestfish-actions.pod:3542
28915 msgid "See also L</pread>."
28920 #: ../fish/guestfish-actions.pod:3547
28926 #: ../fish/guestfish-actions.pod:3549
28929 " pvcreate device\n"
28935 #: ../fish/guestfish-actions.pod:3555
28941 #: ../fish/guestfish-actions.pod:3557
28944 " pvremove device\n"
28950 #: ../fish/guestfish-actions.pod:3566
28956 #: ../fish/guestfish-actions.pod:3568
28959 " pvresize device\n"
28965 #: ../fish/guestfish-actions.pod:3573
28966 msgid "pvresize-size"
28971 #: ../fish/guestfish-actions.pod:3575
28974 " pvresize-size device size\n"
28980 #: ../fish/guestfish-actions.pod:3577
28982 "This command is the same as L</pvresize> except that it allows you to "
28983 "specify the new size (in bytes) explicitly."
28988 #: ../fish/guestfish-actions.pod:3580
28994 #: ../fish/guestfish-actions.pod:3582
29003 #: ../fish/guestfish-actions.pod:3590
29004 msgid "See also L</pvs-full>."
29009 #: ../fish/guestfish-actions.pod:3592
29015 #: ../fish/guestfish-actions.pod:3594
29024 #: ../fish/guestfish-actions.pod:3599
29030 #: ../fish/guestfish-actions.pod:3601
29039 #: ../fish/guestfish-actions.pod:3605
29045 #: ../fish/guestfish-actions.pod:3607
29048 " pwrite path content offset\n"
29054 #: ../fish/guestfish-actions.pod:3618
29055 msgid "See also L</pread>, L</pwrite-device>."
29060 #: ../fish/guestfish-actions.pod:3623
29061 msgid "pwrite-device"
29066 #: ../fish/guestfish-actions.pod:3625
29069 " pwrite-device device content offset\n"
29075 #: ../fish/guestfish-actions.pod:3635
29076 msgid "See also L</pwrite>."
29081 #: ../fish/guestfish-actions.pod:3640
29087 #: ../fish/guestfish-actions.pod:3642
29090 " read-file path\n"
29096 #: ../fish/guestfish-actions.pod:3647
29098 "Unlike L</cat>, this function can correctly handle files that contain "
29099 "embedded ASCII NUL characters. However unlike L</download>, this function "
29100 "is limited in the total size of file that can be handled."
29105 #: ../fish/guestfish-actions.pod:3655
29111 #: ../fish/guestfish-actions.pod:3657
29114 " read-lines path\n"
29120 #: ../fish/guestfish-actions.pod:3664
29122 "Note that this function cannot correctly handle binary files (specifically, "
29123 "files containing C<\\0> character which is treated as end of line). For "
29124 "those you need to use the L</read-file> function which has a more complex "
29130 #: ../fish/guestfish-actions.pod:3669
29136 #: ../fish/guestfish-actions.pod:3671
29145 #: ../fish/guestfish-actions.pod:3723
29147 "This function is primarily intended for use by programs. To get a simple "
29148 "list of names, use L</ls>. To get a printable directory for human "
29149 "consumption, use L</ll>."
29154 #: ../fish/guestfish-actions.pod:3727
29160 #: ../fish/guestfish-actions.pod:3729
29169 #: ../fish/guestfish-actions.pod:3733
29170 msgid "readlinklist"
29175 #: ../fish/guestfish-actions.pod:3735
29178 " readlinklist path 'names ...'\n"
29184 #: ../fish/guestfish-actions.pod:3759
29190 #: ../fish/guestfish-actions.pod:3761
29199 #: ../fish/guestfish-actions.pod:3766
29200 msgid "removexattr"
29205 #: ../fish/guestfish-actions.pod:3768
29208 " removexattr xattr path\n"
29214 #: ../fish/guestfish-actions.pod:3773
29215 msgid "See also: L</lremovexattr>, L<attr(5)>."
29220 #: ../fish/guestfish-actions.pod:3775
29226 #: ../fish/guestfish-actions.pod:3777
29229 " resize2fs device\n"
29235 #: ../fish/guestfish-actions.pod:3782
29237 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29238 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29239 "gives an error about this and sometimes not. In any case, it is always safe "
29240 "to call L</e2fsck-f> before calling this function."
29244 #: ../fish/guestfish-actions.pod:3788
29245 msgid "resize2fs-M"
29249 #: ../fish/guestfish-actions.pod:3790
29252 " resize2fs-M device\n"
29257 #: ../fish/guestfish-actions.pod:3792
29259 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29260 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
29265 #: ../fish/guestfish-actions.pod:3796
29267 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29268 "and read the C<Block size> and C<Block count> values. These two numbers, "
29269 "multiplied together, give the resulting size of the minimal filesystem in "
29275 #: ../fish/guestfish-actions.pod:3801
29276 msgid "resize2fs-size"
29281 #: ../fish/guestfish-actions.pod:3803
29284 " resize2fs-size device size\n"
29290 #: ../fish/guestfish-actions.pod:3805
29292 "This command is the same as L</resize2fs> except that it allows you to "
29293 "specify the new size (in bytes) explicitly."
29298 #: ../fish/guestfish-actions.pod:3808
29304 #: ../fish/guestfish-actions.pod:3810
29313 #: ../fish/guestfish-actions.pod:3814
29319 #: ../fish/guestfish-actions.pod:3816
29328 #: ../fish/guestfish-actions.pod:3822
29334 #: ../fish/guestfish-actions.pod:3824
29343 #: ../fish/guestfish-actions.pod:3828
29344 msgid "rmmountpoint"
29349 #: ../fish/guestfish-actions.pod:3830
29352 " rmmountpoint exemptpath\n"
29358 #: ../fish/guestfish-actions.pod:3832
29360 "This calls removes a mountpoint that was previously created with L</"
29361 "mkmountpoint>. See L</mkmountpoint> for full details."
29366 #: ../fish/guestfish-actions.pod:3836
29367 msgid "scrub-device"
29372 #: ../fish/guestfish-actions.pod:3838
29375 " scrub-device device\n"
29381 #: ../fish/guestfish-actions.pod:3849
29387 #: ../fish/guestfish-actions.pod:3851
29390 " scrub-file file\n"
29396 #: ../fish/guestfish-actions.pod:3861
29397 msgid "scrub-freespace"
29402 #: ../fish/guestfish-actions.pod:3863
29405 " scrub-freespace dir\n"
29411 #: ../fish/guestfish-actions.pod:3865
29413 "This command creates the directory C<dir> and then fills it with files until "
29414 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29415 "deletes them. The intention is to scrub any free space on the partition "
29416 "containing C<dir>."
29421 #: ../fish/guestfish-actions.pod:3874
29427 #: ../fish/guestfish-actions.pod:3876
29433 #: ../fish/guestfish-actions.pod:3878
29436 " set-append append\n"
29441 #: ../fish/guestfish-actions.pod:3889
29442 msgid "set-attach-method"
29446 #: ../fish/guestfish-actions.pod:3891
29447 msgid "attach-method"
29451 #: ../fish/guestfish-actions.pod:3893
29454 " set-attach-method attachmethod\n"
29460 #: ../fish/guestfish-actions.pod:3915
29461 msgid "set-autosync"
29466 #: ../fish/guestfish-actions.pod:3917
29472 #: ../fish/guestfish-actions.pod:3919
29475 " set-autosync true|false\n"
29481 #: ../fish/guestfish-actions.pod:3929
29487 #: ../fish/guestfish-actions.pod:3931
29493 #: ../fish/guestfish-actions.pod:3933
29496 " set-direct true|false\n"
29502 #: ../fish/guestfish-actions.pod:3939
29504 "One consequence of this is that log messages aren't caught by the library "
29505 "and handled by L</set-log-message-callback>, but go straight to stdout."
29510 #: ../fish/guestfish-actions.pod:3948
29511 msgid "set-e2label"
29516 #: ../fish/guestfish-actions.pod:3950
29519 " set-e2label device label\n"
29525 #: ../fish/guestfish-actions.pod:3956
29527 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29528 "label on a filesystem."
29533 #: ../fish/guestfish-actions.pod:3959
29539 #: ../fish/guestfish-actions.pod:3961
29542 " set-e2uuid device uuid\n"
29548 #: ../fish/guestfish-actions.pod:3968
29550 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29551 "UUID of a filesystem."
29556 #: ../fish/guestfish-actions.pod:3971
29557 msgid "set-memsize"
29562 #: ../fish/guestfish-actions.pod:3973
29568 #: ../fish/guestfish-actions.pod:3975
29571 " set-memsize memsize\n"
29577 #: ../fish/guestfish-actions.pod:3977
29579 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29580 "This only has any effect if called before L</launch>."
29585 #: ../fish/guestfish-actions.pod:3988
29586 msgid "set-network"
29591 #: ../fish/guestfish-actions.pod:3990
29597 #: ../fish/guestfish-actions.pod:3992
29600 " set-network true|false\n"
29606 #: ../fish/guestfish-actions.pod:4000
29608 "You must call this before calling L</launch>, otherwise it has no effect."
29613 #: ../fish/guestfish-actions.pod:4003
29619 #: ../fish/guestfish-actions.pod:4005
29625 #: ../fish/guestfish-actions.pod:4007
29628 " set-path searchpath\n"
29634 #: ../fish/guestfish-actions.pod:4016
29640 #: ../fish/guestfish-actions.pod:4018
29646 #: ../fish/guestfish-actions.pod:4020
29655 #: ../fish/guestfish-actions.pod:4040
29656 msgid "set-recovery-proc"
29661 #: ../fish/guestfish-actions.pod:4042
29662 msgid "recovery-proc"
29667 #: ../fish/guestfish-actions.pod:4044
29670 " set-recovery-proc true|false\n"
29676 #: ../fish/guestfish-actions.pod:4046
29678 "If this is called with the parameter C<false> then L</launch> does not "
29679 "create a recovery process. The purpose of the recovery process is to stop "
29680 "runaway qemu processes in the case where the main program aborts abruptly."
29685 #: ../fish/guestfish-actions.pod:4051
29687 "This only has any effect if called before L</launch>, and the default is "
29693 #: ../fish/guestfish-actions.pod:4060
29694 msgid "set-selinux"
29699 #: ../fish/guestfish-actions.pod:4062
29705 #: ../fish/guestfish-actions.pod:4064
29708 " set-selinux true|false\n"
29714 #: ../fish/guestfish-actions.pod:4075
29720 #: ../fish/guestfish-actions.pod:4077
29726 #: ../fish/guestfish-actions.pod:4079
29729 " set-trace true|false\n"
29734 #: ../fish/guestfish-actions.pod:4091
29736 "Trace messages are normally sent to C<stderr>, unless you register a "
29737 "callback to send them somewhere else (see L</set-event-callback>)."
29742 #: ../fish/guestfish-actions.pod:4095
29743 msgid "set-verbose"
29748 #: ../fish/guestfish-actions.pod:4097
29754 #: ../fish/guestfish-actions.pod:4099
29757 " set-verbose true|false\n"
29762 #: ../fish/guestfish-actions.pod:4106
29764 "Verbose messages are normally sent to C<stderr>, unless you register a "
29765 "callback to send them somewhere else (see L</set-event-callback>)."
29770 #: ../fish/guestfish-actions.pod:4110
29776 #: ../fish/guestfish-actions.pod:4112
29779 " setcon context\n"
29785 #: ../fish/guestfish-actions.pod:4119
29791 #: ../fish/guestfish-actions.pod:4121
29794 " setxattr xattr val vallen path\n"
29800 #: ../fish/guestfish-actions.pod:4127
29801 msgid "See also: L</lsetxattr>, L<attr(5)>."
29806 #: ../fish/guestfish-actions.pod:4129
29812 #: ../fish/guestfish-actions.pod:4131
29815 " sfdisk device cyls heads sectors 'lines ...'\n"
29821 #: ../fish/guestfish-actions.pod:4153
29822 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
29827 #: ../fish/guestfish-actions.pod:4159
29833 #: ../fish/guestfish-actions.pod:4161
29836 " sfdiskM device 'lines ...'\n"
29842 #: ../fish/guestfish-actions.pod:4163
29844 "This is a simplified interface to the L</sfdisk> command, where partition "
29845 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
29846 "you don't need to specify the cyls, heads and sectors parameters which were "
29847 "rarely if ever used anyway."
29852 #: ../fish/guestfish-actions.pod:4169
29853 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
29858 #: ../fish/guestfish-actions.pod:4175
29864 #: ../fish/guestfish-actions.pod:4177
29867 " sfdisk-N device partnum cyls heads sectors line\n"
29873 #: ../fish/guestfish-actions.pod:4182
29875 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
29876 "cyls/heads/sectors parameters."
29881 #: ../fish/guestfish-actions.pod:4185
29882 msgid "See also: L</part-add>"
29887 #: ../fish/guestfish-actions.pod:4190
29888 msgid "sfdisk-disk-geometry"
29893 #: ../fish/guestfish-actions.pod:4192
29896 " sfdisk-disk-geometry device\n"
29902 #: ../fish/guestfish-actions.pod:4194
29904 "This displays the disk geometry of C<device> read from the partition table. "
29905 "Especially in the case where the underlying block device has been resized, "
29906 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
29907 "kernel-geometry>)."
29912 #: ../fish/guestfish-actions.pod:4202
29913 msgid "sfdisk-kernel-geometry"
29918 #: ../fish/guestfish-actions.pod:4204
29921 " sfdisk-kernel-geometry device\n"
29927 #: ../fish/guestfish-actions.pod:4211
29933 #: ../fish/guestfish-actions.pod:4213
29936 " sfdisk-l device\n"
29942 #: ../fish/guestfish-actions.pod:4219
29943 msgid "See also: L</part-list>"
29948 #: ../fish/guestfish-actions.pod:4221
29954 #: ../fish/guestfish-actions.pod:4223
29963 #: ../fish/guestfish-actions.pod:4228
29964 msgid "This is like L</command>, but passes the command to:"
29969 #: ../fish/guestfish-actions.pod:4236
29970 msgid "All the provisos about L</command> apply to this call."
29975 #: ../fish/guestfish-actions.pod:4238
29981 #: ../fish/guestfish-actions.pod:4240
29984 " sh-lines command\n"
29990 #: ../fish/guestfish-actions.pod:4242
29991 msgid "This is the same as L</sh>, but splits the result into a list of lines."
29996 #: ../fish/guestfish-actions.pod:4245
29997 msgid "See also: L</command-lines>"
30002 #: ../fish/guestfish-actions.pod:4247
30008 #: ../fish/guestfish-actions.pod:4249
30017 #: ../fish/guestfish-actions.pod:4253
30023 #: ../fish/guestfish-actions.pod:4255
30032 #: ../fish/guestfish-actions.pod:4261
30038 #: ../fish/guestfish-actions.pod:4263
30047 #: ../fish/guestfish-actions.pod:4271
30053 #: ../fish/guestfish-actions.pod:4273
30062 #: ../fish/guestfish-actions.pod:4281
30068 #: ../fish/guestfish-actions.pod:4283
30071 " strings-e encoding path\n"
30077 #: ../fish/guestfish-actions.pod:4285
30079 "This is like the L</strings> command, but allows you to specify the encoding "
30080 "of strings that are looked for in the source file C<path>."
30085 #: ../fish/guestfish-actions.pod:4295
30087 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30088 "ISO-8859-X (this is what L</strings> uses)."
30093 #: ../fish/guestfish-actions.pod:4327
30094 msgid "swapoff-device"
30099 #: ../fish/guestfish-actions.pod:4329
30102 " swapoff-device device\n"
30108 #: ../fish/guestfish-actions.pod:4331
30110 "This command disables the libguestfs appliance swap device or partition "
30111 "named C<device>. See L</swapon-device>."
30116 #: ../fish/guestfish-actions.pod:4335
30117 msgid "swapoff-file"
30122 #: ../fish/guestfish-actions.pod:4337
30125 " swapoff-file file\n"
30131 #: ../fish/guestfish-actions.pod:4341
30132 msgid "swapoff-label"
30137 #: ../fish/guestfish-actions.pod:4343
30140 " swapoff-label label\n"
30146 #: ../fish/guestfish-actions.pod:4348
30147 msgid "swapoff-uuid"
30152 #: ../fish/guestfish-actions.pod:4350
30155 " swapoff-uuid uuid\n"
30161 #: ../fish/guestfish-actions.pod:4355
30162 msgid "swapon-device"
30167 #: ../fish/guestfish-actions.pod:4357
30170 " swapon-device device\n"
30176 #: ../fish/guestfish-actions.pod:4359
30178 "This command enables the libguestfs appliance to use the swap device or "
30179 "partition named C<device>. The increased memory is made available for all "
30180 "commands, for example those run using L</command> or L</sh>."
30185 #: ../fish/guestfish-actions.pod:4371
30186 msgid "swapon-file"
30191 #: ../fish/guestfish-actions.pod:4373
30194 " swapon-file file\n"
30200 #: ../fish/guestfish-actions.pod:4375
30202 "This command enables swap to a file. See L</swapon-device> for other notes."
30207 #: ../fish/guestfish-actions.pod:4378
30208 msgid "swapon-label"
30213 #: ../fish/guestfish-actions.pod:4380
30216 " swapon-label label\n"
30222 #: ../fish/guestfish-actions.pod:4382
30224 "This command enables swap to a labeled swap partition. See L</swapon-"
30225 "device> for other notes."
30230 #: ../fish/guestfish-actions.pod:4385
30231 msgid "swapon-uuid"
30236 #: ../fish/guestfish-actions.pod:4387
30239 " swapon-uuid uuid\n"
30245 #: ../fish/guestfish-actions.pod:4389
30247 "This command enables swap to a swap partition with the given UUID. See L</"
30248 "swapon-device> for other notes."
30253 #: ../fish/guestfish-actions.pod:4392
30259 #: ../fish/guestfish-actions.pod:4394
30268 #: ../fish/guestfish-actions.pod:4402
30274 #: ../fish/guestfish-actions.pod:4404
30283 #: ../fish/guestfish-actions.pod:4412
30289 #: ../fish/guestfish-actions.pod:4414
30292 " tail-n nrlines path\n"
30298 #: ../fish/guestfish-actions.pod:4427
30304 #: ../fish/guestfish-actions.pod:4429
30307 " tar-in (tarfile|-) directory\n"
30313 #: ../fish/guestfish-actions.pod:4434
30314 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30319 #: ../fish/guestfish-actions.pod:4439
30325 #: ../fish/guestfish-actions.pod:4441
30328 " tar-out directory (tarfile|-)\n"
30334 #: ../fish/guestfish-actions.pod:4446
30335 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30340 #: ../fish/guestfish-actions.pod:4451
30346 #: ../fish/guestfish-actions.pod:4453
30349 " tgz-in (tarball|-) directory\n"
30355 #: ../fish/guestfish-actions.pod:4458
30356 msgid "To upload an uncompressed tarball, use L</tar-in>."
30361 #: ../fish/guestfish-actions.pod:4462
30367 #: ../fish/guestfish-actions.pod:4464
30370 " tgz-out directory (tarball|-)\n"
30376 #: ../fish/guestfish-actions.pod:4469
30377 msgid "To download an uncompressed tarball, use L</tar-out>."
30382 #: ../fish/guestfish-actions.pod:4473
30388 #: ../fish/guestfish-actions.pod:4475
30397 #: ../fish/guestfish-actions.pod:4484
30403 #: ../fish/guestfish-actions.pod:4486
30412 #: ../fish/guestfish-actions.pod:4491
30413 msgid "truncate-size"
30418 #: ../fish/guestfish-actions.pod:4493
30421 " truncate-size path size\n"
30427 #: ../fish/guestfish-actions.pod:4498
30429 "If the current file size is less than C<size> then the file is extended to "
30430 "the required size with zero bytes. This creates a sparse file (ie. disk "
30431 "blocks are not allocated for the file until you write to it). To create a "
30432 "non-sparse file of zeroes, use L</fallocate64> instead."
30437 #: ../fish/guestfish-actions.pod:4504
30443 #: ../fish/guestfish-actions.pod:4506
30446 " tune2fs-l device\n"
30452 #: ../fish/guestfish-actions.pod:4516
30458 #: ../fish/guestfish-actions.pod:4518
30461 " txz-in (tarball|-) directory\n"
30467 #: ../fish/guestfish-actions.pod:4525
30473 #: ../fish/guestfish-actions.pod:4527
30476 " txz-out directory (tarball|-)\n"
30482 #: ../fish/guestfish-actions.pod:4534
30488 #: ../fish/guestfish-actions.pod:4536
30497 #: ../fish/guestfish-actions.pod:4550
30498 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30503 #: ../fish/guestfish-actions.pod:4555
30509 #: ../fish/guestfish-actions.pod:4557
30515 #: ../fish/guestfish-actions.pod:4559
30518 " umount pathordevice\n"
30524 #: ../fish/guestfish-actions.pod:4565
30530 #: ../fish/guestfish-actions.pod:4567
30531 msgid "unmount-all"
30536 #: ../fish/guestfish-actions.pod:4569
30545 #: ../fish/guestfish-actions.pod:4575
30551 #: ../fish/guestfish-actions.pod:4577
30554 " upload (filename|-) remotefilename\n"
30560 #: ../fish/guestfish-actions.pod:4584
30561 msgid "See also L</download>."
30566 #: ../fish/guestfish-actions.pod:4588
30567 msgid "upload-offset"
30572 #: ../fish/guestfish-actions.pod:4590
30575 " upload-offset (filename|-) remotefilename offset\n"
30581 #: ../fish/guestfish-actions.pod:4602
30583 "Note that there is no limit on the amount of data that can be uploaded with "
30584 "this call, unlike with L</pwrite>, and this call always writes the full "
30585 "amount unless an error occurs."
30590 #: ../fish/guestfish-actions.pod:4607
30591 msgid "See also L</upload>, L</pwrite>."
30596 #: ../fish/guestfish-actions.pod:4611
30602 #: ../fish/guestfish-actions.pod:4613
30605 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30611 #: ../fish/guestfish-actions.pod:4632
30617 #: ../fish/guestfish-actions.pod:4634
30626 #: ../fish/guestfish-actions.pod:4661
30628 "I<Note:> Don't use this call to test for availability of features. In "
30629 "enterprise distributions we backport features from later versions into "
30630 "earlier versions, making this an unreliable way to test for features. Use "
30631 "L</available> instead."
30636 #: ../fish/guestfish-actions.pod:4667
30642 #: ../fish/guestfish-actions.pod:4669
30645 " vfs-label device\n"
30651 #: ../fish/guestfish-actions.pod:4676
30652 msgid "To find a filesystem from the label, use L</findfs-label>."
30657 #: ../fish/guestfish-actions.pod:4678
30663 #: ../fish/guestfish-actions.pod:4680
30666 " vfs-type device\n"
30672 #: ../fish/guestfish-actions.pod:4690
30678 #: ../fish/guestfish-actions.pod:4692
30681 " vfs-uuid device\n"
30687 #: ../fish/guestfish-actions.pod:4699
30688 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30693 #: ../fish/guestfish-actions.pod:4701
30694 msgid "vg-activate"
30699 #: ../fish/guestfish-actions.pod:4703
30702 " vg-activate true|false 'volgroups ...'\n"
30708 #: ../fish/guestfish-actions.pod:4716
30709 msgid "vg-activate-all"
30714 #: ../fish/guestfish-actions.pod:4718
30717 " vg-activate-all true|false\n"
30723 #: ../fish/guestfish-actions.pod:4728
30729 #: ../fish/guestfish-actions.pod:4730
30732 " vgcreate volgroup 'physvols ...'\n"
30738 #: ../fish/guestfish-actions.pod:4735
30744 #: ../fish/guestfish-actions.pod:4737
30747 " vglvuuids vgname\n"
30753 #: ../fish/guestfish-actions.pod:4742
30755 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30756 "logical volumes and volume groups."
30761 #: ../fish/guestfish-actions.pod:4745
30762 msgid "See also L</vgpvuuids>."
30767 #: ../fish/guestfish-actions.pod:4747
30773 #: ../fish/guestfish-actions.pod:4749
30776 " vgpvuuids vgname\n"
30782 #: ../fish/guestfish-actions.pod:4754
30784 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30785 "physical volumes and volume groups."
30790 #: ../fish/guestfish-actions.pod:4757
30791 msgid "See also L</vglvuuids>."
30796 #: ../fish/guestfish-actions.pod:4759
30802 #: ../fish/guestfish-actions.pod:4761
30805 " vgremove vgname\n"
30811 #: ../fish/guestfish-actions.pod:4768
30817 #: ../fish/guestfish-actions.pod:4770
30820 " vgrename volgroup newvolgroup\n"
30826 #: ../fish/guestfish-actions.pod:4774
30832 #: ../fish/guestfish-actions.pod:4776
30841 #: ../fish/guestfish-actions.pod:4784
30842 msgid "See also L</vgs-full>."
30847 #: ../fish/guestfish-actions.pod:4786
30853 #: ../fish/guestfish-actions.pod:4788
30862 #: ../fish/guestfish-actions.pod:4793
30868 #: ../fish/guestfish-actions.pod:4795
30877 #: ../fish/guestfish-actions.pod:4800
30883 #: ../fish/guestfish-actions.pod:4802
30892 #: ../fish/guestfish-actions.pod:4806
30898 #: ../fish/guestfish-actions.pod:4808
30907 #: ../fish/guestfish-actions.pod:4813
30913 #: ../fish/guestfish-actions.pod:4815
30922 #: ../fish/guestfish-actions.pod:4820
30928 #: ../fish/guestfish-actions.pod:4822
30937 #: ../fish/guestfish-actions.pod:4827
30943 #: ../fish/guestfish-actions.pod:4829
30946 " write path content\n"
30952 #: ../fish/guestfish-actions.pod:4837
30958 #: ../fish/guestfish-actions.pod:4839
30961 " write-file path content size\n"
30967 #: ../fish/guestfish-actions.pod:4862
30973 #: ../fish/guestfish-actions.pod:4864
30976 " zegrep regex path\n"
30982 #: ../fish/guestfish-actions.pod:4872
30988 #: ../fish/guestfish-actions.pod:4874
30991 " zegrepi regex path\n"
30997 #: ../fish/guestfish-actions.pod:4882
31003 #: ../fish/guestfish-actions.pod:4884
31012 #: ../fish/guestfish-actions.pod:4892
31013 msgid "See also: L</zero-device>, L</scrub-device>."
31018 #: ../fish/guestfish-actions.pod:4894
31019 msgid "zero-device"
31024 #: ../fish/guestfish-actions.pod:4896
31027 " zero-device device\n"
31033 #: ../fish/guestfish-actions.pod:4898
31035 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31036 "which just zeroes the first few blocks of a device."
31041 #: ../fish/guestfish-actions.pod:4905
31047 #: ../fish/guestfish-actions.pod:4907
31050 " zerofree device\n"
31056 #: ../fish/guestfish-actions.pod:4920
31062 #: ../fish/guestfish-actions.pod:4922
31065 " zfgrep pattern path\n"
31071 #: ../fish/guestfish-actions.pod:4930
31077 #: ../fish/guestfish-actions.pod:4932
31080 " zfgrepi pattern path\n"
31086 #: ../fish/guestfish-actions.pod:4940
31092 #: ../fish/guestfish-actions.pod:4942
31095 " zfile meth path\n"
31101 #: ../fish/guestfish-actions.pod:4949
31103 "Since 1.0.63, use L</file> instead which can now process compressed files."
31108 #: ../fish/guestfish-actions.pod:4959
31114 #: ../fish/guestfish-actions.pod:4961
31117 " zgrep regex path\n"
31123 #: ../fish/guestfish-actions.pod:4969
31129 #: ../fish/guestfish-actions.pod:4971
31132 " zgrepi regex path\n"
31138 #: ../fish/guestfish-commands.pod:1
31144 #: ../fish/guestfish-commands.pod:3
31150 #: ../fish/guestfish-commands.pod:5
31153 " alloc filename size\n"
31159 #: ../fish/guestfish-commands.pod:7
31161 "This creates an empty (zeroed) file of the given size, and then adds so it "
31162 "can be further examined."
31167 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31168 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31173 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31174 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31179 #: ../fish/guestfish-commands.pod:14
31181 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31182 "image, see L</PREPARED DISK IMAGES>."
31187 #: ../fish/guestfish-commands.pod:17
31193 #: ../fish/guestfish-commands.pod:19
31196 " copy-in local [local ...] /remotedir\n"
31202 #: ../fish/guestfish-commands.pod:21
31204 "C<copy-in> copies local files or directories recursively into the disk "
31205 "image, placing them in the directory called C</remotedir> (which must "
31206 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31207 "other commands as necessary."
31212 #: ../fish/guestfish-commands.pod:26
31214 "Multiple local files and directories can be specified, but the last "
31215 "parameter must always be a remote directory. Wildcards cannot be used."
31220 #: ../fish/guestfish-commands.pod:30
31226 #: ../fish/guestfish-commands.pod:32
31229 " copy-out remote [remote ...] localdir\n"
31235 #: ../fish/guestfish-commands.pod:34
31237 "C<copy-out> copies remote files or directories recursively out of the disk "
31238 "image, placing them on the host disk in a local directory called C<localdir> "
31239 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31240 "download>, L</tar-out> and other commands as necessary."
31245 #: ../fish/guestfish-commands.pod:40
31247 "Multiple remote files and directories can be specified, but the last "
31248 "parameter must always be a local directory. To download to the current "
31249 "directory, use C<.> as in:"
31254 #: ../fish/guestfish-commands.pod:44
31257 " copy-out /home .\n"
31263 #: ../fish/guestfish-commands.pod:46
31265 "Wildcards cannot be used in the ordinary command, but you can use them with "
31266 "the help of L</glob> like this:"
31271 #: ../fish/guestfish-commands.pod:49
31274 " glob copy-out /home/* .\n"
31280 #: ../fish/guestfish-commands.pod:51
31286 #: ../fish/guestfish-commands.pod:53
31289 " echo [params ...]\n"
31295 #: ../fish/guestfish-commands.pod:55
31296 msgid "This echos the parameters to the terminal."
31301 #: ../fish/guestfish-commands.pod:57
31307 #: ../fish/guestfish-commands.pod:59
31313 #: ../fish/guestfish-commands.pod:61
31319 #: ../fish/guestfish-commands.pod:63
31328 #: ../fish/guestfish-commands.pod:65
31330 "This is used to edit a file. It downloads the file, edits it locally using "
31331 "your editor, then uploads the result."
31336 #: ../fish/guestfish-commands.pod:68
31338 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31339 "or C<emacs> you will get those corresponding editors."
31344 #: ../fish/guestfish-commands.pod:72
31350 #: ../fish/guestfish-commands.pod:74
31353 " glob command args...\n"
31359 #: ../fish/guestfish-commands.pod:76
31361 "Expand wildcards in any paths in the args list, and run C<command> "
31362 "repeatedly on each matching path."
31367 #: ../fish/guestfish-commands.pod:79
31368 msgid "See L</WILDCARDS AND GLOBBING>."
31373 #: ../fish/guestfish-commands.pod:81
31379 #: ../fish/guestfish-commands.pod:83
31382 " hexedit <filename|device>\n"
31383 " hexedit <filename|device> <max>\n"
31384 " hexedit <filename|device> <start> <max>\n"
31390 #: ../fish/guestfish-commands.pod:87
31392 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31398 #: ../fish/guestfish-commands.pod:90
31400 "This command works by downloading potentially the whole file or device, "
31401 "editing it locally, then uploading it. If the file or device is large, you "
31402 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31403 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31404 "usual modifiers allowed such as C<1M> (1 megabyte)."
31409 #: ../fish/guestfish-commands.pod:97
31410 msgid "For example to edit the first few sectors of a disk you might do:"
31415 #: ../fish/guestfish-commands.pod:100
31418 " hexedit /dev/sda 1M\n"
31424 #: ../fish/guestfish-commands.pod:102
31426 "which would allow you to edit anywhere within the first megabyte of the disk."
31431 #: ../fish/guestfish-commands.pod:105
31432 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31437 #: ../fish/guestfish-commands.pod:107
31440 " hexedit /dev/sda1 0x400 0x400\n"
31446 #: ../fish/guestfish-commands.pod:109
31447 msgid "(assuming the superblock is in the standard location)."
31452 #: ../fish/guestfish-commands.pod:111
31454 "This command requires the external L<hexedit(1)> program. You can specify "
31455 "another program to use by setting the C<HEXEDITOR> environment variable."
31460 #: ../fish/guestfish-commands.pod:115
31461 msgid "See also L</hexdump>."
31466 #: ../fish/guestfish-commands.pod:117
31472 #: ../fish/guestfish-commands.pod:119
31481 #: ../fish/guestfish-commands.pod:121
31483 "Change the local directory, ie. the current directory of guestfish itself."
31488 #: ../fish/guestfish-commands.pod:124
31489 msgid "Note that C<!cd> won't do what you might expect."
31494 #: ../fish/guestfish-commands.pod:126
31500 #: ../fish/guestfish-commands.pod:128
31506 #: ../fish/guestfish-commands.pod:130
31515 #: ../fish/guestfish-commands.pod:132
31516 msgid "Opens the manual page for guestfish."
31521 #: ../fish/guestfish-commands.pod:134
31527 #: ../fish/guestfish-commands.pod:136
31533 #: ../fish/guestfish-commands.pod:138
31542 #: ../fish/guestfish-commands.pod:140
31551 #: ../fish/guestfish-commands.pod:142
31552 msgid "This is used to view a file."
31557 #: ../fish/guestfish-commands.pod:144
31559 "The default viewer is C<$PAGER>. However if you use the alternate command "
31560 "C<less> you will get the C<less> command specifically."
31565 #: ../fish/guestfish-commands.pod:147
31571 #: ../fish/guestfish-commands.pod:149
31580 #: ../fish/guestfish-commands.pod:151
31582 "Close and reopen the libguestfs handle. It is not necessary to use this "
31583 "normally, because the handle is closed properly when guestfish exits. "
31584 "However this is occasionally useful for testing."
31589 #: ../fish/guestfish-commands.pod:155
31595 #: ../fish/guestfish-commands.pod:157
31598 " sparse filename size\n"
31604 #: ../fish/guestfish-commands.pod:159
31606 "This creates an empty sparse file of the given size, and then adds so it can "
31607 "be further examined."
31612 #: ../fish/guestfish-commands.pod:162
31614 "In all respects it works the same as the L</alloc> command, except that the "
31615 "image file is allocated sparsely, which means that disk blocks are not "
31616 "assigned to the file until they are needed. Sparse disk files only use "
31617 "space when written to, but they are slower and there is a danger you could "
31618 "run out of real disk space during a write operation."
31623 #: ../fish/guestfish-commands.pod:172
31629 #: ../fish/guestfish-commands.pod:174
31638 #: ../fish/guestfish-commands.pod:176
31640 "This command returns a list of the optional groups known to the daemon, and "
31641 "indicates which ones are supported by this build of the libguestfs appliance."
31646 #: ../fish/guestfish-commands.pod:180
31647 msgid "See also L<guestfs(3)/AVAILABILITY>."
31652 #: ../fish/guestfish-commands.pod:182
31658 #: ../fish/guestfish-commands.pod:184
31661 " time command args...\n"
31667 #: ../fish/guestfish-commands.pod:186
31669 "Run the command as usual, but print the elapsed time afterwards. This can "
31670 "be useful for benchmarking operations."
31675 #: ../test-tool/libguestfs-test-tool.pod:5
31676 msgid "libguestfs-test-tool - End user tests for libguestfs"
31681 #: ../test-tool/libguestfs-test-tool.pod:9
31684 " libguestfs-test-tool [--options]\n"
31690 #: ../test-tool/libguestfs-test-tool.pod:13
31692 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31693 "and developers, to allow them to check basic libguestfs functionality is "
31694 "working. This is needed because libguestfs occasionally breaks for reasons "
31695 "beyond our control: usually because of changes in the underlying qemu or "
31696 "kernel packages, or the host environment."
31701 #: ../test-tool/libguestfs-test-tool.pod:20
31702 msgid "If you suspect a problem in libguestfs, then just run:"
31707 #: ../test-tool/libguestfs-test-tool.pod:22
31710 " libguestfs-test-tool\n"
31716 #: ../test-tool/libguestfs-test-tool.pod:24
31717 msgid "It will print lots of diagnostic messages."
31722 #: ../test-tool/libguestfs-test-tool.pod:26
31723 msgid "If it runs to completion successfully, you will see this near the end:"
31728 #: ../test-tool/libguestfs-test-tool.pod:28
31731 " ===== TEST FINISHED OK =====\n"
31737 #: ../test-tool/libguestfs-test-tool.pod:30
31738 msgid "and the test tool will exit with code 0."
31743 #: ../test-tool/libguestfs-test-tool.pod:32
31745 "If it fails (and/or exits with non-zero error code), please paste the "
31746 "B<complete, unedited> output of the test tool into a bug report. More "
31747 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31753 #: ../test-tool/libguestfs-test-tool.pod:41
31759 #: ../test-tool/libguestfs-test-tool.pod:43
31760 msgid "Display short usage information and exit."
31765 #: ../test-tool/libguestfs-test-tool.pod:45
31766 msgid "I<--qemu qemu_binary>"
31771 #: ../test-tool/libguestfs-test-tool.pod:47
31773 "If you have downloaded another qemu binary, point this option at the full "
31774 "path of the binary to try it."
31779 #: ../test-tool/libguestfs-test-tool.pod:50
31780 msgid "I<--qemudir qemu_source_dir>"
31785 #: ../test-tool/libguestfs-test-tool.pod:52
31787 "If you have compiled qemu from source, point this option at the source "
31788 "directory to try it."
31793 #: ../test-tool/libguestfs-test-tool.pod:55
31794 msgid "I<--timeout N>"
31799 #: ../test-tool/libguestfs-test-tool.pod:57
31801 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31802 "does not usually need to be adjusted unless your machine is very slow."
31807 #: ../test-tool/libguestfs-test-tool.pod:63
31808 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31813 #: ../test-tool/libguestfs-test-tool.pod:65
31815 "If you have compiled another version of qemu from source and would like to "
31816 "try that, then you can use the I<--qemudir> option to point to the qemu "
31817 "source directory."
31822 #: ../test-tool/libguestfs-test-tool.pod:69
31824 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
31825 "option to point to the binary."
31830 #: ../test-tool/libguestfs-test-tool.pod:72
31832 "When using an alternate qemu with libguestfs, usually you would need to "
31833 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
31834 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
31835 "use either of the I<--qemudir> or I<--qemu> options."
31840 #: ../test-tool/libguestfs-test-tool.pod:79
31842 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
31843 "I<1> if there was an error."
31848 #: ../test-tool/libguestfs-test-tool.pod:84
31850 "For the full list of environment variables which may affect libguestfs, "
31851 "please see the L<guestfs(3)> manual page."
31856 #: ../test-tool/libguestfs-test-tool.pod:89
31857 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
31862 #: ../fuse/guestmount.pod:5
31864 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
31869 #: ../fuse/guestmount.pod:9
31872 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
31878 #: ../fuse/guestmount.pod:11
31881 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
31887 #: ../fuse/guestmount.pod:13
31890 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
31896 #: ../fuse/guestmount.pod:17
31898 "You must I<not> use C<guestmount> in read-write mode on live virtual "
31899 "machines. If you do this, you risk disk corruption in the VM."
31904 #: ../fuse/guestmount.pod:22
31906 "The guestmount program can be used to mount virtual machine filesystems and "
31907 "other disk images on the host. It uses libguestfs for access to the guest "
31908 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
31909 "a mountable device."
31914 #: ../fuse/guestmount.pod:27
31916 "Along with other options, you have to give at least one device (I<-a> "
31917 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
31918 "option) or use the I<-i> inspection option. How this works is better "
31919 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
31925 #: ../fuse/guestmount.pod:33
31927 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
31928 "by you, and the filesystem will not be visible to any other users unless you "
31929 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
31930 "the filesystem, use the C<fusermount -u> command."
31935 #: ../fuse/guestmount.pod:41
31937 "For a typical Windows guest which has its main filesystem on the first "
31943 #: ../fuse/guestmount.pod:44
31946 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
31952 #: ../fuse/guestmount.pod:46
31954 "For a typical Linux guest which has a /boot filesystem on the first "
31955 "partition, and the root filesystem on a logical volume:"
31960 #: ../fuse/guestmount.pod:49
31963 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
31969 #: ../fuse/guestmount.pod:51
31970 msgid "To get libguestfs to detect guest mountpoints for you:"
31975 #: ../fuse/guestmount.pod:53
31978 " guestmount -a guest.img -i --ro /mnt\n"
31984 #: ../fuse/guestmount.pod:55
31985 msgid "For a libvirt guest called \"Guest\" you could do:"
31990 #: ../fuse/guestmount.pod:57
31993 " guestmount -d Guest -i --ro /mnt\n"
31999 #: ../fuse/guestmount.pod:59
32001 "If you don't know what filesystems are contained in a guest or disk image, "
32002 "use L<virt-filesystems(1)> first:"
32007 #: ../fuse/guestmount.pod:62
32010 " virt-filesystems MyGuest\n"
32016 #: ../fuse/guestmount.pod:64
32018 "If you want to trace the libguestfs calls but without excessive debugging "
32019 "information, we recommend:"
32024 #: ../fuse/guestmount.pod:67
32027 " guestmount [...] --trace /mnt\n"
32033 #: ../fuse/guestmount.pod:69
32034 msgid "If you want to debug the program, we recommend:"
32039 #: ../fuse/guestmount.pod:71
32042 " guestmount [...] --trace --verbose /mnt\n"
32048 #: ../fuse/guestmount.pod:77
32049 msgid "B<-a image> | B<--add image>"
32054 #: ../fuse/guestmount.pod:79
32055 msgid "Add a block device or virtual machine image."
32060 #: ../fuse/guestmount.pod:84
32061 msgid "B<-c URI> | B<--connect URI>"
32066 #: ../fuse/guestmount.pod:90
32067 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32072 #: ../fuse/guestmount.pod:96
32073 msgid "B<--dir-cache-timeout N>"
32078 #: ../fuse/guestmount.pod:98
32080 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32081 "seconds. The readdir cache [actually, there are several semi-independent "
32082 "caches] is populated after a readdir(2) call with the stat and extended "
32083 "attributes of the files in the directory, in anticipation that they will be "
32084 "requested soon after."
32089 #: ../fuse/guestmount.pod:104
32091 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32092 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32093 "requests, only cache existing ones."
32098 #: ../fuse/guestmount.pod:115
32099 msgid "B<--format=raw|qcow2|..> | B<--format>"
32104 #: ../fuse/guestmount.pod:122
32106 "If you have untrusted raw-format guest disk images, you should use this "
32107 "option to specify the disk format. This avoids a possible security problem "
32108 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32109 "guestfs_add_drive_opts>."
32114 #: ../fuse/guestmount.pod:127
32115 msgid "B<--fuse-help>"
32120 #: ../fuse/guestmount.pod:129
32121 msgid "Display help on special FUSE options (see I<-o> below)."
32126 #: ../fuse/guestmount.pod:133
32127 msgid "Display brief help and exit."
32132 #: ../fuse/guestmount.pod:135
32133 msgid "B<-i> | B<--inspector>"
32138 #: ../fuse/guestmount.pod:155
32140 "Mount the named partition or logical volume on the given mountpoint B<in the "
32141 "guest> (this has nothing to do with mountpoints in the host)."
32146 #: ../fuse/guestmount.pod:158
32148 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32149 "something on C</>."
32154 #: ../fuse/guestmount.pod:171
32155 msgid "B<-n> | B<--no-sync>"
32160 #: ../fuse/guestmount.pod:173
32162 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32163 "unmounted. If you specify this option, then we don't attempt to sync the "
32164 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32169 #: ../fuse/guestmount.pod:178
32170 msgid "B<-o option> | B<--option option>"
32175 #: ../fuse/guestmount.pod:180
32176 msgid "Pass extra options to FUSE."
32181 #: ../fuse/guestmount.pod:182
32183 "To get a list of all the extra options supported by FUSE, use the command "
32184 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32185 "of them are a good idea."
32190 #: ../fuse/guestmount.pod:186
32193 " guestmount --fuse-help\n"
32199 #: ../fuse/guestmount.pod:188
32200 msgid "Some potentially useful FUSE options:"
32205 #: ../fuse/guestmount.pod:192
32206 msgid "B<-o allow_other>"
32211 #: ../fuse/guestmount.pod:194
32212 msgid "Allow other users to see the filesystem."
32217 #: ../fuse/guestmount.pod:196
32218 msgid "B<-o attr_timeout=N>"
32223 #: ../fuse/guestmount.pod:198
32224 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32229 #: ../fuse/guestmount.pod:200
32230 msgid "B<-o kernel_cache>"
32235 #: ../fuse/guestmount.pod:202
32237 "Allow the kernel to cache files (reduces the number of reads that have to go "
32238 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32239 "afford the extra memory usage."
32244 #: ../fuse/guestmount.pod:206
32245 msgid "B<-o uid=N> B<-o gid=N>"
32250 #: ../fuse/guestmount.pod:208
32252 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32253 "the chosen values."
32258 #: ../fuse/guestmount.pod:213
32259 msgid "B<-r> | B<--ro>"
32264 #: ../fuse/guestmount.pod:215
32266 "Add devices and mount everything read-only. Also disallow writes and make "
32267 "the disk appear read-only to FUSE."
32272 #: ../fuse/guestmount.pod:218
32274 "This is highly recommended if you are not going to edit the guest disk. If "
32275 "the guest is running and this option is I<not> supplied, then there is a "
32276 "strong risk of disk corruption in the guest. We try to prevent this from "
32277 "happening, but it is not always possible."
32282 #: ../fuse/guestmount.pod:223
32283 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32288 #: ../fuse/guestmount.pod:227
32289 msgid "Enable SELinux support for the guest."
32294 #: ../fuse/guestmount.pod:229
32295 msgid "B<-v> | B<--verbose>"
32300 #: ../fuse/guestmount.pod:231
32301 msgid "Enable verbose messages from underlying libguestfs."
32306 #: ../fuse/guestmount.pod:233
32307 msgid "B<-V> | B<--version>"
32312 #: ../fuse/guestmount.pod:235
32313 msgid "Display the program version and exit."
32318 #: ../fuse/guestmount.pod:237
32319 msgid "B<-w> | B<--rw>"
32323 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
32324 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32329 #: ../fuse/guestmount.pod:244
32330 msgid "B<-x> | B<--trace>"
32335 #: ../fuse/guestmount.pod:246
32336 msgid "Trace libguestfs calls and entry into each FUSE function."
32341 #: ../fuse/guestmount.pod:248
32342 msgid "This also stops the daemon from forking into the background."
32347 #: ../fuse/guestmount.pod:269
32349 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32350 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32356 #: ../fuse/guestmount.pod:284
32357 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32362 #: ../tools/virt-edit.pl:34
32363 msgid "virt-edit - Edit a file in a virtual machine"
32368 #: ../tools/virt-edit.pl:38
32371 " virt-edit [--options] domname file\n"
32377 #: ../tools/virt-edit.pl:40
32380 " virt-edit [--options] disk.img [disk.img ...] file\n"
32386 #: ../tools/virt-edit.pl:42
32389 " virt-edit [domname|disk.img] file -e 'expr'\n"
32395 #: ../tools/virt-edit.pl:46
32397 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32398 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32399 "doing this, but doesn't catch all cases."
32404 #: ../tools/virt-edit.pl:52
32406 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32407 "the named virtual machine (or disk image)."
32411 #: ../tools/virt-edit.pl:55
32412 msgid "If you want to just view a file, use L<virt-cat(1)>."
32416 #: ../tools/virt-edit.pl:57
32418 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32419 "USING GUESTFISH> below)."
32423 #: ../tools/virt-edit.pl:60
32425 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32426 "files. L<guestfish(1)> can do that and much more."
32431 #: ../tools/virt-edit.pl:65
32432 msgid "Edit the named files interactively:"
32437 #: ../tools/virt-edit.pl:67
32440 " virt-edit mydomain /boot/grub/grub.conf\n"
32446 #: ../tools/virt-edit.pl:69
32449 " virt-edit mydomain /etc/passwd\n"
32454 #: ../tools/virt-edit.pl:71
32455 msgid "For Windows guests, some Windows paths are understood:"
32459 #: ../tools/virt-edit.pl:73
32462 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32468 #: ../tools/virt-edit.pl:75
32470 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32471 "below). To change the init default level to 5:"
32476 #: ../tools/virt-edit.pl:79
32479 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32485 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32486 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32487 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32488 msgid "Display brief help."
32493 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32494 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
32495 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
32496 msgid "Display version number and exit."
32501 #: ../tools/virt-edit.pl:105
32502 msgid "B<--backup extension> | B<-b extension>"
32507 #: ../tools/virt-edit.pl:107
32509 "Create a backup of the original file I<in the guest disk image>. The backup "
32510 "has the original filename with C<extension> added."
32515 #: ../tools/virt-edit.pl:110
32517 "Usually the first character of C<extension> would be a dot C<.> so you would "
32523 #: ../tools/virt-edit.pl:113
32526 " virt-edit -b .orig [etc]\n"
32532 #: ../tools/virt-edit.pl:115
32533 msgid "By default, no backup file is made."
32538 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32539 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32540 #: ../tools/virt-list-partitions.pl:78
32541 msgid "B<--connect URI> | B<-c URI>"
32546 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32547 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32548 #: ../tools/virt-list-partitions.pl:80
32550 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32551 "to the default libvirt hypervisor."
32556 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32557 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32558 #: ../tools/virt-list-partitions.pl:83
32560 "If you specify guest block devices directly, then libvirt is not used at all."
32565 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32566 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
32567 #: ../tools/virt-list-partitions.pl:90
32568 msgid "B<--format> raw"
32573 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32574 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32575 #: ../tools/virt-list-partitions.pl:92
32577 "Specify the format of disk images given on the command line. If this is "
32578 "omitted then the format is autodetected from the content of the disk image."
32583 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32584 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32585 #: ../tools/virt-list-partitions.pl:96
32587 "If disk images are requested from libvirt, then this program asks libvirt "
32588 "for this information. In this case, the value of the format parameter is "
32594 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32595 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32596 #: ../tools/virt-list-partitions.pl:100
32598 "If working with untrusted raw-format guest disk images, you should ensure "
32599 "the format is always specified."
32604 #: ../tools/virt-edit.pl:150
32605 msgid "B<--expr EXPR> | B<-e EXPR>"
32610 #: ../tools/virt-edit.pl:152
32612 "Instead of launching the external editor, non-interactively apply the Perl "
32613 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32619 #: ../tools/virt-edit.pl:156
32621 "Be careful to properly quote the expression to prevent it from being altered "
32627 #: ../tools/virt-edit.pl:280
32628 msgid "NON-INTERACTIVE EDITING"
32633 #: ../tools/virt-edit.pl:282
32635 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32636 "administrator can interactively edit the file."
32641 #: ../tools/virt-edit.pl:285
32643 "There are two ways also to use C<virt-edit> from scripts in order to make "
32644 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32645 "like this, it's less error-prone to write scripts directly using the "
32646 "libguestfs API and Augeas for configuration file editing.)"
32651 #: ../tools/virt-edit.pl:291
32653 "The first method is to temporarily set C<$EDITOR> to any script or program "
32654 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32655 "update C<tmpfile> in place however it likes."
32660 #: ../tools/virt-edit.pl:295
32662 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
32663 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32664 "instances of C<foo> with C<bar> in a file:"
32669 #: ../tools/virt-edit.pl:299
32672 " virt-edit domname filename -e 's/foo/bar/'\n"
32678 #: ../tools/virt-edit.pl:301
32680 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32681 "For example to delete root's password you could do:"
32686 #: ../tools/virt-edit.pl:304
32689 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32695 #: ../tools/virt-edit.pl:306
32697 "What really happens is that the snippet is evaluated as a Perl expression "
32698 "for each line of the file. The line, including the final C<\\n>, is passed "
32699 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32704 #: ../tools/virt-edit.pl:311
32706 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32707 "C<apache> user account from the password file you can do:"
32712 #: ../tools/virt-edit.pl:314
32715 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32721 #: ../tools/virt-edit.pl:316
32723 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32724 "the end of the file is rather difficult this way since there is no concept "
32725 "of \"last line of the file\" - your expression just doesn't get called "
32726 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32732 #: ../tools/virt-edit.pl:322
32734 "The variable C<$lineno> contains the current line number. As is "
32735 "traditional, the first line in the file is number C<1>."
32740 #: ../tools/virt-edit.pl:325
32742 "The return value from the expression is ignored, but the expression may call "
32743 "C<die> in order to abort the whole program, leaving the original file "
32749 #: ../tools/virt-edit.pl:329
32751 "Remember when matching the end of a line that C<$_> may contain the final C<"
32752 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32753 "newline then neither of these. Thus to match or substitute some text at the "
32754 "end of a line, use this regular expression:"
32759 #: ../tools/virt-edit.pl:334
32762 " /some text(\\r?\\n)?$/\n"
32768 #: ../tools/virt-edit.pl:336
32770 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32771 "$_> itself (since that would remove all newlines from the file):"
32776 #: ../tools/virt-edit.pl:340
32779 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32784 #: ../tools/virt-edit.pl:344
32786 "C<virt-edit> has a limited ability to understand Windows drive letters and "
32787 "paths (eg. C<E:\\foo\\bar.txt>)."
32791 #: ../tools/virt-edit.pl:347
32792 msgid "If and only if the guest is running Windows then:"
32796 #: ../tools/virt-edit.pl:353
32798 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
32799 "to the correct filesystem."
32803 #: ../tools/virt-edit.pl:358
32805 "Any backslash (C<\\>) characters in the path are replaced with forward "
32806 "slashes so that libguestfs can process it."
32810 #: ../tools/virt-edit.pl:363
32812 "The path is resolved case insensitively to locate the file that should be "
32817 #: ../tools/virt-edit.pl:368
32818 msgid "There are some known shortcomings:"
32822 #: ../tools/virt-edit.pl:374
32823 msgid "Some NTFS symbolic links may not be followed correctly."
32827 #: ../tools/virt-edit.pl:378
32828 msgid "NTFS junction points that cross filesystems are not followed."
32832 #: ../tools/virt-edit.pl:435
32833 msgid "USING GUESTFISH"
32837 #: ../tools/virt-edit.pl:437
32839 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
32840 "C<virt-edit> doesn't work."
32844 #: ../tools/virt-edit.pl:440
32845 msgid "Using C<virt-edit> is approximately equivalent to doing:"
32849 #: ../tools/virt-edit.pl:442
32852 " guestfish --rw -i -d domname edit /file\n"
32857 #: ../tools/virt-edit.pl:444
32859 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
32860 "path to the file."
32864 #: ../tools/virt-edit.pl:447
32866 "The command above uses libguestfs's guest inspection feature and so does not "
32867 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
32868 "disk images that don't contain guests. To edit a file on a disk image "
32873 #: ../tools/virt-edit.pl:452
32876 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
32881 #: ../tools/virt-edit.pl:454
32883 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
32884 "the disk image to edit, and C</file> is the full path to the file."
32888 #: ../tools/virt-edit.pl:458
32890 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
32891 "C<write> or C<upload> instead:"
32895 #: ../tools/virt-edit.pl:461
32898 " guestfish --rw -i -d domname touch /newfile\n"
32903 #: ../tools/virt-edit.pl:463
32906 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
32911 #: ../tools/virt-edit.pl:465
32914 " guestfish --rw -i -d domname upload localfile /newfile\n"
32919 #: ../tools/virt-edit.pl:467
32921 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
32925 #: ../tools/virt-edit.pl:470
32928 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
32934 #: ../tools/virt-edit.pl:480
32940 #: ../tools/virt-edit.pl:482
32942 "If set, this string is used as the editor. It may contain arguments, eg. C<"
32948 #: ../tools/virt-edit.pl:485
32949 msgid "If not set, C<vi> is used."
32954 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
32955 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
32956 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
32957 msgid "SHELL QUOTING"
32962 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
32963 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
32964 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
32966 "Libvirt guest names can contain arbitrary characters, some of which have "
32967 "meaning to the shell such as C<#> and space. You may need to quote or "
32968 "escape these characters on the command line. See the shell manual page L<sh"
32969 "(1)> for details."
32973 #: ../tools/virt-edit.pl:498
32975 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
32976 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
32977 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
32982 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
32983 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
32984 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
32990 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
32991 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
32992 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
32993 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
32997 #: ../tools/virt-edit.pl:516
32998 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33003 #: ../tools/virt-win-reg.pl:37
33005 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33010 #: ../tools/virt-win-reg.pl:41
33013 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33019 #: ../tools/virt-win-reg.pl:43
33022 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33028 #: ../tools/virt-win-reg.pl:45
33031 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33037 #: ../tools/virt-win-reg.pl:47
33040 " virt-win-reg --merge domname [input.reg ...]\n"
33046 #: ../tools/virt-win-reg.pl:49
33049 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33055 #: ../tools/virt-win-reg.pl:53
33057 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
33058 "virtual machines. If you do this, you I<will> get irreversible disk "
33059 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33060 "but doesn't catch all cases."
33065 #: ../tools/virt-win-reg.pl:58
33067 "Modifying the Windows Registry is an inherently risky operation. The format "
33068 "is deliberately obscure and undocumented, and Registry changes can leave the "
33069 "system unbootable. Therefore when using the C<--merge> option, make sure "
33070 "you have a reliable backup first."
33075 #: ../tools/virt-win-reg.pl:65
33077 "This program can export and merge Windows Registry entries from a Windows "
33083 #: ../tools/virt-win-reg.pl:68
33085 "The first parameter is the libvirt guest name or the raw disk image of a "
33091 #: ../tools/virt-win-reg.pl:71
33093 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
33094 "exported (recursively). For example:"
33099 #: ../tools/virt-win-reg.pl:74
33102 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33108 #: ../tools/virt-win-reg.pl:76
33110 "You can also display single values from within registry keys, for example:"
33115 #: ../tools/virt-win-reg.pl:79
33118 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33119 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33120 " Windows 7 Enterprise\n"
33126 #: ../tools/virt-win-reg.pl:83
33128 "With C<--merge>, you can merge a textual regedit file into the Windows "
33134 #: ../tools/virt-win-reg.pl:86
33137 " $ virt-win-reg --merge Windows7 changes.reg\n"
33143 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33149 #: ../tools/virt-win-reg.pl:90
33151 "This program is only meant for simple access to the registry. If you want "
33152 "to do complicated things with the registry, we suggest you download the "
33153 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33154 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33155 "L<hivexregedit(1)>."
33160 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33166 #: ../tools/virt-win-reg.pl:122
33167 msgid "Enable debugging messages."
33172 #: ../tools/virt-win-reg.pl:157
33178 #: ../tools/virt-win-reg.pl:159
33180 "In merge mode, this merges a textual regedit file into the Windows Registry "
33181 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33182 "displays or exports Registry entries instead."
33187 #: ../tools/virt-win-reg.pl:163
33189 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
33190 "result in disk corruption. However exporting (without this flag) is always "
33196 #: ../tools/virt-win-reg.pl:171
33197 msgid "B<--encoding> UTF-16LE|ASCII"
33202 #: ../tools/virt-win-reg.pl:173
33204 "When merging (only), you may need to specify the encoding for strings to be "
33205 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33206 "(3)/ENCODING STRINGS>."
33211 #: ../tools/virt-win-reg.pl:177
33213 "The default is to use UTF-16LE, which should work with recent versions of "
33219 #: ../tools/virt-win-reg.pl:402
33220 msgid "SUPPORTED SYSTEMS"
33225 #: ../tools/virt-win-reg.pl:404
33227 "The program currently supports Windows NT-derived guests starting with "
33228 "Windows XP through to at least Windows 7."
33233 #: ../tools/virt-win-reg.pl:407
33235 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33236 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33237 "and C<HKEY_USERS\\.DEFAULT>."
33242 #: ../tools/virt-win-reg.pl:411
33244 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33250 #: ../tools/virt-win-reg.pl:414
33252 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33258 #: ../tools/virt-win-reg.pl:417
33264 #: ../tools/virt-win-reg.pl:419
33266 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33267 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33268 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33269 "Windows-style line endings, you may need to reencode the whole file before "
33270 "or after processing."
33275 #: ../tools/virt-win-reg.pl:425
33277 "To reencode a file from Windows format to Linux (before processing it with "
33278 "the C<--merge> option), you would do something like this:"
33283 #: ../tools/virt-win-reg.pl:428
33286 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33292 #: ../tools/virt-win-reg.pl:430
33294 "To go in the opposite direction, after exporting and before sending the file "
33295 "to a Windows user, do something like this:"
33300 #: ../tools/virt-win-reg.pl:433
33303 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33309 #: ../tools/virt-win-reg.pl:435
33310 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33315 #: ../tools/virt-win-reg.pl:437
33317 "If you are unsure about the current encoding, use the L<file(1)> command. "
33318 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33319 "style (CRLF) line endings, like this:"
33324 #: ../tools/virt-win-reg.pl:441
33327 " $ file software.reg\n"
33328 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33329 " with CRLF line terminators\n"
33335 #: ../tools/virt-win-reg.pl:445
33336 msgid "This file would need conversion before you could C<--merge> it."
33341 #: ../tools/virt-win-reg.pl:447
33342 msgid "CurrentControlSet etc."
33347 #: ../tools/virt-win-reg.pl:449
33349 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33350 "Registry at the level of the hive file, and therefore you cannot modify "
33356 #: ../tools/virt-win-reg.pl:453
33358 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33359 "circumstances it might refer to another control set. The way to find out is "
33360 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33365 #: ../tools/virt-win-reg.pl:457
33368 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33369 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33370 " \"Current\"=dword:00000001\n"
33371 " \"Default\"=dword:00000001\n"
33372 " \"Failed\"=dword:00000000\n"
33373 " \"LastKnownGood\"=dword:00000002\n"
33379 #: ../tools/virt-win-reg.pl:464
33380 msgid "\"Current\" is the one which Windows will choose when it boots."
33385 #: ../tools/virt-win-reg.pl:466
33387 "Similarly, other C<Current...> keys in the path may need to be replaced."
33392 #: ../tools/virt-win-reg.pl:469
33393 msgid "WINDOWS TIPS"
33398 #: ../tools/virt-win-reg.pl:471
33400 "Note that some of these tips modify the guest disk image. The guest I<must> "
33401 "be shut off, else you will get disk corruption."
33406 #: ../tools/virt-win-reg.pl:474
33407 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33412 #: ../tools/virt-win-reg.pl:476
33414 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33415 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33416 "is uploaded into C<C:\\>:"
33421 #: ../tools/virt-win-reg.pl:480
33424 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33430 #: ../tools/virt-win-reg.pl:482
33431 msgid "Prepare a regedit file containing the registry change:"
33436 #: ../tools/virt-win-reg.pl:484
33439 " cat > test.reg <<'EOF'\n"
33440 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33441 " \"Test\"=\"c:\\\\test.bat\"\n"
33448 #: ../tools/virt-win-reg.pl:489
33450 "In this example we use the key C<RunOnce> which means that the script will "
33451 "run precisely once when the first user logs in. If you want it to run every "
33452 "time a user logs in, replace C<RunOnce> with C<Run>."
33457 #: ../tools/virt-win-reg.pl:493
33458 msgid "Now update the registry:"
33463 #: ../tools/virt-win-reg.pl:495
33466 " virt-win-reg --merge WindowsGuest test.reg\n"
33472 #: ../tools/virt-win-reg.pl:497
33473 msgid "INSTALLING A SERVICE"
33478 #: ../tools/virt-win-reg.pl:499
33480 "This section assumes you are familiar with Windows services, and you either "
33481 "have a program which handles the Windows Service Control Protocol directly "
33482 "or you want to run any program using a service wrapper like SrvAny or the "
33488 #: ../tools/virt-win-reg.pl:504
33490 "First upload the program and optionally the service wrapper. In this case "
33491 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33496 #: ../tools/virt-win-reg.pl:508
33499 " guestfish -i -d WindowsGuest <<EOF\n"
33500 " upload rhsrvany.exe /rhsrvany.exe\n"
33501 " upload test.exe /test.exe\n"
33508 #: ../tools/virt-win-reg.pl:513
33510 "Prepare a regedit file containing the registry changes. In this example, "
33511 "the first registry change is needed for the service itself or the service "
33512 "wrapper (if used). The second registry change is only needed because I am "
33513 "using the RHSrvAny service wrapper."
33518 #: ../tools/virt-win-reg.pl:518
33521 " cat > service.reg <<'EOF'\n"
33522 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33523 " \"Type\"=dword:00000010\n"
33524 " \"Start\"=dword:00000002\n"
33525 " \"ErrorControl\"=dword:00000001\n"
33526 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33527 " \"DisplayName\"=\"RHSrvAny\"\n"
33528 " \"ObjectName\"=\"NetworkService\"\n"
33534 #: ../tools/virt-win-reg.pl:527
33537 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33538 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33539 " \"PWD\"=\"c:\\\\Temp\"\n"
33546 #: ../tools/virt-win-reg.pl:538
33548 "For use of C<ControlSet001> see the section above in this manual page. You "
33549 "may need to adjust this according to the control set that is in use by the "
33555 #: ../tools/virt-win-reg.pl:544
33557 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33558 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33559 "privileged account."
33564 #: ../tools/virt-win-reg.pl:550
33566 "For the meaning of the magic numbers, see this Microsoft KB article: "
33567 "L<http://support.microsoft.com/kb/103000>."
33572 #: ../tools/virt-win-reg.pl:555
33573 msgid "Update the registry:"
33578 #: ../tools/virt-win-reg.pl:557
33581 " virt-win-reg --merge WindowsGuest service.reg\n"
33587 #: ../tools/virt-win-reg.pl:561
33589 "Be careful when passing parameters containing C<\\> (backslash) in the "
33590 "shell. Usually you will have to use 'single quotes' or double backslashes "
33591 "(but not both) to protect them from the shell."
33596 #: ../tools/virt-win-reg.pl:565
33597 msgid "Paths and value names are case-insensitive."
33602 #: ../tools/virt-win-reg.pl:574
33604 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33605 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33606 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33611 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33613 "When reporting bugs, please enable debugging and capture the I<complete> "
33619 #: ../tools/virt-win-reg.pl:592
33622 " export LIBGUESTFS_DEBUG=1\n"
33623 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33629 #: ../tools/virt-win-reg.pl:595
33631 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33637 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
33638 msgid "Copyright (C) 2010 Red Hat Inc."
33643 #: ../tools/virt-list-filesystems.pl:32
33645 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33650 #: ../tools/virt-list-filesystems.pl:36
33653 " virt-list-filesystems [--options] domname\n"
33659 #: ../tools/virt-list-filesystems.pl:38
33662 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33668 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33670 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33676 #: ../tools/virt-list-filesystems.pl:45
33678 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33679 "are contained in a virtual machine or disk image."
33684 #: ../tools/virt-list-filesystems.pl:49
33686 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33687 "functionality. For more complex cases you should look at the L<guestfish(1)"
33693 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33694 msgid "B<-l> | B<--long>"
33699 #: ../tools/virt-list-filesystems.pl:108
33701 "With this option, C<virt-list-filesystems> displays the type of each "
33702 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33707 #: ../tools/virt-list-filesystems.pl:115
33708 msgid "B<-a> | B<--all>"
33713 #: ../tools/virt-list-filesystems.pl:117
33715 "Normally we only show mountable filesystems. If this option is given then "
33716 "swap devices are shown too."
33721 #: ../tools/virt-list-filesystems.pl:191
33723 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33724 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33725 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33730 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33731 msgid "Copyright (C) 2009 Red Hat Inc."
33736 #: ../tools/virt-tar.pl:33
33737 msgid "virt-tar - Extract or upload files to a virtual machine"
33742 #: ../tools/virt-tar.pl:37
33745 " virt-tar [--options] -x domname directory tarball\n"
33751 #: ../tools/virt-tar.pl:39
33754 " virt-tar [--options] -u domname tarball directory\n"
33760 #: ../tools/virt-tar.pl:41
33763 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33769 #: ../tools/virt-tar.pl:43
33772 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33777 #: ../tools/virt-tar.pl:47
33779 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
33780 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
33785 #: ../tools/virt-tar.pl:52
33786 msgid "Download C</home> from the VM into a local tarball:"
33791 #: ../tools/virt-tar.pl:54
33794 " virt-tar -x domname /home home.tar\n"
33800 #: ../tools/virt-tar.pl:56
33803 " virt-tar -zx domname /home home.tar.gz\n"
33809 #: ../tools/virt-tar.pl:58
33810 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33815 #: ../tools/virt-tar.pl:60
33818 " virt-tar -u domname uploadstuff.tar /tmp\n"
33824 #: ../tools/virt-tar.pl:62
33827 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
33833 #: ../tools/virt-tar.pl:66
33835 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
33836 "virtual machines. If you do this, you risk disk corruption in the VM. "
33837 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
33842 #: ../tools/virt-tar.pl:71
33844 "You can use C<-x> (extract) on live virtual machines, but you might get "
33845 "inconsistent results or errors if there is filesystem activity inside the "
33846 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
33847 "work, but the only way to guarantee consistent results is if the virtual "
33848 "machine is shut down."
33853 #: ../tools/virt-tar.pl:79
33855 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
33856 "parts of a guest filesystem. There are many possibilities: making backups, "
33857 "uploading data files, snooping on guest activity, fixing or customizing "
33863 #: ../tools/virt-tar.pl:84
33865 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
33866 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
33867 "should look at the L<guestfish(1)> tool."
33872 #: ../tools/virt-tar.pl:88
33874 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
33875 "its contents (recursively) from the virtual machine into a local tarball. "
33876 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
33877 "virtual machine. You cannot use these two options together."
33882 #: ../tools/virt-tar.pl:94
33884 "In addition, you may need to use the C<-z> (gZip) option to enable "
33885 "compression. When uploading, you have to specify C<-z> if the upload file "
33886 "is compressed because virt-tar won't detect this on its own."
33891 #: ../tools/virt-tar.pl:98
33893 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
33894 "example it cannot do PKZip files or bzip2 compression. If you want that "
33895 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
33896 "the L<libguestfs(3)> API)."
33901 #: ../tools/virt-tar.pl:156
33902 msgid "B<-x> | B<--extract> | B<--download>"
33907 #: ../tools/virt-tar.pl:158
33908 msgid "B<-u> | B<--upload>"
33913 #: ../tools/virt-tar.pl:160
33915 "Use C<-x> to extract (download) a directory from a virtual machine to a "
33921 #: ../tools/virt-tar.pl:163
33923 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
33924 "Please read the L</WARNING> section above before using this option."
33929 #: ../tools/virt-tar.pl:167
33930 msgid "You must specify exactly one of these options."
33935 #: ../tools/virt-tar.pl:173
33936 msgid "B<-z> | B<--gzip>"
33941 #: ../tools/virt-tar.pl:175
33942 msgid "Specify that the input or output tarball is gzip-compressed."
33946 #: ../tools/virt-tar.pl:288
33948 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
33949 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
33950 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
33956 #: ../tools/virt-make-fs.pl:37
33957 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
33962 #: ../tools/virt-make-fs.pl:41
33965 " virt-make-fs [--options] input.tar output.img\n"
33971 #: ../tools/virt-make-fs.pl:43
33974 " virt-make-fs [--options] input.tar.gz output.img\n"
33980 #: ../tools/virt-make-fs.pl:45
33983 " virt-make-fs [--options] directory output.img\n"
33989 #: ../tools/virt-make-fs.pl:49
33991 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
33992 "archive or some files in a directory. It is similar to tools like L<mkisofs"
33993 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
33994 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
33995 "you want to attach these filesystems to existing virtual machines (eg. to "
33996 "import large amounts of read-only data to a VM)."
34001 #: ../tools/virt-make-fs.pl:57
34002 msgid "Basic usage is:"
34007 #: ../tools/virt-make-fs.pl:59
34010 " virt-make-fs input output\n"
34016 #: ../tools/virt-make-fs.pl:61
34018 "where C<input> is either a directory containing files that you want to add, "
34019 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34020 "C<output> is a disk image. The input type is detected automatically. The "
34021 "output disk image defaults to a raw ext2 image unless you specify extra "
34022 "flags (see L</OPTIONS> below)."
34027 #: ../tools/virt-make-fs.pl:67
34028 msgid "EXTRA SPACE"
34033 #: ../tools/virt-make-fs.pl:69
34035 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34036 "the files that it contains, but might have extra space. Depending on how "
34037 "you are going to use the output, you might think this extra space is wasted "
34038 "and want to minimize it, or you might want to leave space so that more files "
34039 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34040 "but you can use the C<--size> flag to leave space in the filesystem if you "
34046 #: ../tools/virt-make-fs.pl:77
34048 "An alternative way to leave extra space but not make the output image any "
34049 "bigger is to use an alternative disk image format (instead of the default "
34050 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
34051 "image format (check your hypervisor supports this before using it). This "
34052 "allows you to choose a large C<--size> but the extra space won't actually be "
34053 "allocated in the image until you try to store something in it."
34057 #: ../tools/virt-make-fs.pl:85
34059 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34060 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34061 "to build another image from scratch."
34066 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34067 #: ../tools/virt-make-fs.pl:142
34073 #: ../tools/virt-make-fs.pl:91
34076 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34082 #: ../tools/virt-make-fs.pl:93
34083 msgid "FILESYSTEM TYPE"
34088 #: ../tools/virt-make-fs.pl:95
34090 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34091 "libguestfs supports can be used (but I<not> read-only formats like "
34092 "ISO9660). Here are some of the more common choices:"
34097 #: ../tools/virt-make-fs.pl:101
34103 #: ../tools/virt-make-fs.pl:103
34105 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34106 "you are not going to use the filesystem in a way that requires the journal, "
34107 "then this is just wasted overhead."
34112 #: ../tools/virt-make-fs.pl:107
34113 msgid "I<ntfs> or I<vfat>"
34118 #: ../tools/virt-make-fs.pl:109
34119 msgid "Useful if exporting data to a Windows guest."
34124 #: ../tools/virt-make-fs.pl:111
34126 "I<Note for vfat>: The tar archive or local directory must only contain files "
34127 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34128 "program running within libguestfs is unable to change the ownership of non-"
34129 "root files, since vfat itself does not support this."
34134 #: ../tools/virt-make-fs.pl:116
34140 #: ../tools/virt-make-fs.pl:118
34142 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34143 "total filesystem size."
34148 #: ../tools/virt-make-fs.pl:125
34151 " virt-make-fs --type=minix input minixfs.img\n"
34157 #: ../tools/virt-make-fs.pl:127
34158 msgid "TO PARTITION OR NOT TO PARTITION"
34163 #: ../tools/virt-make-fs.pl:129
34164 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34169 #: ../tools/virt-make-fs.pl:131
34171 "Adding a partition can make the disk image more compatible with certain "
34172 "virtualized operating systems which don't expect to see a filesystem "
34173 "directly located on a block device (Linux doesn't care and will happily "
34174 "handle both types)."
34179 #: ../tools/virt-make-fs.pl:136
34181 "On the other hand, if you have a partition table then the output image is no "
34182 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34183 "directly on a partitioned disk image. (However libguestfs tools such as "
34184 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34189 #: ../tools/virt-make-fs.pl:144
34190 msgid "Add an MBR partition:"
34195 #: ../tools/virt-make-fs.pl:146
34198 " virt-make-fs --partition -- input disk.img\n"
34204 #: ../tools/virt-make-fs.pl:148
34206 "If the output disk image could be terabyte-sized or larger, it's better to "
34207 "use an EFI/GPT-compatible partition table:"
34212 #: ../tools/virt-make-fs.pl:151
34215 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34221 #: ../tools/virt-make-fs.pl:179
34222 msgid "Enable debugging information."
34227 #: ../tools/virt-make-fs.pl:185
34228 msgid "B<--size=E<lt>NE<gt>>"
34233 #: ../tools/virt-make-fs.pl:187
34234 msgid "B<--size=+E<lt>NE<gt>>"
34239 #: ../tools/virt-make-fs.pl:189
34240 msgid "B<-s E<lt>NE<gt>>"
34245 #: ../tools/virt-make-fs.pl:191
34246 msgid "B<-s +E<lt>NE<gt>>"
34251 #: ../tools/virt-make-fs.pl:193
34253 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
34258 #: ../tools/virt-make-fs.pl:196
34260 "If this option is I<not> given, then the output image will be just large "
34261 "enough to contain all the files, with not much wasted space."
34266 #: ../tools/virt-make-fs.pl:199
34268 "To choose a fixed size output disk, specify an absolute number followed by b/"
34269 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34270 "Petabytes or Exabytes. This must be large enough to contain all the input "
34271 "files, else you will get an error."
34276 #: ../tools/virt-make-fs.pl:204
34278 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34279 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34280 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
34281 "the input files, and (approximately) an extra 200 MB free space."
34286 #: ../tools/virt-make-fs.pl:210
34288 "Note that virt-make-fs estimates free space, and therefore will not produce "
34289 "filesystems containing precisely the free space requested. (It is much more "
34290 "expensive and time-consuming to produce a filesystem which has precisely the "
34291 "desired free space)."
34296 #: ../tools/virt-make-fs.pl:219
34297 msgid "B<--format=E<lt>fmtE<gt>>"
34302 #: ../tools/virt-make-fs.pl:221
34303 msgid "B<-F E<lt>fmtE<gt>>"
34308 #: ../tools/virt-make-fs.pl:223
34309 msgid "Choose the output disk image format."
34314 #: ../tools/virt-make-fs.pl:225
34315 msgid "The default is C<raw> (raw disk image)."
34320 #: ../tools/virt-make-fs.pl:227
34322 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34323 "that would really make sense here is C<qcow2>."
34328 #: ../tools/virt-make-fs.pl:234
34329 msgid "B<--type=E<lt>fsE<gt>>"
34334 #: ../tools/virt-make-fs.pl:236
34335 msgid "B<-t E<lt>fsE<gt>>"
34340 #: ../tools/virt-make-fs.pl:238
34341 msgid "Choose the output filesystem type."
34346 #: ../tools/virt-make-fs.pl:240
34347 msgid "The default is C<ext2>."
34352 #: ../tools/virt-make-fs.pl:242
34354 "Any filesystem which is supported read-write by libguestfs can be used here."
34359 #: ../tools/virt-make-fs.pl:249
34360 msgid "B<--partition>"
34365 #: ../tools/virt-make-fs.pl:251
34366 msgid "B<--partition=E<lt>parttypeE<gt>>"
34371 #: ../tools/virt-make-fs.pl:253
34373 "If specified, this flag adds an MBR partition table to the output disk image."
34378 #: ../tools/virt-make-fs.pl:256
34380 "You can change the partition table type, eg. C<--partition=gpt> for large "
34386 #: ../tools/virt-make-fs.pl:259
34388 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
34389 "might consider the next parameter to be the partition type. For example:"
34394 #: ../tools/virt-make-fs.pl:263
34397 " virt-make-fs --partition input.tar ...\n"
34403 #: ../tools/virt-make-fs.pl:265
34405 "would cause virt-make-fs to think you wanted to use a partition type of "
34406 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
34407 "dash) between options and the input file argument:"
34412 #: ../tools/virt-make-fs.pl:269
34415 " virt-make-fs --partition -- input.tar ...\n"
34420 #: ../tools/virt-make-fs.pl:541
34422 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34423 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34424 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34429 #: ../tools/virt-make-fs.pl:558
34432 " export LIBGUESTFS_DEBUG=1\n"
34433 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34439 #: ../tools/virt-make-fs.pl:561
34441 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34447 #: ../tools/virt-list-partitions.pl:32
34449 "virt-list-partitions - List partitions in a virtual machine or disk image"
34454 #: ../tools/virt-list-partitions.pl:36
34457 " virt-list-partitions [--options] domname\n"
34463 #: ../tools/virt-list-partitions.pl:38
34466 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34472 #: ../tools/virt-list-partitions.pl:45
34474 "C<virt-list-partitions> is a command line tool to list the partitions that "
34475 "are contained in a virtual machine or disk image. It is mainly useful as a "
34476 "first step to using L<virt-resize(1)>."
34481 #: ../tools/virt-list-partitions.pl:50
34483 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34484 "functionality. For more complex cases you should look at the L<guestfish(1)"
34490 #: ../tools/virt-list-partitions.pl:107
34491 msgid "B<-h> | B<--human-readable>"
34496 #: ../tools/virt-list-partitions.pl:109
34497 msgid "Show sizes in human-readable form (eg. \"1G\")."
34502 #: ../tools/virt-list-partitions.pl:117
34504 "With this option, C<virt-list-partitions> displays the type and size of each "
34505 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34510 #: ../tools/virt-list-partitions.pl:124
34511 msgid "B<-t> | B<--total>"
34516 #: ../tools/virt-list-partitions.pl:126
34518 "Display the total size of each block device (as a separate row or rows)."
34523 #: ../tools/virt-list-partitions.pl:259
34525 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34526 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34527 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34532 #: ../tools/virt-list-partitions.pl:275
34533 msgid "Copyright (C) 2009-2010 Red Hat Inc."