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-22 22:23+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:1087
918 #: ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1100
919 #: ../src/guestfs.pod:1108 ../src/guestfs.pod:1127 ../src/guestfs.pod:1135
920 #: ../src/guestfs.pod:1157 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165
921 #: ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177
922 #: ../src/guestfs.pod:1659 ../src/guestfs.pod:1664 ../src/guestfs.pod:1668
923 #: ../src/guestfs.pod:1769 ../src/guestfs.pod:1774 ../src/guestfs.pod:1778
924 #: ../src/guestfs.pod:1788 ../src/guestfs.pod:2022 ../src/guestfs.pod:2027
925 #: ../src/guestfs.pod:2033 ../src/guestfs.pod:2041 ../src/guestfs.pod:2395
926 #: ../src/guestfs.pod:2401 ../src/guestfs.pod:2406 ../src/guestfs.pod:2412
927 #: ../src/guestfs.pod:2877 ../src/guestfs.pod:2881 ../src/guestfs.pod:2885
928 #: ../src/guestfs.pod:2889 ../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:1280 ../src/guestfs.pod:1411
1103 #: ../src/guestfs.pod:2440
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:1284 ../src/guestfs.pod:1415
1125 #: ../src/guestfs.pod:2465
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:1421
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>."
1480 #: ../src/guestfs.pod:644
1482 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1483 "L</guestfs_inspect_get_drive_mappings>)"
1487 #: ../src/guestfs.pod:647
1489 "Dealing with separator characters (backslash vs forward slash) is outside "
1490 "the scope of libguestfs, but usually a simple character replacement will "
1495 #: ../src/guestfs.pod:651
1497 "To resolve the case insensitivity of paths, call L</"
1498 "guestfs_case_sensitive_path>."
1503 #: ../src/guestfs.pod:654
1504 msgid "ACCESSING THE WINDOWS REGISTRY"
1509 #: ../src/guestfs.pod:656
1511 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1512 "files, through the library C<hivex> which is part of the libguestfs project "
1513 "although ships as a separate tarball. You have to locate and download the "
1514 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1515 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1516 "reg(1)> for more help on this issue."
1521 #: ../src/guestfs.pod:664
1522 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1527 #: ../src/guestfs.pod:666
1529 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1530 "provide something which looks like a Linux symlink. The way it tries to do "
1531 "the rewriting is described here:"
1536 #: ../src/guestfs.pod:670
1538 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1544 #: ../src/guestfs.pod:672
1546 "The essential problem is that ntfs-3g simply does not have enough "
1547 "information to do a correct job. NTFS links can contain drive letters and "
1548 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1549 "It is almost certainly the case that libguestfs callers should ignore what "
1550 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1555 #: ../src/guestfs.pod:679
1557 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1558 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1559 "attribute, and read the raw reparse data from that (you can find the format "
1560 "documented in various places around the web)."
1565 #: ../src/guestfs.pod:684
1566 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1571 #: ../src/guestfs.pod:686
1573 "There are other useful extended attributes that can be read from ntfs-3g "
1574 "filesystems (using L</guestfs_getxattr>). See:"
1579 #: ../src/guestfs.pod:689
1581 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1586 #: ../src/guestfs.pod:691
1587 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1592 #: ../src/guestfs.pod:693
1594 "Although we don't want to discourage you from using the C API, we will "
1595 "mention here that the same API is also available in other languages."
1599 #: ../src/guestfs.pod:696
1601 "The API is broadly identical in all supported languages. This means that "
1602 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1603 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1604 "OCaml. In other words, a straightforward, predictable isomorphism between "
1610 #: ../src/guestfs.pod:702
1612 "Error messages are automatically transformed into exceptions if the language "
1618 #: ../src/guestfs.pod:705
1620 "We don't try to \"object orientify\" parts of the API in OO languages, "
1621 "although contributors are welcome to write higher level APIs above what we "
1622 "provide in their favourite languages if they wish."
1627 #: ../src/guestfs.pod:711
1633 #: ../src/guestfs.pod:713
1635 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1636 "identical to the C API. C++ classes and exceptions are not used."
1641 #: ../src/guestfs.pod:717
1647 #: ../src/guestfs.pod:719
1649 "The C# bindings are highly experimental. Please read the warnings at the "
1650 "top of C<csharp/Libguestfs.cs>."
1655 #: ../src/guestfs.pod:722
1661 #: ../src/guestfs.pod:724
1663 "This is the only language binding that is working but incomplete. Only "
1664 "calls which return simple integers have been bound in Haskell, and we are "
1665 "looking for help to complete this binding."
1670 #: ../src/guestfs.pod:728
1676 #: ../src/guestfs.pod:730
1678 "Full documentation is contained in the Javadoc which is distributed with "
1684 #: ../src/guestfs.pod:733
1689 #: ../src/guestfs.pod:735
1690 msgid "See L<guestfs-ocaml(3)>."
1695 #: ../src/guestfs.pod:737
1700 #: ../src/guestfs.pod:739
1701 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1706 #: ../src/guestfs.pod:741
1712 #: ../src/guestfs.pod:743
1714 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1715 "the php-libguestfs package for your distribution."
1720 #: ../src/guestfs.pod:746
1721 msgid "The PHP binding only works correctly on 64 bit machines."
1726 #: ../src/guestfs.pod:748
1731 #: ../src/guestfs.pod:750
1732 msgid "See L<guestfs-python(3)>."
1737 #: ../src/guestfs.pod:752
1742 #: ../src/guestfs.pod:754
1743 msgid "See L<guestfs-ruby(3)>."
1748 #: ../src/guestfs.pod:756
1749 msgid "B<shell scripts>"
1753 #: ../src/guestfs.pod:758
1754 msgid "See L<guestfish(1)>."
1759 #: ../src/guestfs.pod:762
1760 msgid "LIBGUESTFS GOTCHAS"
1765 #: ../src/guestfs.pod:764
1767 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1768 "system [...] that works in the way it is documented but is counterintuitive "
1769 "and almost invites mistakes.\""
1774 #: ../src/guestfs.pod:768
1776 "Since we developed libguestfs and the associated tools, there are several "
1777 "things we would have designed differently, but are now stuck with for "
1778 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1779 "release, you can expect these to change. Beware of them."
1784 #: ../src/guestfs.pod:776
1785 msgid "Autosync / forgetting to sync."
1790 #: ../src/guestfs.pod:778
1792 "When modifying a filesystem from C or another language, you B<must> unmount "
1793 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1794 "libguestfs handle. You can also call:"
1799 #: ../src/guestfs.pod:782
1802 " guestfs_set_autosync (g, 1);\n"
1808 #: ../src/guestfs.pod:784
1810 "to have the unmount/sync done automatically for you when the handle 'g' is "
1811 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1816 #: ../src/guestfs.pod:788
1818 "If you forget to do this, then it is entirely possible that your changes "
1819 "won't be written out, or will be partially written, or (very rarely) that "
1820 "you'll get disk corruption."
1825 #: ../src/guestfs.pod:792
1827 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1828 "guestfish scripts that forget to sync will work just fine, which can make "
1829 "this very puzzling if you are trying to debug a problem."
1834 #: ../src/guestfs.pod:796
1836 "Update: Autosync is enabled by default for all API users starting from "
1837 "libguestfs 1.5.24."
1842 #: ../src/guestfs.pod:799
1843 msgid "Mount option C<-o sync> should not be the default."
1848 #: ../src/guestfs.pod:801
1850 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1851 "However C<-o sync> does not add any reliability benefit, but does have a "
1852 "very large performance impact."
1857 #: ../src/guestfs.pod:805
1859 "The work around is to use L</guestfs_mount_options> and set the mount "
1860 "options that you actually want to use."
1865 #: ../src/guestfs.pod:808
1866 msgid "Read-only should be the default."
1871 #: ../src/guestfs.pod:810
1873 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1874 "specify I<--rw> if you want to make changes to the image."
1879 #: ../src/guestfs.pod:813
1880 msgid "This would reduce the potential to corrupt live VM images."
1885 #: ../src/guestfs.pod:815
1887 "Note that many filesystems change the disk when you just mount and unmount, "
1888 "even if you didn't perform any writes. You need to use L</"
1889 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1894 #: ../src/guestfs.pod:819
1895 msgid "guestfish command line is hard to use."
1900 #: ../src/guestfs.pod:821
1902 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1903 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1904 "exist, so it fails. In earlier versions of guestfish the error message was "
1905 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1906 "we should have used C<guestfish -c command> to run commands."
1911 #: ../src/guestfs.pod:828
1912 msgid "guestfish megabyte modifiers don't work right on all commands"
1917 #: ../src/guestfs.pod:830
1919 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1920 "other modifiers). What guestfish actually does is to multiply the number "
1921 "part by the modifier part and pass the result to the C API. However this "
1922 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1923 "expecting some other unit (eg. megabytes)."
1928 #: ../src/guestfs.pod:837
1929 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1934 #: ../src/guestfs.pod:839
1937 " lvcreate LV VG 100M\n"
1943 #: ../src/guestfs.pod:841
1945 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1946 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1947 "megabytes * megabytes) logical volume. The error message you get from this "
1948 "is also a little obscure."
1953 #: ../src/guestfs.pod:846
1955 "This could be fixed in the generator by specially marking parameters and "
1956 "return values which take bytes or other units."
1961 #: ../src/guestfs.pod:849
1962 msgid "Ambiguity between devices and paths"
1967 #: ../src/guestfs.pod:851
1969 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1970 "sdb2>) and a similar pathname. A file might just happen to be called "
1971 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1976 #: ../src/guestfs.pod:856
1978 "In the current API we usually resolve this ambiguity by having two separate "
1979 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1980 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1981 "detecting if the path supplied begins with C</dev/>."
1986 #: ../src/guestfs.pod:862
1988 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1989 "make paths/devices into structured names. One way to do this would be to "
1990 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1991 "aspect of grub. Another way would be to use a structured type, equivalent "
1992 "to this OCaml type:"
1997 #: ../src/guestfs.pod:868
2000 " type path = Path of string | Device of int | Partition of int * int\n"
2006 #: ../src/guestfs.pod:870
2007 msgid "which would allow you to pass arguments like:"
2012 #: ../src/guestfs.pod:872
2015 " Path \"/foo/bar\"\n"
2016 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2017 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2018 " Path \"/dev/sdb2\" (* not a device *)\n"
2024 #: ../src/guestfs.pod:877
2026 "As you can see there are still problems to resolve even with this "
2027 "representation. Also consider how it might work in guestfish."
2032 #: ../src/guestfs.pod:882
2033 msgid "PROTOCOL LIMITS"
2038 #: ../src/guestfs.pod:884
2040 "Internally libguestfs uses a message-based protocol to pass API calls and "
2041 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2042 "plenty more detail about this). The maximum message size used by the "
2043 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2044 "aware of this limit. The API calls which may be affected are individually "
2045 "documented, with a link back to this section of the documentation."
2050 #: ../src/guestfs.pod:892
2052 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2053 "a simple string. Because this string is at some point internally encoded as "
2054 "a message, the maximum size that it can return is slightly under 4 MB. If "
2055 "the requested file is larger than this then you will get an error."
2060 #: ../src/guestfs.pod:898
2062 "In order to transfer large files into and out of the guest filesystem, you "
2063 "need to use particular calls that support this. The sections L</UPLOADING> "
2064 "and L</DOWNLOADING> document how to do this."
2069 #: ../src/guestfs.pod:902
2071 "You might also consider mounting the disk image using our FUSE filesystem "
2072 "support (L<guestmount(1)>)."
2077 #: ../src/guestfs.pod:905
2078 msgid "KEYS AND PASSPHRASES"
2083 #: ../src/guestfs.pod:907
2085 "Certain libguestfs calls take a parameter that contains sensitive key "
2086 "material, passed in as a C string."
2091 #: ../src/guestfs.pod:910
2093 "In the future we would hope to change the libguestfs implementation so that "
2094 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2095 "swap. However this is I<not> done at the moment, because of the complexity "
2096 "of such an implementation."
2101 #: ../src/guestfs.pod:915
2103 "Therefore you should be aware that any key parameter you pass to libguestfs "
2104 "might end up being written out to the swap partition. If this is a concern, "
2105 "scrub the swap partition or don't use libguestfs on encrypted devices."
2110 #: ../src/guestfs.pod:920
2111 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2116 #: ../src/guestfs.pod:922
2118 "All high-level libguestfs actions are synchronous. If you want to use "
2119 "libguestfs asynchronously then you must create a thread."
2124 #: ../src/guestfs.pod:925
2126 "Only use the handle from a single thread. Either use the handle exclusively "
2127 "from one thread, or provide your own mutex so that two threads cannot issue "
2128 "calls on the same handle at the same time."
2133 #: ../src/guestfs.pod:929
2135 "See the graphical program guestfs-browser for one possible architecture for "
2136 "multithreaded programs using libvirt and libguestfs."
2141 #: ../src/guestfs.pod:932
2146 #: ../src/guestfs.pod:934
2148 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2154 #: ../src/guestfs.pod:937
2156 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2157 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2162 #: ../src/guestfs.pod:940
2164 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2165 "to change the directories that libguestfs will search in. The value is a "
2166 "colon-separated list of paths. The current directory is I<not> searched "
2167 "unless the path contains an empty element or C<.>. For example "
2168 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2169 "then C</usr/lib/guestfs>."
2174 #: ../src/guestfs.pod:947
2175 msgid "QEMU WRAPPERS"
2180 #: ../src/guestfs.pod:949
2182 "If you want to compile your own qemu, run qemu from a non-standard location, "
2183 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2189 #: ../src/guestfs.pod:953
2191 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2192 "last command in the shell script (so that qemu replaces the shell and "
2193 "becomes the direct child of the libguestfs-using program). If you don't do "
2194 "this, then the qemu process won't be cleaned up correctly."
2199 #: ../src/guestfs.pod:958
2201 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2207 #: ../src/guestfs.pod:961
2211 " qemudir=/home/rjones/d/qemu\n"
2212 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2218 #: ../src/guestfs.pod:965
2220 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2221 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2227 #: ../src/guestfs.pod:969
2230 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2236 #: ../src/guestfs.pod:971
2238 "Note that libguestfs also calls qemu with the -help and -version options in "
2239 "order to determine features."
2243 #: ../src/guestfs.pod:974
2244 msgid "ATTACHING TO RUNNING DAEMONS"
2248 #: ../src/guestfs.pod:976
2250 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2251 "babies. Use with caution."
2255 #: ../src/guestfs.pod:979
2257 "I<Note (2):> This section explains how to attach to a running daemon from a "
2258 "low level perspective. For most users, simply using virt tools such as "
2259 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2263 #: ../src/guestfs.pod:983
2264 msgid "Using guestfs_set_attach_method"
2268 #: ../src/guestfs.pod:985
2270 "By calling L</guestfs_set_attach_method> you can change how the library "
2271 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2272 "ARCHITECTURE> for some background)."
2276 #: ../src/guestfs.pod:989
2278 "The normal attach method is C<appliance>, where a small appliance is created "
2279 "containing the daemon, and then the library connects to this."
2283 #: ../src/guestfs.pod:992
2285 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2286 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2287 "daemon over the Unix domain socket."
2291 #: ../src/guestfs.pod:996
2293 "The normal use for this is to connect to a running virtual machine that "
2294 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2295 "files inside the live virtual machine."
2299 #: ../src/guestfs.pod:1000
2300 msgid "Using guestfs_add_domain with live flag"
2304 #: ../src/guestfs.pod:1002
2306 "L</guestfs_add_domain> provides some help for getting the correct attach "
2307 "method. If you pass the C<live> option to this function, then (if the "
2308 "virtual machine is running) it will examine the libvirt XML looking for a "
2309 "virtio-serial channel to connect to:"
2313 #: ../src/guestfs.pod:1008
2320 " <channel type='unix'>\n"
2321 " <source mode='bind' path='/path/to/socket'/>\n"
2322 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2331 #: ../src/guestfs.pod:1020
2333 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2334 "method to C<unix:/path/to/socket>."
2338 #: ../src/guestfs.pod:1023
2340 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2341 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2342 "to attach to and modify live virtual machines."
2346 #: ../src/guestfs.pod:1027
2348 "The virtual machine needs to have been set up beforehand so that it has the "
2349 "virtio-serial channel and so that guestfsd is running inside it."
2354 #: ../src/guestfs.pod:1031
2355 msgid "ABI GUARANTEE"
2360 #: ../src/guestfs.pod:1033
2362 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2363 "actions as outlined in this section. Although we will deprecate some "
2364 "actions, for example if they get replaced by newer calls, we will keep the "
2365 "old actions forever. This allows you the developer to program in confidence "
2366 "against the libguestfs API."
2371 #: ../src/guestfs.pod:1039
2372 msgid "BLOCK DEVICE NAMING"
2377 #: ../src/guestfs.pod:1041
2379 "In the kernel there is now quite a profusion of schemata for naming block "
2380 "devices (in this context, by I<block device> I mean a physical or virtual "
2381 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2382 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2383 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2384 "for the old IDE driver (particularly for SATA devices) those devices also "
2385 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2386 "paravirtualized drivers. This has created several different naming systems, "
2387 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2392 #: ../src/guestfs.pod:1053
2394 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2395 "Linux kernel to access block devices. We can run a variety of appliances "
2396 "based on a variety of Linux kernels."
2401 #: ../src/guestfs.pod:1057
2403 "This causes a problem for libguestfs because many API calls use device or "
2404 "partition names. Working scripts and the recipe (example) scripts that we "
2405 "make available over the internet could fail if the naming scheme changes."
2410 #: ../src/guestfs.pod:1062
2412 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2413 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2414 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2415 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2420 #: ../src/guestfs.pod:1068
2422 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2423 "L</guestfs_list_partitions> and similar calls return the true names of the "
2424 "devices and partitions as known to the appliance."
2429 #: ../src/guestfs.pod:1073
2430 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2435 #: ../src/guestfs.pod:1075
2437 "Usually this translation is transparent. However in some (very rare) cases "
2438 "you may need to know the exact algorithm. Such cases include where you use "
2439 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2440 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2445 #: ../src/guestfs.pod:1081
2447 "The algorithm is applied only to I<parameters> which are known to be either "
2448 "device or partition names. Return values from functions such as L</"
2449 "guestfs_list_devices> are never changed."
2454 #: ../src/guestfs.pod:1089
2455 msgid "Is the string a parameter which is a device or partition name?"
2460 #: ../src/guestfs.pod:1093
2461 msgid "Does the string begin with C</dev/sd>?"
2466 #: ../src/guestfs.pod:1097
2468 "Does the named device exist? If so, we use that device. However if I<not> "
2469 "then we continue with this algorithm."
2474 #: ../src/guestfs.pod:1102
2475 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2480 #: ../src/guestfs.pod:1104
2481 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2486 #: ../src/guestfs.pod:1106
2487 msgid "If that named device exists, use it. If not, continue."
2492 #: ../src/guestfs.pod:1110
2493 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2498 #: ../src/guestfs.pod:1112
2499 msgid "If that named device exists, use it. If not, return an error."
2504 #: ../src/guestfs.pod:1116
2505 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2510 #: ../src/guestfs.pod:1118
2512 "Although the standard naming scheme and automatic translation is useful for "
2513 "simple programs and guestfish scripts, for larger programs it is best not to "
2514 "rely on this mechanism."
2519 #: ../src/guestfs.pod:1122
2521 "Where possible for maximum future portability programs using libguestfs "
2522 "should use these future-proof techniques:"
2527 #: ../src/guestfs.pod:1129
2529 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2530 "device names, and then use those names directly."
2535 #: ../src/guestfs.pod:1132
2537 "Since those device names exist by definition, they will never be translated."
2542 #: ../src/guestfs.pod:1137
2544 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2545 "filesystem labels."
2550 #: ../src/guestfs.pod:1142
2556 #: ../src/guestfs.pod:1144
2558 "This section discusses security implications of using libguestfs, "
2559 "particularly with untrusted or malicious guests or disk images."
2564 #: ../src/guestfs.pod:1147
2565 msgid "GENERAL SECURITY CONSIDERATIONS"
2570 #: ../src/guestfs.pod:1149
2572 "Be careful with any files or data that you download from a guest (by "
2573 "\"download\" we mean not just the L</guestfs_download> command but any "
2574 "command that reads files, filenames, directories or anything else from a "
2575 "disk image). An attacker could manipulate the data to fool your program "
2576 "into doing the wrong thing. Consider cases such as:"
2581 #: ../src/guestfs.pod:1159
2582 msgid "the data (file etc) not being present"
2587 #: ../src/guestfs.pod:1163
2588 msgid "being present but empty"
2593 #: ../src/guestfs.pod:1167
2594 msgid "being much larger than normal"
2599 #: ../src/guestfs.pod:1171
2600 msgid "containing arbitrary 8 bit data"
2605 #: ../src/guestfs.pod:1175
2606 msgid "being in an unexpected character encoding"
2611 #: ../src/guestfs.pod:1179
2612 msgid "containing homoglyphs."
2617 #: ../src/guestfs.pod:1183
2618 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2623 #: ../src/guestfs.pod:1185
2625 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2626 "(VFS) module can sometimes be escalated into exploits by deliberately "
2627 "creating a malicious, malformed filesystem. These exploits are very severe "
2628 "for two reasons. Firstly there are very many filesystem drivers in the "
2629 "kernel, and many of them are infrequently used and not much developer "
2630 "attention has been paid to the code. Linux userspace helps potential "
2631 "crackers by detecting the filesystem type and automatically choosing the "
2632 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2633 "the administrator. Secondly, a kernel-level exploit is like a local root "
2634 "exploit (worse in some ways), giving immediate and total access to the "
2635 "system right down to the hardware level."
2640 #: ../src/guestfs.pod:1198
2642 "That explains why you should never mount a filesystem from an untrusted "
2643 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2644 "inside a qemu virtual machine, usually running as a non-root user. The "
2645 "attacker would need to write a filesystem which first exploited the kernel, "
2646 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2647 "the libguestfs protocol, and finally to be as serious as the host kernel "
2648 "exploit it would need to escalate its privileges to root. This multi-step "
2649 "escalation, performed by a static piece of data, is thought to be extremely "
2650 "hard to do, although we never say 'never' about security issues."
2655 #: ../src/guestfs.pod:1209
2657 "In any case callers can reduce the attack surface by forcing the filesystem "
2658 "type when mounting (use L</guestfs_mount_vfs>)."
2663 #: ../src/guestfs.pod:1212
2664 msgid "PROTOCOL SECURITY"
2669 #: ../src/guestfs.pod:1214
2671 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2672 "defined upper message size. However a program that uses libguestfs must "
2673 "also take care - for example you can write a program that downloads a binary "
2674 "from a disk image and executes it locally, and no amount of protocol "
2675 "security will save you from the consequences."
2680 #: ../src/guestfs.pod:1220
2681 msgid "INSPECTION SECURITY"
2686 #: ../src/guestfs.pod:1222
2688 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2689 "directly from the guest, and these could contain any 8 bit data. Callers "
2690 "should be careful to escape these before printing them to a structured file "
2691 "(for example, use HTML escaping if creating a web page)."
2696 #: ../src/guestfs.pod:1228
2698 "Guest configuration may be altered in unusual ways by the administrator of "
2699 "the virtual machine, and may not reflect reality (particularly for untrusted "
2700 "or actively malicious guests). For example we parse the hostname from "
2701 "configuration files like C</etc/sysconfig/network> that we find in the "
2702 "guest, but the guest administrator can easily manipulate these files to "
2703 "provide the wrong hostname."
2708 #: ../src/guestfs.pod:1236
2710 "The inspection API parses guest configuration using two external libraries: "
2711 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2712 "designed to be robust in the face of malicious data, although denial of "
2713 "service attacks are still possible, for example with oversized configuration "
2719 #: ../src/guestfs.pod:1242
2720 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2725 #: ../src/guestfs.pod:1244
2727 "Be very cautious about running commands from the guest. By running a "
2728 "command in the guest, you are giving CPU time to a binary that you do not "
2729 "control, under the same user account as the library, albeit wrapped in qemu "
2730 "virtualization. More information and alternatives can be found in the "
2731 "section L</RUNNING COMMANDS>."
2736 #: ../src/guestfs.pod:1250
2737 msgid "CVE-2010-3851"
2742 #: ../src/guestfs.pod:1252
2743 msgid "https://bugzilla.redhat.com/642934"
2748 #: ../src/guestfs.pod:1254
2750 "This security bug concerns the automatic disk format detection that qemu "
2751 "does on disk images."
2756 #: ../src/guestfs.pod:1257
2758 "A raw disk image is just the raw bytes, there is no header. Other disk "
2759 "images like qcow2 contain a special header. Qemu deals with this by looking "
2760 "for one of the known headers, and if none is found then assuming the disk "
2761 "image must be raw."
2766 #: ../src/guestfs.pod:1262
2768 "This allows a guest which has been given a raw disk image to write some "
2769 "other header. At next boot (or when the disk image is accessed by "
2770 "libguestfs) qemu would do autodetection and think the disk image format was, "
2771 "say, qcow2 based on the header written by the guest."
2776 #: ../src/guestfs.pod:1267
2778 "This in itself would not be a problem, but qcow2 offers many features, one "
2779 "of which is to allow a disk image to refer to another image (called the "
2780 "\"backing disk\"). It does this by placing the path to the backing disk "
2781 "into the qcow2 header. This path is not validated and could point to any "
2782 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2783 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2784 "control of the attacker."
2789 #: ../src/guestfs.pod:1275
2791 "In libguestfs this is rather hard to exploit except under two circumstances:"
2796 #: ../src/guestfs.pod:1282
2797 msgid "You have enabled the network or have opened the disk in write mode."
2802 #: ../src/guestfs.pod:1286
2804 "You are also running untrusted code from the guest (see L</RUNNING "
2810 #: ../src/guestfs.pod:1291
2812 "The way to avoid this is to specify the expected disk format when adding "
2813 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2814 "should always do this if the disk is raw format, and it's a good idea for "
2820 #: ../src/guestfs.pod:1296
2822 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2823 "format is fetched from libvirt and passed through."
2828 #: ../src/guestfs.pod:1299
2830 "For libguestfs tools, use the I<--format> command line parameter as "
2836 #: ../src/guestfs.pod:1302
2837 msgid "CONNECTION MANAGEMENT"
2842 #: ../src/guestfs.pod:1304
2848 #: ../src/guestfs.pod:1306
2850 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2851 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2852 "handle and release all resources used."
2857 #: ../src/guestfs.pod:1310
2859 "For information on using multiple handles and threads, see the section L</"
2860 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2865 #: ../src/guestfs.pod:1313
2866 msgid "guestfs_create"
2871 #: ../src/guestfs.pod:1315
2874 " guestfs_h *guestfs_create (void);\n"
2880 #: ../src/guestfs.pod:1317
2881 msgid "Create a connection handle."
2886 #: ../src/guestfs.pod:1319
2888 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2889 "on the handle at least once."
2894 #: ../src/guestfs.pod:1322
2896 "This function returns a non-NULL pointer to a handle on success or NULL on "
2902 #: ../src/guestfs.pod:1325
2903 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2908 #: ../src/guestfs.pod:1327
2910 "You may also want to configure error handling for the handle. See L</ERROR "
2911 "HANDLING> section below."
2916 #: ../src/guestfs.pod:1330
2917 msgid "guestfs_close"
2922 #: ../src/guestfs.pod:1332
2925 " void guestfs_close (guestfs_h *g);\n"
2931 #: ../src/guestfs.pod:1334
2932 msgid "This closes the connection handle and frees up all resources used."
2937 #: ../src/guestfs.pod:1336
2938 msgid "ERROR HANDLING"
2943 #: ../src/guestfs.pod:1338
2945 "API functions can return errors. For example, almost all functions that "
2946 "return C<int> will return C<-1> to indicate an error."
2951 #: ../src/guestfs.pod:1341
2953 "Additional information is available for errors: an error message string and "
2954 "optionally an error number (errno) if the thing that failed was a system "
2960 #: ../src/guestfs.pod:1345
2962 "You can get at the additional information about the last error on the handle "
2963 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2964 "up an error handler with L</guestfs_set_error_handler>."
2969 #: ../src/guestfs.pod:1350
2971 "When the handle is created, a default error handler is installed which "
2972 "prints the error message string to C<stderr>. For small short-running "
2973 "command line programs it is sufficient to do:"
2978 #: ../src/guestfs.pod:1354
2981 " if (guestfs_launch (g) == -1)\n"
2982 " exit (EXIT_FAILURE);\n"
2988 #: ../src/guestfs.pod:1357
2990 "since the default error handler will ensure that an error message has been "
2991 "printed to C<stderr> before the program exits."
2996 #: ../src/guestfs.pod:1360
2998 "For other programs the caller will almost certainly want to install an "
2999 "alternate error handler or do error handling in-line like this:"
3004 #: ../src/guestfs.pod:1363
3007 " g = guestfs_create ();\n"
3013 #: ../src/guestfs.pod:1365
3016 " /* This disables the default behaviour of printing errors\n"
3018 " guestfs_set_error_handler (g, NULL, NULL);\n"
3024 #: ../src/guestfs.pod:1369
3027 " if (guestfs_launch (g) == -1) {\n"
3028 " /* Examine the error message and print it etc. */\n"
3029 " char *msg = guestfs_last_error (g);\n"
3030 " int errnum = guestfs_last_errno (g);\n"
3031 " fprintf (stderr, \"%s\\n\", msg);\n"
3039 #: ../src/guestfs.pod:1377
3041 "Out of memory errors are handled differently. The default action is to call "
3042 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3043 "guestfs_set_out_of_memory_handler>."
3048 #: ../src/guestfs.pod:1381
3050 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3051 "because there is no handle if this happens there is no way to get additional "
3052 "error information. However L</guestfs_create> is supposed to be a "
3053 "lightweight operation which can only fail because of insufficient memory (it "
3054 "returns NULL in this case)."
3059 #: ../src/guestfs.pod:1387
3060 msgid "guestfs_last_error"
3065 #: ../src/guestfs.pod:1389
3068 " const char *guestfs_last_error (guestfs_h *g);\n"
3074 #: ../src/guestfs.pod:1391
3076 "This returns the last error message that happened on C<g>. If there has not "
3077 "been an error since the handle was created, then this returns C<NULL>."
3082 #: ../src/guestfs.pod:1395
3084 "The lifetime of the returned string is until the next error occurs, or L</"
3085 "guestfs_close> is called."
3090 #: ../src/guestfs.pod:1398
3091 msgid "guestfs_last_errno"
3096 #: ../src/guestfs.pod:1400
3099 " int guestfs_last_errno (guestfs_h *g);\n"
3105 #: ../src/guestfs.pod:1402
3106 msgid "This returns the last error number (errno) that happened on C<g>."
3111 #: ../src/guestfs.pod:1404
3112 msgid "If successful, an errno integer not equal to zero is returned."
3117 #: ../src/guestfs.pod:1406
3119 "If no error, this returns 0. This call can return 0 in three situations:"
3124 #: ../src/guestfs.pod:1413
3125 msgid "There has not been any error on the handle."
3130 #: ../src/guestfs.pod:1417
3132 "There has been an error but the errno was meaningless. This corresponds to "
3133 "the case where the error did not come from a failed system call, but for "
3134 "some other reason."
3139 #: ../src/guestfs.pod:1423
3141 "There was an error from a failed system call, but for some reason the errno "
3142 "was not captured and returned. This usually indicates a bug in libguestfs."
3147 #: ../src/guestfs.pod:1429
3149 "Libguestfs tries to convert the errno from inside the applicance into a "
3150 "corresponding errno for the caller (not entirely trivial: the appliance "
3151 "might be running a completely different operating system from the library "
3152 "and error numbers are not standardized across Un*xen). If this could not be "
3153 "done, then the error is translated to C<EINVAL>. In practice this should "
3154 "only happen in very rare circumstances."
3159 #: ../src/guestfs.pod:1437
3160 msgid "guestfs_set_error_handler"
3165 #: ../src/guestfs.pod:1439
3168 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3170 " const char *msg);\n"
3171 " void guestfs_set_error_handler (guestfs_h *g,\n"
3172 " guestfs_error_handler_cb cb,\n"
3179 #: ../src/guestfs.pod:1446
3181 "The callback C<cb> will be called if there is an error. The parameters "
3182 "passed to the callback are an opaque data pointer and the error message "
3188 #: ../src/guestfs.pod:1450
3190 "C<errno> is not passed to the callback. To get that the callback must call "
3191 "L</guestfs_last_errno>."
3196 #: ../src/guestfs.pod:1453
3198 "Note that the message string C<msg> is freed as soon as the callback "
3199 "function returns, so if you want to stash it somewhere you must make your "
3205 #: ../src/guestfs.pod:1457
3206 msgid "The default handler prints messages on C<stderr>."
3211 #: ../src/guestfs.pod:1459
3212 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3217 #: ../src/guestfs.pod:1461
3218 msgid "guestfs_get_error_handler"
3223 #: ../src/guestfs.pod:1463
3226 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3227 " void **opaque_rtn);\n"
3233 #: ../src/guestfs.pod:1466
3234 msgid "Returns the current error handler callback."
3239 #: ../src/guestfs.pod:1468
3240 msgid "guestfs_set_out_of_memory_handler"
3245 #: ../src/guestfs.pod:1470
3248 " typedef void (*guestfs_abort_cb) (void);\n"
3249 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3250 " guestfs_abort_cb);\n"
3256 #: ../src/guestfs.pod:1474
3258 "The callback C<cb> will be called if there is an out of memory situation. "
3259 "I<Note this callback must not return>."
3264 #: ../src/guestfs.pod:1477
3265 msgid "The default is to call L<abort(3)>."
3270 #: ../src/guestfs.pod:1479
3272 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3277 #: ../src/guestfs.pod:1482
3278 msgid "guestfs_get_out_of_memory_handler"
3283 #: ../src/guestfs.pod:1484
3286 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3292 #: ../src/guestfs.pod:1486
3293 msgid "This returns the current out of memory handler."
3298 #: ../src/guestfs.pod:1488
3304 #: ../src/guestfs.pod:1490 ../fish/guestfish.pod:1008
3310 #: ../src/guestfs.pod:1492
3316 #: ../src/guestfs.pod:1494
3322 #: ../src/guestfs.pod:1496
3323 msgid "AVAILABILITY"
3328 #: ../src/guestfs.pod:1498
3329 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3334 #: ../src/guestfs.pod:1500
3336 "Using L</guestfs_available> you can test availability of the following "
3337 "groups of functions. This test queries the appliance to see if the "
3338 "appliance you are currently using supports the functionality."
3343 #: ../src/guestfs.pod:1505
3344 msgid "@AVAILABILITY@"
3349 #: ../src/guestfs.pod:1507
3350 msgid "GUESTFISH supported COMMAND"
3355 #: ../src/guestfs.pod:1509
3357 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3358 "prints out the available groups and whether they are supported by this build "
3359 "of libguestfs. Note however that you have to do C<run> first."
3364 #: ../src/guestfs.pod:1514
3365 msgid "SINGLE CALLS AT COMPILE TIME"
3370 #: ../src/guestfs.pod:1516
3372 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3373 "function, such as:"
3378 #: ../src/guestfs.pod:1519
3381 " #define LIBGUESTFS_HAVE_DD 1\n"
3387 #: ../src/guestfs.pod:1521
3388 msgid "if L</guestfs_dd> is available."
3393 #: ../src/guestfs.pod:1523
3395 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3396 "function is available at compile time, we recommended using build tools such "
3397 "as autoconf or cmake. For example in autotools you could use:"
3402 #: ../src/guestfs.pod:1528
3405 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3406 " AC_CHECK_FUNCS([guestfs_dd])\n"
3412 #: ../src/guestfs.pod:1531
3414 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3420 #: ../src/guestfs.pod:1534
3421 msgid "SINGLE CALLS AT RUN TIME"
3426 #: ../src/guestfs.pod:1536
3428 "Testing at compile time doesn't guarantee that a function really exists in "
3429 "the library. The reason is that you might be dynamically linked against a "
3430 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3431 "This situation unfortunately results in a segmentation fault, which is a "
3432 "shortcoming of the C dynamic linking system itself."
3437 #: ../src/guestfs.pod:1543
3439 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3440 "in this example program (note that you still need the compile time check as "
3446 #: ../src/guestfs.pod:1547
3449 " #include <stdio.h>\n"
3450 " #include <stdlib.h>\n"
3451 " #include <unistd.h>\n"
3452 " #include <dlfcn.h>\n"
3453 " #include <guestfs.h>\n"
3459 #: ../src/guestfs.pod:1553
3464 " #ifdef LIBGUESTFS_HAVE_DD\n"
3466 " int has_function;\n"
3472 #: ../src/guestfs.pod:1559
3475 " /* Test if the function guestfs_dd is really available. */\n"
3476 " dl = dlopen (NULL, RTLD_LAZY);\n"
3478 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3479 " exit (EXIT_FAILURE);\n"
3481 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3488 #: ../src/guestfs.pod:1568
3491 " if (!has_function)\n"
3492 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3494 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3495 " /* Now it's safe to call\n"
3496 " guestfs_dd (g, \"foo\", \"bar\");\n"
3500 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3508 #: ../src/guestfs.pod:1581
3510 "You may think the above is an awful lot of hassle, and it is. There are "
3511 "other ways outside of the C linking system to ensure that this kind of "
3512 "incompatibility never arises, such as using package versioning:"
3517 #: ../src/guestfs.pod:1586
3520 " Requires: libguestfs >= 1.0.80\n"
3526 #: ../src/guestfs.pod:1588
3527 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3532 #: ../src/guestfs.pod:1590
3534 "A recent feature of the API is the introduction of calls which take optional "
3535 "arguments. In C these are declared 3 ways. The main way is as a call which "
3536 "takes variable arguments (ie. C<...>), as in this example:"
3541 #: ../src/guestfs.pod:1595
3544 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3550 #: ../src/guestfs.pod:1597
3552 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3553 "call with no optional arguments specified:"
3558 #: ../src/guestfs.pod:1600
3561 " guestfs_add_drive_opts (g, filename, -1);\n"
3567 #: ../src/guestfs.pod:1602
3568 msgid "With a single optional argument:"
3573 #: ../src/guestfs.pod:1604
3576 " guestfs_add_drive_opts (g, filename,\n"
3577 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3584 #: ../src/guestfs.pod:1608
3590 #: ../src/guestfs.pod:1610
3593 " guestfs_add_drive_opts (g, filename,\n"
3594 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3595 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3602 #: ../src/guestfs.pod:1615
3604 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3610 #: ../src/guestfs.pod:1618
3611 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3616 #: ../src/guestfs.pod:1620
3618 "The second variant has the same name with the suffix C<_va>, which works the "
3619 "same way but takes a C<va_list>. See the C manual for details. For the "
3620 "example function, this is declared:"
3625 #: ../src/guestfs.pod:1624
3628 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3635 #: ../src/guestfs.pod:1627
3636 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3641 #: ../src/guestfs.pod:1629
3643 "The third variant is useful where you need to construct these calls. You "
3644 "pass in a structure where you fill in the optional fields. The structure "
3645 "has a bitmask as the first element which you must set to indicate which "
3646 "fields you have filled in. For our example function the structure and call "
3652 #: ../src/guestfs.pod:1635
3655 " struct guestfs_add_drive_opts_argv {\n"
3656 " uint64_t bitmask;\n"
3658 " const char *format;\n"
3661 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3662 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3668 #: ../src/guestfs.pod:1644
3669 msgid "You could call it like this:"
3674 #: ../src/guestfs.pod:1646
3677 " struct guestfs_add_drive_opts_argv optargs = {\n"
3678 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3679 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3681 " .format = \"qcow2\"\n"
3688 #: ../src/guestfs.pod:1653
3691 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3697 #: ../src/guestfs.pod:1655 ../src/guestfs-actions.pod:11
3698 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3699 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3705 #: ../src/guestfs.pod:1661
3706 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3711 #: ../src/guestfs.pod:1666
3712 msgid "You do not need to fill in all fields of the structure."
3717 #: ../src/guestfs.pod:1670
3719 "There must be a one-to-one correspondence between fields of the structure "
3720 "that are filled in, and bits set in the bitmask."
3725 #: ../src/guestfs.pod:1675
3726 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3731 #: ../src/guestfs.pod:1677
3733 "In other languages, optional arguments are expressed in the way that is "
3734 "natural for that language. We refer you to the language-specific "
3735 "documentation for more details on that."
3740 #: ../src/guestfs.pod:1681
3741 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3746 #: ../src/guestfs.pod:1683
3747 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3751 #: ../src/guestfs.pod:1685
3753 "B<Note:> This section documents the generic event mechanism introduced in "
3754 "libguestfs 1.10, which you should use in new code if possible. The old "
3755 "functions C<guestfs_set_log_message_callback>, "
3756 "C<guestfs_set_subprocess_quit_callback>, "
3757 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3758 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3763 #: ../src/guestfs.pod:1693
3765 "Handles generate events when certain things happen, such as log messages "
3766 "being generated, progress messages during long-running operations, or the "
3767 "handle being closed. The API calls described below let you register a "
3768 "callback to be called when events happen. You can register multiple "
3769 "callbacks (for the same, different or overlapping sets of events), and "
3770 "individually remove callbacks. If callbacks are not removed, then they "
3771 "remain in force until the handle is closed."
3775 #: ../src/guestfs.pod:1701
3777 "In the current implementation, events are only generated synchronously: that "
3778 "means that events (and hence callbacks) can only happen while you are in the "
3779 "middle of making another libguestfs call. The callback is called in the "
3784 #: ../src/guestfs.pod:1706
3786 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3787 "unsigned integers, or a message buffer. Payloads are discussed later on."
3791 #: ../src/guestfs.pod:1710
3792 msgid "CLASSES OF EVENTS"
3796 #: ../src/guestfs.pod:1714
3797 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3801 #: ../src/guestfs.pod:1717
3803 "The callback function will be called while the handle is being closed "
3804 "(synchronously from L</guestfs_close>)."
3809 #: ../src/guestfs.pod:1720
3811 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3812 "handles that are open when the program exits. This means that this callback "
3813 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3814 "problems in higher-level languages (eg. if your HLL interpreter has already "
3815 "been cleaned up by the time this is called, and if your callback then jumps "
3816 "into some HLL function)."
3820 #: ../src/guestfs.pod:1727
3822 "If no callback is registered: the handle is closed without any callback "
3827 #: ../src/guestfs.pod:1730
3828 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3832 #: ../src/guestfs.pod:1733
3834 "The callback function will be called when the child process quits, either "
3835 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3836 "corresponds to a transition from any state to the CONFIG state)."
3840 #: ../src/guestfs.pod:1737 ../src/guestfs.pod:1746
3841 msgid "If no callback is registered: the event is ignored."
3845 #: ../src/guestfs.pod:1739
3846 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3850 #: ../src/guestfs.pod:1742
3852 "The callback function will be called when the child process becomes ready "
3853 "first time after it has been launched. (This corresponds to a transition "
3854 "from LAUNCHING to the READY state)."
3858 #: ../src/guestfs.pod:1748
3859 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3864 #: ../src/guestfs.pod:1751
3866 "Some long-running operations can generate progress messages. If this "
3867 "callback is registered, then it will be called each time a progress message "
3868 "is generated (usually two seconds after the operation started, and three "
3869 "times per second thereafter until it completes, although the frequency may "
3870 "change in future versions)."
3874 #: ../src/guestfs.pod:1757
3876 "The callback receives in the payload four unsigned 64 bit numbers which are "
3877 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3881 #: ../src/guestfs.pod:1760
3883 "The units of C<total> are not defined, although for some operations C<total> "
3884 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3885 "or megabytes), and C<position> may be the portion which has been transferred."
3890 #: ../src/guestfs.pod:1765
3891 msgid "The only defined and stable parts of the API are:"
3896 #: ../src/guestfs.pod:1771
3898 "The callback can display to the user some type of progress bar or indicator "
3899 "which shows the ratio of C<position>:C<total>."
3904 #: ../src/guestfs.pod:1776
3905 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3909 #: ../src/guestfs.pod:1780
3911 "If any progress notification is sent during a call, then a final progress "
3912 "notification is always sent when C<position> = C<total> (I<unless> the call "
3913 "fails with an error)."
3918 #: ../src/guestfs.pod:1784
3920 "This is to simplify caller code, so callers can easily set the progress "
3921 "indicator to \"100%\" at the end of the operation, without requiring special "
3922 "code to detect this case."
3926 #: ../src/guestfs.pod:1790
3928 "For some calls we are unable to estimate the progress of the call, but we "
3929 "can still generate progress messages to indicate activity. This is known as "
3930 "\"pulse mode\", and is directly supported by certain progress bar "
3931 "implementations (eg. GtkProgressBar)."
3935 #: ../src/guestfs.pod:1795
3937 "For these calls, zero or more progress messages are generated with "
3938 "C<position = 0> and C<total = 1>, followed by a final message with "
3939 "C<position = total = 1>."
3943 #: ../src/guestfs.pod:1799
3945 "As noted above, if the call fails with an error then the final message may "
3950 #: ../src/guestfs.pod:1804
3952 "The callback also receives the procedure number (C<proc_nr>) and serial "
3953 "number (C<serial>) of the call. These are only useful for debugging "
3954 "protocol issues, and the callback can normally ignore them. The callback "
3955 "may want to print these numbers in error messages or debugging messages."
3959 #: ../src/guestfs.pod:1810
3960 msgid "If no callback is registered: progress messages are discarded."
3964 #: ../src/guestfs.pod:1812
3965 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3969 #: ../src/guestfs.pod:1815
3971 "The callback function is called whenever a log message is generated by qemu, "
3972 "the appliance kernel, guestfsd (daemon), or utility programs."
3976 #: ../src/guestfs.pod:1818
3978 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3979 "guestfs_launch>) then additional debug messages are generated."
3983 #: ../src/guestfs.pod:1821 ../src/guestfs.pod:1835
3985 "If no callback is registered: the messages are discarded unless the verbose "
3986 "flag is set in which case they are sent to stderr. You can override the "
3987 "printing of verbose messages to stderr by setting up a callback."
3991 #: ../src/guestfs.pod:1826
3992 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3996 #: ../src/guestfs.pod:1829
3998 "The callback function is called whenever a log message is generated by the "
3999 "library part of libguestfs."
4003 #: ../src/guestfs.pod:1832
4005 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
4006 "messages are generated."
4010 #: ../src/guestfs.pod:1840
4011 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
4015 #: ../src/guestfs.pod:1843
4017 "The callback function is called whenever a trace message is generated. This "
4018 "only applies if the trace flag (L</guestfs_set_trace>) is set."
4022 #: ../src/guestfs.pod:1846
4024 "If no callback is registered: the messages are sent to stderr. You can "
4025 "override the printing of trace messages to stderr by setting up a callback."
4029 #: ../src/guestfs.pod:1852
4030 msgid "guestfs_set_event_callback"
4034 #: ../src/guestfs.pod:1854
4037 " int guestfs_set_event_callback (guestfs_h *g,\n"
4038 " guestfs_event_callback cb,\n"
4039 " uint64_t event_bitmask,\n"
4046 #: ../src/guestfs.pod:1860
4048 "This function registers a callback (C<cb>) for all event classes in the "
4053 #: ../src/guestfs.pod:1863
4055 "For example, to register for all log message events, you could call this "
4056 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4057 "To register a single callback for all possible classes of events, use "
4058 "C<GUESTFS_EVENT_ALL>."
4062 #: ../src/guestfs.pod:1869
4063 msgid "C<flags> should always be passed as 0."
4067 #: ../src/guestfs.pod:1871
4069 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4070 "it for any purpose."
4074 #: ../src/guestfs.pod:1874
4076 "The return value is the event handle (an integer) which you can use to "
4077 "delete the callback (see below)."
4081 #: ../src/guestfs.pod:1877
4083 "If there is an error, this function returns C<-1>, and sets the error in the "
4084 "handle in the usual way (see L</guestfs_last_error> etc.)"
4088 #: ../src/guestfs.pod:1880
4090 "Callbacks remain in effect until they are deleted, or until the handle is "
4095 #: ../src/guestfs.pod:1883
4097 "In the case where multiple callbacks are registered for a particular event "
4098 "class, all of the callbacks are called. The order in which multiple "
4099 "callbacks are called is not defined."
4103 #: ../src/guestfs.pod:1887
4104 msgid "guestfs_delete_event_callback"
4108 #: ../src/guestfs.pod:1889
4111 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4116 #: ../src/guestfs.pod:1891
4118 "Delete a callback that was previously registered. C<event_handle> should be "
4119 "the integer that was returned by a previous call to "
4120 "C<guestfs_set_event_callback> on the same handle."
4124 #: ../src/guestfs.pod:1895
4125 msgid "guestfs_event_callback"
4129 #: ../src/guestfs.pod:1897
4132 " typedef void (*guestfs_event_callback) (\n"
4135 " uint64_t event,\n"
4136 " int event_handle,\n"
4138 " const char *buf, size_t buf_len,\n"
4139 " const uint64_t *array, size_t array_len);\n"
4144 #: ../src/guestfs.pod:1906
4146 "This is the type of the event callback function that you have to provide."
4150 #: ../src/guestfs.pod:1909
4152 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4153 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4154 "handle, and C<flags> which in the current API you should ignore."
4158 #: ../src/guestfs.pod:1913
4160 "The remaining parameters contain the event payload (if any). Each event may "
4161 "contain a payload, which usually relates to the event class, but for future "
4162 "proofing your code should be written to handle any payload for any event "
4167 #: ../src/guestfs.pod:1918
4169 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4170 "there is no message buffer). Note that this message buffer can contain "
4171 "arbitrary 8 bit data, including NUL bytes."
4175 #: ../src/guestfs.pod:1922
4177 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4178 "moment this is only used for progress messages."
4182 #: ../src/guestfs.pod:1925
4183 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4187 #: ../src/guestfs.pod:1927
4189 "One motivation for the generic event API was to allow GUI programs to "
4190 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4191 "unconditionally to C<stderr>."
4195 #: ../src/guestfs.pod:1931
4197 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4198 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4199 "messages are not events; you must capture error messages separately)."
4203 #: ../src/guestfs.pod:1936
4205 "Programs have to set up a callback to capture the classes of events of "
4210 #: ../src/guestfs.pod:1939
4214 " guestfs_set_event_callback\n"
4215 " (g, message_callback,\n"
4216 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4217 " GUESTFS_EVENT_TRACE,\n"
4218 " 0, NULL) == -1)\n"
4219 " if (eh == -1) {\n"
4220 " // handle error in the usual way\n"
4226 #: ../src/guestfs.pod:1949
4228 "The callback can then direct messages to the appropriate place. In this "
4229 "example, messages are directed to syslog:"
4233 #: ../src/guestfs.pod:1952
4237 " message_callback (\n"
4240 " uint64_t event,\n"
4241 " int event_handle,\n"
4243 " const char *buf, size_t buf_len,\n"
4244 " const uint64_t *array, size_t array_len)\n"
4246 " const int priority = LOG_USER|LOG_INFO;\n"
4247 " if (buf_len > 0)\n"
4248 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4255 #: ../src/guestfs.pod:1967
4256 msgid "PRIVATE DATA AREA"
4260 #: ../src/guestfs.pod:1969
4262 "You can attach named pieces of private data to the libguestfs handle, fetch "
4263 "them by name, and walk over them, for the lifetime of the handle. This is "
4264 "called the private data area and is only available from the C API."
4269 #: ../src/guestfs.pod:1974
4270 msgid "To attach a named piece of data, use the following call:"
4275 #: ../src/guestfs.pod:1976
4278 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4284 #: ../src/guestfs.pod:1978
4286 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4287 "pointer (which can be C<NULL>). Any previous item with the same name is "
4293 #: ../src/guestfs.pod:1982
4295 "You can use any C<key> you want, but names beginning with an underscore "
4296 "character are reserved for internal libguestfs purposes (for implementing "
4297 "language bindings). It is recommended to prefix the name with some unique "
4298 "string to avoid collisions with other users."
4303 #: ../src/guestfs.pod:1987
4304 msgid "To retrieve the pointer, use:"
4309 #: ../src/guestfs.pod:1989
4312 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4318 #: ../src/guestfs.pod:1991
4320 "This function returns C<NULL> if either no data is found associated with "
4321 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4326 #: ../src/guestfs.pod:1995
4328 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4329 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4330 "all. In particular, libguestfs does I<not> try to free the data when the "
4331 "handle is closed. If the data must be freed, then the caller must either "
4332 "free it before calling L</guestfs_close> or must set up a close callback to "
4333 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4337 #: ../src/guestfs.pod:2002
4338 msgid "To walk over all entries, use these two functions:"
4342 #: ../src/guestfs.pod:2004
4345 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4350 #: ../src/guestfs.pod:2006
4353 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4358 #: ../src/guestfs.pod:2008
4360 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4361 "not have any particular meaning -- keys are not returned in any defined "
4362 "order). A pointer to the key is returned in C<*key_rtn> and the "
4363 "corresponding data pointer is returned from the function. C<NULL> is "
4364 "returned if there are no keys stored in the handle."
4368 #: ../src/guestfs.pod:2014
4370 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4371 "value of this function is also C<NULL> is there are no further entries to "
4376 #: ../src/guestfs.pod:2018
4377 msgid "Notes about walking over entries:"
4381 #: ../src/guestfs.pod:2024
4383 "You must not call C<guestfs_set_private> while walking over the entries."
4387 #: ../src/guestfs.pod:2029
4389 "The handle maintains an internal iterator which is reset when you call "
4390 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4391 "call C<guestfs_set_private>."
4395 #: ../src/guestfs.pod:2035
4396 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4400 #: ../src/guestfs.pod:2037
4403 " guestfs_set_private (g, key, NULL);\n"
4408 #: ../src/guestfs.pod:2039
4409 msgid "then that C<key> is not returned when walking."
4413 #: ../src/guestfs.pod:2043
4415 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4416 "C<guestfs_next_private> or C<guestfs_set_private>."
4420 #: ../src/guestfs.pod:2049
4422 "The following example code shows how to print all keys and data pointers "
4423 "that are associated with the handle C<g>:"
4427 #: ../src/guestfs.pod:2052
4430 " const char *key;\n"
4431 " void *data = guestfs_first_private (g, &key);\n"
4432 " while (data != NULL)\n"
4434 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4435 " data = guestfs_next_private (g, &key);\n"
4441 #: ../src/guestfs.pod:2060
4443 "More commonly you are only interested in keys that begin with an application-"
4444 "specific prefix C<foo_>. Modify the loop like so:"
4448 #: ../src/guestfs.pod:2063
4451 " const char *key;\n"
4452 " void *data = guestfs_first_private (g, &key);\n"
4453 " while (data != NULL)\n"
4455 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4456 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4457 " data = guestfs_next_private (g, &key);\n"
4463 #: ../src/guestfs.pod:2072
4465 "If you need to modify keys while walking, then you have to jump back to the "
4466 "beginning of the loop. For example, to delete all keys prefixed with "
4471 #: ../src/guestfs.pod:2076
4474 " const char *key;\n"
4477 " data = guestfs_first_private (g, &key);\n"
4478 " while (data != NULL)\n"
4480 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4482 " guestfs_set_private (g, key, NULL);\n"
4483 " /* note that 'key' pointer is now invalid, and so is\n"
4484 " the internal iterator */\n"
4487 " data = guestfs_next_private (g, &key);\n"
4493 #: ../src/guestfs.pod:2092
4495 "Note that the above loop is guaranteed to terminate because the keys are "
4496 "being deleted, but other manipulations of keys within the loop might not "
4497 "terminate unless you also maintain an indication of which keys have been "
4503 #: ../src/guestfs.pod:2097 ../src/guestfs.pod:2102
4509 #: ../src/guestfs.pod:2099
4511 "<!-- old anchor for the next section --> <a name="
4512 "\"state_machine_and_low_level_event_api\"/>"
4517 #: ../src/guestfs.pod:2104
4518 msgid "ARCHITECTURE"
4523 #: ../src/guestfs.pod:2106
4525 "Internally, libguestfs is implemented by running an appliance (a special "
4526 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4527 "process of the main program."
4532 #: ../src/guestfs.pod:2110
4535 " ___________________\n"
4537 " | main program |\n"
4539 " | | child process / appliance\n"
4540 " | | __________________________\n"
4542 " +-------------------+ RPC | +-----------------+ |\n"
4543 " | libguestfs <--------------------> guestfsd | |\n"
4544 " | | | +-----------------+ |\n"
4545 " \\___________________/ | | Linux kernel | |\n"
4546 " | +--^--------------+ |\n"
4547 " \\_________|________________/\n"
4553 " \\______________/\n"
4559 #: ../src/guestfs.pod:2130
4561 "The library, linked to the main program, creates the child process and hence "
4562 "the appliance in the L</guestfs_launch> function."
4567 #: ../src/guestfs.pod:2133
4569 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4570 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4571 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4572 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4573 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4574 "attached to the qemu process which translates device access by the "
4575 "appliance's Linux kernel into accesses to the image."
4580 #: ../src/guestfs.pod:2142
4582 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4583 "Although the disk image you are attached to might also be used by some "
4584 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4585 "care if both libguestfs's qemu process and your virtual machine are trying "
4586 "to update the disk image at the same time, since these usually results in "
4587 "massive disk corruption)."
4592 #: ../src/guestfs.pod:2149
4593 msgid "STATE MACHINE"
4598 #: ../src/guestfs.pod:2151
4599 msgid "libguestfs uses a state machine to model the child process:"
4604 #: ../src/guestfs.pod:2153
4616 " / | \\ \\ guestfs_launch\n"
4617 " / | _\\__V______\n"
4619 " / | | LAUNCHING |\n"
4620 " / | \\___________/\n"
4622 " / | guestfs_launch\n"
4624 " ______ / __|____V\n"
4625 " / \\ ------> / \\\n"
4626 " | BUSY | | READY |\n"
4627 " \\______/ <------ \\________/\n"
4633 #: ../src/guestfs.pod:2175
4635 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4636 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4637 "(3) alternating between READY and BUSY as commands are issued to, and "
4638 "carried out by, the child process."
4643 #: ../src/guestfs.pod:2180
4645 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4646 "asynchronously at any time (eg. due to some internal error), and that causes "
4647 "the state to transition back to CONFIG."
4652 #: ../src/guestfs.pod:2184
4654 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4655 "issued when in the CONFIG state."
4660 #: ../src/guestfs.pod:2187
4662 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4663 "L</guestfs_launch> blocks until the child process is READY to accept "
4664 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4665 "moves the state from CONFIG to LAUNCHING while it is running."
4670 #: ../src/guestfs.pod:2193
4672 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4673 "state. These API calls block waiting for the command to be carried out (ie. "
4674 "the state to transition to BUSY and then back to READY). There are no non-"
4675 "blocking versions, and no way to issue more than one command per handle at "
4681 #: ../src/guestfs.pod:2199
4683 "Finally, the child process sends asynchronous messages back to the main "
4684 "program, such as kernel log messages. You can register a callback to "
4685 "receive these messages."
4690 #: ../src/guestfs.pod:2203
4696 #: ../src/guestfs.pod:2205
4697 msgid "COMMUNICATION PROTOCOL"
4702 #: ../src/guestfs.pod:2207
4704 "Don't rely on using this protocol directly. This section documents how it "
4705 "currently works, but it may change at any time."
4710 #: ../src/guestfs.pod:2210
4712 "The protocol used to talk between the library and the daemon running inside "
4713 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4714 "1014, RFC 1832, RFC 4506)."
4719 #: ../src/guestfs.pod:2214
4721 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4722 "this file is automatically generated)."
4727 #: ../src/guestfs.pod:2217
4729 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4730 "and C<FileOut> parameters, which are handled with very simple request/reply "
4731 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4732 "parameters, which use the same request and reply messages, but they may also "
4733 "be followed by files sent using a chunked encoding."
4738 #: ../src/guestfs.pod:2224
4739 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4744 #: ../src/guestfs.pod:2226
4745 msgid "For ordinary functions, the request message is:"
4750 #: ../src/guestfs.pod:2228
4753 " total length (header + arguments,\n"
4754 " but not including the length word itself)\n"
4755 " struct guestfs_message_header (encoded as XDR)\n"
4756 " struct guestfs_<foo>_args (encoded as XDR)\n"
4762 #: ../src/guestfs.pod:2233
4764 "The total length field allows the daemon to allocate a fixed size buffer "
4765 "into which it slurps the rest of the message. As a result, the total length "
4766 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4767 "effective size of any request is limited to somewhere under this size."
4772 #: ../src/guestfs.pod:2239
4774 "Note also that many functions don't take any arguments, in which case the "
4775 "C<guestfs_I<foo>_args> is completely omitted."
4780 #: ../src/guestfs.pod:2242
4782 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4783 "receiver knows what type of args structure to expect, or none at all."
4788 #: ../src/guestfs.pod:2246
4790 "For functions that take optional arguments, the optional arguments are "
4791 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4792 "arguments. A bitmask in the header indicates which optional arguments are "
4793 "meaningful. The bitmask is also checked to see if it contains bits set "
4794 "which the daemon does not know about (eg. if more optional arguments were "
4795 "added in a later version of the library), and this causes the call to be "
4801 #: ../src/guestfs.pod:2254
4802 msgid "The reply message for ordinary functions is:"
4807 #: ../src/guestfs.pod:2256
4810 " total length (header + ret,\n"
4811 " but not including the length word itself)\n"
4812 " struct guestfs_message_header (encoded as XDR)\n"
4813 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4819 #: ../src/guestfs.pod:2261
4821 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4822 "functions that return no formal return values."
4827 #: ../src/guestfs.pod:2264
4829 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4834 #: ../src/guestfs.pod:2267
4836 "In the case of an error, a flag is set in the header, and the reply message "
4837 "is slightly changed:"
4842 #: ../src/guestfs.pod:2270
4845 " total length (header + error,\n"
4846 " but not including the length word itself)\n"
4847 " struct guestfs_message_header (encoded as XDR)\n"
4848 " struct guestfs_message_error (encoded as XDR)\n"
4854 #: ../src/guestfs.pod:2275
4856 "The C<guestfs_message_error> structure contains the error message as a "
4862 #: ../src/guestfs.pod:2278
4863 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4868 #: ../src/guestfs.pod:2280
4870 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4871 "The normal request message is sent (see above). However this is followed by "
4872 "a sequence of file chunks."
4877 #: ../src/guestfs.pod:2284
4880 " total length (header + arguments,\n"
4881 " but not including the length word itself,\n"
4882 " and not including the chunks)\n"
4883 " struct guestfs_message_header (encoded as XDR)\n"
4884 " struct guestfs_<foo>_args (encoded as XDR)\n"
4885 " sequence of chunks for FileIn param #0\n"
4886 " sequence of chunks for FileIn param #1 etc.\n"
4892 #: ../src/guestfs.pod:2292
4893 msgid "The \"sequence of chunks\" is:"
4898 #: ../src/guestfs.pod:2294
4901 " length of chunk (not including length word itself)\n"
4902 " struct guestfs_chunk (encoded as XDR)\n"
4903 " length of chunk\n"
4904 " struct guestfs_chunk (encoded as XDR)\n"
4906 " length of chunk\n"
4907 " struct guestfs_chunk (with data.data_len == 0)\n"
4913 #: ../src/guestfs.pod:2302
4915 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4916 "is set in the final chunk to indicate either successful completion or early "
4922 #: ../src/guestfs.pod:2306
4924 "At time of writing there are no functions that have more than one FileIn "
4925 "parameter. However this is (theoretically) supported, by sending the "
4926 "sequence of chunks for each FileIn parameter one after another (from left to "
4932 #: ../src/guestfs.pod:2311
4934 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4935 "transfer. The library does this by sending a chunk with a special flag set "
4936 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4937 "RPC, does I<not> send any reply, and goes back to reading the next request."
4942 #: ../src/guestfs.pod:2317
4944 "The daemon may also cancel. It does this by writing a special word "
4945 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4946 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4947 "cancel chunk). The special word is chosen so that even if cancellation "
4948 "happens right at the end of the transfer (after the library has finished "
4949 "writing and has started listening for the reply), the \"spurious\" cancel "
4950 "flag will not be confused with the reply message."
4955 #: ../src/guestfs.pod:2326
4957 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4958 "limit), and also files where the size is not known in advance (eg. from "
4959 "pipes or sockets). However the chunks are rather small "
4960 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4961 "to keep much in memory."
4966 #: ../src/guestfs.pod:2332
4967 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4972 #: ../src/guestfs.pod:2334
4974 "The protocol for FileOut parameters is exactly the same as for FileIn "
4975 "parameters, but with the roles of daemon and library reversed."
4980 #: ../src/guestfs.pod:2337
4983 " total length (header + ret,\n"
4984 " but not including the length word itself,\n"
4985 " and not including the chunks)\n"
4986 " struct guestfs_message_header (encoded as XDR)\n"
4987 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4988 " sequence of chunks for FileOut param #0\n"
4989 " sequence of chunks for FileOut param #1 etc.\n"
4995 #: ../src/guestfs.pod:2345
4996 msgid "INITIAL MESSAGE"
5001 #: ../src/guestfs.pod:2347
5003 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
5004 "which indicates that the guest and daemon is alive. This is what L</"
5005 "guestfs_launch> waits for."
5010 #: ../src/guestfs.pod:2351
5011 msgid "PROGRESS NOTIFICATION MESSAGES"
5016 #: ../src/guestfs.pod:2353
5018 "The daemon may send progress notification messages at any time. These are "
5019 "distinguished by the normal length word being replaced by "
5020 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
5024 #: ../src/guestfs.pod:2357
5026 "The library turns them into progress callbacks (see L</"
5027 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5033 #: ../src/guestfs.pod:2361
5035 "The daemon self-limits the frequency of progress messages it sends (see "
5036 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5042 #: ../src/guestfs.pod:2365
5043 msgid "LIBGUESTFS VERSION NUMBERS"
5048 #: ../src/guestfs.pod:2367
5050 "Since April 2010, libguestfs has started to make separate development and "
5051 "stable releases, along with corresponding branches in our git repository. "
5052 "These separate releases can be identified by version number:"
5057 #: ../src/guestfs.pod:2372
5060 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5061 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5067 " | `-------- sub-version\n"
5069 " `------ always '1' because we don't change the ABI\n"
5075 #: ../src/guestfs.pod:2383
5076 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5081 #: ../src/guestfs.pod:2385
5083 "As time passes we cherry pick fixes from the development branch and backport "
5084 "those into the stable branch, the effect being that the stable branch should "
5085 "get more stable and less buggy over time. So the stable releases are ideal "
5086 "for people who don't need new features but would just like the software to "
5092 #: ../src/guestfs.pod:2391
5093 msgid "Our criteria for backporting changes are:"
5098 #: ../src/guestfs.pod:2397
5100 "Documentation changes which don't affect any code are backported unless the "
5101 "documentation refers to a future feature which is not in stable."
5106 #: ../src/guestfs.pod:2403
5108 "Bug fixes which are not controversial, fix obvious problems, and have been "
5109 "well tested are backported."
5114 #: ../src/guestfs.pod:2408
5116 "Simple rearrangements of code which shouldn't affect how it works get "
5117 "backported. This is so that the code in the two branches doesn't get too "
5118 "far out of step, allowing us to backport future fixes more easily."
5123 #: ../src/guestfs.pod:2414
5125 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5126 "exceptional case: the new feature is required in order to implement an "
5127 "important bug fix."
5132 #: ../src/guestfs.pod:2420
5134 "A new stable branch starts when we think the new features in development are "
5135 "substantial and compelling enough over the current stable branch to warrant "
5136 "it. When that happens we create new stable and development versions 1.N.0 "
5137 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5138 "stable at this point, but by backporting fixes from development, that branch "
5139 "will stabilize over time."
5143 #: ../src/guestfs.pod:2428
5144 msgid "EXTENDING LIBGUESTFS"
5148 #: ../src/guestfs.pod:2430
5149 msgid "ADDING A NEW API ACTION"
5153 #: ../src/guestfs.pod:2432
5155 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5156 "documentation) are generated, and this makes it easy to extend the "
5161 #: ../src/guestfs.pod:2436
5162 msgid "To add a new API action there are two changes:"
5166 #: ../src/guestfs.pod:2442
5168 "You need to add a description of the call (name, parameters, return type, "
5169 "tests, documentation) to C<generator/generator_actions.ml>."
5173 #: ../src/guestfs.pod:2445
5175 "There are two sorts of API action, depending on whether the call goes "
5176 "through to the daemon in the appliance, or is serviced entirely by the "
5177 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5178 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5179 "an example of the latter, since a trace flag is maintained in the handle and "
5180 "all tracing is done on the library side."
5184 #: ../src/guestfs.pod:2453
5186 "Most new actions are of the first type, and get added to the "
5187 "C<daemon_functions> list. Each function has a unique procedure number used "
5188 "in the RPC protocol which is assigned to that action when we publish "
5189 "libguestfs and cannot be reused. Take the latest procedure number and "
5194 #: ../src/guestfs.pod:2459
5196 "For library-only actions of the second type, add to the "
5197 "C<non_daemon_functions> list. Since these functions are serviced by the "
5198 "library and do not travel over the RPC mechanism to the daemon, these "
5199 "functions do not need a procedure number, and so the procedure number is set "
5204 #: ../src/guestfs.pod:2467
5205 msgid "Implement the action (in C):"
5209 #: ../src/guestfs.pod:2469
5211 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5212 "C<daemon/> directory."
5216 #: ../src/guestfs.pod:2472
5218 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5219 "(note: double underscore) in the C<src/> directory."
5223 #: ../src/guestfs.pod:2475
5224 msgid "In either case, use another function as an example of what to do."
5228 #: ../src/guestfs.pod:2479
5229 msgid "After making these changes, use C<make> to compile."
5233 #: ../src/guestfs.pod:2481
5235 "Note that you don't need to implement the RPC, language bindings, manual "
5236 "pages or anything else. It's all automatically generated from the OCaml "
5241 #: ../src/guestfs.pod:2485
5242 msgid "ADDING TESTS FOR AN API ACTION"
5246 #: ../src/guestfs.pod:2487
5248 "You can supply zero or as many tests as you want per API call. The tests "
5249 "can either be added as part of the API description (C<generator/"
5250 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5251 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5252 "slower, so if possible use the first method."
5256 #: ../src/guestfs.pod:2493
5258 "The following describes the test environment used when you add an API test "
5259 "in C<generator_actions.ml>."
5263 #: ../src/guestfs.pod:2496
5264 msgid "The test environment has 4 block devices:"
5268 #: ../src/guestfs.pod:2500
5269 msgid "C</dev/sda> 500MB"
5273 #: ../src/guestfs.pod:2502
5274 msgid "General block device for testing."
5278 #: ../src/guestfs.pod:2504
5279 msgid "C</dev/sdb> 50MB"
5283 #: ../src/guestfs.pod:2506
5285 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5290 #: ../src/guestfs.pod:2509
5291 msgid "C</dev/sdc> 10MB"
5295 #: ../src/guestfs.pod:2511
5296 msgid "Used in a few tests where two block devices are needed."
5300 #: ../src/guestfs.pod:2513
5305 #: ../src/guestfs.pod:2515
5306 msgid "ISO with fixed content (see C<images/test.iso>)."
5310 #: ../src/guestfs.pod:2519
5312 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5313 "appliance and block devices are reused between tests. So don't try testing "
5314 "L</guestfs_kill_subprocess> :-x"
5318 #: ../src/guestfs.pod:2523
5320 "Each test starts with an initial scenario, selected using one of the "
5321 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5322 "initialize the disks mentioned above in a particular way as documented in "
5323 "C<generator_types.ml>. You should not assume anything about the previous "
5324 "contents of other disks that are not initialized."
5328 #: ../src/guestfs.pod:2529
5330 "You can add a prerequisite clause to any individual test. This is a run-"
5331 "time check, which, if it fails, causes the test to be skipped. Useful if "
5332 "testing a command which might not work on all variations of libguestfs "
5333 "builds. A test that has prerequisite of C<Always> means to run "
5338 #: ../src/guestfs.pod:2535
5340 "In addition, packagers can skip individual tests by setting environment "
5341 "variables before running C<make check>."
5345 #: ../src/guestfs.pod:2538
5348 " SKIP_TEST_<CMD>_<NUM>=1\n"
5353 #: ../src/guestfs.pod:2540
5354 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5358 #: ../src/guestfs.pod:2542
5363 #: ../src/guestfs.pod:2544
5366 " SKIP_TEST_<CMD>=1\n"
5371 #: ../src/guestfs.pod:2546
5372 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5376 #: ../src/guestfs.pod:2548
5377 msgid "Packagers can run only certain tests by setting for example:"
5381 #: ../src/guestfs.pod:2550
5384 " TEST_ONLY=\"vfs_type zerofree\"\n"
5389 #: ../src/guestfs.pod:2552
5391 "See C<capitests/tests.c> for more details of how these environment variables "
5396 #: ../src/guestfs.pod:2555
5397 msgid "DEBUGGING NEW API ACTIONS"
5401 #: ../src/guestfs.pod:2557
5402 msgid "Test new actions work before submitting them."
5406 #: ../src/guestfs.pod:2559
5407 msgid "You can use guestfish to try out new commands."
5411 #: ../src/guestfs.pod:2561
5413 "Debugging the daemon is a problem because it runs inside a minimal "
5414 "environment. However you can fprintf messages in the daemon to stderr, and "
5415 "they will show up if you use C<guestfish -v>."
5419 #: ../src/guestfs.pod:2565
5420 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5424 #: ../src/guestfs.pod:2567
5426 "Our C source code generally adheres to some basic code-formatting "
5427 "conventions. The existing code base is not totally consistent on this "
5428 "front, but we do prefer that contributed code be formatted similarly. In "
5429 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5430 "indentation level, and other than that, follow the K&R style."
5434 #: ../src/guestfs.pod:2573
5436 "If you use Emacs, add the following to one of one of your start-up files (e."
5437 "g., ~/.emacs), to help ensure that you get indentation right:"
5441 #: ../src/guestfs.pod:2576
5444 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5445 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5446 " (add-hook 'find-file-hook\n"
5447 " '(lambda () (if (and buffer-file-name\n"
5448 " (string-match \"/libguestfs\\\\>\"\n"
5449 " (buffer-file-name))\n"
5450 " (not (string-equal mode-name \"Change Log\"))\n"
5451 " (not (string-equal mode-name \"Makefile\")))\n"
5452 " (setq indent-tabs-mode nil))))\n"
5457 #: ../src/guestfs.pod:2586
5460 " ;;; When editing C sources in libguestfs, use this style.\n"
5461 " (defun libguestfs-c-mode ()\n"
5462 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5464 " (c-set-style \"K&R\")\n"
5465 " (setq c-indent-level 2)\n"
5466 " (setq c-basic-offset 2))\n"
5467 " (add-hook 'c-mode-hook\n"
5468 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5469 " (buffer-file-name))\n"
5470 " (libguestfs-c-mode))))\n"
5475 #: ../src/guestfs.pod:2598
5476 msgid "Enable warnings when compiling (and fix any problems this finds):"
5480 #: ../src/guestfs.pod:2601
5483 " ./configure --enable-gcc-warnings\n"
5488 #: ../src/guestfs.pod:2603
5489 msgid "Useful targets are:"
5493 #: ../src/guestfs.pod:2605
5496 " make syntax-check # checks the syntax of the C code\n"
5497 " make check # runs the test suite\n"
5502 #: ../src/guestfs.pod:2608
5503 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5507 #: ../src/guestfs.pod:2610
5509 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5510 "which are used to do shell quoting."
5514 #: ../src/guestfs.pod:2615
5519 #: ../src/guestfs.pod:2617
5521 "Simple shell quoted string. Any spaces or other shell characters are "
5526 #: ../src/guestfs.pod:2620
5531 #: ../src/guestfs.pod:2622
5533 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5539 #: ../src/guestfs.pod:2627 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5540 msgid "For example:"
5544 #: ../src/guestfs.pod:2629
5547 " asprintf (&cmd, \"cat %R\", path);\n"
5552 #: ../src/guestfs.pod:2631
5553 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5557 #: ../src/guestfs.pod:2633
5559 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5560 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5561 "they are not passed via the shell (instead, straight to exec). You probably "
5562 "want to use the C<sysroot_path()> function however."
5566 #: ../src/guestfs.pod:2639
5567 msgid "SUBMITTING YOUR NEW API ACTIONS"
5571 #: ../src/guestfs.pod:2641
5573 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5574 "libguestfs> and CC to L<rjones@redhat.com>."
5578 #: ../src/guestfs.pod:2645
5579 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5583 #: ../src/guestfs.pod:2647
5584 msgid "We support i18n (gettext anyhow) in the library."
5588 #: ../src/guestfs.pod:2649
5590 "However many messages come from the daemon, and we don't translate those at "
5591 "the moment. One reason is that the appliance generally has all locale files "
5592 "removed from it, because they take up a lot of space. So we'd have to readd "
5593 "some of those, as well as copying our PO files into the appliance."
5597 #: ../src/guestfs.pod:2655
5599 "Debugging messages are never translated, since they are intended for the "
5604 #: ../src/guestfs.pod:2658
5605 msgid "SOURCE CODE SUBDIRECTORIES"
5609 #: ../src/guestfs.pod:2662 ../src/guestfs-actions.pod:5814
5610 #: ../fish/guestfish-actions.pod:3908
5611 msgid "C<appliance>"
5615 #: ../src/guestfs.pod:2664
5616 msgid "The libguestfs appliance, build scripts and so on."
5620 #: ../src/guestfs.pod:2666
5621 msgid "C<capitests>"
5625 #: ../src/guestfs.pod:2668
5626 msgid "Automated tests of the C API."
5630 #: ../src/guestfs.pod:2670
5635 #: ../src/guestfs.pod:2672
5637 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5642 #: ../src/guestfs.pod:2675
5647 #: ../src/guestfs.pod:2677
5648 msgid "Outside contributions, experimental parts."
5652 #: ../src/guestfs.pod:2679
5657 #: ../src/guestfs.pod:2681
5659 "The daemon that runs inside the libguestfs appliance and carries out actions."
5663 #: ../src/guestfs.pod:2684
5668 #: ../src/guestfs.pod:2686
5669 msgid "L<virt-df(1)> command and documentation."
5673 #: ../src/guestfs.pod:2688
5678 #: ../src/guestfs.pod:2690
5679 msgid "C API example code."
5683 #: ../src/guestfs.pod:2692
5688 #: ../src/guestfs.pod:2694
5690 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5691 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5692 "L<virt-tar-out(1)>."
5696 #: ../src/guestfs.pod:2698
5701 #: ../src/guestfs.pod:2700
5703 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5707 #: ../src/guestfs.pod:2702
5708 msgid "C<generator>"
5712 #: ../src/guestfs.pod:2704
5714 "The crucially important generator, used to automatically generate large "
5715 "amounts of boilerplate C code for things like RPC and bindings."
5719 #: ../src/guestfs.pod:2707
5724 #: ../src/guestfs.pod:2709
5725 msgid "Files used by the test suite."
5729 #: ../src/guestfs.pod:2711
5730 msgid "Some \"phony\" guest images which we test against."
5734 #: ../src/guestfs.pod:2713
5735 msgid "C<inspector>"
5739 #: ../src/guestfs.pod:2715
5740 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5744 #: ../src/guestfs.pod:2717
5749 #: ../src/guestfs.pod:2719
5750 msgid "Logo used on the website. The fish is called Arthur by the way."
5754 #: ../src/guestfs.pod:2721
5759 #: ../src/guestfs.pod:2723
5760 msgid "M4 macros used by autoconf."
5764 #: ../src/guestfs.pod:2725
5769 #: ../src/guestfs.pod:2727
5770 msgid "Translations of simple gettext strings."
5774 #: ../src/guestfs.pod:2729
5779 #: ../src/guestfs.pod:2731
5781 "The build infrastructure and PO files for translations of manpages and POD "
5782 "files. Eventually this will be combined with the C<po> directory, but that "
5783 "is rather complicated."
5787 #: ../src/guestfs.pod:2735
5788 msgid "C<regressions>"
5792 #: ../src/guestfs.pod:2737
5793 msgid "Regression tests."
5797 #: ../src/guestfs.pod:2739
5802 #: ../src/guestfs.pod:2741
5803 msgid "L<virt-rescue(1)> command and documentation."
5807 #: ../src/guestfs.pod:2743
5812 #: ../src/guestfs.pod:2745
5813 msgid "Source code to the C library."
5817 #: ../src/guestfs.pod:2747
5822 #: ../src/guestfs.pod:2749
5823 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5827 #: ../src/guestfs.pod:2751
5828 msgid "C<test-tool>"
5832 #: ../src/guestfs.pod:2753
5834 "Test tool for end users to test if their qemu/kernel combination will work "
5839 #: ../src/guestfs.pod:2756
5844 #: ../src/guestfs.pod:2758
5849 #: ../src/guestfs.pod:2760
5854 #: ../src/guestfs.pod:2762
5859 #: ../src/guestfs.pod:2764
5864 #: ../src/guestfs.pod:2766
5869 #: ../src/guestfs.pod:2768
5874 #: ../src/guestfs.pod:2770
5879 #: ../src/guestfs.pod:2772
5880 msgid "Language bindings."
5885 #: ../src/guestfs.pod:2776 ../fish/guestfish.pod:1015
5886 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5887 msgid "ENVIRONMENT VARIABLES"
5892 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1041
5893 msgid "LIBGUESTFS_APPEND"
5898 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1043
5899 msgid "Pass additional options to the guest kernel."
5904 #: ../src/guestfs.pod:2784 ../fish/guestfish.pod:1045
5905 msgid "LIBGUESTFS_DEBUG"
5910 #: ../src/guestfs.pod:2786
5912 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5913 "effect as calling C<guestfs_set_verbose (g, 1)>."
5918 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1050
5919 msgid "LIBGUESTFS_MEMSIZE"
5924 #: ../src/guestfs.pod:2791 ../fish/guestfish.pod:1052
5926 "Set the memory allocated to the qemu process, in megabytes. For example:"
5931 #: ../src/guestfs.pod:2794 ../fish/guestfish.pod:1055
5934 " LIBGUESTFS_MEMSIZE=700\n"
5940 #: ../src/guestfs.pod:2796 ../fish/guestfish.pod:1057
5941 msgid "LIBGUESTFS_PATH"
5945 #: ../src/guestfs.pod:2798
5947 "Set the path that libguestfs uses to search for a supermin appliance. See "
5948 "the discussion of paths in section L</PATH> above."
5953 #: ../src/guestfs.pod:2801 ../fish/guestfish.pod:1062
5954 msgid "LIBGUESTFS_QEMU"
5959 #: ../src/guestfs.pod:2803 ../fish/guestfish.pod:1064
5961 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5962 "which was found at compile time by the configure script is used."
5967 #: ../src/guestfs.pod:2807
5968 msgid "See also L</QEMU WRAPPERS> above."
5973 #: ../src/guestfs.pod:2809 ../fish/guestfish.pod:1068
5974 msgid "LIBGUESTFS_TRACE"
5979 #: ../src/guestfs.pod:2811
5981 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5982 "effect as calling C<guestfs_set_trace (g, 1)>."
5987 #: ../src/guestfs.pod:2814 ../fish/guestfish.pod:1077
5992 #: ../src/guestfs.pod:2816 ../fish/guestfish.pod:1079
5994 "Location of temporary directory, defaults to C</tmp> except for the cached "
5995 "supermin appliance which defaults to C</var/tmp>."
5999 #: ../src/guestfs.pod:2819 ../fish/guestfish.pod:1082
6001 "If libguestfs was compiled to use the supermin appliance then the real "
6002 "appliance is cached in this directory, shared between all handles belonging "
6003 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6004 "use in case C</var/tmp> is not large enough."
6009 #: ../src/guestfs.pod:2827 ../fish/guestfish.pod:1149
6010 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267
6011 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6012 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
6013 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
6018 #: ../src/guestfs.pod:2829
6020 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6021 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6022 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6023 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6024 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6025 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6026 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6031 #: ../src/guestfs.pod:2856
6033 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6034 "(8)>, L<disktype(1)>."
6039 #: ../src/guestfs.pod:2863 ../tools/virt-win-reg.pl:587
6040 #: ../tools/virt-make-fs.pl:553
6046 #: ../src/guestfs.pod:2865
6047 msgid "To get a list of bugs against libguestfs use this link:"
6052 #: ../src/guestfs.pod:2867
6054 "L<https://bugzilla.redhat.com/buglist.cgi?"
6055 "component=libguestfs&product=Virtualization+Tools>"
6060 #: ../src/guestfs.pod:2869
6061 msgid "To report a new bug against libguestfs use this link:"
6066 #: ../src/guestfs.pod:2871
6068 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6069 "component=libguestfs&product=Virtualization+Tools>"
6074 #: ../src/guestfs.pod:2873
6075 msgid "When reporting a bug, please check:"
6080 #: ../src/guestfs.pod:2879
6081 msgid "That the bug hasn't been reported already."
6086 #: ../src/guestfs.pod:2883
6087 msgid "That you are testing a recent version."
6092 #: ../src/guestfs.pod:2887
6093 msgid "Describe the bug accurately, and give a way to reproduce it."
6098 #: ../src/guestfs.pod:2891
6100 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6106 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1172
6107 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
6113 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1174
6114 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
6115 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6120 #: ../src/guestfs.pod:2900 ../fish/guestfish.pod:1176
6121 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282
6122 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6123 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
6124 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
6129 #: ../src/guestfs.pod:2902 ../fish/guestfish.pod:1178
6130 #: ../test-tool/libguestfs-test-tool.pod:99
6131 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6136 #: ../src/guestfs.pod:2905
6138 "This library is free software; you can redistribute it and/or modify it "
6139 "under the terms of the GNU Lesser General Public License as published by the "
6140 "Free Software Foundation; either version 2 of the License, or (at your "
6141 "option) any later version."
6146 #: ../src/guestfs.pod:2910
6148 "This library is distributed in the hope that it will be useful, but WITHOUT "
6149 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6150 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6156 #: ../src/guestfs.pod:2915
6158 "You should have received a copy of the GNU Lesser General Public License "
6159 "along with this library; if not, write to the Free Software Foundation, "
6160 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6165 #: ../src/guestfs-actions.pod:1
6166 msgid "guestfs_add_cdrom"
6171 #: ../src/guestfs-actions.pod:3
6175 " guestfs_add_cdrom (guestfs_h *g,\n"
6176 " const char *filename);\n"
6182 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6183 msgid "This function adds a virtual CD-ROM disk image to the guest."
6188 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6189 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
6194 #: ../src/guestfs-actions.pod:17
6196 "This call checks for the existence of C<filename>. This stops you from "
6197 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6198 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6204 #: ../src/guestfs-actions.pod:24
6206 "If you just want to add an ISO file (often you use this as an efficient way "
6207 "to transfer large files into the guest), then you should probably use "
6208 "C<guestfs_add_drive_ro> instead."
6213 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6214 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6215 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6216 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6217 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6218 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6219 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6220 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6221 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6222 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6223 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6224 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6225 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6226 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6227 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6228 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6229 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
6230 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
6231 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
6232 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
6233 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
6234 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3459
6235 #: ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3499
6236 #: ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3668
6237 #: ../src/guestfs-actions.pod:3681 ../src/guestfs-actions.pod:3695
6238 #: ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3746
6239 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3838
6240 #: ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3878
6241 #: ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3933
6242 #: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:3971
6243 #: ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4018
6244 #: ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4070
6245 #: ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4098
6246 #: ../src/guestfs-actions.pod:4115 ../src/guestfs-actions.pod:4208
6247 #: ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4241
6248 #: ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4310
6249 #: ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4344
6250 #: ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4372
6251 #: ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4404
6252 #: ../src/guestfs-actions.pod:4424 ../src/guestfs-actions.pod:4482
6253 #: ../src/guestfs-actions.pod:4555 ../src/guestfs-actions.pod:4586
6254 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4624
6255 #: ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4653
6256 #: ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4681
6257 #: ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4731
6258 #: ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4766
6259 #: ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:4797
6260 #: ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883
6261 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4925
6262 #: ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4960
6263 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5151
6264 #: ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:5191
6265 #: ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5289
6266 #: ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5319
6267 #: ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5622
6268 #: ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5660
6269 #: ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5684
6270 #: ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5710
6271 #: ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5740
6272 #: ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:5780
6273 #: ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5829
6274 #: ../src/guestfs-actions.pod:5845 ../src/guestfs-actions.pod:5868
6275 #: ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905
6276 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5945
6277 #: ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5990
6278 #: ../src/guestfs-actions.pod:6014 ../src/guestfs-actions.pod:6033
6279 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6076
6280 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6110
6281 #: ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6170
6282 #: ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6304
6283 #: ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6437
6284 #: ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6463
6285 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6498
6286 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6524
6287 #: ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6598
6288 #: ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6631
6289 #: ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6664
6290 #: ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6697
6291 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6747
6292 #: ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6801
6293 #: ../src/guestfs-actions.pod:6819 ../src/guestfs-actions.pod:6853
6294 #: ../src/guestfs-actions.pod:6889 ../src/guestfs-actions.pod:7008
6295 #: ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7040
6296 #: ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7108
6297 #: ../src/guestfs-actions.pod:7153 ../src/guestfs-actions.pod:7186
6298 #: ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7266
6299 #: ../src/guestfs-actions.pod:7332 ../src/guestfs-actions.pod:7351
6300 #: ../src/guestfs-actions.pod:7380
6301 msgid "This function returns 0 on success or -1 on error."
6306 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6307 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6308 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6310 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6316 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6317 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6318 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
6319 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:7274
6320 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:31
6321 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6322 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6323 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3008
6324 #: ../fish/guestfish-actions.pod:4866 ../fish/guestfish-actions.pod:4963
6326 "Deprecated functions will not be removed from the API, but the fact that "
6327 "they are deprecated indicates that there are problems with correct use of "
6333 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6334 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
6335 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
6336 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3481
6337 #: ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:5847
6338 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6078
6339 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6666
6340 #: ../src/guestfs-actions.pod:7188
6341 msgid "(Added in 0.3)"
6346 #: ../src/guestfs-actions.pod:41
6347 msgid "guestfs_add_domain"
6352 #: ../src/guestfs-actions.pod:43
6356 " guestfs_add_domain (guestfs_h *g,\n"
6357 " const char *dom,\n"
6364 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6365 #: ../src/guestfs-actions.pod:4443
6367 "You may supply a list of optional arguments to this call. Use zero or more "
6368 "of the following pairs of parameters, and terminate the list with C<-1> on "
6369 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6373 #: ../src/guestfs-actions.pod:53
6376 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6377 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6378 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6379 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6385 #: ../src/guestfs-actions.pod:58
6387 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6388 "It works by connecting to libvirt, requesting the domain and domain XML from "
6389 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6395 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6397 "The number of disks added is returned. This operation is atomic: if an "
6398 "error is returned, then no disks are added."
6403 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6405 "This function does some minimal checks to make sure the libvirt domain is "
6406 "not running (unless C<readonly> is true). In a future version we will try "
6407 "to acquire the libvirt lock on each disk."
6412 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6414 "Disks must be accessible locally. This often means that adding disks from a "
6415 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6416 "unless those disks are accessible via the same device path locally too."
6420 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6422 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6423 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6424 "libvirt URI (or one set through an environment variable, see the libvirt "
6425 "documentation for full details)."
6429 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6431 "The optional C<live> flag controls whether this call will try to connect to "
6432 "a running virtual machine C<guestfsd> process if it sees a suitable "
6433 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6434 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6435 "DAEMONS> for more information."
6440 #: ../src/guestfs-actions.pod:88
6442 "The other optional parameters are passed directly through to "
6443 "C<guestfs_add_drive_opts>."
6448 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6449 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6450 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6451 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6452 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
6453 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
6454 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
6455 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2780
6456 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:4869
6457 #: ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5403
6458 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:6774
6459 #: ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7212
6460 #: ../src/guestfs-actions.pod:7225
6461 msgid "On error this function returns -1."
6466 #: ../src/guestfs-actions.pod:93
6467 msgid "(Added in 1.7.4)"
6472 #: ../src/guestfs-actions.pod:95
6473 msgid "guestfs_add_domain_va"
6478 #: ../src/guestfs-actions.pod:97
6482 " guestfs_add_domain_va (guestfs_h *g,\n"
6483 " const char *dom,\n"
6490 #: ../src/guestfs-actions.pod:102
6491 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6496 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6497 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6498 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4508
6499 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6504 #: ../src/guestfs-actions.pod:106
6505 msgid "guestfs_add_domain_argv"
6510 #: ../src/guestfs-actions.pod:108
6514 " guestfs_add_domain_argv (guestfs_h *g,\n"
6515 " const char *dom,\n"
6516 " const struct guestfs_add_domain_argv *optargs);\n"
6522 #: ../src/guestfs-actions.pod:113
6523 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6528 #: ../src/guestfs-actions.pod:117
6529 msgid "guestfs_add_drive"
6534 #: ../src/guestfs-actions.pod:119
6538 " guestfs_add_drive (guestfs_h *g,\n"
6539 " const char *filename);\n"
6545 #: ../src/guestfs-actions.pod:123
6547 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6548 "optional parameters, so the disk is added writable, with the format being "
6549 "detected automatically."
6554 #: ../src/guestfs-actions.pod:127
6556 "Automatic detection of the format opens you up to a potential security hole "
6557 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6558 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6559 "you should think about replacing calls to this function with calls to "
6560 "C<guestfs_add_drive_opts>, and specifying the format."
6565 #: ../src/guestfs-actions.pod:138
6566 msgid "guestfs_add_drive_opts"
6571 #: ../src/guestfs-actions.pod:140
6575 " guestfs_add_drive_opts (guestfs_h *g,\n"
6576 " const char *filename,\n"
6583 #: ../src/guestfs-actions.pod:150
6586 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6587 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6588 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6594 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6596 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6597 "The first time you call this function, the disk appears as C</dev/sda>, the "
6598 "second time as C</dev/sdb>, and so on."
6603 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6605 "You don't necessarily need to be root when using libguestfs. However you "
6606 "obviously do need sufficient permissions to access the filename for whatever "
6607 "operations you want to perform (ie. read access if you just want to read the "
6608 "image or write access if you want to modify the image)."
6613 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6614 msgid "This call checks that C<filename> exists."
6619 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4454
6620 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3019
6621 msgid "The optional arguments are:"
6626 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6632 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6634 "If true then the image is treated as read-only. Writes are still allowed, "
6635 "but they are stored in a temporary snapshot overlay which is discarded at "
6636 "the end. The disk that you add is not modified."
6641 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6647 #: ../src/guestfs-actions.pod:179
6649 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6650 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6651 "Possible formats include C<raw> and C<qcow2>."
6656 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6658 "Automatic detection of the format opens you up to a potential security hole "
6659 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6660 "RHBZ#642934. Specifying the format closes this security hole."
6665 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6671 #: ../src/guestfs-actions.pod:190
6673 "This rarely-used option lets you emulate the behaviour of the deprecated "
6674 "C<guestfs_add_drive_with_if> call (q.v.)"
6679 #: ../src/guestfs-actions.pod:197
6680 msgid "(Added in 1.5.23)"
6685 #: ../src/guestfs-actions.pod:199
6686 msgid "guestfs_add_drive_opts_va"
6691 #: ../src/guestfs-actions.pod:201
6695 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6696 " const char *filename,\n"
6703 #: ../src/guestfs-actions.pod:206
6704 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6709 #: ../src/guestfs-actions.pod:210
6710 msgid "guestfs_add_drive_opts_argv"
6715 #: ../src/guestfs-actions.pod:212
6719 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6720 " const char *filename,\n"
6721 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6727 #: ../src/guestfs-actions.pod:217
6728 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6733 #: ../src/guestfs-actions.pod:221
6734 msgid "guestfs_add_drive_ro"
6739 #: ../src/guestfs-actions.pod:223
6743 " guestfs_add_drive_ro (guestfs_h *g,\n"
6744 " const char *filename);\n"
6750 #: ../src/guestfs-actions.pod:227
6752 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6753 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6754 "disk is added read-only, with the format being detected automatically."
6759 #: ../src/guestfs-actions.pod:234
6760 msgid "(Added in 1.0.38)"
6765 #: ../src/guestfs-actions.pod:236
6766 msgid "guestfs_add_drive_ro_with_if"
6771 #: ../src/guestfs-actions.pod:238
6775 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6776 " const char *filename,\n"
6777 " const char *iface);\n"
6783 #: ../src/guestfs-actions.pod:243
6785 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6786 "QEMU interface emulation to use at run time."
6791 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6792 #: ../src/guestfs-actions.pod:2356
6793 msgid "(Added in 1.0.84)"
6798 #: ../src/guestfs-actions.pod:257
6799 msgid "guestfs_add_drive_with_if"
6804 #: ../src/guestfs-actions.pod:259
6808 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6809 " const char *filename,\n"
6810 " const char *iface);\n"
6816 #: ../src/guestfs-actions.pod:264
6818 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6819 "QEMU interface emulation to use at run time."
6824 #: ../src/guestfs-actions.pod:278
6825 msgid "guestfs_aug_clear"
6830 #: ../src/guestfs-actions.pod:280
6834 " guestfs_aug_clear (guestfs_h *g,\n"
6835 " const char *augpath);\n"
6841 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6843 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6844 "L<augtool(1)> C<clear> command."
6849 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6850 msgid "(Added in 1.3.4)"
6855 #: ../src/guestfs-actions.pod:291
6856 msgid "guestfs_aug_close"
6861 #: ../src/guestfs-actions.pod:293
6865 " guestfs_aug_close (guestfs_h *g);\n"
6871 #: ../src/guestfs-actions.pod:296
6873 "Close the current Augeas handle and free up any resources used by it. After "
6874 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6875 "any other Augeas functions."
6880 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6881 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6882 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6883 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6884 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6885 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6886 #: ../src/guestfs-actions.pod:5480
6887 msgid "(Added in 0.7)"
6892 #: ../src/guestfs-actions.pod:305
6893 msgid "guestfs_aug_defnode"
6898 #: ../src/guestfs-actions.pod:307
6901 " struct guestfs_int_bool *\n"
6902 " guestfs_aug_defnode (guestfs_h *g,\n"
6903 " const char *name,\n"
6904 " const char *expr,\n"
6905 " const char *val);\n"
6911 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6913 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6918 #: ../src/guestfs-actions.pod:316
6920 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6921 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6922 "containing that single node."
6927 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6929 "On success this returns a pair containing the number of nodes in the "
6930 "nodeset, and a boolean flag if a node was created."
6935 #: ../src/guestfs-actions.pod:324
6937 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6938 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6943 #: ../src/guestfs-actions.pod:330
6944 msgid "guestfs_aug_defvar"
6949 #: ../src/guestfs-actions.pod:332
6953 " guestfs_aug_defvar (guestfs_h *g,\n"
6954 " const char *name,\n"
6955 " const char *expr);\n"
6961 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6963 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6964 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6969 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6971 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6972 "evaluates to something which is not a nodeset."
6977 #: ../src/guestfs-actions.pod:348
6978 msgid "guestfs_aug_get"
6983 #: ../src/guestfs-actions.pod:350
6987 " guestfs_aug_get (guestfs_h *g,\n"
6988 " const char *augpath);\n"
6994 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6996 "Look up the value associated with C<path>. If C<path> matches exactly one "
6997 "node, the C<value> is returned."
7002 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
7003 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
7004 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
7005 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
7006 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
7007 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
7008 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
7009 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
7010 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
7011 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
7012 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2732
7013 #: ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2872
7014 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927
7015 #: ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3024
7016 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068
7017 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3990
7018 #: ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4270
7019 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5208
7020 #: ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5556
7021 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:6217
7022 #: ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6250
7023 #: ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6948
7024 #: ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6985
7025 #: ../src/guestfs-actions.pod:7165 ../src/guestfs-actions.pod:7437
7027 "This function returns a string, or NULL on error. I<The caller must free "
7028 "the returned string after use>."
7033 #: ../src/guestfs-actions.pod:362
7034 msgid "guestfs_aug_init"
7039 #: ../src/guestfs-actions.pod:364
7043 " guestfs_aug_init (guestfs_h *g,\n"
7044 " const char *root,\n"
7051 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7053 "Create a new Augeas handle for editing configuration files. If there was "
7054 "any previous Augeas handle associated with this guestfs session, then it is "
7060 #: ../src/guestfs-actions.pod:373
7061 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7066 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7068 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7073 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7075 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7076 "logical I<or> of the following integers:"
7081 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7082 msgid "C<AUG_SAVE_BACKUP> = 1"
7087 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7088 msgid "Keep the original file with a C<.augsave> extension."
7093 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7094 msgid "C<AUG_SAVE_NEWFILE> = 2"
7099 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7101 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7102 "original. Overrides C<AUG_SAVE_BACKUP>."
7107 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7108 msgid "C<AUG_TYPE_CHECK> = 4"
7113 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7114 msgid "Typecheck lenses (can be expensive)."
7119 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7120 msgid "C<AUG_NO_STDINC> = 8"
7125 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7126 msgid "Do not use standard load path for modules."
7131 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7132 msgid "C<AUG_SAVE_NOOP> = 16"
7137 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7138 msgid "Make save a no-op, just record what would have been changed."
7143 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7144 msgid "C<AUG_NO_LOAD> = 32"
7149 #: ../src/guestfs-actions.pod:408
7150 msgid "Do not load the tree in C<guestfs_aug_init>."
7155 #: ../src/guestfs-actions.pod:412
7156 msgid "To close the handle, you can call C<guestfs_aug_close>."
7161 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7162 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7167 #: ../src/guestfs-actions.pod:420
7168 msgid "guestfs_aug_insert"
7173 #: ../src/guestfs-actions.pod:422
7177 " guestfs_aug_insert (guestfs_h *g,\n"
7178 " const char *augpath,\n"
7179 " const char *label,\n"
7186 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7188 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7189 "or after C<path> (depending on the boolean flag C<before>)."
7194 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7196 "C<path> must match exactly one existing node in the tree, and C<label> must "
7197 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7202 #: ../src/guestfs-actions.pod:440
7203 msgid "guestfs_aug_load"
7208 #: ../src/guestfs-actions.pod:442
7212 " guestfs_aug_load (guestfs_h *g);\n"
7218 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7219 msgid "Load files into the tree."
7224 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7225 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7230 #: ../src/guestfs-actions.pod:454
7231 msgid "guestfs_aug_ls"
7236 #: ../src/guestfs-actions.pod:456
7240 " guestfs_aug_ls (guestfs_h *g,\n"
7241 " const char *augpath);\n"
7247 #: ../src/guestfs-actions.pod:460
7249 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7250 "sorting the resulting nodes into alphabetical order."
7255 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7256 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7257 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
7258 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
7259 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
7260 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
7261 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
7262 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
7263 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2981
7264 #: ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560
7265 #: ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3727
7266 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4830
7267 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5476
7268 #: ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:6290
7269 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6406
7270 #: ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6576
7271 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078
7272 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7290
7273 #: ../src/guestfs-actions.pod:7309 ../src/guestfs-actions.pod:7394
7274 #: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7459
7275 #: ../src/guestfs-actions.pod:7478
7277 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7278 ">), or NULL if there was an error. I<The caller must free the strings and "
7279 "the array after use>."
7284 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7285 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
7286 #: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3379
7287 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4023
7288 #: ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4243
7289 #: ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4834
7290 #: ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5686
7291 #: ../src/guestfs-actions.pod:5700 ../src/guestfs-actions.pod:5712
7292 #: ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6790
7293 #: ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:7042
7294 #: ../src/guestfs-actions.pod:7278
7295 msgid "(Added in 0.8)"
7300 #: ../src/guestfs-actions.pod:469
7301 msgid "guestfs_aug_match"
7306 #: ../src/guestfs-actions.pod:471
7310 " guestfs_aug_match (guestfs_h *g,\n"
7311 " const char *augpath);\n"
7317 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7319 "Returns a list of paths which match the path expression C<path>. The "
7320 "returned paths are sufficiently qualified so that they match exactly one "
7321 "node in the current tree."
7326 #: ../src/guestfs-actions.pod:485
7327 msgid "guestfs_aug_mv"
7332 #: ../src/guestfs-actions.pod:487
7336 " guestfs_aug_mv (guestfs_h *g,\n"
7337 " const char *src,\n"
7338 " const char *dest);\n"
7344 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7346 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7347 "C<dest> is overwritten if it exists."
7352 #: ../src/guestfs-actions.pod:499
7353 msgid "guestfs_aug_rm"
7358 #: ../src/guestfs-actions.pod:501
7362 " guestfs_aug_rm (guestfs_h *g,\n"
7363 " const char *augpath);\n"
7369 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7370 msgid "Remove C<path> and all of its children."
7375 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7376 msgid "On success this returns the number of entries which were removed."
7381 #: ../src/guestfs-actions.pod:513
7382 msgid "guestfs_aug_save"
7387 #: ../src/guestfs-actions.pod:515
7391 " guestfs_aug_save (guestfs_h *g);\n"
7397 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7398 msgid "This writes all pending changes to disk."
7403 #: ../src/guestfs-actions.pod:520
7405 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7411 #: ../src/guestfs-actions.pod:527
7412 msgid "guestfs_aug_set"
7417 #: ../src/guestfs-actions.pod:529
7421 " guestfs_aug_set (guestfs_h *g,\n"
7422 " const char *augpath,\n"
7423 " const char *val);\n"
7429 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7430 msgid "Set the value associated with C<path> to C<val>."
7435 #: ../src/guestfs-actions.pod:536
7437 "In the Augeas API, it is possible to clear a node by setting the value to "
7438 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7439 "this call. Instead you must use the C<guestfs_aug_clear> call."
7444 #: ../src/guestfs-actions.pod:545
7445 msgid "guestfs_available"
7450 #: ../src/guestfs-actions.pod:547
7454 " guestfs_available (guestfs_h *g,\n"
7455 " char *const *groups);\n"
7461 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7463 "This command is used to check the availability of some groups of "
7464 "functionality in the appliance, which not all builds of the libguestfs "
7465 "appliance will be able to provide."
7470 #: ../src/guestfs-actions.pod:555
7472 "The libguestfs groups, and the functions that those groups correspond to, "
7473 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7474 "runtime by calling C<guestfs_available_all_groups>."
7479 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7481 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7482 "\"]> would check for the availability of the Linux inotify functions and "
7483 "Augeas (configuration file editing) functions."
7488 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7489 msgid "The command returns no error if I<all> requested groups are available."
7494 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7496 "It fails with an error if one or more of the requested groups is unavailable "
7502 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7504 "If an unknown group name is included in the list of groups then an error is "
7510 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7516 #: ../src/guestfs-actions.pod:579
7517 msgid "You must call C<guestfs_launch> before calling this function."
7522 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7524 "The reason is because we don't know what groups are supported by the "
7525 "appliance/daemon until it is running and can be queried."
7530 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7532 "If a group of functions is available, this does not necessarily mean that "
7533 "they will work. You still have to check for errors when calling individual "
7534 "API functions even if they are available."
7539 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7541 "It is usually the job of distro packagers to build complete functionality "
7542 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7543 "with all requirements satisfied, will support everything."
7548 #: ../src/guestfs-actions.pod:601
7550 "This call was added in version C<1.0.80>. In previous versions of "
7551 "libguestfs all you could do would be to speculatively execute a command to "
7552 "find out if the daemon implemented it. See also C<guestfs_version>."
7557 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7558 msgid "(Added in 1.0.80)"
7563 #: ../src/guestfs-actions.pod:612
7564 msgid "guestfs_available_all_groups"
7569 #: ../src/guestfs-actions.pod:614
7573 " guestfs_available_all_groups (guestfs_h *g);\n"
7579 #: ../src/guestfs-actions.pod:617
7581 "This command returns a list of all optional groups that this daemon knows "
7582 "about. Note this returns both supported and unsupported groups. To find "
7583 "out which ones the daemon can actually support you have to call "
7584 "C<guestfs_available> on each member of the returned list."
7589 #: ../src/guestfs-actions.pod:623
7590 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7595 #: ../src/guestfs-actions.pod:629
7596 msgid "(Added in 1.3.15)"
7601 #: ../src/guestfs-actions.pod:631
7602 msgid "guestfs_base64_in"
7607 #: ../src/guestfs-actions.pod:633
7611 " guestfs_base64_in (guestfs_h *g,\n"
7612 " const char *base64file,\n"
7613 " const char *filename);\n"
7619 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7621 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7626 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7627 msgid "(Added in 1.3.5)"
7632 #: ../src/guestfs-actions.pod:645
7633 msgid "guestfs_base64_out"
7638 #: ../src/guestfs-actions.pod:647
7642 " guestfs_base64_out (guestfs_h *g,\n"
7643 " const char *filename,\n"
7644 " const char *base64file);\n"
7650 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7652 "This command downloads the contents of C<filename>, writing it out to local "
7653 "file C<base64file> encoded as base64."
7658 #: ../src/guestfs-actions.pod:659
7659 msgid "guestfs_blockdev_flushbufs"
7664 #: ../src/guestfs-actions.pod:661
7668 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7669 " const char *device);\n"
7675 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7677 "This tells the kernel to flush internal buffers associated with C<device>."
7682 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7683 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7684 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7685 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7686 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7687 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7688 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7689 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7690 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7691 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7692 msgid "This uses the L<blockdev(8)> command."
7697 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7698 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7699 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7700 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7701 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7702 msgid "(Added in 0.9.3)"
7707 #: ../src/guestfs-actions.pod:674
7708 msgid "guestfs_blockdev_getbsz"
7713 #: ../src/guestfs-actions.pod:676
7717 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7718 " const char *device);\n"
7724 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7725 msgid "This returns the block size of a device."
7730 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7731 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7733 "(Note this is different from both I<size in blocks> and I<filesystem block "
7739 #: ../src/guestfs-actions.pod:691
7740 msgid "guestfs_blockdev_getro"
7745 #: ../src/guestfs-actions.pod:693
7749 " guestfs_blockdev_getro (guestfs_h *g,\n"
7750 " const char *device);\n"
7756 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7758 "Returns a boolean indicating if the block device is read-only (true if read-"
7759 "only, false if not)."
7764 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7765 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7766 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7767 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7768 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7769 #: ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105
7770 #: ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3287
7771 #: ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3316
7772 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3346
7773 #: ../src/guestfs-actions.pod:3361 ../src/guestfs-actions.pod:3377
7774 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3404
7775 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3433
7776 #: ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:4979
7777 msgid "This function returns a C truth value on success or -1 on error."
7782 #: ../src/guestfs-actions.pod:706
7783 msgid "guestfs_blockdev_getsize64"
7788 #: ../src/guestfs-actions.pod:708
7792 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7793 " const char *device);\n"
7799 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7800 msgid "This returns the size of the device in bytes."
7805 #: ../src/guestfs-actions.pod:714
7806 msgid "See also C<guestfs_blockdev_getsz>."
7811 #: ../src/guestfs-actions.pod:722
7812 msgid "guestfs_blockdev_getss"
7817 #: ../src/guestfs-actions.pod:724
7821 " guestfs_blockdev_getss (guestfs_h *g,\n"
7822 " const char *device);\n"
7828 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7830 "This returns the size of sectors on a block device. Usually 512, but can be "
7831 "larger for modern devices."
7836 #: ../src/guestfs-actions.pod:731
7838 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7844 #: ../src/guestfs-actions.pod:740
7845 msgid "guestfs_blockdev_getsz"
7850 #: ../src/guestfs-actions.pod:742
7854 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7855 " const char *device);\n"
7861 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7863 "This returns the size of the device in units of 512-byte sectors (even if "
7864 "the sectorsize isn't 512 bytes ... weird)."
7869 #: ../src/guestfs-actions.pod:749
7871 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7872 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7877 #: ../src/guestfs-actions.pod:759
7878 msgid "guestfs_blockdev_rereadpt"
7883 #: ../src/guestfs-actions.pod:761
7887 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7888 " const char *device);\n"
7894 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7895 msgid "Reread the partition table on C<device>."
7900 #: ../src/guestfs-actions.pod:773
7901 msgid "guestfs_blockdev_setbsz"
7906 #: ../src/guestfs-actions.pod:775
7910 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7911 " const char *device,\n"
7912 " int blocksize);\n"
7918 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7919 msgid "This sets the block size of a device."
7924 #: ../src/guestfs-actions.pod:791
7925 msgid "guestfs_blockdev_setro"
7930 #: ../src/guestfs-actions.pod:793
7934 " guestfs_blockdev_setro (guestfs_h *g,\n"
7935 " const char *device);\n"
7941 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7942 msgid "Sets the block device named C<device> to read-only."
7947 #: ../src/guestfs-actions.pod:805
7948 msgid "guestfs_blockdev_setrw"
7953 #: ../src/guestfs-actions.pod:807
7957 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7958 " const char *device);\n"
7964 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7965 msgid "Sets the block device named C<device> to read-write."
7970 #: ../src/guestfs-actions.pod:819
7971 msgid "guestfs_case_sensitive_path"
7976 #: ../src/guestfs-actions.pod:821
7980 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7981 " const char *path);\n"
7987 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7989 "This can be used to resolve case insensitive paths on a filesystem which is "
7990 "case sensitive. The use case is to resolve paths which you have read from "
7991 "Windows configuration files or the Windows Registry, to the true path."
7996 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7998 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7999 "(and probably others), which is that although the underlying filesystem is "
8000 "case-insensitive, the driver exports the filesystem to Linux as case-"
8006 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8008 "One consequence of this is that special directories such as C<c:\\windows> "
8009 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8010 "precise details of how they were created. In Windows itself this would not "
8016 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8018 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8024 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8026 "This function resolves the true case of each element in the path and returns "
8027 "the case-sensitive path."
8032 #: ../src/guestfs-actions.pod:847
8034 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8035 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8036 "how the directories were originally created under Windows)."
8041 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8042 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8047 #: ../src/guestfs-actions.pod:855
8048 msgid "See also C<guestfs_realpath>."
8053 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6970
8054 msgid "(Added in 1.0.75)"
8059 #: ../src/guestfs-actions.pod:862
8065 #: ../src/guestfs-actions.pod:864
8069 " guestfs_cat (guestfs_h *g,\n"
8070 " const char *path);\n"
8076 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5466
8077 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3667
8078 msgid "Return the contents of the file named C<path>."
8083 #: ../src/guestfs-actions.pod:870
8085 "Note that this function cannot correctly handle binary files (specifically, "
8086 "files containing C<\\0> character which is treated as end of string). For "
8087 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8088 "functions which have a more complex interface."
8093 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8094 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
8095 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
8096 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
8097 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
8098 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
8099 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
8100 #: ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5274
8101 #: ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5431
8102 #: ../src/guestfs-actions.pod:5455 ../src/guestfs-actions.pod:6355
8103 #: ../src/guestfs-actions.pod:6410 ../src/guestfs-actions.pod:6556
8104 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:7242
8105 #: ../src/guestfs-actions.pod:7268 ../src/guestfs-actions.pod:7294
8106 #: ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7398
8107 #: ../src/guestfs-actions.pod:7417 ../src/guestfs-actions.pod:7463
8108 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:587
8109 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8110 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8111 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8112 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8113 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8114 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8115 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3537
8116 #: ../fish/guestfish-actions.pod:3552 ../fish/guestfish-actions.pod:3628
8117 #: ../fish/guestfish-actions.pod:3645 ../fish/guestfish-actions.pod:3660
8118 #: ../fish/guestfish-actions.pod:4286 ../fish/guestfish-actions.pod:4332
8119 #: ../fish/guestfish-actions.pod:4417 ../fish/guestfish-actions.pod:4432
8120 #: ../fish/guestfish-actions.pod:4842 ../fish/guestfish-actions.pod:4860
8121 #: ../fish/guestfish-actions.pod:4877 ../fish/guestfish-actions.pod:4887
8122 #: ../fish/guestfish-actions.pod:4935 ../fish/guestfish-actions.pod:4945
8123 #: ../fish/guestfish-actions.pod:4974 ../fish/guestfish-actions.pod:4984
8125 "Because of the message protocol, there is a transfer limit of somewhere "
8126 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8131 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3564
8132 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3643
8133 #: ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:4136
8134 #: ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:5354
8135 #: ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:7129
8136 #: ../src/guestfs-actions.pod:7143
8137 msgid "(Added in 0.4)"
8142 #: ../src/guestfs-actions.pod:883
8143 msgid "guestfs_checksum"
8148 #: ../src/guestfs-actions.pod:885
8152 " guestfs_checksum (guestfs_h *g,\n"
8153 " const char *csumtype,\n"
8154 " const char *path);\n"
8160 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8162 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8167 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8169 "The type of checksum to compute is given by the C<csumtype> parameter which "
8170 "must have one of the following values:"
8175 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8181 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8183 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8189 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8195 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8196 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8201 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8207 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8208 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8213 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8219 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8220 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8225 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8231 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8232 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8237 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8243 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8244 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8249 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8255 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8256 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8261 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8262 msgid "The checksum is returned as a printable string."
8267 #: ../src/guestfs-actions.pod:931
8268 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8273 #: ../src/guestfs-actions.pod:933
8274 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8279 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8280 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3303
8281 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3393
8282 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:6826
8283 msgid "(Added in 1.0.2)"
8288 #: ../src/guestfs-actions.pod:940
8289 msgid "guestfs_checksum_device"
8294 #: ../src/guestfs-actions.pod:942
8298 " guestfs_checksum_device (guestfs_h *g,\n"
8299 " const char *csumtype,\n"
8300 " const char *device);\n"
8306 #: ../src/guestfs-actions.pod:947
8308 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8309 "device named C<device>. For the types of checksums supported see the "
8310 "C<guestfs_checksum> command."
8315 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4885
8316 #: ../src/guestfs-actions.pod:4944 ../src/guestfs-actions.pod:4981
8317 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175
8318 #: ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:6749
8319 #: ../src/guestfs-actions.pod:7155
8320 msgid "(Added in 1.3.2)"
8325 #: ../src/guestfs-actions.pod:956
8326 msgid "guestfs_checksums_out"
8331 #: ../src/guestfs-actions.pod:958
8335 " guestfs_checksums_out (guestfs_h *g,\n"
8336 " const char *csumtype,\n"
8337 " const char *directory,\n"
8338 " const char *sumsfile);\n"
8344 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8346 "This command computes the checksums of all regular files in C<directory> and "
8347 "then emits a list of those checksums to the local output file C<sumsfile>."
8352 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8354 "This can be used for verifying the integrity of a virtual machine. However "
8355 "to be properly secure you should pay attention to the output of the checksum "
8356 "command (it uses the ones from GNU coreutils). In particular when the "
8357 "filename is not printable, coreutils uses a special backslash syntax. For "
8358 "more information, see the GNU coreutils info file."
8363 #: ../src/guestfs-actions.pod:978
8364 msgid "(Added in 1.3.7)"
8369 #: ../src/guestfs-actions.pod:980
8370 msgid "guestfs_chmod"
8375 #: ../src/guestfs-actions.pod:982
8379 " guestfs_chmod (guestfs_h *g,\n"
8381 " const char *path);\n"
8387 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8389 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8395 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8397 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8398 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8404 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4387
8405 #: ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4603
8406 #: ../src/guestfs-actions.pod:4622 ../fish/guestfish-actions.pod:676
8407 #: ../fish/guestfish-actions.pod:2983 ../fish/guestfish-actions.pod:3112
8408 #: ../fish/guestfish-actions.pod:3122 ../fish/guestfish-actions.pod:3132
8409 msgid "The mode actually set is affected by the umask."
8414 #: ../src/guestfs-actions.pod:1000
8415 msgid "guestfs_chown"
8420 #: ../src/guestfs-actions.pod:1002
8424 " guestfs_chown (guestfs_h *g,\n"
8427 " const char *path);\n"
8433 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8434 msgid "Change the file owner to C<owner> and group to C<group>."
8439 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3495
8440 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2441
8442 "Only numeric uid and gid are supported. If you want to use names, you will "
8443 "need to locate and parse the password file yourself (Augeas support makes "
8444 "this relatively easy)."
8449 #: ../src/guestfs-actions.pod:1018
8450 msgid "guestfs_command"
8455 #: ../src/guestfs-actions.pod:1020
8459 " guestfs_command (guestfs_h *g,\n"
8460 " char *const *arguments);\n"
8466 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8468 "This call runs a command from the guest filesystem. The filesystem must be "
8469 "mounted, and must contain a compatible operating system (ie. something "
8470 "Linux, with the same or compatible processor architecture)."
8475 #: ../src/guestfs-actions.pod:1029
8477 "The single parameter is an argv-style list of arguments. The first element "
8478 "is the name of the program to run. Subsequent elements are parameters. The "
8479 "list must be non-empty (ie. must contain a program name). Note that the "
8480 "command runs directly, and is I<not> invoked via the shell (see "
8486 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8487 msgid "The return value is anything printed to I<stdout> by the command."
8492 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8494 "If the command returns a non-zero exit status, then this function returns an "
8495 "error message. The error message string is the content of I<stderr> from "
8501 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8503 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8504 "bin>. If you require a program from another location, you should provide "
8505 "the full path in the first parameter."
8510 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8512 "Shared libraries and data files required by the program must be available on "
8513 "filesystems which are mounted in the correct places. It is the caller's "
8514 "responsibility to ensure all filesystems that are needed are mounted at the "
8520 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8521 #: ../src/guestfs-actions.pod:1548
8522 msgid "(Added in 0.9.1)"
8527 #: ../src/guestfs-actions.pod:1062
8528 msgid "guestfs_command_lines"
8533 #: ../src/guestfs-actions.pod:1064
8537 " guestfs_command_lines (guestfs_h *g,\n"
8538 " char *const *arguments);\n"
8544 #: ../src/guestfs-actions.pod:1068
8546 "This is the same as C<guestfs_command>, but splits the result into a list of "
8552 #: ../src/guestfs-actions.pod:1071
8553 msgid "See also: C<guestfs_sh_lines>"
8558 #: ../src/guestfs-actions.pod:1082
8559 msgid "guestfs_config"
8564 #: ../src/guestfs-actions.pod:1084
8568 " guestfs_config (guestfs_h *g,\n"
8569 " const char *qemuparam,\n"
8570 " const char *qemuvalue);\n"
8576 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8578 "This can be used to add arbitrary qemu command line parameters of the form "
8579 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8580 "setting some parameters which would interfere with parameters that we use."
8585 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8586 msgid "The first character of C<param> string must be a C<-> (dash)."
8591 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8592 msgid "C<value> can be NULL."
8597 #: ../src/guestfs-actions.pod:1102
8598 msgid "guestfs_copy_size"
8603 #: ../src/guestfs-actions.pod:1104
8607 " guestfs_copy_size (guestfs_h *g,\n"
8608 " const char *src,\n"
8609 " const char *dest,\n"
8616 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8618 "This command copies exactly C<size> bytes from one source device or file "
8619 "C<src> to another destination device or file C<dest>."
8624 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8626 "Note this will fail if the source is too short or if the destination is not "
8631 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8632 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8633 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
8634 #: ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:6821
8635 #: ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:7334
8636 #: ../src/guestfs-actions.pod:7353
8638 "This long-running command can generate progress notification messages so "
8639 "that the caller can display a progress bar or indicator. To receive these "
8640 "messages, the caller must register a progress event callback. See L<guestfs"
8641 "(3)/GUESTFS_EVENT_PROGRESS>."
8646 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4163
8647 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7062
8648 #: ../src/guestfs-actions.pod:7082 ../src/guestfs-actions.pod:7168
8649 msgid "(Added in 1.0.87)"
8654 #: ../src/guestfs-actions.pod:1125
8660 #: ../src/guestfs-actions.pod:1127
8664 " guestfs_cp (guestfs_h *g,\n"
8665 " const char *src,\n"
8666 " const char *dest);\n"
8672 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8674 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8675 "destination filename or destination directory."
8680 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8681 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8682 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4848
8683 #: ../src/guestfs-actions.pod:5225
8684 msgid "(Added in 1.0.18)"
8689 #: ../src/guestfs-actions.pod:1139
8690 msgid "guestfs_cp_a"
8695 #: ../src/guestfs-actions.pod:1141
8699 " guestfs_cp_a (guestfs_h *g,\n"
8700 " const char *src,\n"
8701 " const char *dest);\n"
8707 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8709 "This copies a file or directory from C<src> to C<dest> recursively using the "
8715 #: ../src/guestfs-actions.pod:1153
8721 #: ../src/guestfs-actions.pod:1155
8725 " guestfs_dd (guestfs_h *g,\n"
8726 " const char *src,\n"
8727 " const char *dest);\n"
8733 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8735 "This command copies from one source device or file C<src> to another "
8736 "destination device or file C<dest>. Normally you would use this to copy to "
8737 "or from a device or partition, for example to duplicate a filesystem."
8742 #: ../src/guestfs-actions.pod:1165
8744 "If the destination is a device, it must be as large or larger than the "
8745 "source file or device, otherwise the copy will fail. This command cannot do "
8746 "partial copies (see C<guestfs_copy_size>)."
8751 #: ../src/guestfs-actions.pod:1173
8757 #: ../src/guestfs-actions.pod:1175
8761 " guestfs_df (guestfs_h *g);\n"
8767 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8768 msgid "This command runs the C<df> command to report disk space used."
8773 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8775 "This command is mostly useful for interactive sessions. It is I<not> "
8776 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8782 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8783 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8784 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8785 #: ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4748
8786 #: ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6583
8787 #: ../src/guestfs-actions.pod:7201 ../src/guestfs-actions.pod:7214
8788 #: ../src/guestfs-actions.pod:7227
8789 msgid "(Added in 1.0.54)"
8794 #: ../src/guestfs-actions.pod:1189
8795 msgid "guestfs_df_h"
8800 #: ../src/guestfs-actions.pod:1191
8804 " guestfs_df_h (guestfs_h *g);\n"
8810 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8812 "This command runs the C<df -h> command to report disk space used in human-"
8818 #: ../src/guestfs-actions.pod:1206
8819 msgid "guestfs_dmesg"
8824 #: ../src/guestfs-actions.pod:1208
8828 " guestfs_dmesg (guestfs_h *g);\n"
8834 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8836 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8837 "This is sometimes useful for extended debugging of problems."
8842 #: ../src/guestfs-actions.pod:1215
8844 "Another way to get the same information is to enable verbose messages with "
8845 "C<guestfs_set_verbose> or by setting the environment variable "
8846 "C<LIBGUESTFS_DEBUG=1> before running the program."
8851 #: ../src/guestfs-actions.pod:1225
8852 msgid "guestfs_download"
8857 #: ../src/guestfs-actions.pod:1227
8861 " guestfs_download (guestfs_h *g,\n"
8862 " const char *remotefilename,\n"
8863 " const char *filename);\n"
8869 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8870 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8872 "Download file C<remotefilename> and save it as C<filename> on the local "
8878 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6815
8879 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4590
8880 msgid "C<filename> can also be a named pipe."
8885 #: ../src/guestfs-actions.pod:1237
8886 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8891 #: ../src/guestfs-actions.pod:1248
8892 msgid "guestfs_download_offset"
8897 #: ../src/guestfs-actions.pod:1250
8901 " guestfs_download_offset (guestfs_h *g,\n"
8902 " const char *remotefilename,\n"
8903 " const char *filename,\n"
8904 " int64_t offset,\n"
8911 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8913 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8914 "region must be within the file or device)."
8919 #: ../src/guestfs-actions.pod:1263
8921 "Note that there is no limit on the amount of data that can be downloaded "
8922 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8923 "full amount unless an error occurs."
8928 #: ../src/guestfs-actions.pod:1268
8929 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8934 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6860
8935 msgid "(Added in 1.5.17)"
8940 #: ../src/guestfs-actions.pod:1279
8941 msgid "guestfs_drop_caches"
8946 #: ../src/guestfs-actions.pod:1281
8950 " guestfs_drop_caches (guestfs_h *g,\n"
8951 " int whattodrop);\n"
8957 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8959 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8960 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8961 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8966 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8967 msgid "Setting C<whattodrop> to 3 should drop everything."
8972 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8974 "This automatically calls L<sync(2)> before the operation, so that the "
8975 "maximum guest memory is freed."
8980 #: ../src/guestfs-actions.pod:1299
8986 #: ../src/guestfs-actions.pod:1301
8990 " guestfs_du (guestfs_h *g,\n"
8991 " const char *path);\n"
8997 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8999 "This command runs the C<du -s> command to estimate file space usage for "
9005 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
9007 "C<path> can be a file or a directory. If C<path> is a directory then the "
9008 "estimate includes the contents of the directory and all subdirectories "
9014 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9016 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9021 #: ../src/guestfs-actions.pod:1324
9022 msgid "guestfs_e2fsck_f"
9027 #: ../src/guestfs-actions.pod:1326
9031 " guestfs_e2fsck_f (guestfs_h *g,\n"
9032 " const char *device);\n"
9038 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
9040 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9041 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
9047 #: ../src/guestfs-actions.pod:1334
9049 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9050 "Normally you should use C<guestfs_fsck>."
9055 #: ../src/guestfs-actions.pod:1339
9056 msgid "(Added in 1.0.29)"
9061 #: ../src/guestfs-actions.pod:1341
9062 msgid "guestfs_echo_daemon"
9067 #: ../src/guestfs-actions.pod:1343
9071 " guestfs_echo_daemon (guestfs_h *g,\n"
9072 " char *const *words);\n"
9078 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
9080 "This command concatenates the list of C<words> passed with single spaces "
9081 "between them and returns the resulting string."
9086 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
9087 msgid "You can use this command to test the connection through to the daemon."
9092 #: ../src/guestfs-actions.pod:1352
9093 msgid "See also C<guestfs_ping_daemon>."
9098 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
9099 #: ../src/guestfs-actions.pod:6059
9100 msgid "(Added in 1.0.69)"
9105 #: ../src/guestfs-actions.pod:1359
9106 msgid "guestfs_egrep"
9111 #: ../src/guestfs-actions.pod:1361
9115 " guestfs_egrep (guestfs_h *g,\n"
9116 " const char *regex,\n"
9117 " const char *path);\n"
9123 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
9125 "This calls the external C<egrep> program and returns the matching lines."
9130 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
9131 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
9132 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
9133 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
9134 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
9135 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
9136 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3656
9137 #: ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3683
9138 #: ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:4683
9139 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5608
9140 #: ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6439
9141 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6465
9142 #: ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6500
9143 #: ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6526
9144 #: ../src/guestfs-actions.pod:7297 ../src/guestfs-actions.pod:7316
9145 #: ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7420
9146 #: ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7485
9147 msgid "(Added in 1.0.66)"
9152 #: ../src/guestfs-actions.pod:1378
9153 msgid "guestfs_egrepi"
9158 #: ../src/guestfs-actions.pod:1380
9162 " guestfs_egrepi (guestfs_h *g,\n"
9163 " const char *regex,\n"
9164 " const char *path);\n"
9170 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
9172 "This calls the external C<egrep -i> program and returns the matching lines."
9177 #: ../src/guestfs-actions.pod:1397
9178 msgid "guestfs_equal"
9183 #: ../src/guestfs-actions.pod:1399
9187 " guestfs_equal (guestfs_h *g,\n"
9188 " const char *file1,\n"
9189 " const char *file2);\n"
9195 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
9197 "This compares the two files C<file1> and C<file2> and returns true if their "
9198 "content is exactly equal, or false otherwise."
9203 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
9204 msgid "The external L<cmp(1)> program is used for the comparison."
9209 #: ../src/guestfs-actions.pod:1413
9210 msgid "guestfs_exists"
9215 #: ../src/guestfs-actions.pod:1415
9219 " guestfs_exists (guestfs_h *g,\n"
9220 " const char *path);\n"
9226 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
9228 "This returns C<true> if and only if there is a file, directory (or anything) "
9229 "with the given C<path> name."
9234 #: ../src/guestfs-actions.pod:1422
9235 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9240 #: ../src/guestfs-actions.pod:1428
9241 msgid "guestfs_fallocate"
9246 #: ../src/guestfs-actions.pod:1430
9250 " guestfs_fallocate (guestfs_h *g,\n"
9251 " const char *path,\n"
9258 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
9259 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9261 "This command preallocates a file (containing zero bytes) named C<path> of "
9262 "size C<len> bytes. If the file exists already, it is overwritten."
9267 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
9269 "Do not confuse this with the guestfish-specific C<alloc> command which "
9270 "allocates a file in the host and attaches it as a device."
9275 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
9277 "This function is deprecated. In new code, use the C<fallocate64> call "
9283 #: ../src/guestfs-actions.pod:1454
9284 msgid "guestfs_fallocate64"
9289 #: ../src/guestfs-actions.pod:1456
9293 " guestfs_fallocate64 (guestfs_h *g,\n"
9294 " const char *path,\n"
9301 #: ../src/guestfs-actions.pod:1465
9303 "Note that this call allocates disk blocks for the file. To create a sparse "
9304 "file use C<guestfs_truncate_size> instead."
9309 #: ../src/guestfs-actions.pod:1468
9311 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9312 "oversight it only allowed 30 bit lengths to be specified, effectively "
9313 "limiting the maximum size of files created through that call to 1GB."
9318 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
9320 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9321 "commands which create a file in the host and attach it as a device."
9326 #: ../src/guestfs-actions.pod:1479
9327 msgid "(Added in 1.3.17)"
9332 #: ../src/guestfs-actions.pod:1481
9333 msgid "guestfs_fgrep"
9338 #: ../src/guestfs-actions.pod:1483
9342 " guestfs_fgrep (guestfs_h *g,\n"
9343 " const char *pattern,\n"
9344 " const char *path);\n"
9350 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
9352 "This calls the external C<fgrep> program and returns the matching lines."
9357 #: ../src/guestfs-actions.pod:1500
9358 msgid "guestfs_fgrepi"
9363 #: ../src/guestfs-actions.pod:1502
9367 " guestfs_fgrepi (guestfs_h *g,\n"
9368 " const char *pattern,\n"
9369 " const char *path);\n"
9375 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
9377 "This calls the external C<fgrep -i> program and returns the matching lines."
9382 #: ../src/guestfs-actions.pod:1519
9383 msgid "guestfs_file"
9388 #: ../src/guestfs-actions.pod:1521
9392 " guestfs_file (guestfs_h *g,\n"
9393 " const char *path);\n"
9399 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
9401 "This call uses the standard L<file(1)> command to determine the type or "
9402 "contents of the file."
9407 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
9409 "This call will also transparently look inside various types of compressed "
9415 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
9417 "The exact command which runs is C<file -zb path>. Note in particular that "
9418 "the filename is not prepended to the output (the C<-b> option)."
9423 #: ../src/guestfs-actions.pod:1535
9425 "This command can also be used on C</dev/> devices (and partitions, LV "
9426 "names). You can for example use this to determine if a device contains a "
9427 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9432 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
9434 "If the C<path> does not begin with C</dev/> then this command only works for "
9435 "the content of regular files. For other file types (directory, symbolic "
9436 "link etc) it will just return the string C<directory> etc."
9441 #: ../src/guestfs-actions.pod:1550
9442 msgid "guestfs_file_architecture"
9447 #: ../src/guestfs-actions.pod:1552
9451 " guestfs_file_architecture (guestfs_h *g,\n"
9452 " const char *filename);\n"
9458 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
9460 "This detects the architecture of the binary C<filename>, and returns it if "
9466 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
9467 msgid "Currently defined architectures are:"
9472 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
9478 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9480 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9481 "irrespective of the precise processor requirements of the binary."
9486 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
9492 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
9493 msgid "64 bit x86-64."
9498 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
9504 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
9505 msgid "32 bit SPARC."
9510 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
9516 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
9517 msgid "64 bit SPARC V9 and above."
9522 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
9528 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
9529 msgid "Intel Itanium."
9534 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
9540 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
9541 msgid "32 bit Power PC."
9546 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
9552 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
9553 msgid "64 bit Power PC."
9558 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
9559 msgid "Libguestfs may return other architecture strings in future."
9564 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
9565 msgid "The function works on at least the following types of files:"
9570 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
9571 msgid "many types of Un*x and Linux binary"
9576 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
9577 msgid "many types of Un*x and Linux shared library"
9582 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
9583 msgid "Windows Win32 and Win64 binaries"
9588 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
9589 msgid "Windows Win32 and Win64 DLLs"
9594 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
9595 msgid "Win32 binaries and DLLs return C<i386>."
9600 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
9601 msgid "Win64 binaries and DLLs return C<x86_64>."
9606 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
9607 msgid "Linux kernel modules"
9612 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
9613 msgid "Linux new-style initrd images"
9618 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
9619 msgid "some non-x86 Linux vmlinuz kernels"
9624 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
9625 msgid "What it can't do currently:"
9630 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
9631 msgid "static libraries (libfoo.a)"
9636 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
9637 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9642 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
9643 msgid "x86 Linux vmlinuz kernels"
9648 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
9650 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9651 "compressed code, and are horribly hard to unpack. If you want to find the "
9652 "architecture of a kernel, use the architecture of the associated initrd or "
9653 "kernel module(s) instead."
9658 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
9659 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
9660 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2694
9661 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803
9662 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2930
9663 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3274
9664 #: ../src/guestfs-actions.pod:3406
9665 msgid "(Added in 1.5.3)"
9670 #: ../src/guestfs-actions.pod:1662
9671 msgid "guestfs_filesize"
9676 #: ../src/guestfs-actions.pod:1664
9680 " guestfs_filesize (guestfs_h *g,\n"
9681 " const char *file);\n"
9687 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
9688 msgid "This command returns the size of C<file> in bytes."
9693 #: ../src/guestfs-actions.pod:1670
9695 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9696 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9697 "devices, use C<guestfs_blockdev_getsize64>."
9702 #: ../src/guestfs-actions.pod:1676
9703 msgid "(Added in 1.0.82)"
9708 #: ../src/guestfs-actions.pod:1678
9709 msgid "guestfs_fill"
9714 #: ../src/guestfs-actions.pod:1680
9718 " guestfs_fill (guestfs_h *g,\n"
9721 " const char *path);\n"
9727 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
9729 "This command creates a new file called C<path>. The initial content of the "
9730 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9736 #: ../src/guestfs-actions.pod:1690
9738 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9739 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9740 "bytes use C<guestfs_fill_pattern>."
9745 #: ../src/guestfs-actions.pod:1702
9746 msgid "(Added in 1.0.79)"
9751 #: ../src/guestfs-actions.pod:1704
9752 msgid "guestfs_fill_pattern"
9757 #: ../src/guestfs-actions.pod:1706
9761 " guestfs_fill_pattern (guestfs_h *g,\n"
9762 " const char *pattern,\n"
9764 " const char *path);\n"
9770 #: ../src/guestfs-actions.pod:1712
9772 "This function is like C<guestfs_fill> except that it creates a new file of "
9773 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9774 "pattern is truncated if necessary to ensure the length of the file is "
9775 "exactly C<len> bytes."
9780 #: ../src/guestfs-actions.pod:1724
9781 msgid "(Added in 1.3.12)"
9786 #: ../src/guestfs-actions.pod:1726
9787 msgid "guestfs_find"
9792 #: ../src/guestfs-actions.pod:1728
9796 " guestfs_find (guestfs_h *g,\n"
9797 " const char *directory);\n"
9803 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
9805 "This command lists out all files and directories, recursively, starting at "
9806 "C<directory>. It is essentially equivalent to running the shell command "
9807 "C<find directory -print> but some post-processing happens on the output, "
9813 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9815 "This returns a list of strings I<without any prefix>. Thus if the directory "
9821 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
9832 #: ../src/guestfs-actions.pod:1744
9834 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9839 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
9851 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
9852 msgid "If C<directory> is not a directory, then this command returns an error."
9857 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
9858 msgid "The returned list is sorted."
9863 #: ../src/guestfs-actions.pod:1757
9864 msgid "See also C<guestfs_find0>."
9869 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4100
9870 #: ../src/guestfs-actions.pod:5643
9871 msgid "(Added in 1.0.27)"
9876 #: ../src/guestfs-actions.pod:1768
9877 msgid "guestfs_find0"
9882 #: ../src/guestfs-actions.pod:1770
9886 " guestfs_find0 (guestfs_h *g,\n"
9887 " const char *directory,\n"
9888 " const char *files);\n"
9894 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
9896 "This command lists out all files and directories, recursively, starting at "
9897 "C<directory>, placing the resulting list in the external file called "
9903 #: ../src/guestfs-actions.pod:1779
9905 "This command works the same way as C<guestfs_find> with the following "
9911 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
9912 msgid "The resulting list is written to an external file."
9917 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9919 "Items (filenames) in the result are separated by C<\\0> characters. See "
9920 "L<find(1)> option I<-print0>."
9925 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9926 msgid "This command is not limited in the number of names that it can return."
9931 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9932 msgid "The result list is not sorted."
9937 #: ../src/guestfs-actions.pod:1806
9938 msgid "(Added in 1.0.74)"
9943 #: ../src/guestfs-actions.pod:1808
9944 msgid "guestfs_findfs_label"
9949 #: ../src/guestfs-actions.pod:1810
9953 " guestfs_findfs_label (guestfs_h *g,\n"
9954 " const char *label);\n"
9960 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9962 "This command searches the filesystems and returns the one which has the "
9963 "given label. An error is returned if no such filesystem can be found."
9968 #: ../src/guestfs-actions.pod:1818
9969 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9974 #: ../src/guestfs-actions.pod:1825
9975 msgid "guestfs_findfs_uuid"
9980 #: ../src/guestfs-actions.pod:1827
9984 " guestfs_findfs_uuid (guestfs_h *g,\n"
9985 " const char *uuid);\n"
9991 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9993 "This command searches the filesystems and returns the one which has the "
9994 "given UUID. An error is returned if no such filesystem can be found."
9999 #: ../src/guestfs-actions.pod:1835
10000 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10005 #: ../src/guestfs-actions.pod:1842
10006 msgid "guestfs_fsck"
10011 #: ../src/guestfs-actions.pod:1844
10015 " guestfs_fsck (guestfs_h *g,\n"
10016 " const char *fstype,\n"
10017 " const char *device);\n"
10023 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
10025 "This runs the filesystem checker (fsck) on C<device> which should have "
10026 "filesystem type C<fstype>."
10031 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
10033 "The returned integer is the status. See L<fsck(8)> for the list of status "
10034 "codes from C<fsck>."
10039 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
10040 msgid "Multiple status codes can be summed together."
10045 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
10047 "A non-zero return code can mean \"success\", for example if errors have been "
10048 "corrected on the filesystem."
10053 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
10054 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10059 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
10061 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10066 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7339
10067 msgid "(Added in 1.0.16)"
10072 #: ../src/guestfs-actions.pod:1881
10073 msgid "guestfs_get_append"
10078 #: ../src/guestfs-actions.pod:1883
10082 " guestfs_get_append (guestfs_h *g);\n"
10088 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
10090 "Return the additional kernel options which are added to the guest kernel "
10096 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
10097 msgid "If C<NULL> then no options are added."
10102 #: ../src/guestfs-actions.pod:1891
10104 "This function returns a string which may be NULL. There is no way to return "
10105 "an error from this function. The string is owned by the guest handle and "
10106 "must I<not> be freed."
10111 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5321
10112 #: ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:6201
10113 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236
10114 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:7010
10115 #: ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7382
10116 msgid "(Added in 1.0.26)"
10120 #: ../src/guestfs-actions.pod:1897
10121 msgid "guestfs_get_attach_method"
10125 #: ../src/guestfs-actions.pod:1899
10129 " guestfs_get_attach_method (guestfs_h *g);\n"
10134 #: ../src/guestfs-actions.pod:1902
10135 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10140 #: ../src/guestfs-actions.pod:1907
10141 msgid "guestfs_get_autosync"
10146 #: ../src/guestfs-actions.pod:1909
10150 " guestfs_get_autosync (guestfs_h *g);\n"
10156 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
10157 msgid "Get the autosync flag."
10162 #: ../src/guestfs-actions.pod:1918
10163 msgid "guestfs_get_direct"
10168 #: ../src/guestfs-actions.pod:1920
10172 " guestfs_get_direct (guestfs_h *g);\n"
10178 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
10179 msgid "Return the direct appliance mode flag."
10184 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5870
10185 msgid "(Added in 1.0.72)"
10190 #: ../src/guestfs-actions.pod:1929
10191 msgid "guestfs_get_e2label"
10196 #: ../src/guestfs-actions.pod:1931
10200 " guestfs_get_e2label (guestfs_h *g,\n"
10201 " const char *device);\n"
10207 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
10209 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10214 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
10216 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10221 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
10222 #: ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:5907
10223 msgid "(Added in 1.0.15)"
10228 #: ../src/guestfs-actions.pod:1950
10229 msgid "guestfs_get_e2uuid"
10234 #: ../src/guestfs-actions.pod:1952
10238 " guestfs_get_e2uuid (guestfs_h *g,\n"
10239 " const char *device);\n"
10245 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
10247 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10252 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
10254 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10259 #: ../src/guestfs-actions.pod:1971
10260 msgid "guestfs_get_memsize"
10265 #: ../src/guestfs-actions.pod:1973
10269 " guestfs_get_memsize (guestfs_h *g);\n"
10275 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
10277 "This gets the memory size in megabytes allocated to the qemu subprocess."
10282 #: ../src/guestfs-actions.pod:1979
10284 "If C<guestfs_set_memsize> was not called on this handle, and if "
10285 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10286 "value for memsize."
10291 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
10292 #: ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:6030
10293 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10294 #: ../fish/guestfish-actions.pod:3993 ../fish/guestfish-actions.pod:4080
10296 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10301 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4391
10302 #: ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4607
10303 #: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4638
10304 #: ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:4668
10305 #: ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5928
10306 #: ../src/guestfs-actions.pod:6175 ../src/guestfs-actions.pod:6776
10307 msgid "(Added in 1.0.55)"
10312 #: ../src/guestfs-actions.pod:1990
10313 msgid "guestfs_get_network"
10318 #: ../src/guestfs-actions.pod:1992
10322 " guestfs_get_network (guestfs_h *g);\n"
10328 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
10329 msgid "This returns the enable network flag."
10334 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5947
10335 msgid "(Added in 1.5.4)"
10340 #: ../src/guestfs-actions.pod:2001
10341 msgid "guestfs_get_path"
10346 #: ../src/guestfs-actions.pod:2003
10350 " guestfs_get_path (guestfs_h *g);\n"
10356 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
10357 msgid "Return the current search path."
10362 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
10364 "This is always non-NULL. If it wasn't set already, then this will return "
10365 "the default path."
10370 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
10372 "This function returns a string, or NULL on error. The string is owned by "
10373 "the guest handle and must I<not> be freed."
10378 #: ../src/guestfs-actions.pod:2016
10379 msgid "guestfs_get_pid"
10384 #: ../src/guestfs-actions.pod:2018
10388 " guestfs_get_pid (guestfs_h *g);\n"
10394 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
10396 "Return the process ID of the qemu subprocess. If there is no qemu "
10397 "subprocess, then this will return an error."
10402 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
10403 msgid "This is an internal call used for debugging and testing."
10408 #: ../src/guestfs-actions.pod:2028
10409 msgid "(Added in 1.0.56)"
10414 #: ../src/guestfs-actions.pod:2030
10415 msgid "guestfs_get_qemu"
10420 #: ../src/guestfs-actions.pod:2032
10424 " guestfs_get_qemu (guestfs_h *g);\n"
10430 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
10431 msgid "Return the current qemu binary."
10436 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
10438 "This is always non-NULL. If it wasn't set already, then this will return "
10439 "the default qemu binary name."
10444 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5992
10445 msgid "(Added in 1.0.6)"
10450 #: ../src/guestfs-actions.pod:2045
10451 msgid "guestfs_get_recovery_proc"
10456 #: ../src/guestfs-actions.pod:2047
10460 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10466 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
10467 msgid "Return the recovery process enabled flag."
10472 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3501
10473 #: ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:4198
10474 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:5251
10475 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:6016
10476 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6699
10477 #: ../src/guestfs-actions.pod:6891
10478 msgid "(Added in 1.0.77)"
10483 #: ../src/guestfs-actions.pod:2056
10484 msgid "guestfs_get_selinux"
10489 #: ../src/guestfs-actions.pod:2058
10493 " guestfs_get_selinux (guestfs_h *g);\n"
10499 #: ../src/guestfs-actions.pod:2061
10501 "This returns the current setting of the selinux flag which is passed to the "
10502 "appliance at boot time. See C<guestfs_set_selinux>."
10507 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
10508 #: ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6093
10509 msgid "(Added in 1.0.67)"
10514 #: ../src/guestfs-actions.pod:2071
10515 msgid "guestfs_get_state"
10520 #: ../src/guestfs-actions.pod:2073
10524 " guestfs_get_state (guestfs_h *g);\n"
10530 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
10532 "This returns the current state as an opaque integer. This is only useful "
10533 "for printing debug and internal error messages."
10538 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3299
10539 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3389
10540 #: ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:1409
10541 #: ../fish/guestfish-actions.pod:2323 ../fish/guestfish-actions.pod:2341
10542 #: ../fish/guestfish-actions.pod:2379 ../fish/guestfish-actions.pod:2395
10543 msgid "For more information on states, see L<guestfs(3)>."
10548 #: ../src/guestfs-actions.pod:2085
10549 msgid "guestfs_get_trace"
10554 #: ../src/guestfs-actions.pod:2087
10558 " guestfs_get_trace (guestfs_h *g);\n"
10564 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
10565 msgid "Return the command trace flag."
10570 #: ../src/guestfs-actions.pod:2096
10571 msgid "guestfs_get_umask"
10576 #: ../src/guestfs-actions.pod:2098
10580 " guestfs_get_umask (guestfs_h *g);\n"
10586 #: ../src/guestfs-actions.pod:2101
10588 "Return the current umask. By default the umask is C<022> unless it has been "
10589 "set by calling C<guestfs_umask>."
10594 #: ../src/guestfs-actions.pod:2108
10595 msgid "guestfs_get_verbose"
10600 #: ../src/guestfs-actions.pod:2110
10604 " guestfs_get_verbose (guestfs_h *g);\n"
10610 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
10611 msgid "This returns the verbose messages flag."
10616 #: ../src/guestfs-actions.pod:2119
10617 msgid "guestfs_getcon"
10622 #: ../src/guestfs-actions.pod:2121
10626 " guestfs_getcon (guestfs_h *g);\n"
10632 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
10633 msgid "This gets the SELinux security context of the daemon."
10638 #: ../src/guestfs-actions.pod:2126
10640 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10645 #: ../src/guestfs-actions.pod:2134
10646 msgid "guestfs_getxattr"
10651 #: ../src/guestfs-actions.pod:2136
10655 " guestfs_getxattr (guestfs_h *g,\n"
10656 " const char *path,\n"
10657 " const char *name,\n"
10658 " size_t *size_r);\n"
10664 #: ../src/guestfs-actions.pod:2142
10666 "Get a single extended attribute from file C<path> named C<name>. This call "
10667 "follows symlinks. If you want to lookup an extended attribute for the "
10668 "symlink itself, use C<guestfs_lgetxattr>."
10673 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3515
10675 "Normally it is better to get all extended attributes from a file in one go "
10676 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10677 "implementations are buggy and do not provide a way to list out attributes. "
10678 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10679 "extended attributes you want in advance and call this function."
10684 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3522
10685 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2460
10687 "Extended attribute values are blobs of binary data. If there is no extended "
10688 "attribute named C<name>, this returns an error."
10693 #: ../src/guestfs-actions.pod:2156
10694 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10699 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
10700 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:5244
10701 #: ../src/guestfs-actions.pod:5270 ../src/guestfs-actions.pod:5451
10703 "This function returns a buffer, or NULL on error. The size of the returned "
10704 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10709 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3531
10710 msgid "(Added in 1.7.24)"
10715 #: ../src/guestfs-actions.pod:2164
10716 msgid "guestfs_getxattrs"
10721 #: ../src/guestfs-actions.pod:2166
10724 " struct guestfs_xattr_list *\n"
10725 " guestfs_getxattrs (guestfs_h *g,\n"
10726 " const char *path);\n"
10732 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
10734 "This call lists the extended attributes of the file or directory C<path>."
10739 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
10741 "At the system call level, this is a combination of the L<listxattr(2)> and "
10742 "L<getxattr(2)> calls."
10747 #: ../src/guestfs-actions.pod:2176
10748 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10753 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3543
10754 #: ../src/guestfs-actions.pod:4194
10756 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10757 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10762 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3547
10763 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748
10764 #: ../src/guestfs-actions.pod:5624 ../src/guestfs-actions.pod:6112
10765 #: ../src/guestfs-actions.pod:7447
10766 msgid "(Added in 1.0.59)"
10771 #: ../src/guestfs-actions.pod:2184
10772 msgid "guestfs_glob_expand"
10777 #: ../src/guestfs-actions.pod:2186
10781 " guestfs_glob_expand (guestfs_h *g,\n"
10782 " const char *pattern);\n"
10788 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
10790 "This command searches for all the pathnames matching C<pattern> according to "
10791 "the wildcard expansion rules used by the shell."
10796 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
10798 "If no paths match, then this returns an empty list (note: not an error)."
10803 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
10805 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10806 "GLOB_BRACE>. See that manual page for more details."
10811 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6277
10812 #: ../src/guestfs-actions.pod:6294
10813 msgid "(Added in 1.0.50)"
10818 #: ../src/guestfs-actions.pod:2207
10819 msgid "guestfs_grep"
10824 #: ../src/guestfs-actions.pod:2209
10828 " guestfs_grep (guestfs_h *g,\n"
10829 " const char *regex,\n"
10830 " const char *path);\n"
10836 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
10837 msgid "This calls the external C<grep> program and returns the matching lines."
10842 #: ../src/guestfs-actions.pod:2226
10843 msgid "guestfs_grepi"
10848 #: ../src/guestfs-actions.pod:2228
10852 " guestfs_grepi (guestfs_h *g,\n"
10853 " const char *regex,\n"
10854 " const char *path);\n"
10860 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
10862 "This calls the external C<grep -i> program and returns the matching lines."
10867 #: ../src/guestfs-actions.pod:2245
10868 msgid "guestfs_grub_install"
10873 #: ../src/guestfs-actions.pod:2247
10877 " guestfs_grub_install (guestfs_h *g,\n"
10878 " const char *root,\n"
10879 " const char *device);\n"
10885 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
10887 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10888 "the root directory being C<root>."
10893 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
10895 "Note: If grub-install reports the error \"No suitable drive was found in the "
10896 "generated device map.\" it may be that you need to create a C</boot/grub/"
10897 "device.map> file first that contains the mapping between grub device names "
10898 "and Linux device names. It is usually sufficient to create a file "
10904 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
10907 " (hd0) /dev/vda\n"
10913 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
10914 msgid "replacing C</dev/vda> with the name of the installation device."
10919 #: ../src/guestfs-actions.pod:2268
10920 msgid "(Added in 1.0.17)"
10925 #: ../src/guestfs-actions.pod:2270
10926 msgid "guestfs_head"
10931 #: ../src/guestfs-actions.pod:2272
10935 " guestfs_head (guestfs_h *g,\n"
10936 " const char *path);\n"
10942 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
10944 "This command returns up to the first 10 lines of a file as a list of strings."
10949 #: ../src/guestfs-actions.pod:2288
10950 msgid "guestfs_head_n"
10955 #: ../src/guestfs-actions.pod:2290
10959 " guestfs_head_n (guestfs_h *g,\n"
10961 " const char *path);\n"
10967 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
10969 "If the parameter C<nrlines> is a positive number, this returns the first "
10970 "C<nrlines> lines of the file C<path>."
10975 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
10977 "If the parameter C<nrlines> is a negative number, this returns lines from "
10978 "the file C<path>, excluding the last C<nrlines> lines."
10983 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6574
10984 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4430
10985 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10990 #: ../src/guestfs-actions.pod:2312
10991 msgid "guestfs_hexdump"
10996 #: ../src/guestfs-actions.pod:2314
11000 " guestfs_hexdump (guestfs_h *g,\n"
11001 " const char *path);\n"
11007 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
11009 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11010 "readable, canonical hex dump of the file."
11015 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6358
11016 #: ../src/guestfs-actions.pod:6413
11017 msgid "(Added in 1.0.22)"
11022 #: ../src/guestfs-actions.pod:2329
11023 msgid "guestfs_initrd_cat"
11028 #: ../src/guestfs-actions.pod:2331
11032 " guestfs_initrd_cat (guestfs_h *g,\n"
11033 " const char *initrdpath,\n"
11034 " const char *filename,\n"
11035 " size_t *size_r);\n"
11041 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
11043 "This command unpacks the file C<filename> from the initrd file called "
11044 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11050 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
11052 "For example, in guestfish you could use the following command to examine the "
11053 "boot script (usually called C</init>) contained in a Linux initrd or "
11059 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
11062 " initrd-cat /boot/initrd-<version>.img init\n"
11068 #: ../src/guestfs-actions.pod:2347
11069 msgid "See also C<guestfs_initrd_list>."
11074 #: ../src/guestfs-actions.pod:2358
11075 msgid "guestfs_initrd_list"
11080 #: ../src/guestfs-actions.pod:2360
11084 " guestfs_initrd_list (guestfs_h *g,\n"
11085 " const char *path);\n"
11091 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
11092 msgid "This command lists out files contained in an initrd."
11097 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
11099 "The files are listed without any initial C</> character. The files are "
11100 "listed in the order they appear (not necessarily alphabetical). Directory "
11101 "names are listed as separate items."
11106 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
11108 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11109 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11115 #: ../src/guestfs-actions.pod:2380
11116 msgid "guestfs_inotify_add_watch"
11121 #: ../src/guestfs-actions.pod:2382
11125 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11126 " const char *path,\n"
11133 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
11134 msgid "Watch C<path> for the events listed in C<mask>."
11139 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
11141 "Note that if C<path> is a directory then events within that directory are "
11142 "watched, but this does I<not> happen recursively (in subdirectories)."
11147 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
11149 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11150 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11155 #: ../src/guestfs-actions.pod:2401
11156 msgid "guestfs_inotify_close"
11161 #: ../src/guestfs-actions.pod:2403
11165 " guestfs_inotify_close (guestfs_h *g);\n"
11171 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
11173 "This closes the inotify handle which was previously opened by inotify_init. "
11174 "It removes all watches, throws away any pending events, and deallocates all "
11180 #: ../src/guestfs-actions.pod:2414
11181 msgid "guestfs_inotify_files"
11186 #: ../src/guestfs-actions.pod:2416
11190 " guestfs_inotify_files (guestfs_h *g);\n"
11196 #: ../src/guestfs-actions.pod:2419
11198 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11199 "returns a list of pathnames of objects that were touched. The returned "
11200 "pathnames are sorted and deduplicated."
11205 #: ../src/guestfs-actions.pod:2429
11206 msgid "guestfs_inotify_init"
11211 #: ../src/guestfs-actions.pod:2431
11215 " guestfs_inotify_init (guestfs_h *g,\n"
11216 " int maxevents);\n"
11222 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
11224 "This command creates a new inotify handle. The inotify subsystem can be "
11225 "used to notify events which happen to objects in the guest filesystem."
11230 #: ../src/guestfs-actions.pod:2439
11232 "C<maxevents> is the maximum number of events which will be queued up between "
11233 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11234 "passed as C<0>, then the kernel (or previously set) default is used. For "
11235 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11236 "throws away events, but records the fact that it threw them away by setting "
11237 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11238 "C<guestfs_inotify_read>)."
11243 #: ../src/guestfs-actions.pod:2449
11245 "Before any events are generated, you have to add some watches to the "
11246 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11247 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11252 #: ../src/guestfs-actions.pod:2455
11254 "Queued up events should be read periodically by calling "
11255 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11256 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11257 "often enough then you risk the internal queue overflowing."
11262 #: ../src/guestfs-actions.pod:2462
11264 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11265 "This also removes any watches automatically."
11270 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
11272 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11273 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11274 "that there is one global inotify handle per libguestfs instance."
11279 #: ../src/guestfs-actions.pod:2475
11280 msgid "guestfs_inotify_read"
11285 #: ../src/guestfs-actions.pod:2477
11288 " struct guestfs_inotify_event_list *\n"
11289 " guestfs_inotify_read (guestfs_h *g);\n"
11295 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
11297 "Return the complete queue of events that have happened since the previous "
11303 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
11304 msgid "If no events have happened, this returns an empty list."
11309 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
11311 "I<Note>: In order to make sure that all events have been read, you must call "
11312 "this function repeatedly until it returns an empty list. The reason is that "
11313 "the call will read events up to the maximum appliance-to-host message size "
11314 "and leave remaining events in the queue."
11319 #: ../src/guestfs-actions.pod:2491
11321 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11322 "there was an error. I<The caller must call "
11323 "C<guestfs_free_inotify_event_list> after use>."
11328 #: ../src/guestfs-actions.pod:2497
11329 msgid "guestfs_inotify_rm_watch"
11334 #: ../src/guestfs-actions.pod:2499
11338 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11345 #: ../src/guestfs-actions.pod:2503
11347 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11352 #: ../src/guestfs-actions.pod:2510
11353 msgid "guestfs_inspect_get_arch"
11358 #: ../src/guestfs-actions.pod:2512
11362 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11363 " const char *root);\n"
11369 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
11370 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2676
11371 #: ../src/guestfs-actions.pod:2702 ../src/guestfs-actions.pod:2741
11372 #: ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2790
11373 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2854
11374 #: ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:2914
11375 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2993
11376 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3056
11377 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3096
11378 #: ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3132
11380 "This function should only be called with a root device string as returned by "
11381 "C<guestfs_inspect_os>."
11386 #: ../src/guestfs-actions.pod:2519
11388 "This returns the architecture of the inspected operating system. The "
11389 "possible return values are listed under C<guestfs_file_architecture>."
11394 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
11396 "If the architecture could not be determined, then the string C<unknown> is "
11402 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2619
11403 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2750
11404 #: ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2870
11405 #: ../src/guestfs-actions.pod:2901 ../src/guestfs-actions.pod:2925
11406 #: ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3022
11407 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3066
11408 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3103
11409 #: ../src/guestfs-actions.pod:3122 ../src/guestfs-actions.pod:3225
11410 #: ../src/guestfs-actions.pod:3266 ../fish/guestfish-actions.pod:1698
11411 #: ../fish/guestfish-actions.pod:1784 ../fish/guestfish-actions.pod:1872
11412 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:1908
11413 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2002
11414 #: ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2062
11415 #: ../fish/guestfish-actions.pod:2097 ../fish/guestfish-actions.pod:2113
11416 #: ../fish/guestfish-actions.pod:2129 ../fish/guestfish-actions.pod:2142
11417 #: ../fish/guestfish-actions.pod:2155 ../fish/guestfish-actions.pod:2170
11418 #: ../fish/guestfish-actions.pod:2269 ../fish/guestfish-actions.pod:2303
11419 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11424 #: ../src/guestfs-actions.pod:2533
11425 msgid "guestfs_inspect_get_distro"
11430 #: ../src/guestfs-actions.pod:2535
11434 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11435 " const char *root);\n"
11441 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
11443 "This returns the distro (distribution) of the inspected operating system."
11448 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
11449 msgid "Currently defined distros are:"
11454 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
11455 msgid "\"archlinux\""
11460 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
11461 msgid "Arch Linux."
11465 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
11470 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
11476 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
11482 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
11488 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
11494 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
11500 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
11506 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
11512 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
11513 msgid "\"linuxmint\""
11518 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
11519 msgid "Linux Mint."
11524 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
11525 msgid "\"mandriva\""
11530 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
11536 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
11542 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
11548 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
11554 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
11560 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
11561 msgid "\"redhat-based\""
11566 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
11567 msgid "Some Red Hat-derived distro."
11572 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
11577 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
11578 msgid "Red Hat Enterprise Linux."
11582 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
11583 msgid "\"scientificlinux\""
11587 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
11588 msgid "Scientific Linux."
11592 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
11593 msgid "\"slackware\""
11597 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
11603 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
11609 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
11615 #: ../src/guestfs-actions.pod:2605 ../src/guestfs-actions.pod:2721
11616 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:1770
11617 #: ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:2088
11618 msgid "\"unknown\""
11623 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1772
11624 msgid "The distro could not be determined."
11629 #: ../src/guestfs-actions.pod:2609 ../src/guestfs-actions.pod:3005
11630 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:2080
11631 msgid "\"windows\""
11636 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1776
11638 "Windows does not have distributions. This string is returned if the OS type "
11644 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2727
11645 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1781
11646 #: ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:2094
11648 "Future versions of libguestfs may return other strings here. The caller "
11649 "should be prepared to handle any string."
11653 #: ../src/guestfs-actions.pod:2626
11654 msgid "guestfs_inspect_get_drive_mappings"
11658 #: ../src/guestfs-actions.pod:2628
11662 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11663 " const char *root);\n"
11668 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1793
11670 "This call is useful for Windows which uses a primitive system of assigning "
11671 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11672 "Windows Registry to find out how disks/partitions are mapped to drive "
11673 "letters, and returns a hash table as in the example below:"
11677 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
11680 " C => /dev/vda2\n"
11681 " E => /dev/vdb1\n"
11682 " F => /dev/vdc1\n"
11687 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1803
11689 "Note that keys are drive letters. For Windows, the key is case insensitive "
11690 "and just contains the drive letter, without the customary colon separator "
11695 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
11697 "In future we may support other operating systems that also used drive "
11698 "letters, but the keys for those might not be case insensitive and might be "
11699 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11704 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
11706 "For Windows guests, currently only hard drive mappings are returned. "
11707 "Removable disks (eg. DVD-ROMs) are ignored."
11711 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1815
11713 "For guests that do not use drive mappings, or if the drive mappings could "
11714 "not be determined, this returns an empty hash table."
11718 #: ../src/guestfs-actions.pod:2660
11720 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11721 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11726 #: ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2840
11727 #: ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:4810
11728 #: ../src/guestfs-actions.pod:6715
11730 "This function returns a NULL-terminated array of strings, or NULL if there "
11731 "was an error. The array of strings will always have length C<2n+1>, where "
11732 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11733 "caller must free the strings and the array after use>."
11738 #: ../src/guestfs-actions.pod:2670
11739 msgid "guestfs_inspect_get_filesystems"
11744 #: ../src/guestfs-actions.pod:2672
11748 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11749 " const char *root);\n"
11755 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
11757 "This returns a list of all the filesystems that we think are associated with "
11758 "this operating system. This includes the root filesystem, other ordinary "
11759 "filesystems, and non-mounted devices like swap partitions."
11764 #: ../src/guestfs-actions.pod:2684 ../fish/guestfish-actions.pod:1834
11766 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11767 "to be shared between operating systems."
11772 #: ../src/guestfs-actions.pod:2687
11774 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11775 "C<guestfs_inspect_get_mountpoints>."
11779 #: ../src/guestfs-actions.pod:2696
11780 msgid "guestfs_inspect_get_format"
11784 #: ../src/guestfs-actions.pod:2698
11788 " guestfs_inspect_get_format (guestfs_h *g,\n"
11789 " const char *root);\n"
11794 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
11796 "This returns the format of the inspected operating system. You can use it "
11797 "to detect install images, live CDs and similar."
11801 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
11802 msgid "Currently defined formats are:"
11806 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1854
11807 msgid "\"installed\""
11811 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
11812 msgid "This is an installed operating system."
11816 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
11817 msgid "\"installer\""
11821 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
11823 "The disk image being inspected is not an installed operating system, but a "
11824 "I<bootable> install disk, live CD, or similar."
11828 #: ../src/guestfs-actions.pod:2723 ../fish/guestfish-actions.pod:1865
11829 msgid "The format of this disk image is not known."
11834 #: ../src/guestfs-actions.pod:2735
11835 msgid "guestfs_inspect_get_hostname"
11840 #: ../src/guestfs-actions.pod:2737
11844 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11845 " const char *root);\n"
11851 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
11853 "This function returns the hostname of the operating system as found by "
11854 "inspection of the guest's configuration files."
11859 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1884
11861 "If the hostname could not be determined, then the string C<unknown> is "
11867 #: ../src/guestfs-actions.pod:2755
11868 msgid "(Added in 1.7.9)"
11873 #: ../src/guestfs-actions.pod:2757
11874 msgid "guestfs_inspect_get_major_version"
11879 #: ../src/guestfs-actions.pod:2759
11883 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11884 " const char *root);\n"
11890 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
11892 "This returns the major version number of the inspected operating system."
11897 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1899
11899 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11900 "popular public names used by the operating system. Notably the operating "
11901 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11902 "1). You can find out the real versions corresponding to releases of Windows "
11903 "by consulting Wikipedia or MSDN."
11908 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2796
11909 #: ../fish/guestfish-actions.pod:1906 ../fish/guestfish-actions.pod:1920
11910 msgid "If the version could not be determined, then C<0> is returned."
11915 #: ../src/guestfs-actions.pod:2784
11916 msgid "guestfs_inspect_get_minor_version"
11921 #: ../src/guestfs-actions.pod:2786
11925 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11926 " const char *root);\n"
11932 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1917
11934 "This returns the minor version number of the inspected operating system."
11939 #: ../src/guestfs-actions.pod:2798
11941 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11942 "C<guestfs_inspect_get_major_version>."
11947 #: ../src/guestfs-actions.pod:2805
11948 msgid "guestfs_inspect_get_mountpoints"
11953 #: ../src/guestfs-actions.pod:2807
11957 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11958 " const char *root);\n"
11963 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1932
11965 "This returns a hash of where we think the filesystems associated with this "
11966 "operating system should be mounted. Callers should note that this is at "
11967 "best an educated guess made by reading configuration files such as C</etc/"
11968 "fstab>. I<In particular note> that this may return filesystems which are "
11969 "non-existent or not mountable and callers should be prepared to handle or "
11970 "ignore failures if they try to mount them."
11975 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:1941
11977 "Each element in the returned hashtable has a key which is the path of the "
11978 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11979 "mounted there (eg. C</dev/sda1>)."
11984 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1946
11986 "Non-mounted devices such as swap devices are I<not> returned in this list."
11990 #: ../src/guestfs-actions.pod:2831
11992 "For operating systems like Windows which still use drive letters, this call "
11993 "will only return an entry for the first drive \"mounted on\" C</>. For "
11994 "information about the mapping of drive letters to partitions, see "
11995 "C<guestfs_inspect_get_drive_mappings>."
12000 #: ../src/guestfs-actions.pod:2837
12002 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12003 "C<guestfs_inspect_get_filesystems>."
12008 #: ../src/guestfs-actions.pod:2848
12009 msgid "guestfs_inspect_get_package_format"
12014 #: ../src/guestfs-actions.pod:2850
12018 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12019 " const char *root);\n"
12025 #: ../src/guestfs-actions.pod:2857
12027 "This function and C<guestfs_inspect_get_package_management> return the "
12028 "package format and package management tool used by the inspected operating "
12029 "system. For example for Fedora these functions would return C<rpm> (package "
12030 "format) and C<yum> (package management)."
12035 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1971
12037 "This returns the string C<unknown> if we could not determine the package "
12038 "format I<or> if the operating system does not have a real packaging system "
12044 #: ../src/guestfs-actions.pod:2867 ../fish/guestfish-actions.pod:1975
12046 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12047 "Future versions of libguestfs may return other strings."
12052 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
12053 msgid "(Added in 1.7.5)"
12058 #: ../src/guestfs-actions.pod:2877
12059 msgid "guestfs_inspect_get_package_management"
12064 #: ../src/guestfs-actions.pod:2879
12068 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12069 " const char *root);\n"
12075 #: ../src/guestfs-actions.pod:2886
12077 "C<guestfs_inspect_get_package_format> and this function return the package "
12078 "format and package management tool used by the inspected operating system. "
12079 "For example for Fedora these functions would return C<rpm> (package format) "
12080 "and C<yum> (package management)."
12085 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:1993
12087 "This returns the string C<unknown> if we could not determine the package "
12088 "management tool I<or> if the operating system does not have a real packaging "
12089 "system (eg. Windows)."
12094 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1997
12096 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12097 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12098 "libguestfs may return other strings."
12103 #: ../src/guestfs-actions.pod:2908
12104 msgid "guestfs_inspect_get_product_name"
12109 #: ../src/guestfs-actions.pod:2910
12113 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12114 " const char *root);\n"
12120 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2011
12122 "This returns the product name of the inspected operating system. The "
12123 "product name is generally some freeform string which can be displayed to the "
12124 "user, but should not be parsed by programs."
12129 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2016
12131 "If the product name could not be determined, then the string C<unknown> is "
12136 #: ../src/guestfs-actions.pod:2932
12137 msgid "guestfs_inspect_get_product_variant"
12141 #: ../src/guestfs-actions.pod:2934
12145 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12146 " const char *root);\n"
12151 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
12152 msgid "This returns the product variant of the inspected operating system."
12156 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2031
12158 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12159 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12160 "is usually a string such as C<Client> or C<Server> (other values are "
12161 "possible). This can be used to distinguish consumer and enterprise versions "
12162 "of Windows that have the same version number (for example, Windows 7 and "
12163 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12164 "the latter is C<Server>)."
12168 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2040
12170 "For enterprise Linux guests, in future we intend this to return the product "
12171 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12172 "implemented at present."
12176 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2044
12178 "If the product variant could not be determined, then the string C<unknown> "
12183 #: ../src/guestfs-actions.pod:2960
12185 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12186 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12191 #: ../src/guestfs-actions.pod:2967
12192 msgid "guestfs_inspect_get_roots"
12197 #: ../src/guestfs-actions.pod:2969
12201 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12207 #: ../src/guestfs-actions.pod:2972
12209 "This function is a convenient way to get the list of root devices, as "
12210 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12211 "the whole inspection process."
12216 #: ../src/guestfs-actions.pod:2976
12218 "This returns an empty list if either no root devices were found or the "
12219 "caller has not called C<guestfs_inspect_os>."
12224 #: ../src/guestfs-actions.pod:2985
12225 msgid "(Added in 1.7.3)"
12230 #: ../src/guestfs-actions.pod:2987
12231 msgid "guestfs_inspect_get_type"
12236 #: ../src/guestfs-actions.pod:2989
12240 " guestfs_inspect_get_type (guestfs_h *g,\n"
12241 " const char *root);\n"
12247 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2071
12249 "This returns the type of the inspected operating system. Currently defined "
12255 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
12261 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
12262 msgid "Any Linux-based operating system."
12267 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
12268 msgid "Any Microsoft Windows operating system."
12273 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
12274 msgid "\"freebsd\""
12279 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
12285 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2090
12286 msgid "The operating system type could not be determined."
12290 #: ../src/guestfs-actions.pod:3029
12291 msgid "guestfs_inspect_get_windows_current_control_set"
12295 #: ../src/guestfs-actions.pod:3031
12299 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12300 " const char *root);\n"
12305 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
12307 "This returns the Windows CurrentControlSet of the inspected guest. The "
12308 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12312 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2109
12314 "This call assumes that the guest is Windows and that the Registry could be "
12315 "examined by inspection. If this is not the case then an error is returned."
12320 #: ../src/guestfs-actions.pod:3050
12321 msgid "guestfs_inspect_get_windows_systemroot"
12326 #: ../src/guestfs-actions.pod:3052
12330 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12331 " const char *root);\n"
12337 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
12339 "This returns the Windows systemroot of the inspected guest. The systemroot "
12340 "is a directory path such as C</WINDOWS>."
12345 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2125
12347 "This call assumes that the guest is Windows and that the systemroot could be "
12348 "determined by inspection. If this is not the case then an error is returned."
12353 #: ../src/guestfs-actions.pod:3071
12354 msgid "(Added in 1.5.25)"
12358 #: ../src/guestfs-actions.pod:3073
12359 msgid "guestfs_inspect_is_live"
12363 #: ../src/guestfs-actions.pod:3075
12367 " guestfs_inspect_is_live (guestfs_h *g,\n"
12368 " const char *root);\n"
12373 #: ../src/guestfs-actions.pod:3082
12375 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12376 "disk), then this returns true if a live image was detected on the disk."
12380 #: ../src/guestfs-actions.pod:3090
12381 msgid "guestfs_inspect_is_multipart"
12385 #: ../src/guestfs-actions.pod:3092
12389 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12390 " const char *root);\n"
12395 #: ../src/guestfs-actions.pod:3099
12397 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12398 "disk), then this returns true if the disk is part of a set."
12402 #: ../src/guestfs-actions.pod:3107
12403 msgid "guestfs_inspect_is_netinst"
12407 #: ../src/guestfs-actions.pod:3109
12411 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12412 " const char *root);\n"
12417 #: ../src/guestfs-actions.pod:3116
12419 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12420 "disk), then this returns true if the disk is a network installer, ie. not a "
12421 "self-contained install CD but one which is likely to require network access "
12422 "to complete the install."
12427 #: ../src/guestfs-actions.pod:3126
12428 msgid "guestfs_inspect_list_applications"
12433 #: ../src/guestfs-actions.pod:3128
12436 " struct guestfs_application_list *\n"
12437 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12438 " const char *root);\n"
12444 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2179
12445 msgid "Return the list of applications installed in the operating system."
12450 #: ../src/guestfs-actions.pod:3137
12452 "I<Note:> This call works differently from other parts of the inspection "
12453 "API. You have to call C<guestfs_inspect_os>, then "
12454 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12455 "this. Listing applications is a significantly more difficult operation "
12456 "which requires access to the full filesystem. Also note that unlike the "
12457 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12458 "the libguestfs handle, this call actually reads parts of the mounted "
12459 "filesystems during the call."
12464 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
12466 "This returns an empty list if the inspection code was not able to determine "
12467 "the list of applications."
12472 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2194
12473 msgid "The application structure contains the following fields:"
12478 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2198
12479 msgid "C<app_name>"
12484 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
12486 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12487 "guests, this is the package name."
12492 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
12493 msgid "C<app_display_name>"
12498 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
12500 "The display name of the application, sometimes localized to the install "
12501 "language of the guest operating system."
12506 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
12508 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12509 "to display something can use C<app_name> instead."
12514 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2211
12515 msgid "C<app_epoch>"
12520 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
12522 "For package managers which use epochs, this contains the epoch of the "
12523 "package (an integer). If unavailable, this is returned as C<0>."
12528 #: ../src/guestfs-actions.pod:3172 ../fish/guestfish-actions.pod:2216
12529 msgid "C<app_version>"
12534 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
12536 "The version string of the application or package. If unavailable this is "
12537 "returned as an empty string C<\"\">."
12542 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
12543 msgid "C<app_release>"
12548 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
12550 "The release string of the application or package, for package managers that "
12551 "use this. If unavailable this is returned as an empty string C<\"\">."
12556 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2227
12557 msgid "C<app_install_path>"
12562 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
12564 "The installation path of the application (on operating systems such as "
12565 "Windows which use installation paths). This path is in the format used by "
12566 "the guest operating system, it is not a libguestfs path."
12571 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2234
12572 msgid "If unavailable this is returned as an empty string C<\"\">."
12577 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
12578 msgid "C<app_trans_path>"
12583 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
12585 "The install path translated into a libguestfs path. If unavailable this is "
12586 "returned as an empty string C<\"\">."
12591 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
12592 msgid "C<app_publisher>"
12597 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
12599 "The name of the publisher of the application, for package managers that use "
12600 "this. If unavailable this is returned as an empty string C<\"\">."
12605 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2247
12611 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
12613 "The URL (eg. upstream URL) of the application. If unavailable this is "
12614 "returned as an empty string C<\"\">."
12619 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2252
12620 msgid "C<app_source_package>"
12625 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
12627 "For packaging systems which support this, the name of the source package. "
12628 "If unavailable this is returned as an empty string C<\"\">."
12633 #: ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:2257
12634 msgid "C<app_summary>"
12639 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
12641 "A short (usually one line) description of the application or package. If "
12642 "unavailable this is returned as an empty string C<\"\">."
12647 #: ../src/guestfs-actions.pod:3218 ../fish/guestfish-actions.pod:2262
12648 msgid "C<app_description>"
12653 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
12655 "A longer description of the application or package. If unavailable this is "
12656 "returned as an empty string C<\"\">."
12661 #: ../src/guestfs-actions.pod:3227
12663 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12664 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12670 #: ../src/guestfs-actions.pod:3231
12671 msgid "(Added in 1.7.8)"
12676 #: ../src/guestfs-actions.pod:3233
12677 msgid "guestfs_inspect_os"
12682 #: ../src/guestfs-actions.pod:3235
12686 " guestfs_inspect_os (guestfs_h *g);\n"
12692 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2275
12694 "This function uses other libguestfs functions and certain heuristics to "
12695 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12696 "for operating systems."
12701 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2279
12702 msgid "The list returned is empty if no operating systems were found."
12707 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
12709 "If one operating system was found, then this returns a list with a single "
12710 "element, which is the name of the root filesystem of this operating system. "
12711 "It is also possible for this function to return a list containing more than "
12712 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12713 "element being the root filesystem of one of the operating systems."
12718 #: ../src/guestfs-actions.pod:3251
12720 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12721 "functions in order to query further information about each operating system, "
12722 "such as the name and version."
12727 #: ../src/guestfs-actions.pod:3256
12729 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12730 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12731 "the contents. This should be called with no disks currently mounted. The "
12732 "function may also use Augeas, so any existing Augeas handle will be closed."
12737 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2299
12739 "This function cannot decrypt encrypted disks. The caller must do that first "
12740 "(supplying the necessary keys) if the disk is encrypted."
12745 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3558
12746 #: ../src/guestfs-actions.pod:3620
12747 msgid "See also C<guestfs_list_filesystems>."
12752 #: ../src/guestfs-actions.pod:3276
12753 msgid "guestfs_is_blockdev"
12758 #: ../src/guestfs-actions.pod:3278
12762 " guestfs_is_blockdev (guestfs_h *g,\n"
12763 " const char *path);\n"
12769 #: ../src/guestfs-actions.pod:3282 ../fish/guestfish-actions.pod:2311
12771 "This returns C<true> if and only if there is a block device with the given "
12777 #: ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3314
12778 #: ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3359
12779 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3431
12780 #: ../src/guestfs-actions.pod:3446
12781 msgid "See also C<guestfs_stat>."
12786 #: ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3318
12787 #: ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3435
12788 #: ../src/guestfs-actions.pod:3450
12789 msgid "(Added in 1.5.10)"
12794 #: ../src/guestfs-actions.pod:3291
12795 msgid "guestfs_is_busy"
12800 #: ../src/guestfs-actions.pod:3293
12804 " guestfs_is_busy (guestfs_h *g);\n"
12810 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2320
12812 "This returns true iff this handle is busy processing a command (in the "
12818 #: ../src/guestfs-actions.pod:3305
12819 msgid "guestfs_is_chardev"
12824 #: ../src/guestfs-actions.pod:3307
12828 " guestfs_is_chardev (guestfs_h *g,\n"
12829 " const char *path);\n"
12835 #: ../src/guestfs-actions.pod:3311 ../fish/guestfish-actions.pod:2329
12837 "This returns C<true> if and only if there is a character device with the "
12838 "given C<path> name."
12843 #: ../src/guestfs-actions.pod:3320
12844 msgid "guestfs_is_config"
12849 #: ../src/guestfs-actions.pod:3322
12853 " guestfs_is_config (guestfs_h *g);\n"
12859 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2338
12861 "This returns true iff this handle is being configured (in the C<CONFIG> "
12867 #: ../src/guestfs-actions.pod:3334
12868 msgid "guestfs_is_dir"
12873 #: ../src/guestfs-actions.pod:3336
12877 " guestfs_is_dir (guestfs_h *g,\n"
12878 " const char *path);\n"
12884 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2347
12886 "This returns C<true> if and only if there is a directory with the given "
12887 "C<path> name. Note that it returns false for other objects like files."
12892 #: ../src/guestfs-actions.pod:3350
12893 msgid "guestfs_is_fifo"
12898 #: ../src/guestfs-actions.pod:3352
12902 " guestfs_is_fifo (guestfs_h *g,\n"
12903 " const char *path);\n"
12909 #: ../src/guestfs-actions.pod:3356 ../fish/guestfish-actions.pod:2357
12911 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12912 "given C<path> name."
12917 #: ../src/guestfs-actions.pod:3365
12918 msgid "guestfs_is_file"
12923 #: ../src/guestfs-actions.pod:3367
12927 " guestfs_is_file (guestfs_h *g,\n"
12928 " const char *path);\n"
12934 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2366
12936 "This returns C<true> if and only if there is a regular file with the given "
12937 "C<path> name. Note that it returns false for other objects like directories."
12942 #: ../src/guestfs-actions.pod:3381
12943 msgid "guestfs_is_launching"
12948 #: ../src/guestfs-actions.pod:3383
12952 " guestfs_is_launching (guestfs_h *g);\n"
12958 #: ../src/guestfs-actions.pod:3386 ../fish/guestfish-actions.pod:2376
12960 "This returns true iff this handle is launching the subprocess (in the "
12961 "C<LAUNCHING> state)."
12966 #: ../src/guestfs-actions.pod:3395
12967 msgid "guestfs_is_lv"
12972 #: ../src/guestfs-actions.pod:3397
12976 " guestfs_is_lv (guestfs_h *g,\n"
12977 " const char *device);\n"
12983 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2385
12985 "This command tests whether C<device> is a logical volume, and returns true "
12986 "iff this is the case."
12991 #: ../src/guestfs-actions.pod:3408
12992 msgid "guestfs_is_ready"
12997 #: ../src/guestfs-actions.pod:3410
13001 " guestfs_is_ready (guestfs_h *g);\n"
13007 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:2392
13009 "This returns true iff this handle is ready to accept commands (in the "
13015 #: ../src/guestfs-actions.pod:3422
13016 msgid "guestfs_is_socket"
13021 #: ../src/guestfs-actions.pod:3424
13025 " guestfs_is_socket (guestfs_h *g,\n"
13026 " const char *path);\n"
13032 #: ../src/guestfs-actions.pod:3428 ../fish/guestfish-actions.pod:2401
13034 "This returns C<true> if and only if there is a Unix domain socket with the "
13035 "given C<path> name."
13040 #: ../src/guestfs-actions.pod:3437
13041 msgid "guestfs_is_symlink"
13046 #: ../src/guestfs-actions.pod:3439
13050 " guestfs_is_symlink (guestfs_h *g,\n"
13051 " const char *path);\n"
13057 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2410
13059 "This returns C<true> if and only if there is a symbolic link with the given "
13065 #: ../src/guestfs-actions.pod:3452
13066 msgid "guestfs_kill_subprocess"
13071 #: ../src/guestfs-actions.pod:3454
13075 " guestfs_kill_subprocess (guestfs_h *g);\n"
13081 #: ../src/guestfs-actions.pod:3457 ../fish/guestfish-actions.pod:2419
13082 msgid "This kills the qemu subprocess. You should never need to call this."
13087 #: ../src/guestfs-actions.pod:3463
13088 msgid "guestfs_launch"
13093 #: ../src/guestfs-actions.pod:3465
13097 " guestfs_launch (guestfs_h *g);\n"
13103 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
13105 "Internally libguestfs is implemented by running a virtual machine using "
13111 #: ../src/guestfs-actions.pod:3471 ../fish/guestfish-actions.pod:2430
13113 "You should call this after configuring the handle (eg. adding drives) but "
13114 "before performing any actions."
13119 #: ../src/guestfs-actions.pod:3483
13120 msgid "guestfs_lchown"
13125 #: ../src/guestfs-actions.pod:3485
13129 " guestfs_lchown (guestfs_h *g,\n"
13132 " const char *path);\n"
13138 #: ../src/guestfs-actions.pod:3491
13140 "Change the file owner to C<owner> and group to C<group>. This is like "
13141 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13142 "changed, not the target."
13147 #: ../src/guestfs-actions.pod:3503
13148 msgid "guestfs_lgetxattr"
13153 #: ../src/guestfs-actions.pod:3505
13157 " guestfs_lgetxattr (guestfs_h *g,\n"
13158 " const char *path,\n"
13159 " const char *name,\n"
13160 " size_t *size_r);\n"
13166 #: ../src/guestfs-actions.pod:3511 ../fish/guestfish-actions.pod:2449
13168 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13169 "is a symlink, then this call returns an extended attribute from the symlink."
13174 #: ../src/guestfs-actions.pod:3525
13175 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13180 #: ../src/guestfs-actions.pod:3533
13181 msgid "guestfs_lgetxattrs"
13186 #: ../src/guestfs-actions.pod:3535
13189 " struct guestfs_xattr_list *\n"
13190 " guestfs_lgetxattrs (guestfs_h *g,\n"
13191 " const char *path);\n"
13197 #: ../src/guestfs-actions.pod:3539
13199 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13200 "then it returns the extended attributes of the link itself."
13205 #: ../src/guestfs-actions.pod:3549
13206 msgid "guestfs_list_devices"
13211 #: ../src/guestfs-actions.pod:3551
13215 " guestfs_list_devices (guestfs_h *g);\n"
13221 #: ../src/guestfs-actions.pod:3554 ../fish/guestfish-actions.pod:2477
13222 msgid "List all the block devices."
13227 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
13228 msgid "The full block device names are returned, eg. C</dev/sda>."
13233 #: ../src/guestfs-actions.pod:3566
13234 msgid "guestfs_list_filesystems"
13239 #: ../src/guestfs-actions.pod:3568
13243 " guestfs_list_filesystems (guestfs_h *g);\n"
13249 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
13251 "This inspection command looks for filesystems on partitions, block devices "
13252 "and logical volumes, returning a list of devices containing filesystems and "
13258 #: ../src/guestfs-actions.pod:3575 ../fish/guestfish-actions.pod:2491
13260 "The return value is a hash, where the keys are the devices containing "
13261 "filesystems, and the values are the filesystem types. For example:"
13266 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2495
13269 " \"/dev/sda1\" => \"ntfs\"\n"
13270 " \"/dev/sda2\" => \"ext2\"\n"
13271 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13272 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13278 #: ../src/guestfs-actions.pod:3584 ../fish/guestfish-actions.pod:2500
13280 "The value can have the special value \"unknown\", meaning the content of the "
13281 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13286 #: ../src/guestfs-actions.pod:3588
13288 "This command runs other libguestfs commands, which might include "
13289 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13290 "soon after launch and only when nothing is mounted."
13295 #: ../src/guestfs-actions.pod:3592
13297 "Not all of the filesystems returned will be mountable. In particular, swap "
13298 "partitions are returned in the list. Also this command does not check that "
13299 "each filesystem found is valid and mountable, and some filesystems might be "
13300 "mountable but require special options. Filesystems may not all belong to a "
13301 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13306 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:5211
13307 msgid "(Added in 1.5.15)"
13312 #: ../src/guestfs-actions.pod:3608
13313 msgid "guestfs_list_partitions"
13318 #: ../src/guestfs-actions.pod:3610
13322 " guestfs_list_partitions (guestfs_h *g);\n"
13328 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2520
13329 msgid "List all the partitions detected on all block devices."
13334 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
13335 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13340 #: ../src/guestfs-actions.pod:3617
13342 "This does not return logical volumes. For that you will need to call "
13348 #: ../src/guestfs-actions.pod:3628
13354 #: ../src/guestfs-actions.pod:3630
13358 " guestfs_ll (guestfs_h *g,\n"
13359 " const char *directory);\n"
13365 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
13367 "List the files in C<directory> (relative to the root directory, there is no "
13368 "cwd) in the format of 'ls -la'."
13373 #: ../src/guestfs-actions.pod:3637 ../fish/guestfish-actions.pod:2536
13375 "This command is mostly useful for interactive sessions. It is I<not> "
13376 "intended that you try to parse the output string."
13381 #: ../src/guestfs-actions.pod:3645
13387 #: ../src/guestfs-actions.pod:3647
13391 " guestfs_ln (guestfs_h *g,\n"
13392 " const char *target,\n"
13393 " const char *linkname);\n"
13399 #: ../src/guestfs-actions.pod:3652 ../fish/guestfish-actions.pod:2543
13400 msgid "This command creates a hard link using the C<ln> command."
13405 #: ../src/guestfs-actions.pod:3658
13406 msgid "guestfs_ln_f"
13411 #: ../src/guestfs-actions.pod:3660
13415 " guestfs_ln_f (guestfs_h *g,\n"
13416 " const char *target,\n"
13417 " const char *linkname);\n"
13423 #: ../src/guestfs-actions.pod:3665 ../fish/guestfish-actions.pod:2549
13425 "This command creates a hard link using the C<ln -f> command. The C<-f> "
13426 "option removes the link (C<linkname>) if it exists already."
13431 #: ../src/guestfs-actions.pod:3672
13432 msgid "guestfs_ln_s"
13437 #: ../src/guestfs-actions.pod:3674
13441 " guestfs_ln_s (guestfs_h *g,\n"
13442 " const char *target,\n"
13443 " const char *linkname);\n"
13449 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2556
13450 msgid "This command creates a symbolic link using the C<ln -s> command."
13455 #: ../src/guestfs-actions.pod:3685
13456 msgid "guestfs_ln_sf"
13461 #: ../src/guestfs-actions.pod:3687
13465 " guestfs_ln_sf (guestfs_h *g,\n"
13466 " const char *target,\n"
13467 " const char *linkname);\n"
13473 #: ../src/guestfs-actions.pod:3692 ../fish/guestfish-actions.pod:2562
13475 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
13476 "option removes the link (C<linkname>) if it exists already."
13481 #: ../src/guestfs-actions.pod:3699
13482 msgid "guestfs_lremovexattr"
13487 #: ../src/guestfs-actions.pod:3701
13491 " guestfs_lremovexattr (guestfs_h *g,\n"
13492 " const char *xattr,\n"
13493 " const char *path);\n"
13499 #: ../src/guestfs-actions.pod:3706
13501 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13502 "link, then it removes an extended attribute of the link itself."
13507 #: ../src/guestfs-actions.pod:3714
13513 #: ../src/guestfs-actions.pod:3716
13517 " guestfs_ls (guestfs_h *g,\n"
13518 " const char *directory);\n"
13524 #: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2577
13526 "List the files in C<directory> (relative to the root directory, there is no "
13527 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13532 #: ../src/guestfs-actions.pod:3724
13534 "This command is mostly useful for interactive sessions. Programs should "
13535 "probably use C<guestfs_readdir> instead."
13540 #: ../src/guestfs-actions.pod:3733
13541 msgid "guestfs_lsetxattr"
13546 #: ../src/guestfs-actions.pod:3735
13550 " guestfs_lsetxattr (guestfs_h *g,\n"
13551 " const char *xattr,\n"
13552 " const char *val,\n"
13554 " const char *path);\n"
13560 #: ../src/guestfs-actions.pod:3742
13562 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13563 "then it sets an extended attribute of the link itself."
13568 #: ../src/guestfs-actions.pod:3750
13569 msgid "guestfs_lstat"
13574 #: ../src/guestfs-actions.pod:3752
13577 " struct guestfs_stat *\n"
13578 " guestfs_lstat (guestfs_h *g,\n"
13579 " const char *path);\n"
13585 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6314
13586 #: ../fish/guestfish-actions.pod:2596 ../fish/guestfish-actions.pod:4265
13587 msgid "Returns file information for the given C<path>."
13592 #: ../src/guestfs-actions.pod:3758
13594 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13595 "link, then the link is stat-ed, not the file it refers to."
13600 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2602
13601 msgid "This is the same as the C<lstat(2)> system call."
13606 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:6318
13608 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13609 "error. I<The caller must call C<guestfs_free_stat> after use>."
13614 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:6322
13615 #: ../src/guestfs-actions.pod:6340 ../src/guestfs-actions.pod:6721
13616 msgid "(Added in 0.9.2)"
13621 #: ../src/guestfs-actions.pod:3770
13622 msgid "guestfs_lstatlist"
13627 #: ../src/guestfs-actions.pod:3772
13630 " struct guestfs_stat_list *\n"
13631 " guestfs_lstatlist (guestfs_h *g,\n"
13632 " const char *path,\n"
13633 " char *const *names);\n"
13639 #: ../src/guestfs-actions.pod:3777
13641 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13642 "files, where all files are in the directory C<path>. C<names> is the list "
13643 "of files from this directory."
13648 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2612
13650 "On return you get a list of stat structs, with a one-to-one correspondence "
13651 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13652 "then the C<ino> field of that structure is set to C<-1>."
13657 #: ../src/guestfs-actions.pod:3786
13659 "This call is intended for programs that want to efficiently list a directory "
13660 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13661 "for a similarly efficient call for getting extended attributes. Very long "
13662 "directory listings might cause the protocol message size to be exceeded, "
13663 "causing this call to fail. The caller must split up such requests into "
13664 "smaller groups of names."
13669 #: ../src/guestfs-actions.pod:3794
13671 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13672 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13677 #: ../src/guestfs-actions.pod:3800
13678 msgid "guestfs_luks_add_key"
13683 #: ../src/guestfs-actions.pod:3802
13687 " guestfs_luks_add_key (guestfs_h *g,\n"
13688 " const char *device,\n"
13689 " const char *key,\n"
13690 " const char *newkey,\n"
13697 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2629
13699 "This command adds a new key on LUKS device C<device>. C<key> is any "
13700 "existing key, and is used to access the device. C<newkey> is the new key to "
13701 "add. C<keyslot> is the key slot that will be replaced."
13706 #: ../src/guestfs-actions.pod:3814
13708 "Note that if C<keyslot> already contains a key, then this command will "
13709 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13714 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3860
13715 #: ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3903
13716 #: ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:3954
13718 "This function takes a key or passphrase parameter which could contain "
13719 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13725 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3864
13726 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3907
13727 msgid "(Added in 1.5.2)"
13732 #: ../src/guestfs-actions.pod:3826
13733 msgid "guestfs_luks_close"
13738 #: ../src/guestfs-actions.pod:3828
13742 " guestfs_luks_close (guestfs_h *g,\n"
13743 " const char *device);\n"
13749 #: ../src/guestfs-actions.pod:3832
13751 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13752 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13753 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13754 "underlying block device."
13759 #: ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3939
13760 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4008
13761 #: ../src/guestfs-actions.pod:4056
13762 msgid "(Added in 1.5.1)"
13767 #: ../src/guestfs-actions.pod:3842
13768 msgid "guestfs_luks_format"
13773 #: ../src/guestfs-actions.pod:3844
13777 " guestfs_luks_format (guestfs_h *g,\n"
13778 " const char *device,\n"
13779 " const char *key,\n"
13786 #: ../src/guestfs-actions.pod:3850 ../fish/guestfish-actions.pod:2655
13788 "This command erases existing data on C<device> and formats the device as a "
13789 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13790 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13795 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880
13796 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4962
13797 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6149
13798 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6198
13799 #: ../src/guestfs-actions.pod:7358 ../fish/guestfish-actions.pod:2663
13800 #: ../fish/guestfish-actions.pod:2676 ../fish/guestfish-actions.pod:2760
13801 #: ../fish/guestfish-actions.pod:3334 ../fish/guestfish-actions.pod:3854
13802 #: ../fish/guestfish-actions.pod:4164 ../fish/guestfish-actions.pod:4180
13803 #: ../fish/guestfish-actions.pod:4195 ../fish/guestfish-actions.pod:4910
13805 "B<This command is dangerous. Without careful use you can easily destroy all "
13811 #: ../src/guestfs-actions.pod:3866
13812 msgid "guestfs_luks_format_cipher"
13817 #: ../src/guestfs-actions.pod:3868
13821 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13822 " const char *device,\n"
13823 " const char *key,\n"
13825 " const char *cipher);\n"
13831 #: ../src/guestfs-actions.pod:3875
13833 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13834 "set the C<cipher> used."
13839 #: ../src/guestfs-actions.pod:3889
13840 msgid "guestfs_luks_kill_slot"
13845 #: ../src/guestfs-actions.pod:3891
13849 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13850 " const char *device,\n"
13851 " const char *key,\n"
13858 #: ../src/guestfs-actions.pod:3897 ../fish/guestfish-actions.pod:2683
13860 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13861 "device C<device>. C<key> must be one of the I<other> keys."
13866 #: ../src/guestfs-actions.pod:3909
13867 msgid "guestfs_luks_open"
13872 #: ../src/guestfs-actions.pod:3911
13876 " guestfs_luks_open (guestfs_h *g,\n"
13877 " const char *device,\n"
13878 " const char *key,\n"
13879 " const char *mapname);\n"
13885 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
13887 "This command opens a block device which has been encrypted according to the "
13888 "Linux Unified Key Setup (LUKS) standard."
13893 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2697
13894 msgid "C<device> is the encrypted block device or partition."
13899 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
13901 "The caller must supply one of the keys associated with the LUKS block "
13902 "device, in the C<key> parameter."
13907 #: ../src/guestfs-actions.pod:3925 ../fish/guestfish-actions.pod:2702
13909 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13910 "writes to this block device are decrypted from and encrypted to the "
13911 "underlying C<device> respectively."
13916 #: ../src/guestfs-actions.pod:3929
13918 "If this block device contains LVM volume groups, then calling "
13919 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13925 #: ../src/guestfs-actions.pod:3941
13926 msgid "guestfs_luks_open_ro"
13931 #: ../src/guestfs-actions.pod:3943
13935 " guestfs_luks_open_ro (guestfs_h *g,\n"
13936 " const char *device,\n"
13937 " const char *key,\n"
13938 " const char *mapname);\n"
13944 #: ../src/guestfs-actions.pod:3949
13946 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13952 #: ../src/guestfs-actions.pod:3960
13953 msgid "guestfs_lvcreate"
13958 #: ../src/guestfs-actions.pod:3962
13962 " guestfs_lvcreate (guestfs_h *g,\n"
13963 " const char *logvol,\n"
13964 " const char *volgroup,\n"
13971 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2727
13973 "This creates an LVM logical volume called C<logvol> on the volume group "
13974 "C<volgroup>, with C<size> megabytes."
13979 #: ../src/guestfs-actions.pod:3975
13980 msgid "guestfs_lvm_canonical_lv_name"
13985 #: ../src/guestfs-actions.pod:3977
13989 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13990 " const char *lvname);\n"
13996 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2734
13998 "This converts alternative naming schemes for LVs that you might find to the "
13999 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
14005 #: ../src/guestfs-actions.pod:3985 ../fish/guestfish-actions.pod:2738
14007 "This command returns an error if the C<lvname> parameter does not refer to a "
14013 #: ../src/guestfs-actions.pod:3988
14014 msgid "See also C<guestfs_is_lv>."
14019 #: ../src/guestfs-actions.pod:3993
14020 msgid "(Added in 1.5.24)"
14025 #: ../src/guestfs-actions.pod:3995
14026 msgid "guestfs_lvm_clear_filter"
14031 #: ../src/guestfs-actions.pod:3997
14035 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14041 #: ../src/guestfs-actions.pod:4000
14043 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14044 "see every block device."
14049 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4045
14050 #: ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2781
14052 "This command also clears the LVM cache and performs a volume group scan."
14057 #: ../src/guestfs-actions.pod:4010
14058 msgid "guestfs_lvm_remove_all"
14063 #: ../src/guestfs-actions.pod:4012
14067 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14073 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2757
14075 "This command removes all LVM logical volumes, volume groups and physical "
14081 #: ../src/guestfs-actions.pod:4025
14082 msgid "guestfs_lvm_set_filter"
14087 #: ../src/guestfs-actions.pod:4027
14091 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14092 " char *const *devices);\n"
14098 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2767
14100 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14101 "block devices in the list C<devices>, and will ignore all other attached "
14107 #: ../src/guestfs-actions.pod:4035 ../fish/guestfish-actions.pod:2771
14109 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14110 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14111 "there are two types of duplication possible: either cloned PVs/VGs which "
14112 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14113 "same name. In normal operation you cannot create this situation, but you "
14114 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14115 "inside the LVM metadata."
14120 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2784
14121 msgid "You can filter whole block devices or individual partitions."
14126 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
14128 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14129 "filesystem), even if you are not filtering out that VG."
14134 #: ../src/guestfs-actions.pod:4058
14135 msgid "guestfs_lvremove"
14140 #: ../src/guestfs-actions.pod:4060
14144 " guestfs_lvremove (guestfs_h *g,\n"
14145 " const char *device);\n"
14151 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
14153 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14154 "LV, such as C</dev/VG/LV>."
14159 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2797
14161 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14167 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:5308
14168 #: ../src/guestfs-actions.pod:7097
14169 msgid "(Added in 1.0.13)"
14174 #: ../src/guestfs-actions.pod:4074
14175 msgid "guestfs_lvrename"
14180 #: ../src/guestfs-actions.pod:4076
14184 " guestfs_lvrename (guestfs_h *g,\n"
14185 " const char *logvol,\n"
14186 " const char *newlogvol);\n"
14192 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2804
14193 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14198 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:7110
14199 msgid "(Added in 1.0.83)"
14204 #: ../src/guestfs-actions.pod:4087
14205 msgid "guestfs_lvresize"
14210 #: ../src/guestfs-actions.pod:4089
14214 " guestfs_lvresize (guestfs_h *g,\n"
14215 " const char *device,\n"
14222 #: ../src/guestfs-actions.pod:4094 ../fish/guestfish-actions.pod:2810
14224 "This resizes (expands or shrinks) an existing LVM logical volume to "
14225 "C<mbytes>. When reducing, data in the reduced part is lost."
14230 #: ../src/guestfs-actions.pod:4102
14231 msgid "guestfs_lvresize_free"
14236 #: ../src/guestfs-actions.pod:4104
14240 " guestfs_lvresize_free (guestfs_h *g,\n"
14241 " const char *lv,\n"
14248 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2818
14250 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14251 "remaining free space in the volume group. Commonly you would call this with "
14252 "pc = 100 which expands the logical volume as much as possible, using all "
14253 "remaining free space in the volume group."
14258 #: ../src/guestfs-actions.pod:4117
14259 msgid "(Added in 1.3.3)"
14264 #: ../src/guestfs-actions.pod:4119
14265 msgid "guestfs_lvs"
14270 #: ../src/guestfs-actions.pod:4121
14274 " guestfs_lvs (guestfs_h *g);\n"
14280 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
14282 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14288 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2831
14290 "This returns a list of the logical volume device names (eg. C</dev/"
14291 "VolGroup00/LogVol00>)."
14296 #: ../src/guestfs-actions.pod:4130
14297 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14302 #: ../src/guestfs-actions.pod:4138
14303 msgid "guestfs_lvs_full"
14308 #: ../src/guestfs-actions.pod:4140
14311 " struct guestfs_lvm_lv_list *\n"
14312 " guestfs_lvs_full (guestfs_h *g);\n"
14318 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:2840
14320 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14321 "(8)> command. The \"full\" version includes all fields."
14326 #: ../src/guestfs-actions.pod:4146
14328 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14329 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14334 #: ../src/guestfs-actions.pod:4152
14335 msgid "guestfs_lvuuid"
14340 #: ../src/guestfs-actions.pod:4154
14344 " guestfs_lvuuid (guestfs_h *g,\n"
14345 " const char *device);\n"
14351 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2847
14352 msgid "This command returns the UUID of the LVM LV C<device>."
14357 #: ../src/guestfs-actions.pod:4165
14358 msgid "guestfs_lxattrlist"
14363 #: ../src/guestfs-actions.pod:4167
14366 " struct guestfs_xattr_list *\n"
14367 " guestfs_lxattrlist (guestfs_h *g,\n"
14368 " const char *path,\n"
14369 " char *const *names);\n"
14375 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2853
14377 "This call allows you to get the extended attributes of multiple files, where "
14378 "all files are in the directory C<path>. C<names> is the list of files from "
14384 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2857
14386 "On return you get a flat list of xattr structs which must be interpreted "
14387 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14388 "C<attrval> in this struct is zero-length to indicate there was an error "
14389 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14390 "number (the number of following attributes for this file, which could be C<"
14391 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14392 "for the first named file. This repeats for the second and subsequent files."
14397 #: ../src/guestfs-actions.pod:4186
14399 "This call is intended for programs that want to efficiently list a directory "
14400 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14401 "a similarly efficient call for getting standard stats. Very long directory "
14402 "listings might cause the protocol message size to be exceeded, causing this "
14403 "call to fail. The caller must split up such requests into smaller groups of "
14409 #: ../src/guestfs-actions.pod:4200
14410 msgid "guestfs_mkdir"
14415 #: ../src/guestfs-actions.pod:4202
14419 " guestfs_mkdir (guestfs_h *g,\n"
14420 " const char *path);\n"
14426 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2879
14427 msgid "Create a directory named C<path>."
14432 #: ../src/guestfs-actions.pod:4212
14433 msgid "guestfs_mkdir_mode"
14438 #: ../src/guestfs-actions.pod:4214
14442 " guestfs_mkdir_mode (guestfs_h *g,\n"
14443 " const char *path,\n"
14450 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
14452 "This command creates a directory, setting the initial permissions of the "
14453 "directory to C<mode>."
14458 #: ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2888
14460 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14461 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14467 #: ../src/guestfs-actions.pod:4226
14468 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14473 #: ../src/guestfs-actions.pod:4232
14474 msgid "guestfs_mkdir_p"
14479 #: ../src/guestfs-actions.pod:4234
14483 " guestfs_mkdir_p (guestfs_h *g,\n"
14484 " const char *path);\n"
14490 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:2898
14492 "Create a directory named C<path>, creating any parent directories as "
14493 "necessary. This is like the C<mkdir -p> shell command."
14498 #: ../src/guestfs-actions.pod:4245
14499 msgid "guestfs_mkdtemp"
14504 #: ../src/guestfs-actions.pod:4247
14508 " guestfs_mkdtemp (guestfs_h *g,\n"
14509 " const char *template);\n"
14515 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
14517 "This command creates a temporary directory. The C<template> parameter "
14518 "should be a full pathname for the temporary directory name with the final "
14519 "six characters being \"XXXXXX\"."
14524 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
14526 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14527 "being suitable for Windows filesystems."
14532 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
14533 msgid "The name of the temporary directory that was created is returned."
14538 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
14539 msgid "The temporary directory is created with mode 0700 and is owned by root."
14544 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
14546 "The caller is responsible for deleting the temporary directory and its "
14547 "contents after use."
14552 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2922
14553 msgid "See also: L<mkdtemp(3)>"
14558 #: ../src/guestfs-actions.pod:4275
14559 msgid "guestfs_mke2fs_J"
14564 #: ../src/guestfs-actions.pod:4277
14568 " guestfs_mke2fs_J (guestfs_h *g,\n"
14569 " const char *fstype,\n"
14570 " int blocksize,\n"
14571 " const char *device,\n"
14572 " const char *journal);\n"
14578 #: ../src/guestfs-actions.pod:4284 ../fish/guestfish-actions.pod:2928
14580 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14581 "C<journal>. It is equivalent to the command:"
14586 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2932
14589 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14595 #: ../src/guestfs-actions.pod:4290
14596 msgid "See also C<guestfs_mke2journal>."
14601 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312
14602 #: ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346
14603 #: ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374
14604 #: ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4698
14605 msgid "(Added in 1.0.68)"
14610 #: ../src/guestfs-actions.pod:4296
14611 msgid "guestfs_mke2fs_JL"
14616 #: ../src/guestfs-actions.pod:4298
14620 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14621 " const char *fstype,\n"
14622 " int blocksize,\n"
14623 " const char *device,\n"
14624 " const char *label);\n"
14630 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2940
14632 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14633 "the journal labeled C<label>."
14638 #: ../src/guestfs-actions.pod:4308
14639 msgid "See also C<guestfs_mke2journal_L>."
14644 #: ../src/guestfs-actions.pod:4314
14645 msgid "guestfs_mke2fs_JU"
14650 #: ../src/guestfs-actions.pod:4316
14654 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14655 " const char *fstype,\n"
14656 " int blocksize,\n"
14657 " const char *device,\n"
14658 " const char *uuid);\n"
14664 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2949
14666 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14667 "the journal with UUID C<uuid>."
14672 #: ../src/guestfs-actions.pod:4326
14673 msgid "See also C<guestfs_mke2journal_U>."
14678 #: ../src/guestfs-actions.pod:4332
14679 msgid "guestfs_mke2journal"
14684 #: ../src/guestfs-actions.pod:4334
14688 " guestfs_mke2journal (guestfs_h *g,\n"
14689 " int blocksize,\n"
14690 " const char *device);\n"
14696 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
14698 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14704 #: ../src/guestfs-actions.pod:4342 ../fish/guestfish-actions.pod:2961
14707 " mke2fs -O journal_dev -b blocksize device\n"
14713 #: ../src/guestfs-actions.pod:4348
14714 msgid "guestfs_mke2journal_L"
14719 #: ../src/guestfs-actions.pod:4350
14723 " guestfs_mke2journal_L (guestfs_h *g,\n"
14724 " int blocksize,\n"
14725 " const char *label,\n"
14726 " const char *device);\n"
14732 #: ../src/guestfs-actions.pod:4356 ../fish/guestfish-actions.pod:2967
14733 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14738 #: ../src/guestfs-actions.pod:4362
14739 msgid "guestfs_mke2journal_U"
14744 #: ../src/guestfs-actions.pod:4364
14748 " guestfs_mke2journal_U (guestfs_h *g,\n"
14749 " int blocksize,\n"
14750 " const char *uuid,\n"
14751 " const char *device);\n"
14757 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2973
14758 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14763 #: ../src/guestfs-actions.pod:4376
14764 msgid "guestfs_mkfifo"
14769 #: ../src/guestfs-actions.pod:4378
14773 " guestfs_mkfifo (guestfs_h *g,\n"
14775 " const char *path);\n"
14781 #: ../src/guestfs-actions.pod:4383
14783 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14784 "is just a convenient wrapper around C<guestfs_mknod>."
14789 #: ../src/guestfs-actions.pod:4393
14790 msgid "guestfs_mkfs"
14795 #: ../src/guestfs-actions.pod:4395
14799 " guestfs_mkfs (guestfs_h *g,\n"
14800 " const char *fstype,\n"
14801 " const char *device);\n"
14807 #: ../src/guestfs-actions.pod:4400 ../fish/guestfish-actions.pod:2989
14809 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14810 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14815 #: ../src/guestfs-actions.pod:4408
14816 msgid "guestfs_mkfs_b"
14821 #: ../src/guestfs-actions.pod:4410
14825 " guestfs_mkfs_b (guestfs_h *g,\n"
14826 " const char *fstype,\n"
14827 " int blocksize,\n"
14828 " const char *device);\n"
14834 #: ../src/guestfs-actions.pod:4416
14836 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14837 "block size of the resulting filesystem. Supported block sizes depend on the "
14838 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14843 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4464
14844 #: ../fish/guestfish-actions.pod:3002 ../fish/guestfish-actions.pod:3029
14846 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14852 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:3005
14854 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14859 #: ../src/guestfs-actions.pod:4435
14860 msgid "guestfs_mkfs_opts"
14865 #: ../src/guestfs-actions.pod:4437
14869 " guestfs_mkfs_opts (guestfs_h *g,\n"
14870 " const char *fstype,\n"
14871 " const char *device,\n"
14877 #: ../src/guestfs-actions.pod:4448
14880 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14881 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14887 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3016
14889 "This function creates a filesystem on C<device>. The filesystem type is "
14890 "C<fstype>, for example C<ext3>."
14895 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:3023
14896 msgid "C<blocksize>"
14901 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
14903 "The filesystem block size. Supported block sizes depend on the filesystem "
14904 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14909 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:3032
14910 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14914 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
14915 msgid "C<features>"
14919 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
14920 msgid "This passes the C<-O> parameter to the external mkfs program."
14924 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
14926 "For certain filesystem types, this allows extra filesystem features to be "
14927 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14931 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3042
14933 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14938 #: ../src/guestfs-actions.pod:4484
14939 msgid "(Added in 1.7.19)"
14944 #: ../src/guestfs-actions.pod:4486
14945 msgid "guestfs_mkfs_opts_va"
14950 #: ../src/guestfs-actions.pod:4488
14954 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14955 " const char *fstype,\n"
14956 " const char *device,\n"
14957 " va_list args);\n"
14963 #: ../src/guestfs-actions.pod:4494
14964 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14969 #: ../src/guestfs-actions.pod:4498
14970 msgid "guestfs_mkfs_opts_argv"
14975 #: ../src/guestfs-actions.pod:4500
14979 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14980 " const char *fstype,\n"
14981 " const char *device,\n"
14982 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14988 #: ../src/guestfs-actions.pod:4506
14989 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14994 #: ../src/guestfs-actions.pod:4510
14995 msgid "guestfs_mkmountpoint"
15000 #: ../src/guestfs-actions.pod:4512
15004 " guestfs_mkmountpoint (guestfs_h *g,\n"
15005 " const char *exemptpath);\n"
15011 #: ../src/guestfs-actions.pod:4516
15013 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15014 "that can be used to create extra mountpoints before mounting the first "
15020 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3057
15022 "These calls are I<only> necessary in some very limited circumstances, mainly "
15023 "the case where you want to mount a mix of unrelated and/or read-only "
15024 "filesystems together."
15029 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3061
15031 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15032 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15033 "inside that. You can unpack this as follows in guestfish:"
15038 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3066
15041 " add-ro Fedora-11-i686-Live.iso\n"
15043 " mkmountpoint /cd\n"
15044 " mkmountpoint /sqsh\n"
15045 " mkmountpoint /ext3fs\n"
15046 " mount /dev/sda /cd\n"
15047 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15048 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15054 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3075
15055 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15060 #: ../src/guestfs-actions.pod:4540
15062 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15063 "may get unexpected errors if you try to mix these calls. It is safest to "
15064 "manually unmount filesystems and remove mountpoints after use."
15069 #: ../src/guestfs-actions.pod:4544
15071 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15072 "first, so for this to work for manual mountpoints, you must ensure that the "
15073 "innermost mountpoints have the longest pathnames, as in the example code "
15079 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3086
15081 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15085 #: ../src/guestfs-actions.pod:4551
15087 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15088 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15089 "can also trigger these issues."
15094 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4816
15095 #: ../src/guestfs-actions.pod:5726
15096 msgid "(Added in 1.0.62)"
15101 #: ../src/guestfs-actions.pod:4559
15102 msgid "guestfs_mknod"
15107 #: ../src/guestfs-actions.pod:4561
15111 " guestfs_mknod (guestfs_h *g,\n"
15115 " const char *path);\n"
15121 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
15123 "This call creates block or character special devices, or named pipes (FIFOs)."
15128 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3099
15130 "The C<mode> parameter should be the mode, using the standard constants. "
15131 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15132 "used when creating block and character special devices."
15137 #: ../src/guestfs-actions.pod:4576
15139 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15140 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15141 "regular file). These constants are available in the standard Linux header "
15142 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15143 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15144 "the appropriate constant for you."
15149 #: ../src/guestfs-actions.pod:4590
15150 msgid "guestfs_mknod_b"
15155 #: ../src/guestfs-actions.pod:4592
15159 " guestfs_mknod_b (guestfs_h *g,\n"
15163 " const char *path);\n"
15169 #: ../src/guestfs-actions.pod:4599
15171 "This call creates a block device node called C<path> with mode C<mode> and "
15172 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15173 "wrapper around C<guestfs_mknod>."
15178 #: ../src/guestfs-actions.pod:4609
15179 msgid "guestfs_mknod_c"
15184 #: ../src/guestfs-actions.pod:4611
15188 " guestfs_mknod_c (guestfs_h *g,\n"
15192 " const char *path);\n"
15198 #: ../src/guestfs-actions.pod:4618
15200 "This call creates a char device node called C<path> with mode C<mode> and "
15201 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15202 "wrapper around C<guestfs_mknod>."
15207 #: ../src/guestfs-actions.pod:4628
15208 msgid "guestfs_mkswap"
15213 #: ../src/guestfs-actions.pod:4630
15217 " guestfs_mkswap (guestfs_h *g,\n"
15218 " const char *device);\n"
15224 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3138
15225 msgid "Create a swap partition on C<device>."
15230 #: ../src/guestfs-actions.pod:4640
15231 msgid "guestfs_mkswap_L"
15236 #: ../src/guestfs-actions.pod:4642
15240 " guestfs_mkswap_L (guestfs_h *g,\n"
15241 " const char *label,\n"
15242 " const char *device);\n"
15248 #: ../src/guestfs-actions.pod:4647 ../fish/guestfish-actions.pod:3144
15249 msgid "Create a swap partition on C<device> with label C<label>."
15254 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
15256 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15257 "sda>), just to a partition. This appears to be a limitation of the kernel "
15263 #: ../src/guestfs-actions.pod:4657
15264 msgid "guestfs_mkswap_U"
15269 #: ../src/guestfs-actions.pod:4659
15273 " guestfs_mkswap_U (guestfs_h *g,\n"
15274 " const char *uuid,\n"
15275 " const char *device);\n"
15281 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3154
15282 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15287 #: ../src/guestfs-actions.pod:4670
15288 msgid "guestfs_mkswap_file"
15293 #: ../src/guestfs-actions.pod:4672
15297 " guestfs_mkswap_file (guestfs_h *g,\n"
15298 " const char *path);\n"
15304 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3160
15305 msgid "Create a swap file."
15310 #: ../src/guestfs-actions.pod:4678
15312 "This command just writes a swap file signature to an existing file. To "
15313 "create the file itself, use something like C<guestfs_fallocate>."
15318 #: ../src/guestfs-actions.pod:4685
15319 msgid "guestfs_modprobe"
15324 #: ../src/guestfs-actions.pod:4687
15328 " guestfs_modprobe (guestfs_h *g,\n"
15329 " const char *modulename);\n"
15335 #: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3169
15336 msgid "This loads a kernel module in the appliance."
15341 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
15343 "The kernel module must have been whitelisted when libguestfs was built (see "
15344 "C<appliance/kmod.whitelist.in> in the source)."
15349 #: ../src/guestfs-actions.pod:4700
15350 msgid "guestfs_mount"
15355 #: ../src/guestfs-actions.pod:4702
15359 " guestfs_mount (guestfs_h *g,\n"
15360 " const char *device,\n"
15361 " const char *mountpoint);\n"
15367 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3178
15369 "Mount a guest disk at a position in the filesystem. Block devices are named "
15370 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15371 "those block devices contain partitions, they will have the usual names (eg. "
15372 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15377 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3184
15379 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15380 "mounted on C</> before others can be mounted. Other filesystems can only be "
15381 "mounted on directories which already exist."
15386 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3189
15388 "The mounted filesystem is writable, if we have sufficient permissions on the "
15389 "underlying device."
15394 #: ../src/guestfs-actions.pod:4721
15396 "B<Important note:> When you use this call, the filesystem options C<sync> "
15397 "and C<noatime> are set implicitly. This was originally done because we "
15398 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15399 "very large negative performance impact and negligible effect on "
15400 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15401 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15402 "(use an empty string for the first parameter if you don't want any options)."
15407 #: ../src/guestfs-actions.pod:4735
15408 msgid "guestfs_mount_loop"
15413 #: ../src/guestfs-actions.pod:4737
15417 " guestfs_mount_loop (guestfs_h *g,\n"
15418 " const char *file,\n"
15419 " const char *mountpoint);\n"
15425 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3206
15427 "This command lets you mount C<file> (a filesystem image in a file) on a "
15428 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15434 #: ../src/guestfs-actions.pod:4750
15435 msgid "guestfs_mount_options"
15440 #: ../src/guestfs-actions.pod:4752
15444 " guestfs_mount_options (guestfs_h *g,\n"
15445 " const char *options,\n"
15446 " const char *device,\n"
15447 " const char *mountpoint);\n"
15453 #: ../src/guestfs-actions.pod:4758
15455 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15456 "the mount options as for the L<mount(8)> I<-o> flag."
15461 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3218
15463 "If the C<options> parameter is an empty string, then no options are passed "
15464 "(all options default to whatever the filesystem uses)."
15469 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4782
15470 #: ../src/guestfs-actions.pod:4799
15471 msgid "(Added in 1.0.10)"
15476 #: ../src/guestfs-actions.pod:4770
15477 msgid "guestfs_mount_ro"
15482 #: ../src/guestfs-actions.pod:4772
15486 " guestfs_mount_ro (guestfs_h *g,\n"
15487 " const char *device,\n"
15488 " const char *mountpoint);\n"
15494 #: ../src/guestfs-actions.pod:4777
15496 "This is the same as the C<guestfs_mount> command, but it mounts the "
15497 "filesystem with the read-only (I<-o ro>) flag."
15502 #: ../src/guestfs-actions.pod:4784
15503 msgid "guestfs_mount_vfs"
15508 #: ../src/guestfs-actions.pod:4786
15512 " guestfs_mount_vfs (guestfs_h *g,\n"
15513 " const char *options,\n"
15514 " const char *vfstype,\n"
15515 " const char *device,\n"
15516 " const char *mountpoint);\n"
15522 #: ../src/guestfs-actions.pod:4793
15524 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15525 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15531 #: ../src/guestfs-actions.pod:4801
15532 msgid "guestfs_mountpoints"
15537 #: ../src/guestfs-actions.pod:4803
15541 " guestfs_mountpoints (guestfs_h *g);\n"
15547 #: ../src/guestfs-actions.pod:4806
15549 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15550 "devices. This one returns a hash table (map) of device name to directory "
15551 "where the device is mounted."
15556 #: ../src/guestfs-actions.pod:4818
15557 msgid "guestfs_mounts"
15562 #: ../src/guestfs-actions.pod:4820
15566 " guestfs_mounts (guestfs_h *g);\n"
15572 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3249
15574 "This returns the list of currently mounted filesystems. It returns the list "
15575 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15580 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3252
15581 msgid "Some internal mounts are not shown."
15586 #: ../src/guestfs-actions.pod:4828
15587 msgid "See also: C<guestfs_mountpoints>"
15592 #: ../src/guestfs-actions.pod:4836
15598 #: ../src/guestfs-actions.pod:4838
15602 " guestfs_mv (guestfs_h *g,\n"
15603 " const char *src,\n"
15604 " const char *dest);\n"
15610 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3260
15612 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15613 "destination filename or destination directory."
15618 #: ../src/guestfs-actions.pod:4850
15619 msgid "guestfs_ntfs_3g_probe"
15624 #: ../src/guestfs-actions.pod:4852
15628 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15630 " const char *device);\n"
15636 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
15638 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15639 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15640 "write, and some cannot be mounted at all)."
15645 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
15647 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15648 "can be mounted read-write. Set it to false if you want to test if the "
15649 "volume can be mounted read-only."
15654 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
15656 "The return value is an integer which C<0> if the operation would succeed, or "
15657 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15662 #: ../src/guestfs-actions.pod:4871
15663 msgid "(Added in 1.0.43)"
15668 #: ../src/guestfs-actions.pod:4873
15669 msgid "guestfs_ntfsresize"
15674 #: ../src/guestfs-actions.pod:4875
15678 " guestfs_ntfsresize (guestfs_h *g,\n"
15679 " const char *device);\n"
15685 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3283
15687 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15688 "size of the underlying device. See also L<ntfsresize(8)>."
15693 #: ../src/guestfs-actions.pod:4887
15694 msgid "guestfs_ntfsresize_size"
15699 #: ../src/guestfs-actions.pod:4889
15703 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15704 " const char *device,\n"
15705 " int64_t size);\n"
15711 #: ../src/guestfs-actions.pod:4894
15713 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15714 "to specify the new size (in bytes) explicitly."
15719 #: ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:5335
15720 #: ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5674
15721 #: ../src/guestfs-actions.pod:7245
15722 msgid "(Added in 1.3.14)"
15727 #: ../src/guestfs-actions.pod:4901
15728 msgid "guestfs_part_add"
15733 #: ../src/guestfs-actions.pod:4903
15737 " guestfs_part_add (guestfs_h *g,\n"
15738 " const char *device,\n"
15739 " const char *prlogex,\n"
15740 " int64_t startsect,\n"
15741 " int64_t endsect);\n"
15747 #: ../src/guestfs-actions.pod:4910
15749 "This command adds a partition to C<device>. If there is no partition table "
15750 "on the device, call C<guestfs_part_init> first."
15755 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3301
15757 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15758 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15759 "C<logical>) and C<e> (or C<extended>) partition types."
15764 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3306
15766 "C<startsect> and C<endsect> are the start and end of the partition in "
15767 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15768 "from the end of the disk (C<-1> is the last sector)."
15773 #: ../src/guestfs-actions.pod:4922
15775 "Creating a partition which covers the whole disk is not so easy. Use "
15776 "C<guestfs_part_disk> to do that."
15781 #: ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:4965
15782 #: ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5096
15783 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5153
15784 #: ../src/guestfs-actions.pod:5193
15785 msgid "(Added in 1.0.78)"
15790 #: ../src/guestfs-actions.pod:4929
15791 msgid "guestfs_part_del"
15796 #: ../src/guestfs-actions.pod:4931
15800 " guestfs_part_del (guestfs_h *g,\n"
15801 " const char *device,\n"
15808 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3317
15809 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15814 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3319
15816 "Note that in the case of MBR partitioning, deleting an extended partition "
15817 "also deletes any logical partitions it contains."
15822 #: ../src/guestfs-actions.pod:4946
15823 msgid "guestfs_part_disk"
15828 #: ../src/guestfs-actions.pod:4948
15832 " guestfs_part_disk (guestfs_h *g,\n"
15833 " const char *device,\n"
15834 " const char *parttype);\n"
15840 #: ../src/guestfs-actions.pod:4953
15842 "This command is simply a combination of C<guestfs_part_init> followed by "
15843 "C<guestfs_part_add> to create a single primary partition covering the whole "
15849 #: ../src/guestfs-actions.pod:4957
15851 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15852 "possible values are described in C<guestfs_part_init>."
15857 #: ../src/guestfs-actions.pod:4967
15858 msgid "guestfs_part_get_bootable"
15863 #: ../src/guestfs-actions.pod:4969
15867 " guestfs_part_get_bootable (guestfs_h *g,\n"
15868 " const char *device,\n"
15875 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3341
15877 "This command returns true if the partition C<partnum> on C<device> has the "
15878 "bootable flag set."
15883 #: ../src/guestfs-actions.pod:4977
15884 msgid "See also C<guestfs_part_set_bootable>."
15889 #: ../src/guestfs-actions.pod:4983
15890 msgid "guestfs_part_get_mbr_id"
15895 #: ../src/guestfs-actions.pod:4985
15899 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15900 " const char *device,\n"
15907 #: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3350
15909 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15910 "partition C<partnum>."
15915 #: ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5169
15917 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15918 "undefined results for other partition table types (see "
15919 "C<guestfs_part_get_parttype>)."
15924 #: ../src/guestfs-actions.pod:5001
15925 msgid "guestfs_part_get_parttype"
15930 #: ../src/guestfs-actions.pod:5003
15934 " guestfs_part_get_parttype (guestfs_h *g,\n"
15935 " const char *device);\n"
15941 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3361
15943 "This command examines the partition table on C<device> and returns the "
15944 "partition table type (format) being used."
15949 #: ../src/guestfs-actions.pod:5010
15951 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15952 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15953 "possible, although unusual. See C<guestfs_part_init> for a full list."
15958 #: ../src/guestfs-actions.pod:5020
15959 msgid "guestfs_part_init"
15964 #: ../src/guestfs-actions.pod:5022
15968 " guestfs_part_init (guestfs_h *g,\n"
15969 " const char *device,\n"
15970 " const char *parttype);\n"
15976 #: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3373
15978 "This creates an empty partition table on C<device> of one of the partition "
15979 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15980 "(for large disks)."
15985 #: ../src/guestfs-actions.pod:5031
15987 "Initially there are no partitions. Following this, you should call "
15988 "C<guestfs_part_add> for each partition required."
15993 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
15994 msgid "Possible values for C<parttype> are:"
15999 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
16000 msgid "B<efi> | B<gpt>"
16005 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
16006 msgid "Intel EFI / GPT partition table."
16011 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3388
16013 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16014 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16015 "the C<mbr> format."
16020 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3392
16021 msgid "B<mbr> | B<msdos>"
16026 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3394
16028 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16029 "Windows. This partition type will B<only> work for device sizes up to 2 "
16030 "TB. For large disks we recommend using C<gpt>."
16035 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
16037 "Other partition table types that may work but are not supported include:"
16042 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
16048 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
16049 msgid "AIX disk labels."
16054 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
16055 msgid "B<amiga> | B<rdb>"
16060 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
16061 msgid "Amiga \"Rigid Disk Block\" format."
16066 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
16072 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
16073 msgid "BSD disk labels."
16078 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
16084 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
16085 msgid "DASD, used on IBM mainframes."
16090 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
16096 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
16097 msgid "MIPS/SGI volumes."
16102 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
16108 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
16109 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16114 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
16120 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
16121 msgid "NEC PC-98 format, common in Japan apparently."
16126 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
16132 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
16133 msgid "Sun disk labels."
16138 #: ../src/guestfs-actions.pod:5098
16139 msgid "guestfs_part_list"
16144 #: ../src/guestfs-actions.pod:5100
16147 " struct guestfs_partition_list *\n"
16148 " guestfs_part_list (guestfs_h *g,\n"
16149 " const char *device);\n"
16155 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3444
16157 "This command parses the partition table on C<device> and returns the list of "
16158 "partitions found."
16163 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
16164 msgid "The fields in the returned structure are:"
16169 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3451
16170 msgid "B<part_num>"
16175 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3453
16176 msgid "Partition number, counting from 1."
16181 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3455
16182 msgid "B<part_start>"
16187 #: ../src/guestfs-actions.pod:5117
16189 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16190 "the device's sector size, see C<guestfs_blockdev_getss>."
16195 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
16196 msgid "B<part_end>"
16201 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
16202 msgid "End of the partition in bytes."
16207 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
16208 msgid "B<part_size>"
16213 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
16214 msgid "Size of the partition in bytes."
16219 #: ../src/guestfs-actions.pod:5130
16221 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16222 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16228 #: ../src/guestfs-actions.pod:5136
16229 msgid "guestfs_part_set_bootable"
16234 #: ../src/guestfs-actions.pod:5138
16238 " guestfs_part_set_bootable (guestfs_h *g,\n"
16239 " const char *device,\n"
16241 " int bootable);\n"
16247 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3474
16249 "This sets the bootable flag on partition numbered C<partnum> on device "
16250 "C<device>. Note that partitions are numbered from 1."
16255 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3477
16257 "The bootable flag is used by some operating systems (notably Windows) to "
16258 "determine which partition to boot from. It is by no means universally "
16264 #: ../src/guestfs-actions.pod:5155
16265 msgid "guestfs_part_set_mbr_id"
16270 #: ../src/guestfs-actions.pod:5157
16274 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16275 " const char *device,\n"
16283 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3485
16285 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16286 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16287 "documentation are in fact hexadecimal numbers, but usually documented "
16288 "without any leading \"0x\" which might be confusing."
16293 #: ../src/guestfs-actions.pod:5177
16294 msgid "guestfs_part_set_name"
16299 #: ../src/guestfs-actions.pod:5179
16303 " guestfs_part_set_name (guestfs_h *g,\n"
16304 " const char *device,\n"
16306 " const char *name);\n"
16312 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3499
16314 "This sets the partition name on partition numbered C<partnum> on device "
16315 "C<device>. Note that partitions are numbered from 1."
16320 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3502
16322 "The partition name can only be set on certain types of partition table. "
16323 "This works on C<gpt> but not on C<mbr> partitions."
16328 #: ../src/guestfs-actions.pod:5195
16329 msgid "guestfs_part_to_dev"
16334 #: ../src/guestfs-actions.pod:5197
16338 " guestfs_part_to_dev (guestfs_h *g,\n"
16339 " const char *partition);\n"
16345 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3509
16347 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16348 "partition number, returning the device name (eg. \"/dev/sdb\")."
16353 #: ../src/guestfs-actions.pod:5205
16355 "The named partition must exist, for example as a string returned from "
16356 "C<guestfs_list_partitions>."
16361 #: ../src/guestfs-actions.pod:5213
16362 msgid "guestfs_ping_daemon"
16367 #: ../src/guestfs-actions.pod:5215
16371 " guestfs_ping_daemon (guestfs_h *g);\n"
16377 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3520
16379 "This is a test probe into the guestfs daemon running inside the qemu "
16380 "subprocess. Calling this function checks that the daemon responds to the "
16381 "ping message, without affecting the daemon or attached block device(s) in "
16387 #: ../src/guestfs-actions.pod:5227
16388 msgid "guestfs_pread"
16393 #: ../src/guestfs-actions.pod:5229
16397 " guestfs_pread (guestfs_h *g,\n"
16398 " const char *path,\n"
16400 " int64_t offset,\n"
16401 " size_t *size_r);\n"
16407 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3529
16409 "This command lets you read part of a file. It reads C<count> bytes of the "
16410 "file, starting at C<offset>, from file C<path>."
16415 #: ../src/guestfs-actions.pod:5239 ../src/guestfs-actions.pod:5265
16416 #: ../fish/guestfish-actions.pod:3532 ../fish/guestfish-actions.pod:3547
16418 "This may read fewer bytes than requested. For further details see the "
16419 "L<pread(2)> system call."
16424 #: ../src/guestfs-actions.pod:5242
16425 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16430 #: ../src/guestfs-actions.pod:5253
16431 msgid "guestfs_pread_device"
16436 #: ../src/guestfs-actions.pod:5255
16440 " guestfs_pread_device (guestfs_h *g,\n"
16441 " const char *device,\n"
16443 " int64_t offset,\n"
16444 " size_t *size_r);\n"
16450 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3544
16452 "This command lets you read part of a file. It reads C<count> bytes of "
16453 "C<device>, starting at C<offset>."
16458 #: ../src/guestfs-actions.pod:5268
16459 msgid "See also C<guestfs_pread>."
16464 #: ../src/guestfs-actions.pod:5277
16465 msgid "(Added in 1.5.21)"
16470 #: ../src/guestfs-actions.pod:5279
16471 msgid "guestfs_pvcreate"
16476 #: ../src/guestfs-actions.pod:5281
16480 " guestfs_pvcreate (guestfs_h *g,\n"
16481 " const char *device);\n"
16487 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3559
16489 "This creates an LVM physical volume on the named C<device>, where C<device> "
16490 "should usually be a partition name such as C</dev/sda1>."
16495 #: ../src/guestfs-actions.pod:5293
16496 msgid "guestfs_pvremove"
16501 #: ../src/guestfs-actions.pod:5295
16505 " guestfs_pvremove (guestfs_h *g,\n"
16506 " const char *device);\n"
16512 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3567
16514 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16520 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3570
16522 "The implementation uses the C<pvremove> command which refuses to wipe "
16523 "physical volumes that contain any volume groups, so you have to remove those "
16529 #: ../src/guestfs-actions.pod:5310
16530 msgid "guestfs_pvresize"
16535 #: ../src/guestfs-actions.pod:5312
16539 " guestfs_pvresize (guestfs_h *g,\n"
16540 " const char *device);\n"
16546 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3578
16548 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16549 "the new size of the underlying device."
16554 #: ../src/guestfs-actions.pod:5323
16555 msgid "guestfs_pvresize_size"
16560 #: ../src/guestfs-actions.pod:5325
16564 " guestfs_pvresize_size (guestfs_h *g,\n"
16565 " const char *device,\n"
16566 " int64_t size);\n"
16572 #: ../src/guestfs-actions.pod:5330
16574 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16575 "specify the new size (in bytes) explicitly."
16580 #: ../src/guestfs-actions.pod:5337
16581 msgid "guestfs_pvs"
16586 #: ../src/guestfs-actions.pod:5339
16590 " guestfs_pvs (guestfs_h *g);\n"
16596 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3592
16598 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16604 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3595
16606 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16612 #: ../src/guestfs-actions.pod:5348
16613 msgid "See also C<guestfs_pvs_full>."
16618 #: ../src/guestfs-actions.pod:5356
16619 msgid "guestfs_pvs_full"
16624 #: ../src/guestfs-actions.pod:5358
16627 " struct guestfs_lvm_pv_list *\n"
16628 " guestfs_pvs_full (guestfs_h *g);\n"
16634 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3604
16636 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16637 "(8)> command. The \"full\" version includes all fields."
16642 #: ../src/guestfs-actions.pod:5364
16644 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16645 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16650 #: ../src/guestfs-actions.pod:5370
16651 msgid "guestfs_pvuuid"
16656 #: ../src/guestfs-actions.pod:5372
16660 " guestfs_pvuuid (guestfs_h *g,\n"
16661 " const char *device);\n"
16667 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3611
16668 msgid "This command returns the UUID of the LVM PV C<device>."
16673 #: ../src/guestfs-actions.pod:5383
16674 msgid "guestfs_pwrite"
16679 #: ../src/guestfs-actions.pod:5385
16683 " guestfs_pwrite (guestfs_h *g,\n"
16684 " const char *path,\n"
16685 " const char *content,\n"
16686 " size_t content_size,\n"
16687 " int64_t offset);\n"
16693 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3617
16695 "This command writes to part of a file. It writes the data buffer C<content> "
16696 "to the file C<path> starting at offset C<offset>."
16701 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3620
16703 "This command implements the L<pwrite(2)> system call, and like that system "
16704 "call it may not write the full data requested. The return value is the "
16705 "number of bytes that were actually written to the file. This could even be "
16706 "0, although short writes are unlikely for regular files in ordinary "
16712 #: ../src/guestfs-actions.pod:5401
16713 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16718 #: ../src/guestfs-actions.pod:5410
16719 msgid "guestfs_pwrite_device"
16724 #: ../src/guestfs-actions.pod:5412
16728 " guestfs_pwrite_device (guestfs_h *g,\n"
16729 " const char *device,\n"
16730 " const char *content,\n"
16731 " size_t content_size,\n"
16732 " int64_t offset);\n"
16738 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3635
16740 "This command writes to part of a device. It writes the data buffer "
16741 "C<content> to C<device> starting at offset C<offset>."
16746 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
16748 "This command implements the L<pwrite(2)> system call, and like that system "
16749 "call it may not write the full data requested (although short writes to disk "
16750 "devices and partitions are probably impossible with standard Linux kernels)."
16755 #: ../src/guestfs-actions.pod:5427
16756 msgid "See also C<guestfs_pwrite>."
16761 #: ../src/guestfs-actions.pod:5434
16762 msgid "(Added in 1.5.20)"
16767 #: ../src/guestfs-actions.pod:5436
16768 msgid "guestfs_read_file"
16773 #: ../src/guestfs-actions.pod:5438
16777 " guestfs_read_file (guestfs_h *g,\n"
16778 " const char *path,\n"
16779 " size_t *size_r);\n"
16785 #: ../src/guestfs-actions.pod:5443 ../fish/guestfish-actions.pod:3652
16786 msgid "This calls returns the contents of the file C<path> as a buffer."
16791 #: ../src/guestfs-actions.pod:5446
16793 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16794 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16795 "function is limited in the total size of file that can be handled."
16800 #: ../src/guestfs-actions.pod:5458
16801 msgid "(Added in 1.0.63)"
16806 #: ../src/guestfs-actions.pod:5460
16807 msgid "guestfs_read_lines"
16812 #: ../src/guestfs-actions.pod:5462
16816 " guestfs_read_lines (guestfs_h *g,\n"
16817 " const char *path);\n"
16823 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3669
16825 "The file contents are returned as a list of lines. Trailing C<LF> and "
16826 "C<CRLF> character sequences are I<not> returned."
16831 #: ../src/guestfs-actions.pod:5471
16833 "Note that this function cannot correctly handle binary files (specifically, "
16834 "files containing C<\\0> character which is treated as end of line). For "
16835 "those you need to use the C<guestfs_read_file> function which has a more "
16836 "complex interface."
16841 #: ../src/guestfs-actions.pod:5482
16842 msgid "guestfs_readdir"
16847 #: ../src/guestfs-actions.pod:5484
16850 " struct guestfs_dirent_list *\n"
16851 " guestfs_readdir (guestfs_h *g,\n"
16852 " const char *dir);\n"
16858 #: ../src/guestfs-actions.pod:5488 ../fish/guestfish-actions.pod:3681
16859 msgid "This returns the list of directory entries in directory C<dir>."
16864 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:3683
16866 "All entries in the directory are returned, including C<.> and C<..>. The "
16867 "entries are I<not> sorted, but returned in the same order as the underlying "
16873 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3687
16875 "Also this call returns basic file type information about each file. The "
16876 "C<ftyp> field will contain one of the following characters:"
16881 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
16887 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
16888 msgid "Block special"
16893 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
16899 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
16900 msgid "Char special"
16905 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
16911 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
16917 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
16923 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
16924 msgid "FIFO (named pipe)"
16929 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
16935 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
16936 msgid "Symbolic link"
16941 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
16947 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
16948 msgid "Regular file"
16953 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
16959 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
16965 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
16971 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
16972 msgid "Unknown file type"
16977 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
16983 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
16985 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16990 #: ../src/guestfs-actions.pod:5538
16992 "This function is primarily intended for use by programs. To get a simple "
16993 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16994 "consumption, use C<guestfs_ll>."
16999 #: ../src/guestfs-actions.pod:5542
17001 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
17002 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
17007 #: ../src/guestfs-actions.pod:5548
17008 msgid "guestfs_readlink"
17013 #: ../src/guestfs-actions.pod:5550
17017 " guestfs_readlink (guestfs_h *g,\n"
17018 " const char *path);\n"
17024 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3739
17025 msgid "This command reads the target of a symbolic link."
17030 #: ../src/guestfs-actions.pod:5561
17031 msgid "guestfs_readlinklist"
17036 #: ../src/guestfs-actions.pod:5563
17040 " guestfs_readlinklist (guestfs_h *g,\n"
17041 " const char *path,\n"
17042 " char *const *names);\n"
17048 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
17050 "This call allows you to do a C<readlink> operation on multiple files, where "
17051 "all files are in the directory C<path>. C<names> is the list of files from "
17057 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3749
17059 "On return you get a list of strings, with a one-to-one correspondence to the "
17060 "C<names> list. Each string is the value of the symbolic link."
17065 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3753
17067 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17068 "result string is the empty string C<\"\">. However the whole operation is "
17069 "completed even if there were C<readlink(2)> errors, and so you can call this "
17070 "function with names where you don't know if they are symbolic links already "
17071 "(albeit slightly less efficient)."
17076 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3760
17078 "This call is intended for programs that want to efficiently list a directory "
17079 "contents without making many round-trips. Very long directory listings "
17080 "might cause the protocol message size to be exceeded, causing this call to "
17081 "fail. The caller must split up such requests into smaller groups of names."
17086 #: ../src/guestfs-actions.pod:5596
17087 msgid "guestfs_realpath"
17092 #: ../src/guestfs-actions.pod:5598
17096 " guestfs_realpath (guestfs_h *g,\n"
17097 " const char *path);\n"
17103 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3771
17105 "Return the canonicalized absolute pathname of C<path>. The returned path "
17106 "has no C<.>, C<..> or symbolic link path elements."
17111 #: ../src/guestfs-actions.pod:5610
17112 msgid "guestfs_removexattr"
17117 #: ../src/guestfs-actions.pod:5612
17121 " guestfs_removexattr (guestfs_h *g,\n"
17122 " const char *xattr,\n"
17123 " const char *path);\n"
17129 #: ../src/guestfs-actions.pod:5617 ../fish/guestfish-actions.pod:3778
17131 "This call removes the extended attribute named C<xattr> of the file C<path>."
17136 #: ../src/guestfs-actions.pod:5620
17137 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17142 #: ../src/guestfs-actions.pod:5626
17143 msgid "guestfs_resize2fs"
17148 #: ../src/guestfs-actions.pod:5628
17152 " guestfs_resize2fs (guestfs_h *g,\n"
17153 " const char *device);\n"
17159 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3787
17161 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17162 "underlying device."
17167 #: ../src/guestfs-actions.pod:5635
17169 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17170 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17171 "sometimes gives an error about this and sometimes not. In any case, it is "
17172 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17176 #: ../src/guestfs-actions.pod:5645
17177 msgid "guestfs_resize2fs_M"
17181 #: ../src/guestfs-actions.pod:5647
17185 " guestfs_resize2fs_M (guestfs_h *g,\n"
17186 " const char *device);\n"
17191 #: ../src/guestfs-actions.pod:5651
17193 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17194 "resized to its minimum size. This works like the C<-M> option to the "
17195 "C<resize2fs> command."
17199 #: ../src/guestfs-actions.pod:5655
17201 "To get the resulting size of the filesystem you should call "
17202 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17203 "These two numbers, multiplied together, give the resulting size of the "
17204 "minimal filesystem in bytes."
17209 #: ../src/guestfs-actions.pod:5662
17210 msgid "guestfs_resize2fs_size"
17215 #: ../src/guestfs-actions.pod:5664
17219 " guestfs_resize2fs_size (guestfs_h *g,\n"
17220 " const char *device,\n"
17221 " int64_t size);\n"
17227 #: ../src/guestfs-actions.pod:5669
17229 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17230 "to specify the new size (in bytes) explicitly."
17235 #: ../src/guestfs-actions.pod:5676
17241 #: ../src/guestfs-actions.pod:5678
17245 " guestfs_rm (guestfs_h *g,\n"
17246 " const char *path);\n"
17252 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3820
17253 msgid "Remove the single file C<path>."
17258 #: ../src/guestfs-actions.pod:5688
17259 msgid "guestfs_rm_rf"
17264 #: ../src/guestfs-actions.pod:5690
17268 " guestfs_rm_rf (guestfs_h *g,\n"
17269 " const char *path);\n"
17275 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3826
17277 "Remove the file or directory C<path>, recursively removing the contents if "
17278 "its a directory. This is like the C<rm -rf> shell command."
17283 #: ../src/guestfs-actions.pod:5702
17284 msgid "guestfs_rmdir"
17289 #: ../src/guestfs-actions.pod:5704
17293 " guestfs_rmdir (guestfs_h *g,\n"
17294 " const char *path);\n"
17300 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3834
17301 msgid "Remove the single directory C<path>."
17306 #: ../src/guestfs-actions.pod:5714
17307 msgid "guestfs_rmmountpoint"
17312 #: ../src/guestfs-actions.pod:5716
17316 " guestfs_rmmountpoint (guestfs_h *g,\n"
17317 " const char *exemptpath);\n"
17323 #: ../src/guestfs-actions.pod:5720
17325 "This calls removes a mountpoint that was previously created with "
17326 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17331 #: ../src/guestfs-actions.pod:5728
17332 msgid "guestfs_scrub_device"
17337 #: ../src/guestfs-actions.pod:5730
17341 " guestfs_scrub_device (guestfs_h *g,\n"
17342 " const char *device);\n"
17348 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3848
17350 "This command writes patterns over C<device> to make data retrieval more "
17356 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5758
17357 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3851
17358 #: ../fish/guestfish-actions.pod:3866 ../fish/guestfish-actions.pod:3879
17360 "It is an interface to the L<scrub(1)> program. See that manual page for "
17366 #: ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:5763
17367 #: ../src/guestfs-actions.pod:5782
17368 msgid "(Added in 1.0.52)"
17373 #: ../src/guestfs-actions.pod:5747
17374 msgid "guestfs_scrub_file"
17379 #: ../src/guestfs-actions.pod:5749
17383 " guestfs_scrub_file (guestfs_h *g,\n"
17384 " const char *file);\n"
17390 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3861
17392 "This command writes patterns over a file to make data retrieval more "
17398 #: ../src/guestfs-actions.pod:5756 ../fish/guestfish-actions.pod:3864
17399 msgid "The file is I<removed> after scrubbing."
17404 #: ../src/guestfs-actions.pod:5765
17405 msgid "guestfs_scrub_freespace"
17410 #: ../src/guestfs-actions.pod:5767
17414 " guestfs_scrub_freespace (guestfs_h *g,\n"
17415 " const char *dir);\n"
17421 #: ../src/guestfs-actions.pod:5771
17423 "This command creates the directory C<dir> and then fills it with files until "
17424 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17425 "and deletes them. The intention is to scrub any free space on the partition "
17426 "containing C<dir>."
17431 #: ../src/guestfs-actions.pod:5784
17432 msgid "guestfs_set_append"
17437 #: ../src/guestfs-actions.pod:5786
17441 " guestfs_set_append (guestfs_h *g,\n"
17442 " const char *append);\n"
17448 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3888
17450 "This function is used to add additional options to the guest kernel command "
17456 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3891
17458 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17459 "environment variable."
17464 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3894
17466 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17467 "(libguestfs always adds a few of its own)."
17471 #: ../src/guestfs-actions.pod:5803
17472 msgid "guestfs_set_attach_method"
17476 #: ../src/guestfs-actions.pod:5805
17480 " guestfs_set_attach_method (guestfs_h *g,\n"
17481 " const char *attachmethod);\n"
17486 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3903
17488 "Set the method that libguestfs uses to connect to the back end guestfsd "
17489 "daemon. Possible methods are:"
17493 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3910
17495 "Launch an appliance and connect to it. This is the ordinary method and the "
17500 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3913
17501 msgid "C<unix:I<path>>"
17505 #: ../src/guestfs-actions.pod:5821 ../fish/guestfish-actions.pod:3915
17506 msgid "Connect to the Unix domain socket I<path>."
17510 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3917
17512 "This method lets you connect to an existing daemon or (using virtio-serial) "
17513 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17514 "RUNNING DAEMONS>."
17519 #: ../src/guestfs-actions.pod:5831
17520 msgid "guestfs_set_autosync"
17525 #: ../src/guestfs-actions.pod:5833
17529 " guestfs_set_autosync (guestfs_h *g,\n"
17530 " int autosync);\n"
17535 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3929
17537 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17538 "effort attempt to make filesystems consistent and synchronized when the "
17539 "handle is closed (also if the program exits without closing handles)."
17544 #: ../src/guestfs-actions.pod:5842 ../fish/guestfish-actions.pod:3934
17546 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17547 "disabled by default)."
17552 #: ../src/guestfs-actions.pod:5849
17553 msgid "guestfs_set_direct"
17558 #: ../src/guestfs-actions.pod:5851
17562 " guestfs_set_direct (guestfs_h *g,\n"
17569 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
17571 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17572 "passed directly through to the appliance once it is launched."
17577 #: ../src/guestfs-actions.pod:5859
17579 "One consequence of this is that log messages aren't caught by the library "
17580 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17586 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3951
17587 msgid "You probably don't want to use this unless you know what you are doing."
17592 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3954
17593 msgid "The default is disabled."
17598 #: ../src/guestfs-actions.pod:5872
17599 msgid "guestfs_set_e2label"
17604 #: ../src/guestfs-actions.pod:5874
17608 " guestfs_set_e2label (guestfs_h *g,\n"
17609 " const char *device,\n"
17610 " const char *label);\n"
17616 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3960
17618 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17619 "C<label>. Filesystem labels are limited to 16 characters."
17624 #: ../src/guestfs-actions.pod:5883
17626 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17627 "the existing label on a filesystem."
17632 #: ../src/guestfs-actions.pod:5890
17633 msgid "guestfs_set_e2uuid"
17638 #: ../src/guestfs-actions.pod:5892
17642 " guestfs_set_e2uuid (guestfs_h *g,\n"
17643 " const char *device,\n"
17644 " const char *uuid);\n"
17650 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3971
17652 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17653 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17654 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17659 #: ../src/guestfs-actions.pod:5902
17661 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17662 "the existing UUID of a filesystem."
17667 #: ../src/guestfs-actions.pod:5909
17668 msgid "guestfs_set_memsize"
17673 #: ../src/guestfs-actions.pod:5911
17677 " guestfs_set_memsize (guestfs_h *g,\n"
17684 #: ../src/guestfs-actions.pod:5915
17686 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17687 "This only has any effect if called before C<guestfs_launch>."
17692 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3989
17694 "You can also change this by setting the environment variable "
17695 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17700 #: ../src/guestfs-actions.pod:5930
17701 msgid "guestfs_set_network"
17706 #: ../src/guestfs-actions.pod:5932
17710 " guestfs_set_network (guestfs_h *g,\n"
17717 #: ../src/guestfs-actions.pod:5936 ../fish/guestfish-actions.pod:4002
17719 "If C<network> is true, then the network is enabled in the libguestfs "
17720 "appliance. The default is false."
17725 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:4005
17727 "This affects whether commands are able to access the network (see L<guestfs"
17728 "(3)/RUNNING COMMANDS>)."
17733 #: ../src/guestfs-actions.pod:5942
17735 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17741 #: ../src/guestfs-actions.pod:5949
17742 msgid "guestfs_set_path"
17747 #: ../src/guestfs-actions.pod:5951
17751 " guestfs_set_path (guestfs_h *g,\n"
17752 " const char *searchpath);\n"
17758 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4017
17759 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17764 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4019
17766 "The default is C<$libdir/guestfs> unless overridden by setting "
17767 "C<LIBGUESTFS_PATH> environment variable."
17772 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4022
17773 msgid "Setting C<path> to C<NULL> restores the default path."
17778 #: ../src/guestfs-actions.pod:5966
17779 msgid "guestfs_set_qemu"
17784 #: ../src/guestfs-actions.pod:5968
17788 " guestfs_set_qemu (guestfs_h *g,\n"
17789 " const char *qemu);\n"
17795 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
17796 msgid "Set the qemu binary that we will use."
17801 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
17803 "The default is chosen when the library was compiled by the configure script."
17808 #: ../src/guestfs-actions.pod:5977 ../fish/guestfish-actions.pod:4035
17810 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17816 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4038
17817 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17822 #: ../src/guestfs-actions.pod:5982 ../fish/guestfish-actions.pod:4040
17824 "Note that you should call this function as early as possible after creating "
17825 "the handle. This is because some pre-launch operations depend on testing "
17826 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17827 "don't retest features, and so you might see inconsistent results. Using the "
17828 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17829 "the qemu binary at the same time as the handle is created."
17834 #: ../src/guestfs-actions.pod:5994
17835 msgid "guestfs_set_recovery_proc"
17840 #: ../src/guestfs-actions.pod:5996
17844 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17845 " int recoveryproc);\n"
17851 #: ../src/guestfs-actions.pod:6000
17853 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17854 "not create a recovery process. The purpose of the recovery process is to "
17855 "stop runaway qemu processes in the case where the main program aborts "
17861 #: ../src/guestfs-actions.pod:6005
17863 "This only has any effect if called before C<guestfs_launch>, and the default "
17869 #: ../src/guestfs-actions.pod:6008 ../fish/guestfish-actions.pod:4062
17871 "About the only time when you would want to disable this is if the main "
17872 "process will fork itself into the background (\"daemonize\" itself). In "
17873 "this case the recovery process thinks that the main program has disappeared "
17874 "and so kills qemu, which is not very helpful."
17879 #: ../src/guestfs-actions.pod:6018
17880 msgid "guestfs_set_selinux"
17885 #: ../src/guestfs-actions.pod:6020
17889 " guestfs_set_selinux (guestfs_h *g,\n"
17896 #: ../src/guestfs-actions.pod:6024 ../fish/guestfish-actions.pod:4074
17898 "This sets the selinux flag that is passed to the appliance at boot time. "
17899 "The default is C<selinux=0> (disabled)."
17904 #: ../src/guestfs-actions.pod:6027 ../fish/guestfish-actions.pod:4077
17906 "Note that if SELinux is enabled, it is always in Permissive mode "
17907 "(C<enforcing=0>)."
17912 #: ../src/guestfs-actions.pod:6037
17913 msgid "guestfs_set_trace"
17918 #: ../src/guestfs-actions.pod:6039
17922 " guestfs_set_trace (guestfs_h *g,\n"
17928 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:4089
17930 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17931 "return values are traced."
17936 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4092
17938 "If you want to trace C API calls into libguestfs (and other libraries) then "
17939 "possibly a better way is to use the external ltrace(1) command."
17944 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4096
17946 "Command traces are disabled unless the environment variable "
17947 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17951 #: ../src/guestfs-actions.pod:6053
17953 "Trace messages are normally sent to C<stderr>, unless you register a "
17954 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17959 #: ../src/guestfs-actions.pod:6061
17960 msgid "guestfs_set_verbose"
17965 #: ../src/guestfs-actions.pod:6063
17969 " guestfs_set_verbose (guestfs_h *g,\n"
17975 #: ../src/guestfs-actions.pod:6067 ../fish/guestfish-actions.pod:4109
17976 msgid "If C<verbose> is true, this turns on verbose messages."
17981 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:4111
17983 "Verbose messages are disabled unless the environment variable "
17984 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17988 #: ../src/guestfs-actions.pod:6072
17990 "Verbose messages are normally sent to C<stderr>, unless you register a "
17991 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17996 #: ../src/guestfs-actions.pod:6080
17997 msgid "guestfs_setcon"
18002 #: ../src/guestfs-actions.pod:6082
18006 " guestfs_setcon (guestfs_h *g,\n"
18007 " const char *context);\n"
18013 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4122
18015 "This sets the SELinux security context of the daemon to the string "
18021 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4125
18022 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18027 #: ../src/guestfs-actions.pod:6095
18028 msgid "guestfs_setxattr"
18033 #: ../src/guestfs-actions.pod:6097
18037 " guestfs_setxattr (guestfs_h *g,\n"
18038 " const char *xattr,\n"
18039 " const char *val,\n"
18041 " const char *path);\n"
18047 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4131
18049 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18050 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18055 #: ../src/guestfs-actions.pod:6108
18056 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18061 #: ../src/guestfs-actions.pod:6114
18062 msgid "guestfs_sfdisk"
18067 #: ../src/guestfs-actions.pod:6116
18071 " guestfs_sfdisk (guestfs_h *g,\n"
18072 " const char *device,\n"
18076 " char *const *lines);\n"
18082 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4141
18084 "This is a direct interface to the L<sfdisk(8)> program for creating "
18085 "partitions on block devices."
18090 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4144
18091 msgid "C<device> should be a block device, for example C</dev/sda>."
18096 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
18098 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18099 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18100 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18101 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18102 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18103 "the kernel) cannot work out the right geometry and you will need to tell it."
18108 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
18110 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18111 "refer to the L<sfdisk(8)> manpage."
18116 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
18118 "To create a single partition occupying the whole disk, you would pass "
18119 "C<lines> as a single element list, when the single element being the string "
18125 #: ../src/guestfs-actions.pod:6144
18127 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18132 #: ../src/guestfs-actions.pod:6154
18133 msgid "guestfs_sfdiskM"
18138 #: ../src/guestfs-actions.pod:6156
18142 " guestfs_sfdiskM (guestfs_h *g,\n"
18143 " const char *device,\n"
18144 " char *const *lines);\n"
18150 #: ../src/guestfs-actions.pod:6161
18152 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18153 "partition sizes are specified in megabytes only (rounded to the nearest "
18154 "cylinder) and you don't need to specify the cyls, heads and sectors "
18155 "parameters which were rarely if ever used anyway."
18160 #: ../src/guestfs-actions.pod:6167
18162 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18163 "C<guestfs_part_disk>"
18168 #: ../src/guestfs-actions.pod:6177
18169 msgid "guestfs_sfdisk_N"
18174 #: ../src/guestfs-actions.pod:6179
18178 " guestfs_sfdisk_N (guestfs_h *g,\n"
18179 " const char *device,\n"
18184 " const char *line);\n"
18190 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4187
18192 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18193 "(note: C<n> counts from 1)."
18198 #: ../src/guestfs-actions.pod:6191
18200 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18201 "for the cyls/heads/sectors parameters."
18206 #: ../src/guestfs-actions.pod:6194
18207 msgid "See also: C<guestfs_part_add>"
18212 #: ../src/guestfs-actions.pod:6203
18213 msgid "guestfs_sfdisk_disk_geometry"
18218 #: ../src/guestfs-actions.pod:6205
18222 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18223 " const char *device);\n"
18229 #: ../src/guestfs-actions.pod:6209
18231 "This displays the disk geometry of C<device> read from the partition table. "
18232 "Especially in the case where the underlying block device has been resized, "
18233 "this can be different from the kernel's idea of the geometry (see "
18234 "C<guestfs_sfdisk_kernel_geometry>)."
18239 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6230
18240 #: ../fish/guestfish-actions.pod:4207 ../fish/guestfish-actions.pod:4216
18241 msgid "The result is in human-readable format, and not designed to be parsed."
18246 #: ../src/guestfs-actions.pod:6222
18247 msgid "guestfs_sfdisk_kernel_geometry"
18252 #: ../src/guestfs-actions.pod:6224
18256 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18257 " const char *device);\n"
18263 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4214
18264 msgid "This displays the kernel's idea of the geometry of C<device>."
18269 #: ../src/guestfs-actions.pod:6238
18270 msgid "guestfs_sfdisk_l"
18275 #: ../src/guestfs-actions.pod:6240
18279 " guestfs_sfdisk_l (guestfs_h *g,\n"
18280 " const char *device);\n"
18286 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4223
18288 "This displays the partition table on C<device>, in the human-readable output "
18289 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18294 #: ../src/guestfs-actions.pod:6248
18295 msgid "See also: C<guestfs_part_list>"
18300 #: ../src/guestfs-actions.pod:6255
18306 #: ../src/guestfs-actions.pod:6257
18310 " guestfs_sh (guestfs_h *g,\n"
18311 " const char *command);\n"
18317 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4233
18319 "This call runs a command from the guest filesystem via the guest's C</bin/"
18325 #: ../src/guestfs-actions.pod:6264
18326 msgid "This is like C<guestfs_command>, but passes the command to:"
18331 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4238
18334 " /bin/sh -c \"command\"\n"
18340 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4240
18342 "Depending on the guest's shell, this usually results in wildcards being "
18343 "expanded, shell expressions being interpolated and so on."
18348 #: ../src/guestfs-actions.pod:6272
18349 msgid "All the provisos about C<guestfs_command> apply to this call."
18354 #: ../src/guestfs-actions.pod:6279
18355 msgid "guestfs_sh_lines"
18360 #: ../src/guestfs-actions.pod:6281
18364 " guestfs_sh_lines (guestfs_h *g,\n"
18365 " const char *command);\n"
18371 #: ../src/guestfs-actions.pod:6285
18373 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18379 #: ../src/guestfs-actions.pod:6288
18380 msgid "See also: C<guestfs_command_lines>"
18385 #: ../src/guestfs-actions.pod:6296
18386 msgid "guestfs_sleep"
18391 #: ../src/guestfs-actions.pod:6298
18395 " guestfs_sleep (guestfs_h *g,\n"
18402 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4259
18403 msgid "Sleep for C<secs> seconds."
18408 #: ../src/guestfs-actions.pod:6306
18409 msgid "(Added in 1.0.41)"
18414 #: ../src/guestfs-actions.pod:6308 ../src/guestfs-structs.pod:109
18415 msgid "guestfs_stat"
18420 #: ../src/guestfs-actions.pod:6310
18423 " struct guestfs_stat *\n"
18424 " guestfs_stat (guestfs_h *g,\n"
18425 " const char *path);\n"
18431 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4267
18432 msgid "This is the same as the C<stat(2)> system call."
18437 #: ../src/guestfs-actions.pod:6324 ../src/guestfs-structs.pod:135
18438 msgid "guestfs_statvfs"
18443 #: ../src/guestfs-actions.pod:6326
18446 " struct guestfs_statvfs *\n"
18447 " guestfs_statvfs (guestfs_h *g,\n"
18448 " const char *path);\n"
18454 #: ../src/guestfs-actions.pod:6330 ../fish/guestfish-actions.pod:4273
18456 "Returns file system statistics for any mounted file system. C<path> should "
18457 "be a file or directory in the mounted file system (typically it is the mount "
18458 "point itself, but it doesn't need to be)."
18463 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4277
18464 msgid "This is the same as the C<statvfs(2)> system call."
18469 #: ../src/guestfs-actions.pod:6336
18471 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18472 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18477 #: ../src/guestfs-actions.pod:6342
18478 msgid "guestfs_strings"
18483 #: ../src/guestfs-actions.pod:6344
18487 " guestfs_strings (guestfs_h *g,\n"
18488 " const char *path);\n"
18494 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4283
18496 "This runs the L<strings(1)> command on a file and returns the list of "
18497 "printable strings found."
18502 #: ../src/guestfs-actions.pod:6360
18503 msgid "guestfs_strings_e"
18508 #: ../src/guestfs-actions.pod:6362
18512 " guestfs_strings_e (guestfs_h *g,\n"
18513 " const char *encoding,\n"
18514 " const char *path);\n"
18520 #: ../src/guestfs-actions.pod:6367
18522 "This is like the C<guestfs_strings> command, but allows you to specify the "
18523 "encoding of strings that are looked for in the source file C<path>."
18528 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4297
18529 msgid "Allowed encodings are:"
18534 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4301
18540 #: ../src/guestfs-actions.pod:6377
18542 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18543 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18548 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4306
18554 #: ../src/guestfs-actions.pod:6382 ../fish/guestfish-actions.pod:4308
18555 msgid "Single 8-bit-byte characters."
18560 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4310
18566 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
18567 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18572 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4315
18573 msgid "l (lower case letter L)"
18578 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4317
18580 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18581 "examining binaries in Windows guests."
18586 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4320
18592 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
18593 msgid "32-bit big endian such as UCS-4BE."
18598 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4324
18604 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4326
18605 msgid "32-bit little endian such as UCS-4LE."
18610 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4330
18611 msgid "The returned strings are transcoded to UTF-8."
18616 #: ../src/guestfs-actions.pod:6415
18617 msgid "guestfs_swapoff_device"
18622 #: ../src/guestfs-actions.pod:6417
18626 " guestfs_swapoff_device (guestfs_h *g,\n"
18627 " const char *device);\n"
18633 #: ../src/guestfs-actions.pod:6421
18635 "This command disables the libguestfs appliance swap device or partition "
18636 "named C<device>. See C<guestfs_swapon_device>."
18641 #: ../src/guestfs-actions.pod:6429
18642 msgid "guestfs_swapoff_file"
18647 #: ../src/guestfs-actions.pod:6431
18651 " guestfs_swapoff_file (guestfs_h *g,\n"
18652 " const char *file);\n"
18658 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4347
18659 msgid "This command disables the libguestfs appliance swap on file."
18664 #: ../src/guestfs-actions.pod:6441
18665 msgid "guestfs_swapoff_label"
18670 #: ../src/guestfs-actions.pod:6443
18674 " guestfs_swapoff_label (guestfs_h *g,\n"
18675 " const char *label);\n"
18681 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4353
18683 "This command disables the libguestfs appliance swap on labeled swap "
18689 #: ../src/guestfs-actions.pod:6454
18690 msgid "guestfs_swapoff_uuid"
18695 #: ../src/guestfs-actions.pod:6456
18699 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18700 " const char *uuid);\n"
18706 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4360
18708 "This command disables the libguestfs appliance swap partition with the given "
18714 #: ../src/guestfs-actions.pod:6467
18715 msgid "guestfs_swapon_device"
18720 #: ../src/guestfs-actions.pod:6469
18724 " guestfs_swapon_device (guestfs_h *g,\n"
18725 " const char *device);\n"
18731 #: ../src/guestfs-actions.pod:6473
18733 "This command enables the libguestfs appliance to use the swap device or "
18734 "partition named C<device>. The increased memory is made available for all "
18735 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18740 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4372
18742 "Note that you should not swap to existing guest swap partitions unless you "
18743 "know what you are doing. They may contain hibernation information, or other "
18744 "information that the guest doesn't want you to trash. You also risk leaking "
18745 "information about the host to the guest this way. Instead, attach a new "
18746 "host device to the guest and swap on that."
18751 #: ../src/guestfs-actions.pod:6489
18752 msgid "guestfs_swapon_file"
18757 #: ../src/guestfs-actions.pod:6491
18761 " guestfs_swapon_file (guestfs_h *g,\n"
18762 " const char *file);\n"
18768 #: ../src/guestfs-actions.pod:6495
18770 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18776 #: ../src/guestfs-actions.pod:6502
18777 msgid "guestfs_swapon_label"
18782 #: ../src/guestfs-actions.pod:6504
18786 " guestfs_swapon_label (guestfs_h *g,\n"
18787 " const char *label);\n"
18793 #: ../src/guestfs-actions.pod:6508
18795 "This command enables swap to a labeled swap partition. See "
18796 "C<guestfs_swapon_device> for other notes."
18801 #: ../src/guestfs-actions.pod:6515
18802 msgid "guestfs_swapon_uuid"
18807 #: ../src/guestfs-actions.pod:6517
18811 " guestfs_swapon_uuid (guestfs_h *g,\n"
18812 " const char *uuid);\n"
18818 #: ../src/guestfs-actions.pod:6521
18820 "This command enables swap to a swap partition with the given UUID. See "
18821 "C<guestfs_swapon_device> for other notes."
18826 #: ../src/guestfs-actions.pod:6528
18827 msgid "guestfs_sync"
18832 #: ../src/guestfs-actions.pod:6530
18836 " guestfs_sync (guestfs_h *g);\n"
18842 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4404
18844 "This syncs the disk, so that any writes are flushed through to the "
18845 "underlying disk image."
18850 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4407
18852 "You should always call this if you have modified a disk image, before "
18853 "closing the handle."
18858 #: ../src/guestfs-actions.pod:6543
18859 msgid "guestfs_tail"
18864 #: ../src/guestfs-actions.pod:6545
18868 " guestfs_tail (guestfs_h *g,\n"
18869 " const char *path);\n"
18875 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4414
18877 "This command returns up to the last 10 lines of a file as a list of strings."
18882 #: ../src/guestfs-actions.pod:6561
18883 msgid "guestfs_tail_n"
18888 #: ../src/guestfs-actions.pod:6563
18892 " guestfs_tail_n (guestfs_h *g,\n"
18894 " const char *path);\n"
18900 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4424
18902 "If the parameter C<nrlines> is a positive number, this returns the last "
18903 "C<nrlines> lines of the file C<path>."
18908 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4427
18910 "If the parameter C<nrlines> is a negative number, this returns lines from "
18911 "the file C<path>, starting with the C<-nrlines>th line."
18916 #: ../src/guestfs-actions.pod:6585
18917 msgid "guestfs_tar_in"
18922 #: ../src/guestfs-actions.pod:6587
18926 " guestfs_tar_in (guestfs_h *g,\n"
18927 " const char *tarfile,\n"
18928 " const char *directory);\n"
18934 #: ../src/guestfs-actions.pod:6592 ../fish/guestfish-actions.pod:4439
18936 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18937 "tar file) into C<directory>."
18942 #: ../src/guestfs-actions.pod:6595
18944 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18949 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6617
18950 #: ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6649
18951 msgid "(Added in 1.0.3)"
18956 #: ../src/guestfs-actions.pod:6602
18957 msgid "guestfs_tar_out"
18962 #: ../src/guestfs-actions.pod:6604
18966 " guestfs_tar_out (guestfs_h *g,\n"
18967 " const char *directory,\n"
18968 " const char *tarfile);\n"
18974 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4451
18976 "This command packs the contents of C<directory> and downloads it to local "
18982 #: ../src/guestfs-actions.pod:6612
18984 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18985 "C<guestfs_txz_out>."
18990 #: ../src/guestfs-actions.pod:6619
18991 msgid "guestfs_tgz_in"
18996 #: ../src/guestfs-actions.pod:6621
19000 " guestfs_tgz_in (guestfs_h *g,\n"
19001 " const char *tarball,\n"
19002 " const char *directory);\n"
19008 #: ../src/guestfs-actions.pod:6626 ../fish/guestfish-actions.pod:4463
19010 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19011 "tar file) into C<directory>."
19016 #: ../src/guestfs-actions.pod:6629
19017 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19022 #: ../src/guestfs-actions.pod:6635
19023 msgid "guestfs_tgz_out"
19028 #: ../src/guestfs-actions.pod:6637
19032 " guestfs_tgz_out (guestfs_h *g,\n"
19033 " const char *directory,\n"
19034 " const char *tarball);\n"
19040 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4474
19042 "This command packs the contents of C<directory> and downloads it to local "
19048 #: ../src/guestfs-actions.pod:6645
19049 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19054 #: ../src/guestfs-actions.pod:6651
19055 msgid "guestfs_touch"
19060 #: ../src/guestfs-actions.pod:6653
19064 " guestfs_touch (guestfs_h *g,\n"
19065 " const char *path);\n"
19071 #: ../src/guestfs-actions.pod:6657 ../fish/guestfish-actions.pod:4485
19073 "Touch acts like the L<touch(1)> command. It can be used to update the "
19074 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19080 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4489
19082 "This command only works on regular files, and will fail on other file types "
19083 "such as directories, symbolic links, block special etc."
19088 #: ../src/guestfs-actions.pod:6668
19089 msgid "guestfs_truncate"
19094 #: ../src/guestfs-actions.pod:6670
19098 " guestfs_truncate (guestfs_h *g,\n"
19099 " const char *path);\n"
19105 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4496
19107 "This command truncates C<path> to a zero-length file. The file must exist "
19113 #: ../src/guestfs-actions.pod:6681
19114 msgid "guestfs_truncate_size"
19119 #: ../src/guestfs-actions.pod:6683
19123 " guestfs_truncate_size (guestfs_h *g,\n"
19124 " const char *path,\n"
19125 " int64_t size);\n"
19131 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4503
19133 "This command truncates C<path> to size C<size> bytes. The file must exist "
19139 #: ../src/guestfs-actions.pod:6691
19141 "If the current file size is less than C<size> then the file is extended to "
19142 "the required size with zero bytes. This creates a sparse file (ie. disk "
19143 "blocks are not allocated for the file until you write to it). To create a "
19144 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19149 #: ../src/guestfs-actions.pod:6701
19150 msgid "guestfs_tune2fs_l"
19155 #: ../src/guestfs-actions.pod:6703
19159 " guestfs_tune2fs_l (guestfs_h *g,\n"
19160 " const char *device);\n"
19166 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4516
19168 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19174 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4519
19176 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19177 "for more details. The list of fields returned isn't clearly defined, and "
19178 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19179 "and the filesystem itself."
19184 #: ../src/guestfs-actions.pod:6723
19185 msgid "guestfs_txz_in"
19190 #: ../src/guestfs-actions.pod:6725
19194 " guestfs_txz_in (guestfs_h *g,\n"
19195 " const char *tarball,\n"
19196 " const char *directory);\n"
19202 #: ../src/guestfs-actions.pod:6730 ../fish/guestfish-actions.pod:4528
19204 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19205 "tar file) into C<directory>."
19210 #: ../src/guestfs-actions.pod:6737
19211 msgid "guestfs_txz_out"
19216 #: ../src/guestfs-actions.pod:6739
19220 " guestfs_txz_out (guestfs_h *g,\n"
19221 " const char *directory,\n"
19222 " const char *tarball);\n"
19228 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4537
19230 "This command packs the contents of C<directory> and downloads it to local "
19231 "file C<tarball> (as an xz compressed tar archive)."
19236 #: ../src/guestfs-actions.pod:6751
19237 msgid "guestfs_umask"
19242 #: ../src/guestfs-actions.pod:6753
19246 " guestfs_umask (guestfs_h *g,\n"
19253 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
19255 "This function sets the mask used for creating new files and device nodes to "
19261 #: ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:4549
19263 "Typical umask values would be C<022> which creates new files with "
19264 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19265 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19270 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4554
19272 "The default umask is C<022>. This is important because it means that "
19273 "directories and device nodes will be created with C<0644> or C<0755> mode "
19274 "even if you specify C<0777>."
19279 #: ../src/guestfs-actions.pod:6769
19281 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19282 "C<guestfs_mkdir>."
19287 #: ../src/guestfs-actions.pod:6772 ../fish/guestfish-actions.pod:4561
19288 msgid "This call returns the previous umask."
19293 #: ../src/guestfs-actions.pod:6778
19294 msgid "guestfs_umount"
19299 #: ../src/guestfs-actions.pod:6780
19303 " guestfs_umount (guestfs_h *g,\n"
19304 " const char *pathordevice);\n"
19310 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4569
19312 "This unmounts the given filesystem. The filesystem may be specified either "
19313 "by its mountpoint (path) or the device which contains the filesystem."
19318 #: ../src/guestfs-actions.pod:6792
19319 msgid "guestfs_umount_all"
19324 #: ../src/guestfs-actions.pod:6794
19328 " guestfs_umount_all (guestfs_h *g);\n"
19334 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4579
19335 msgid "This unmounts all mounted filesystems."
19340 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4581
19341 msgid "Some internal mounts are not unmounted by this call."
19346 #: ../src/guestfs-actions.pod:6805
19347 msgid "guestfs_upload"
19352 #: ../src/guestfs-actions.pod:6807
19356 " guestfs_upload (guestfs_h *g,\n"
19357 " const char *filename,\n"
19358 " const char *remotefilename);\n"
19364 #: ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6836
19365 #: ../fish/guestfish-actions.pod:4587 ../fish/guestfish-actions.pod:4600
19366 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19371 #: ../src/guestfs-actions.pod:6817
19372 msgid "See also C<guestfs_download>."
19377 #: ../src/guestfs-actions.pod:6828
19378 msgid "guestfs_upload_offset"
19383 #: ../src/guestfs-actions.pod:6830
19387 " guestfs_upload_offset (guestfs_h *g,\n"
19388 " const char *filename,\n"
19389 " const char *remotefilename,\n"
19390 " int64_t offset);\n"
19396 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4603
19398 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19399 "The intention is to overwrite parts of existing files or devices, although "
19400 "if a non-existant file is specified then it is created with a \"hole\" "
19401 "before C<offset>. The size of the data written is implicit in the size of "
19402 "the source C<filename>."
19407 #: ../src/guestfs-actions.pod:6846
19409 "Note that there is no limit on the amount of data that can be uploaded with "
19410 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19411 "full amount unless an error occurs."
19416 #: ../src/guestfs-actions.pod:6851
19417 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19422 #: ../src/guestfs-actions.pod:6862
19423 msgid "guestfs_utimens"
19428 #: ../src/guestfs-actions.pod:6864
19432 " guestfs_utimens (guestfs_h *g,\n"
19433 " const char *path,\n"
19434 " int64_t atsecs,\n"
19435 " int64_t atnsecs,\n"
19436 " int64_t mtsecs,\n"
19437 " int64_t mtnsecs);\n"
19443 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4623
19444 msgid "This command sets the timestamps of a file with nanosecond precision."
19449 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4626
19451 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19457 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4629
19459 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19460 "nanoseconds from the epoch."
19465 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4632
19467 "If the C<*nsecs> field contains the special value C<-1> then the "
19468 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19469 "ignored in this case)."
19474 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4636
19476 "If the C<*nsecs> field contains the special value C<-2> then the "
19477 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19483 #: ../src/guestfs-actions.pod:6893 ../src/guestfs-structs.pod:175
19484 msgid "guestfs_version"
19489 #: ../src/guestfs-actions.pod:6895
19492 " struct guestfs_version *\n"
19493 " guestfs_version (guestfs_h *g);\n"
19499 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
19501 "Return the libguestfs version number that the program is linked against."
19506 #: ../src/guestfs-actions.pod:6901 ../fish/guestfish-actions.pod:4647
19508 "Note that because of dynamic linking this is not necessarily the version of "
19509 "libguestfs that you compiled against. You can compile the program, and then "
19510 "at runtime dynamically link against a completely different C<libguestfs.so> "
19516 #: ../src/guestfs-actions.pod:6906 ../fish/guestfish-actions.pod:4652
19518 "This call was added in version C<1.0.58>. In previous versions of "
19519 "libguestfs there was no way to get the version number. From C code you can "
19520 "use dynamic linker functions to find out if this symbol exists (if it "
19521 "doesn't, then it's an earlier version)."
19526 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4658
19528 "The call returns a structure with four elements. The first three (C<major>, "
19529 "C<minor> and C<release>) are numbers and correspond to the usual version "
19530 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19531 "but may be used for distro-specific information."
19536 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4664
19538 "To construct the original version string: C<$major.$minor.$release$extra>"
19543 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4667
19544 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19549 #: ../src/guestfs-actions.pod:6923
19551 "I<Note:> Don't use this call to test for availability of features. In "
19552 "enterprise distributions we backport features from later versions into "
19553 "earlier versions, making this an unreliable way to test for features. Use "
19554 "C<guestfs_available> instead."
19559 #: ../src/guestfs-actions.pod:6929
19561 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19562 "error. I<The caller must call C<guestfs_free_version> after use>."
19567 #: ../src/guestfs-actions.pod:6933
19568 msgid "(Added in 1.0.58)"
19573 #: ../src/guestfs-actions.pod:6935
19574 msgid "guestfs_vfs_label"
19579 #: ../src/guestfs-actions.pod:6937
19583 " guestfs_vfs_label (guestfs_h *g,\n"
19584 " const char *device);\n"
19590 #: ../src/guestfs-actions.pod:6941 ../fish/guestfish-actions.pod:4679
19591 msgid "This returns the filesystem label of the filesystem on C<device>."
19596 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4682
19597 msgid "If the filesystem is unlabeled, this returns the empty string."
19602 #: ../src/guestfs-actions.pod:6946
19603 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19608 #: ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:6988
19609 msgid "(Added in 1.3.18)"
19614 #: ../src/guestfs-actions.pod:6953
19615 msgid "guestfs_vfs_type"
19620 #: ../src/guestfs-actions.pod:6955
19624 " guestfs_vfs_type (guestfs_h *g,\n"
19625 " const char *device);\n"
19631 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4690
19633 "This command gets the filesystem type corresponding to the filesystem on "
19639 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4693
19641 "For most filesystems, the result is the name of the Linux VFS module which "
19642 "would be used to mount this filesystem if you mounted it without specifying "
19643 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19648 #: ../src/guestfs-actions.pod:6972
19649 msgid "guestfs_vfs_uuid"
19654 #: ../src/guestfs-actions.pod:6974
19658 " guestfs_vfs_uuid (guestfs_h *g,\n"
19659 " const char *device);\n"
19665 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4702
19666 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19671 #: ../src/guestfs-actions.pod:6981 ../fish/guestfish-actions.pod:4705
19672 msgid "If the filesystem does not have a UUID, this returns the empty string."
19677 #: ../src/guestfs-actions.pod:6983
19678 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19683 #: ../src/guestfs-actions.pod:6990
19684 msgid "guestfs_vg_activate"
19689 #: ../src/guestfs-actions.pod:6992
19693 " guestfs_vg_activate (guestfs_h *g,\n"
19695 " char *const *volgroups);\n"
19701 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
19703 "This command activates or (if C<activate> is false) deactivates all logical "
19704 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19705 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19706 "deactivated, then those devices disappear."
19711 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4719
19712 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19717 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4721
19719 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19720 "activated or deactivated."
19725 #: ../src/guestfs-actions.pod:7012
19726 msgid "guestfs_vg_activate_all"
19731 #: ../src/guestfs-actions.pod:7014
19735 " guestfs_vg_activate_all (guestfs_h *g,\n"
19736 " int activate);\n"
19742 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4728
19744 "This command activates or (if C<activate> is false) deactivates all logical "
19745 "volumes in all volume groups. If activated, then they are made known to the "
19746 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19747 "those devices disappear."
19752 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4734
19753 msgid "This command is the same as running C<vgchange -a y|n>"
19758 #: ../src/guestfs-actions.pod:7030
19759 msgid "guestfs_vgcreate"
19764 #: ../src/guestfs-actions.pod:7032
19768 " guestfs_vgcreate (guestfs_h *g,\n"
19769 " const char *volgroup,\n"
19770 " char *const *physvols);\n"
19776 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4740
19778 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19779 "of physical volumes C<physvols>."
19784 #: ../src/guestfs-actions.pod:7044
19785 msgid "guestfs_vglvuuids"
19790 #: ../src/guestfs-actions.pod:7046
19794 " guestfs_vglvuuids (guestfs_h *g,\n"
19795 " const char *vgname);\n"
19801 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4747
19803 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19804 "volumes created in this volume group."
19809 #: ../src/guestfs-actions.pod:7053
19811 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19812 "associate logical volumes and volume groups."
19817 #: ../src/guestfs-actions.pod:7056
19818 msgid "See also C<guestfs_vgpvuuids>."
19823 #: ../src/guestfs-actions.pod:7064
19824 msgid "guestfs_vgpvuuids"
19829 #: ../src/guestfs-actions.pod:7066
19833 " guestfs_vgpvuuids (guestfs_h *g,\n"
19834 " const char *vgname);\n"
19840 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4759
19842 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19843 "volumes that this volume group resides on."
19848 #: ../src/guestfs-actions.pod:7073
19850 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
19851 "associate physical volumes and volume groups."
19856 #: ../src/guestfs-actions.pod:7076
19857 msgid "See also C<guestfs_vglvuuids>."
19862 #: ../src/guestfs-actions.pod:7084
19863 msgid "guestfs_vgremove"
19868 #: ../src/guestfs-actions.pod:7086
19872 " guestfs_vgremove (guestfs_h *g,\n"
19873 " const char *vgname);\n"
19879 #: ../src/guestfs-actions.pod:7090 ../fish/guestfish-actions.pod:4771
19880 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19885 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4773
19887 "This also forcibly removes all logical volumes in the volume group (if any)."
19892 #: ../src/guestfs-actions.pod:7099
19893 msgid "guestfs_vgrename"
19898 #: ../src/guestfs-actions.pod:7101
19902 " guestfs_vgrename (guestfs_h *g,\n"
19903 " const char *volgroup,\n"
19904 " const char *newvolgroup);\n"
19910 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4780
19911 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19916 #: ../src/guestfs-actions.pod:7112
19917 msgid "guestfs_vgs"
19922 #: ../src/guestfs-actions.pod:7114
19926 " guestfs_vgs (guestfs_h *g);\n"
19932 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4786
19934 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19940 #: ../src/guestfs-actions.pod:7120 ../fish/guestfish-actions.pod:4789
19942 "This returns a list of just the volume group names that were detected (eg. "
19948 #: ../src/guestfs-actions.pod:7123
19949 msgid "See also C<guestfs_vgs_full>."
19954 #: ../src/guestfs-actions.pod:7131
19955 msgid "guestfs_vgs_full"
19960 #: ../src/guestfs-actions.pod:7133
19963 " struct guestfs_lvm_vg_list *\n"
19964 " guestfs_vgs_full (guestfs_h *g);\n"
19970 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4798
19972 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19973 "> command. The \"full\" version includes all fields."
19978 #: ../src/guestfs-actions.pod:7139
19980 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
19981 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
19986 #: ../src/guestfs-actions.pod:7145
19987 msgid "guestfs_vgscan"
19992 #: ../src/guestfs-actions.pod:7147
19996 " guestfs_vgscan (guestfs_h *g);\n"
20002 #: ../src/guestfs-actions.pod:7150 ../fish/guestfish-actions.pod:4805
20004 "This rescans all block devices and rebuilds the list of LVM physical "
20005 "volumes, volume groups and logical volumes."
20010 #: ../src/guestfs-actions.pod:7157
20011 msgid "guestfs_vguuid"
20016 #: ../src/guestfs-actions.pod:7159
20020 " guestfs_vguuid (guestfs_h *g,\n"
20021 " const char *vgname);\n"
20027 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4812
20028 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20033 #: ../src/guestfs-actions.pod:7170
20034 msgid "guestfs_wait_ready"
20039 #: ../src/guestfs-actions.pod:7172
20043 " guestfs_wait_ready (guestfs_h *g);\n"
20049 #: ../src/guestfs-actions.pod:7175
20050 msgid "This function is a no op."
20055 #: ../src/guestfs-actions.pod:7177
20057 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20058 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20059 "is no longer necessary because C<guestfs_launch> now does the waiting."
20064 #: ../src/guestfs-actions.pod:7182
20066 "If you see any calls to this function in code then you can just remove them, "
20067 "unless you want to retain compatibility with older versions of the API."
20072 #: ../src/guestfs-actions.pod:7190
20073 msgid "guestfs_wc_c"
20078 #: ../src/guestfs-actions.pod:7192
20082 " guestfs_wc_c (guestfs_h *g,\n"
20083 " const char *path);\n"
20089 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4818
20091 "This command counts the characters in a file, using the C<wc -c> external "
20097 #: ../src/guestfs-actions.pod:7203
20098 msgid "guestfs_wc_l"
20103 #: ../src/guestfs-actions.pod:7205
20107 " guestfs_wc_l (guestfs_h *g,\n"
20108 " const char *path);\n"
20114 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4825
20116 "This command counts the lines in a file, using the C<wc -l> external command."
20121 #: ../src/guestfs-actions.pod:7216
20122 msgid "guestfs_wc_w"
20127 #: ../src/guestfs-actions.pod:7218
20131 " guestfs_wc_w (guestfs_h *g,\n"
20132 " const char *path);\n"
20138 #: ../src/guestfs-actions.pod:7222 ../fish/guestfish-actions.pod:4832
20140 "This command counts the words in a file, using the C<wc -w> external command."
20145 #: ../src/guestfs-actions.pod:7229
20146 msgid "guestfs_write"
20151 #: ../src/guestfs-actions.pod:7231
20155 " guestfs_write (guestfs_h *g,\n"
20156 " const char *path,\n"
20157 " const char *content,\n"
20158 " size_t content_size);\n"
20164 #: ../src/guestfs-actions.pod:7237 ../fish/guestfish-actions.pod:4839
20166 "This call creates a file called C<path>. The content of the file is the "
20167 "string C<content> (which can contain any 8 bit data)."
20172 #: ../src/guestfs-actions.pod:7247
20173 msgid "guestfs_write_file"
20178 #: ../src/guestfs-actions.pod:7249
20182 " guestfs_write_file (guestfs_h *g,\n"
20183 " const char *path,\n"
20184 " const char *content,\n"
20191 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
20193 "This call creates a file called C<path>. The contents of the file is the "
20194 "string C<content> (which can contain any 8 bit data), with length C<size>."
20199 #: ../src/guestfs-actions.pod:7259 ../fish/guestfish-actions.pod:4853
20201 "As a special case, if C<size> is C<0> then the length is calculated using "
20202 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20207 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4857
20209 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20210 "I<not> work, even if the length is specified."
20215 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4863
20217 "This function is deprecated. In new code, use the C<write> call instead."
20222 #: ../src/guestfs-actions.pod:7280
20223 msgid "guestfs_zegrep"
20228 #: ../src/guestfs-actions.pod:7282
20232 " guestfs_zegrep (guestfs_h *g,\n"
20233 " const char *regex,\n"
20234 " const char *path);\n"
20240 #: ../src/guestfs-actions.pod:7287 ../fish/guestfish-actions.pod:4874
20242 "This calls the external C<zegrep> program and returns the matching lines."
20247 #: ../src/guestfs-actions.pod:7299
20248 msgid "guestfs_zegrepi"
20253 #: ../src/guestfs-actions.pod:7301
20257 " guestfs_zegrepi (guestfs_h *g,\n"
20258 " const char *regex,\n"
20259 " const char *path);\n"
20265 #: ../src/guestfs-actions.pod:7306 ../fish/guestfish-actions.pod:4884
20267 "This calls the external C<zegrep -i> program and returns the matching lines."
20272 #: ../src/guestfs-actions.pod:7318
20273 msgid "guestfs_zero"
20278 #: ../src/guestfs-actions.pod:7320
20282 " guestfs_zero (guestfs_h *g,\n"
20283 " const char *device);\n"
20289 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4894
20290 msgid "This command writes zeroes over the first few blocks of C<device>."
20295 #: ../src/guestfs-actions.pod:7326 ../fish/guestfish-actions.pod:4896
20297 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20298 "securely wipe the device). It should be sufficient to remove any partition "
20299 "tables, filesystem superblocks and so on."
20304 #: ../src/guestfs-actions.pod:7330
20305 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20310 #: ../src/guestfs-actions.pod:7341
20311 msgid "guestfs_zero_device"
20316 #: ../src/guestfs-actions.pod:7343
20320 " guestfs_zero_device (guestfs_h *g,\n"
20321 " const char *device);\n"
20327 #: ../src/guestfs-actions.pod:7347
20329 "This command writes zeroes over the entire C<device>. Compare with "
20330 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20335 #: ../src/guestfs-actions.pod:7361
20336 msgid "(Added in 1.3.1)"
20341 #: ../src/guestfs-actions.pod:7363
20342 msgid "guestfs_zerofree"
20347 #: ../src/guestfs-actions.pod:7365
20351 " guestfs_zerofree (guestfs_h *g,\n"
20352 " const char *device);\n"
20358 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
20360 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20361 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20362 "possible to compress the filesystem more effectively."
20367 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4922
20368 msgid "You should B<not> run this program if the filesystem is mounted."
20373 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4925
20375 "It is possible that using this program can damage the filesystem or data on "
20381 #: ../src/guestfs-actions.pod:7384
20382 msgid "guestfs_zfgrep"
20387 #: ../src/guestfs-actions.pod:7386
20391 " guestfs_zfgrep (guestfs_h *g,\n"
20392 " const char *pattern,\n"
20393 " const char *path);\n"
20399 #: ../src/guestfs-actions.pod:7391 ../fish/guestfish-actions.pod:4932
20401 "This calls the external C<zfgrep> program and returns the matching lines."
20406 #: ../src/guestfs-actions.pod:7403
20407 msgid "guestfs_zfgrepi"
20412 #: ../src/guestfs-actions.pod:7405
20416 " guestfs_zfgrepi (guestfs_h *g,\n"
20417 " const char *pattern,\n"
20418 " const char *path);\n"
20424 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4942
20426 "This calls the external C<zfgrep -i> program and returns the matching lines."
20431 #: ../src/guestfs-actions.pod:7422
20432 msgid "guestfs_zfile"
20437 #: ../src/guestfs-actions.pod:7424
20441 " guestfs_zfile (guestfs_h *g,\n"
20442 " const char *meth,\n"
20443 " const char *path);\n"
20449 #: ../src/guestfs-actions.pod:7429 ../fish/guestfish-actions.pod:4952
20451 "This command runs C<file> after first decompressing C<path> using C<method>."
20456 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4955
20457 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20462 #: ../src/guestfs-actions.pod:7434
20464 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20470 #: ../src/guestfs-actions.pod:7440 ../fish/guestfish-actions.pod:4960
20472 "This function is deprecated. In new code, use the C<file> call instead."
20477 #: ../src/guestfs-actions.pod:7449
20478 msgid "guestfs_zgrep"
20483 #: ../src/guestfs-actions.pod:7451
20487 " guestfs_zgrep (guestfs_h *g,\n"
20488 " const char *regex,\n"
20489 " const char *path);\n"
20495 #: ../src/guestfs-actions.pod:7456 ../fish/guestfish-actions.pod:4971
20497 "This calls the external C<zgrep> program and returns the matching lines."
20502 #: ../src/guestfs-actions.pod:7468
20503 msgid "guestfs_zgrepi"
20508 #: ../src/guestfs-actions.pod:7470
20512 " guestfs_zgrepi (guestfs_h *g,\n"
20513 " const char *regex,\n"
20514 " const char *path);\n"
20520 #: ../src/guestfs-actions.pod:7475 ../fish/guestfish-actions.pod:4981
20522 "This calls the external C<zgrep -i> program and returns the matching lines."
20527 #: ../src/guestfs-availability.pod:3
20533 #: ../src/guestfs-availability.pod:5
20535 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20536 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20537 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20538 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20539 "L</guestfs_aug_save> L</guestfs_aug_set>"
20544 #: ../src/guestfs-availability.pod:21
20550 #: ../src/guestfs-availability.pod:23
20552 "The following functions: L</guestfs_inotify_add_watch> L</"
20553 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20554 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20559 #: ../src/guestfs-availability.pod:31
20560 msgid "B<linuxfsuuid>"
20565 #: ../src/guestfs-availability.pod:33
20567 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20568 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20573 #: ../src/guestfs-availability.pod:40
20574 msgid "B<linuxmodules>"
20579 #: ../src/guestfs-availability.pod:42
20580 msgid "The following functions: L</guestfs_modprobe>"
20585 #: ../src/guestfs-availability.pod:45
20586 msgid "B<linuxxattrs>"
20591 #: ../src/guestfs-availability.pod:47
20593 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20594 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20595 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20596 "guestfs_setxattr>"
20601 #: ../src/guestfs-availability.pod:58
20607 #: ../src/guestfs-availability.pod:60
20609 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20610 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20611 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20616 #: ../src/guestfs-availability.pod:69
20622 #: ../src/guestfs-availability.pod:71
20624 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20625 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20626 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20627 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20628 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20629 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20630 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20635 #: ../src/guestfs-availability.pod:94
20641 #: ../src/guestfs-availability.pod:96
20643 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20644 "guestfs_mknod_b> L</guestfs_mknod_c>"
20649 #: ../src/guestfs-availability.pod:102
20655 #: ../src/guestfs-availability.pod:104
20656 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20661 #: ../src/guestfs-availability.pod:107
20662 msgid "B<ntfsprogs>"
20667 #: ../src/guestfs-availability.pod:109
20669 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20674 #: ../src/guestfs-availability.pod:113
20675 msgid "B<realpath>"
20680 #: ../src/guestfs-availability.pod:115
20681 msgid "The following functions: L</guestfs_realpath>"
20686 #: ../src/guestfs-availability.pod:118
20692 #: ../src/guestfs-availability.pod:120
20694 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20695 "guestfs_scrub_freespace>"
20700 #: ../src/guestfs-availability.pod:125
20706 #: ../src/guestfs-availability.pod:127
20707 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20712 #: ../src/guestfs-availability.pod:131
20718 #: ../src/guestfs-availability.pod:133
20719 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20724 #: ../src/guestfs-availability.pod:137
20725 msgid "B<zerofree>"
20730 #: ../src/guestfs-availability.pod:139
20731 msgid "The following functions: L</guestfs_zerofree>"
20736 #: ../src/guestfs-structs.pod:1
20737 msgid "guestfs_int_bool"
20742 #: ../src/guestfs-structs.pod:3
20745 " struct guestfs_int_bool {\n"
20754 #: ../src/guestfs-structs.pod:8
20757 " struct guestfs_int_bool_list {\n"
20758 " uint32_t len; /* Number of elements in list. */\n"
20759 " struct guestfs_int_bool *val; /* Elements. */\n"
20766 #: ../src/guestfs-structs.pod:13
20769 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20770 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20776 #: ../src/guestfs-structs.pod:16
20777 msgid "guestfs_lvm_pv"
20782 #: ../src/guestfs-structs.pod:18
20785 " struct guestfs_lvm_pv {\n"
20786 " char *pv_name;\n"
20787 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20788 " char pv_uuid[32];\n"
20790 " uint64_t pv_size;\n"
20791 " uint64_t dev_size;\n"
20792 " uint64_t pv_free;\n"
20793 " uint64_t pv_used;\n"
20794 " char *pv_attr;\n"
20795 " int64_t pv_pe_count;\n"
20796 " int64_t pv_pe_alloc_count;\n"
20797 " char *pv_tags;\n"
20798 " uint64_t pe_start;\n"
20799 " int64_t pv_mda_count;\n"
20800 " uint64_t pv_mda_free;\n"
20807 #: ../src/guestfs-structs.pod:36
20810 " struct guestfs_lvm_pv_list {\n"
20811 " uint32_t len; /* Number of elements in list. */\n"
20812 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20819 #: ../src/guestfs-structs.pod:41
20822 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20823 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20829 #: ../src/guestfs-structs.pod:44
20830 msgid "guestfs_lvm_vg"
20835 #: ../src/guestfs-structs.pod:46
20838 " struct guestfs_lvm_vg {\n"
20839 " char *vg_name;\n"
20840 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20841 " char vg_uuid[32];\n"
20843 " char *vg_attr;\n"
20844 " uint64_t vg_size;\n"
20845 " uint64_t vg_free;\n"
20846 " char *vg_sysid;\n"
20847 " uint64_t vg_extent_size;\n"
20848 " int64_t vg_extent_count;\n"
20849 " int64_t vg_free_count;\n"
20850 " int64_t max_lv;\n"
20851 " int64_t max_pv;\n"
20852 " int64_t pv_count;\n"
20853 " int64_t lv_count;\n"
20854 " int64_t snap_count;\n"
20855 " int64_t vg_seqno;\n"
20856 " char *vg_tags;\n"
20857 " int64_t vg_mda_count;\n"
20858 " uint64_t vg_mda_free;\n"
20865 #: ../src/guestfs-structs.pod:69
20868 " struct guestfs_lvm_vg_list {\n"
20869 " uint32_t len; /* Number of elements in list. */\n"
20870 " struct guestfs_lvm_vg *val; /* Elements. */\n"
20877 #: ../src/guestfs-structs.pod:74
20880 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
20881 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
20887 #: ../src/guestfs-structs.pod:77
20888 msgid "guestfs_lvm_lv"
20893 #: ../src/guestfs-structs.pod:79
20896 " struct guestfs_lvm_lv {\n"
20897 " char *lv_name;\n"
20898 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20899 " char lv_uuid[32];\n"
20900 " char *lv_attr;\n"
20901 " int64_t lv_major;\n"
20902 " int64_t lv_minor;\n"
20903 " int64_t lv_kernel_major;\n"
20904 " int64_t lv_kernel_minor;\n"
20905 " uint64_t lv_size;\n"
20906 " int64_t seg_count;\n"
20908 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20909 " float snap_percent;\n"
20910 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20911 " float copy_percent;\n"
20912 " char *move_pv;\n"
20913 " char *lv_tags;\n"
20914 " char *mirror_log;\n"
20915 " char *modules;\n"
20922 #: ../src/guestfs-structs.pod:101
20925 " struct guestfs_lvm_lv_list {\n"
20926 " uint32_t len; /* Number of elements in list. */\n"
20927 " struct guestfs_lvm_lv *val; /* Elements. */\n"
20934 #: ../src/guestfs-structs.pod:106
20937 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
20938 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
20944 #: ../src/guestfs-structs.pod:111
20947 " struct guestfs_stat {\n"
20951 " int64_t nlink;\n"
20956 " int64_t blksize;\n"
20957 " int64_t blocks;\n"
20958 " int64_t atime;\n"
20959 " int64_t mtime;\n"
20960 " int64_t ctime;\n"
20967 #: ../src/guestfs-structs.pod:127
20970 " struct guestfs_stat_list {\n"
20971 " uint32_t len; /* Number of elements in list. */\n"
20972 " struct guestfs_stat *val; /* Elements. */\n"
20979 #: ../src/guestfs-structs.pod:132
20982 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
20983 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
20989 #: ../src/guestfs-structs.pod:137
20992 " struct guestfs_statvfs {\n"
20993 " int64_t bsize;\n"
20994 " int64_t frsize;\n"
20995 " int64_t blocks;\n"
20996 " int64_t bfree;\n"
20997 " int64_t bavail;\n"
20998 " int64_t files;\n"
20999 " int64_t ffree;\n"
21000 " int64_t favail;\n"
21003 " int64_t namemax;\n"
21010 #: ../src/guestfs-structs.pod:151
21013 " struct guestfs_statvfs_list {\n"
21014 " uint32_t len; /* Number of elements in list. */\n"
21015 " struct guestfs_statvfs *val; /* Elements. */\n"
21022 #: ../src/guestfs-structs.pod:156
21025 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21026 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21032 #: ../src/guestfs-structs.pod:159
21033 msgid "guestfs_dirent"
21038 #: ../src/guestfs-structs.pod:161
21041 " struct guestfs_dirent {\n"
21051 #: ../src/guestfs-structs.pod:167
21054 " struct guestfs_dirent_list {\n"
21055 " uint32_t len; /* Number of elements in list. */\n"
21056 " struct guestfs_dirent *val; /* Elements. */\n"
21063 #: ../src/guestfs-structs.pod:172
21066 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21067 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21073 #: ../src/guestfs-structs.pod:177
21076 " struct guestfs_version {\n"
21077 " int64_t major;\n"
21078 " int64_t minor;\n"
21079 " int64_t release;\n"
21087 #: ../src/guestfs-structs.pod:184
21090 " struct guestfs_version_list {\n"
21091 " uint32_t len; /* Number of elements in list. */\n"
21092 " struct guestfs_version *val; /* Elements. */\n"
21099 #: ../src/guestfs-structs.pod:189
21102 " void guestfs_free_version (struct guestfs_free_version *);\n"
21103 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21109 #: ../src/guestfs-structs.pod:192
21110 msgid "guestfs_xattr"
21115 #: ../src/guestfs-structs.pod:194
21118 " struct guestfs_xattr {\n"
21119 " char *attrname;\n"
21120 " /* The next two fields describe a byte array. */\n"
21121 " uint32_t attrval_len;\n"
21122 " char *attrval;\n"
21129 #: ../src/guestfs-structs.pod:201
21132 " struct guestfs_xattr_list {\n"
21133 " uint32_t len; /* Number of elements in list. */\n"
21134 " struct guestfs_xattr *val; /* Elements. */\n"
21141 #: ../src/guestfs-structs.pod:206
21144 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21145 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21151 #: ../src/guestfs-structs.pod:209
21152 msgid "guestfs_inotify_event"
21157 #: ../src/guestfs-structs.pod:211
21160 " struct guestfs_inotify_event {\n"
21161 " int64_t in_wd;\n"
21162 " uint32_t in_mask;\n"
21163 " uint32_t in_cookie;\n"
21164 " char *in_name;\n"
21171 #: ../src/guestfs-structs.pod:218
21174 " struct guestfs_inotify_event_list {\n"
21175 " uint32_t len; /* Number of elements in list. */\n"
21176 " struct guestfs_inotify_event *val; /* Elements. */\n"
21183 #: ../src/guestfs-structs.pod:223
21186 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21187 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21193 #: ../src/guestfs-structs.pod:226
21194 msgid "guestfs_partition"
21199 #: ../src/guestfs-structs.pod:228
21202 " struct guestfs_partition {\n"
21203 " int32_t part_num;\n"
21204 " uint64_t part_start;\n"
21205 " uint64_t part_end;\n"
21206 " uint64_t part_size;\n"
21213 #: ../src/guestfs-structs.pod:235
21216 " struct guestfs_partition_list {\n"
21217 " uint32_t len; /* Number of elements in list. */\n"
21218 " struct guestfs_partition *val; /* Elements. */\n"
21225 #: ../src/guestfs-structs.pod:240
21228 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21229 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21235 #: ../src/guestfs-structs.pod:243
21236 msgid "guestfs_application"
21241 #: ../src/guestfs-structs.pod:245
21244 " struct guestfs_application {\n"
21245 " char *app_name;\n"
21246 " char *app_display_name;\n"
21247 " int32_t app_epoch;\n"
21248 " char *app_version;\n"
21249 " char *app_release;\n"
21250 " char *app_install_path;\n"
21251 " char *app_trans_path;\n"
21252 " char *app_publisher;\n"
21253 " char *app_url;\n"
21254 " char *app_source_package;\n"
21255 " char *app_summary;\n"
21256 " char *app_description;\n"
21263 #: ../src/guestfs-structs.pod:260
21266 " struct guestfs_application_list {\n"
21267 " uint32_t len; /* Number of elements in list. */\n"
21268 " struct guestfs_application *val; /* Elements. */\n"
21275 #: ../src/guestfs-structs.pod:265
21278 " void guestfs_free_application (struct guestfs_free_application *);\n"
21279 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21285 #: ../fish/guestfish.pod:5
21286 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21291 #: ../fish/guestfish.pod:9
21294 " guestfish [--options] [commands]\n"
21300 #: ../fish/guestfish.pod:11
21309 #: ../fish/guestfish.pod:13
21312 " guestfish [--ro|--rw] -a disk.img\n"
21318 #: ../fish/guestfish.pod:15
21321 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21327 #: ../fish/guestfish.pod:17
21330 " guestfish -d libvirt-domain\n"
21336 #: ../fish/guestfish.pod:19
21339 " guestfish [--ro|--rw] -a disk.img -i\n"
21345 #: ../fish/guestfish.pod:21
21348 " guestfish -d libvirt-domain -i\n"
21354 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21355 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21361 #: ../fish/guestfish.pod:25
21363 "Using guestfish in read/write mode on live virtual machines can be "
21364 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21365 "option to use guestfish safely if the disk image or virtual machine might be "
21371 #: ../fish/guestfish.pod:32
21373 "Guestfish is a shell and command-line tool for examining and modifying "
21374 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21375 "functionality of the guestfs API, see L<guestfs(3)>."
21380 #: ../fish/guestfish.pod:36
21382 "Guestfish gives you structured access to the libguestfs API, from shell "
21383 "scripts or the command line or interactively. If you want to rescue a "
21384 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21390 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
21391 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
21397 #: ../fish/guestfish.pod:43
21398 msgid "As an interactive shell"
21403 #: ../fish/guestfish.pod:45
21412 #: ../fish/guestfish.pod:47
21415 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21416 " editing virtual machine filesystems.\n"
21422 #: ../fish/guestfish.pod:50
21425 " Type: 'help' for a list of commands\n"
21426 " 'man' to read the manual\n"
21427 " 'quit' to quit the shell\n"
21433 #: ../fish/guestfish.pod:54
21436 " ><fs> add-ro disk.img\n"
21438 " ><fs> list-filesystems\n"
21439 " /dev/sda1: ext4\n"
21440 " /dev/vg_guest/lv_root: ext4\n"
21441 " /dev/vg_guest/lv_swap: swap\n"
21442 " ><fs> mount /dev/vg_guest/lv_root /\n"
21443 " ><fs> cat /etc/fstab\n"
21445 " # Created by anaconda\n"
21453 #: ../fish/guestfish.pod:67
21454 msgid "From shell scripts"
21459 #: ../fish/guestfish.pod:69
21460 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21465 #: ../fish/guestfish.pod:71
21468 " guestfish <<_EOF_\n"
21471 " mount /dev/vg_guest/lv_root /\n"
21472 " write /etc/motd \"Welcome, new users\"\n"
21479 #: ../fish/guestfish.pod:78
21480 msgid "List the LVM logical volumes in a disk image:"
21485 #: ../fish/guestfish.pod:80
21488 " guestfish -a disk.img --ro <<_EOF_\n"
21497 #: ../fish/guestfish.pod:85
21498 msgid "List all the filesystems in a disk image:"
21503 #: ../fish/guestfish.pod:87
21506 " guestfish -a disk.img --ro <<_EOF_\n"
21508 " list-filesystems\n"
21515 #: ../fish/guestfish.pod:92
21516 msgid "On one command line"
21521 #: ../fish/guestfish.pod:94
21522 msgid "Update C</etc/resolv.conf> in a guest:"
21527 #: ../fish/guestfish.pod:96
21531 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21532 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21538 #: ../fish/guestfish.pod:100
21539 msgid "Edit C</boot/grub/grub.conf> interactively:"
21544 #: ../fish/guestfish.pod:102
21547 " guestfish --rw --add disk.img \\\n"
21548 " --mount /dev/vg_guest/lv_root \\\n"
21549 " --mount /dev/sda1:/boot \\\n"
21550 " edit /boot/grub/grub.conf\n"
21556 #: ../fish/guestfish.pod:107
21557 msgid "Mount disks automatically"
21562 #: ../fish/guestfish.pod:109
21564 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21569 #: ../fish/guestfish.pod:112
21572 " guestfish --ro -a disk.img -i cat /etc/group\n"
21578 #: ../fish/guestfish.pod:114
21581 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21587 #: ../fish/guestfish.pod:116
21588 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21593 #: ../fish/guestfish.pod:118
21596 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21602 #: ../fish/guestfish.pod:120
21603 msgid "As a script interpreter"
21608 #: ../fish/guestfish.pod:122
21609 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21614 #: ../fish/guestfish.pod:124
21617 " #!/usr/bin/guestfish -f\n"
21618 " sparse test1.img 100M\n"
21620 " part-disk /dev/sda mbr\n"
21621 " mkfs ext2 /dev/sda1\n"
21627 #: ../fish/guestfish.pod:130
21628 msgid "Start with a prepared disk"
21633 #: ../fish/guestfish.pod:132
21635 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21636 "single ext2-formatted partition:"
21641 #: ../fish/guestfish.pod:135
21644 " guestfish -N fs\n"
21650 #: ../fish/guestfish.pod:137
21651 msgid "To list what is available do:"
21656 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
21659 " guestfish -N help | less\n"
21665 #: ../fish/guestfish.pod:141
21666 msgid "Remote control"
21671 #: ../fish/guestfish.pod:143
21674 " eval \"`guestfish --listen`\"\n"
21675 " guestfish --remote add-ro disk.img\n"
21676 " guestfish --remote run\n"
21677 " guestfish --remote lvs\n"
21683 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21684 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
21685 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
21686 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
21687 #: ../tools/virt-list-partitions.pl:54
21693 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21694 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21695 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
21696 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
21702 #: ../fish/guestfish.pod:154
21703 msgid "Displays general help on options."
21708 #: ../fish/guestfish.pod:156
21714 #: ../fish/guestfish.pod:158
21715 msgid "B<--cmd-help>"
21720 #: ../fish/guestfish.pod:160
21721 msgid "Lists all available guestfish commands."
21726 #: ../fish/guestfish.pod:162
21732 #: ../fish/guestfish.pod:164
21733 msgid "B<--cmd-help cmd>"
21738 #: ../fish/guestfish.pod:166
21739 msgid "Displays detailed help on a single command C<cmd>."
21744 #: ../fish/guestfish.pod:168
21745 msgid "B<-a image>"
21750 #: ../fish/guestfish.pod:170
21751 msgid "B<--add image>"
21756 #: ../fish/guestfish.pod:172
21757 msgid "Add a block device or virtual machine image to the shell."
21762 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21764 "The format of the disk image is auto-detected. To override this and force a "
21765 "particular format use the I<--format=..> option."
21769 #: ../fish/guestfish.pod:177
21771 "Using this flag is mostly equivalent to using the C<add> command, with "
21772 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21773 "the I<--format=...> flag was given."
21778 #: ../fish/guestfish.pod:181
21784 #: ../fish/guestfish.pod:183
21785 msgid "B<--connect URI>"
21790 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21792 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21793 "URI to use. The default is to use the default libvirt connection."
21798 #: ../fish/guestfish.pod:189
21804 #: ../fish/guestfish.pod:191
21806 "If using the I<--listen> option and a csh-like shell, use this option. See "
21807 "section L</REMOTE CONTROL AND CSH> below."
21812 #: ../fish/guestfish.pod:194
21813 msgid "B<-d libvirt-domain>"
21818 #: ../fish/guestfish.pod:196
21819 msgid "B<--domain libvirt-domain>"
21824 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21826 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21827 "used, then any libvirt domain can be used. However in write mode, only "
21828 "libvirt domains which are shut down can be named here."
21833 #: ../fish/guestfish.pod:202
21835 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21836 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21837 "if the I<--format:...> flag was given."
21842 #: ../fish/guestfish.pod:206
21848 #: ../fish/guestfish.pod:208
21849 msgid "B<--no-dest-paths>"
21854 #: ../fish/guestfish.pod:210
21856 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21857 "to hit the tab key to complete paths on the guest filesystem, but this "
21858 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21859 "allow this feature to be disabled."
21864 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
21865 msgid "B<--echo-keys>"
21870 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
21872 "When prompting for keys and passphrases, guestfish normally turns echoing "
21873 "off so you cannot see what you are typing. If you are not worried about "
21874 "Tempest attacks and there is no one else in the room you can specify this "
21875 "flag to see what you are typing."
21880 #: ../fish/guestfish.pod:222
21886 #: ../fish/guestfish.pod:224
21887 msgid "B<--file file>"
21892 #: ../fish/guestfish.pod:226
21893 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21898 #: ../fish/guestfish.pod:229
21901 " #!/usr/bin/guestfish -f\n"
21907 #: ../fish/guestfish.pod:231
21908 msgid "B<--format=raw|qcow2|..>"
21913 #: ../fish/guestfish.pod:233
21914 msgid "B<--format>"
21919 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
21921 "The default for the I<-a> option is to auto-detect the format of the disk "
21922 "image. Using this forces the disk format for I<-a> options which follow on "
21923 "the command line. Using I<--format> with no argument switches back to auto-"
21924 "detection for subsequent I<-a> options."
21929 #: ../fish/guestfish.pod:242
21932 " guestfish --format=raw -a disk.img\n"
21938 #: ../fish/guestfish.pod:244
21939 msgid "forces raw format (no auto-detection) for C<disk.img>."
21944 #: ../fish/guestfish.pod:246
21947 " guestfish --format=raw -a disk.img --format -a another.img\n"
21953 #: ../fish/guestfish.pod:248
21955 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
21956 "detection for C<another.img>."
21961 #: ../fish/guestfish.pod:251
21963 "If you have untrusted raw-format guest disk images, you should use this "
21964 "option to specify the disk format. This avoids a possible security problem "
21965 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21970 #: ../fish/guestfish.pod:256
21976 #: ../fish/guestfish.pod:258
21977 msgid "B<--inspector>"
21982 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
21984 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21985 "system and mount filesystems as they would be mounted on the real virtual "
21991 #: ../fish/guestfish.pod:264
21992 msgid "Typical usage is either:"
21997 #: ../fish/guestfish.pod:266
22000 " guestfish -d myguest -i\n"
22006 #: ../fish/guestfish.pod:268
22007 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22012 #: ../fish/guestfish.pod:270
22015 " guestfish --ro -d myguest -i\n"
22021 #: ../fish/guestfish.pod:272
22022 msgid "(for active domains, readonly), or specify the block device directly:"
22027 #: ../fish/guestfish.pod:274
22030 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22036 #: ../fish/guestfish.pod:276
22038 "Note that the command line syntax changed slightly over older versions of "
22039 "guestfish. You can still use the old syntax:"
22044 #: ../fish/guestfish.pod:279
22047 " guestfish [--ro] -i disk.img\n"
22053 #: ../fish/guestfish.pod:281
22056 " guestfish [--ro] -i libvirt-domain\n"
22062 #: ../fish/guestfish.pod:283
22064 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22065 "then using other commands to mount the filesystems that were found."
22070 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
22071 msgid "B<--keys-from-stdin>"
22076 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
22078 "Read key or passphrase parameters from stdin. The default is to try to read "
22079 "passphrases from the user by opening C</dev/tty>."
22084 #: ../fish/guestfish.pod:292
22085 msgid "B<--listen>"
22090 #: ../fish/guestfish.pod:294
22092 "Fork into the background and listen for remote commands. See section L</"
22093 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22097 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
22102 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
22104 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22105 "ATTACHING TO RUNNING DAEMONS>)."
22109 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
22110 msgid "B<-m dev[:mountpoint[:options]]>"
22114 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
22115 msgid "B<--mount dev[:mountpoint[:options]]>"
22120 #: ../fish/guestfish.pod:306
22121 msgid "Mount the named partition or logical volume on the given mountpoint."
22126 #: ../fish/guestfish.pod:308
22127 msgid "If the mountpoint is omitted, it defaults to C</>."
22132 #: ../fish/guestfish.pod:310
22133 msgid "You have to mount something on C</> before most commands will work."
22138 #: ../fish/guestfish.pod:312
22140 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22146 #: ../fish/guestfish.pod:315
22148 "If you don't know what filesystems a disk image contains, you can either run "
22149 "guestfish without this option, then list the partitions, filesystems and LVs "
22150 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22151 "commands), or you can use the L<virt-filesystems(1)> program."
22155 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
22157 "The third (and rarely used) part of the mount parameter is the list of mount "
22158 "options used to mount the underlying filesystem. If this is not given, then "
22159 "the mount options are either the empty string or C<ro> (the latter if the "
22160 "I<--ro> flag is used). By specifying the mount options, you override this "
22161 "default choice. Probably the only time you would use this is to enable ACLs "
22162 "and/or extended attributes if the filesystem can support them:"
22166 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
22169 " -m /dev/sda1:/:acl,user_xattr\n"
22174 #: ../fish/guestfish.pod:331
22175 msgid "Using this flag is equivalent to using the C<mount-options> command."
22180 #: ../fish/guestfish.pod:333
22186 #: ../fish/guestfish.pod:335
22187 msgid "B<--no-sync>"
22192 #: ../fish/guestfish.pod:337
22194 "Disable autosync. This is enabled by default. See the discussion of "
22195 "autosync in the L<guestfs(3)> manpage."
22200 #: ../fish/guestfish.pod:340
22206 #: ../fish/guestfish.pod:342
22207 msgid "B<--new type>"
22212 #: ../fish/guestfish.pod:344
22218 #: ../fish/guestfish.pod:346
22220 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22221 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22222 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22228 #: ../fish/guestfish.pod:351
22229 msgid "B<--progress-bars>"
22234 #: ../fish/guestfish.pod:353
22235 msgid "Enable progress bars, even when guestfish is used non-interactively."
22240 #: ../fish/guestfish.pod:355
22242 "Progress bars are enabled by default when guestfish is used as an "
22243 "interactive shell."
22248 #: ../fish/guestfish.pod:358
22249 msgid "B<--no-progress-bars>"
22254 #: ../fish/guestfish.pod:360
22255 msgid "Disable progress bars."
22260 #: ../fish/guestfish.pod:362
22261 msgid "B<--remote[=pid]>"
22266 #: ../fish/guestfish.pod:364
22268 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22269 "CONTROL GUESTFISH OVER A SOCKET> below."
22274 #: ../fish/guestfish.pod:367
22280 #: ../fish/guestfish.pod:369
22286 #: ../fish/guestfish.pod:371
22288 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22289 "mounts are done read-only."
22294 #: ../fish/guestfish.pod:374
22296 "The option must always be used if the disk image or virtual machine might be "
22297 "running, and is generally recommended in cases where you don't need write "
22298 "access to the disk."
22303 #: ../fish/guestfish.pod:378
22305 "Note that prepared disk images created with I<-N> are not affected by this "
22306 "option. Also commands like C<add> are not affected - you have to specify "
22307 "the C<readonly:true> option explicitly if you need it."
22312 #: ../fish/guestfish.pod:382
22313 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22318 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
22319 msgid "B<--selinux>"
22324 #: ../fish/guestfish.pod:386
22325 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22330 #: ../fish/guestfish.pod:388
22336 #: ../fish/guestfish.pod:390
22337 msgid "B<--verbose>"
22342 #: ../fish/guestfish.pod:392
22344 "Enable very verbose messages. This is particularly useful if you find a bug."
22349 #: ../fish/guestfish.pod:395
22355 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
22356 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
22357 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
22358 #: ../tools/virt-list-partitions.pl:70
22359 msgid "B<--version>"
22364 #: ../fish/guestfish.pod:399
22365 msgid "Display the guestfish / libguestfs version number and exit."
22370 #: ../fish/guestfish.pod:401
22376 #: ../fish/guestfish.pod:403
22381 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
22383 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22384 "mounts are done read-write."
22388 #: ../fish/guestfish.pod:408
22389 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22394 #: ../fish/guestfish.pod:410
22400 #: ../fish/guestfish.pod:412
22401 msgid "Echo each command before executing it."
22406 #: ../fish/guestfish.pod:416
22407 msgid "COMMANDS ON COMMAND LINE"
22412 #: ../fish/guestfish.pod:418
22414 "Any additional (non-option) arguments are treated as commands to execute."
22419 #: ../fish/guestfish.pod:421
22421 "Commands to execute should be separated by a colon (C<:>), where the colon "
22422 "is a separate parameter. Thus:"
22427 #: ../fish/guestfish.pod:424
22430 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22436 #: ../fish/guestfish.pod:426
22438 "If there are no additional arguments, then we enter a shell, either an "
22439 "interactive shell with a prompt (if the input is a terminal) or a non-"
22440 "interactive shell."
22445 #: ../fish/guestfish.pod:430
22447 "In either command line mode or non-interactive shell, the first command that "
22448 "gives an error causes the whole shell to exit. In interactive mode (with a "
22449 "prompt) if a command fails, you can continue to enter commands."
22454 #: ../fish/guestfish.pod:435
22455 msgid "USING launch (OR run)"
22460 #: ../fish/guestfish.pod:437
22462 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22463 "then launch it, then mount any disks you need, and finally issue actions/"
22464 "commands. So the general order of the day is:"
22469 #: ../fish/guestfish.pod:445
22470 msgid "add or -a/--add"
22475 #: ../fish/guestfish.pod:449
22476 msgid "launch (aka run)"
22481 #: ../fish/guestfish.pod:453
22482 msgid "mount or -m/--mount"
22487 #: ../fish/guestfish.pod:457
22488 msgid "any other commands"
22493 #: ../fish/guestfish.pod:461
22495 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22496 "guest before mounting or performing any other commands."
22501 #: ../fish/guestfish.pod:464
22503 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22504 "I<--new> options were given then C<run> is done automatically, simply "
22505 "because guestfish can't perform the action you asked for without doing this."
22510 #: ../fish/guestfish.pod:469
22511 msgid "OPENING DISKS FOR READ AND WRITE"
22515 #: ../fish/guestfish.pod:471
22517 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22518 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22519 "I<-i> and I<-m> open disk images read-only or for writing."
22523 #: ../fish/guestfish.pod:476
22525 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
22526 "opening disk images supplied on the command line for write. To open a disk "
22527 "image read-only you have to do I<-a image --ro>."
22532 #: ../fish/guestfish.pod:480
22534 "This matters: If you accidentally open a live VM disk image writable then "
22535 "you will cause irreversible disk corruption."
22539 #: ../fish/guestfish.pod:483
22541 "By libguestfs 1.12 we intend to change the default the other way. Disk "
22542 "images will be opened read-only. You will have to either specify "
22543 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22544 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22545 "access for disk images specified by those other command line options."
22549 #: ../fish/guestfish.pod:490
22551 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22552 "which does nothing (it is already the default). However it is highly "
22553 "recommended that you use this option to indicate that you need write access, "
22554 "and prepare your scripts for the day when this option will be required for "
22560 #: ../fish/guestfish.pod:496
22562 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22563 "other libguestfs program apart from guestfish and guestmount."
22568 #: ../fish/guestfish.pod:499
22574 #: ../fish/guestfish.pod:501
22576 "You can quote ordinary parameters using either single or double quotes. For "
22582 #: ../fish/guestfish.pod:504
22585 " add \"file with a space.img\"\n"
22591 #: ../fish/guestfish.pod:506
22594 " rm '/file name'\n"
22600 #: ../fish/guestfish.pod:508
22609 #: ../fish/guestfish.pod:510
22611 "A few commands require a list of strings to be passed. For these, use a "
22612 "whitespace-separated list, enclosed in quotes. Strings containing "
22613 "whitespace to be passed through must be enclosed in single quotes. A "
22614 "literal single quote must be escaped with a backslash."
22619 #: ../fish/guestfish.pod:515
22622 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22623 " command \"/bin/echo 'foo bar'\"\n"
22624 " command \"/bin/echo \\'foo\\'\"\n"
22630 #: ../fish/guestfish.pod:519
22631 msgid "OPTIONAL ARGUMENTS"
22636 #: ../fish/guestfish.pod:521
22638 "Some commands take optional arguments. These arguments appear in this "
22639 "documentation as C<[argname:..]>. You can use them as in these examples:"
22644 #: ../fish/guestfish.pod:525
22647 " add-drive-opts filename\n"
22653 #: ../fish/guestfish.pod:527
22656 " add-drive-opts filename readonly:true\n"
22662 #: ../fish/guestfish.pod:529
22665 " add-drive-opts filename format:qcow2 readonly:false\n"
22671 #: ../fish/guestfish.pod:531
22673 "Each optional argument can appear at most once. All optional arguments must "
22674 "appear after the required ones."
22679 #: ../fish/guestfish.pod:534
22685 #: ../fish/guestfish.pod:536
22687 "This section applies to all commands which can take integers as parameters."
22692 #: ../fish/guestfish.pod:539
22693 msgid "SIZE SUFFIX"
22698 #: ../fish/guestfish.pod:541
22700 "When the command takes a parameter measured in bytes, you can use one of the "
22701 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22706 #: ../fish/guestfish.pod:547
22707 msgid "B<k> or B<K> or B<KiB>"
22712 #: ../fish/guestfish.pod:549
22713 msgid "The size in kilobytes (multiplied by 1024)."
22718 #: ../fish/guestfish.pod:551
22724 #: ../fish/guestfish.pod:553
22725 msgid "The size in SI 1000 byte units."
22730 #: ../fish/guestfish.pod:555
22731 msgid "B<M> or B<MiB>"
22736 #: ../fish/guestfish.pod:557
22737 msgid "The size in megabytes (multiplied by 1048576)."
22742 #: ../fish/guestfish.pod:559
22748 #: ../fish/guestfish.pod:561
22749 msgid "The size in SI 1000000 byte units."
22754 #: ../fish/guestfish.pod:563
22755 msgid "B<G> or B<GiB>"
22760 #: ../fish/guestfish.pod:565
22761 msgid "The size in gigabytes (multiplied by 2**30)."
22766 #: ../fish/guestfish.pod:567
22772 #: ../fish/guestfish.pod:569
22773 msgid "The size in SI 10**9 byte units."
22778 #: ../fish/guestfish.pod:571
22779 msgid "B<T> or B<TiB>"
22784 #: ../fish/guestfish.pod:573
22785 msgid "The size in terabytes (multiplied by 2**40)."
22790 #: ../fish/guestfish.pod:575
22796 #: ../fish/guestfish.pod:577
22797 msgid "The size in SI 10**12 byte units."
22802 #: ../fish/guestfish.pod:579
22803 msgid "B<P> or B<PiB>"
22808 #: ../fish/guestfish.pod:581
22809 msgid "The size in petabytes (multiplied by 2**50)."
22814 #: ../fish/guestfish.pod:583
22820 #: ../fish/guestfish.pod:585
22821 msgid "The size in SI 10**15 byte units."
22826 #: ../fish/guestfish.pod:587
22827 msgid "B<E> or B<EiB>"
22832 #: ../fish/guestfish.pod:589
22833 msgid "The size in exabytes (multiplied by 2**60)."
22838 #: ../fish/guestfish.pod:591
22844 #: ../fish/guestfish.pod:593
22845 msgid "The size in SI 10**18 byte units."
22850 #: ../fish/guestfish.pod:595
22851 msgid "B<Z> or B<ZiB>"
22856 #: ../fish/guestfish.pod:597
22857 msgid "The size in zettabytes (multiplied by 2**70)."
22862 #: ../fish/guestfish.pod:599
22868 #: ../fish/guestfish.pod:601
22869 msgid "The size in SI 10**21 byte units."
22874 #: ../fish/guestfish.pod:603
22875 msgid "B<Y> or B<YiB>"
22880 #: ../fish/guestfish.pod:605
22881 msgid "The size in yottabytes (multiplied by 2**80)."
22886 #: ../fish/guestfish.pod:607
22892 #: ../fish/guestfish.pod:609
22893 msgid "The size in SI 10**24 byte units."
22898 #: ../fish/guestfish.pod:615
22901 " truncate-size /file 1G\n"
22907 #: ../fish/guestfish.pod:617
22908 msgid "would truncate the file to 1 gigabyte."
22913 #: ../fish/guestfish.pod:619
22915 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22916 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22917 "suffix will probably not do what you expect."
22922 #: ../fish/guestfish.pod:623
22923 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22928 #: ../fish/guestfish.pod:625
22930 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22931 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22936 #: ../fish/guestfish.pod:628
22939 " 1234 decimal number 1234\n"
22940 " 02322 octal number, equivalent to decimal 1234\n"
22941 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22947 #: ../fish/guestfish.pod:632
22949 "When using the C<chmod> command, you almost always want to specify an octal "
22950 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22951 "L<chmod(1)> program):"
22956 #: ../fish/guestfish.pod:636
22959 " chmod 0777 /public # OK\n"
22960 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22966 #: ../fish/guestfish.pod:639
22968 "Commands that return numbers usually print them in decimal, but some "
22969 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22970 "octal, preceeded by C<0>)."
22975 #: ../fish/guestfish.pod:643
22976 msgid "WILDCARDS AND GLOBBING"
22981 #: ../fish/guestfish.pod:645
22983 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22984 "(globbing) by default. So for example the following will not do what you "
22990 #: ../fish/guestfish.pod:649
22999 #: ../fish/guestfish.pod:651
23001 "Assuming you don't have a directory called literally C</home/*> then the "
23002 "above command will return an error."
23007 #: ../fish/guestfish.pod:654
23008 msgid "To perform wildcard expansion, use the C<glob> command."
23013 #: ../fish/guestfish.pod:656
23016 " glob rm-rf /home/*\n"
23022 #: ../fish/guestfish.pod:658
23024 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23025 "many times), equivalent to:"
23030 #: ../fish/guestfish.pod:661
23033 " rm-rf /home/jim\n"
23034 " rm-rf /home/joe\n"
23035 " rm-rf /home/mary\n"
23041 #: ../fish/guestfish.pod:665
23042 msgid "C<glob> only works on simple guest paths and not on device names."
23047 #: ../fish/guestfish.pod:667
23049 "If you have several parameters, each containing a wildcard, then glob will "
23050 "perform a Cartesian product."
23055 #: ../fish/guestfish.pod:670
23061 #: ../fish/guestfish.pod:672
23063 "Any line which starts with a I<#> character is treated as a comment and "
23064 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23065 "a command. For example:"
23070 #: ../fish/guestfish.pod:676
23073 " # this is a comment\n"
23074 " # this is a comment\n"
23075 " foo # NOT a comment\n"
23081 #: ../fish/guestfish.pod:680
23082 msgid "Blank lines are also ignored."
23087 #: ../fish/guestfish.pod:682
23088 msgid "RUNNING COMMANDS LOCALLY"
23093 #: ../fish/guestfish.pod:684
23095 "Any line which starts with a I<!> character is treated as a command sent to "
23096 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23101 #: ../fish/guestfish.pod:688
23105 " tgz-out /remote local/remote-data.tar.gz\n"
23111 #: ../fish/guestfish.pod:691
23113 "will create a directory C<local> on the host, and then export the contents "
23114 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23115 "(See C<tgz-out>)."
23120 #: ../fish/guestfish.pod:695
23122 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23123 "effect, due to the way that subprocesses work in Unix."
23127 #: ../fish/guestfish.pod:698
23128 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23132 #: ../fish/guestfish.pod:700
23134 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23135 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23136 "and executed as guestfish commands."
23140 #: ../fish/guestfish.pod:704
23142 "Thus you can use shell script to construct arbitrary guestfish commands "
23143 "which are then parsed by guestfish."
23147 #: ../fish/guestfish.pod:707
23149 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23150 "through C</foo.100>) using guestfish commands alone. However this is simple "
23151 "if we use a shell script to create the guestfish commands for us:"
23155 #: ../fish/guestfish.pod:712
23158 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23163 #: ../fish/guestfish.pod:714
23164 msgid "or with names like C</foo.001>:"
23168 #: ../fish/guestfish.pod:716
23171 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23176 #: ../fish/guestfish.pod:718
23178 "When using guestfish interactively it can be helpful to just run the shell "
23179 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23180 "ordinary I<!> local command), see what guestfish commands it would run, and "
23181 "when you are happy with those prepend the C<E<lt>> character to run the "
23182 "guestfish commands for real."
23187 #: ../fish/guestfish.pod:724
23193 #: ../fish/guestfish.pod:726
23195 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23196 "command (a guestfish command) to the second command (any host command). For "
23202 #: ../fish/guestfish.pod:730
23205 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23211 #: ../fish/guestfish.pod:732
23213 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23214 "program). The above command would list all accounts in the guest filesystem "
23215 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23220 #: ../fish/guestfish.pod:737
23223 " hexdump /bin/ls | head\n"
23224 " list-devices | tail -1\n"
23225 " tgz-out / - | tar ztf -\n"
23231 #: ../fish/guestfish.pod:741
23233 "The space before the pipe symbol is required, any space after the pipe "
23234 "symbol is optional. Everything after the pipe symbol is just passed "
23235 "straight to the host shell, so it can contain redirections, globs and "
23236 "anything else that makes sense on the host side."
23241 #: ../fish/guestfish.pod:746
23243 "To use a literal argument which begins with a pipe symbol, you have to quote "
23249 #: ../fish/guestfish.pod:749
23258 #: ../fish/guestfish.pod:751
23259 msgid "HOME DIRECTORIES"
23264 #: ../fish/guestfish.pod:753
23266 "If a parameter starts with the character C<~> then the tilde may be expanded "
23267 "as a home directory path (either C<~> for the current user's home directory, "
23268 "or C<~user> for another user)."
23273 #: ../fish/guestfish.pod:757
23275 "Note that home directory expansion happens for users known I<on the host>, "
23276 "not in the guest filesystem."
23281 #: ../fish/guestfish.pod:760
23283 "To use a literal argument which begins with a tilde, you have to quote it, "
23289 #: ../fish/guestfish.pod:763
23298 #: ../fish/guestfish.pod:767
23300 "Libguestfs has some support for Linux guests encrypted according to the "
23301 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23302 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23303 "LUKS is supported."
23308 #: ../fish/guestfish.pod:772
23309 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23314 #: ../fish/guestfish.pod:774
23317 " ><fs> vfs-type /dev/sda2\n"
23324 #: ../fish/guestfish.pod:777
23326 "Then open those devices using L</luks-open>. This creates a device-mapper "
23327 "device called C</dev/mapper/luksdev>."
23332 #: ../fish/guestfish.pod:780
23335 " ><fs> luks-open /dev/sda2 luksdev\n"
23336 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23342 #: ../fish/guestfish.pod:783
23344 "Finally you have to tell LVM to scan for volume groups on the newly created "
23350 #: ../fish/guestfish.pod:786
23354 " vg-activate-all true\n"
23360 #: ../fish/guestfish.pod:789
23361 msgid "The logical volume(s) can now be mounted in the usual way."
23366 #: ../fish/guestfish.pod:791
23368 "Before closing a LUKS device you must unmount any logical volumes on it and "
23369 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23370 "one. Then you can close the mapper device:"
23375 #: ../fish/guestfish.pod:795
23378 " vg-activate false /dev/VG\n"
23379 " luks-close /dev/mapper/luksdev\n"
23385 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
23386 msgid "WINDOWS PATHS"
23390 #: ../fish/guestfish.pod:800
23392 "If a path is prefixed with C<win:> then you can use Windows-style drive "
23393 "letters and paths (with some limitations). The following commands are "
23399 #: ../fish/guestfish.pod:804
23402 " file /WINDOWS/system32/config/system.LOG\n"
23408 #: ../fish/guestfish.pod:806
23411 " file win:\\windows\\system32\\config\\system.log\n"
23416 #: ../fish/guestfish.pod:808
23419 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
23424 #: ../fish/guestfish.pod:810
23426 "The parameter is rewritten \"behind the scenes\" by looking up the position "
23427 "where the drive is mounted, prepending that to the path, changing all "
23428 "backslash characters to forward slash, then resolving the result using L</"
23429 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
23430 "the parameter might be rewritten like this:"
23434 #: ../fish/guestfish.pod:816
23437 " win:e:\\foo\\bar => /e/FOO/bar\n"
23442 #: ../fish/guestfish.pod:818
23443 msgid "This only works in argument positions that expect a path."
23448 #: ../fish/guestfish.pod:820
23449 msgid "UPLOADING AND DOWNLOADING FILES"
23454 #: ../fish/guestfish.pod:822
23456 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23457 "others which upload from or download to a local file, you can use the "
23458 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23463 #: ../fish/guestfish.pod:826
23472 #: ../fish/guestfish.pod:828
23474 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23479 #: ../fish/guestfish.pod:831
23482 " tar-out /etc - | tar tf -\n"
23488 #: ../fish/guestfish.pod:833
23490 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23491 "command (see L</PIPES>)."
23496 #: ../fish/guestfish.pod:836
23498 "When using C<-> to read from stdin, the input is read up to the end of "
23499 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23500 "some arbitrary end marker:"
23505 #: ../fish/guestfish.pod:840
23508 " upload -<<END /foo\n"
23518 #: ../fish/guestfish.pod:846
23520 "Any string of characters can be used instead of C<END>. The end marker must "
23521 "appear on a line of its own, without any preceeding or following characters "
23522 "(not even spaces)."
23527 #: ../fish/guestfish.pod:850
23529 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23530 "upload local files (so-called \"FileIn\" parameters in the generator)."
23535 #: ../fish/guestfish.pod:853
23536 msgid "EXIT ON ERROR BEHAVIOUR"
23541 #: ../fish/guestfish.pod:855
23543 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23544 "taking commands from a human over a tty), and will exit on the first error "
23545 "in non-interactive mode (scripts, commands given on the command line)."
23550 #: ../fish/guestfish.pod:860
23552 "If you prefix a command with a I<-> character, then that command will not "
23553 "cause guestfish to exit, even if that (one) command returns an error."
23558 #: ../fish/guestfish.pod:864
23559 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23564 #: ../fish/guestfish.pod:866
23566 "Guestfish can be remote-controlled over a socket. This is useful "
23567 "particularly in shell scripts where you want to make several different "
23568 "changes to a filesystem, but you don't want the overhead of starting up a "
23569 "guestfish process each time."
23574 #: ../fish/guestfish.pod:871
23575 msgid "Start a guestfish server process using:"
23580 #: ../fish/guestfish.pod:873
23583 " eval \"`guestfish --listen`\"\n"
23589 #: ../fish/guestfish.pod:875
23590 msgid "and then send it commands by doing:"
23595 #: ../fish/guestfish.pod:877
23598 " guestfish --remote cmd [...]\n"
23604 #: ../fish/guestfish.pod:879
23605 msgid "To cause the server to exit, send it the exit command:"
23610 #: ../fish/guestfish.pod:881
23613 " guestfish --remote exit\n"
23619 #: ../fish/guestfish.pod:883
23621 "Note that the server will normally exit if there is an error in a command. "
23622 "You can change this in the usual way. See section L</EXIT ON ERROR "
23628 #: ../fish/guestfish.pod:887
23629 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23634 #: ../fish/guestfish.pod:889
23636 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23637 "is how the I<--remote> option knows where to send the commands. You can "
23638 "have several guestfish listener processes running using:"
23643 #: ../fish/guestfish.pod:893
23646 " eval \"`guestfish --listen`\"\n"
23647 " pid1=$GUESTFISH_PID\n"
23648 " eval \"`guestfish --listen`\"\n"
23649 " pid2=$GUESTFISH_PID\n"
23651 " guestfish --remote=$pid1 cmd\n"
23652 " guestfish --remote=$pid2 cmd\n"
23658 #: ../fish/guestfish.pod:901
23659 msgid "REMOTE CONTROL AND CSH"
23664 #: ../fish/guestfish.pod:903
23666 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23672 #: ../fish/guestfish.pod:906
23675 " eval \"`guestfish --listen --csh`\"\n"
23681 #: ../fish/guestfish.pod:908
23682 msgid "REMOTE CONTROL DETAILS"
23687 #: ../fish/guestfish.pod:910
23689 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23690 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23691 "and C<$PID> is the process ID of the server."
23696 #: ../fish/guestfish.pod:914
23697 msgid "Guestfish client and server versions must match exactly."
23702 #: ../fish/guestfish.pod:916
23703 msgid "PREPARED DISK IMAGES"
23708 #: ../fish/guestfish.pod:918
23710 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23711 "preformatted disk images that guestfish can make for you to save typing. "
23712 "This is particularly useful for testing purposes. This option is used "
23713 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23714 "can be mixed with I<-a>)."
23719 #: ../fish/guestfish.pod:924
23721 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23722 "the second and so on. Existing files in the current directory are "
23728 #: ../fish/guestfish.pod:928
23730 "The type briefly describes how the disk should be sized, partitioned, how "
23731 "filesystem(s) should be created, and how content should be added. "
23732 "Optionally the type can be followed by extra parameters, separated by C<:> "
23733 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23734 "allocated disk, containing a single partition, with the partition formatted "
23735 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23741 #: ../fish/guestfish.pod:936
23742 msgid "To list the available types and any extra parameters they take, run:"
23747 #: ../fish/guestfish.pod:940
23749 "Note that the prepared filesystem is not mounted. You would usually have to "
23750 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23755 #: ../fish/guestfish.pod:944
23757 "If any I<-N> or I<--new> options are given, the guest is automatically "
23763 #: ../fish/guestfish.pod:949
23764 msgid "Create a 100MB disk with an ext4-formatted partition:"
23769 #: ../fish/guestfish.pod:951
23772 " guestfish -N fs:ext4\n"
23778 #: ../fish/guestfish.pod:953
23779 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23784 #: ../fish/guestfish.pod:955
23787 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23793 #: ../fish/guestfish.pod:957
23794 msgid "Create a blank 200MB disk:"
23799 #: ../fish/guestfish.pod:959
23802 " guestfish -N disk:200M\n"
23808 #: ../fish/guestfish.pod:961
23809 msgid "PROGRESS BARS"
23814 #: ../fish/guestfish.pod:963
23816 "Some (not all) long-running commands send progress notification messages as "
23817 "they are running. Guestfish turns these messages into progress bars."
23822 #: ../fish/guestfish.pod:967
23824 "When a command that supports progress bars takes longer than two seconds to "
23825 "run, and if progress bars are enabled, then you will see one appearing below "
23831 #: ../fish/guestfish.pod:971
23834 " ><fs> copy-size /large-file /another-file 2048M\n"
23835 " / 10% [#####-----------------------------------------] 00:30\n"
23841 #: ../fish/guestfish.pod:974
23843 "The spinner on the left hand side moves round once for every progress "
23844 "notification received from the backend. This is a (reasonably) golden "
23845 "assurance that the command is \"doing something\" even if the progress bar "
23846 "is not moving, because the command is able to send the progress "
23847 "notifications. When the bar reaches 100% and the command finishes, the "
23848 "spinner disappears."
23853 #: ../fish/guestfish.pod:981
23855 "Progress bars are enabled by default when guestfish is used interactively. "
23856 "You can enable them even for non-interactive modes using I<--progress-bars>, "
23857 "and you can disable them completely using I<--no-progress-bars>."
23862 #: ../fish/guestfish.pod:986
23863 msgid "GUESTFISH COMMANDS"
23868 #: ../fish/guestfish.pod:988
23870 "The commands in this section are guestfish convenience commands, in other "
23871 "words, they are not part of the L<guestfs(3)> API."
23876 #: ../fish/guestfish.pod:991
23882 #: ../fish/guestfish.pod:993
23892 #: ../fish/guestfish.pod:996
23893 msgid "Without any parameter, this provides general help."
23898 #: ../fish/guestfish.pod:998
23899 msgid "With a C<cmd> parameter, this displays detailed help for that command."
23904 #: ../fish/guestfish.pod:1000
23905 msgid "quit | exit"
23910 #: ../fish/guestfish.pod:1002
23911 msgid "This exits guestfish. You can also use C<^D> key."
23916 #: ../fish/guestfish.pod:1004
23917 msgid "@FISH_COMMANDS@"
23922 #: ../fish/guestfish.pod:1006
23928 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
23934 #: ../fish/guestfish.pod:1012
23936 "guestfish returns 0 if the commands completed without error, or 1 if there "
23942 #: ../fish/guestfish.pod:1019
23948 #: ../fish/guestfish.pod:1021
23950 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23956 #: ../fish/guestfish.pod:1024
23957 msgid "GUESTFISH_PID"
23962 #: ../fish/guestfish.pod:1026
23964 "Used with the I<--remote> option to specify the remote guestfish process to "
23965 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23970 #: ../fish/guestfish.pod:1030
23976 #: ../fish/guestfish.pod:1032
23978 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23979 "not specified, the external L<hexedit(1)> program is used."
23984 #: ../fish/guestfish.pod:1036
23990 #: ../fish/guestfish.pod:1038
23992 "If compiled with GNU readline support, various files in the home directory "
23993 "can be used. See L</FILES>."
23998 #: ../fish/guestfish.pod:1047
24000 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
24001 "effect as using the B<-v> option."
24006 #: ../fish/guestfish.pod:1059
24008 "Set the path that guestfish uses to search for kernel and initrd.img. See "
24009 "the discussion of paths in L<guestfs(3)>."
24014 #: ../fish/guestfish.pod:1070
24015 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24020 #: ../fish/guestfish.pod:1072
24026 #: ../fish/guestfish.pod:1074
24028 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24034 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:252
24039 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:256
24040 msgid "$HOME/.libguestfs-tools.rc"
24044 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
24045 msgid "/etc/libguestfs-tools.conf"
24049 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
24051 "This configuration file controls the default read-only or read-write mode "
24052 "(I<--ro> or I<--rw>)."
24056 #: ../fish/guestfish.pod:1101
24057 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24062 #: ../fish/guestfish.pod:1103
24063 msgid "$HOME/.guestfish"
24068 #: ../fish/guestfish.pod:1105
24070 "If compiled with GNU readline support, then the command history is saved in "
24076 #: ../fish/guestfish.pod:1108
24077 msgid "$HOME/.inputrc"
24082 #: ../fish/guestfish.pod:1110
24083 msgid "/etc/inputrc"
24088 #: ../fish/guestfish.pod:1112
24090 "If compiled with GNU readline support, then these files can be used to "
24091 "configure readline. For further information, please see L<readline(3)/"
24092 "INITIALIZATION FILE>."
24097 #: ../fish/guestfish.pod:1116
24098 msgid "To write rules which only apply to guestfish, use:"
24103 #: ../fish/guestfish.pod:1118
24114 #: ../fish/guestfish.pod:1122
24116 "Variables that you can set in inputrc that change the behaviour of guestfish "
24117 "in useful ways include:"
24122 #: ../fish/guestfish.pod:1127
24123 msgid "completion-ignore-case (default: on)"
24128 #: ../fish/guestfish.pod:1129
24130 "By default, guestfish will ignore case when tab-completing paths on the "
24136 #: ../fish/guestfish.pod:1132
24139 " set completion-ignore-case off\n"
24145 #: ../fish/guestfish.pod:1134
24146 msgid "to make guestfish case sensitive."
24151 #: ../fish/guestfish.pod:1138
24157 #: ../fish/guestfish.pod:1140
24158 msgid "test2.img (etc)"
24163 #: ../fish/guestfish.pod:1142
24165 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
24166 "will be created in the file C<test1.img> in the current directory. The "
24167 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
24168 "the same name will be overwritten."
24172 #: ../fish/guestfish.pod:1151
24174 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24175 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24176 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24177 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24178 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24179 ">, L<hexedit(1)>."
24184 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
24185 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
24186 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
24187 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
24188 #: ../tools/virt-list-partitions.pl:277
24190 "This program is free software; you can redistribute it and/or modify it "
24191 "under the terms of the GNU General Public License as published by the Free "
24192 "Software Foundation; either version 2 of the License, or (at your option) "
24193 "any later version."
24198 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
24199 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
24200 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
24201 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
24202 #: ../tools/virt-list-partitions.pl:282
24204 "This program is distributed in the hope that it will be useful, but WITHOUT "
24205 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24206 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24212 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
24213 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
24214 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
24215 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
24216 #: ../tools/virt-list-partitions.pl:287
24218 "You should have received a copy of the GNU General Public License along with "
24219 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24220 "Ave, Cambridge, MA 02139, USA."
24225 #: ../fish/guestfish-actions.pod:1
24231 #: ../fish/guestfish-actions.pod:3
24234 " add-cdrom filename\n"
24240 #: ../fish/guestfish-actions.pod:15
24242 "This call checks for the existence of C<filename>. This stops you from "
24243 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24244 "and C<http:> URLs. To specify those, use the general L</config> call "
24250 #: ../fish/guestfish-actions.pod:22
24252 "If you just want to add an ISO file (often you use this as an efficient way "
24253 "to transfer large files into the guest), then you should probably use L</add-"
24254 "drive-ro> instead."
24259 #: ../fish/guestfish-actions.pod:35
24265 #: ../fish/guestfish-actions.pod:37
24270 #: ../fish/guestfish-actions.pod:39
24273 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24279 #: ../fish/guestfish-actions.pod:41
24281 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24282 "It works by connecting to libvirt, requesting the domain and domain XML from "
24283 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24288 #: ../fish/guestfish-actions.pod:71
24290 "The other optional parameters are passed directly through to L</add-drive-"
24296 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24297 #: ../fish/guestfish-actions.pod:3047
24299 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24304 #: ../fish/guestfish-actions.pod:76
24310 #: ../fish/guestfish-actions.pod:78
24313 " add-drive filename\n"
24319 #: ../fish/guestfish-actions.pod:80
24321 "This function is the equivalent of calling L</add-drive-opts> with no "
24322 "optional parameters, so the disk is added writable, with the format being "
24323 "detected automatically."
24328 #: ../fish/guestfish-actions.pod:84
24330 "Automatic detection of the format opens you up to a potential security hole "
24331 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24332 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24333 "you should think about replacing calls to this function with calls to L</add-"
24334 "drive-opts>, and specifying the format."
24339 #: ../fish/guestfish-actions.pod:91
24340 msgid "add-drive-opts"
24345 #: ../fish/guestfish-actions.pod:93
24351 #: ../fish/guestfish-actions.pod:95
24354 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24360 #: ../fish/guestfish-actions.pod:122
24362 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24363 "add-drive-ro>) then the format is automatically detected. Possible formats "
24364 "include C<raw> and C<qcow2>."
24369 #: ../fish/guestfish-actions.pod:133
24371 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24372 "add-drive-with-if> call (q.v.)"
24377 #: ../fish/guestfish-actions.pod:140
24378 msgid "add-drive-ro"
24383 #: ../fish/guestfish-actions.pod:142
24389 #: ../fish/guestfish-actions.pod:144
24392 " add-drive-ro filename\n"
24398 #: ../fish/guestfish-actions.pod:146
24400 "This function is the equivalent of calling L</add-drive-opts> with the "
24401 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24402 "is added read-only, with the format being detected automatically."
24407 #: ../fish/guestfish-actions.pod:151
24408 msgid "add-drive-ro-with-if"
24413 #: ../fish/guestfish-actions.pod:153
24416 " add-drive-ro-with-if filename iface\n"
24422 #: ../fish/guestfish-actions.pod:155
24424 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24425 "interface emulation to use at run time."
24430 #: ../fish/guestfish-actions.pod:165
24431 msgid "add-drive-with-if"
24436 #: ../fish/guestfish-actions.pod:167
24439 " add-drive-with-if filename iface\n"
24445 #: ../fish/guestfish-actions.pod:169
24447 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24448 "interface emulation to use at run time."
24453 #: ../fish/guestfish-actions.pod:179
24459 #: ../fish/guestfish-actions.pod:181
24462 " aug-clear augpath\n"
24468 #: ../fish/guestfish-actions.pod:186
24474 #: ../fish/guestfish-actions.pod:188
24483 #: ../fish/guestfish-actions.pod:190
24485 "Close the current Augeas handle and free up any resources used by it. After "
24486 "calling this, you have to call L</aug-init> again before you can use any "
24487 "other Augeas functions."
24492 #: ../fish/guestfish-actions.pod:195
24493 msgid "aug-defnode"
24498 #: ../fish/guestfish-actions.pod:197
24501 " aug-defnode name expr val\n"
24507 #: ../fish/guestfish-actions.pod:202
24509 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24510 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24511 "containing that single node."
24516 #: ../fish/guestfish-actions.pod:210
24522 #: ../fish/guestfish-actions.pod:212
24525 " aug-defvar name expr\n"
24531 #: ../fish/guestfish-actions.pod:221
24537 #: ../fish/guestfish-actions.pod:223
24540 " aug-get augpath\n"
24546 #: ../fish/guestfish-actions.pod:228
24552 #: ../fish/guestfish-actions.pod:230
24555 " aug-init root flags\n"
24561 #: ../fish/guestfish-actions.pod:236
24562 msgid "You must call this before using any other L</aug-*> commands."
24567 #: ../fish/guestfish-actions.pod:271
24568 msgid "Do not load the tree in L</aug-init>."
24573 #: ../fish/guestfish-actions.pod:275
24574 msgid "To close the handle, you can call L</aug-close>."
24579 #: ../fish/guestfish-actions.pod:279
24585 #: ../fish/guestfish-actions.pod:281
24588 " aug-insert augpath label true|false\n"
24594 #: ../fish/guestfish-actions.pod:291
24600 #: ../fish/guestfish-actions.pod:293
24609 #: ../fish/guestfish-actions.pod:300
24615 #: ../fish/guestfish-actions.pod:302
24618 " aug-ls augpath\n"
24624 #: ../fish/guestfish-actions.pod:304
24626 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24627 "resulting nodes into alphabetical order."
24632 #: ../fish/guestfish-actions.pod:307
24638 #: ../fish/guestfish-actions.pod:309
24641 " aug-match augpath\n"
24647 #: ../fish/guestfish-actions.pod:315
24653 #: ../fish/guestfish-actions.pod:317
24656 " aug-mv src dest\n"
24662 #: ../fish/guestfish-actions.pod:322
24668 #: ../fish/guestfish-actions.pod:324
24671 " aug-rm augpath\n"
24677 #: ../fish/guestfish-actions.pod:330
24683 #: ../fish/guestfish-actions.pod:332
24692 #: ../fish/guestfish-actions.pod:336
24694 "The flags which were passed to L</aug-init> affect exactly how files are "
24700 #: ../fish/guestfish-actions.pod:339
24706 #: ../fish/guestfish-actions.pod:341
24709 " aug-set augpath val\n"
24715 #: ../fish/guestfish-actions.pod:345
24717 "In the Augeas API, it is possible to clear a node by setting the value to "
24718 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24719 "this call. Instead you must use the L</aug-clear> call."
24724 #: ../fish/guestfish-actions.pod:350
24730 #: ../fish/guestfish-actions.pod:352
24733 " available 'groups ...'\n"
24739 #: ../fish/guestfish-actions.pod:358
24741 "The libguestfs groups, and the functions that those groups correspond to, "
24742 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24743 "runtime by calling L</available-all-groups>."
24748 #: ../fish/guestfish-actions.pod:382
24749 msgid "You must call L</launch> before calling this function."
24754 #: ../fish/guestfish-actions.pod:404
24756 "This call was added in version C<1.0.80>. In previous versions of "
24757 "libguestfs all you could do would be to speculatively execute a command to "
24758 "find out if the daemon implemented it. See also L</version>."
24763 #: ../fish/guestfish-actions.pod:411
24764 msgid "available-all-groups"
24769 #: ../fish/guestfish-actions.pod:413
24772 " available-all-groups\n"
24778 #: ../fish/guestfish-actions.pod:415
24780 "This command returns a list of all optional groups that this daemon knows "
24781 "about. Note this returns both supported and unsupported groups. To find "
24782 "out which ones the daemon can actually support you have to call L</"
24783 "available> on each member of the returned list."
24788 #: ../fish/guestfish-actions.pod:421
24789 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24794 #: ../fish/guestfish-actions.pod:423
24800 #: ../fish/guestfish-actions.pod:425
24803 " base64-in (base64file|-) filename\n"
24809 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24810 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24811 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24812 #: ../fish/guestfish-actions.pod:4445 ../fish/guestfish-actions.pod:4457
24813 #: ../fish/guestfish-actions.pod:4468 ../fish/guestfish-actions.pod:4479
24814 #: ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4540
24815 #: ../fish/guestfish-actions.pod:4594 ../fish/guestfish-actions.pod:4617
24816 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24821 #: ../fish/guestfish-actions.pod:432
24827 #: ../fish/guestfish-actions.pod:434
24830 " base64-out filename (base64file|-)\n"
24836 #: ../fish/guestfish-actions.pod:441
24837 msgid "blockdev-flushbufs"
24842 #: ../fish/guestfish-actions.pod:443
24845 " blockdev-flushbufs device\n"
24851 #: ../fish/guestfish-actions.pod:450
24852 msgid "blockdev-getbsz"
24857 #: ../fish/guestfish-actions.pod:452
24860 " blockdev-getbsz device\n"
24866 #: ../fish/guestfish-actions.pod:461
24867 msgid "blockdev-getro"
24872 #: ../fish/guestfish-actions.pod:463
24875 " blockdev-getro device\n"
24881 #: ../fish/guestfish-actions.pod:470
24882 msgid "blockdev-getsize64"
24887 #: ../fish/guestfish-actions.pod:472
24890 " blockdev-getsize64 device\n"
24896 #: ../fish/guestfish-actions.pod:476
24897 msgid "See also L</blockdev-getsz>."
24902 #: ../fish/guestfish-actions.pod:480
24903 msgid "blockdev-getss"
24908 #: ../fish/guestfish-actions.pod:482
24911 " blockdev-getss device\n"
24917 #: ../fish/guestfish-actions.pod:487
24919 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
24924 #: ../fish/guestfish-actions.pod:492
24925 msgid "blockdev-getsz"
24930 #: ../fish/guestfish-actions.pod:494
24933 " blockdev-getsz device\n"
24939 #: ../fish/guestfish-actions.pod:499
24941 "See also L</blockdev-getss> for the real sector size of the device, and L</"
24942 "blockdev-getsize64> for the more useful I<size in bytes>."
24947 #: ../fish/guestfish-actions.pod:505
24948 msgid "blockdev-rereadpt"
24953 #: ../fish/guestfish-actions.pod:507
24956 " blockdev-rereadpt device\n"
24962 #: ../fish/guestfish-actions.pod:513
24963 msgid "blockdev-setbsz"
24968 #: ../fish/guestfish-actions.pod:515
24971 " blockdev-setbsz device blocksize\n"
24977 #: ../fish/guestfish-actions.pod:524
24978 msgid "blockdev-setro"
24983 #: ../fish/guestfish-actions.pod:526
24986 " blockdev-setro device\n"
24992 #: ../fish/guestfish-actions.pod:532
24993 msgid "blockdev-setrw"
24998 #: ../fish/guestfish-actions.pod:534
25001 " blockdev-setrw device\n"
25007 #: ../fish/guestfish-actions.pod:540
25008 msgid "case-sensitive-path"
25013 #: ../fish/guestfish-actions.pod:542
25016 " case-sensitive-path path\n"
25022 #: ../fish/guestfish-actions.pod:566
25024 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25025 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25026 "the directories were originally created under Windows)."
25031 #: ../fish/guestfish-actions.pod:574
25032 msgid "See also L</realpath>."
25037 #: ../fish/guestfish-actions.pod:576
25043 #: ../fish/guestfish-actions.pod:578
25052 #: ../fish/guestfish-actions.pod:582
25054 "Note that this function cannot correctly handle binary files (specifically, "
25055 "files containing C<\\0> character which is treated as end of string). For "
25056 "those you need to use the L</read-file> or L</download> functions which have "
25057 "a more complex interface."
25062 #: ../fish/guestfish-actions.pod:590
25068 #: ../fish/guestfish-actions.pod:592
25071 " checksum csumtype path\n"
25077 #: ../fish/guestfish-actions.pod:635
25078 msgid "To get the checksum for a device, use L</checksum-device>."
25083 #: ../fish/guestfish-actions.pod:637
25084 msgid "To get the checksums for many files, use L</checksums-out>."
25089 #: ../fish/guestfish-actions.pod:639
25090 msgid "checksum-device"
25095 #: ../fish/guestfish-actions.pod:641
25098 " checksum-device csumtype device\n"
25104 #: ../fish/guestfish-actions.pod:643
25106 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25107 "device named C<device>. For the types of checksums supported see the L</"
25108 "checksum> command."
25113 #: ../fish/guestfish-actions.pod:647
25114 msgid "checksums-out"
25119 #: ../fish/guestfish-actions.pod:649
25122 " checksums-out csumtype directory (sumsfile|-)\n"
25128 #: ../fish/guestfish-actions.pod:665
25134 #: ../fish/guestfish-actions.pod:667
25137 " chmod mode path\n"
25143 #: ../fish/guestfish-actions.pod:678
25149 #: ../fish/guestfish-actions.pod:680
25152 " chown owner group path\n"
25158 #: ../fish/guestfish-actions.pod:688
25164 #: ../fish/guestfish-actions.pod:690
25167 " command 'arguments ...'\n"
25173 #: ../fish/guestfish-actions.pod:697
25175 "The single parameter is an argv-style list of arguments. The first element "
25176 "is the name of the program to run. Subsequent elements are parameters. The "
25177 "list must be non-empty (ie. must contain a program name). Note that the "
25178 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25183 #: ../fish/guestfish-actions.pod:725
25184 msgid "command-lines"
25189 #: ../fish/guestfish-actions.pod:727
25192 " command-lines 'arguments ...'\n"
25198 #: ../fish/guestfish-actions.pod:729
25200 "This is the same as L</command>, but splits the result into a list of lines."
25205 #: ../fish/guestfish-actions.pod:732
25206 msgid "See also: L</sh-lines>"
25211 #: ../fish/guestfish-actions.pod:737
25217 #: ../fish/guestfish-actions.pod:739
25220 " config qemuparam qemuvalue\n"
25226 #: ../fish/guestfish-actions.pod:750
25232 #: ../fish/guestfish-actions.pod:752
25235 " copy-size src dest size\n"
25241 #: ../fish/guestfish-actions.pod:760
25247 #: ../fish/guestfish-actions.pod:762
25256 #: ../fish/guestfish-actions.pod:767
25262 #: ../fish/guestfish-actions.pod:769
25271 #: ../fish/guestfish-actions.pod:774
25277 #: ../fish/guestfish-actions.pod:776
25286 #: ../fish/guestfish-actions.pod:783
25288 "If the destination is a device, it must be as large or larger than the "
25289 "source file or device, otherwise the copy will fail. This command cannot do "
25290 "partial copies (see L</copy-size>)."
25295 #: ../fish/guestfish-actions.pod:787
25301 #: ../fish/guestfish-actions.pod:789
25310 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25312 "This command is mostly useful for interactive sessions. It is I<not> "
25313 "intended that you try to parse the output string. Use L</statvfs> from "
25319 #: ../fish/guestfish-actions.pod:797
25325 #: ../fish/guestfish-actions.pod:799
25334 #: ../fish/guestfish-actions.pod:808
25340 #: ../fish/guestfish-actions.pod:810
25349 #: ../fish/guestfish-actions.pod:816
25351 "Another way to get the same information is to enable verbose messages with "
25352 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25353 "before running the program."
25358 #: ../fish/guestfish-actions.pod:821
25364 #: ../fish/guestfish-actions.pod:823
25367 " download remotefilename (filename|-)\n"
25373 #: ../fish/guestfish-actions.pod:830
25374 msgid "See also L</upload>, L</cat>."
25379 #: ../fish/guestfish-actions.pod:834
25380 msgid "download-offset"
25385 #: ../fish/guestfish-actions.pod:836
25388 " download-offset remotefilename (filename|-) offset size\n"
25394 #: ../fish/guestfish-actions.pod:844
25396 "Note that there is no limit on the amount of data that can be downloaded "
25397 "with this call, unlike with L</pread>, and this call always reads the full "
25398 "amount unless an error occurs."
25403 #: ../fish/guestfish-actions.pod:849
25404 msgid "See also L</download>, L</pread>."
25409 #: ../fish/guestfish-actions.pod:853
25410 msgid "drop-caches"
25415 #: ../fish/guestfish-actions.pod:855
25418 " drop-caches whattodrop\n"
25424 #: ../fish/guestfish-actions.pod:867
25430 #: ../fish/guestfish-actions.pod:869
25439 #: ../fish/guestfish-actions.pod:881
25445 #: ../fish/guestfish-actions.pod:883
25448 " e2fsck-f device\n"
25454 #: ../fish/guestfish-actions.pod:889
25456 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25457 "should use L</fsck>."
25462 #: ../fish/guestfish-actions.pod:892
25463 msgid "echo-daemon"
25468 #: ../fish/guestfish-actions.pod:894
25471 " echo-daemon 'words ...'\n"
25477 #: ../fish/guestfish-actions.pod:901
25478 msgid "See also L</ping-daemon>."
25483 #: ../fish/guestfish-actions.pod:903
25489 #: ../fish/guestfish-actions.pod:905
25492 " egrep regex path\n"
25498 #: ../fish/guestfish-actions.pod:913
25504 #: ../fish/guestfish-actions.pod:915
25507 " egrepi regex path\n"
25513 #: ../fish/guestfish-actions.pod:923
25519 #: ../fish/guestfish-actions.pod:925
25522 " equal file1 file2\n"
25528 #: ../fish/guestfish-actions.pod:932
25534 #: ../fish/guestfish-actions.pod:934
25543 #: ../fish/guestfish-actions.pod:939
25544 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25549 #: ../fish/guestfish-actions.pod:941
25555 #: ../fish/guestfish-actions.pod:943
25558 " fallocate path len\n"
25564 #: ../fish/guestfish-actions.pod:960
25565 msgid "fallocate64"
25570 #: ../fish/guestfish-actions.pod:962
25573 " fallocate64 path len\n"
25579 #: ../fish/guestfish-actions.pod:968
25581 "Note that this call allocates disk blocks for the file. To create a sparse "
25582 "file use L</truncate-size> instead."
25587 #: ../fish/guestfish-actions.pod:971
25589 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25590 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25591 "maximum size of files created through that call to 1GB."
25596 #: ../fish/guestfish-actions.pod:980
25602 #: ../fish/guestfish-actions.pod:982
25605 " fgrep pattern path\n"
25611 #: ../fish/guestfish-actions.pod:990
25617 #: ../fish/guestfish-actions.pod:992
25620 " fgrepi pattern path\n"
25626 #: ../fish/guestfish-actions.pod:1000
25632 #: ../fish/guestfish-actions.pod:1002
25641 #: ../fish/guestfish-actions.pod:1014
25643 "This command can also be used on C</dev/> devices (and partitions, LV "
25644 "names). You can for example use this to determine if a device contains a "
25645 "filesystem, although it's usually better to use L</vfs-type>."
25650 #: ../fish/guestfish-actions.pod:1024
25651 msgid "file-architecture"
25656 #: ../fish/guestfish-actions.pod:1026
25659 " file-architecture filename\n"
25665 #: ../fish/guestfish-actions.pod:1129
25671 #: ../fish/guestfish-actions.pod:1131
25680 #: ../fish/guestfish-actions.pod:1135
25682 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25683 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25688 #: ../fish/guestfish-actions.pod:1139
25694 #: ../fish/guestfish-actions.pod:1141
25697 " fill c len path\n"
25703 #: ../fish/guestfish-actions.pod:1147
25705 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25706 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25707 "L</fill-pattern>."
25712 #: ../fish/guestfish-actions.pod:1152
25713 msgid "fill-pattern"
25718 #: ../fish/guestfish-actions.pod:1154
25721 " fill-pattern pattern len path\n"
25727 #: ../fish/guestfish-actions.pod:1156
25729 "This function is like L</fill> except that it creates a new file of length "
25730 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25731 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25737 #: ../fish/guestfish-actions.pod:1161
25743 #: ../fish/guestfish-actions.pod:1163
25746 " find directory\n"
25752 #: ../fish/guestfish-actions.pod:1177
25753 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25758 #: ../fish/guestfish-actions.pod:1190
25759 msgid "See also L</find0>."
25764 #: ../fish/guestfish-actions.pod:1195
25770 #: ../fish/guestfish-actions.pod:1197
25773 " find0 directory (files|-)\n"
25779 #: ../fish/guestfish-actions.pod:1203
25781 "This command works the same way as L</find> with the following exceptions:"
25786 #: ../fish/guestfish-actions.pod:1230
25787 msgid "findfs-label"
25792 #: ../fish/guestfish-actions.pod:1232
25795 " findfs-label label\n"
25801 #: ../fish/guestfish-actions.pod:1238
25802 msgid "To find the label of a filesystem, use L</vfs-label>."
25807 #: ../fish/guestfish-actions.pod:1240
25808 msgid "findfs-uuid"
25813 #: ../fish/guestfish-actions.pod:1242
25816 " findfs-uuid uuid\n"
25822 #: ../fish/guestfish-actions.pod:1248
25823 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25828 #: ../fish/guestfish-actions.pod:1250
25834 #: ../fish/guestfish-actions.pod:1252
25837 " fsck fstype device\n"
25843 #: ../fish/guestfish-actions.pod:1282
25849 #: ../fish/guestfish-actions.pod:1284
25857 #: ../fish/guestfish-actions.pod:1291
25858 msgid "get-attach-method"
25862 #: ../fish/guestfish-actions.pod:1293
25865 " get-attach-method\n"
25870 #: ../fish/guestfish-actions.pod:1295
25871 msgid "Return the current attach method. See L</set-attach-method>."
25876 #: ../fish/guestfish-actions.pod:1297
25877 msgid "get-autosync"
25882 #: ../fish/guestfish-actions.pod:1299
25891 #: ../fish/guestfish-actions.pod:1303
25897 #: ../fish/guestfish-actions.pod:1305
25906 #: ../fish/guestfish-actions.pod:1309
25907 msgid "get-e2label"
25912 #: ../fish/guestfish-actions.pod:1311
25915 " get-e2label device\n"
25921 #: ../fish/guestfish-actions.pod:1323
25927 #: ../fish/guestfish-actions.pod:1325
25930 " get-e2uuid device\n"
25936 #: ../fish/guestfish-actions.pod:1337
25937 msgid "get-memsize"
25942 #: ../fish/guestfish-actions.pod:1339
25951 #: ../fish/guestfish-actions.pod:1344
25953 "If L</set-memsize> was not called on this handle, and if "
25954 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
25955 "value for memsize."
25960 #: ../fish/guestfish-actions.pod:1351
25961 msgid "get-network"
25966 #: ../fish/guestfish-actions.pod:1353
25975 #: ../fish/guestfish-actions.pod:1357
25981 #: ../fish/guestfish-actions.pod:1359
25990 #: ../fish/guestfish-actions.pod:1366
25996 #: ../fish/guestfish-actions.pod:1368
26002 #: ../fish/guestfish-actions.pod:1370
26011 #: ../fish/guestfish-actions.pod:1377
26017 #: ../fish/guestfish-actions.pod:1379
26026 #: ../fish/guestfish-actions.pod:1386
26027 msgid "get-recovery-proc"
26032 #: ../fish/guestfish-actions.pod:1388
26035 " get-recovery-proc\n"
26041 #: ../fish/guestfish-actions.pod:1392
26042 msgid "get-selinux"
26047 #: ../fish/guestfish-actions.pod:1394
26056 #: ../fish/guestfish-actions.pod:1396
26058 "This returns the current setting of the selinux flag which is passed to the "
26059 "appliance at boot time. See L</set-selinux>."
26064 #: ../fish/guestfish-actions.pod:1402
26070 #: ../fish/guestfish-actions.pod:1404
26079 #: ../fish/guestfish-actions.pod:1411
26085 #: ../fish/guestfish-actions.pod:1413
26094 #: ../fish/guestfish-actions.pod:1417
26100 #: ../fish/guestfish-actions.pod:1419
26109 #: ../fish/guestfish-actions.pod:1421
26111 "Return the current umask. By default the umask is C<022> unless it has been "
26112 "set by calling L</umask>."
26117 #: ../fish/guestfish-actions.pod:1424
26118 msgid "get-verbose"
26123 #: ../fish/guestfish-actions.pod:1426
26132 #: ../fish/guestfish-actions.pod:1430
26138 #: ../fish/guestfish-actions.pod:1432
26147 #: ../fish/guestfish-actions.pod:1436
26148 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26153 #: ../fish/guestfish-actions.pod:1439
26159 #: ../fish/guestfish-actions.pod:1441
26162 " getxattr path name\n"
26168 #: ../fish/guestfish-actions.pod:1443
26170 "Get a single extended attribute from file C<path> named C<name>. This call "
26171 "follows symlinks. If you want to lookup an extended attribute for the "
26172 "symlink itself, use L</lgetxattr>."
26177 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2453
26179 "Normally it is better to get all extended attributes from a file in one go "
26180 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26181 "buggy and do not provide a way to list out attributes. For these "
26182 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26183 "attributes you want in advance and call this function."
26188 #: ../fish/guestfish-actions.pod:1457
26189 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26194 #: ../fish/guestfish-actions.pod:1459
26200 #: ../fish/guestfish-actions.pod:1461
26203 " getxattrs path\n"
26209 #: ../fish/guestfish-actions.pod:1469
26210 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26215 #: ../fish/guestfish-actions.pod:1471
26216 msgid "glob-expand"
26221 #: ../fish/guestfish-actions.pod:1473
26224 " glob-expand pattern\n"
26230 #: ../fish/guestfish-actions.pod:1486
26236 #: ../fish/guestfish-actions.pod:1488
26239 " grep regex path\n"
26245 #: ../fish/guestfish-actions.pod:1496
26251 #: ../fish/guestfish-actions.pod:1498
26254 " grepi regex path\n"
26260 #: ../fish/guestfish-actions.pod:1506
26261 msgid "grub-install"
26266 #: ../fish/guestfish-actions.pod:1508
26269 " grub-install root device\n"
26275 #: ../fish/guestfish-actions.pod:1524
26281 #: ../fish/guestfish-actions.pod:1526
26290 #: ../fish/guestfish-actions.pod:1534
26296 #: ../fish/guestfish-actions.pod:1536
26299 " head-n nrlines path\n"
26305 #: ../fish/guestfish-actions.pod:1549
26311 #: ../fish/guestfish-actions.pod:1551
26320 #: ../fish/guestfish-actions.pod:1559
26326 #: ../fish/guestfish-actions.pod:1561
26329 " initrd-cat initrdpath filename\n"
26335 #: ../fish/guestfish-actions.pod:1573
26336 msgid "See also L</initrd-list>."
26341 #: ../fish/guestfish-actions.pod:1578
26342 msgid "initrd-list"
26347 #: ../fish/guestfish-actions.pod:1580
26350 " initrd-list path\n"
26356 #: ../fish/guestfish-actions.pod:1592
26357 msgid "inotify-add-watch"
26362 #: ../fish/guestfish-actions.pod:1594
26365 " inotify-add-watch path mask\n"
26371 #: ../fish/guestfish-actions.pod:1606
26372 msgid "inotify-close"
26377 #: ../fish/guestfish-actions.pod:1608
26386 #: ../fish/guestfish-actions.pod:1614
26387 msgid "inotify-files"
26392 #: ../fish/guestfish-actions.pod:1616
26401 #: ../fish/guestfish-actions.pod:1618
26403 "This function is a helpful wrapper around L</inotify-read> which just "
26404 "returns a list of pathnames of objects that were touched. The returned "
26405 "pathnames are sorted and deduplicated."
26410 #: ../fish/guestfish-actions.pod:1622
26411 msgid "inotify-init"
26416 #: ../fish/guestfish-actions.pod:1624
26419 " inotify-init maxevents\n"
26425 #: ../fish/guestfish-actions.pod:1630
26427 "C<maxevents> is the maximum number of events which will be queued up between "
26428 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26429 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26430 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26431 "but records the fact that it threw them away by setting a flag "
26432 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26437 #: ../fish/guestfish-actions.pod:1640
26439 "Before any events are generated, you have to add some watches to the "
26440 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26441 "L</inotify-watch-all>."
26446 #: ../fish/guestfish-actions.pod:1646
26448 "Queued up events should be read periodically by calling L</inotify-read> (or "
26449 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26450 "If you don't read the events out often enough then you risk the internal "
26451 "queue overflowing."
26456 #: ../fish/guestfish-actions.pod:1653
26458 "The handle should be closed after use by calling L</inotify-close>. This "
26459 "also removes any watches automatically."
26464 #: ../fish/guestfish-actions.pod:1662
26465 msgid "inotify-read"
26470 #: ../fish/guestfish-actions.pod:1664
26479 #: ../fish/guestfish-actions.pod:1677
26480 msgid "inotify-rm-watch"
26485 #: ../fish/guestfish-actions.pod:1679
26488 " inotify-rm-watch wd\n"
26494 #: ../fish/guestfish-actions.pod:1681
26495 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26500 #: ../fish/guestfish-actions.pod:1684
26501 msgid "inspect-get-arch"
26506 #: ../fish/guestfish-actions.pod:1686
26509 " inspect-get-arch root\n"
26515 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26516 #: ../fish/guestfish-actions.pod:1790 ../fish/guestfish-actions.pod:1826
26517 #: ../fish/guestfish-actions.pod:1844 ../fish/guestfish-actions.pod:1878
26518 #: ../fish/guestfish-actions.pod:1893 ../fish/guestfish-actions.pod:1914
26519 #: ../fish/guestfish-actions.pod:1929 ../fish/guestfish-actions.pod:1962
26520 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:2008
26521 #: ../fish/guestfish-actions.pod:2025 ../fish/guestfish-actions.pod:2068
26522 #: ../fish/guestfish-actions.pod:2103 ../fish/guestfish-actions.pod:2119
26523 #: ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2148
26524 #: ../fish/guestfish-actions.pod:2161 ../fish/guestfish-actions.pod:2176
26526 "This function should only be called with a root device string as returned by "
26532 #: ../fish/guestfish-actions.pod:1691
26534 "This returns the architecture of the inspected operating system. The "
26535 "possible return values are listed under L</file-architecture>."
26540 #: ../fish/guestfish-actions.pod:1700
26541 msgid "inspect-get-distro"
26546 #: ../fish/guestfish-actions.pod:1702
26549 " inspect-get-distro root\n"
26554 #: ../fish/guestfish-actions.pod:1786
26555 msgid "inspect-get-drive-mappings"
26559 #: ../fish/guestfish-actions.pod:1788
26562 " inspect-get-drive-mappings root\n"
26567 #: ../fish/guestfish-actions.pod:1818
26569 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26570 "get-mountpoints>, L</inspect-get-filesystems>."
26575 #: ../fish/guestfish-actions.pod:1822
26576 msgid "inspect-get-filesystems"
26581 #: ../fish/guestfish-actions.pod:1824
26584 " inspect-get-filesystems root\n"
26590 #: ../fish/guestfish-actions.pod:1837
26592 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26593 "get-mountpoints>."
26597 #: ../fish/guestfish-actions.pod:1840
26598 msgid "inspect-get-format"
26602 #: ../fish/guestfish-actions.pod:1842
26605 " inspect-get-format root\n"
26611 #: ../fish/guestfish-actions.pod:1874
26612 msgid "inspect-get-hostname"
26617 #: ../fish/guestfish-actions.pod:1876
26620 " inspect-get-hostname root\n"
26626 #: ../fish/guestfish-actions.pod:1889
26627 msgid "inspect-get-major-version"
26632 #: ../fish/guestfish-actions.pod:1891
26635 " inspect-get-major-version root\n"
26641 #: ../fish/guestfish-actions.pod:1910
26642 msgid "inspect-get-minor-version"
26647 #: ../fish/guestfish-actions.pod:1912
26650 " inspect-get-minor-version root\n"
26656 #: ../fish/guestfish-actions.pod:1922
26658 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26659 "get-major-version>."
26664 #: ../fish/guestfish-actions.pod:1925
26665 msgid "inspect-get-mountpoints"
26670 #: ../fish/guestfish-actions.pod:1927
26673 " inspect-get-mountpoints root\n"
26678 #: ../fish/guestfish-actions.pod:1949
26680 "For operating systems like Windows which still use drive letters, this call "
26681 "will only return an entry for the first drive \"mounted on\" C</>. For "
26682 "information about the mapping of drive letters to partitions, see L</inspect-"
26683 "get-drive-mappings>."
26688 #: ../fish/guestfish-actions.pod:1955
26690 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26691 "get-filesystems>."
26696 #: ../fish/guestfish-actions.pod:1958
26697 msgid "inspect-get-package-format"
26702 #: ../fish/guestfish-actions.pod:1960
26705 " inspect-get-package-format root\n"
26711 #: ../fish/guestfish-actions.pod:1965
26713 "This function and L</inspect-get-package-management> return the package "
26714 "format and package management tool used by the inspected operating system. "
26715 "For example for Fedora these functions would return C<rpm> (package format) "
26716 "and C<yum> (package management)."
26721 #: ../fish/guestfish-actions.pod:1980
26722 msgid "inspect-get-package-management"
26727 #: ../fish/guestfish-actions.pod:1982
26730 " inspect-get-package-management root\n"
26736 #: ../fish/guestfish-actions.pod:1987
26738 "L</inspect-get-package-format> and this function return the package format "
26739 "and package management tool used by the inspected operating system. For "
26740 "example for Fedora these functions would return C<rpm> (package format) and "
26741 "C<yum> (package management)."
26746 #: ../fish/guestfish-actions.pod:2004
26747 msgid "inspect-get-product-name"
26752 #: ../fish/guestfish-actions.pod:2006
26755 " inspect-get-product-name root\n"
26760 #: ../fish/guestfish-actions.pod:2021
26761 msgid "inspect-get-product-variant"
26765 #: ../fish/guestfish-actions.pod:2023
26768 " inspect-get-product-variant root\n"
26773 #: ../fish/guestfish-actions.pod:2047
26775 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26776 "get-product-name>, L</inspect-get-major-version>."
26781 #: ../fish/guestfish-actions.pod:2051
26782 msgid "inspect-get-roots"
26787 #: ../fish/guestfish-actions.pod:2053
26790 " inspect-get-roots\n"
26796 #: ../fish/guestfish-actions.pod:2055
26798 "This function is a convenient way to get the list of root devices, as "
26799 "returned from a previous call to L</inspect-os>, but without redoing the "
26800 "whole inspection process."
26805 #: ../fish/guestfish-actions.pod:2059
26807 "This returns an empty list if either no root devices were found or the "
26808 "caller has not called L</inspect-os>."
26813 #: ../fish/guestfish-actions.pod:2064
26814 msgid "inspect-get-type"
26819 #: ../fish/guestfish-actions.pod:2066
26822 " inspect-get-type root\n"
26827 #: ../fish/guestfish-actions.pod:2099
26828 msgid "inspect-get-windows-current-control-set"
26832 #: ../fish/guestfish-actions.pod:2101
26835 " inspect-get-windows-current-control-set root\n"
26841 #: ../fish/guestfish-actions.pod:2115
26842 msgid "inspect-get-windows-systemroot"
26847 #: ../fish/guestfish-actions.pod:2117
26850 " inspect-get-windows-systemroot root\n"
26855 #: ../fish/guestfish-actions.pod:2131
26856 msgid "inspect-is-live"
26860 #: ../fish/guestfish-actions.pod:2133
26863 " inspect-is-live root\n"
26868 #: ../fish/guestfish-actions.pod:2138
26870 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26871 "then this returns true if a live image was detected on the disk."
26875 #: ../fish/guestfish-actions.pod:2144
26876 msgid "inspect-is-multipart"
26880 #: ../fish/guestfish-actions.pod:2146
26883 " inspect-is-multipart root\n"
26888 #: ../fish/guestfish-actions.pod:2151
26890 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26891 "then this returns true if the disk is part of a set."
26895 #: ../fish/guestfish-actions.pod:2157
26896 msgid "inspect-is-netinst"
26900 #: ../fish/guestfish-actions.pod:2159
26903 " inspect-is-netinst root\n"
26908 #: ../fish/guestfish-actions.pod:2164
26910 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26911 "then this returns true if the disk is a network installer, ie. not a self-"
26912 "contained install CD but one which is likely to require network access to "
26913 "complete the install."
26918 #: ../fish/guestfish-actions.pod:2172
26919 msgid "inspect-list-applications"
26924 #: ../fish/guestfish-actions.pod:2174
26927 " inspect-list-applications root\n"
26933 #: ../fish/guestfish-actions.pod:2181
26935 "I<Note:> This call works differently from other parts of the inspection "
26936 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
26937 "then mount up the disks, before calling this. Listing applications is a "
26938 "significantly more difficult operation which requires access to the full "
26939 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
26940 "are just returning data cached in the libguestfs handle, this call actually "
26941 "reads parts of the mounted filesystems during the call."
26946 #: ../fish/guestfish-actions.pod:2271
26952 #: ../fish/guestfish-actions.pod:2273
26961 #: ../fish/guestfish-actions.pod:2288
26963 "You can pass the root string(s) returned to other L</inspect-get-*> "
26964 "functions in order to query further information about each operating system, "
26965 "such as the name and version."
26970 #: ../fish/guestfish-actions.pod:2293
26972 "This function uses other libguestfs features such as L</mount-ro> and L</"
26973 "umount-all> in order to mount and unmount filesystems and look at the "
26974 "contents. This should be called with no disks currently mounted. The "
26975 "function may also use Augeas, so any existing Augeas handle will be closed."
26980 #: ../fish/guestfish-actions.pod:2305 ../fish/guestfish-actions.pod:2481
26981 #: ../fish/guestfish-actions.pod:2527
26982 msgid "See also L</list-filesystems>."
26987 #: ../fish/guestfish-actions.pod:2307
26988 msgid "is-blockdev"
26993 #: ../fish/guestfish-actions.pod:2309
26996 " is-blockdev path\n"
27002 #: ../fish/guestfish-actions.pod:2314 ../fish/guestfish-actions.pod:2332
27003 #: ../fish/guestfish-actions.pod:2351 ../fish/guestfish-actions.pod:2360
27004 #: ../fish/guestfish-actions.pod:2370 ../fish/guestfish-actions.pod:2404
27005 #: ../fish/guestfish-actions.pod:2413
27006 msgid "See also L</stat>."
27011 #: ../fish/guestfish-actions.pod:2316
27017 #: ../fish/guestfish-actions.pod:2318
27026 #: ../fish/guestfish-actions.pod:2325
27032 #: ../fish/guestfish-actions.pod:2327
27035 " is-chardev path\n"
27041 #: ../fish/guestfish-actions.pod:2334
27047 #: ../fish/guestfish-actions.pod:2336
27056 #: ../fish/guestfish-actions.pod:2343
27062 #: ../fish/guestfish-actions.pod:2345
27071 #: ../fish/guestfish-actions.pod:2353
27077 #: ../fish/guestfish-actions.pod:2355
27086 #: ../fish/guestfish-actions.pod:2362
27092 #: ../fish/guestfish-actions.pod:2364
27101 #: ../fish/guestfish-actions.pod:2372
27102 msgid "is-launching"
27107 #: ../fish/guestfish-actions.pod:2374
27116 #: ../fish/guestfish-actions.pod:2381
27122 #: ../fish/guestfish-actions.pod:2383
27131 #: ../fish/guestfish-actions.pod:2388
27137 #: ../fish/guestfish-actions.pod:2390
27146 #: ../fish/guestfish-actions.pod:2397
27152 #: ../fish/guestfish-actions.pod:2399
27155 " is-socket path\n"
27161 #: ../fish/guestfish-actions.pod:2406
27167 #: ../fish/guestfish-actions.pod:2408
27170 " is-symlink path\n"
27176 #: ../fish/guestfish-actions.pod:2415
27177 msgid "kill-subprocess"
27182 #: ../fish/guestfish-actions.pod:2417
27185 " kill-subprocess\n"
27191 #: ../fish/guestfish-actions.pod:2421
27197 #: ../fish/guestfish-actions.pod:2423
27203 #: ../fish/guestfish-actions.pod:2425
27212 #: ../fish/guestfish-actions.pod:2433
27218 #: ../fish/guestfish-actions.pod:2435
27221 " lchown owner group path\n"
27227 #: ../fish/guestfish-actions.pod:2437
27229 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27230 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27236 #: ../fish/guestfish-actions.pod:2445
27242 #: ../fish/guestfish-actions.pod:2447
27245 " lgetxattr path name\n"
27251 #: ../fish/guestfish-actions.pod:2463
27252 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27257 #: ../fish/guestfish-actions.pod:2465
27263 #: ../fish/guestfish-actions.pod:2467
27266 " lgetxattrs path\n"
27272 #: ../fish/guestfish-actions.pod:2469
27274 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27275 "it returns the extended attributes of the link itself."
27280 #: ../fish/guestfish-actions.pod:2473
27281 msgid "list-devices"
27286 #: ../fish/guestfish-actions.pod:2475
27295 #: ../fish/guestfish-actions.pod:2483
27296 msgid "list-filesystems"
27301 #: ../fish/guestfish-actions.pod:2485
27304 " list-filesystems\n"
27310 #: ../fish/guestfish-actions.pod:2504
27312 "This command runs other libguestfs commands, which might include L</mount> "
27313 "and L</umount>, and therefore you should use this soon after launch and only "
27314 "when nothing is mounted."
27319 #: ../fish/guestfish-actions.pod:2508
27321 "Not all of the filesystems returned will be mountable. In particular, swap "
27322 "partitions are returned in the list. Also this command does not check that "
27323 "each filesystem found is valid and mountable, and some filesystems might be "
27324 "mountable but require special options. Filesystems may not all belong to a "
27325 "single logical operating system (use L</inspect-os> to look for OSes)."
27330 #: ../fish/guestfish-actions.pod:2516
27331 msgid "list-partitions"
27336 #: ../fish/guestfish-actions.pod:2518
27339 " list-partitions\n"
27345 #: ../fish/guestfish-actions.pod:2524
27347 "This does not return logical volumes. For that you will need to call L</"
27353 #: ../fish/guestfish-actions.pod:2529
27359 #: ../fish/guestfish-actions.pod:2531
27368 #: ../fish/guestfish-actions.pod:2539
27374 #: ../fish/guestfish-actions.pod:2541
27377 " ln target linkname\n"
27383 #: ../fish/guestfish-actions.pod:2545
27389 #: ../fish/guestfish-actions.pod:2547
27392 " ln-f target linkname\n"
27398 #: ../fish/guestfish-actions.pod:2552
27404 #: ../fish/guestfish-actions.pod:2554
27407 " ln-s target linkname\n"
27413 #: ../fish/guestfish-actions.pod:2558
27419 #: ../fish/guestfish-actions.pod:2560
27422 " ln-sf target linkname\n"
27428 #: ../fish/guestfish-actions.pod:2565
27429 msgid "lremovexattr"
27434 #: ../fish/guestfish-actions.pod:2567
27437 " lremovexattr xattr path\n"
27443 #: ../fish/guestfish-actions.pod:2569
27445 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27446 "it removes an extended attribute of the link itself."
27451 #: ../fish/guestfish-actions.pod:2573
27457 #: ../fish/guestfish-actions.pod:2575
27466 #: ../fish/guestfish-actions.pod:2581
27468 "This command is mostly useful for interactive sessions. Programs should "
27469 "probably use L</readdir> instead."
27474 #: ../fish/guestfish-actions.pod:2584
27480 #: ../fish/guestfish-actions.pod:2586
27483 " lsetxattr xattr val vallen path\n"
27489 #: ../fish/guestfish-actions.pod:2588
27491 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27492 "sets an extended attribute of the link itself."
27497 #: ../fish/guestfish-actions.pod:2592
27503 #: ../fish/guestfish-actions.pod:2594
27512 #: ../fish/guestfish-actions.pod:2598
27514 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27515 "the link is stat-ed, not the file it refers to."
27520 #: ../fish/guestfish-actions.pod:2604
27526 #: ../fish/guestfish-actions.pod:2606
27529 " lstatlist path 'names ...'\n"
27535 #: ../fish/guestfish-actions.pod:2608
27537 "This call allows you to perform the L</lstat> operation on multiple files, "
27538 "where all files are in the directory C<path>. C<names> is the list of files "
27539 "from this directory."
27544 #: ../fish/guestfish-actions.pod:2617
27546 "This call is intended for programs that want to efficiently list a directory "
27547 "contents without making many round-trips. See also L</lxattrlist> for a "
27548 "similarly efficient call for getting extended attributes. Very long "
27549 "directory listings might cause the protocol message size to be exceeded, "
27550 "causing this call to fail. The caller must split up such requests into "
27551 "smaller groups of names."
27556 #: ../fish/guestfish-actions.pod:2625
27557 msgid "luks-add-key"
27562 #: ../fish/guestfish-actions.pod:2627
27565 " luks-add-key device keyslot\n"
27571 #: ../fish/guestfish-actions.pod:2634
27573 "Note that if C<keyslot> already contains a key, then this command will "
27574 "fail. You have to use L</luks-kill-slot> first to remove that key."
27579 #: ../fish/guestfish-actions.pod:2638 ../fish/guestfish-actions.pod:2660
27580 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2687
27581 #: ../fish/guestfish-actions.pod:2710 ../fish/guestfish-actions.pod:2720
27583 "This command has one or more key or passphrase parameters. Guestfish will "
27584 "prompt for these separately."
27589 #: ../fish/guestfish-actions.pod:2641
27595 #: ../fish/guestfish-actions.pod:2643
27598 " luks-close device\n"
27604 #: ../fish/guestfish-actions.pod:2645
27606 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27607 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27608 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27614 #: ../fish/guestfish-actions.pod:2651
27615 msgid "luks-format"
27620 #: ../fish/guestfish-actions.pod:2653
27623 " luks-format device keyslot\n"
27629 #: ../fish/guestfish-actions.pod:2666
27630 msgid "luks-format-cipher"
27635 #: ../fish/guestfish-actions.pod:2668
27638 " luks-format-cipher device keyslot cipher\n"
27644 #: ../fish/guestfish-actions.pod:2670
27646 "This command is the same as L</luks-format> but it also allows you to set "
27647 "the C<cipher> used."
27652 #: ../fish/guestfish-actions.pod:2679
27653 msgid "luks-kill-slot"
27658 #: ../fish/guestfish-actions.pod:2681
27661 " luks-kill-slot device keyslot\n"
27667 #: ../fish/guestfish-actions.pod:2690
27673 #: ../fish/guestfish-actions.pod:2692
27676 " luks-open device mapname\n"
27682 #: ../fish/guestfish-actions.pod:2706
27684 "If this block device contains LVM volume groups, then calling L</vgscan> "
27685 "followed by L</vg-activate-all> will make them visible."
27690 #: ../fish/guestfish-actions.pod:2713
27691 msgid "luks-open-ro"
27696 #: ../fish/guestfish-actions.pod:2715
27699 " luks-open-ro device mapname\n"
27705 #: ../fish/guestfish-actions.pod:2717
27707 "This is the same as L</luks-open> except that a read-only mapping is created."
27712 #: ../fish/guestfish-actions.pod:2723
27718 #: ../fish/guestfish-actions.pod:2725
27721 " lvcreate logvol volgroup mbytes\n"
27727 #: ../fish/guestfish-actions.pod:2730
27728 msgid "lvm-canonical-lv-name"
27733 #: ../fish/guestfish-actions.pod:2732
27736 " lvm-canonical-lv-name lvname\n"
27742 #: ../fish/guestfish-actions.pod:2741
27743 msgid "See also L</is-lv>."
27748 #: ../fish/guestfish-actions.pod:2743
27749 msgid "lvm-clear-filter"
27754 #: ../fish/guestfish-actions.pod:2745
27757 " lvm-clear-filter\n"
27763 #: ../fish/guestfish-actions.pod:2747
27765 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27771 #: ../fish/guestfish-actions.pod:2753
27772 msgid "lvm-remove-all"
27777 #: ../fish/guestfish-actions.pod:2755
27780 " lvm-remove-all\n"
27786 #: ../fish/guestfish-actions.pod:2763
27787 msgid "lvm-set-filter"
27792 #: ../fish/guestfish-actions.pod:2765
27795 " lvm-set-filter 'devices ...'\n"
27801 #: ../fish/guestfish-actions.pod:2790
27807 #: ../fish/guestfish-actions.pod:2792
27810 " lvremove device\n"
27816 #: ../fish/guestfish-actions.pod:2800
27822 #: ../fish/guestfish-actions.pod:2802
27825 " lvrename logvol newlogvol\n"
27831 #: ../fish/guestfish-actions.pod:2806
27837 #: ../fish/guestfish-actions.pod:2808
27840 " lvresize device mbytes\n"
27846 #: ../fish/guestfish-actions.pod:2814
27847 msgid "lvresize-free"
27852 #: ../fish/guestfish-actions.pod:2816
27855 " lvresize-free lv percent\n"
27861 #: ../fish/guestfish-actions.pod:2824
27867 #: ../fish/guestfish-actions.pod:2826
27876 #: ../fish/guestfish-actions.pod:2834
27877 msgid "See also L</lvs-full>, L</list-filesystems>."
27882 #: ../fish/guestfish-actions.pod:2836
27888 #: ../fish/guestfish-actions.pod:2838
27897 #: ../fish/guestfish-actions.pod:2843
27903 #: ../fish/guestfish-actions.pod:2845
27912 #: ../fish/guestfish-actions.pod:2849
27918 #: ../fish/guestfish-actions.pod:2851
27921 " lxattrlist path 'names ...'\n"
27927 #: ../fish/guestfish-actions.pod:2867
27929 "This call is intended for programs that want to efficiently list a directory "
27930 "contents without making many round-trips. See also L</lstatlist> for a "
27931 "similarly efficient call for getting standard stats. Very long directory "
27932 "listings might cause the protocol message size to be exceeded, causing this "
27933 "call to fail. The caller must split up such requests into smaller groups of "
27939 #: ../fish/guestfish-actions.pod:2875
27945 #: ../fish/guestfish-actions.pod:2877
27954 #: ../fish/guestfish-actions.pod:2881
27960 #: ../fish/guestfish-actions.pod:2883
27963 " mkdir-mode path mode\n"
27969 #: ../fish/guestfish-actions.pod:2892
27970 msgid "See also L</mkdir>, L</umask>"
27975 #: ../fish/guestfish-actions.pod:2894
27981 #: ../fish/guestfish-actions.pod:2896
27990 #: ../fish/guestfish-actions.pod:2901
27996 #: ../fish/guestfish-actions.pod:2903
27999 " mkdtemp template\n"
28005 #: ../fish/guestfish-actions.pod:2924
28011 #: ../fish/guestfish-actions.pod:2926
28014 " mke2fs-J fstype blocksize device journal\n"
28020 #: ../fish/guestfish-actions.pod:2934
28021 msgid "See also L</mke2journal>."
28026 #: ../fish/guestfish-actions.pod:2936
28032 #: ../fish/guestfish-actions.pod:2938
28035 " mke2fs-JL fstype blocksize device label\n"
28041 #: ../fish/guestfish-actions.pod:2943
28042 msgid "See also L</mke2journal-L>."
28047 #: ../fish/guestfish-actions.pod:2945
28053 #: ../fish/guestfish-actions.pod:2947
28056 " mke2fs-JU fstype blocksize device uuid\n"
28062 #: ../fish/guestfish-actions.pod:2952
28063 msgid "See also L</mke2journal-U>."
28068 #: ../fish/guestfish-actions.pod:2954
28069 msgid "mke2journal"
28074 #: ../fish/guestfish-actions.pod:2956
28077 " mke2journal blocksize device\n"
28083 #: ../fish/guestfish-actions.pod:2963
28084 msgid "mke2journal-L"
28089 #: ../fish/guestfish-actions.pod:2965
28092 " mke2journal-L blocksize label device\n"
28098 #: ../fish/guestfish-actions.pod:2969
28099 msgid "mke2journal-U"
28104 #: ../fish/guestfish-actions.pod:2971
28107 " mke2journal-U blocksize uuid device\n"
28113 #: ../fish/guestfish-actions.pod:2975
28119 #: ../fish/guestfish-actions.pod:2977
28122 " mkfifo mode path\n"
28128 #: ../fish/guestfish-actions.pod:2979
28130 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28131 "is just a convenient wrapper around L</mknod>."
28136 #: ../fish/guestfish-actions.pod:2985
28142 #: ../fish/guestfish-actions.pod:2987
28145 " mkfs fstype device\n"
28151 #: ../fish/guestfish-actions.pod:2993
28157 #: ../fish/guestfish-actions.pod:2995
28160 " mkfs-b fstype blocksize device\n"
28166 #: ../fish/guestfish-actions.pod:2997
28168 "This call is similar to L</mkfs>, but it allows you to control the block "
28169 "size of the resulting filesystem. Supported block sizes depend on the "
28170 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28175 #: ../fish/guestfish-actions.pod:3012
28180 #: ../fish/guestfish-actions.pod:3014
28183 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28189 #: ../fish/guestfish-actions.pod:3049
28190 msgid "mkmountpoint"
28195 #: ../fish/guestfish-actions.pod:3051
28198 " mkmountpoint exemptpath\n"
28204 #: ../fish/guestfish-actions.pod:3053
28206 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28207 "to create extra mountpoints before mounting the first filesystem."
28212 #: ../fish/guestfish-actions.pod:3077
28214 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28215 "unexpected errors if you try to mix these calls. It is safest to manually "
28216 "unmount filesystems and remove mountpoints after use."
28221 #: ../fish/guestfish-actions.pod:3081
28223 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28224 "for this to work for manual mountpoints, you must ensure that the innermost "
28225 "mountpoints have the longest pathnames, as in the example code above."
28229 #: ../fish/guestfish-actions.pod:3088
28231 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28232 "L</umount-all> to be called when the handle is closed which can also trigger "
28238 #: ../fish/guestfish-actions.pod:3092
28244 #: ../fish/guestfish-actions.pod:3094
28247 " mknod mode devmajor devminor path\n"
28253 #: ../fish/guestfish-actions.pod:3104
28255 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28256 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28257 "regular file). These constants are available in the standard Linux header "
28258 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28259 "wrappers around this command which bitwise OR in the appropriate constant "
28265 #: ../fish/guestfish-actions.pod:3114
28271 #: ../fish/guestfish-actions.pod:3116
28274 " mknod-b mode devmajor devminor path\n"
28280 #: ../fish/guestfish-actions.pod:3118
28282 "This call creates a block device node called C<path> with mode C<mode> and "
28283 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28284 "wrapper around L</mknod>."
28289 #: ../fish/guestfish-actions.pod:3124
28295 #: ../fish/guestfish-actions.pod:3126
28298 " mknod-c mode devmajor devminor path\n"
28304 #: ../fish/guestfish-actions.pod:3128
28306 "This call creates a char device node called C<path> with mode C<mode> and "
28307 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28308 "wrapper around L</mknod>."
28313 #: ../fish/guestfish-actions.pod:3134
28319 #: ../fish/guestfish-actions.pod:3136
28328 #: ../fish/guestfish-actions.pod:3140
28334 #: ../fish/guestfish-actions.pod:3142
28337 " mkswap-L label device\n"
28343 #: ../fish/guestfish-actions.pod:3150
28349 #: ../fish/guestfish-actions.pod:3152
28352 " mkswap-U uuid device\n"
28358 #: ../fish/guestfish-actions.pod:3156
28359 msgid "mkswap-file"
28364 #: ../fish/guestfish-actions.pod:3158
28367 " mkswap-file path\n"
28373 #: ../fish/guestfish-actions.pod:3162
28375 "This command just writes a swap file signature to an existing file. To "
28376 "create the file itself, use something like L</fallocate>."
28381 #: ../fish/guestfish-actions.pod:3165
28387 #: ../fish/guestfish-actions.pod:3167
28390 " modprobe modulename\n"
28396 #: ../fish/guestfish-actions.pod:3174
28402 #: ../fish/guestfish-actions.pod:3176
28405 " mount device mountpoint\n"
28411 #: ../fish/guestfish-actions.pod:3192
28413 "B<Important note:> When you use this call, the filesystem options C<sync> "
28414 "and C<noatime> are set implicitly. This was originally done because we "
28415 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28416 "very large negative performance impact and negligible effect on "
28417 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28418 "code that needs performance, and instead use L</mount-options> (use an empty "
28419 "string for the first parameter if you don't want any options)."
28424 #: ../fish/guestfish-actions.pod:3202
28430 #: ../fish/guestfish-actions.pod:3204
28433 " mount-loop file mountpoint\n"
28439 #: ../fish/guestfish-actions.pod:3210
28440 msgid "mount-options"
28445 #: ../fish/guestfish-actions.pod:3212
28448 " mount-options options device mountpoint\n"
28454 #: ../fish/guestfish-actions.pod:3214
28456 "This is the same as the L</mount> command, but it allows you to set the "
28457 "mount options as for the L<mount(8)> I<-o> flag."
28462 #: ../fish/guestfish-actions.pod:3222
28468 #: ../fish/guestfish-actions.pod:3224
28471 " mount-ro device mountpoint\n"
28477 #: ../fish/guestfish-actions.pod:3226
28479 "This is the same as the L</mount> command, but it mounts the filesystem with "
28480 "the read-only (I<-o ro>) flag."
28485 #: ../fish/guestfish-actions.pod:3229
28491 #: ../fish/guestfish-actions.pod:3231
28494 " mount-vfs options vfstype device mountpoint\n"
28500 #: ../fish/guestfish-actions.pod:3233
28502 "This is the same as the L</mount> command, but it allows you to set both the "
28503 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28508 #: ../fish/guestfish-actions.pod:3237
28509 msgid "mountpoints"
28514 #: ../fish/guestfish-actions.pod:3239
28523 #: ../fish/guestfish-actions.pod:3241
28525 "This call is similar to L</mounts>. That call returns a list of devices. "
28526 "This one returns a hash table (map) of device name to directory where the "
28527 "device is mounted."
28532 #: ../fish/guestfish-actions.pod:3245
28538 #: ../fish/guestfish-actions.pod:3247
28547 #: ../fish/guestfish-actions.pod:3254
28548 msgid "See also: L</mountpoints>"
28553 #: ../fish/guestfish-actions.pod:3256
28559 #: ../fish/guestfish-actions.pod:3258
28568 #: ../fish/guestfish-actions.pod:3263
28569 msgid "ntfs-3g-probe"
28574 #: ../fish/guestfish-actions.pod:3265
28577 " ntfs-3g-probe true|false device\n"
28583 #: ../fish/guestfish-actions.pod:3279
28589 #: ../fish/guestfish-actions.pod:3281
28592 " ntfsresize device\n"
28598 #: ../fish/guestfish-actions.pod:3287
28599 msgid "ntfsresize-size"
28604 #: ../fish/guestfish-actions.pod:3289
28607 " ntfsresize-size device size\n"
28613 #: ../fish/guestfish-actions.pod:3291
28615 "This command is the same as L</ntfsresize> except that it allows you to "
28616 "specify the new size (in bytes) explicitly."
28621 #: ../fish/guestfish-actions.pod:3294
28627 #: ../fish/guestfish-actions.pod:3296
28630 " part-add device prlogex startsect endsect\n"
28636 #: ../fish/guestfish-actions.pod:3298
28638 "This command adds a partition to C<device>. If there is no partition table "
28639 "on the device, call L</part-init> first."
28644 #: ../fish/guestfish-actions.pod:3310
28646 "Creating a partition which covers the whole disk is not so easy. Use L</"
28647 "part-disk> to do that."
28652 #: ../fish/guestfish-actions.pod:3313
28658 #: ../fish/guestfish-actions.pod:3315
28661 " part-del device partnum\n"
28667 #: ../fish/guestfish-actions.pod:3323
28673 #: ../fish/guestfish-actions.pod:3325
28676 " part-disk device parttype\n"
28682 #: ../fish/guestfish-actions.pod:3327
28684 "This command is simply a combination of L</part-init> followed by L</part-"
28685 "add> to create a single primary partition covering the whole disk."
28690 #: ../fish/guestfish-actions.pod:3331
28692 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28693 "possible values are described in L</part-init>."
28698 #: ../fish/guestfish-actions.pod:3337
28699 msgid "part-get-bootable"
28704 #: ../fish/guestfish-actions.pod:3339
28707 " part-get-bootable device partnum\n"
28713 #: ../fish/guestfish-actions.pod:3344
28714 msgid "See also L</part-set-bootable>."
28719 #: ../fish/guestfish-actions.pod:3346
28720 msgid "part-get-mbr-id"
28725 #: ../fish/guestfish-actions.pod:3348
28728 " part-get-mbr-id device partnum\n"
28734 #: ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3491
28736 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28737 "undefined results for other partition table types (see L</part-get-"
28743 #: ../fish/guestfish-actions.pod:3357
28744 msgid "part-get-parttype"
28749 #: ../fish/guestfish-actions.pod:3359
28752 " part-get-parttype device\n"
28758 #: ../fish/guestfish-actions.pod:3364
28760 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28761 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28762 "possible, although unusual. See L</part-init> for a full list."
28767 #: ../fish/guestfish-actions.pod:3369
28773 #: ../fish/guestfish-actions.pod:3371
28776 " part-init device parttype\n"
28782 #: ../fish/guestfish-actions.pod:3377
28784 "Initially there are no partitions. Following this, you should call L</part-"
28785 "add> for each partition required."
28790 #: ../fish/guestfish-actions.pod:3440
28796 #: ../fish/guestfish-actions.pod:3442
28799 " part-list device\n"
28805 #: ../fish/guestfish-actions.pod:3457
28807 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28808 "the device's sector size, see L</blockdev-getss>."
28813 #: ../fish/guestfish-actions.pod:3470
28814 msgid "part-set-bootable"
28819 #: ../fish/guestfish-actions.pod:3472
28822 " part-set-bootable device partnum true|false\n"
28828 #: ../fish/guestfish-actions.pod:3481
28829 msgid "part-set-mbr-id"
28834 #: ../fish/guestfish-actions.pod:3483
28837 " part-set-mbr-id device partnum idbyte\n"
28843 #: ../fish/guestfish-actions.pod:3495
28844 msgid "part-set-name"
28849 #: ../fish/guestfish-actions.pod:3497
28852 " part-set-name device partnum name\n"
28858 #: ../fish/guestfish-actions.pod:3505
28859 msgid "part-to-dev"
28864 #: ../fish/guestfish-actions.pod:3507
28867 " part-to-dev partition\n"
28873 #: ../fish/guestfish-actions.pod:3513
28875 "The named partition must exist, for example as a string returned from L</"
28876 "list-partitions>."
28881 #: ../fish/guestfish-actions.pod:3516
28882 msgid "ping-daemon"
28887 #: ../fish/guestfish-actions.pod:3518
28896 #: ../fish/guestfish-actions.pod:3525
28902 #: ../fish/guestfish-actions.pod:3527
28905 " pread path count offset\n"
28911 #: ../fish/guestfish-actions.pod:3535
28912 msgid "See also L</pwrite>, L</pread-device>."
28917 #: ../fish/guestfish-actions.pod:3540
28918 msgid "pread-device"
28923 #: ../fish/guestfish-actions.pod:3542
28926 " pread-device device count offset\n"
28932 #: ../fish/guestfish-actions.pod:3550
28933 msgid "See also L</pread>."
28938 #: ../fish/guestfish-actions.pod:3555
28944 #: ../fish/guestfish-actions.pod:3557
28947 " pvcreate device\n"
28953 #: ../fish/guestfish-actions.pod:3563
28959 #: ../fish/guestfish-actions.pod:3565
28962 " pvremove device\n"
28968 #: ../fish/guestfish-actions.pod:3574
28974 #: ../fish/guestfish-actions.pod:3576
28977 " pvresize device\n"
28983 #: ../fish/guestfish-actions.pod:3581
28984 msgid "pvresize-size"
28989 #: ../fish/guestfish-actions.pod:3583
28992 " pvresize-size device size\n"
28998 #: ../fish/guestfish-actions.pod:3585
29000 "This command is the same as L</pvresize> except that it allows you to "
29001 "specify the new size (in bytes) explicitly."
29006 #: ../fish/guestfish-actions.pod:3588
29012 #: ../fish/guestfish-actions.pod:3590
29021 #: ../fish/guestfish-actions.pod:3598
29022 msgid "See also L</pvs-full>."
29027 #: ../fish/guestfish-actions.pod:3600
29033 #: ../fish/guestfish-actions.pod:3602
29042 #: ../fish/guestfish-actions.pod:3607
29048 #: ../fish/guestfish-actions.pod:3609
29057 #: ../fish/guestfish-actions.pod:3613
29063 #: ../fish/guestfish-actions.pod:3615
29066 " pwrite path content offset\n"
29072 #: ../fish/guestfish-actions.pod:3626
29073 msgid "See also L</pread>, L</pwrite-device>."
29078 #: ../fish/guestfish-actions.pod:3631
29079 msgid "pwrite-device"
29084 #: ../fish/guestfish-actions.pod:3633
29087 " pwrite-device device content offset\n"
29093 #: ../fish/guestfish-actions.pod:3643
29094 msgid "See also L</pwrite>."
29099 #: ../fish/guestfish-actions.pod:3648
29105 #: ../fish/guestfish-actions.pod:3650
29108 " read-file path\n"
29114 #: ../fish/guestfish-actions.pod:3655
29116 "Unlike L</cat>, this function can correctly handle files that contain "
29117 "embedded ASCII NUL characters. However unlike L</download>, this function "
29118 "is limited in the total size of file that can be handled."
29123 #: ../fish/guestfish-actions.pod:3663
29129 #: ../fish/guestfish-actions.pod:3665
29132 " read-lines path\n"
29138 #: ../fish/guestfish-actions.pod:3672
29140 "Note that this function cannot correctly handle binary files (specifically, "
29141 "files containing C<\\0> character which is treated as end of line). For "
29142 "those you need to use the L</read-file> function which has a more complex "
29148 #: ../fish/guestfish-actions.pod:3677
29154 #: ../fish/guestfish-actions.pod:3679
29163 #: ../fish/guestfish-actions.pod:3731
29165 "This function is primarily intended for use by programs. To get a simple "
29166 "list of names, use L</ls>. To get a printable directory for human "
29167 "consumption, use L</ll>."
29172 #: ../fish/guestfish-actions.pod:3735
29178 #: ../fish/guestfish-actions.pod:3737
29187 #: ../fish/guestfish-actions.pod:3741
29188 msgid "readlinklist"
29193 #: ../fish/guestfish-actions.pod:3743
29196 " readlinklist path 'names ...'\n"
29202 #: ../fish/guestfish-actions.pod:3767
29208 #: ../fish/guestfish-actions.pod:3769
29217 #: ../fish/guestfish-actions.pod:3774
29218 msgid "removexattr"
29223 #: ../fish/guestfish-actions.pod:3776
29226 " removexattr xattr path\n"
29232 #: ../fish/guestfish-actions.pod:3781
29233 msgid "See also: L</lremovexattr>, L<attr(5)>."
29238 #: ../fish/guestfish-actions.pod:3783
29244 #: ../fish/guestfish-actions.pod:3785
29247 " resize2fs device\n"
29253 #: ../fish/guestfish-actions.pod:3790
29255 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29256 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29257 "gives an error about this and sometimes not. In any case, it is always safe "
29258 "to call L</e2fsck-f> before calling this function."
29262 #: ../fish/guestfish-actions.pod:3796
29263 msgid "resize2fs-M"
29267 #: ../fish/guestfish-actions.pod:3798
29270 " resize2fs-M device\n"
29275 #: ../fish/guestfish-actions.pod:3800
29277 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29278 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
29283 #: ../fish/guestfish-actions.pod:3804
29285 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29286 "and read the C<Block size> and C<Block count> values. These two numbers, "
29287 "multiplied together, give the resulting size of the minimal filesystem in "
29293 #: ../fish/guestfish-actions.pod:3809
29294 msgid "resize2fs-size"
29299 #: ../fish/guestfish-actions.pod:3811
29302 " resize2fs-size device size\n"
29308 #: ../fish/guestfish-actions.pod:3813
29310 "This command is the same as L</resize2fs> except that it allows you to "
29311 "specify the new size (in bytes) explicitly."
29316 #: ../fish/guestfish-actions.pod:3816
29322 #: ../fish/guestfish-actions.pod:3818
29331 #: ../fish/guestfish-actions.pod:3822
29337 #: ../fish/guestfish-actions.pod:3824
29346 #: ../fish/guestfish-actions.pod:3830
29352 #: ../fish/guestfish-actions.pod:3832
29361 #: ../fish/guestfish-actions.pod:3836
29362 msgid "rmmountpoint"
29367 #: ../fish/guestfish-actions.pod:3838
29370 " rmmountpoint exemptpath\n"
29376 #: ../fish/guestfish-actions.pod:3840
29378 "This calls removes a mountpoint that was previously created with L</"
29379 "mkmountpoint>. See L</mkmountpoint> for full details."
29384 #: ../fish/guestfish-actions.pod:3844
29385 msgid "scrub-device"
29390 #: ../fish/guestfish-actions.pod:3846
29393 " scrub-device device\n"
29399 #: ../fish/guestfish-actions.pod:3857
29405 #: ../fish/guestfish-actions.pod:3859
29408 " scrub-file file\n"
29414 #: ../fish/guestfish-actions.pod:3869
29415 msgid "scrub-freespace"
29420 #: ../fish/guestfish-actions.pod:3871
29423 " scrub-freespace dir\n"
29429 #: ../fish/guestfish-actions.pod:3873
29431 "This command creates the directory C<dir> and then fills it with files until "
29432 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29433 "deletes them. The intention is to scrub any free space on the partition "
29434 "containing C<dir>."
29439 #: ../fish/guestfish-actions.pod:3882
29445 #: ../fish/guestfish-actions.pod:3884
29451 #: ../fish/guestfish-actions.pod:3886
29454 " set-append append\n"
29459 #: ../fish/guestfish-actions.pod:3897
29460 msgid "set-attach-method"
29464 #: ../fish/guestfish-actions.pod:3899
29465 msgid "attach-method"
29469 #: ../fish/guestfish-actions.pod:3901
29472 " set-attach-method attachmethod\n"
29478 #: ../fish/guestfish-actions.pod:3923
29479 msgid "set-autosync"
29484 #: ../fish/guestfish-actions.pod:3925
29490 #: ../fish/guestfish-actions.pod:3927
29493 " set-autosync true|false\n"
29499 #: ../fish/guestfish-actions.pod:3937
29505 #: ../fish/guestfish-actions.pod:3939
29511 #: ../fish/guestfish-actions.pod:3941
29514 " set-direct true|false\n"
29520 #: ../fish/guestfish-actions.pod:3947
29522 "One consequence of this is that log messages aren't caught by the library "
29523 "and handled by L</set-log-message-callback>, but go straight to stdout."
29528 #: ../fish/guestfish-actions.pod:3956
29529 msgid "set-e2label"
29534 #: ../fish/guestfish-actions.pod:3958
29537 " set-e2label device label\n"
29543 #: ../fish/guestfish-actions.pod:3964
29545 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29546 "label on a filesystem."
29551 #: ../fish/guestfish-actions.pod:3967
29557 #: ../fish/guestfish-actions.pod:3969
29560 " set-e2uuid device uuid\n"
29566 #: ../fish/guestfish-actions.pod:3976
29568 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29569 "UUID of a filesystem."
29574 #: ../fish/guestfish-actions.pod:3979
29575 msgid "set-memsize"
29580 #: ../fish/guestfish-actions.pod:3981
29586 #: ../fish/guestfish-actions.pod:3983
29589 " set-memsize memsize\n"
29595 #: ../fish/guestfish-actions.pod:3985
29597 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29598 "This only has any effect if called before L</launch>."
29603 #: ../fish/guestfish-actions.pod:3996
29604 msgid "set-network"
29609 #: ../fish/guestfish-actions.pod:3998
29615 #: ../fish/guestfish-actions.pod:4000
29618 " set-network true|false\n"
29624 #: ../fish/guestfish-actions.pod:4008
29626 "You must call this before calling L</launch>, otherwise it has no effect."
29631 #: ../fish/guestfish-actions.pod:4011
29637 #: ../fish/guestfish-actions.pod:4013
29643 #: ../fish/guestfish-actions.pod:4015
29646 " set-path searchpath\n"
29652 #: ../fish/guestfish-actions.pod:4024
29658 #: ../fish/guestfish-actions.pod:4026
29664 #: ../fish/guestfish-actions.pod:4028
29673 #: ../fish/guestfish-actions.pod:4048
29674 msgid "set-recovery-proc"
29679 #: ../fish/guestfish-actions.pod:4050
29680 msgid "recovery-proc"
29685 #: ../fish/guestfish-actions.pod:4052
29688 " set-recovery-proc true|false\n"
29694 #: ../fish/guestfish-actions.pod:4054
29696 "If this is called with the parameter C<false> then L</launch> does not "
29697 "create a recovery process. The purpose of the recovery process is to stop "
29698 "runaway qemu processes in the case where the main program aborts abruptly."
29703 #: ../fish/guestfish-actions.pod:4059
29705 "This only has any effect if called before L</launch>, and the default is "
29711 #: ../fish/guestfish-actions.pod:4068
29712 msgid "set-selinux"
29717 #: ../fish/guestfish-actions.pod:4070
29723 #: ../fish/guestfish-actions.pod:4072
29726 " set-selinux true|false\n"
29732 #: ../fish/guestfish-actions.pod:4083
29738 #: ../fish/guestfish-actions.pod:4085
29744 #: ../fish/guestfish-actions.pod:4087
29747 " set-trace true|false\n"
29752 #: ../fish/guestfish-actions.pod:4099
29754 "Trace messages are normally sent to C<stderr>, unless you register a "
29755 "callback to send them somewhere else (see L</set-event-callback>)."
29760 #: ../fish/guestfish-actions.pod:4103
29761 msgid "set-verbose"
29766 #: ../fish/guestfish-actions.pod:4105
29772 #: ../fish/guestfish-actions.pod:4107
29775 " set-verbose true|false\n"
29780 #: ../fish/guestfish-actions.pod:4114
29782 "Verbose messages are normally sent to C<stderr>, unless you register a "
29783 "callback to send them somewhere else (see L</set-event-callback>)."
29788 #: ../fish/guestfish-actions.pod:4118
29794 #: ../fish/guestfish-actions.pod:4120
29797 " setcon context\n"
29803 #: ../fish/guestfish-actions.pod:4127
29809 #: ../fish/guestfish-actions.pod:4129
29812 " setxattr xattr val vallen path\n"
29818 #: ../fish/guestfish-actions.pod:4135
29819 msgid "See also: L</lsetxattr>, L<attr(5)>."
29824 #: ../fish/guestfish-actions.pod:4137
29830 #: ../fish/guestfish-actions.pod:4139
29833 " sfdisk device cyls heads sectors 'lines ...'\n"
29839 #: ../fish/guestfish-actions.pod:4161
29840 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
29845 #: ../fish/guestfish-actions.pod:4167
29851 #: ../fish/guestfish-actions.pod:4169
29854 " sfdiskM device 'lines ...'\n"
29860 #: ../fish/guestfish-actions.pod:4171
29862 "This is a simplified interface to the L</sfdisk> command, where partition "
29863 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
29864 "you don't need to specify the cyls, heads and sectors parameters which were "
29865 "rarely if ever used anyway."
29870 #: ../fish/guestfish-actions.pod:4177
29871 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
29876 #: ../fish/guestfish-actions.pod:4183
29882 #: ../fish/guestfish-actions.pod:4185
29885 " sfdisk-N device partnum cyls heads sectors line\n"
29891 #: ../fish/guestfish-actions.pod:4190
29893 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
29894 "cyls/heads/sectors parameters."
29899 #: ../fish/guestfish-actions.pod:4193
29900 msgid "See also: L</part-add>"
29905 #: ../fish/guestfish-actions.pod:4198
29906 msgid "sfdisk-disk-geometry"
29911 #: ../fish/guestfish-actions.pod:4200
29914 " sfdisk-disk-geometry device\n"
29920 #: ../fish/guestfish-actions.pod:4202
29922 "This displays the disk geometry of C<device> read from the partition table. "
29923 "Especially in the case where the underlying block device has been resized, "
29924 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
29925 "kernel-geometry>)."
29930 #: ../fish/guestfish-actions.pod:4210
29931 msgid "sfdisk-kernel-geometry"
29936 #: ../fish/guestfish-actions.pod:4212
29939 " sfdisk-kernel-geometry device\n"
29945 #: ../fish/guestfish-actions.pod:4219
29951 #: ../fish/guestfish-actions.pod:4221
29954 " sfdisk-l device\n"
29960 #: ../fish/guestfish-actions.pod:4227
29961 msgid "See also: L</part-list>"
29966 #: ../fish/guestfish-actions.pod:4229
29972 #: ../fish/guestfish-actions.pod:4231
29981 #: ../fish/guestfish-actions.pod:4236
29982 msgid "This is like L</command>, but passes the command to:"
29987 #: ../fish/guestfish-actions.pod:4244
29988 msgid "All the provisos about L</command> apply to this call."
29993 #: ../fish/guestfish-actions.pod:4246
29999 #: ../fish/guestfish-actions.pod:4248
30002 " sh-lines command\n"
30008 #: ../fish/guestfish-actions.pod:4250
30009 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30014 #: ../fish/guestfish-actions.pod:4253
30015 msgid "See also: L</command-lines>"
30020 #: ../fish/guestfish-actions.pod:4255
30026 #: ../fish/guestfish-actions.pod:4257
30035 #: ../fish/guestfish-actions.pod:4261
30041 #: ../fish/guestfish-actions.pod:4263
30050 #: ../fish/guestfish-actions.pod:4269
30056 #: ../fish/guestfish-actions.pod:4271
30065 #: ../fish/guestfish-actions.pod:4279
30071 #: ../fish/guestfish-actions.pod:4281
30080 #: ../fish/guestfish-actions.pod:4289
30086 #: ../fish/guestfish-actions.pod:4291
30089 " strings-e encoding path\n"
30095 #: ../fish/guestfish-actions.pod:4293
30097 "This is like the L</strings> command, but allows you to specify the encoding "
30098 "of strings that are looked for in the source file C<path>."
30103 #: ../fish/guestfish-actions.pod:4303
30105 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30106 "ISO-8859-X (this is what L</strings> uses)."
30111 #: ../fish/guestfish-actions.pod:4335
30112 msgid "swapoff-device"
30117 #: ../fish/guestfish-actions.pod:4337
30120 " swapoff-device device\n"
30126 #: ../fish/guestfish-actions.pod:4339
30128 "This command disables the libguestfs appliance swap device or partition "
30129 "named C<device>. See L</swapon-device>."
30134 #: ../fish/guestfish-actions.pod:4343
30135 msgid "swapoff-file"
30140 #: ../fish/guestfish-actions.pod:4345
30143 " swapoff-file file\n"
30149 #: ../fish/guestfish-actions.pod:4349
30150 msgid "swapoff-label"
30155 #: ../fish/guestfish-actions.pod:4351
30158 " swapoff-label label\n"
30164 #: ../fish/guestfish-actions.pod:4356
30165 msgid "swapoff-uuid"
30170 #: ../fish/guestfish-actions.pod:4358
30173 " swapoff-uuid uuid\n"
30179 #: ../fish/guestfish-actions.pod:4363
30180 msgid "swapon-device"
30185 #: ../fish/guestfish-actions.pod:4365
30188 " swapon-device device\n"
30194 #: ../fish/guestfish-actions.pod:4367
30196 "This command enables the libguestfs appliance to use the swap device or "
30197 "partition named C<device>. The increased memory is made available for all "
30198 "commands, for example those run using L</command> or L</sh>."
30203 #: ../fish/guestfish-actions.pod:4379
30204 msgid "swapon-file"
30209 #: ../fish/guestfish-actions.pod:4381
30212 " swapon-file file\n"
30218 #: ../fish/guestfish-actions.pod:4383
30220 "This command enables swap to a file. See L</swapon-device> for other notes."
30225 #: ../fish/guestfish-actions.pod:4386
30226 msgid "swapon-label"
30231 #: ../fish/guestfish-actions.pod:4388
30234 " swapon-label label\n"
30240 #: ../fish/guestfish-actions.pod:4390
30242 "This command enables swap to a labeled swap partition. See L</swapon-"
30243 "device> for other notes."
30248 #: ../fish/guestfish-actions.pod:4393
30249 msgid "swapon-uuid"
30254 #: ../fish/guestfish-actions.pod:4395
30257 " swapon-uuid uuid\n"
30263 #: ../fish/guestfish-actions.pod:4397
30265 "This command enables swap to a swap partition with the given UUID. See L</"
30266 "swapon-device> for other notes."
30271 #: ../fish/guestfish-actions.pod:4400
30277 #: ../fish/guestfish-actions.pod:4402
30286 #: ../fish/guestfish-actions.pod:4410
30292 #: ../fish/guestfish-actions.pod:4412
30301 #: ../fish/guestfish-actions.pod:4420
30307 #: ../fish/guestfish-actions.pod:4422
30310 " tail-n nrlines path\n"
30316 #: ../fish/guestfish-actions.pod:4435
30322 #: ../fish/guestfish-actions.pod:4437
30325 " tar-in (tarfile|-) directory\n"
30331 #: ../fish/guestfish-actions.pod:4442
30332 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30337 #: ../fish/guestfish-actions.pod:4447
30343 #: ../fish/guestfish-actions.pod:4449
30346 " tar-out directory (tarfile|-)\n"
30352 #: ../fish/guestfish-actions.pod:4454
30353 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30358 #: ../fish/guestfish-actions.pod:4459
30364 #: ../fish/guestfish-actions.pod:4461
30367 " tgz-in (tarball|-) directory\n"
30373 #: ../fish/guestfish-actions.pod:4466
30374 msgid "To upload an uncompressed tarball, use L</tar-in>."
30379 #: ../fish/guestfish-actions.pod:4470
30385 #: ../fish/guestfish-actions.pod:4472
30388 " tgz-out directory (tarball|-)\n"
30394 #: ../fish/guestfish-actions.pod:4477
30395 msgid "To download an uncompressed tarball, use L</tar-out>."
30400 #: ../fish/guestfish-actions.pod:4481
30406 #: ../fish/guestfish-actions.pod:4483
30415 #: ../fish/guestfish-actions.pod:4492
30421 #: ../fish/guestfish-actions.pod:4494
30430 #: ../fish/guestfish-actions.pod:4499
30431 msgid "truncate-size"
30436 #: ../fish/guestfish-actions.pod:4501
30439 " truncate-size path size\n"
30445 #: ../fish/guestfish-actions.pod:4506
30447 "If the current file size is less than C<size> then the file is extended to "
30448 "the required size with zero bytes. This creates a sparse file (ie. disk "
30449 "blocks are not allocated for the file until you write to it). To create a "
30450 "non-sparse file of zeroes, use L</fallocate64> instead."
30455 #: ../fish/guestfish-actions.pod:4512
30461 #: ../fish/guestfish-actions.pod:4514
30464 " tune2fs-l device\n"
30470 #: ../fish/guestfish-actions.pod:4524
30476 #: ../fish/guestfish-actions.pod:4526
30479 " txz-in (tarball|-) directory\n"
30485 #: ../fish/guestfish-actions.pod:4533
30491 #: ../fish/guestfish-actions.pod:4535
30494 " txz-out directory (tarball|-)\n"
30500 #: ../fish/guestfish-actions.pod:4542
30506 #: ../fish/guestfish-actions.pod:4544
30515 #: ../fish/guestfish-actions.pod:4558
30516 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30521 #: ../fish/guestfish-actions.pod:4563
30527 #: ../fish/guestfish-actions.pod:4565
30533 #: ../fish/guestfish-actions.pod:4567
30536 " umount pathordevice\n"
30542 #: ../fish/guestfish-actions.pod:4573
30548 #: ../fish/guestfish-actions.pod:4575
30549 msgid "unmount-all"
30554 #: ../fish/guestfish-actions.pod:4577
30563 #: ../fish/guestfish-actions.pod:4583
30569 #: ../fish/guestfish-actions.pod:4585
30572 " upload (filename|-) remotefilename\n"
30578 #: ../fish/guestfish-actions.pod:4592
30579 msgid "See also L</download>."
30584 #: ../fish/guestfish-actions.pod:4596
30585 msgid "upload-offset"
30590 #: ../fish/guestfish-actions.pod:4598
30593 " upload-offset (filename|-) remotefilename offset\n"
30599 #: ../fish/guestfish-actions.pod:4610
30601 "Note that there is no limit on the amount of data that can be uploaded with "
30602 "this call, unlike with L</pwrite>, and this call always writes the full "
30603 "amount unless an error occurs."
30608 #: ../fish/guestfish-actions.pod:4615
30609 msgid "See also L</upload>, L</pwrite>."
30614 #: ../fish/guestfish-actions.pod:4619
30620 #: ../fish/guestfish-actions.pod:4621
30623 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30629 #: ../fish/guestfish-actions.pod:4640
30635 #: ../fish/guestfish-actions.pod:4642
30644 #: ../fish/guestfish-actions.pod:4669
30646 "I<Note:> Don't use this call to test for availability of features. In "
30647 "enterprise distributions we backport features from later versions into "
30648 "earlier versions, making this an unreliable way to test for features. Use "
30649 "L</available> instead."
30654 #: ../fish/guestfish-actions.pod:4675
30660 #: ../fish/guestfish-actions.pod:4677
30663 " vfs-label device\n"
30669 #: ../fish/guestfish-actions.pod:4684
30670 msgid "To find a filesystem from the label, use L</findfs-label>."
30675 #: ../fish/guestfish-actions.pod:4686
30681 #: ../fish/guestfish-actions.pod:4688
30684 " vfs-type device\n"
30690 #: ../fish/guestfish-actions.pod:4698
30696 #: ../fish/guestfish-actions.pod:4700
30699 " vfs-uuid device\n"
30705 #: ../fish/guestfish-actions.pod:4707
30706 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30711 #: ../fish/guestfish-actions.pod:4709
30712 msgid "vg-activate"
30717 #: ../fish/guestfish-actions.pod:4711
30720 " vg-activate true|false 'volgroups ...'\n"
30726 #: ../fish/guestfish-actions.pod:4724
30727 msgid "vg-activate-all"
30732 #: ../fish/guestfish-actions.pod:4726
30735 " vg-activate-all true|false\n"
30741 #: ../fish/guestfish-actions.pod:4736
30747 #: ../fish/guestfish-actions.pod:4738
30750 " vgcreate volgroup 'physvols ...'\n"
30756 #: ../fish/guestfish-actions.pod:4743
30762 #: ../fish/guestfish-actions.pod:4745
30765 " vglvuuids vgname\n"
30771 #: ../fish/guestfish-actions.pod:4750
30773 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30774 "logical volumes and volume groups."
30779 #: ../fish/guestfish-actions.pod:4753
30780 msgid "See also L</vgpvuuids>."
30785 #: ../fish/guestfish-actions.pod:4755
30791 #: ../fish/guestfish-actions.pod:4757
30794 " vgpvuuids vgname\n"
30800 #: ../fish/guestfish-actions.pod:4762
30802 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30803 "physical volumes and volume groups."
30808 #: ../fish/guestfish-actions.pod:4765
30809 msgid "See also L</vglvuuids>."
30814 #: ../fish/guestfish-actions.pod:4767
30820 #: ../fish/guestfish-actions.pod:4769
30823 " vgremove vgname\n"
30829 #: ../fish/guestfish-actions.pod:4776
30835 #: ../fish/guestfish-actions.pod:4778
30838 " vgrename volgroup newvolgroup\n"
30844 #: ../fish/guestfish-actions.pod:4782
30850 #: ../fish/guestfish-actions.pod:4784
30859 #: ../fish/guestfish-actions.pod:4792
30860 msgid "See also L</vgs-full>."
30865 #: ../fish/guestfish-actions.pod:4794
30871 #: ../fish/guestfish-actions.pod:4796
30880 #: ../fish/guestfish-actions.pod:4801
30886 #: ../fish/guestfish-actions.pod:4803
30895 #: ../fish/guestfish-actions.pod:4808
30901 #: ../fish/guestfish-actions.pod:4810
30910 #: ../fish/guestfish-actions.pod:4814
30916 #: ../fish/guestfish-actions.pod:4816
30925 #: ../fish/guestfish-actions.pod:4821
30931 #: ../fish/guestfish-actions.pod:4823
30940 #: ../fish/guestfish-actions.pod:4828
30946 #: ../fish/guestfish-actions.pod:4830
30955 #: ../fish/guestfish-actions.pod:4835
30961 #: ../fish/guestfish-actions.pod:4837
30964 " write path content\n"
30970 #: ../fish/guestfish-actions.pod:4845
30976 #: ../fish/guestfish-actions.pod:4847
30979 " write-file path content size\n"
30985 #: ../fish/guestfish-actions.pod:4870
30991 #: ../fish/guestfish-actions.pod:4872
30994 " zegrep regex path\n"
31000 #: ../fish/guestfish-actions.pod:4880
31006 #: ../fish/guestfish-actions.pod:4882
31009 " zegrepi regex path\n"
31015 #: ../fish/guestfish-actions.pod:4890
31021 #: ../fish/guestfish-actions.pod:4892
31030 #: ../fish/guestfish-actions.pod:4900
31031 msgid "See also: L</zero-device>, L</scrub-device>."
31036 #: ../fish/guestfish-actions.pod:4902
31037 msgid "zero-device"
31042 #: ../fish/guestfish-actions.pod:4904
31045 " zero-device device\n"
31051 #: ../fish/guestfish-actions.pod:4906
31053 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31054 "which just zeroes the first few blocks of a device."
31059 #: ../fish/guestfish-actions.pod:4913
31065 #: ../fish/guestfish-actions.pod:4915
31068 " zerofree device\n"
31074 #: ../fish/guestfish-actions.pod:4928
31080 #: ../fish/guestfish-actions.pod:4930
31083 " zfgrep pattern path\n"
31089 #: ../fish/guestfish-actions.pod:4938
31095 #: ../fish/guestfish-actions.pod:4940
31098 " zfgrepi pattern path\n"
31104 #: ../fish/guestfish-actions.pod:4948
31110 #: ../fish/guestfish-actions.pod:4950
31113 " zfile meth path\n"
31119 #: ../fish/guestfish-actions.pod:4957
31121 "Since 1.0.63, use L</file> instead which can now process compressed files."
31126 #: ../fish/guestfish-actions.pod:4967
31132 #: ../fish/guestfish-actions.pod:4969
31135 " zgrep regex path\n"
31141 #: ../fish/guestfish-actions.pod:4977
31147 #: ../fish/guestfish-actions.pod:4979
31150 " zgrepi regex path\n"
31156 #: ../fish/guestfish-commands.pod:1
31162 #: ../fish/guestfish-commands.pod:3
31168 #: ../fish/guestfish-commands.pod:5
31171 " alloc filename size\n"
31177 #: ../fish/guestfish-commands.pod:7
31179 "This creates an empty (zeroed) file of the given size, and then adds so it "
31180 "can be further examined."
31185 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31186 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31191 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31192 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31197 #: ../fish/guestfish-commands.pod:14
31199 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31200 "image, see L</PREPARED DISK IMAGES>."
31205 #: ../fish/guestfish-commands.pod:17
31211 #: ../fish/guestfish-commands.pod:19
31214 " copy-in local [local ...] /remotedir\n"
31220 #: ../fish/guestfish-commands.pod:21
31222 "C<copy-in> copies local files or directories recursively into the disk "
31223 "image, placing them in the directory called C</remotedir> (which must "
31224 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31225 "other commands as necessary."
31230 #: ../fish/guestfish-commands.pod:26
31232 "Multiple local files and directories can be specified, but the last "
31233 "parameter must always be a remote directory. Wildcards cannot be used."
31238 #: ../fish/guestfish-commands.pod:30
31244 #: ../fish/guestfish-commands.pod:32
31247 " copy-out remote [remote ...] localdir\n"
31253 #: ../fish/guestfish-commands.pod:34
31255 "C<copy-out> copies remote files or directories recursively out of the disk "
31256 "image, placing them on the host disk in a local directory called C<localdir> "
31257 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31258 "download>, L</tar-out> and other commands as necessary."
31263 #: ../fish/guestfish-commands.pod:40
31265 "Multiple remote files and directories can be specified, but the last "
31266 "parameter must always be a local directory. To download to the current "
31267 "directory, use C<.> as in:"
31272 #: ../fish/guestfish-commands.pod:44
31275 " copy-out /home .\n"
31281 #: ../fish/guestfish-commands.pod:46
31283 "Wildcards cannot be used in the ordinary command, but you can use them with "
31284 "the help of L</glob> like this:"
31289 #: ../fish/guestfish-commands.pod:49
31292 " glob copy-out /home/* .\n"
31298 #: ../fish/guestfish-commands.pod:51
31304 #: ../fish/guestfish-commands.pod:53
31307 " echo [params ...]\n"
31313 #: ../fish/guestfish-commands.pod:55
31314 msgid "This echos the parameters to the terminal."
31319 #: ../fish/guestfish-commands.pod:57
31325 #: ../fish/guestfish-commands.pod:59
31331 #: ../fish/guestfish-commands.pod:61
31337 #: ../fish/guestfish-commands.pod:63
31346 #: ../fish/guestfish-commands.pod:65
31348 "This is used to edit a file. It downloads the file, edits it locally using "
31349 "your editor, then uploads the result."
31354 #: ../fish/guestfish-commands.pod:68
31356 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31357 "or C<emacs> you will get those corresponding editors."
31362 #: ../fish/guestfish-commands.pod:72
31368 #: ../fish/guestfish-commands.pod:74
31371 " glob command args...\n"
31377 #: ../fish/guestfish-commands.pod:76
31379 "Expand wildcards in any paths in the args list, and run C<command> "
31380 "repeatedly on each matching path."
31385 #: ../fish/guestfish-commands.pod:79
31386 msgid "See L</WILDCARDS AND GLOBBING>."
31391 #: ../fish/guestfish-commands.pod:81
31397 #: ../fish/guestfish-commands.pod:83
31400 " hexedit <filename|device>\n"
31401 " hexedit <filename|device> <max>\n"
31402 " hexedit <filename|device> <start> <max>\n"
31408 #: ../fish/guestfish-commands.pod:87
31410 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31416 #: ../fish/guestfish-commands.pod:90
31418 "This command works by downloading potentially the whole file or device, "
31419 "editing it locally, then uploading it. If the file or device is large, you "
31420 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31421 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31422 "usual modifiers allowed such as C<1M> (1 megabyte)."
31427 #: ../fish/guestfish-commands.pod:97
31428 msgid "For example to edit the first few sectors of a disk you might do:"
31433 #: ../fish/guestfish-commands.pod:100
31436 " hexedit /dev/sda 1M\n"
31442 #: ../fish/guestfish-commands.pod:102
31444 "which would allow you to edit anywhere within the first megabyte of the disk."
31449 #: ../fish/guestfish-commands.pod:105
31450 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31455 #: ../fish/guestfish-commands.pod:107
31458 " hexedit /dev/sda1 0x400 0x400\n"
31464 #: ../fish/guestfish-commands.pod:109
31465 msgid "(assuming the superblock is in the standard location)."
31470 #: ../fish/guestfish-commands.pod:111
31472 "This command requires the external L<hexedit(1)> program. You can specify "
31473 "another program to use by setting the C<HEXEDITOR> environment variable."
31478 #: ../fish/guestfish-commands.pod:115
31479 msgid "See also L</hexdump>."
31484 #: ../fish/guestfish-commands.pod:117
31490 #: ../fish/guestfish-commands.pod:119
31499 #: ../fish/guestfish-commands.pod:121
31501 "Change the local directory, ie. the current directory of guestfish itself."
31506 #: ../fish/guestfish-commands.pod:124
31507 msgid "Note that C<!cd> won't do what you might expect."
31512 #: ../fish/guestfish-commands.pod:126
31518 #: ../fish/guestfish-commands.pod:128
31524 #: ../fish/guestfish-commands.pod:130
31533 #: ../fish/guestfish-commands.pod:132
31534 msgid "Opens the manual page for guestfish."
31539 #: ../fish/guestfish-commands.pod:134
31545 #: ../fish/guestfish-commands.pod:136
31551 #: ../fish/guestfish-commands.pod:138
31560 #: ../fish/guestfish-commands.pod:140
31569 #: ../fish/guestfish-commands.pod:142
31570 msgid "This is used to view a file."
31575 #: ../fish/guestfish-commands.pod:144
31577 "The default viewer is C<$PAGER>. However if you use the alternate command "
31578 "C<less> you will get the C<less> command specifically."
31583 #: ../fish/guestfish-commands.pod:147
31589 #: ../fish/guestfish-commands.pod:149
31598 #: ../fish/guestfish-commands.pod:151
31600 "Close and reopen the libguestfs handle. It is not necessary to use this "
31601 "normally, because the handle is closed properly when guestfish exits. "
31602 "However this is occasionally useful for testing."
31607 #: ../fish/guestfish-commands.pod:155
31613 #: ../fish/guestfish-commands.pod:157
31616 " sparse filename size\n"
31622 #: ../fish/guestfish-commands.pod:159
31624 "This creates an empty sparse file of the given size, and then adds so it can "
31625 "be further examined."
31630 #: ../fish/guestfish-commands.pod:162
31632 "In all respects it works the same as the L</alloc> command, except that the "
31633 "image file is allocated sparsely, which means that disk blocks are not "
31634 "assigned to the file until they are needed. Sparse disk files only use "
31635 "space when written to, but they are slower and there is a danger you could "
31636 "run out of real disk space during a write operation."
31641 #: ../fish/guestfish-commands.pod:172
31647 #: ../fish/guestfish-commands.pod:174
31656 #: ../fish/guestfish-commands.pod:176
31658 "This command returns a list of the optional groups known to the daemon, and "
31659 "indicates which ones are supported by this build of the libguestfs appliance."
31664 #: ../fish/guestfish-commands.pod:180
31665 msgid "See also L<guestfs(3)/AVAILABILITY>."
31670 #: ../fish/guestfish-commands.pod:182
31676 #: ../fish/guestfish-commands.pod:184
31679 " time command args...\n"
31685 #: ../fish/guestfish-commands.pod:186
31687 "Run the command as usual, but print the elapsed time afterwards. This can "
31688 "be useful for benchmarking operations."
31693 #: ../test-tool/libguestfs-test-tool.pod:5
31694 msgid "libguestfs-test-tool - End user tests for libguestfs"
31699 #: ../test-tool/libguestfs-test-tool.pod:9
31702 " libguestfs-test-tool [--options]\n"
31708 #: ../test-tool/libguestfs-test-tool.pod:13
31710 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31711 "and developers, to allow them to check basic libguestfs functionality is "
31712 "working. This is needed because libguestfs occasionally breaks for reasons "
31713 "beyond our control: usually because of changes in the underlying qemu or "
31714 "kernel packages, or the host environment."
31719 #: ../test-tool/libguestfs-test-tool.pod:20
31720 msgid "If you suspect a problem in libguestfs, then just run:"
31725 #: ../test-tool/libguestfs-test-tool.pod:22
31728 " libguestfs-test-tool\n"
31734 #: ../test-tool/libguestfs-test-tool.pod:24
31735 msgid "It will print lots of diagnostic messages."
31740 #: ../test-tool/libguestfs-test-tool.pod:26
31741 msgid "If it runs to completion successfully, you will see this near the end:"
31746 #: ../test-tool/libguestfs-test-tool.pod:28
31749 " ===== TEST FINISHED OK =====\n"
31755 #: ../test-tool/libguestfs-test-tool.pod:30
31756 msgid "and the test tool will exit with code 0."
31761 #: ../test-tool/libguestfs-test-tool.pod:32
31763 "If it fails (and/or exits with non-zero error code), please paste the "
31764 "B<complete, unedited> output of the test tool into a bug report. More "
31765 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31771 #: ../test-tool/libguestfs-test-tool.pod:41
31777 #: ../test-tool/libguestfs-test-tool.pod:43
31778 msgid "Display short usage information and exit."
31783 #: ../test-tool/libguestfs-test-tool.pod:45
31784 msgid "I<--qemu qemu_binary>"
31789 #: ../test-tool/libguestfs-test-tool.pod:47
31791 "If you have downloaded another qemu binary, point this option at the full "
31792 "path of the binary to try it."
31797 #: ../test-tool/libguestfs-test-tool.pod:50
31798 msgid "I<--qemudir qemu_source_dir>"
31803 #: ../test-tool/libguestfs-test-tool.pod:52
31805 "If you have compiled qemu from source, point this option at the source "
31806 "directory to try it."
31811 #: ../test-tool/libguestfs-test-tool.pod:55
31812 msgid "I<--timeout N>"
31817 #: ../test-tool/libguestfs-test-tool.pod:57
31819 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31820 "does not usually need to be adjusted unless your machine is very slow."
31825 #: ../test-tool/libguestfs-test-tool.pod:63
31826 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31831 #: ../test-tool/libguestfs-test-tool.pod:65
31833 "If you have compiled another version of qemu from source and would like to "
31834 "try that, then you can use the I<--qemudir> option to point to the qemu "
31835 "source directory."
31840 #: ../test-tool/libguestfs-test-tool.pod:69
31842 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
31843 "option to point to the binary."
31848 #: ../test-tool/libguestfs-test-tool.pod:72
31850 "When using an alternate qemu with libguestfs, usually you would need to "
31851 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
31852 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
31853 "use either of the I<--qemudir> or I<--qemu> options."
31858 #: ../test-tool/libguestfs-test-tool.pod:79
31860 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
31861 "I<1> if there was an error."
31866 #: ../test-tool/libguestfs-test-tool.pod:84
31868 "For the full list of environment variables which may affect libguestfs, "
31869 "please see the L<guestfs(3)> manual page."
31874 #: ../test-tool/libguestfs-test-tool.pod:89
31875 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
31880 #: ../fuse/guestmount.pod:5
31882 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
31887 #: ../fuse/guestmount.pod:9
31890 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
31896 #: ../fuse/guestmount.pod:11
31899 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
31905 #: ../fuse/guestmount.pod:13
31908 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
31914 #: ../fuse/guestmount.pod:17
31916 "You must I<not> use C<guestmount> in read-write mode on live virtual "
31917 "machines. If you do this, you risk disk corruption in the VM."
31922 #: ../fuse/guestmount.pod:22
31924 "The guestmount program can be used to mount virtual machine filesystems and "
31925 "other disk images on the host. It uses libguestfs for access to the guest "
31926 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
31927 "a mountable device."
31932 #: ../fuse/guestmount.pod:27
31934 "Along with other options, you have to give at least one device (I<-a> "
31935 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
31936 "option) or use the I<-i> inspection option. How this works is better "
31937 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
31943 #: ../fuse/guestmount.pod:33
31945 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
31946 "by you, and the filesystem will not be visible to any other users unless you "
31947 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
31948 "the filesystem, use the C<fusermount -u> command."
31953 #: ../fuse/guestmount.pod:41
31955 "For a typical Windows guest which has its main filesystem on the first "
31961 #: ../fuse/guestmount.pod:44
31964 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
31970 #: ../fuse/guestmount.pod:46
31972 "For a typical Linux guest which has a /boot filesystem on the first "
31973 "partition, and the root filesystem on a logical volume:"
31978 #: ../fuse/guestmount.pod:49
31981 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
31987 #: ../fuse/guestmount.pod:51
31988 msgid "To get libguestfs to detect guest mountpoints for you:"
31993 #: ../fuse/guestmount.pod:53
31996 " guestmount -a guest.img -i --ro /mnt\n"
32002 #: ../fuse/guestmount.pod:55
32003 msgid "For a libvirt guest called \"Guest\" you could do:"
32008 #: ../fuse/guestmount.pod:57
32011 " guestmount -d Guest -i --ro /mnt\n"
32017 #: ../fuse/guestmount.pod:59
32019 "If you don't know what filesystems are contained in a guest or disk image, "
32020 "use L<virt-filesystems(1)> first:"
32025 #: ../fuse/guestmount.pod:62
32028 " virt-filesystems MyGuest\n"
32034 #: ../fuse/guestmount.pod:64
32036 "If you want to trace the libguestfs calls but without excessive debugging "
32037 "information, we recommend:"
32042 #: ../fuse/guestmount.pod:67
32045 " guestmount [...] --trace /mnt\n"
32051 #: ../fuse/guestmount.pod:69
32052 msgid "If you want to debug the program, we recommend:"
32057 #: ../fuse/guestmount.pod:71
32060 " guestmount [...] --trace --verbose /mnt\n"
32066 #: ../fuse/guestmount.pod:77
32067 msgid "B<-a image> | B<--add image>"
32072 #: ../fuse/guestmount.pod:79
32073 msgid "Add a block device or virtual machine image."
32078 #: ../fuse/guestmount.pod:84
32079 msgid "B<-c URI> | B<--connect URI>"
32084 #: ../fuse/guestmount.pod:90
32085 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32090 #: ../fuse/guestmount.pod:96
32091 msgid "B<--dir-cache-timeout N>"
32096 #: ../fuse/guestmount.pod:98
32098 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32099 "seconds. The readdir cache [actually, there are several semi-independent "
32100 "caches] is populated after a readdir(2) call with the stat and extended "
32101 "attributes of the files in the directory, in anticipation that they will be "
32102 "requested soon after."
32107 #: ../fuse/guestmount.pod:104
32109 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32110 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32111 "requests, only cache existing ones."
32116 #: ../fuse/guestmount.pod:115
32117 msgid "B<--format=raw|qcow2|..> | B<--format>"
32122 #: ../fuse/guestmount.pod:122
32124 "If you have untrusted raw-format guest disk images, you should use this "
32125 "option to specify the disk format. This avoids a possible security problem "
32126 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32127 "guestfs_add_drive_opts>."
32132 #: ../fuse/guestmount.pod:127
32133 msgid "B<--fuse-help>"
32138 #: ../fuse/guestmount.pod:129
32139 msgid "Display help on special FUSE options (see I<-o> below)."
32144 #: ../fuse/guestmount.pod:133
32145 msgid "Display brief help and exit."
32150 #: ../fuse/guestmount.pod:135
32151 msgid "B<-i> | B<--inspector>"
32156 #: ../fuse/guestmount.pod:155
32158 "Mount the named partition or logical volume on the given mountpoint B<in the "
32159 "guest> (this has nothing to do with mountpoints in the host)."
32164 #: ../fuse/guestmount.pod:158
32166 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32167 "something on C</>."
32172 #: ../fuse/guestmount.pod:171
32173 msgid "B<-n> | B<--no-sync>"
32178 #: ../fuse/guestmount.pod:173
32180 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32181 "unmounted. If you specify this option, then we don't attempt to sync the "
32182 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32187 #: ../fuse/guestmount.pod:178
32188 msgid "B<-o option> | B<--option option>"
32193 #: ../fuse/guestmount.pod:180
32194 msgid "Pass extra options to FUSE."
32199 #: ../fuse/guestmount.pod:182
32201 "To get a list of all the extra options supported by FUSE, use the command "
32202 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32203 "of them are a good idea."
32208 #: ../fuse/guestmount.pod:186
32211 " guestmount --fuse-help\n"
32217 #: ../fuse/guestmount.pod:188
32218 msgid "Some potentially useful FUSE options:"
32223 #: ../fuse/guestmount.pod:192
32224 msgid "B<-o allow_other>"
32229 #: ../fuse/guestmount.pod:194
32230 msgid "Allow other users to see the filesystem."
32235 #: ../fuse/guestmount.pod:196
32236 msgid "B<-o attr_timeout=N>"
32241 #: ../fuse/guestmount.pod:198
32242 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32247 #: ../fuse/guestmount.pod:200
32248 msgid "B<-o kernel_cache>"
32253 #: ../fuse/guestmount.pod:202
32255 "Allow the kernel to cache files (reduces the number of reads that have to go "
32256 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32257 "afford the extra memory usage."
32262 #: ../fuse/guestmount.pod:206
32263 msgid "B<-o uid=N> B<-o gid=N>"
32268 #: ../fuse/guestmount.pod:208
32270 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32271 "the chosen values."
32276 #: ../fuse/guestmount.pod:213
32277 msgid "B<-r> | B<--ro>"
32282 #: ../fuse/guestmount.pod:215
32284 "Add devices and mount everything read-only. Also disallow writes and make "
32285 "the disk appear read-only to FUSE."
32290 #: ../fuse/guestmount.pod:218
32292 "This is highly recommended if you are not going to edit the guest disk. If "
32293 "the guest is running and this option is I<not> supplied, then there is a "
32294 "strong risk of disk corruption in the guest. We try to prevent this from "
32295 "happening, but it is not always possible."
32300 #: ../fuse/guestmount.pod:223
32301 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32306 #: ../fuse/guestmount.pod:227
32307 msgid "Enable SELinux support for the guest."
32312 #: ../fuse/guestmount.pod:229
32313 msgid "B<-v> | B<--verbose>"
32318 #: ../fuse/guestmount.pod:231
32319 msgid "Enable verbose messages from underlying libguestfs."
32324 #: ../fuse/guestmount.pod:233
32325 msgid "B<-V> | B<--version>"
32330 #: ../fuse/guestmount.pod:235
32331 msgid "Display the program version and exit."
32336 #: ../fuse/guestmount.pod:237
32337 msgid "B<-w> | B<--rw>"
32341 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
32342 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32347 #: ../fuse/guestmount.pod:244
32348 msgid "B<-x> | B<--trace>"
32353 #: ../fuse/guestmount.pod:246
32354 msgid "Trace libguestfs calls and entry into each FUSE function."
32359 #: ../fuse/guestmount.pod:248
32360 msgid "This also stops the daemon from forking into the background."
32365 #: ../fuse/guestmount.pod:269
32367 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32368 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32374 #: ../fuse/guestmount.pod:284
32375 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32380 #: ../tools/virt-edit.pl:34
32381 msgid "virt-edit - Edit a file in a virtual machine"
32386 #: ../tools/virt-edit.pl:38
32389 " virt-edit [--options] domname file\n"
32395 #: ../tools/virt-edit.pl:40
32398 " virt-edit [--options] disk.img [disk.img ...] file\n"
32404 #: ../tools/virt-edit.pl:42
32407 " virt-edit [domname|disk.img] file -e 'expr'\n"
32413 #: ../tools/virt-edit.pl:46
32415 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32416 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32417 "doing this, but doesn't catch all cases."
32422 #: ../tools/virt-edit.pl:52
32424 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32425 "the named virtual machine (or disk image)."
32429 #: ../tools/virt-edit.pl:55
32430 msgid "If you want to just view a file, use L<virt-cat(1)>."
32434 #: ../tools/virt-edit.pl:57
32436 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32437 "USING GUESTFISH> below)."
32441 #: ../tools/virt-edit.pl:60
32443 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32444 "files. L<guestfish(1)> can do that and much more."
32449 #: ../tools/virt-edit.pl:65
32450 msgid "Edit the named files interactively:"
32455 #: ../tools/virt-edit.pl:67
32458 " virt-edit mydomain /boot/grub/grub.conf\n"
32464 #: ../tools/virt-edit.pl:69
32467 " virt-edit mydomain /etc/passwd\n"
32472 #: ../tools/virt-edit.pl:71
32473 msgid "For Windows guests, some Windows paths are understood:"
32477 #: ../tools/virt-edit.pl:73
32480 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32486 #: ../tools/virt-edit.pl:75
32488 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32489 "below). To change the init default level to 5:"
32494 #: ../tools/virt-edit.pl:79
32497 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32503 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32504 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32505 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32506 msgid "Display brief help."
32511 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32512 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
32513 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
32514 msgid "Display version number and exit."
32519 #: ../tools/virt-edit.pl:105
32520 msgid "B<--backup extension> | B<-b extension>"
32525 #: ../tools/virt-edit.pl:107
32527 "Create a backup of the original file I<in the guest disk image>. The backup "
32528 "has the original filename with C<extension> added."
32533 #: ../tools/virt-edit.pl:110
32535 "Usually the first character of C<extension> would be a dot C<.> so you would "
32541 #: ../tools/virt-edit.pl:113
32544 " virt-edit -b .orig [etc]\n"
32550 #: ../tools/virt-edit.pl:115
32551 msgid "By default, no backup file is made."
32556 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32557 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32558 #: ../tools/virt-list-partitions.pl:78
32559 msgid "B<--connect URI> | B<-c URI>"
32564 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32565 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32566 #: ../tools/virt-list-partitions.pl:80
32568 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32569 "to the default libvirt hypervisor."
32574 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32575 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32576 #: ../tools/virt-list-partitions.pl:83
32578 "If you specify guest block devices directly, then libvirt is not used at all."
32583 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32584 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
32585 #: ../tools/virt-list-partitions.pl:90
32586 msgid "B<--format> raw"
32591 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32592 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32593 #: ../tools/virt-list-partitions.pl:92
32595 "Specify the format of disk images given on the command line. If this is "
32596 "omitted then the format is autodetected from the content of the disk image."
32601 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32602 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32603 #: ../tools/virt-list-partitions.pl:96
32605 "If disk images are requested from libvirt, then this program asks libvirt "
32606 "for this information. In this case, the value of the format parameter is "
32612 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32613 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32614 #: ../tools/virt-list-partitions.pl:100
32616 "If working with untrusted raw-format guest disk images, you should ensure "
32617 "the format is always specified."
32622 #: ../tools/virt-edit.pl:150
32623 msgid "B<--expr EXPR> | B<-e EXPR>"
32628 #: ../tools/virt-edit.pl:152
32630 "Instead of launching the external editor, non-interactively apply the Perl "
32631 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32637 #: ../tools/virt-edit.pl:156
32639 "Be careful to properly quote the expression to prevent it from being altered "
32645 #: ../tools/virt-edit.pl:280
32646 msgid "NON-INTERACTIVE EDITING"
32651 #: ../tools/virt-edit.pl:282
32653 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32654 "administrator can interactively edit the file."
32659 #: ../tools/virt-edit.pl:285
32661 "There are two ways also to use C<virt-edit> from scripts in order to make "
32662 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32663 "like this, it's less error-prone to write scripts directly using the "
32664 "libguestfs API and Augeas for configuration file editing.)"
32669 #: ../tools/virt-edit.pl:291
32671 "The first method is to temporarily set C<$EDITOR> to any script or program "
32672 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32673 "update C<tmpfile> in place however it likes."
32678 #: ../tools/virt-edit.pl:295
32680 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
32681 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32682 "instances of C<foo> with C<bar> in a file:"
32687 #: ../tools/virt-edit.pl:299
32690 " virt-edit domname filename -e 's/foo/bar/'\n"
32696 #: ../tools/virt-edit.pl:301
32698 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32699 "For example to delete root's password you could do:"
32704 #: ../tools/virt-edit.pl:304
32707 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32713 #: ../tools/virt-edit.pl:306
32715 "What really happens is that the snippet is evaluated as a Perl expression "
32716 "for each line of the file. The line, including the final C<\\n>, is passed "
32717 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32722 #: ../tools/virt-edit.pl:311
32724 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32725 "C<apache> user account from the password file you can do:"
32730 #: ../tools/virt-edit.pl:314
32733 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32739 #: ../tools/virt-edit.pl:316
32741 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32742 "the end of the file is rather difficult this way since there is no concept "
32743 "of \"last line of the file\" - your expression just doesn't get called "
32744 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32750 #: ../tools/virt-edit.pl:322
32752 "The variable C<$lineno> contains the current line number. As is "
32753 "traditional, the first line in the file is number C<1>."
32758 #: ../tools/virt-edit.pl:325
32760 "The return value from the expression is ignored, but the expression may call "
32761 "C<die> in order to abort the whole program, leaving the original file "
32767 #: ../tools/virt-edit.pl:329
32769 "Remember when matching the end of a line that C<$_> may contain the final C<"
32770 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32771 "newline then neither of these. Thus to match or substitute some text at the "
32772 "end of a line, use this regular expression:"
32777 #: ../tools/virt-edit.pl:334
32780 " /some text(\\r?\\n)?$/\n"
32786 #: ../tools/virt-edit.pl:336
32788 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32789 "$_> itself (since that would remove all newlines from the file):"
32794 #: ../tools/virt-edit.pl:340
32797 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32802 #: ../tools/virt-edit.pl:344
32804 "C<virt-edit> has a limited ability to understand Windows drive letters and "
32805 "paths (eg. C<E:\\foo\\bar.txt>)."
32809 #: ../tools/virt-edit.pl:347
32810 msgid "If and only if the guest is running Windows then:"
32814 #: ../tools/virt-edit.pl:353
32816 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
32817 "to the correct filesystem."
32821 #: ../tools/virt-edit.pl:358
32823 "Any backslash (C<\\>) characters in the path are replaced with forward "
32824 "slashes so that libguestfs can process it."
32828 #: ../tools/virt-edit.pl:363
32830 "The path is resolved case insensitively to locate the file that should be "
32835 #: ../tools/virt-edit.pl:368
32836 msgid "There are some known shortcomings:"
32840 #: ../tools/virt-edit.pl:374
32841 msgid "Some NTFS symbolic links may not be followed correctly."
32845 #: ../tools/virt-edit.pl:378
32846 msgid "NTFS junction points that cross filesystems are not followed."
32850 #: ../tools/virt-edit.pl:435
32851 msgid "USING GUESTFISH"
32855 #: ../tools/virt-edit.pl:437
32857 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
32858 "C<virt-edit> doesn't work."
32862 #: ../tools/virt-edit.pl:440
32863 msgid "Using C<virt-edit> is approximately equivalent to doing:"
32867 #: ../tools/virt-edit.pl:442
32870 " guestfish --rw -i -d domname edit /file\n"
32875 #: ../tools/virt-edit.pl:444
32877 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
32878 "path to the file."
32882 #: ../tools/virt-edit.pl:447
32884 "The command above uses libguestfs's guest inspection feature and so does not "
32885 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
32886 "disk images that don't contain guests. To edit a file on a disk image "
32891 #: ../tools/virt-edit.pl:452
32894 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
32899 #: ../tools/virt-edit.pl:454
32901 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
32902 "the disk image to edit, and C</file> is the full path to the file."
32906 #: ../tools/virt-edit.pl:458
32908 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
32909 "C<write> or C<upload> instead:"
32913 #: ../tools/virt-edit.pl:461
32916 " guestfish --rw -i -d domname touch /newfile\n"
32921 #: ../tools/virt-edit.pl:463
32924 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
32929 #: ../tools/virt-edit.pl:465
32932 " guestfish --rw -i -d domname upload localfile /newfile\n"
32937 #: ../tools/virt-edit.pl:467
32939 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
32943 #: ../tools/virt-edit.pl:470
32946 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
32952 #: ../tools/virt-edit.pl:480
32958 #: ../tools/virt-edit.pl:482
32960 "If set, this string is used as the editor. It may contain arguments, eg. C<"
32966 #: ../tools/virt-edit.pl:485
32967 msgid "If not set, C<vi> is used."
32972 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
32973 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
32974 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
32975 msgid "SHELL QUOTING"
32980 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
32981 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
32982 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
32984 "Libvirt guest names can contain arbitrary characters, some of which have "
32985 "meaning to the shell such as C<#> and space. You may need to quote or "
32986 "escape these characters on the command line. See the shell manual page L<sh"
32987 "(1)> for details."
32991 #: ../tools/virt-edit.pl:498
32993 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
32994 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
32995 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
33000 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
33001 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
33002 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
33008 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
33009 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
33010 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
33011 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33015 #: ../tools/virt-edit.pl:516
33016 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33021 #: ../tools/virt-win-reg.pl:37
33023 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33028 #: ../tools/virt-win-reg.pl:41
33031 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33037 #: ../tools/virt-win-reg.pl:43
33040 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33046 #: ../tools/virt-win-reg.pl:45
33049 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33055 #: ../tools/virt-win-reg.pl:47
33058 " virt-win-reg --merge domname [input.reg ...]\n"
33064 #: ../tools/virt-win-reg.pl:49
33067 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33073 #: ../tools/virt-win-reg.pl:53
33075 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
33076 "virtual machines. If you do this, you I<will> get irreversible disk "
33077 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33078 "but doesn't catch all cases."
33083 #: ../tools/virt-win-reg.pl:58
33085 "Modifying the Windows Registry is an inherently risky operation. The format "
33086 "is deliberately obscure and undocumented, and Registry changes can leave the "
33087 "system unbootable. Therefore when using the C<--merge> option, make sure "
33088 "you have a reliable backup first."
33093 #: ../tools/virt-win-reg.pl:65
33095 "This program can export and merge Windows Registry entries from a Windows "
33101 #: ../tools/virt-win-reg.pl:68
33103 "The first parameter is the libvirt guest name or the raw disk image of a "
33109 #: ../tools/virt-win-reg.pl:71
33111 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
33112 "exported (recursively). For example:"
33117 #: ../tools/virt-win-reg.pl:74
33120 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33126 #: ../tools/virt-win-reg.pl:76
33128 "You can also display single values from within registry keys, for example:"
33133 #: ../tools/virt-win-reg.pl:79
33136 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33137 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33138 " Windows 7 Enterprise\n"
33144 #: ../tools/virt-win-reg.pl:83
33146 "With C<--merge>, you can merge a textual regedit file into the Windows "
33152 #: ../tools/virt-win-reg.pl:86
33155 " $ virt-win-reg --merge Windows7 changes.reg\n"
33161 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33167 #: ../tools/virt-win-reg.pl:90
33169 "This program is only meant for simple access to the registry. If you want "
33170 "to do complicated things with the registry, we suggest you download the "
33171 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33172 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33173 "L<hivexregedit(1)>."
33178 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33184 #: ../tools/virt-win-reg.pl:122
33185 msgid "Enable debugging messages."
33190 #: ../tools/virt-win-reg.pl:157
33196 #: ../tools/virt-win-reg.pl:159
33198 "In merge mode, this merges a textual regedit file into the Windows Registry "
33199 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33200 "displays or exports Registry entries instead."
33205 #: ../tools/virt-win-reg.pl:163
33207 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
33208 "result in disk corruption. However exporting (without this flag) is always "
33214 #: ../tools/virt-win-reg.pl:171
33215 msgid "B<--encoding> UTF-16LE|ASCII"
33220 #: ../tools/virt-win-reg.pl:173
33222 "When merging (only), you may need to specify the encoding for strings to be "
33223 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33224 "(3)/ENCODING STRINGS>."
33229 #: ../tools/virt-win-reg.pl:177
33231 "The default is to use UTF-16LE, which should work with recent versions of "
33237 #: ../tools/virt-win-reg.pl:402
33238 msgid "SUPPORTED SYSTEMS"
33243 #: ../tools/virt-win-reg.pl:404
33245 "The program currently supports Windows NT-derived guests starting with "
33246 "Windows XP through to at least Windows 7."
33251 #: ../tools/virt-win-reg.pl:407
33253 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33254 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33255 "and C<HKEY_USERS\\.DEFAULT>."
33260 #: ../tools/virt-win-reg.pl:411
33262 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33268 #: ../tools/virt-win-reg.pl:414
33270 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33276 #: ../tools/virt-win-reg.pl:417
33282 #: ../tools/virt-win-reg.pl:419
33284 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33285 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33286 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33287 "Windows-style line endings, you may need to reencode the whole file before "
33288 "or after processing."
33293 #: ../tools/virt-win-reg.pl:425
33295 "To reencode a file from Windows format to Linux (before processing it with "
33296 "the C<--merge> option), you would do something like this:"
33301 #: ../tools/virt-win-reg.pl:428
33304 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33310 #: ../tools/virt-win-reg.pl:430
33312 "To go in the opposite direction, after exporting and before sending the file "
33313 "to a Windows user, do something like this:"
33318 #: ../tools/virt-win-reg.pl:433
33321 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33327 #: ../tools/virt-win-reg.pl:435
33328 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33333 #: ../tools/virt-win-reg.pl:437
33335 "If you are unsure about the current encoding, use the L<file(1)> command. "
33336 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33337 "style (CRLF) line endings, like this:"
33342 #: ../tools/virt-win-reg.pl:441
33345 " $ file software.reg\n"
33346 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33347 " with CRLF line terminators\n"
33353 #: ../tools/virt-win-reg.pl:445
33354 msgid "This file would need conversion before you could C<--merge> it."
33359 #: ../tools/virt-win-reg.pl:447
33360 msgid "CurrentControlSet etc."
33365 #: ../tools/virt-win-reg.pl:449
33367 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33368 "Registry at the level of the hive file, and therefore you cannot modify "
33374 #: ../tools/virt-win-reg.pl:453
33376 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33377 "circumstances it might refer to another control set. The way to find out is "
33378 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33383 #: ../tools/virt-win-reg.pl:457
33386 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33387 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33388 " \"Current\"=dword:00000001\n"
33389 " \"Default\"=dword:00000001\n"
33390 " \"Failed\"=dword:00000000\n"
33391 " \"LastKnownGood\"=dword:00000002\n"
33397 #: ../tools/virt-win-reg.pl:464
33398 msgid "\"Current\" is the one which Windows will choose when it boots."
33403 #: ../tools/virt-win-reg.pl:466
33405 "Similarly, other C<Current...> keys in the path may need to be replaced."
33410 #: ../tools/virt-win-reg.pl:469
33411 msgid "WINDOWS TIPS"
33416 #: ../tools/virt-win-reg.pl:471
33418 "Note that some of these tips modify the guest disk image. The guest I<must> "
33419 "be shut off, else you will get disk corruption."
33424 #: ../tools/virt-win-reg.pl:474
33425 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33430 #: ../tools/virt-win-reg.pl:476
33432 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33433 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33434 "is uploaded into C<C:\\>:"
33439 #: ../tools/virt-win-reg.pl:480
33442 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33448 #: ../tools/virt-win-reg.pl:482
33449 msgid "Prepare a regedit file containing the registry change:"
33454 #: ../tools/virt-win-reg.pl:484
33457 " cat > test.reg <<'EOF'\n"
33458 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33459 " \"Test\"=\"c:\\\\test.bat\"\n"
33466 #: ../tools/virt-win-reg.pl:489
33468 "In this example we use the key C<RunOnce> which means that the script will "
33469 "run precisely once when the first user logs in. If you want it to run every "
33470 "time a user logs in, replace C<RunOnce> with C<Run>."
33475 #: ../tools/virt-win-reg.pl:493
33476 msgid "Now update the registry:"
33481 #: ../tools/virt-win-reg.pl:495
33484 " virt-win-reg --merge WindowsGuest test.reg\n"
33490 #: ../tools/virt-win-reg.pl:497
33491 msgid "INSTALLING A SERVICE"
33496 #: ../tools/virt-win-reg.pl:499
33498 "This section assumes you are familiar with Windows services, and you either "
33499 "have a program which handles the Windows Service Control Protocol directly "
33500 "or you want to run any program using a service wrapper like SrvAny or the "
33506 #: ../tools/virt-win-reg.pl:504
33508 "First upload the program and optionally the service wrapper. In this case "
33509 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33514 #: ../tools/virt-win-reg.pl:508
33517 " guestfish -i -d WindowsGuest <<EOF\n"
33518 " upload rhsrvany.exe /rhsrvany.exe\n"
33519 " upload test.exe /test.exe\n"
33526 #: ../tools/virt-win-reg.pl:513
33528 "Prepare a regedit file containing the registry changes. In this example, "
33529 "the first registry change is needed for the service itself or the service "
33530 "wrapper (if used). The second registry change is only needed because I am "
33531 "using the RHSrvAny service wrapper."
33536 #: ../tools/virt-win-reg.pl:518
33539 " cat > service.reg <<'EOF'\n"
33540 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33541 " \"Type\"=dword:00000010\n"
33542 " \"Start\"=dword:00000002\n"
33543 " \"ErrorControl\"=dword:00000001\n"
33544 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33545 " \"DisplayName\"=\"RHSrvAny\"\n"
33546 " \"ObjectName\"=\"NetworkService\"\n"
33552 #: ../tools/virt-win-reg.pl:527
33555 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33556 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33557 " \"PWD\"=\"c:\\\\Temp\"\n"
33564 #: ../tools/virt-win-reg.pl:538
33566 "For use of C<ControlSet001> see the section above in this manual page. You "
33567 "may need to adjust this according to the control set that is in use by the "
33573 #: ../tools/virt-win-reg.pl:544
33575 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33576 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33577 "privileged account."
33582 #: ../tools/virt-win-reg.pl:550
33584 "For the meaning of the magic numbers, see this Microsoft KB article: "
33585 "L<http://support.microsoft.com/kb/103000>."
33590 #: ../tools/virt-win-reg.pl:555
33591 msgid "Update the registry:"
33596 #: ../tools/virt-win-reg.pl:557
33599 " virt-win-reg --merge WindowsGuest service.reg\n"
33605 #: ../tools/virt-win-reg.pl:561
33607 "Be careful when passing parameters containing C<\\> (backslash) in the "
33608 "shell. Usually you will have to use 'single quotes' or double backslashes "
33609 "(but not both) to protect them from the shell."
33614 #: ../tools/virt-win-reg.pl:565
33615 msgid "Paths and value names are case-insensitive."
33620 #: ../tools/virt-win-reg.pl:574
33622 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33623 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33624 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33629 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33631 "When reporting bugs, please enable debugging and capture the I<complete> "
33637 #: ../tools/virt-win-reg.pl:592
33640 " export LIBGUESTFS_DEBUG=1\n"
33641 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33647 #: ../tools/virt-win-reg.pl:595
33649 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33655 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
33656 msgid "Copyright (C) 2010 Red Hat Inc."
33661 #: ../tools/virt-list-filesystems.pl:32
33663 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33668 #: ../tools/virt-list-filesystems.pl:36
33671 " virt-list-filesystems [--options] domname\n"
33677 #: ../tools/virt-list-filesystems.pl:38
33680 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33686 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33688 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33694 #: ../tools/virt-list-filesystems.pl:45
33696 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33697 "are contained in a virtual machine or disk image."
33702 #: ../tools/virt-list-filesystems.pl:49
33704 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33705 "functionality. For more complex cases you should look at the L<guestfish(1)"
33711 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33712 msgid "B<-l> | B<--long>"
33717 #: ../tools/virt-list-filesystems.pl:108
33719 "With this option, C<virt-list-filesystems> displays the type of each "
33720 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33725 #: ../tools/virt-list-filesystems.pl:115
33726 msgid "B<-a> | B<--all>"
33731 #: ../tools/virt-list-filesystems.pl:117
33733 "Normally we only show mountable filesystems. If this option is given then "
33734 "swap devices are shown too."
33739 #: ../tools/virt-list-filesystems.pl:191
33741 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33742 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33743 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33748 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
33749 msgid "Copyright (C) 2009 Red Hat Inc."
33754 #: ../tools/virt-tar.pl:33
33755 msgid "virt-tar - Extract or upload files to a virtual machine"
33760 #: ../tools/virt-tar.pl:37
33763 " virt-tar [--options] -x domname directory tarball\n"
33769 #: ../tools/virt-tar.pl:39
33772 " virt-tar [--options] -u domname tarball directory\n"
33778 #: ../tools/virt-tar.pl:41
33781 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33787 #: ../tools/virt-tar.pl:43
33790 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33795 #: ../tools/virt-tar.pl:47
33797 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
33798 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
33803 #: ../tools/virt-tar.pl:52
33804 msgid "Download C</home> from the VM into a local tarball:"
33809 #: ../tools/virt-tar.pl:54
33812 " virt-tar -x domname /home home.tar\n"
33818 #: ../tools/virt-tar.pl:56
33821 " virt-tar -zx domname /home home.tar.gz\n"
33827 #: ../tools/virt-tar.pl:58
33828 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33833 #: ../tools/virt-tar.pl:60
33836 " virt-tar -u domname uploadstuff.tar /tmp\n"
33842 #: ../tools/virt-tar.pl:62
33845 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
33851 #: ../tools/virt-tar.pl:66
33853 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
33854 "virtual machines. If you do this, you risk disk corruption in the VM. "
33855 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
33860 #: ../tools/virt-tar.pl:71
33862 "You can use C<-x> (extract) on live virtual machines, but you might get "
33863 "inconsistent results or errors if there is filesystem activity inside the "
33864 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
33865 "work, but the only way to guarantee consistent results is if the virtual "
33866 "machine is shut down."
33871 #: ../tools/virt-tar.pl:79
33873 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
33874 "parts of a guest filesystem. There are many possibilities: making backups, "
33875 "uploading data files, snooping on guest activity, fixing or customizing "
33881 #: ../tools/virt-tar.pl:84
33883 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
33884 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
33885 "should look at the L<guestfish(1)> tool."
33890 #: ../tools/virt-tar.pl:88
33892 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
33893 "its contents (recursively) from the virtual machine into a local tarball. "
33894 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
33895 "virtual machine. You cannot use these two options together."
33900 #: ../tools/virt-tar.pl:94
33902 "In addition, you may need to use the C<-z> (gZip) option to enable "
33903 "compression. When uploading, you have to specify C<-z> if the upload file "
33904 "is compressed because virt-tar won't detect this on its own."
33909 #: ../tools/virt-tar.pl:98
33911 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
33912 "example it cannot do PKZip files or bzip2 compression. If you want that "
33913 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
33914 "the L<libguestfs(3)> API)."
33919 #: ../tools/virt-tar.pl:156
33920 msgid "B<-x> | B<--extract> | B<--download>"
33925 #: ../tools/virt-tar.pl:158
33926 msgid "B<-u> | B<--upload>"
33931 #: ../tools/virt-tar.pl:160
33933 "Use C<-x> to extract (download) a directory from a virtual machine to a "
33939 #: ../tools/virt-tar.pl:163
33941 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
33942 "Please read the L</WARNING> section above before using this option."
33947 #: ../tools/virt-tar.pl:167
33948 msgid "You must specify exactly one of these options."
33953 #: ../tools/virt-tar.pl:173
33954 msgid "B<-z> | B<--gzip>"
33959 #: ../tools/virt-tar.pl:175
33960 msgid "Specify that the input or output tarball is gzip-compressed."
33964 #: ../tools/virt-tar.pl:288
33966 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
33967 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
33968 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
33974 #: ../tools/virt-make-fs.pl:37
33975 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
33980 #: ../tools/virt-make-fs.pl:41
33983 " virt-make-fs [--options] input.tar output.img\n"
33989 #: ../tools/virt-make-fs.pl:43
33992 " virt-make-fs [--options] input.tar.gz output.img\n"
33998 #: ../tools/virt-make-fs.pl:45
34001 " virt-make-fs [--options] directory output.img\n"
34007 #: ../tools/virt-make-fs.pl:49
34009 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34010 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34011 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34012 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34013 "you want to attach these filesystems to existing virtual machines (eg. to "
34014 "import large amounts of read-only data to a VM)."
34019 #: ../tools/virt-make-fs.pl:57
34020 msgid "Basic usage is:"
34025 #: ../tools/virt-make-fs.pl:59
34028 " virt-make-fs input output\n"
34034 #: ../tools/virt-make-fs.pl:61
34036 "where C<input> is either a directory containing files that you want to add, "
34037 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34038 "C<output> is a disk image. The input type is detected automatically. The "
34039 "output disk image defaults to a raw ext2 image unless you specify extra "
34040 "flags (see L</OPTIONS> below)."
34045 #: ../tools/virt-make-fs.pl:67
34046 msgid "EXTRA SPACE"
34051 #: ../tools/virt-make-fs.pl:69
34053 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34054 "the files that it contains, but might have extra space. Depending on how "
34055 "you are going to use the output, you might think this extra space is wasted "
34056 "and want to minimize it, or you might want to leave space so that more files "
34057 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34058 "but you can use the C<--size> flag to leave space in the filesystem if you "
34064 #: ../tools/virt-make-fs.pl:77
34066 "An alternative way to leave extra space but not make the output image any "
34067 "bigger is to use an alternative disk image format (instead of the default "
34068 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
34069 "image format (check your hypervisor supports this before using it). This "
34070 "allows you to choose a large C<--size> but the extra space won't actually be "
34071 "allocated in the image until you try to store something in it."
34075 #: ../tools/virt-make-fs.pl:85
34077 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34078 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34079 "to build another image from scratch."
34084 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34085 #: ../tools/virt-make-fs.pl:142
34091 #: ../tools/virt-make-fs.pl:91
34094 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34100 #: ../tools/virt-make-fs.pl:93
34101 msgid "FILESYSTEM TYPE"
34106 #: ../tools/virt-make-fs.pl:95
34108 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34109 "libguestfs supports can be used (but I<not> read-only formats like "
34110 "ISO9660). Here are some of the more common choices:"
34115 #: ../tools/virt-make-fs.pl:101
34121 #: ../tools/virt-make-fs.pl:103
34123 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34124 "you are not going to use the filesystem in a way that requires the journal, "
34125 "then this is just wasted overhead."
34130 #: ../tools/virt-make-fs.pl:107
34131 msgid "I<ntfs> or I<vfat>"
34136 #: ../tools/virt-make-fs.pl:109
34137 msgid "Useful if exporting data to a Windows guest."
34142 #: ../tools/virt-make-fs.pl:111
34144 "I<Note for vfat>: The tar archive or local directory must only contain files "
34145 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34146 "program running within libguestfs is unable to change the ownership of non-"
34147 "root files, since vfat itself does not support this."
34152 #: ../tools/virt-make-fs.pl:116
34158 #: ../tools/virt-make-fs.pl:118
34160 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34161 "total filesystem size."
34166 #: ../tools/virt-make-fs.pl:125
34169 " virt-make-fs --type=minix input minixfs.img\n"
34175 #: ../tools/virt-make-fs.pl:127
34176 msgid "TO PARTITION OR NOT TO PARTITION"
34181 #: ../tools/virt-make-fs.pl:129
34182 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34187 #: ../tools/virt-make-fs.pl:131
34189 "Adding a partition can make the disk image more compatible with certain "
34190 "virtualized operating systems which don't expect to see a filesystem "
34191 "directly located on a block device (Linux doesn't care and will happily "
34192 "handle both types)."
34197 #: ../tools/virt-make-fs.pl:136
34199 "On the other hand, if you have a partition table then the output image is no "
34200 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34201 "directly on a partitioned disk image. (However libguestfs tools such as "
34202 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34207 #: ../tools/virt-make-fs.pl:144
34208 msgid "Add an MBR partition:"
34213 #: ../tools/virt-make-fs.pl:146
34216 " virt-make-fs --partition -- input disk.img\n"
34222 #: ../tools/virt-make-fs.pl:148
34224 "If the output disk image could be terabyte-sized or larger, it's better to "
34225 "use an EFI/GPT-compatible partition table:"
34230 #: ../tools/virt-make-fs.pl:151
34233 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34239 #: ../tools/virt-make-fs.pl:179
34240 msgid "Enable debugging information."
34245 #: ../tools/virt-make-fs.pl:185
34246 msgid "B<--size=E<lt>NE<gt>>"
34251 #: ../tools/virt-make-fs.pl:187
34252 msgid "B<--size=+E<lt>NE<gt>>"
34257 #: ../tools/virt-make-fs.pl:189
34258 msgid "B<-s E<lt>NE<gt>>"
34263 #: ../tools/virt-make-fs.pl:191
34264 msgid "B<-s +E<lt>NE<gt>>"
34269 #: ../tools/virt-make-fs.pl:193
34271 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
34276 #: ../tools/virt-make-fs.pl:196
34278 "If this option is I<not> given, then the output image will be just large "
34279 "enough to contain all the files, with not much wasted space."
34284 #: ../tools/virt-make-fs.pl:199
34286 "To choose a fixed size output disk, specify an absolute number followed by b/"
34287 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34288 "Petabytes or Exabytes. This must be large enough to contain all the input "
34289 "files, else you will get an error."
34294 #: ../tools/virt-make-fs.pl:204
34296 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
34297 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
34298 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
34299 "the input files, and (approximately) an extra 200 MB free space."
34304 #: ../tools/virt-make-fs.pl:210
34306 "Note that virt-make-fs estimates free space, and therefore will not produce "
34307 "filesystems containing precisely the free space requested. (It is much more "
34308 "expensive and time-consuming to produce a filesystem which has precisely the "
34309 "desired free space)."
34314 #: ../tools/virt-make-fs.pl:219
34315 msgid "B<--format=E<lt>fmtE<gt>>"
34320 #: ../tools/virt-make-fs.pl:221
34321 msgid "B<-F E<lt>fmtE<gt>>"
34326 #: ../tools/virt-make-fs.pl:223
34327 msgid "Choose the output disk image format."
34332 #: ../tools/virt-make-fs.pl:225
34333 msgid "The default is C<raw> (raw disk image)."
34338 #: ../tools/virt-make-fs.pl:227
34340 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
34341 "that would really make sense here is C<qcow2>."
34346 #: ../tools/virt-make-fs.pl:234
34347 msgid "B<--type=E<lt>fsE<gt>>"
34352 #: ../tools/virt-make-fs.pl:236
34353 msgid "B<-t E<lt>fsE<gt>>"
34358 #: ../tools/virt-make-fs.pl:238
34359 msgid "Choose the output filesystem type."
34364 #: ../tools/virt-make-fs.pl:240
34365 msgid "The default is C<ext2>."
34370 #: ../tools/virt-make-fs.pl:242
34372 "Any filesystem which is supported read-write by libguestfs can be used here."
34377 #: ../tools/virt-make-fs.pl:249
34378 msgid "B<--partition>"
34383 #: ../tools/virt-make-fs.pl:251
34384 msgid "B<--partition=E<lt>parttypeE<gt>>"
34389 #: ../tools/virt-make-fs.pl:253
34391 "If specified, this flag adds an MBR partition table to the output disk image."
34396 #: ../tools/virt-make-fs.pl:256
34398 "You can change the partition table type, eg. C<--partition=gpt> for large "
34404 #: ../tools/virt-make-fs.pl:259
34406 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
34407 "might consider the next parameter to be the partition type. For example:"
34412 #: ../tools/virt-make-fs.pl:263
34415 " virt-make-fs --partition input.tar ...\n"
34421 #: ../tools/virt-make-fs.pl:265
34423 "would cause virt-make-fs to think you wanted to use a partition type of "
34424 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
34425 "dash) between options and the input file argument:"
34430 #: ../tools/virt-make-fs.pl:269
34433 " virt-make-fs --partition -- input.tar ...\n"
34438 #: ../tools/virt-make-fs.pl:541
34440 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
34441 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
34442 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
34447 #: ../tools/virt-make-fs.pl:558
34450 " export LIBGUESTFS_DEBUG=1\n"
34451 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
34457 #: ../tools/virt-make-fs.pl:561
34459 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
34465 #: ../tools/virt-list-partitions.pl:32
34467 "virt-list-partitions - List partitions in a virtual machine or disk image"
34472 #: ../tools/virt-list-partitions.pl:36
34475 " virt-list-partitions [--options] domname\n"
34481 #: ../tools/virt-list-partitions.pl:38
34484 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34490 #: ../tools/virt-list-partitions.pl:45
34492 "C<virt-list-partitions> is a command line tool to list the partitions that "
34493 "are contained in a virtual machine or disk image. It is mainly useful as a "
34494 "first step to using L<virt-resize(1)>."
34499 #: ../tools/virt-list-partitions.pl:50
34501 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34502 "functionality. For more complex cases you should look at the L<guestfish(1)"
34508 #: ../tools/virt-list-partitions.pl:107
34509 msgid "B<-h> | B<--human-readable>"
34514 #: ../tools/virt-list-partitions.pl:109
34515 msgid "Show sizes in human-readable form (eg. \"1G\")."
34520 #: ../tools/virt-list-partitions.pl:117
34522 "With this option, C<virt-list-partitions> displays the type and size of each "
34523 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34528 #: ../tools/virt-list-partitions.pl:124
34529 msgid "B<-t> | B<--total>"
34534 #: ../tools/virt-list-partitions.pl:126
34536 "Display the total size of each block device (as a separate row or rows)."
34541 #: ../tools/virt-list-partitions.pl:259
34543 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34544 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34545 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34550 #: ../tools/virt-list-partitions.pl:275
34551 msgid "Copyright (C) 2009-2010 Red Hat Inc."