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-05 20:38+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-resize.pl:40 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../tools/virt-list-partitions.pl:30
32 #: ../src/guestfs.pod:5
33 msgid "guestfs - Library for accessing and modifying virtual machine images"
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
41 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
42 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
43 #: ../tools/virt-list-partitions.pl:34
49 #: ../src/guestfs.pod:9
52 " #include <guestfs.h>\n"
58 #: ../src/guestfs.pod:11
61 " guestfs_h *g = guestfs_create ();\n"
62 " guestfs_add_drive (g, \"guest.img\");\n"
63 " guestfs_launch (g);\n"
64 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
65 " guestfs_touch (g, \"/hello\");\n"
66 " guestfs_umount (g, \"/\");\n"
67 " guestfs_close (g);\n"
73 #: ../src/guestfs.pod:19
76 " cc prog.c -o prog -lguestfs\n"
78 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
84 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
85 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
86 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
87 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
88 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
89 #: ../tools/virt-list-partitions.pl:40
95 #: ../src/guestfs.pod:25
97 "Libguestfs is a library for accessing and modifying guest disk images. "
98 "Amongst the things this is good for: making batch configuration changes to "
99 "guests, getting disk used/free statistics (see also: virt-df), migrating "
100 "between virtualization systems (see also: virt-p2v), performing partial "
101 "backups, performing partial guest clones, cloning guests and changing "
102 "registry/UUID/hostname info, and much else besides."
107 #: ../src/guestfs.pod:33
109 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
110 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
111 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
117 #: ../src/guestfs.pod:38
119 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
120 "what filesystem is in each LV, etc.). It can also run commands in the "
121 "context of the guest. Also you can access filesystems over FUSE."
126 #: ../src/guestfs.pod:43
128 "Libguestfs is a library that can be linked with C and C++ management "
129 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
130 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
136 #: ../src/guestfs.pod:48
138 "You don't need to be root to use libguestfs, although obviously you do need "
139 "enough permissions to access the disk images."
144 #: ../src/guestfs.pod:51
146 "Libguestfs is a large API because it can do many things. For a gentle "
147 "introduction, please read the L</API OVERVIEW> section next."
152 #: ../src/guestfs.pod:54
154 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
166 #: ../src/guestfs.pod:59
168 "This section provides a gentler overview of the libguestfs API. We also try "
169 "to group API calls together, where that may not be obvious from reading "
170 "about the individual calls in the main section of this manual."
175 #: ../src/guestfs.pod:64
181 #: ../src/guestfs.pod:66
183 "Before you can use libguestfs calls, you have to create a handle. Then you "
184 "must add at least one disk image to the handle, followed by launching the "
185 "handle, then performing whatever operations you want, and finally closing "
186 "the handle. By convention we use the single letter C<g> for the name of the "
187 "handle variable, although of course you can use any name you want."
192 #: ../src/guestfs.pod:73
193 msgid "The general structure of all libguestfs-using programs looks like this:"
198 #: ../src/guestfs.pod:76
201 " guestfs_h *g = guestfs_create ();\n"
207 #: ../src/guestfs.pod:78
210 " /* Call guestfs_add_drive additional times if there are\n"
211 " * multiple disk images.\n"
213 " guestfs_add_drive (g, \"guest.img\");\n"
219 #: ../src/guestfs.pod:83
222 " /* Most manipulation calls won't work until you've launched\n"
223 " * the handle 'g'. You have to do this _after_ adding drives\n"
224 " * and _before_ other commands.\n"
226 " guestfs_launch (g);\n"
232 #: ../src/guestfs.pod:89
235 " /* Now you can examine what partitions, LVs etc are available.\n"
237 " char **partitions = guestfs_list_partitions (g);\n"
238 " char **logvols = guestfs_lvs (g);\n"
244 #: ../src/guestfs.pod:94
247 " /* To access a filesystem in the image, you must mount it.\n"
249 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
254 #: ../src/guestfs.pod:98
257 " /* Now you can perform filesystem actions on the guest\n"
260 " guestfs_touch (g, \"/hello\");\n"
266 #: ../src/guestfs.pod:103
269 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
270 " * it is done automatically when you close the handle. See\n"
271 " * discussion of autosync in this page.\n"
273 " guestfs_sync (g);\n"
279 #: ../src/guestfs.pod:109
282 " /* Close the handle 'g'. */\n"
283 " guestfs_close (g);\n"
289 #: ../src/guestfs.pod:112
291 "The code above doesn't include any error checking. In real code you should "
292 "check return values carefully for errors. In general all functions that "
293 "return integers return C<-1> on error, and all functions that return "
294 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
295 "how to handle errors, and consult the documentation for each function call "
296 "below to see precisely how they return error indications. See L<guestfs-"
297 "examples(3)> for fully worked examples."
302 #: ../src/guestfs.pod:121
308 #: ../src/guestfs.pod:123
310 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
311 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
312 "actual block device, or simply an empty file of zeroes that you have created "
313 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
319 #: ../src/guestfs.pod:129
321 "The call you should use in modern code for adding drives is L</"
322 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
323 "specifying that the format is raw, do:"
328 #: ../src/guestfs.pod:133
331 " guestfs_add_drive_opts (g, filename,\n"
332 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
345 #: ../src/guestfs.pod:139
348 " guestfs_add_drive_opts (g, filename,\n"
349 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
350 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
357 #: ../src/guestfs.pod:144
359 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
360 "libguestfs won't modify the file."
365 #: ../src/guestfs.pod:147
367 "Be extremely cautious if the disk image is in use, eg. if it is being used "
368 "by a virtual machine. Adding it read-write will almost certainly cause disk "
369 "corruption, but adding it read-only is safe."
374 #: ../src/guestfs.pod:151
376 "You must add at least one disk image, and you may add multiple disk images. "
377 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
378 "first one you added), C</dev/sdb> (for the second one you added), etc."
383 #: ../src/guestfs.pod:156
385 "Once L</guestfs_launch> has been called you cannot add any more images. You "
386 "can call L</guestfs_list_devices> to get a list of the device names, in the "
387 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
392 #: ../src/guestfs.pod:161
397 #: ../src/guestfs.pod:163
399 "Before you can read or write files, create directories and so on in a disk "
400 "image that contains filesystems, you have to mount those filesystems using "
401 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
402 "a disk image contains (for example) one partition with a filesystem on that "
403 "partition, then you can mount it directly:"
407 #: ../src/guestfs.pod:170
410 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
415 #: ../src/guestfs.pod:172
417 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
418 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
419 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
420 "that these are libguestfs virtual devices, and are nothing to do with host "
425 #: ../src/guestfs.pod:178
427 "If you are given a disk image and you don't know what it contains then you "
428 "have to find out. Libguestfs can do that too: use L</"
429 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
430 "LVs, and either try mounting each to see what is mountable, or else examine "
431 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
432 "filesystems, use L</guestfs_list_filesystems>."
436 #: ../src/guestfs.pod:186
438 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
439 "L</INSPECTION> below). But you might find it easier to look at higher level "
440 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
444 #: ../src/guestfs.pod:191
446 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
447 "several other variations of the C<guestfs_mount_*> call."
452 #: ../src/guestfs.pod:194
453 msgid "FILESYSTEM ACCESS AND MODIFICATION"
458 #: ../src/guestfs.pod:196
460 "The majority of the libguestfs API consists of fairly low-level calls for "
461 "accessing and modifying the files, directories, symlinks etc on mounted "
462 "filesystems. There are over a hundred such calls which you can find listed "
463 "in detail below in this man page, and we don't even pretend to cover them "
464 "all in this overview."
469 #: ../src/guestfs.pod:202
471 "Specify filenames as full paths, starting with C<\"/\"> and including the "
477 #: ../src/guestfs.pod:205
479 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
480 "the file called C<\"etc/passwd\"> then you could do:"
485 #: ../src/guestfs.pod:208
488 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
494 #: ../src/guestfs.pod:210
496 "This would return C<data> as a newly allocated buffer containing the full "
497 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
498 "or C<NULL> if there was an error."
503 #: ../src/guestfs.pod:214
505 "As another example, to create a top-level directory on that filesystem "
506 "called C<\"var\"> you would do:"
511 #: ../src/guestfs.pod:217
514 " guestfs_mkdir (g, \"/var\");\n"
520 #: ../src/guestfs.pod:219
521 msgid "To create a symlink you could do:"
526 #: ../src/guestfs.pod:221
529 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
530 " \"/etc/rc3.d/S30portmap\");\n"
536 #: ../src/guestfs.pod:224
538 "Libguestfs will reject attempts to use relative paths and there is no "
539 "concept of a current working directory."
544 #: ../src/guestfs.pod:227
546 "Libguestfs can return errors in many situations: for example if the "
547 "filesystem isn't writable, or if a file or directory that you requested "
548 "doesn't exist. If you are using the C API (documented here) you have to "
549 "check for those error conditions after each call. (Other language bindings "
550 "turn these errors into exceptions)."
555 #: ../src/guestfs.pod:233
557 "File writes are affected by the per-handle umask, set by calling L</"
558 "guestfs_umask> and defaulting to 022. See L</UMASK>."
563 #: ../src/guestfs.pod:236
569 #: ../src/guestfs.pod:238
571 "Libguestfs contains API calls to read, create and modify partition tables on "
577 #: ../src/guestfs.pod:241
579 "In the common case where you want to create a single partition covering the "
580 "whole disk, you should use the L</guestfs_part_disk> call:"
585 #: ../src/guestfs.pod:245
588 " const char *parttype = \"mbr\";\n"
589 " if (disk_is_larger_than_2TB)\n"
590 " parttype = \"gpt\";\n"
591 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
597 #: ../src/guestfs.pod:250
599 "Obviously this effectively wipes anything that was on that disk image before."
604 #: ../src/guestfs.pod:253
610 #: ../src/guestfs.pod:255
612 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
613 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
614 "you familiarize yourself with the concepts of physical volumes, volume "
615 "groups and logical volumes."
620 #: ../src/guestfs.pod:260
622 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
623 "tldp.org/HOWTO/LVM-HOWTO/>."
628 #: ../src/guestfs.pod:263
633 #: ../src/guestfs.pod:265
635 "Use L</guestfs_cat> to download small, text only files. This call is "
636 "limited to files which are less than 2 MB and which cannot contain any ASCII "
637 "NUL (C<\\0>) characters. However the API is very simple to use."
642 #: ../src/guestfs.pod:269
644 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
645 "bit data, since it returns a (pointer, size) pair. However it is still "
646 "limited to \"small\" files, less than 2 MB."
651 #: ../src/guestfs.pod:273
653 "L</guestfs_download> can be used to download any file, with no limits on "
654 "content or size (even files larger than 4 GB)."
659 #: ../src/guestfs.pod:276
661 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
666 #: ../src/guestfs.pod:279
672 #: ../src/guestfs.pod:281
674 "It's often the case that you want to write a file or files to the disk image."
679 #: ../src/guestfs.pod:284
681 "To write a small file with fixed content, use L</guestfs_write>. To create "
682 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
683 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
684 "of other functions for creating test files, for example L</guestfs_fill> and "
685 "L</guestfs_fill_pattern>."
690 #: ../src/guestfs.pod:290
692 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
693 "file content or size (even files larger than 4 GB)."
698 #: ../src/guestfs.pod:293
700 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
705 #: ../src/guestfs.pod:295
707 "However the fastest way to upload I<large numbers of arbitrary files> is to "
708 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
709 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
710 "in a predictable way (eg. adding it last after all other drives) then you "
711 "can get the device name from L</guestfs_list_devices> and mount it directly "
712 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
713 "portable between kernel versions, and they don't support labels or UUIDs. "
714 "If you want to pre-build an image or you need to mount it using a label or "
715 "UUID, use an ISO image instead."
720 #: ../src/guestfs.pod:306
726 #: ../src/guestfs.pod:308
728 "There are various different commands for copying between files and devices "
729 "and in and out of the guest filesystem. These are summarised in the table "
735 #: ../src/guestfs.pod:314
736 msgid "B<file> to B<file>"
741 #: ../src/guestfs.pod:316
743 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
744 "directories recursively."
749 #: ../src/guestfs.pod:319
750 msgid "B<file or device> to B<file or device>"
755 #: ../src/guestfs.pod:321
757 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
758 "devices in the guest."
763 #: ../src/guestfs.pod:324
764 msgid "Example: duplicate the contents of an LV:"
769 #: ../src/guestfs.pod:326
772 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
778 #: ../src/guestfs.pod:328
780 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
781 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
782 "guestfs_copy_size>."
787 #: ../src/guestfs.pod:332
788 msgid "B<file on the host> to B<file or device>"
793 #: ../src/guestfs.pod:334
794 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
799 #: ../src/guestfs.pod:336
800 msgid "B<file or device> to B<file on the host>"
805 #: ../src/guestfs.pod:338
806 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
811 #: ../src/guestfs.pod:342
812 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
817 #: ../src/guestfs.pod:344
819 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
820 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
821 "appears you can only upload and download to files. However many Un*x-like "
822 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
823 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
824 "and arbitrary file descriptor N."
829 #: ../src/guestfs.pod:352
830 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
834 #: ../src/guestfs.pod:355
837 " guestfs_download (g, filename, \"/dev/stdout\");\n"
843 #: ../src/guestfs.pod:357
844 msgid "and you can write tar output to a pipe C<fd> by doing:"
848 #: ../src/guestfs.pod:359
852 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
853 " guestfs_tar_out (g, \"/\", devfd);\n"
859 #: ../src/guestfs.pod:363
860 msgid "LISTING FILES"
865 #: ../src/guestfs.pod:365
867 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
868 "L<guestfish(1)>-equivalent command C<ll>)."
873 #: ../src/guestfs.pod:368
875 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
876 "programs, as a flat list of strings."
881 #: ../src/guestfs.pod:371
883 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
884 "directory, plus additional information about each one. It is more "
885 "equivalent to using the L<readdir(3)> call on a local filesystem."
890 #: ../src/guestfs.pod:375
892 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
897 #: ../src/guestfs.pod:378
898 msgid "RUNNING COMMANDS"
903 #: ../src/guestfs.pod:380
905 "Although libguestfs is primarily an API for manipulating files inside guest "
906 "images, we also provide some limited facilities for running commands inside "
912 #: ../src/guestfs.pod:384
913 msgid "There are many limitations to this:"
918 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
919 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
920 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1088
921 #: ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101
922 #: ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136
923 #: ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166
924 #: ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178
925 #: ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669
926 #: ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779
927 #: ../src/guestfs.pod:1789 ../src/guestfs.pod:2023 ../src/guestfs.pod:2028
928 #: ../src/guestfs.pod:2034 ../src/guestfs.pod:2042 ../src/guestfs.pod:2396
929 #: ../src/guestfs.pod:2402 ../src/guestfs.pod:2407 ../src/guestfs.pod:2413
930 #: ../src/guestfs.pod:2878 ../src/guestfs.pod:2882 ../src/guestfs.pod:2886
931 #: ../src/guestfs.pod:2890 ../src/guestfs-actions.pod:15
932 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
933 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
934 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600
935 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
936 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620
937 #: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628
938 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642
939 #: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784
940 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
941 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859
942 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868
943 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
944 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
945 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
946 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
947 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
948 #: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076
949 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
950 #: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096
951 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110
952 #: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118
953 #: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212
954 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222
955 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268
956 #: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351
957 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
958 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
959 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
960 #: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345
961 #: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
967 #: ../src/guestfs.pod:390
969 "The kernel version that the command runs under will be different from what "
975 #: ../src/guestfs.pod:395
977 "If the command needs to communicate with daemons, then most likely they "
983 #: ../src/guestfs.pod:400
984 msgid "The command will be running in limited memory."
989 #: ../src/guestfs.pod:404
991 "The network may not be available unless you enable it (see L</"
992 "guestfs_set_network>)."
997 #: ../src/guestfs.pod:409
998 msgid "Only supports Linux guests (not Windows, BSD, etc)."
1003 #: ../src/guestfs.pod:413
1005 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1010 #: ../src/guestfs.pod:418
1012 "For SELinux guests, you may need to enable SELinux and load policy first. "
1013 "See L</SELINUX> in this manpage."
1018 #: ../src/guestfs.pod:423
1020 "I<Security:> It is not safe to run commands from untrusted, possibly "
1021 "malicious guests. These commands may attempt to exploit your program by "
1022 "sending unexpected output. They could also try to exploit the Linux kernel "
1023 "or qemu provided by the libguestfs appliance. They could use the network "
1024 "provided by the libguestfs appliance to bypass ordinary network partitions "
1025 "and firewalls. They could use the elevated privileges or different SELinux "
1026 "context of your program to their advantage."
1031 #: ../src/guestfs.pod:432
1033 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1034 "(a script which runs when the guest next boots normally), and to have this "
1035 "script run the commands you want in the normal context of the running guest, "
1036 "network security and so on. For information about other security issues, "
1042 #: ../src/guestfs.pod:440
1044 "The two main API calls to run commands are L</guestfs_command> and L</"
1045 "guestfs_sh> (there are also variations)."
1050 #: ../src/guestfs.pod:443
1052 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1053 "shell globs, redirections, etc will work."
1058 #: ../src/guestfs.pod:446
1059 msgid "CONFIGURATION FILES"
1064 #: ../src/guestfs.pod:448
1066 "To read and write configuration files in Linux guest filesystems, we "
1067 "strongly recommend using Augeas. For example, Augeas understands how to "
1068 "read and write, say, a Linux shadow password file or X.org configuration "
1069 "file, and so avoids you having to write that code."
1074 #: ../src/guestfs.pod:453
1076 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1077 "document Augeas itself here because there is excellent documentation on the "
1078 "L<http://augeas.net/> website."
1083 #: ../src/guestfs.pod:457
1085 "If you don't want to use Augeas (you fool!) then try calling L</"
1086 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1092 #: ../src/guestfs.pod:461
1098 #: ../src/guestfs.pod:463
1100 "We support SELinux guests. To ensure that labeling happens correctly in "
1101 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1106 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1107 #: ../src/guestfs.pod:2441
1113 #: ../src/guestfs.pod:471
1114 msgid "Before launching, do:"
1119 #: ../src/guestfs.pod:473
1122 " guestfs_set_selinux (g, 1);\n"
1128 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1129 #: ../src/guestfs.pod:2466
1135 #: ../src/guestfs.pod:477
1137 "After mounting the guest's filesystem(s), load the policy. This is best "
1138 "done by running the L<load_policy(8)> command in the guest itself:"
1143 #: ../src/guestfs.pod:481
1146 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1152 #: ../src/guestfs.pod:483
1154 "(Older versions of C<load_policy> require you to specify the name of the "
1160 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1166 #: ../src/guestfs.pod:488
1168 "Optionally, set the security context for the API. The correct security "
1169 "context to use can only be known by inspecting the guest. As an example:"
1174 #: ../src/guestfs.pod:492
1177 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1183 #: ../src/guestfs.pod:496
1184 msgid "This will work for running commands and editing existing files."
1189 #: ../src/guestfs.pod:498
1191 "When new files are created, you may need to label them explicitly, for "
1192 "example by running the external command C<restorecon pathname>."
1197 #: ../src/guestfs.pod:502
1203 #: ../src/guestfs.pod:504
1205 "Certain calls are affected by the current file mode creation mask (the "
1206 "\"umask\"). In particular ones which create files or directories, such as "
1207 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1208 "either the default mode that the file is created with or modifies the mode "
1214 #: ../src/guestfs.pod:510
1216 "The default umask is C<022>, so files are created with modes such as C<0644> "
1217 "and directories with C<0755>."
1222 #: ../src/guestfs.pod:513
1224 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1225 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1226 "guestfs_chmod> after creating each file or directory."
1231 #: ../src/guestfs.pod:517
1232 msgid "For more information about umask, see L<umask(2)>."
1237 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1238 msgid "ENCRYPTED DISKS"
1243 #: ../src/guestfs.pod:521
1245 "Libguestfs allows you to access Linux guests which have been encrypted using "
1246 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1247 "standard. This includes nearly all whole disk encryption systems used by "
1248 "modern Linux guests."
1253 #: ../src/guestfs.pod:527
1255 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1256 "returns the string C<crypto_LUKS>)."
1261 #: ../src/guestfs.pod:530
1263 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1264 "will require the passphrase!"
1269 #: ../src/guestfs.pod:533
1271 "Opening a LUKS device creates a new device mapper device called C</dev/"
1272 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1273 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1274 "from and encrypted to the underlying block device respectively."
1279 #: ../src/guestfs.pod:539
1281 "LVM volume groups on the device can be made visible by calling L</"
1282 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1283 "(s) can now be mounted in the usual way."
1288 #: ../src/guestfs.pod:543
1290 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1291 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1292 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1293 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1294 "underlying encrypted block device)."
1299 #: ../src/guestfs.pod:550
1304 #: ../src/guestfs.pod:552
1306 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1307 "contains operating systems, an install CD or a live CD. (These APIs used to "
1308 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1309 "version 1.5.3 the most frequently used part of this library has been "
1310 "rewritten in C and moved into the core code)."
1315 #: ../src/guestfs.pod:559
1317 "Add all disks belonging to the unknown virtual machine and call L</"
1318 "guestfs_launch> in the usual way."
1323 #: ../src/guestfs.pod:562
1325 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1326 "and certain heuristics, and returns a list of operating systems that were "
1327 "found. An empty list means none were found. A single element is the root "
1328 "filesystem of the operating system. For dual- or multi-boot guests, "
1329 "multiple roots can be returned, each one corresponding to a separate "
1330 "operating system. (Multi-boot virtual machines are extremely rare in the "
1331 "world of virtualization, but since this scenario can happen, we have built "
1332 "libguestfs to deal with it.)"
1337 #: ../src/guestfs.pod:571
1339 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1340 "to get additional details about that operating system. For example, call L</"
1341 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1342 "Windows and Linux-based operating systems respectively."
1347 #: ../src/guestfs.pod:577
1349 "Un*x-like and Linux-based operating systems usually consist of several "
1350 "filesystems which are mounted at boot time (for example, a separate boot "
1351 "partition mounted on C</boot>). The inspection rules are able to detect how "
1352 "filesystems correspond to mount points. Call "
1353 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1354 "hash table like this example:"
1359 #: ../src/guestfs.pod:584
1362 " /boot => /dev/sda1\n"
1363 " / => /dev/vg_guest/lv_root\n"
1364 " /usr => /dev/vg_guest/lv_usr\n"
1370 #: ../src/guestfs.pod:588
1372 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1373 "filesystems as suggested."
1378 #: ../src/guestfs.pod:591
1380 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1381 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1386 #: ../src/guestfs.pod:595
1388 "Inspection currently only works for some common operating systems. "
1389 "Contributors are welcome to send patches for other operating systems that we "
1390 "currently cannot detect."
1395 #: ../src/guestfs.pod:599
1397 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1398 "for more details. The L</guestfs_inspect_os> function just ignores any "
1399 "encrypted devices."
1404 #: ../src/guestfs.pod:603
1406 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1407 "inspection and caches the results in the guest handle. Subsequent calls to "
1408 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1409 "read the disks. If you change the content of the guest disks, you can redo "
1410 "inspection by calling L</guestfs_inspect_os> again. (L</"
1411 "guestfs_inspect_list_applications> works a little differently from the other "
1412 "calls and does read the disks. See documentation for that function for "
1417 #: ../src/guestfs.pod:612
1418 msgid "INSPECTING INSTALL DISKS"
1422 #: ../src/guestfs.pod:614
1424 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1429 #: ../src/guestfs.pod:617
1431 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1432 "system, which currently can be C<installed> (a regular operating system) or "
1433 "C<installer> (some sort of install disk)."
1437 #: ../src/guestfs.pod:621
1439 "Further information is available about the operating system that can be "
1440 "installed using the regular inspection APIs like L</"
1441 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1445 #: ../src/guestfs.pod:626
1447 "Some additional information specific to installer disks is also available "
1448 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1449 "guestfs_inspect_is_multipart> calls."
1454 #: ../src/guestfs.pod:631
1455 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1460 #: ../src/guestfs.pod:633
1462 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1463 "ntfs-3g.org/> driver."
1468 #: ../src/guestfs.pod:636
1469 msgid "DRIVE LETTERS AND PATHS"
1474 #: ../src/guestfs.pod:638
1476 "DOS and Windows still use drive letters, and the filesystems are always "
1477 "treated as case insensitive by Windows itself, and therefore you might find "
1478 "a Windows configuration file referring to a path like C<c:\\windows"
1479 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1480 "might be referred to as C</WINDOWS/System32>."
1485 #: ../src/guestfs.pod:644
1487 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1488 "libguestfs to read the appropriate Windows Registry and configuration files, "
1489 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1495 #: ../src/guestfs.pod:649
1497 "Replacing backslash characters with forward slash characters is also outside "
1498 "the scope of libguestfs, but something that you can easily do."
1503 #: ../src/guestfs.pod:652
1505 "Where we can help is in resolving the case insensitivity of paths. For "
1506 "this, call L</guestfs_case_sensitive_path>."
1511 #: ../src/guestfs.pod:655
1512 msgid "ACCESSING THE WINDOWS REGISTRY"
1517 #: ../src/guestfs.pod:657
1519 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1520 "files, through the library C<hivex> which is part of the libguestfs project "
1521 "although ships as a separate tarball. You have to locate and download the "
1522 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1523 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1524 "reg(1)> for more help on this issue."
1529 #: ../src/guestfs.pod:665
1530 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1535 #: ../src/guestfs.pod:667
1537 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1538 "provide something which looks like a Linux symlink. The way it tries to do "
1539 "the rewriting is described here:"
1544 #: ../src/guestfs.pod:671
1546 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1552 #: ../src/guestfs.pod:673
1554 "The essential problem is that ntfs-3g simply does not have enough "
1555 "information to do a correct job. NTFS links can contain drive letters and "
1556 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1557 "It is almost certainly the case that libguestfs callers should ignore what "
1558 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1563 #: ../src/guestfs.pod:680
1565 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1566 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1567 "attribute, and read the raw reparse data from that (you can find the format "
1568 "documented in various places around the web)."
1573 #: ../src/guestfs.pod:685
1574 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1579 #: ../src/guestfs.pod:687
1581 "There are other useful extended attributes that can be read from ntfs-3g "
1582 "filesystems (using L</guestfs_getxattr>). See:"
1587 #: ../src/guestfs.pod:690
1589 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1594 #: ../src/guestfs.pod:692
1595 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1600 #: ../src/guestfs.pod:694
1602 "Although we don't want to discourage you from using the C API, we will "
1603 "mention here that the same API is also available in other languages."
1607 #: ../src/guestfs.pod:697
1609 "The API is broadly identical in all supported languages. This means that "
1610 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1611 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1612 "OCaml. In other words, a straightforward, predictable isomorphism between "
1618 #: ../src/guestfs.pod:703
1620 "Error messages are automatically transformed into exceptions if the language "
1626 #: ../src/guestfs.pod:706
1628 "We don't try to \"object orientify\" parts of the API in OO languages, "
1629 "although contributors are welcome to write higher level APIs above what we "
1630 "provide in their favourite languages if they wish."
1635 #: ../src/guestfs.pod:712
1641 #: ../src/guestfs.pod:714
1643 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1644 "identical to the C API. C++ classes and exceptions are not used."
1649 #: ../src/guestfs.pod:718
1655 #: ../src/guestfs.pod:720
1657 "The C# bindings are highly experimental. Please read the warnings at the "
1658 "top of C<csharp/Libguestfs.cs>."
1663 #: ../src/guestfs.pod:723
1669 #: ../src/guestfs.pod:725
1671 "This is the only language binding that is working but incomplete. Only "
1672 "calls which return simple integers have been bound in Haskell, and we are "
1673 "looking for help to complete this binding."
1678 #: ../src/guestfs.pod:729
1684 #: ../src/guestfs.pod:731
1686 "Full documentation is contained in the Javadoc which is distributed with "
1692 #: ../src/guestfs.pod:734
1697 #: ../src/guestfs.pod:736
1698 msgid "See L<guestfs-ocaml(3)>."
1703 #: ../src/guestfs.pod:738
1708 #: ../src/guestfs.pod:740
1709 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1714 #: ../src/guestfs.pod:742
1720 #: ../src/guestfs.pod:744
1722 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1723 "the php-libguestfs package for your distribution."
1728 #: ../src/guestfs.pod:747
1729 msgid "The PHP binding only works correctly on 64 bit machines."
1734 #: ../src/guestfs.pod:749
1739 #: ../src/guestfs.pod:751
1740 msgid "See L<guestfs-python(3)>."
1745 #: ../src/guestfs.pod:753
1750 #: ../src/guestfs.pod:755
1751 msgid "See L<guestfs-ruby(3)>."
1756 #: ../src/guestfs.pod:757
1757 msgid "B<shell scripts>"
1761 #: ../src/guestfs.pod:759
1762 msgid "See L<guestfish(1)>."
1767 #: ../src/guestfs.pod:763
1768 msgid "LIBGUESTFS GOTCHAS"
1773 #: ../src/guestfs.pod:765
1775 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1776 "system [...] that works in the way it is documented but is counterintuitive "
1777 "and almost invites mistakes.\""
1782 #: ../src/guestfs.pod:769
1784 "Since we developed libguestfs and the associated tools, there are several "
1785 "things we would have designed differently, but are now stuck with for "
1786 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1787 "release, you can expect these to change. Beware of them."
1792 #: ../src/guestfs.pod:777
1793 msgid "Autosync / forgetting to sync."
1798 #: ../src/guestfs.pod:779
1800 "When modifying a filesystem from C or another language, you B<must> unmount "
1801 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1802 "libguestfs handle. You can also call:"
1807 #: ../src/guestfs.pod:783
1810 " guestfs_set_autosync (g, 1);\n"
1816 #: ../src/guestfs.pod:785
1818 "to have the unmount/sync done automatically for you when the handle 'g' is "
1819 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1824 #: ../src/guestfs.pod:789
1826 "If you forget to do this, then it is entirely possible that your changes "
1827 "won't be written out, or will be partially written, or (very rarely) that "
1828 "you'll get disk corruption."
1833 #: ../src/guestfs.pod:793
1835 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1836 "guestfish scripts that forget to sync will work just fine, which can make "
1837 "this very puzzling if you are trying to debug a problem."
1842 #: ../src/guestfs.pod:797
1844 "Update: Autosync is enabled by default for all API users starting from "
1845 "libguestfs 1.5.24."
1850 #: ../src/guestfs.pod:800
1851 msgid "Mount option C<-o sync> should not be the default."
1856 #: ../src/guestfs.pod:802
1858 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1859 "However C<-o sync> does not add any reliability benefit, but does have a "
1860 "very large performance impact."
1865 #: ../src/guestfs.pod:806
1867 "The work around is to use L</guestfs_mount_options> and set the mount "
1868 "options that you actually want to use."
1873 #: ../src/guestfs.pod:809
1874 msgid "Read-only should be the default."
1879 #: ../src/guestfs.pod:811
1881 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1882 "specify I<--rw> if you want to make changes to the image."
1887 #: ../src/guestfs.pod:814
1888 msgid "This would reduce the potential to corrupt live VM images."
1893 #: ../src/guestfs.pod:816
1895 "Note that many filesystems change the disk when you just mount and unmount, "
1896 "even if you didn't perform any writes. You need to use L</"
1897 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1902 #: ../src/guestfs.pod:820
1903 msgid "guestfish command line is hard to use."
1908 #: ../src/guestfs.pod:822
1910 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1911 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1912 "exist, so it fails. In earlier versions of guestfish the error message was "
1913 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1914 "we should have used C<guestfish -c command> to run commands."
1919 #: ../src/guestfs.pod:829
1920 msgid "guestfish megabyte modifiers don't work right on all commands"
1925 #: ../src/guestfs.pod:831
1927 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1928 "other modifiers). What guestfish actually does is to multiply the number "
1929 "part by the modifier part and pass the result to the C API. However this "
1930 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1931 "expecting some other unit (eg. megabytes)."
1936 #: ../src/guestfs.pod:838
1937 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1942 #: ../src/guestfs.pod:840
1945 " lvcreate LV VG 100M\n"
1951 #: ../src/guestfs.pod:842
1953 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1954 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1955 "megabytes * megabytes) logical volume. The error message you get from this "
1956 "is also a little obscure."
1961 #: ../src/guestfs.pod:847
1963 "This could be fixed in the generator by specially marking parameters and "
1964 "return values which take bytes or other units."
1969 #: ../src/guestfs.pod:850
1970 msgid "Ambiguity between devices and paths"
1975 #: ../src/guestfs.pod:852
1977 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1978 "sdb2>) and a similar pathname. A file might just happen to be called "
1979 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1984 #: ../src/guestfs.pod:857
1986 "In the current API we usually resolve this ambiguity by having two separate "
1987 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1988 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1989 "detecting if the path supplied begins with C</dev/>."
1994 #: ../src/guestfs.pod:863
1996 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1997 "make paths/devices into structured names. One way to do this would be to "
1998 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1999 "aspect of grub. Another way would be to use a structured type, equivalent "
2000 "to this OCaml type:"
2005 #: ../src/guestfs.pod:869
2008 " type path = Path of string | Device of int | Partition of int * int\n"
2014 #: ../src/guestfs.pod:871
2015 msgid "which would allow you to pass arguments like:"
2020 #: ../src/guestfs.pod:873
2023 " Path \"/foo/bar\"\n"
2024 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2025 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2026 " Path \"/dev/sdb2\" (* not a device *)\n"
2032 #: ../src/guestfs.pod:878
2034 "As you can see there are still problems to resolve even with this "
2035 "representation. Also consider how it might work in guestfish."
2040 #: ../src/guestfs.pod:883
2041 msgid "PROTOCOL LIMITS"
2046 #: ../src/guestfs.pod:885
2048 "Internally libguestfs uses a message-based protocol to pass API calls and "
2049 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2050 "plenty more detail about this). The maximum message size used by the "
2051 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2052 "aware of this limit. The API calls which may be affected are individually "
2053 "documented, with a link back to this section of the documentation."
2058 #: ../src/guestfs.pod:893
2060 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2061 "a simple string. Because this string is at some point internally encoded as "
2062 "a message, the maximum size that it can return is slightly under 4 MB. If "
2063 "the requested file is larger than this then you will get an error."
2068 #: ../src/guestfs.pod:899
2070 "In order to transfer large files into and out of the guest filesystem, you "
2071 "need to use particular calls that support this. The sections L</UPLOADING> "
2072 "and L</DOWNLOADING> document how to do this."
2077 #: ../src/guestfs.pod:903
2079 "You might also consider mounting the disk image using our FUSE filesystem "
2080 "support (L<guestmount(1)>)."
2085 #: ../src/guestfs.pod:906
2086 msgid "KEYS AND PASSPHRASES"
2091 #: ../src/guestfs.pod:908
2093 "Certain libguestfs calls take a parameter that contains sensitive key "
2094 "material, passed in as a C string."
2099 #: ../src/guestfs.pod:911
2101 "In the future we would hope to change the libguestfs implementation so that "
2102 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2103 "swap. However this is I<not> done at the moment, because of the complexity "
2104 "of such an implementation."
2109 #: ../src/guestfs.pod:916
2111 "Therefore you should be aware that any key parameter you pass to libguestfs "
2112 "might end up being written out to the swap partition. If this is a concern, "
2113 "scrub the swap partition or don't use libguestfs on encrypted devices."
2118 #: ../src/guestfs.pod:921
2119 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2124 #: ../src/guestfs.pod:923
2126 "All high-level libguestfs actions are synchronous. If you want to use "
2127 "libguestfs asynchronously then you must create a thread."
2132 #: ../src/guestfs.pod:926
2134 "Only use the handle from a single thread. Either use the handle exclusively "
2135 "from one thread, or provide your own mutex so that two threads cannot issue "
2136 "calls on the same handle at the same time."
2141 #: ../src/guestfs.pod:930
2143 "See the graphical program guestfs-browser for one possible architecture for "
2144 "multithreaded programs using libvirt and libguestfs."
2149 #: ../src/guestfs.pod:933
2154 #: ../src/guestfs.pod:935
2156 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2162 #: ../src/guestfs.pod:938
2164 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2165 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2170 #: ../src/guestfs.pod:941
2172 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2173 "to change the directories that libguestfs will search in. The value is a "
2174 "colon-separated list of paths. The current directory is I<not> searched "
2175 "unless the path contains an empty element or C<.>. For example "
2176 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2177 "then C</usr/lib/guestfs>."
2182 #: ../src/guestfs.pod:948
2183 msgid "QEMU WRAPPERS"
2188 #: ../src/guestfs.pod:950
2190 "If you want to compile your own qemu, run qemu from a non-standard location, "
2191 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2197 #: ../src/guestfs.pod:954
2199 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2200 "last command in the shell script (so that qemu replaces the shell and "
2201 "becomes the direct child of the libguestfs-using program). If you don't do "
2202 "this, then the qemu process won't be cleaned up correctly."
2207 #: ../src/guestfs.pod:959
2209 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2215 #: ../src/guestfs.pod:962
2219 " qemudir=/home/rjones/d/qemu\n"
2220 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2226 #: ../src/guestfs.pod:966
2228 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2229 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2235 #: ../src/guestfs.pod:970
2238 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2244 #: ../src/guestfs.pod:972
2246 "Note that libguestfs also calls qemu with the -help and -version options in "
2247 "order to determine features."
2251 #: ../src/guestfs.pod:975
2252 msgid "ATTACHING TO RUNNING DAEMONS"
2256 #: ../src/guestfs.pod:977
2258 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2259 "babies. Use with caution."
2263 #: ../src/guestfs.pod:980
2265 "I<Note (2):> This section explains how to attach to a running daemon from a "
2266 "low level perspective. For most users, simply using virt tools such as "
2267 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2271 #: ../src/guestfs.pod:984
2272 msgid "Using guestfs_set_attach_method"
2276 #: ../src/guestfs.pod:986
2278 "By calling L</guestfs_set_attach_method> you can change how the library "
2279 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2280 "ARCHITECTURE> for some background)."
2284 #: ../src/guestfs.pod:990
2286 "The normal attach method is C<appliance>, where a small appliance is created "
2287 "containing the daemon, and then the library connects to this."
2291 #: ../src/guestfs.pod:993
2293 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2294 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2295 "daemon over the Unix domain socket."
2299 #: ../src/guestfs.pod:997
2301 "The normal use for this is to connect to a running virtual machine that "
2302 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2303 "files inside the live virtual machine."
2307 #: ../src/guestfs.pod:1001
2308 msgid "Using guestfs_add_domain with live flag"
2312 #: ../src/guestfs.pod:1003
2314 "L</guestfs_add_domain> provides some help for getting the correct attach "
2315 "method. If you pass the C<live> option to this function, then (if the "
2316 "virtual machine is running) it will examine the libvirt XML looking for a "
2317 "virtio-serial channel to connect to:"
2321 #: ../src/guestfs.pod:1009
2328 " <channel type='unix'>\n"
2329 " <source mode='bind' path='/path/to/socket'/>\n"
2330 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2339 #: ../src/guestfs.pod:1021
2341 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2342 "method to C<unix:/path/to/socket>."
2346 #: ../src/guestfs.pod:1024
2348 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2349 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2350 "to attach to and modify live virtual machines."
2354 #: ../src/guestfs.pod:1028
2356 "The virtual machine needs to have been set up beforehand so that it has the "
2357 "virtio-serial channel and so that guestfsd is running inside it."
2362 #: ../src/guestfs.pod:1032
2363 msgid "ABI GUARANTEE"
2368 #: ../src/guestfs.pod:1034
2370 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2371 "actions as outlined in this section. Although we will deprecate some "
2372 "actions, for example if they get replaced by newer calls, we will keep the "
2373 "old actions forever. This allows you the developer to program in confidence "
2374 "against the libguestfs API."
2379 #: ../src/guestfs.pod:1040
2380 msgid "BLOCK DEVICE NAMING"
2385 #: ../src/guestfs.pod:1042
2387 "In the kernel there is now quite a profusion of schemata for naming block "
2388 "devices (in this context, by I<block device> I mean a physical or virtual "
2389 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2390 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2391 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2392 "for the old IDE driver (particularly for SATA devices) those devices also "
2393 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2394 "paravirtualized drivers. This has created several different naming systems, "
2395 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2400 #: ../src/guestfs.pod:1054
2402 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2403 "Linux kernel to access block devices. We can run a variety of appliances "
2404 "based on a variety of Linux kernels."
2409 #: ../src/guestfs.pod:1058
2411 "This causes a problem for libguestfs because many API calls use device or "
2412 "partition names. Working scripts and the recipe (example) scripts that we "
2413 "make available over the internet could fail if the naming scheme changes."
2418 #: ../src/guestfs.pod:1063
2420 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2421 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2422 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2423 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2428 #: ../src/guestfs.pod:1069
2430 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2431 "L</guestfs_list_partitions> and similar calls return the true names of the "
2432 "devices and partitions as known to the appliance."
2437 #: ../src/guestfs.pod:1074
2438 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2443 #: ../src/guestfs.pod:1076
2445 "Usually this translation is transparent. However in some (very rare) cases "
2446 "you may need to know the exact algorithm. Such cases include where you use "
2447 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2448 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2453 #: ../src/guestfs.pod:1082
2455 "The algorithm is applied only to I<parameters> which are known to be either "
2456 "device or partition names. Return values from functions such as L</"
2457 "guestfs_list_devices> are never changed."
2462 #: ../src/guestfs.pod:1090
2463 msgid "Is the string a parameter which is a device or partition name?"
2468 #: ../src/guestfs.pod:1094
2469 msgid "Does the string begin with C</dev/sd>?"
2474 #: ../src/guestfs.pod:1098
2476 "Does the named device exist? If so, we use that device. However if I<not> "
2477 "then we continue with this algorithm."
2482 #: ../src/guestfs.pod:1103
2483 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2488 #: ../src/guestfs.pod:1105
2489 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2494 #: ../src/guestfs.pod:1107
2495 msgid "If that named device exists, use it. If not, continue."
2500 #: ../src/guestfs.pod:1111
2501 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2506 #: ../src/guestfs.pod:1113
2507 msgid "If that named device exists, use it. If not, return an error."
2512 #: ../src/guestfs.pod:1117
2513 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2518 #: ../src/guestfs.pod:1119
2520 "Although the standard naming scheme and automatic translation is useful for "
2521 "simple programs and guestfish scripts, for larger programs it is best not to "
2522 "rely on this mechanism."
2527 #: ../src/guestfs.pod:1123
2529 "Where possible for maximum future portability programs using libguestfs "
2530 "should use these future-proof techniques:"
2535 #: ../src/guestfs.pod:1130
2537 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2538 "device names, and then use those names directly."
2543 #: ../src/guestfs.pod:1133
2545 "Since those device names exist by definition, they will never be translated."
2550 #: ../src/guestfs.pod:1138
2552 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2553 "filesystem labels."
2558 #: ../src/guestfs.pod:1143
2564 #: ../src/guestfs.pod:1145
2566 "This section discusses security implications of using libguestfs, "
2567 "particularly with untrusted or malicious guests or disk images."
2572 #: ../src/guestfs.pod:1148
2573 msgid "GENERAL SECURITY CONSIDERATIONS"
2578 #: ../src/guestfs.pod:1150
2580 "Be careful with any files or data that you download from a guest (by "
2581 "\"download\" we mean not just the L</guestfs_download> command but any "
2582 "command that reads files, filenames, directories or anything else from a "
2583 "disk image). An attacker could manipulate the data to fool your program "
2584 "into doing the wrong thing. Consider cases such as:"
2589 #: ../src/guestfs.pod:1160
2590 msgid "the data (file etc) not being present"
2595 #: ../src/guestfs.pod:1164
2596 msgid "being present but empty"
2601 #: ../src/guestfs.pod:1168
2602 msgid "being much larger than normal"
2607 #: ../src/guestfs.pod:1172
2608 msgid "containing arbitrary 8 bit data"
2613 #: ../src/guestfs.pod:1176
2614 msgid "being in an unexpected character encoding"
2619 #: ../src/guestfs.pod:1180
2620 msgid "containing homoglyphs."
2625 #: ../src/guestfs.pod:1184
2626 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2631 #: ../src/guestfs.pod:1186
2633 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2634 "(VFS) module can sometimes be escalated into exploits by deliberately "
2635 "creating a malicious, malformed filesystem. These exploits are very severe "
2636 "for two reasons. Firstly there are very many filesystem drivers in the "
2637 "kernel, and many of them are infrequently used and not much developer "
2638 "attention has been paid to the code. Linux userspace helps potential "
2639 "crackers by detecting the filesystem type and automatically choosing the "
2640 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2641 "the administrator. Secondly, a kernel-level exploit is like a local root "
2642 "exploit (worse in some ways), giving immediate and total access to the "
2643 "system right down to the hardware level."
2648 #: ../src/guestfs.pod:1199
2650 "That explains why you should never mount a filesystem from an untrusted "
2651 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2652 "inside a qemu virtual machine, usually running as a non-root user. The "
2653 "attacker would need to write a filesystem which first exploited the kernel, "
2654 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2655 "the libguestfs protocol, and finally to be as serious as the host kernel "
2656 "exploit it would need to escalate its privileges to root. This multi-step "
2657 "escalation, performed by a static piece of data, is thought to be extremely "
2658 "hard to do, although we never say 'never' about security issues."
2663 #: ../src/guestfs.pod:1210
2665 "In any case callers can reduce the attack surface by forcing the filesystem "
2666 "type when mounting (use L</guestfs_mount_vfs>)."
2671 #: ../src/guestfs.pod:1213
2672 msgid "PROTOCOL SECURITY"
2677 #: ../src/guestfs.pod:1215
2679 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2680 "defined upper message size. However a program that uses libguestfs must "
2681 "also take care - for example you can write a program that downloads a binary "
2682 "from a disk image and executes it locally, and no amount of protocol "
2683 "security will save you from the consequences."
2688 #: ../src/guestfs.pod:1221
2689 msgid "INSPECTION SECURITY"
2694 #: ../src/guestfs.pod:1223
2696 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2697 "directly from the guest, and these could contain any 8 bit data. Callers "
2698 "should be careful to escape these before printing them to a structured file "
2699 "(for example, use HTML escaping if creating a web page)."
2704 #: ../src/guestfs.pod:1229
2706 "Guest configuration may be altered in unusual ways by the administrator of "
2707 "the virtual machine, and may not reflect reality (particularly for untrusted "
2708 "or actively malicious guests). For example we parse the hostname from "
2709 "configuration files like C</etc/sysconfig/network> that we find in the "
2710 "guest, but the guest administrator can easily manipulate these files to "
2711 "provide the wrong hostname."
2716 #: ../src/guestfs.pod:1237
2718 "The inspection API parses guest configuration using two external libraries: "
2719 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2720 "designed to be robust in the face of malicious data, although denial of "
2721 "service attacks are still possible, for example with oversized configuration "
2727 #: ../src/guestfs.pod:1243
2728 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2733 #: ../src/guestfs.pod:1245
2735 "Be very cautious about running commands from the guest. By running a "
2736 "command in the guest, you are giving CPU time to a binary that you do not "
2737 "control, under the same user account as the library, albeit wrapped in qemu "
2738 "virtualization. More information and alternatives can be found in the "
2739 "section L</RUNNING COMMANDS>."
2744 #: ../src/guestfs.pod:1251
2745 msgid "CVE-2010-3851"
2750 #: ../src/guestfs.pod:1253
2751 msgid "https://bugzilla.redhat.com/642934"
2756 #: ../src/guestfs.pod:1255
2758 "This security bug concerns the automatic disk format detection that qemu "
2759 "does on disk images."
2764 #: ../src/guestfs.pod:1258
2766 "A raw disk image is just the raw bytes, there is no header. Other disk "
2767 "images like qcow2 contain a special header. Qemu deals with this by looking "
2768 "for one of the known headers, and if none is found then assuming the disk "
2769 "image must be raw."
2774 #: ../src/guestfs.pod:1263
2776 "This allows a guest which has been given a raw disk image to write some "
2777 "other header. At next boot (or when the disk image is accessed by "
2778 "libguestfs) qemu would do autodetection and think the disk image format was, "
2779 "say, qcow2 based on the header written by the guest."
2784 #: ../src/guestfs.pod:1268
2786 "This in itself would not be a problem, but qcow2 offers many features, one "
2787 "of which is to allow a disk image to refer to another image (called the "
2788 "\"backing disk\"). It does this by placing the path to the backing disk "
2789 "into the qcow2 header. This path is not validated and could point to any "
2790 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2791 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2792 "control of the attacker."
2797 #: ../src/guestfs.pod:1276
2799 "In libguestfs this is rather hard to exploit except under two circumstances:"
2804 #: ../src/guestfs.pod:1283
2805 msgid "You have enabled the network or have opened the disk in write mode."
2810 #: ../src/guestfs.pod:1287
2812 "You are also running untrusted code from the guest (see L</RUNNING "
2818 #: ../src/guestfs.pod:1292
2820 "The way to avoid this is to specify the expected disk format when adding "
2821 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2822 "should always do this if the disk is raw format, and it's a good idea for "
2828 #: ../src/guestfs.pod:1297
2830 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2831 "format is fetched from libvirt and passed through."
2836 #: ../src/guestfs.pod:1300
2838 "For libguestfs tools, use the I<--format> command line parameter as "
2844 #: ../src/guestfs.pod:1303
2845 msgid "CONNECTION MANAGEMENT"
2850 #: ../src/guestfs.pod:1305
2856 #: ../src/guestfs.pod:1307
2858 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2859 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2860 "handle and release all resources used."
2865 #: ../src/guestfs.pod:1311
2867 "For information on using multiple handles and threads, see the section L</"
2868 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2873 #: ../src/guestfs.pod:1314
2874 msgid "guestfs_create"
2879 #: ../src/guestfs.pod:1316
2882 " guestfs_h *guestfs_create (void);\n"
2888 #: ../src/guestfs.pod:1318
2889 msgid "Create a connection handle."
2894 #: ../src/guestfs.pod:1320
2896 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2897 "on the handle at least once."
2902 #: ../src/guestfs.pod:1323
2904 "This function returns a non-NULL pointer to a handle on success or NULL on "
2910 #: ../src/guestfs.pod:1326
2911 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2916 #: ../src/guestfs.pod:1328
2918 "You may also want to configure error handling for the handle. See L</ERROR "
2919 "HANDLING> section below."
2924 #: ../src/guestfs.pod:1331
2925 msgid "guestfs_close"
2930 #: ../src/guestfs.pod:1333
2933 " void guestfs_close (guestfs_h *g);\n"
2939 #: ../src/guestfs.pod:1335
2940 msgid "This closes the connection handle and frees up all resources used."
2945 #: ../src/guestfs.pod:1337
2946 msgid "ERROR HANDLING"
2951 #: ../src/guestfs.pod:1339
2953 "API functions can return errors. For example, almost all functions that "
2954 "return C<int> will return C<-1> to indicate an error."
2959 #: ../src/guestfs.pod:1342
2961 "Additional information is available for errors: an error message string and "
2962 "optionally an error number (errno) if the thing that failed was a system "
2968 #: ../src/guestfs.pod:1346
2970 "You can get at the additional information about the last error on the handle "
2971 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2972 "up an error handler with L</guestfs_set_error_handler>."
2977 #: ../src/guestfs.pod:1351
2979 "When the handle is created, a default error handler is installed which "
2980 "prints the error message string to C<stderr>. For small short-running "
2981 "command line programs it is sufficient to do:"
2986 #: ../src/guestfs.pod:1355
2989 " if (guestfs_launch (g) == -1)\n"
2990 " exit (EXIT_FAILURE);\n"
2996 #: ../src/guestfs.pod:1358
2998 "since the default error handler will ensure that an error message has been "
2999 "printed to C<stderr> before the program exits."
3004 #: ../src/guestfs.pod:1361
3006 "For other programs the caller will almost certainly want to install an "
3007 "alternate error handler or do error handling in-line like this:"
3012 #: ../src/guestfs.pod:1364
3015 " g = guestfs_create ();\n"
3021 #: ../src/guestfs.pod:1366
3024 " /* This disables the default behaviour of printing errors\n"
3026 " guestfs_set_error_handler (g, NULL, NULL);\n"
3032 #: ../src/guestfs.pod:1370
3035 " if (guestfs_launch (g) == -1) {\n"
3036 " /* Examine the error message and print it etc. */\n"
3037 " char *msg = guestfs_last_error (g);\n"
3038 " int errnum = guestfs_last_errno (g);\n"
3039 " fprintf (stderr, \"%s\\n\", msg);\n"
3047 #: ../src/guestfs.pod:1378
3049 "Out of memory errors are handled differently. The default action is to call "
3050 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3051 "guestfs_set_out_of_memory_handler>."
3056 #: ../src/guestfs.pod:1382
3058 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3059 "because there is no handle if this happens there is no way to get additional "
3060 "error information. However L</guestfs_create> is supposed to be a "
3061 "lightweight operation which can only fail because of insufficient memory (it "
3062 "returns NULL in this case)."
3067 #: ../src/guestfs.pod:1388
3068 msgid "guestfs_last_error"
3073 #: ../src/guestfs.pod:1390
3076 " const char *guestfs_last_error (guestfs_h *g);\n"
3082 #: ../src/guestfs.pod:1392
3084 "This returns the last error message that happened on C<g>. If there has not "
3085 "been an error since the handle was created, then this returns C<NULL>."
3090 #: ../src/guestfs.pod:1396
3092 "The lifetime of the returned string is until the next error occurs, or L</"
3093 "guestfs_close> is called."
3098 #: ../src/guestfs.pod:1399
3099 msgid "guestfs_last_errno"
3104 #: ../src/guestfs.pod:1401
3107 " int guestfs_last_errno (guestfs_h *g);\n"
3113 #: ../src/guestfs.pod:1403
3114 msgid "This returns the last error number (errno) that happened on C<g>."
3119 #: ../src/guestfs.pod:1405
3120 msgid "If successful, an errno integer not equal to zero is returned."
3125 #: ../src/guestfs.pod:1407
3127 "If no error, this returns 0. This call can return 0 in three situations:"
3132 #: ../src/guestfs.pod:1414
3133 msgid "There has not been any error on the handle."
3138 #: ../src/guestfs.pod:1418
3140 "There has been an error but the errno was meaningless. This corresponds to "
3141 "the case where the error did not come from a failed system call, but for "
3142 "some other reason."
3147 #: ../src/guestfs.pod:1424
3149 "There was an error from a failed system call, but for some reason the errno "
3150 "was not captured and returned. This usually indicates a bug in libguestfs."
3155 #: ../src/guestfs.pod:1430
3157 "Libguestfs tries to convert the errno from inside the applicance into a "
3158 "corresponding errno for the caller (not entirely trivial: the appliance "
3159 "might be running a completely different operating system from the library "
3160 "and error numbers are not standardized across Un*xen). If this could not be "
3161 "done, then the error is translated to C<EINVAL>. In practice this should "
3162 "only happen in very rare circumstances."
3167 #: ../src/guestfs.pod:1438
3168 msgid "guestfs_set_error_handler"
3173 #: ../src/guestfs.pod:1440
3176 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3178 " const char *msg);\n"
3179 " void guestfs_set_error_handler (guestfs_h *g,\n"
3180 " guestfs_error_handler_cb cb,\n"
3187 #: ../src/guestfs.pod:1447
3189 "The callback C<cb> will be called if there is an error. The parameters "
3190 "passed to the callback are an opaque data pointer and the error message "
3196 #: ../src/guestfs.pod:1451
3198 "C<errno> is not passed to the callback. To get that the callback must call "
3199 "L</guestfs_last_errno>."
3204 #: ../src/guestfs.pod:1454
3206 "Note that the message string C<msg> is freed as soon as the callback "
3207 "function returns, so if you want to stash it somewhere you must make your "
3213 #: ../src/guestfs.pod:1458
3214 msgid "The default handler prints messages on C<stderr>."
3219 #: ../src/guestfs.pod:1460
3220 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3225 #: ../src/guestfs.pod:1462
3226 msgid "guestfs_get_error_handler"
3231 #: ../src/guestfs.pod:1464
3234 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3235 " void **opaque_rtn);\n"
3241 #: ../src/guestfs.pod:1467
3242 msgid "Returns the current error handler callback."
3247 #: ../src/guestfs.pod:1469
3248 msgid "guestfs_set_out_of_memory_handler"
3253 #: ../src/guestfs.pod:1471
3256 " typedef void (*guestfs_abort_cb) (void);\n"
3257 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3258 " guestfs_abort_cb);\n"
3264 #: ../src/guestfs.pod:1475
3266 "The callback C<cb> will be called if there is an out of memory situation. "
3267 "I<Note this callback must not return>."
3272 #: ../src/guestfs.pod:1478
3273 msgid "The default is to call L<abort(3)>."
3278 #: ../src/guestfs.pod:1480
3280 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3285 #: ../src/guestfs.pod:1483
3286 msgid "guestfs_get_out_of_memory_handler"
3291 #: ../src/guestfs.pod:1485
3294 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3300 #: ../src/guestfs.pod:1487
3301 msgid "This returns the current out of memory handler."
3306 #: ../src/guestfs.pod:1489
3312 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
3318 #: ../src/guestfs.pod:1493
3324 #: ../src/guestfs.pod:1495
3330 #: ../src/guestfs.pod:1497
3331 msgid "AVAILABILITY"
3336 #: ../src/guestfs.pod:1499
3337 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3342 #: ../src/guestfs.pod:1501
3344 "Using L</guestfs_available> you can test availability of the following "
3345 "groups of functions. This test queries the appliance to see if the "
3346 "appliance you are currently using supports the functionality."
3351 #: ../src/guestfs.pod:1506
3352 msgid "@AVAILABILITY@"
3357 #: ../src/guestfs.pod:1508
3358 msgid "GUESTFISH supported COMMAND"
3363 #: ../src/guestfs.pod:1510
3365 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3366 "prints out the available groups and whether they are supported by this build "
3367 "of libguestfs. Note however that you have to do C<run> first."
3372 #: ../src/guestfs.pod:1515
3373 msgid "SINGLE CALLS AT COMPILE TIME"
3378 #: ../src/guestfs.pod:1517
3380 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3381 "function, such as:"
3386 #: ../src/guestfs.pod:1520
3389 " #define LIBGUESTFS_HAVE_DD 1\n"
3395 #: ../src/guestfs.pod:1522
3396 msgid "if L</guestfs_dd> is available."
3401 #: ../src/guestfs.pod:1524
3403 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3404 "function is available at compile time, we recommended using build tools such "
3405 "as autoconf or cmake. For example in autotools you could use:"
3410 #: ../src/guestfs.pod:1529
3413 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3414 " AC_CHECK_FUNCS([guestfs_dd])\n"
3420 #: ../src/guestfs.pod:1532
3422 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3428 #: ../src/guestfs.pod:1535
3429 msgid "SINGLE CALLS AT RUN TIME"
3434 #: ../src/guestfs.pod:1537
3436 "Testing at compile time doesn't guarantee that a function really exists in "
3437 "the library. The reason is that you might be dynamically linked against a "
3438 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3439 "This situation unfortunately results in a segmentation fault, which is a "
3440 "shortcoming of the C dynamic linking system itself."
3445 #: ../src/guestfs.pod:1544
3447 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3448 "in this example program (note that you still need the compile time check as "
3454 #: ../src/guestfs.pod:1548
3457 " #include <stdio.h>\n"
3458 " #include <stdlib.h>\n"
3459 " #include <unistd.h>\n"
3460 " #include <dlfcn.h>\n"
3461 " #include <guestfs.h>\n"
3467 #: ../src/guestfs.pod:1554
3472 " #ifdef LIBGUESTFS_HAVE_DD\n"
3474 " int has_function;\n"
3480 #: ../src/guestfs.pod:1560
3483 " /* Test if the function guestfs_dd is really available. */\n"
3484 " dl = dlopen (NULL, RTLD_LAZY);\n"
3486 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3487 " exit (EXIT_FAILURE);\n"
3489 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3496 #: ../src/guestfs.pod:1569
3499 " if (!has_function)\n"
3500 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3502 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3503 " /* Now it's safe to call\n"
3504 " guestfs_dd (g, \"foo\", \"bar\");\n"
3508 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3516 #: ../src/guestfs.pod:1582
3518 "You may think the above is an awful lot of hassle, and it is. There are "
3519 "other ways outside of the C linking system to ensure that this kind of "
3520 "incompatibility never arises, such as using package versioning:"
3525 #: ../src/guestfs.pod:1587
3528 " Requires: libguestfs >= 1.0.80\n"
3534 #: ../src/guestfs.pod:1589
3535 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3540 #: ../src/guestfs.pod:1591
3542 "A recent feature of the API is the introduction of calls which take optional "
3543 "arguments. In C these are declared 3 ways. The main way is as a call which "
3544 "takes variable arguments (ie. C<...>), as in this example:"
3549 #: ../src/guestfs.pod:1596
3552 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3558 #: ../src/guestfs.pod:1598
3560 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3561 "call with no optional arguments specified:"
3566 #: ../src/guestfs.pod:1601
3569 " guestfs_add_drive_opts (g, filename, -1);\n"
3575 #: ../src/guestfs.pod:1603
3576 msgid "With a single optional argument:"
3581 #: ../src/guestfs.pod:1605
3584 " guestfs_add_drive_opts (g, filename,\n"
3585 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3592 #: ../src/guestfs.pod:1609
3598 #: ../src/guestfs.pod:1611
3601 " guestfs_add_drive_opts (g, filename,\n"
3602 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3603 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3610 #: ../src/guestfs.pod:1616
3612 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3618 #: ../src/guestfs.pod:1619
3619 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3624 #: ../src/guestfs.pod:1621
3626 "The second variant has the same name with the suffix C<_va>, which works the "
3627 "same way but takes a C<va_list>. See the C manual for details. For the "
3628 "example function, this is declared:"
3633 #: ../src/guestfs.pod:1625
3636 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3643 #: ../src/guestfs.pod:1628
3644 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3649 #: ../src/guestfs.pod:1630
3651 "The third variant is useful where you need to construct these calls. You "
3652 "pass in a structure where you fill in the optional fields. The structure "
3653 "has a bitmask as the first element which you must set to indicate which "
3654 "fields you have filled in. For our example function the structure and call "
3660 #: ../src/guestfs.pod:1636
3663 " struct guestfs_add_drive_opts_argv {\n"
3664 " uint64_t bitmask;\n"
3666 " const char *format;\n"
3669 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3670 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3676 #: ../src/guestfs.pod:1645
3677 msgid "You could call it like this:"
3682 #: ../src/guestfs.pod:1647
3685 " struct guestfs_add_drive_opts_argv optargs = {\n"
3686 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3687 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3689 " .format = \"qcow2\"\n"
3696 #: ../src/guestfs.pod:1654
3699 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3705 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3706 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3707 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3713 #: ../src/guestfs.pod:1662
3714 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3719 #: ../src/guestfs.pod:1667
3720 msgid "You do not need to fill in all fields of the structure."
3725 #: ../src/guestfs.pod:1671
3727 "There must be a one-to-one correspondence between fields of the structure "
3728 "that are filled in, and bits set in the bitmask."
3733 #: ../src/guestfs.pod:1676
3734 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3739 #: ../src/guestfs.pod:1678
3741 "In other languages, optional arguments are expressed in the way that is "
3742 "natural for that language. We refer you to the language-specific "
3743 "documentation for more details on that."
3748 #: ../src/guestfs.pod:1682
3749 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3754 #: ../src/guestfs.pod:1684
3755 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3759 #: ../src/guestfs.pod:1686
3761 "B<Note:> This section documents the generic event mechanism introduced in "
3762 "libguestfs 1.10, which you should use in new code if possible. The old "
3763 "functions C<guestfs_set_log_message_callback>, "
3764 "C<guestfs_set_subprocess_quit_callback>, "
3765 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3766 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3771 #: ../src/guestfs.pod:1694
3773 "Handles generate events when certain things happen, such as log messages "
3774 "being generated, progress messages during long-running operations, or the "
3775 "handle being closed. The API calls described below let you register a "
3776 "callback to be called when events happen. You can register multiple "
3777 "callbacks (for the same, different or overlapping sets of events), and "
3778 "individually remove callbacks. If callbacks are not removed, then they "
3779 "remain in force until the handle is closed."
3783 #: ../src/guestfs.pod:1702
3785 "In the current implementation, events are only generated synchronously: that "
3786 "means that events (and hence callbacks) can only happen while you are in the "
3787 "middle of making another libguestfs call. The callback is called in the "
3792 #: ../src/guestfs.pod:1707
3794 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3795 "unsigned integers, or a message buffer. Payloads are discussed later on."
3799 #: ../src/guestfs.pod:1711
3800 msgid "CLASSES OF EVENTS"
3804 #: ../src/guestfs.pod:1715
3805 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3809 #: ../src/guestfs.pod:1718
3811 "The callback function will be called while the handle is being closed "
3812 "(synchronously from L</guestfs_close>)."
3817 #: ../src/guestfs.pod:1721
3819 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3820 "handles that are open when the program exits. This means that this callback "
3821 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3822 "problems in higher-level languages (eg. if your HLL interpreter has already "
3823 "been cleaned up by the time this is called, and if your callback then jumps "
3824 "into some HLL function)."
3828 #: ../src/guestfs.pod:1728
3830 "If no callback is registered: the handle is closed without any callback "
3835 #: ../src/guestfs.pod:1731
3836 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3840 #: ../src/guestfs.pod:1734
3842 "The callback function will be called when the child process quits, either "
3843 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3844 "corresponds to a transition from any state to the CONFIG state)."
3848 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3849 msgid "If no callback is registered: the event is ignored."
3853 #: ../src/guestfs.pod:1740
3854 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3858 #: ../src/guestfs.pod:1743
3860 "The callback function will be called when the child process becomes ready "
3861 "first time after it has been launched. (This corresponds to a transition "
3862 "from LAUNCHING to the READY state)."
3866 #: ../src/guestfs.pod:1749
3867 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3872 #: ../src/guestfs.pod:1752
3874 "Some long-running operations can generate progress messages. If this "
3875 "callback is registered, then it will be called each time a progress message "
3876 "is generated (usually two seconds after the operation started, and three "
3877 "times per second thereafter until it completes, although the frequency may "
3878 "change in future versions)."
3882 #: ../src/guestfs.pod:1758
3884 "The callback receives in the payload four unsigned 64 bit numbers which are "
3885 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3889 #: ../src/guestfs.pod:1761
3891 "The units of C<total> are not defined, although for some operations C<total> "
3892 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3893 "or megabytes), and C<position> may be the portion which has been transferred."
3898 #: ../src/guestfs.pod:1766
3899 msgid "The only defined and stable parts of the API are:"
3904 #: ../src/guestfs.pod:1772
3906 "The callback can display to the user some type of progress bar or indicator "
3907 "which shows the ratio of C<position>:C<total>."
3912 #: ../src/guestfs.pod:1777
3913 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3917 #: ../src/guestfs.pod:1781
3919 "If any progress notification is sent during a call, then a final progress "
3920 "notification is always sent when C<position> = C<total> (I<unless> the call "
3921 "fails with an error)."
3926 #: ../src/guestfs.pod:1785
3928 "This is to simplify caller code, so callers can easily set the progress "
3929 "indicator to \"100%\" at the end of the operation, without requiring special "
3930 "code to detect this case."
3934 #: ../src/guestfs.pod:1791
3936 "For some calls we are unable to estimate the progress of the call, but we "
3937 "can still generate progress messages to indicate activity. This is known as "
3938 "\"pulse mode\", and is directly supported by certain progress bar "
3939 "implementations (eg. GtkProgressBar)."
3943 #: ../src/guestfs.pod:1796
3945 "For these calls, zero or more progress messages are generated with "
3946 "C<position = 0> and C<total = 1>, followed by a final message with "
3947 "C<position = total = 1>."
3951 #: ../src/guestfs.pod:1800
3953 "As noted above, if the call fails with an error then the final message may "
3958 #: ../src/guestfs.pod:1805
3960 "The callback also receives the procedure number (C<proc_nr>) and serial "
3961 "number (C<serial>) of the call. These are only useful for debugging "
3962 "protocol issues, and the callback can normally ignore them. The callback "
3963 "may want to print these numbers in error messages or debugging messages."
3967 #: ../src/guestfs.pod:1811
3968 msgid "If no callback is registered: progress messages are discarded."
3972 #: ../src/guestfs.pod:1813
3973 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3977 #: ../src/guestfs.pod:1816
3979 "The callback function is called whenever a log message is generated by qemu, "
3980 "the appliance kernel, guestfsd (daemon), or utility programs."
3984 #: ../src/guestfs.pod:1819
3986 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3987 "guestfs_launch>) then additional debug messages are generated."
3991 #: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
3993 "If no callback is registered: the messages are discarded unless the verbose "
3994 "flag is set in which case they are sent to stderr. You can override the "
3995 "printing of verbose messages to stderr by setting up a callback."
3999 #: ../src/guestfs.pod:1827
4000 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
4004 #: ../src/guestfs.pod:1830
4006 "The callback function is called whenever a log message is generated by the "
4007 "library part of libguestfs."
4011 #: ../src/guestfs.pod:1833
4013 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
4014 "messages are generated."
4018 #: ../src/guestfs.pod:1841
4019 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
4023 #: ../src/guestfs.pod:1844
4025 "The callback function is called whenever a trace message is generated. This "
4026 "only applies if the trace flag (L</guestfs_set_trace>) is set."
4030 #: ../src/guestfs.pod:1847
4032 "If no callback is registered: the messages are sent to stderr. You can "
4033 "override the printing of trace messages to stderr by setting up a callback."
4037 #: ../src/guestfs.pod:1853
4038 msgid "guestfs_set_event_callback"
4042 #: ../src/guestfs.pod:1855
4045 " int guestfs_set_event_callback (guestfs_h *g,\n"
4046 " guestfs_event_callback cb,\n"
4047 " uint64_t event_bitmask,\n"
4054 #: ../src/guestfs.pod:1861
4056 "This function registers a callback (C<cb>) for all event classes in the "
4061 #: ../src/guestfs.pod:1864
4063 "For example, to register for all log message events, you could call this "
4064 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4065 "To register a single callback for all possible classes of events, use "
4066 "C<GUESTFS_EVENT_ALL>."
4070 #: ../src/guestfs.pod:1870
4071 msgid "C<flags> should always be passed as 0."
4075 #: ../src/guestfs.pod:1872
4077 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4078 "it for any purpose."
4082 #: ../src/guestfs.pod:1875
4084 "The return value is the event handle (an integer) which you can use to "
4085 "delete the callback (see below)."
4089 #: ../src/guestfs.pod:1878
4091 "If there is an error, this function returns C<-1>, and sets the error in the "
4092 "handle in the usual way (see L</guestfs_last_error> etc.)"
4096 #: ../src/guestfs.pod:1881
4098 "Callbacks remain in effect until they are deleted, or until the handle is "
4103 #: ../src/guestfs.pod:1884
4105 "In the case where multiple callbacks are registered for a particular event "
4106 "class, all of the callbacks are called. The order in which multiple "
4107 "callbacks are called is not defined."
4111 #: ../src/guestfs.pod:1888
4112 msgid "guestfs_delete_event_callback"
4116 #: ../src/guestfs.pod:1890
4119 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4124 #: ../src/guestfs.pod:1892
4126 "Delete a callback that was previously registered. C<event_handle> should be "
4127 "the integer that was returned by a previous call to "
4128 "C<guestfs_set_event_callback> on the same handle."
4132 #: ../src/guestfs.pod:1896
4133 msgid "guestfs_event_callback"
4137 #: ../src/guestfs.pod:1898
4140 " typedef void (*guestfs_event_callback) (\n"
4143 " uint64_t event,\n"
4144 " int event_handle,\n"
4146 " const char *buf, size_t buf_len,\n"
4147 " const uint64_t *array, size_t array_len);\n"
4152 #: ../src/guestfs.pod:1907
4154 "This is the type of the event callback function that you have to provide."
4158 #: ../src/guestfs.pod:1910
4160 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4161 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4162 "handle, and C<flags> which in the current API you should ignore."
4166 #: ../src/guestfs.pod:1914
4168 "The remaining parameters contain the event payload (if any). Each event may "
4169 "contain a payload, which usually relates to the event class, but for future "
4170 "proofing your code should be written to handle any payload for any event "
4175 #: ../src/guestfs.pod:1919
4177 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4178 "there is no message buffer). Note that this message buffer can contain "
4179 "arbitrary 8 bit data, including NUL bytes."
4183 #: ../src/guestfs.pod:1923
4185 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4186 "moment this is only used for progress messages."
4190 #: ../src/guestfs.pod:1926
4191 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4195 #: ../src/guestfs.pod:1928
4197 "One motivation for the generic event API was to allow GUI programs to "
4198 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4199 "unconditionally to C<stderr>."
4203 #: ../src/guestfs.pod:1932
4205 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4206 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4207 "messages are not events; you must capture error messages separately)."
4211 #: ../src/guestfs.pod:1937
4213 "Programs have to set up a callback to capture the classes of events of "
4218 #: ../src/guestfs.pod:1940
4222 " guestfs_set_event_callback\n"
4223 " (g, message_callback,\n"
4224 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4225 " GUESTFS_EVENT_TRACE,\n"
4226 " 0, NULL) == -1)\n"
4227 " if (eh == -1) {\n"
4228 " // handle error in the usual way\n"
4234 #: ../src/guestfs.pod:1950
4236 "The callback can then direct messages to the appropriate place. In this "
4237 "example, messages are directed to syslog:"
4241 #: ../src/guestfs.pod:1953
4245 " message_callback (\n"
4248 " uint64_t event,\n"
4249 " int event_handle,\n"
4251 " const char *buf, size_t buf_len,\n"
4252 " const uint64_t *array, size_t array_len)\n"
4254 " const int priority = LOG_USER|LOG_INFO;\n"
4255 " if (buf_len > 0)\n"
4256 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4263 #: ../src/guestfs.pod:1968
4264 msgid "PRIVATE DATA AREA"
4268 #: ../src/guestfs.pod:1970
4270 "You can attach named pieces of private data to the libguestfs handle, fetch "
4271 "them by name, and walk over them, for the lifetime of the handle. This is "
4272 "called the private data area and is only available from the C API."
4277 #: ../src/guestfs.pod:1975
4278 msgid "To attach a named piece of data, use the following call:"
4283 #: ../src/guestfs.pod:1977
4286 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4292 #: ../src/guestfs.pod:1979
4294 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4295 "pointer (which can be C<NULL>). Any previous item with the same name is "
4301 #: ../src/guestfs.pod:1983
4303 "You can use any C<key> you want, but names beginning with an underscore "
4304 "character are reserved for internal libguestfs purposes (for implementing "
4305 "language bindings). It is recommended to prefix the name with some unique "
4306 "string to avoid collisions with other users."
4311 #: ../src/guestfs.pod:1988
4312 msgid "To retrieve the pointer, use:"
4317 #: ../src/guestfs.pod:1990
4320 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4326 #: ../src/guestfs.pod:1992
4328 "This function returns C<NULL> if either no data is found associated with "
4329 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4334 #: ../src/guestfs.pod:1996
4336 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4337 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4338 "all. In particular, libguestfs does I<not> try to free the data when the "
4339 "handle is closed. If the data must be freed, then the caller must either "
4340 "free it before calling L</guestfs_close> or must set up a close callback to "
4341 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4345 #: ../src/guestfs.pod:2003
4346 msgid "To walk over all entries, use these two functions:"
4350 #: ../src/guestfs.pod:2005
4353 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4358 #: ../src/guestfs.pod:2007
4361 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4366 #: ../src/guestfs.pod:2009
4368 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4369 "not have any particular meaning -- keys are not returned in any defined "
4370 "order). A pointer to the key is returned in C<*key_rtn> and the "
4371 "corresponding data pointer is returned from the function. C<NULL> is "
4372 "returned if there are no keys stored in the handle."
4376 #: ../src/guestfs.pod:2015
4378 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4379 "value of this function is also C<NULL> is there are no further entries to "
4384 #: ../src/guestfs.pod:2019
4385 msgid "Notes about walking over entries:"
4389 #: ../src/guestfs.pod:2025
4391 "You must not call C<guestfs_set_private> while walking over the entries."
4395 #: ../src/guestfs.pod:2030
4397 "The handle maintains an internal iterator which is reset when you call "
4398 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4399 "call C<guestfs_set_private>."
4403 #: ../src/guestfs.pod:2036
4404 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4408 #: ../src/guestfs.pod:2038
4411 " guestfs_set_private (g, key, NULL);\n"
4416 #: ../src/guestfs.pod:2040
4417 msgid "then that C<key> is not returned when walking."
4421 #: ../src/guestfs.pod:2044
4423 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4424 "C<guestfs_next_private> or C<guestfs_set_private>."
4428 #: ../src/guestfs.pod:2050
4430 "The following example code shows how to print all keys and data pointers "
4431 "that are associated with the handle C<g>:"
4435 #: ../src/guestfs.pod:2053
4438 " const char *key;\n"
4439 " void *data = guestfs_first_private (g, &key);\n"
4440 " while (data != NULL)\n"
4442 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4443 " data = guestfs_next_private (g, &key);\n"
4449 #: ../src/guestfs.pod:2061
4451 "More commonly you are only interested in keys that begin with an application-"
4452 "specific prefix C<foo_>. Modify the loop like so:"
4456 #: ../src/guestfs.pod:2064
4459 " const char *key;\n"
4460 " void *data = guestfs_first_private (g, &key);\n"
4461 " while (data != NULL)\n"
4463 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4464 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4465 " data = guestfs_next_private (g, &key);\n"
4471 #: ../src/guestfs.pod:2073
4473 "If you need to modify keys while walking, then you have to jump back to the "
4474 "beginning of the loop. For example, to delete all keys prefixed with "
4479 #: ../src/guestfs.pod:2077
4482 " const char *key;\n"
4485 " data = guestfs_first_private (g, &key);\n"
4486 " while (data != NULL)\n"
4488 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4490 " guestfs_set_private (g, key, NULL);\n"
4491 " /* note that 'key' pointer is now invalid, and so is\n"
4492 " the internal iterator */\n"
4495 " data = guestfs_next_private (g, &key);\n"
4501 #: ../src/guestfs.pod:2093
4503 "Note that the above loop is guaranteed to terminate because the keys are "
4504 "being deleted, but other manipulations of keys within the loop might not "
4505 "terminate unless you also maintain an indication of which keys have been "
4511 #: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
4517 #: ../src/guestfs.pod:2100
4519 "<!-- old anchor for the next section --> <a name="
4520 "\"state_machine_and_low_level_event_api\"/>"
4525 #: ../src/guestfs.pod:2105
4526 msgid "ARCHITECTURE"
4531 #: ../src/guestfs.pod:2107
4533 "Internally, libguestfs is implemented by running an appliance (a special "
4534 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4535 "process of the main program."
4540 #: ../src/guestfs.pod:2111
4543 " ___________________\n"
4545 " | main program |\n"
4547 " | | child process / appliance\n"
4548 " | | __________________________\n"
4550 " +-------------------+ RPC | +-----------------+ |\n"
4551 " | libguestfs <--------------------> guestfsd | |\n"
4552 " | | | +-----------------+ |\n"
4553 " \\___________________/ | | Linux kernel | |\n"
4554 " | +--^--------------+ |\n"
4555 " \\_________|________________/\n"
4561 " \\______________/\n"
4567 #: ../src/guestfs.pod:2131
4569 "The library, linked to the main program, creates the child process and hence "
4570 "the appliance in the L</guestfs_launch> function."
4575 #: ../src/guestfs.pod:2134
4577 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4578 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4579 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4580 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4581 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4582 "attached to the qemu process which translates device access by the "
4583 "appliance's Linux kernel into accesses to the image."
4588 #: ../src/guestfs.pod:2143
4590 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4591 "Although the disk image you are attached to might also be used by some "
4592 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4593 "care if both libguestfs's qemu process and your virtual machine are trying "
4594 "to update the disk image at the same time, since these usually results in "
4595 "massive disk corruption)."
4600 #: ../src/guestfs.pod:2150
4601 msgid "STATE MACHINE"
4606 #: ../src/guestfs.pod:2152
4607 msgid "libguestfs uses a state machine to model the child process:"
4612 #: ../src/guestfs.pod:2154
4624 " / | \\ \\ guestfs_launch\n"
4625 " / | _\\__V______\n"
4627 " / | | LAUNCHING |\n"
4628 " / | \\___________/\n"
4630 " / | guestfs_launch\n"
4632 " ______ / __|____V\n"
4633 " / \\ ------> / \\\n"
4634 " | BUSY | | READY |\n"
4635 " \\______/ <------ \\________/\n"
4641 #: ../src/guestfs.pod:2176
4643 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4644 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4645 "(3) alternating between READY and BUSY as commands are issued to, and "
4646 "carried out by, the child process."
4651 #: ../src/guestfs.pod:2181
4653 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4654 "asynchronously at any time (eg. due to some internal error), and that causes "
4655 "the state to transition back to CONFIG."
4660 #: ../src/guestfs.pod:2185
4662 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4663 "issued when in the CONFIG state."
4668 #: ../src/guestfs.pod:2188
4670 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4671 "L</guestfs_launch> blocks until the child process is READY to accept "
4672 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4673 "moves the state from CONFIG to LAUNCHING while it is running."
4678 #: ../src/guestfs.pod:2194
4680 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4681 "state. These API calls block waiting for the command to be carried out (ie. "
4682 "the state to transition to BUSY and then back to READY). There are no non-"
4683 "blocking versions, and no way to issue more than one command per handle at "
4689 #: ../src/guestfs.pod:2200
4691 "Finally, the child process sends asynchronous messages back to the main "
4692 "program, such as kernel log messages. You can register a callback to "
4693 "receive these messages."
4698 #: ../src/guestfs.pod:2204
4704 #: ../src/guestfs.pod:2206
4705 msgid "COMMUNICATION PROTOCOL"
4710 #: ../src/guestfs.pod:2208
4712 "Don't rely on using this protocol directly. This section documents how it "
4713 "currently works, but it may change at any time."
4718 #: ../src/guestfs.pod:2211
4720 "The protocol used to talk between the library and the daemon running inside "
4721 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4722 "1014, RFC 1832, RFC 4506)."
4727 #: ../src/guestfs.pod:2215
4729 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4730 "this file is automatically generated)."
4735 #: ../src/guestfs.pod:2218
4737 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4738 "and C<FileOut> parameters, which are handled with very simple request/reply "
4739 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4740 "parameters, which use the same request and reply messages, but they may also "
4741 "be followed by files sent using a chunked encoding."
4746 #: ../src/guestfs.pod:2225
4747 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4752 #: ../src/guestfs.pod:2227
4753 msgid "For ordinary functions, the request message is:"
4758 #: ../src/guestfs.pod:2229
4761 " total length (header + arguments,\n"
4762 " but not including the length word itself)\n"
4763 " struct guestfs_message_header (encoded as XDR)\n"
4764 " struct guestfs_<foo>_args (encoded as XDR)\n"
4770 #: ../src/guestfs.pod:2234
4772 "The total length field allows the daemon to allocate a fixed size buffer "
4773 "into which it slurps the rest of the message. As a result, the total length "
4774 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4775 "effective size of any request is limited to somewhere under this size."
4780 #: ../src/guestfs.pod:2240
4782 "Note also that many functions don't take any arguments, in which case the "
4783 "C<guestfs_I<foo>_args> is completely omitted."
4788 #: ../src/guestfs.pod:2243
4790 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4791 "receiver knows what type of args structure to expect, or none at all."
4796 #: ../src/guestfs.pod:2247
4798 "For functions that take optional arguments, the optional arguments are "
4799 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4800 "arguments. A bitmask in the header indicates which optional arguments are "
4801 "meaningful. The bitmask is also checked to see if it contains bits set "
4802 "which the daemon does not know about (eg. if more optional arguments were "
4803 "added in a later version of the library), and this causes the call to be "
4809 #: ../src/guestfs.pod:2255
4810 msgid "The reply message for ordinary functions is:"
4815 #: ../src/guestfs.pod:2257
4818 " total length (header + ret,\n"
4819 " but not including the length word itself)\n"
4820 " struct guestfs_message_header (encoded as XDR)\n"
4821 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4827 #: ../src/guestfs.pod:2262
4829 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4830 "functions that return no formal return values."
4835 #: ../src/guestfs.pod:2265
4837 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4842 #: ../src/guestfs.pod:2268
4844 "In the case of an error, a flag is set in the header, and the reply message "
4845 "is slightly changed:"
4850 #: ../src/guestfs.pod:2271
4853 " total length (header + error,\n"
4854 " but not including the length word itself)\n"
4855 " struct guestfs_message_header (encoded as XDR)\n"
4856 " struct guestfs_message_error (encoded as XDR)\n"
4862 #: ../src/guestfs.pod:2276
4864 "The C<guestfs_message_error> structure contains the error message as a "
4870 #: ../src/guestfs.pod:2279
4871 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4876 #: ../src/guestfs.pod:2281
4878 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4879 "The normal request message is sent (see above). However this is followed by "
4880 "a sequence of file chunks."
4885 #: ../src/guestfs.pod:2285
4888 " total length (header + arguments,\n"
4889 " but not including the length word itself,\n"
4890 " and not including the chunks)\n"
4891 " struct guestfs_message_header (encoded as XDR)\n"
4892 " struct guestfs_<foo>_args (encoded as XDR)\n"
4893 " sequence of chunks for FileIn param #0\n"
4894 " sequence of chunks for FileIn param #1 etc.\n"
4900 #: ../src/guestfs.pod:2293
4901 msgid "The \"sequence of chunks\" is:"
4906 #: ../src/guestfs.pod:2295
4909 " length of chunk (not including length word itself)\n"
4910 " struct guestfs_chunk (encoded as XDR)\n"
4911 " length of chunk\n"
4912 " struct guestfs_chunk (encoded as XDR)\n"
4914 " length of chunk\n"
4915 " struct guestfs_chunk (with data.data_len == 0)\n"
4921 #: ../src/guestfs.pod:2303
4923 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4924 "is set in the final chunk to indicate either successful completion or early "
4930 #: ../src/guestfs.pod:2307
4932 "At time of writing there are no functions that have more than one FileIn "
4933 "parameter. However this is (theoretically) supported, by sending the "
4934 "sequence of chunks for each FileIn parameter one after another (from left to "
4940 #: ../src/guestfs.pod:2312
4942 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4943 "transfer. The library does this by sending a chunk with a special flag set "
4944 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4945 "RPC, does I<not> send any reply, and goes back to reading the next request."
4950 #: ../src/guestfs.pod:2318
4952 "The daemon may also cancel. It does this by writing a special word "
4953 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4954 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4955 "cancel chunk). The special word is chosen so that even if cancellation "
4956 "happens right at the end of the transfer (after the library has finished "
4957 "writing and has started listening for the reply), the \"spurious\" cancel "
4958 "flag will not be confused with the reply message."
4963 #: ../src/guestfs.pod:2327
4965 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4966 "limit), and also files where the size is not known in advance (eg. from "
4967 "pipes or sockets). However the chunks are rather small "
4968 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4969 "to keep much in memory."
4974 #: ../src/guestfs.pod:2333
4975 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4980 #: ../src/guestfs.pod:2335
4982 "The protocol for FileOut parameters is exactly the same as for FileIn "
4983 "parameters, but with the roles of daemon and library reversed."
4988 #: ../src/guestfs.pod:2338
4991 " total length (header + ret,\n"
4992 " but not including the length word itself,\n"
4993 " and not including the chunks)\n"
4994 " struct guestfs_message_header (encoded as XDR)\n"
4995 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4996 " sequence of chunks for FileOut param #0\n"
4997 " sequence of chunks for FileOut param #1 etc.\n"
5003 #: ../src/guestfs.pod:2346
5004 msgid "INITIAL MESSAGE"
5009 #: ../src/guestfs.pod:2348
5011 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
5012 "which indicates that the guest and daemon is alive. This is what L</"
5013 "guestfs_launch> waits for."
5018 #: ../src/guestfs.pod:2352
5019 msgid "PROGRESS NOTIFICATION MESSAGES"
5024 #: ../src/guestfs.pod:2354
5026 "The daemon may send progress notification messages at any time. These are "
5027 "distinguished by the normal length word being replaced by "
5028 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
5032 #: ../src/guestfs.pod:2358
5034 "The library turns them into progress callbacks (see L</"
5035 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5041 #: ../src/guestfs.pod:2362
5043 "The daemon self-limits the frequency of progress messages it sends (see "
5044 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5050 #: ../src/guestfs.pod:2366
5051 msgid "LIBGUESTFS VERSION NUMBERS"
5056 #: ../src/guestfs.pod:2368
5058 "Since April 2010, libguestfs has started to make separate development and "
5059 "stable releases, along with corresponding branches in our git repository. "
5060 "These separate releases can be identified by version number:"
5065 #: ../src/guestfs.pod:2373
5068 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5069 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5075 " | `-------- sub-version\n"
5077 " `------ always '1' because we don't change the ABI\n"
5083 #: ../src/guestfs.pod:2384
5084 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5089 #: ../src/guestfs.pod:2386
5091 "As time passes we cherry pick fixes from the development branch and backport "
5092 "those into the stable branch, the effect being that the stable branch should "
5093 "get more stable and less buggy over time. So the stable releases are ideal "
5094 "for people who don't need new features but would just like the software to "
5100 #: ../src/guestfs.pod:2392
5101 msgid "Our criteria for backporting changes are:"
5106 #: ../src/guestfs.pod:2398
5108 "Documentation changes which don't affect any code are backported unless the "
5109 "documentation refers to a future feature which is not in stable."
5114 #: ../src/guestfs.pod:2404
5116 "Bug fixes which are not controversial, fix obvious problems, and have been "
5117 "well tested are backported."
5122 #: ../src/guestfs.pod:2409
5124 "Simple rearrangements of code which shouldn't affect how it works get "
5125 "backported. This is so that the code in the two branches doesn't get too "
5126 "far out of step, allowing us to backport future fixes more easily."
5131 #: ../src/guestfs.pod:2415
5133 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5134 "exceptional case: the new feature is required in order to implement an "
5135 "important bug fix."
5140 #: ../src/guestfs.pod:2421
5142 "A new stable branch starts when we think the new features in development are "
5143 "substantial and compelling enough over the current stable branch to warrant "
5144 "it. When that happens we create new stable and development versions 1.N.0 "
5145 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5146 "stable at this point, but by backporting fixes from development, that branch "
5147 "will stabilize over time."
5151 #: ../src/guestfs.pod:2429
5152 msgid "EXTENDING LIBGUESTFS"
5156 #: ../src/guestfs.pod:2431
5157 msgid "ADDING A NEW API ACTION"
5161 #: ../src/guestfs.pod:2433
5163 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5164 "documentation) are generated, and this makes it easy to extend the "
5169 #: ../src/guestfs.pod:2437
5170 msgid "To add a new API action there are two changes:"
5174 #: ../src/guestfs.pod:2443
5176 "You need to add a description of the call (name, parameters, return type, "
5177 "tests, documentation) to C<generator/generator_actions.ml>."
5181 #: ../src/guestfs.pod:2446
5183 "There are two sorts of API action, depending on whether the call goes "
5184 "through to the daemon in the appliance, or is serviced entirely by the "
5185 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5186 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5187 "an example of the latter, since a trace flag is maintained in the handle and "
5188 "all tracing is done on the library side."
5192 #: ../src/guestfs.pod:2454
5194 "Most new actions are of the first type, and get added to the "
5195 "C<daemon_functions> list. Each function has a unique procedure number used "
5196 "in the RPC protocol which is assigned to that action when we publish "
5197 "libguestfs and cannot be reused. Take the latest procedure number and "
5202 #: ../src/guestfs.pod:2460
5204 "For library-only actions of the second type, add to the "
5205 "C<non_daemon_functions> list. Since these functions are serviced by the "
5206 "library and do not travel over the RPC mechanism to the daemon, these "
5207 "functions do not need a procedure number, and so the procedure number is set "
5212 #: ../src/guestfs.pod:2468
5213 msgid "Implement the action (in C):"
5217 #: ../src/guestfs.pod:2470
5219 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5220 "C<daemon/> directory."
5224 #: ../src/guestfs.pod:2473
5226 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5227 "(note: double underscore) in the C<src/> directory."
5231 #: ../src/guestfs.pod:2476
5232 msgid "In either case, use another function as an example of what to do."
5236 #: ../src/guestfs.pod:2480
5237 msgid "After making these changes, use C<make> to compile."
5241 #: ../src/guestfs.pod:2482
5243 "Note that you don't need to implement the RPC, language bindings, manual "
5244 "pages or anything else. It's all automatically generated from the OCaml "
5249 #: ../src/guestfs.pod:2486
5250 msgid "ADDING TESTS FOR AN API ACTION"
5254 #: ../src/guestfs.pod:2488
5256 "You can supply zero or as many tests as you want per API call. The tests "
5257 "can either be added as part of the API description (C<generator/"
5258 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5259 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5260 "slower, so if possible use the first method."
5264 #: ../src/guestfs.pod:2494
5266 "The following describes the test environment used when you add an API test "
5267 "in C<generator_actions.ml>."
5271 #: ../src/guestfs.pod:2497
5272 msgid "The test environment has 4 block devices:"
5276 #: ../src/guestfs.pod:2501
5277 msgid "C</dev/sda> 500MB"
5281 #: ../src/guestfs.pod:2503
5282 msgid "General block device for testing."
5286 #: ../src/guestfs.pod:2505
5287 msgid "C</dev/sdb> 50MB"
5291 #: ../src/guestfs.pod:2507
5293 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5298 #: ../src/guestfs.pod:2510
5299 msgid "C</dev/sdc> 10MB"
5303 #: ../src/guestfs.pod:2512
5304 msgid "Used in a few tests where two block devices are needed."
5308 #: ../src/guestfs.pod:2514
5313 #: ../src/guestfs.pod:2516
5314 msgid "ISO with fixed content (see C<images/test.iso>)."
5318 #: ../src/guestfs.pod:2520
5320 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5321 "appliance and block devices are reused between tests. So don't try testing "
5322 "L</guestfs_kill_subprocess> :-x"
5326 #: ../src/guestfs.pod:2524
5328 "Each test starts with an initial scenario, selected using one of the "
5329 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5330 "initialize the disks mentioned above in a particular way as documented in "
5331 "C<generator_types.ml>. You should not assume anything about the previous "
5332 "contents of other disks that are not initialized."
5336 #: ../src/guestfs.pod:2530
5338 "You can add a prerequisite clause to any individual test. This is a run-"
5339 "time check, which, if it fails, causes the test to be skipped. Useful if "
5340 "testing a command which might not work on all variations of libguestfs "
5341 "builds. A test that has prerequisite of C<Always> means to run "
5346 #: ../src/guestfs.pod:2536
5348 "In addition, packagers can skip individual tests by setting environment "
5349 "variables before running C<make check>."
5353 #: ../src/guestfs.pod:2539
5356 " SKIP_TEST_<CMD>_<NUM>=1\n"
5361 #: ../src/guestfs.pod:2541
5362 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5366 #: ../src/guestfs.pod:2543
5371 #: ../src/guestfs.pod:2545
5374 " SKIP_TEST_<CMD>=1\n"
5379 #: ../src/guestfs.pod:2547
5380 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5384 #: ../src/guestfs.pod:2549
5385 msgid "Packagers can run only certain tests by setting for example:"
5389 #: ../src/guestfs.pod:2551
5392 " TEST_ONLY=\"vfs_type zerofree\"\n"
5397 #: ../src/guestfs.pod:2553
5399 "See C<capitests/tests.c> for more details of how these environment variables "
5404 #: ../src/guestfs.pod:2556
5405 msgid "DEBUGGING NEW API ACTIONS"
5409 #: ../src/guestfs.pod:2558
5410 msgid "Test new actions work before submitting them."
5414 #: ../src/guestfs.pod:2560
5415 msgid "You can use guestfish to try out new commands."
5419 #: ../src/guestfs.pod:2562
5421 "Debugging the daemon is a problem because it runs inside a minimal "
5422 "environment. However you can fprintf messages in the daemon to stderr, and "
5423 "they will show up if you use C<guestfish -v>."
5427 #: ../src/guestfs.pod:2566
5428 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5432 #: ../src/guestfs.pod:2568
5434 "Our C source code generally adheres to some basic code-formatting "
5435 "conventions. The existing code base is not totally consistent on this "
5436 "front, but we do prefer that contributed code be formatted similarly. In "
5437 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5438 "indentation level, and other than that, follow the K&R style."
5442 #: ../src/guestfs.pod:2574
5444 "If you use Emacs, add the following to one of one of your start-up files (e."
5445 "g., ~/.emacs), to help ensure that you get indentation right:"
5449 #: ../src/guestfs.pod:2577
5452 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5453 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5454 " (add-hook 'find-file-hook\n"
5455 " '(lambda () (if (and buffer-file-name\n"
5456 " (string-match \"/libguestfs\\\\>\"\n"
5457 " (buffer-file-name))\n"
5458 " (not (string-equal mode-name \"Change Log\"))\n"
5459 " (not (string-equal mode-name \"Makefile\")))\n"
5460 " (setq indent-tabs-mode nil))))\n"
5465 #: ../src/guestfs.pod:2587
5468 " ;;; When editing C sources in libguestfs, use this style.\n"
5469 " (defun libguestfs-c-mode ()\n"
5470 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5472 " (c-set-style \"K&R\")\n"
5473 " (setq c-indent-level 2)\n"
5474 " (setq c-basic-offset 2))\n"
5475 " (add-hook 'c-mode-hook\n"
5476 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5477 " (buffer-file-name))\n"
5478 " (libguestfs-c-mode))))\n"
5483 #: ../src/guestfs.pod:2599
5484 msgid "Enable warnings when compiling (and fix any problems this finds):"
5488 #: ../src/guestfs.pod:2602
5491 " ./configure --enable-gcc-warnings\n"
5496 #: ../src/guestfs.pod:2604
5497 msgid "Useful targets are:"
5501 #: ../src/guestfs.pod:2606
5504 " make syntax-check # checks the syntax of the C code\n"
5505 " make check # runs the test suite\n"
5510 #: ../src/guestfs.pod:2609
5511 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5515 #: ../src/guestfs.pod:2611
5517 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5518 "which are used to do shell quoting."
5522 #: ../src/guestfs.pod:2616
5527 #: ../src/guestfs.pod:2618
5529 "Simple shell quoted string. Any spaces or other shell characters are "
5534 #: ../src/guestfs.pod:2621
5539 #: ../src/guestfs.pod:2623
5541 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5547 #: ../src/guestfs.pod:2628 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5548 msgid "For example:"
5552 #: ../src/guestfs.pod:2630
5555 " asprintf (&cmd, \"cat %R\", path);\n"
5560 #: ../src/guestfs.pod:2632
5561 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5565 #: ../src/guestfs.pod:2634
5567 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5568 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5569 "they are not passed via the shell (instead, straight to exec). You probably "
5570 "want to use the C<sysroot_path()> function however."
5574 #: ../src/guestfs.pod:2640
5575 msgid "SUBMITTING YOUR NEW API ACTIONS"
5579 #: ../src/guestfs.pod:2642
5581 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5582 "libguestfs> and CC to L<rjones@redhat.com>."
5586 #: ../src/guestfs.pod:2646
5587 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5591 #: ../src/guestfs.pod:2648
5592 msgid "We support i18n (gettext anyhow) in the library."
5596 #: ../src/guestfs.pod:2650
5598 "However many messages come from the daemon, and we don't translate those at "
5599 "the moment. One reason is that the appliance generally has all locale files "
5600 "removed from it, because they take up a lot of space. So we'd have to readd "
5601 "some of those, as well as copying our PO files into the appliance."
5605 #: ../src/guestfs.pod:2656
5607 "Debugging messages are never translated, since they are intended for the "
5612 #: ../src/guestfs.pod:2659
5613 msgid "SOURCE CODE SUBDIRECTORIES"
5617 #: ../src/guestfs.pod:2663 ../src/guestfs-actions.pod:5806
5618 #: ../fish/guestfish-actions.pod:3900
5619 msgid "C<appliance>"
5623 #: ../src/guestfs.pod:2665
5624 msgid "The libguestfs appliance, build scripts and so on."
5628 #: ../src/guestfs.pod:2667
5629 msgid "C<capitests>"
5633 #: ../src/guestfs.pod:2669
5634 msgid "Automated tests of the C API."
5638 #: ../src/guestfs.pod:2671
5643 #: ../src/guestfs.pod:2673
5645 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5650 #: ../src/guestfs.pod:2676
5655 #: ../src/guestfs.pod:2678
5656 msgid "Outside contributions, experimental parts."
5660 #: ../src/guestfs.pod:2680
5665 #: ../src/guestfs.pod:2682
5667 "The daemon that runs inside the libguestfs appliance and carries out actions."
5671 #: ../src/guestfs.pod:2685
5676 #: ../src/guestfs.pod:2687
5677 msgid "L<virt-df(1)> command and documentation."
5681 #: ../src/guestfs.pod:2689
5686 #: ../src/guestfs.pod:2691
5687 msgid "C API example code."
5691 #: ../src/guestfs.pod:2693
5696 #: ../src/guestfs.pod:2695
5698 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5699 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5700 "L<virt-tar-out(1)>."
5704 #: ../src/guestfs.pod:2699
5709 #: ../src/guestfs.pod:2701
5711 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5715 #: ../src/guestfs.pod:2703
5716 msgid "C<generator>"
5720 #: ../src/guestfs.pod:2705
5722 "The crucially important generator, used to automatically generate large "
5723 "amounts of boilerplate C code for things like RPC and bindings."
5727 #: ../src/guestfs.pod:2708
5732 #: ../src/guestfs.pod:2710
5733 msgid "Files used by the test suite."
5737 #: ../src/guestfs.pod:2712
5738 msgid "Some \"phony\" guest images which we test against."
5742 #: ../src/guestfs.pod:2714
5743 msgid "C<inspector>"
5747 #: ../src/guestfs.pod:2716
5748 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5752 #: ../src/guestfs.pod:2718
5757 #: ../src/guestfs.pod:2720
5758 msgid "Logo used on the website. The fish is called Arthur by the way."
5762 #: ../src/guestfs.pod:2722
5767 #: ../src/guestfs.pod:2724
5768 msgid "M4 macros used by autoconf."
5772 #: ../src/guestfs.pod:2726
5777 #: ../src/guestfs.pod:2728
5778 msgid "Translations of simple gettext strings."
5782 #: ../src/guestfs.pod:2730
5787 #: ../src/guestfs.pod:2732
5789 "The build infrastructure and PO files for translations of manpages and POD "
5790 "files. Eventually this will be combined with the C<po> directory, but that "
5791 "is rather complicated."
5795 #: ../src/guestfs.pod:2736
5796 msgid "C<regressions>"
5800 #: ../src/guestfs.pod:2738
5801 msgid "Regression tests."
5805 #: ../src/guestfs.pod:2740
5810 #: ../src/guestfs.pod:2742
5811 msgid "L<virt-rescue(1)> command and documentation."
5815 #: ../src/guestfs.pod:2744
5820 #: ../src/guestfs.pod:2746
5821 msgid "Source code to the C library."
5825 #: ../src/guestfs.pod:2748
5830 #: ../src/guestfs.pod:2750
5831 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5835 #: ../src/guestfs.pod:2752
5836 msgid "C<test-tool>"
5840 #: ../src/guestfs.pod:2754
5842 "Test tool for end users to test if their qemu/kernel combination will work "
5847 #: ../src/guestfs.pod:2757
5852 #: ../src/guestfs.pod:2759
5857 #: ../src/guestfs.pod:2761
5862 #: ../src/guestfs.pod:2763
5867 #: ../src/guestfs.pod:2765
5872 #: ../src/guestfs.pod:2767
5877 #: ../src/guestfs.pod:2769
5882 #: ../src/guestfs.pod:2771
5887 #: ../src/guestfs.pod:2773
5888 msgid "Language bindings."
5893 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1010
5894 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:476
5895 msgid "ENVIRONMENT VARIABLES"
5900 #: ../src/guestfs.pod:2781 ../fish/guestfish.pod:1036
5901 msgid "LIBGUESTFS_APPEND"
5906 #: ../src/guestfs.pod:2783 ../fish/guestfish.pod:1038
5907 msgid "Pass additional options to the guest kernel."
5912 #: ../src/guestfs.pod:2785 ../fish/guestfish.pod:1040
5913 msgid "LIBGUESTFS_DEBUG"
5918 #: ../src/guestfs.pod:2787
5920 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5921 "effect as calling C<guestfs_set_verbose (g, 1)>."
5926 #: ../src/guestfs.pod:2790 ../fish/guestfish.pod:1045
5927 msgid "LIBGUESTFS_MEMSIZE"
5932 #: ../src/guestfs.pod:2792 ../fish/guestfish.pod:1047
5934 "Set the memory allocated to the qemu process, in megabytes. For example:"
5939 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1050
5942 " LIBGUESTFS_MEMSIZE=700\n"
5948 #: ../src/guestfs.pod:2797 ../fish/guestfish.pod:1052
5949 msgid "LIBGUESTFS_PATH"
5953 #: ../src/guestfs.pod:2799
5955 "Set the path that libguestfs uses to search for a supermin appliance. See "
5956 "the discussion of paths in section L</PATH> above."
5961 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1057
5962 msgid "LIBGUESTFS_QEMU"
5967 #: ../src/guestfs.pod:2804 ../fish/guestfish.pod:1059
5969 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5970 "which was found at compile time by the configure script is used."
5975 #: ../src/guestfs.pod:2808
5976 msgid "See also L</QEMU WRAPPERS> above."
5981 #: ../src/guestfs.pod:2810 ../fish/guestfish.pod:1063
5982 msgid "LIBGUESTFS_TRACE"
5987 #: ../src/guestfs.pod:2812
5989 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5990 "effect as calling C<guestfs_set_trace (g, 1)>."
5995 #: ../src/guestfs.pod:2815 ../fish/guestfish.pod:1072
6000 #: ../src/guestfs.pod:2817 ../fish/guestfish.pod:1074
6002 "Location of temporary directory, defaults to C</tmp> except for the cached "
6003 "supermin appliance which defaults to C</var/tmp>."
6007 #: ../src/guestfs.pod:2820 ../fish/guestfish.pod:1077
6009 "If libguestfs was compiled to use the supermin appliance then the real "
6010 "appliance is cached in this directory, shared between all handles belonging "
6011 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6012 "use in case C</var/tmp> is not large enough."
6017 #: ../src/guestfs.pod:2828 ../fish/guestfish.pod:1144
6018 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:267
6019 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
6020 #: ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189
6021 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
6022 #: ../tools/virt-list-partitions.pl:257
6027 #: ../src/guestfs.pod:2830
6029 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6030 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6031 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6032 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6033 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6034 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6035 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6040 #: ../src/guestfs.pod:2857
6042 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6043 "(8)>, L<disktype(1)>."
6048 #: ../src/guestfs.pod:2864 ../tools/virt-win-reg.pl:587
6049 #: ../tools/virt-make-fs.pl:553
6055 #: ../src/guestfs.pod:2866
6056 msgid "To get a list of bugs against libguestfs use this link:"
6061 #: ../src/guestfs.pod:2868
6063 "L<https://bugzilla.redhat.com/buglist.cgi?"
6064 "component=libguestfs&product=Virtualization+Tools>"
6069 #: ../src/guestfs.pod:2870
6070 msgid "To report a new bug against libguestfs use this link:"
6075 #: ../src/guestfs.pod:2872
6077 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6078 "component=libguestfs&product=Virtualization+Tools>"
6083 #: ../src/guestfs.pod:2874
6084 msgid "When reporting a bug, please check:"
6089 #: ../src/guestfs.pod:2880
6090 msgid "That the bug hasn't been reported already."
6095 #: ../src/guestfs.pod:2884
6096 msgid "That you are testing a recent version."
6101 #: ../src/guestfs.pod:2888
6102 msgid "Describe the bug accurately, and give a way to reproduce it."
6107 #: ../src/guestfs.pod:2892
6109 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6115 #: ../src/guestfs.pod:2897 ../fish/guestfish.pod:1167
6116 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:278
6122 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1169
6123 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:280
6124 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6129 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1171
6130 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:282
6131 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
6132 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206
6133 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6134 #: ../tools/virt-list-partitions.pl:273
6139 #: ../src/guestfs.pod:2903 ../fish/guestfish.pod:1173
6140 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6145 #: ../src/guestfs.pod:2906
6147 "This library is free software; you can redistribute it and/or modify it "
6148 "under the terms of the GNU Lesser General Public License as published by the "
6149 "Free Software Foundation; either version 2 of the License, or (at your "
6150 "option) any later version."
6155 #: ../src/guestfs.pod:2911
6157 "This library is distributed in the hope that it will be useful, but WITHOUT "
6158 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6159 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6165 #: ../src/guestfs.pod:2916
6167 "You should have received a copy of the GNU Lesser General Public License "
6168 "along with this library; if not, write to the Free Software Foundation, "
6169 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6174 #: ../src/guestfs-actions.pod:1
6175 msgid "guestfs_add_cdrom"
6180 #: ../src/guestfs-actions.pod:3
6184 " guestfs_add_cdrom (guestfs_h *g,\n"
6185 " const char *filename);\n"
6191 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6192 msgid "This function adds a virtual CD-ROM disk image to the guest."
6197 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6198 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
6203 #: ../src/guestfs-actions.pod:17
6205 "This call checks for the existence of C<filename>. This stops you from "
6206 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6207 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6213 #: ../src/guestfs-actions.pod:24
6215 "If you just want to add an ISO file (often you use this as an efficient way "
6216 "to transfer large files into the guest), then you should probably use "
6217 "C<guestfs_add_drive_ro> instead."
6222 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6223 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6224 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6225 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6226 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6227 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6228 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6229 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6230 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6231 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6232 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6233 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6234 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6235 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6236 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6237 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6238 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
6239 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
6240 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
6241 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
6242 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
6243 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3451
6244 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3491
6245 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3660
6246 #: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3687
6247 #: ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3738
6248 #: ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3830
6249 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3870
6250 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3925
6251 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3963
6252 #: ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010
6253 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4062
6254 #: ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4090
6255 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4200
6256 #: ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4233
6257 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4302
6258 #: ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4336
6259 #: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364
6260 #: ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4396
6261 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4474
6262 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4578
6263 #: ../src/guestfs-actions.pod:4597 ../src/guestfs-actions.pod:4616
6264 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4645
6265 #: ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4673
6266 #: ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4723
6267 #: ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4758
6268 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4789
6269 #: ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4875
6270 #: ../src/guestfs-actions.pod:4889 ../src/guestfs-actions.pod:4917
6271 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952
6272 #: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5143
6273 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5183
6274 #: ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5281
6275 #: ../src/guestfs-actions.pod:5298 ../src/guestfs-actions.pod:5311
6276 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5614
6277 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652
6278 #: ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5676
6279 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702
6280 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5732
6281 #: ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5772
6282 #: ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5821
6283 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5860
6284 #: ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5897
6285 #: ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5937
6286 #: ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5982
6287 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6025
6288 #: ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6068
6289 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6102
6290 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162
6291 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6296
6292 #: ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6429
6293 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6455
6294 #: ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6490
6295 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6516
6296 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6590
6297 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6623
6298 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656
6299 #: ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6689
6300 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739
6301 #: ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6793
6302 #: ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6845
6303 #: ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:7000
6304 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7032
6305 #: ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7100
6306 #: ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7178
6307 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7258
6308 #: ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7343
6309 #: ../src/guestfs-actions.pod:7372
6310 msgid "This function returns 0 on success or -1 on error."
6315 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6316 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6317 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6319 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6325 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6326 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6327 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
6328 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:7266
6329 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:31
6330 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6331 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6332 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3000
6333 #: ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4955
6335 "Deprecated functions will not be removed from the API, but the fact that "
6336 "they are deprecated indicates that there are problems with correct use of "
6342 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6343 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
6344 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
6345 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3473
6346 #: ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:5839
6347 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6070
6348 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6658
6349 #: ../src/guestfs-actions.pod:7180
6350 msgid "(Added in 0.3)"
6355 #: ../src/guestfs-actions.pod:41
6356 msgid "guestfs_add_domain"
6361 #: ../src/guestfs-actions.pod:43
6365 " guestfs_add_domain (guestfs_h *g,\n"
6366 " const char *dom,\n"
6373 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6374 #: ../src/guestfs-actions.pod:4435
6376 "You may supply a list of optional arguments to this call. Use zero or more "
6377 "of the following pairs of parameters, and terminate the list with C<-1> on "
6378 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6382 #: ../src/guestfs-actions.pod:53
6385 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6386 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6387 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6388 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6394 #: ../src/guestfs-actions.pod:58
6396 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6397 "It works by connecting to libvirt, requesting the domain and domain XML from "
6398 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6404 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6406 "The number of disks added is returned. This operation is atomic: if an "
6407 "error is returned, then no disks are added."
6412 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6414 "This function does some minimal checks to make sure the libvirt domain is "
6415 "not running (unless C<readonly> is true). In a future version we will try "
6416 "to acquire the libvirt lock on each disk."
6421 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6423 "Disks must be accessible locally. This often means that adding disks from a "
6424 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6425 "unless those disks are accessible via the same device path locally too."
6429 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6431 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6432 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6433 "libvirt URI (or one set through an environment variable, see the libvirt "
6434 "documentation for full details)."
6438 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6440 "The optional C<live> flag controls whether this call will try to connect to "
6441 "a running virtual machine C<guestfsd> process if it sees a suitable "
6442 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6443 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6444 "DAEMONS> for more information."
6449 #: ../src/guestfs-actions.pod:88
6451 "The other optional parameters are passed directly through to "
6452 "C<guestfs_add_drive_opts>."
6457 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6458 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6459 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6460 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6461 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
6462 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
6463 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
6464 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2772
6465 #: ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:4861
6466 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5395
6467 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:6766
6468 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7204
6469 #: ../src/guestfs-actions.pod:7217
6470 msgid "On error this function returns -1."
6475 #: ../src/guestfs-actions.pod:93
6476 msgid "(Added in 1.7.4)"
6481 #: ../src/guestfs-actions.pod:95
6482 msgid "guestfs_add_domain_va"
6487 #: ../src/guestfs-actions.pod:97
6491 " guestfs_add_domain_va (guestfs_h *g,\n"
6492 " const char *dom,\n"
6499 #: ../src/guestfs-actions.pod:102
6500 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6505 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6506 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6507 #: ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4500
6508 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6513 #: ../src/guestfs-actions.pod:106
6514 msgid "guestfs_add_domain_argv"
6519 #: ../src/guestfs-actions.pod:108
6523 " guestfs_add_domain_argv (guestfs_h *g,\n"
6524 " const char *dom,\n"
6525 " const struct guestfs_add_domain_argv *optargs);\n"
6531 #: ../src/guestfs-actions.pod:113
6532 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6537 #: ../src/guestfs-actions.pod:117
6538 msgid "guestfs_add_drive"
6543 #: ../src/guestfs-actions.pod:119
6547 " guestfs_add_drive (guestfs_h *g,\n"
6548 " const char *filename);\n"
6554 #: ../src/guestfs-actions.pod:123
6556 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6557 "optional parameters, so the disk is added writable, with the format being "
6558 "detected automatically."
6563 #: ../src/guestfs-actions.pod:127
6565 "Automatic detection of the format opens you up to a potential security hole "
6566 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6567 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6568 "you should think about replacing calls to this function with calls to "
6569 "C<guestfs_add_drive_opts>, and specifying the format."
6574 #: ../src/guestfs-actions.pod:138
6575 msgid "guestfs_add_drive_opts"
6580 #: ../src/guestfs-actions.pod:140
6584 " guestfs_add_drive_opts (guestfs_h *g,\n"
6585 " const char *filename,\n"
6592 #: ../src/guestfs-actions.pod:150
6595 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6596 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6597 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6603 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6605 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6606 "The first time you call this function, the disk appears as C</dev/sda>, the "
6607 "second time as C</dev/sdb>, and so on."
6612 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6614 "You don't necessarily need to be root when using libguestfs. However you "
6615 "obviously do need sufficient permissions to access the filename for whatever "
6616 "operations you want to perform (ie. read access if you just want to read the "
6617 "image or write access if you want to modify the image)."
6622 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6623 msgid "This call checks that C<filename> exists."
6628 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4446
6629 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3011
6630 msgid "The optional arguments are:"
6635 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6641 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6643 "If true then the image is treated as read-only. Writes are still allowed, "
6644 "but they are stored in a temporary snapshot overlay which is discarded at "
6645 "the end. The disk that you add is not modified."
6650 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6656 #: ../src/guestfs-actions.pod:179
6658 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6659 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6660 "Possible formats include C<raw> and C<qcow2>."
6665 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6667 "Automatic detection of the format opens you up to a potential security hole "
6668 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6669 "RHBZ#642934. Specifying the format closes this security hole."
6674 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6680 #: ../src/guestfs-actions.pod:190
6682 "This rarely-used option lets you emulate the behaviour of the deprecated "
6683 "C<guestfs_add_drive_with_if> call (q.v.)"
6688 #: ../src/guestfs-actions.pod:197
6689 msgid "(Added in 1.5.23)"
6694 #: ../src/guestfs-actions.pod:199
6695 msgid "guestfs_add_drive_opts_va"
6700 #: ../src/guestfs-actions.pod:201
6704 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6705 " const char *filename,\n"
6712 #: ../src/guestfs-actions.pod:206
6713 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6718 #: ../src/guestfs-actions.pod:210
6719 msgid "guestfs_add_drive_opts_argv"
6724 #: ../src/guestfs-actions.pod:212
6728 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6729 " const char *filename,\n"
6730 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6736 #: ../src/guestfs-actions.pod:217
6737 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6742 #: ../src/guestfs-actions.pod:221
6743 msgid "guestfs_add_drive_ro"
6748 #: ../src/guestfs-actions.pod:223
6752 " guestfs_add_drive_ro (guestfs_h *g,\n"
6753 " const char *filename);\n"
6759 #: ../src/guestfs-actions.pod:227
6761 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6762 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6763 "disk is added read-only, with the format being detected automatically."
6768 #: ../src/guestfs-actions.pod:234
6769 msgid "(Added in 1.0.38)"
6774 #: ../src/guestfs-actions.pod:236
6775 msgid "guestfs_add_drive_ro_with_if"
6780 #: ../src/guestfs-actions.pod:238
6784 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6785 " const char *filename,\n"
6786 " const char *iface);\n"
6792 #: ../src/guestfs-actions.pod:243
6794 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6795 "QEMU interface emulation to use at run time."
6800 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6801 #: ../src/guestfs-actions.pod:2356
6802 msgid "(Added in 1.0.84)"
6807 #: ../src/guestfs-actions.pod:257
6808 msgid "guestfs_add_drive_with_if"
6813 #: ../src/guestfs-actions.pod:259
6817 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6818 " const char *filename,\n"
6819 " const char *iface);\n"
6825 #: ../src/guestfs-actions.pod:264
6827 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6828 "QEMU interface emulation to use at run time."
6833 #: ../src/guestfs-actions.pod:278
6834 msgid "guestfs_aug_clear"
6839 #: ../src/guestfs-actions.pod:280
6843 " guestfs_aug_clear (guestfs_h *g,\n"
6844 " const char *augpath);\n"
6850 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6852 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6853 "L<augtool(1)> C<clear> command."
6858 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6859 msgid "(Added in 1.3.4)"
6864 #: ../src/guestfs-actions.pod:291
6865 msgid "guestfs_aug_close"
6870 #: ../src/guestfs-actions.pod:293
6874 " guestfs_aug_close (guestfs_h *g);\n"
6880 #: ../src/guestfs-actions.pod:296
6882 "Close the current Augeas handle and free up any resources used by it. After "
6883 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6884 "any other Augeas functions."
6889 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6890 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6891 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6892 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6893 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6894 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6895 #: ../src/guestfs-actions.pod:5472
6896 msgid "(Added in 0.7)"
6901 #: ../src/guestfs-actions.pod:305
6902 msgid "guestfs_aug_defnode"
6907 #: ../src/guestfs-actions.pod:307
6910 " struct guestfs_int_bool *\n"
6911 " guestfs_aug_defnode (guestfs_h *g,\n"
6912 " const char *name,\n"
6913 " const char *expr,\n"
6914 " const char *val);\n"
6920 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6922 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6927 #: ../src/guestfs-actions.pod:316
6929 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6930 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6931 "containing that single node."
6936 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6938 "On success this returns a pair containing the number of nodes in the "
6939 "nodeset, and a boolean flag if a node was created."
6944 #: ../src/guestfs-actions.pod:324
6946 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6947 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6952 #: ../src/guestfs-actions.pod:330
6953 msgid "guestfs_aug_defvar"
6958 #: ../src/guestfs-actions.pod:332
6962 " guestfs_aug_defvar (guestfs_h *g,\n"
6963 " const char *name,\n"
6964 " const char *expr);\n"
6970 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6972 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6973 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6978 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6980 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6981 "evaluates to something which is not a nodeset."
6986 #: ../src/guestfs-actions.pod:348
6987 msgid "guestfs_aug_get"
6992 #: ../src/guestfs-actions.pod:350
6996 " guestfs_aug_get (guestfs_h *g,\n"
6997 " const char *augpath);\n"
7003 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
7005 "Look up the value associated with C<path>. If C<path> matches exactly one "
7006 "node, the C<value> is returned."
7011 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
7012 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
7013 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
7014 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
7015 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
7016 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
7017 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
7018 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
7019 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
7020 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
7021 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
7022 #: ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2864
7023 #: ../src/guestfs-actions.pod:2895 ../src/guestfs-actions.pod:2919
7024 #: ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:3016
7025 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3060
7026 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3982
7027 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4262
7028 #: ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5200
7029 #: ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5548
7030 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6209
7031 #: ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6242
7032 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6940
7033 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6977
7034 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7429
7036 "This function returns a string, or NULL on error. I<The caller must free "
7037 "the returned string after use>."
7042 #: ../src/guestfs-actions.pod:362
7043 msgid "guestfs_aug_init"
7048 #: ../src/guestfs-actions.pod:364
7052 " guestfs_aug_init (guestfs_h *g,\n"
7053 " const char *root,\n"
7060 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7062 "Create a new Augeas handle for editing configuration files. If there was "
7063 "any previous Augeas handle associated with this guestfs session, then it is "
7069 #: ../src/guestfs-actions.pod:373
7070 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7075 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7077 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7082 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7084 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7085 "logical I<or> of the following integers:"
7090 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7091 msgid "C<AUG_SAVE_BACKUP> = 1"
7096 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7097 msgid "Keep the original file with a C<.augsave> extension."
7102 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7103 msgid "C<AUG_SAVE_NEWFILE> = 2"
7108 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7110 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7111 "original. Overrides C<AUG_SAVE_BACKUP>."
7116 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7117 msgid "C<AUG_TYPE_CHECK> = 4"
7122 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7123 msgid "Typecheck lenses (can be expensive)."
7128 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7129 msgid "C<AUG_NO_STDINC> = 8"
7134 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7135 msgid "Do not use standard load path for modules."
7140 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7141 msgid "C<AUG_SAVE_NOOP> = 16"
7146 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7147 msgid "Make save a no-op, just record what would have been changed."
7152 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7153 msgid "C<AUG_NO_LOAD> = 32"
7158 #: ../src/guestfs-actions.pod:408
7159 msgid "Do not load the tree in C<guestfs_aug_init>."
7164 #: ../src/guestfs-actions.pod:412
7165 msgid "To close the handle, you can call C<guestfs_aug_close>."
7170 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7171 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7176 #: ../src/guestfs-actions.pod:420
7177 msgid "guestfs_aug_insert"
7182 #: ../src/guestfs-actions.pod:422
7186 " guestfs_aug_insert (guestfs_h *g,\n"
7187 " const char *augpath,\n"
7188 " const char *label,\n"
7195 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7197 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7198 "or after C<path> (depending on the boolean flag C<before>)."
7203 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7205 "C<path> must match exactly one existing node in the tree, and C<label> must "
7206 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7211 #: ../src/guestfs-actions.pod:440
7212 msgid "guestfs_aug_load"
7217 #: ../src/guestfs-actions.pod:442
7221 " guestfs_aug_load (guestfs_h *g);\n"
7227 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7228 msgid "Load files into the tree."
7233 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7234 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7239 #: ../src/guestfs-actions.pod:454
7240 msgid "guestfs_aug_ls"
7245 #: ../src/guestfs-actions.pod:456
7249 " guestfs_aug_ls (guestfs_h *g,\n"
7250 " const char *augpath);\n"
7256 #: ../src/guestfs-actions.pod:460
7258 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7259 "sorting the resulting nodes into alphabetical order."
7264 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7265 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7266 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
7267 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
7268 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
7269 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
7270 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
7271 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
7272 #: ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2973
7273 #: ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:3552
7274 #: ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3719
7275 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4822
7276 #: ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5468
7277 #: ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:6282
7278 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6398
7279 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6568
7280 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7070
7281 #: ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7282
7282 #: ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7386
7283 #: ../src/guestfs-actions.pod:7405 ../src/guestfs-actions.pod:7451
7284 #: ../src/guestfs-actions.pod:7470
7286 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7287 ">), or NULL if there was an error. I<The caller must free the strings and "
7288 "the array after use>."
7293 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7294 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
7295 #: ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3371
7296 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4015
7297 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4235
7298 #: ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4826
7299 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5678
7300 #: ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5704
7301 #: ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6782
7302 #: ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7034
7303 #: ../src/guestfs-actions.pod:7270
7304 msgid "(Added in 0.8)"
7309 #: ../src/guestfs-actions.pod:469
7310 msgid "guestfs_aug_match"
7315 #: ../src/guestfs-actions.pod:471
7319 " guestfs_aug_match (guestfs_h *g,\n"
7320 " const char *augpath);\n"
7326 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7328 "Returns a list of paths which match the path expression C<path>. The "
7329 "returned paths are sufficiently qualified so that they match exactly one "
7330 "node in the current tree."
7335 #: ../src/guestfs-actions.pod:485
7336 msgid "guestfs_aug_mv"
7341 #: ../src/guestfs-actions.pod:487
7345 " guestfs_aug_mv (guestfs_h *g,\n"
7346 " const char *src,\n"
7347 " const char *dest);\n"
7353 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7355 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7356 "C<dest> is overwritten if it exists."
7361 #: ../src/guestfs-actions.pod:499
7362 msgid "guestfs_aug_rm"
7367 #: ../src/guestfs-actions.pod:501
7371 " guestfs_aug_rm (guestfs_h *g,\n"
7372 " const char *augpath);\n"
7378 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7379 msgid "Remove C<path> and all of its children."
7384 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7385 msgid "On success this returns the number of entries which were removed."
7390 #: ../src/guestfs-actions.pod:513
7391 msgid "guestfs_aug_save"
7396 #: ../src/guestfs-actions.pod:515
7400 " guestfs_aug_save (guestfs_h *g);\n"
7406 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7407 msgid "This writes all pending changes to disk."
7412 #: ../src/guestfs-actions.pod:520
7414 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7420 #: ../src/guestfs-actions.pod:527
7421 msgid "guestfs_aug_set"
7426 #: ../src/guestfs-actions.pod:529
7430 " guestfs_aug_set (guestfs_h *g,\n"
7431 " const char *augpath,\n"
7432 " const char *val);\n"
7438 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7439 msgid "Set the value associated with C<path> to C<val>."
7444 #: ../src/guestfs-actions.pod:536
7446 "In the Augeas API, it is possible to clear a node by setting the value to "
7447 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7448 "this call. Instead you must use the C<guestfs_aug_clear> call."
7453 #: ../src/guestfs-actions.pod:545
7454 msgid "guestfs_available"
7459 #: ../src/guestfs-actions.pod:547
7463 " guestfs_available (guestfs_h *g,\n"
7464 " char *const *groups);\n"
7470 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7472 "This command is used to check the availability of some groups of "
7473 "functionality in the appliance, which not all builds of the libguestfs "
7474 "appliance will be able to provide."
7479 #: ../src/guestfs-actions.pod:555
7481 "The libguestfs groups, and the functions that those groups correspond to, "
7482 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7483 "runtime by calling C<guestfs_available_all_groups>."
7488 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7490 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7491 "\"]> would check for the availability of the Linux inotify functions and "
7492 "Augeas (configuration file editing) functions."
7497 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7498 msgid "The command returns no error if I<all> requested groups are available."
7503 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7505 "It fails with an error if one or more of the requested groups is unavailable "
7511 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7513 "If an unknown group name is included in the list of groups then an error is "
7519 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7525 #: ../src/guestfs-actions.pod:579
7526 msgid "You must call C<guestfs_launch> before calling this function."
7531 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7533 "The reason is because we don't know what groups are supported by the "
7534 "appliance/daemon until it is running and can be queried."
7539 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7541 "If a group of functions is available, this does not necessarily mean that "
7542 "they will work. You still have to check for errors when calling individual "
7543 "API functions even if they are available."
7548 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7550 "It is usually the job of distro packagers to build complete functionality "
7551 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7552 "with all requirements satisfied, will support everything."
7557 #: ../src/guestfs-actions.pod:601
7559 "This call was added in version C<1.0.80>. In previous versions of "
7560 "libguestfs all you could do would be to speculatively execute a command to "
7561 "find out if the daemon implemented it. See also C<guestfs_version>."
7566 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7567 msgid "(Added in 1.0.80)"
7572 #: ../src/guestfs-actions.pod:612
7573 msgid "guestfs_available_all_groups"
7578 #: ../src/guestfs-actions.pod:614
7582 " guestfs_available_all_groups (guestfs_h *g);\n"
7588 #: ../src/guestfs-actions.pod:617
7590 "This command returns a list of all optional groups that this daemon knows "
7591 "about. Note this returns both supported and unsupported groups. To find "
7592 "out which ones the daemon can actually support you have to call "
7593 "C<guestfs_available> on each member of the returned list."
7598 #: ../src/guestfs-actions.pod:623
7599 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7604 #: ../src/guestfs-actions.pod:629
7605 msgid "(Added in 1.3.15)"
7610 #: ../src/guestfs-actions.pod:631
7611 msgid "guestfs_base64_in"
7616 #: ../src/guestfs-actions.pod:633
7620 " guestfs_base64_in (guestfs_h *g,\n"
7621 " const char *base64file,\n"
7622 " const char *filename);\n"
7628 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7630 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7635 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7636 msgid "(Added in 1.3.5)"
7641 #: ../src/guestfs-actions.pod:645
7642 msgid "guestfs_base64_out"
7647 #: ../src/guestfs-actions.pod:647
7651 " guestfs_base64_out (guestfs_h *g,\n"
7652 " const char *filename,\n"
7653 " const char *base64file);\n"
7659 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7661 "This command downloads the contents of C<filename>, writing it out to local "
7662 "file C<base64file> encoded as base64."
7667 #: ../src/guestfs-actions.pod:659
7668 msgid "guestfs_blockdev_flushbufs"
7673 #: ../src/guestfs-actions.pod:661
7677 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7678 " const char *device);\n"
7684 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7686 "This tells the kernel to flush internal buffers associated with C<device>."
7691 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7692 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7693 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7694 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7695 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7696 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7697 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7698 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7699 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7700 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7701 msgid "This uses the L<blockdev(8)> command."
7706 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7707 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7708 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7709 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7710 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7711 msgid "(Added in 0.9.3)"
7716 #: ../src/guestfs-actions.pod:674
7717 msgid "guestfs_blockdev_getbsz"
7722 #: ../src/guestfs-actions.pod:676
7726 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7727 " const char *device);\n"
7733 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7734 msgid "This returns the block size of a device."
7739 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7740 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7742 "(Note this is different from both I<size in blocks> and I<filesystem block "
7748 #: ../src/guestfs-actions.pod:691
7749 msgid "guestfs_blockdev_getro"
7754 #: ../src/guestfs-actions.pod:693
7758 " guestfs_blockdev_getro (guestfs_h *g,\n"
7759 " const char *device);\n"
7765 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7767 "Returns a boolean indicating if the block device is read-only (true if read-"
7768 "only, false if not)."
7773 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7774 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7775 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7776 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7777 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7778 #: ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3097
7779 #: ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3279
7780 #: ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3308
7781 #: ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3338
7782 #: ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3369
7783 #: ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3396
7784 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3425
7785 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:4971
7786 msgid "This function returns a C truth value on success or -1 on error."
7791 #: ../src/guestfs-actions.pod:706
7792 msgid "guestfs_blockdev_getsize64"
7797 #: ../src/guestfs-actions.pod:708
7801 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7802 " const char *device);\n"
7808 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7809 msgid "This returns the size of the device in bytes."
7814 #: ../src/guestfs-actions.pod:714
7815 msgid "See also C<guestfs_blockdev_getsz>."
7820 #: ../src/guestfs-actions.pod:722
7821 msgid "guestfs_blockdev_getss"
7826 #: ../src/guestfs-actions.pod:724
7830 " guestfs_blockdev_getss (guestfs_h *g,\n"
7831 " const char *device);\n"
7837 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7839 "This returns the size of sectors on a block device. Usually 512, but can be "
7840 "larger for modern devices."
7845 #: ../src/guestfs-actions.pod:731
7847 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7853 #: ../src/guestfs-actions.pod:740
7854 msgid "guestfs_blockdev_getsz"
7859 #: ../src/guestfs-actions.pod:742
7863 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7864 " const char *device);\n"
7870 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7872 "This returns the size of the device in units of 512-byte sectors (even if "
7873 "the sectorsize isn't 512 bytes ... weird)."
7878 #: ../src/guestfs-actions.pod:749
7880 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7881 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7886 #: ../src/guestfs-actions.pod:759
7887 msgid "guestfs_blockdev_rereadpt"
7892 #: ../src/guestfs-actions.pod:761
7896 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7897 " const char *device);\n"
7903 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7904 msgid "Reread the partition table on C<device>."
7909 #: ../src/guestfs-actions.pod:773
7910 msgid "guestfs_blockdev_setbsz"
7915 #: ../src/guestfs-actions.pod:775
7919 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7920 " const char *device,\n"
7921 " int blocksize);\n"
7927 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7928 msgid "This sets the block size of a device."
7933 #: ../src/guestfs-actions.pod:791
7934 msgid "guestfs_blockdev_setro"
7939 #: ../src/guestfs-actions.pod:793
7943 " guestfs_blockdev_setro (guestfs_h *g,\n"
7944 " const char *device);\n"
7950 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7951 msgid "Sets the block device named C<device> to read-only."
7956 #: ../src/guestfs-actions.pod:805
7957 msgid "guestfs_blockdev_setrw"
7962 #: ../src/guestfs-actions.pod:807
7966 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7967 " const char *device);\n"
7973 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7974 msgid "Sets the block device named C<device> to read-write."
7979 #: ../src/guestfs-actions.pod:819
7980 msgid "guestfs_case_sensitive_path"
7985 #: ../src/guestfs-actions.pod:821
7989 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7990 " const char *path);\n"
7996 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7998 "This can be used to resolve case insensitive paths on a filesystem which is "
7999 "case sensitive. The use case is to resolve paths which you have read from "
8000 "Windows configuration files or the Windows Registry, to the true path."
8005 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
8007 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8008 "(and probably others), which is that although the underlying filesystem is "
8009 "case-insensitive, the driver exports the filesystem to Linux as case-"
8015 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8017 "One consequence of this is that special directories such as C<c:\\windows> "
8018 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8019 "precise details of how they were created. In Windows itself this would not "
8025 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8027 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8033 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8035 "This function resolves the true case of each element in the path and returns "
8036 "the case-sensitive path."
8041 #: ../src/guestfs-actions.pod:847
8043 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8044 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8045 "how the directories were originally created under Windows)."
8050 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8051 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8056 #: ../src/guestfs-actions.pod:855
8057 msgid "See also C<guestfs_realpath>."
8062 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6962
8063 msgid "(Added in 1.0.75)"
8068 #: ../src/guestfs-actions.pod:862
8074 #: ../src/guestfs-actions.pod:864
8078 " guestfs_cat (guestfs_h *g,\n"
8079 " const char *path);\n"
8085 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5458
8086 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3659
8087 msgid "Return the contents of the file named C<path>."
8092 #: ../src/guestfs-actions.pod:870
8094 "Note that this function cannot correctly handle binary files (specifically, "
8095 "files containing C<\\0> character which is treated as end of string). For "
8096 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8097 "functions which have a more complex interface."
8102 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8103 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
8104 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
8105 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
8106 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
8107 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
8108 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
8109 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5266
8110 #: ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423
8111 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6347
8112 #: ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6548
8113 #: ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7234
8114 #: ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7286
8115 #: ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7390
8116 #: ../src/guestfs-actions.pod:7409 ../src/guestfs-actions.pod:7455
8117 #: ../src/guestfs-actions.pod:7474 ../fish/guestfish-actions.pod:587
8118 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8119 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8120 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8121 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8122 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8123 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8124 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3529
8125 #: ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3620
8126 #: ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652
8127 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4324
8128 #: ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4424
8129 #: ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4852
8130 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
8131 #: ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4937
8132 #: ../fish/guestfish-actions.pod:4966 ../fish/guestfish-actions.pod:4976
8134 "Because of the message protocol, there is a transfer limit of somewhere "
8135 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8140 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3556
8141 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3635
8142 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4128
8143 #: ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:5346
8144 #: ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:7121
8145 #: ../src/guestfs-actions.pod:7135
8146 msgid "(Added in 0.4)"
8151 #: ../src/guestfs-actions.pod:883
8152 msgid "guestfs_checksum"
8157 #: ../src/guestfs-actions.pod:885
8161 " guestfs_checksum (guestfs_h *g,\n"
8162 " const char *csumtype,\n"
8163 " const char *path);\n"
8169 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8171 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8176 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8178 "The type of checksum to compute is given by the C<csumtype> parameter which "
8179 "must have one of the following values:"
8184 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8190 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8192 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8198 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8204 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8205 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8210 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8216 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8217 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8222 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8228 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8229 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8234 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8240 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8241 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8246 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8252 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8253 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8258 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8264 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8265 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8270 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8271 msgid "The checksum is returned as a printable string."
8276 #: ../src/guestfs-actions.pod:931
8277 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8282 #: ../src/guestfs-actions.pod:933
8283 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8288 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8289 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3295
8290 #: ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3385
8291 #: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:6818
8292 msgid "(Added in 1.0.2)"
8297 #: ../src/guestfs-actions.pod:940
8298 msgid "guestfs_checksum_device"
8303 #: ../src/guestfs-actions.pod:942
8307 " guestfs_checksum_device (guestfs_h *g,\n"
8308 " const char *csumtype,\n"
8309 " const char *device);\n"
8315 #: ../src/guestfs-actions.pod:947
8317 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8318 "device named C<device>. For the types of checksums supported see the "
8319 "C<guestfs_checksum> command."
8324 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4877
8325 #: ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4973
8326 #: ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5167
8327 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741
8328 #: ../src/guestfs-actions.pod:7147
8329 msgid "(Added in 1.3.2)"
8334 #: ../src/guestfs-actions.pod:956
8335 msgid "guestfs_checksums_out"
8340 #: ../src/guestfs-actions.pod:958
8344 " guestfs_checksums_out (guestfs_h *g,\n"
8345 " const char *csumtype,\n"
8346 " const char *directory,\n"
8347 " const char *sumsfile);\n"
8353 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8355 "This command computes the checksums of all regular files in C<directory> and "
8356 "then emits a list of those checksums to the local output file C<sumsfile>."
8361 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8363 "This can be used for verifying the integrity of a virtual machine. However "
8364 "to be properly secure you should pay attention to the output of the checksum "
8365 "command (it uses the ones from GNU coreutils). In particular when the "
8366 "filename is not printable, coreutils uses a special backslash syntax. For "
8367 "more information, see the GNU coreutils info file."
8372 #: ../src/guestfs-actions.pod:978
8373 msgid "(Added in 1.3.7)"
8378 #: ../src/guestfs-actions.pod:980
8379 msgid "guestfs_chmod"
8384 #: ../src/guestfs-actions.pod:982
8388 " guestfs_chmod (guestfs_h *g,\n"
8390 " const char *path);\n"
8396 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8398 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8404 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8406 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8407 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8413 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4379
8414 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4595
8415 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:676
8416 #: ../fish/guestfish-actions.pod:2975 ../fish/guestfish-actions.pod:3104
8417 #: ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124
8418 msgid "The mode actually set is affected by the umask."
8423 #: ../src/guestfs-actions.pod:1000
8424 msgid "guestfs_chown"
8429 #: ../src/guestfs-actions.pod:1002
8433 " guestfs_chown (guestfs_h *g,\n"
8436 " const char *path);\n"
8442 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8443 msgid "Change the file owner to C<owner> and group to C<group>."
8448 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3487
8449 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2433
8451 "Only numeric uid and gid are supported. If you want to use names, you will "
8452 "need to locate and parse the password file yourself (Augeas support makes "
8453 "this relatively easy)."
8458 #: ../src/guestfs-actions.pod:1018
8459 msgid "guestfs_command"
8464 #: ../src/guestfs-actions.pod:1020
8468 " guestfs_command (guestfs_h *g,\n"
8469 " char *const *arguments);\n"
8475 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8477 "This call runs a command from the guest filesystem. The filesystem must be "
8478 "mounted, and must contain a compatible operating system (ie. something "
8479 "Linux, with the same or compatible processor architecture)."
8484 #: ../src/guestfs-actions.pod:1029
8486 "The single parameter is an argv-style list of arguments. The first element "
8487 "is the name of the program to run. Subsequent elements are parameters. The "
8488 "list must be non-empty (ie. must contain a program name). Note that the "
8489 "command runs directly, and is I<not> invoked via the shell (see "
8495 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8496 msgid "The return value is anything printed to I<stdout> by the command."
8501 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8503 "If the command returns a non-zero exit status, then this function returns an "
8504 "error message. The error message string is the content of I<stderr> from "
8510 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8512 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8513 "bin>. If you require a program from another location, you should provide "
8514 "the full path in the first parameter."
8519 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8521 "Shared libraries and data files required by the program must be available on "
8522 "filesystems which are mounted in the correct places. It is the caller's "
8523 "responsibility to ensure all filesystems that are needed are mounted at the "
8529 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8530 #: ../src/guestfs-actions.pod:1548
8531 msgid "(Added in 0.9.1)"
8536 #: ../src/guestfs-actions.pod:1062
8537 msgid "guestfs_command_lines"
8542 #: ../src/guestfs-actions.pod:1064
8546 " guestfs_command_lines (guestfs_h *g,\n"
8547 " char *const *arguments);\n"
8553 #: ../src/guestfs-actions.pod:1068
8555 "This is the same as C<guestfs_command>, but splits the result into a list of "
8561 #: ../src/guestfs-actions.pod:1071
8562 msgid "See also: C<guestfs_sh_lines>"
8567 #: ../src/guestfs-actions.pod:1082
8568 msgid "guestfs_config"
8573 #: ../src/guestfs-actions.pod:1084
8577 " guestfs_config (guestfs_h *g,\n"
8578 " const char *qemuparam,\n"
8579 " const char *qemuvalue);\n"
8585 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8587 "This can be used to add arbitrary qemu command line parameters of the form "
8588 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8589 "setting some parameters which would interfere with parameters that we use."
8594 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8595 msgid "The first character of C<param> string must be a C<-> (dash)."
8600 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8601 msgid "C<value> can be NULL."
8606 #: ../src/guestfs-actions.pod:1102
8607 msgid "guestfs_copy_size"
8612 #: ../src/guestfs-actions.pod:1104
8616 " guestfs_copy_size (guestfs_h *g,\n"
8617 " const char *src,\n"
8618 " const char *dest,\n"
8625 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8627 "This command copies exactly C<size> bytes from one source device or file "
8628 "C<src> to another destination device or file C<dest>."
8633 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8635 "Note this will fail if the source is too short or if the destination is not "
8640 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8641 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8642 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
8643 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:6813
8644 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:7326
8645 #: ../src/guestfs-actions.pod:7345
8647 "This long-running command can generate progress notification messages so "
8648 "that the caller can display a progress bar or indicator. To receive these "
8649 "messages, the caller must register a progress event callback. See L<guestfs"
8650 "(3)/GUESTFS_EVENT_PROGRESS>."
8655 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4155
8656 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:7054
8657 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7160
8658 msgid "(Added in 1.0.87)"
8663 #: ../src/guestfs-actions.pod:1125
8669 #: ../src/guestfs-actions.pod:1127
8673 " guestfs_cp (guestfs_h *g,\n"
8674 " const char *src,\n"
8675 " const char *dest);\n"
8681 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8683 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8684 "destination filename or destination directory."
8689 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8690 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8691 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4840
8692 #: ../src/guestfs-actions.pod:5217
8693 msgid "(Added in 1.0.18)"
8698 #: ../src/guestfs-actions.pod:1139
8699 msgid "guestfs_cp_a"
8704 #: ../src/guestfs-actions.pod:1141
8708 " guestfs_cp_a (guestfs_h *g,\n"
8709 " const char *src,\n"
8710 " const char *dest);\n"
8716 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8718 "This copies a file or directory from C<src> to C<dest> recursively using the "
8724 #: ../src/guestfs-actions.pod:1153
8730 #: ../src/guestfs-actions.pod:1155
8734 " guestfs_dd (guestfs_h *g,\n"
8735 " const char *src,\n"
8736 " const char *dest);\n"
8742 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8744 "This command copies from one source device or file C<src> to another "
8745 "destination device or file C<dest>. Normally you would use this to copy to "
8746 "or from a device or partition, for example to duplicate a filesystem."
8751 #: ../src/guestfs-actions.pod:1165
8753 "If the destination is a device, it must be as large or larger than the "
8754 "source file or device, otherwise the copy will fail. This command cannot do "
8755 "partial copies (see C<guestfs_copy_size>)."
8760 #: ../src/guestfs-actions.pod:1173
8766 #: ../src/guestfs-actions.pod:1175
8770 " guestfs_df (guestfs_h *g);\n"
8776 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8777 msgid "This command runs the C<df> command to report disk space used."
8782 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8784 "This command is mostly useful for interactive sessions. It is I<not> "
8785 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8791 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8792 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8793 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8794 #: ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4740
8795 #: ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6575
8796 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7206
8797 #: ../src/guestfs-actions.pod:7219
8798 msgid "(Added in 1.0.54)"
8803 #: ../src/guestfs-actions.pod:1189
8804 msgid "guestfs_df_h"
8809 #: ../src/guestfs-actions.pod:1191
8813 " guestfs_df_h (guestfs_h *g);\n"
8819 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8821 "This command runs the C<df -h> command to report disk space used in human-"
8827 #: ../src/guestfs-actions.pod:1206
8828 msgid "guestfs_dmesg"
8833 #: ../src/guestfs-actions.pod:1208
8837 " guestfs_dmesg (guestfs_h *g);\n"
8843 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8845 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8846 "This is sometimes useful for extended debugging of problems."
8851 #: ../src/guestfs-actions.pod:1215
8853 "Another way to get the same information is to enable verbose messages with "
8854 "C<guestfs_set_verbose> or by setting the environment variable "
8855 "C<LIBGUESTFS_DEBUG=1> before running the program."
8860 #: ../src/guestfs-actions.pod:1225
8861 msgid "guestfs_download"
8866 #: ../src/guestfs-actions.pod:1227
8870 " guestfs_download (guestfs_h *g,\n"
8871 " const char *remotefilename,\n"
8872 " const char *filename);\n"
8878 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8879 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8881 "Download file C<remotefilename> and save it as C<filename> on the local "
8887 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6807
8888 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4582
8889 msgid "C<filename> can also be a named pipe."
8894 #: ../src/guestfs-actions.pod:1237
8895 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8900 #: ../src/guestfs-actions.pod:1248
8901 msgid "guestfs_download_offset"
8906 #: ../src/guestfs-actions.pod:1250
8910 " guestfs_download_offset (guestfs_h *g,\n"
8911 " const char *remotefilename,\n"
8912 " const char *filename,\n"
8913 " int64_t offset,\n"
8920 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8922 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8923 "region must be within the file or device)."
8928 #: ../src/guestfs-actions.pod:1263
8930 "Note that there is no limit on the amount of data that can be downloaded "
8931 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8932 "full amount unless an error occurs."
8937 #: ../src/guestfs-actions.pod:1268
8938 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8943 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6852
8944 msgid "(Added in 1.5.17)"
8949 #: ../src/guestfs-actions.pod:1279
8950 msgid "guestfs_drop_caches"
8955 #: ../src/guestfs-actions.pod:1281
8959 " guestfs_drop_caches (guestfs_h *g,\n"
8960 " int whattodrop);\n"
8966 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8968 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8969 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8970 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8975 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8976 msgid "Setting C<whattodrop> to 3 should drop everything."
8981 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8983 "This automatically calls L<sync(2)> before the operation, so that the "
8984 "maximum guest memory is freed."
8989 #: ../src/guestfs-actions.pod:1299
8995 #: ../src/guestfs-actions.pod:1301
8999 " guestfs_du (guestfs_h *g,\n"
9000 " const char *path);\n"
9006 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
9008 "This command runs the C<du -s> command to estimate file space usage for "
9014 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
9016 "C<path> can be a file or a directory. If C<path> is a directory then the "
9017 "estimate includes the contents of the directory and all subdirectories "
9023 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9025 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9030 #: ../src/guestfs-actions.pod:1324
9031 msgid "guestfs_e2fsck_f"
9036 #: ../src/guestfs-actions.pod:1326
9040 " guestfs_e2fsck_f (guestfs_h *g,\n"
9041 " const char *device);\n"
9047 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
9049 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9050 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
9056 #: ../src/guestfs-actions.pod:1334
9058 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9059 "Normally you should use C<guestfs_fsck>."
9064 #: ../src/guestfs-actions.pod:1339
9065 msgid "(Added in 1.0.29)"
9070 #: ../src/guestfs-actions.pod:1341
9071 msgid "guestfs_echo_daemon"
9076 #: ../src/guestfs-actions.pod:1343
9080 " guestfs_echo_daemon (guestfs_h *g,\n"
9081 " char *const *words);\n"
9087 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
9089 "This command concatenates the list of C<words> passed with single spaces "
9090 "between them and returns the resulting string."
9095 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
9096 msgid "You can use this command to test the connection through to the daemon."
9101 #: ../src/guestfs-actions.pod:1352
9102 msgid "See also C<guestfs_ping_daemon>."
9107 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
9108 #: ../src/guestfs-actions.pod:6051
9109 msgid "(Added in 1.0.69)"
9114 #: ../src/guestfs-actions.pod:1359
9115 msgid "guestfs_egrep"
9120 #: ../src/guestfs-actions.pod:1361
9124 " guestfs_egrep (guestfs_h *g,\n"
9125 " const char *regex,\n"
9126 " const char *path);\n"
9132 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
9134 "This calls the external C<egrep> program and returns the matching lines."
9139 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
9140 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
9141 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
9142 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
9143 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
9144 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
9145 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3648
9146 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675
9147 #: ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:4675
9148 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5600
9149 #: ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6431
9150 #: ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6457
9151 #: ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492
9152 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518
9153 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7308
9154 #: ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7412
9155 #: ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7477
9156 msgid "(Added in 1.0.66)"
9161 #: ../src/guestfs-actions.pod:1378
9162 msgid "guestfs_egrepi"
9167 #: ../src/guestfs-actions.pod:1380
9171 " guestfs_egrepi (guestfs_h *g,\n"
9172 " const char *regex,\n"
9173 " const char *path);\n"
9179 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
9181 "This calls the external C<egrep -i> program and returns the matching lines."
9186 #: ../src/guestfs-actions.pod:1397
9187 msgid "guestfs_equal"
9192 #: ../src/guestfs-actions.pod:1399
9196 " guestfs_equal (guestfs_h *g,\n"
9197 " const char *file1,\n"
9198 " const char *file2);\n"
9204 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
9206 "This compares the two files C<file1> and C<file2> and returns true if their "
9207 "content is exactly equal, or false otherwise."
9212 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
9213 msgid "The external L<cmp(1)> program is used for the comparison."
9218 #: ../src/guestfs-actions.pod:1413
9219 msgid "guestfs_exists"
9224 #: ../src/guestfs-actions.pod:1415
9228 " guestfs_exists (guestfs_h *g,\n"
9229 " const char *path);\n"
9235 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
9237 "This returns C<true> if and only if there is a file, directory (or anything) "
9238 "with the given C<path> name."
9243 #: ../src/guestfs-actions.pod:1422
9244 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9249 #: ../src/guestfs-actions.pod:1428
9250 msgid "guestfs_fallocate"
9255 #: ../src/guestfs-actions.pod:1430
9259 " guestfs_fallocate (guestfs_h *g,\n"
9260 " const char *path,\n"
9267 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
9268 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9270 "This command preallocates a file (containing zero bytes) named C<path> of "
9271 "size C<len> bytes. If the file exists already, it is overwritten."
9276 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
9278 "Do not confuse this with the guestfish-specific C<alloc> command which "
9279 "allocates a file in the host and attaches it as a device."
9284 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
9286 "This function is deprecated. In new code, use the C<fallocate64> call "
9292 #: ../src/guestfs-actions.pod:1454
9293 msgid "guestfs_fallocate64"
9298 #: ../src/guestfs-actions.pod:1456
9302 " guestfs_fallocate64 (guestfs_h *g,\n"
9303 " const char *path,\n"
9310 #: ../src/guestfs-actions.pod:1465
9312 "Note that this call allocates disk blocks for the file. To create a sparse "
9313 "file use C<guestfs_truncate_size> instead."
9318 #: ../src/guestfs-actions.pod:1468
9320 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9321 "oversight it only allowed 30 bit lengths to be specified, effectively "
9322 "limiting the maximum size of files created through that call to 1GB."
9327 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
9329 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9330 "commands which create a file in the host and attach it as a device."
9335 #: ../src/guestfs-actions.pod:1479
9336 msgid "(Added in 1.3.17)"
9341 #: ../src/guestfs-actions.pod:1481
9342 msgid "guestfs_fgrep"
9347 #: ../src/guestfs-actions.pod:1483
9351 " guestfs_fgrep (guestfs_h *g,\n"
9352 " const char *pattern,\n"
9353 " const char *path);\n"
9359 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
9361 "This calls the external C<fgrep> program and returns the matching lines."
9366 #: ../src/guestfs-actions.pod:1500
9367 msgid "guestfs_fgrepi"
9372 #: ../src/guestfs-actions.pod:1502
9376 " guestfs_fgrepi (guestfs_h *g,\n"
9377 " const char *pattern,\n"
9378 " const char *path);\n"
9384 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
9386 "This calls the external C<fgrep -i> program and returns the matching lines."
9391 #: ../src/guestfs-actions.pod:1519
9392 msgid "guestfs_file"
9397 #: ../src/guestfs-actions.pod:1521
9401 " guestfs_file (guestfs_h *g,\n"
9402 " const char *path);\n"
9408 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
9410 "This call uses the standard L<file(1)> command to determine the type or "
9411 "contents of the file."
9416 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
9418 "This call will also transparently look inside various types of compressed "
9424 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
9426 "The exact command which runs is C<file -zb path>. Note in particular that "
9427 "the filename is not prepended to the output (the C<-b> option)."
9432 #: ../src/guestfs-actions.pod:1535
9434 "This command can also be used on C</dev/> devices (and partitions, LV "
9435 "names). You can for example use this to determine if a device contains a "
9436 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9441 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
9443 "If the C<path> does not begin with C</dev/> then this command only works for "
9444 "the content of regular files. For other file types (directory, symbolic "
9445 "link etc) it will just return the string C<directory> etc."
9450 #: ../src/guestfs-actions.pod:1550
9451 msgid "guestfs_file_architecture"
9456 #: ../src/guestfs-actions.pod:1552
9460 " guestfs_file_architecture (guestfs_h *g,\n"
9461 " const char *filename);\n"
9467 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
9469 "This detects the architecture of the binary C<filename>, and returns it if "
9475 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
9476 msgid "Currently defined architectures are:"
9481 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
9487 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9489 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9490 "irrespective of the precise processor requirements of the binary."
9495 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
9501 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
9502 msgid "64 bit x86-64."
9507 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
9513 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
9514 msgid "32 bit SPARC."
9519 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
9525 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
9526 msgid "64 bit SPARC V9 and above."
9531 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
9537 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
9538 msgid "Intel Itanium."
9543 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
9549 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
9550 msgid "32 bit Power PC."
9555 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
9561 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
9562 msgid "64 bit Power PC."
9567 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
9568 msgid "Libguestfs may return other architecture strings in future."
9573 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
9574 msgid "The function works on at least the following types of files:"
9579 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
9580 msgid "many types of Un*x and Linux binary"
9585 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
9586 msgid "many types of Un*x and Linux shared library"
9591 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
9592 msgid "Windows Win32 and Win64 binaries"
9597 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
9598 msgid "Windows Win32 and Win64 DLLs"
9603 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
9604 msgid "Win32 binaries and DLLs return C<i386>."
9609 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
9610 msgid "Win64 binaries and DLLs return C<x86_64>."
9615 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
9616 msgid "Linux kernel modules"
9621 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
9622 msgid "Linux new-style initrd images"
9627 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
9628 msgid "some non-x86 Linux vmlinuz kernels"
9633 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
9634 msgid "What it can't do currently:"
9639 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
9640 msgid "static libraries (libfoo.a)"
9645 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
9646 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9651 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
9652 msgid "x86 Linux vmlinuz kernels"
9657 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
9659 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9660 "compressed code, and are horribly hard to unpack. If you want to find the "
9661 "architecture of a kernel, use the architecture of the associated initrd or "
9662 "kernel module(s) instead."
9667 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
9668 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
9669 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686
9670 #: ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795
9671 #: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922
9672 #: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266
9673 #: ../src/guestfs-actions.pod:3398
9674 msgid "(Added in 1.5.3)"
9679 #: ../src/guestfs-actions.pod:1662
9680 msgid "guestfs_filesize"
9685 #: ../src/guestfs-actions.pod:1664
9689 " guestfs_filesize (guestfs_h *g,\n"
9690 " const char *file);\n"
9696 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
9697 msgid "This command returns the size of C<file> in bytes."
9702 #: ../src/guestfs-actions.pod:1670
9704 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9705 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9706 "devices, use C<guestfs_blockdev_getsize64>."
9711 #: ../src/guestfs-actions.pod:1676
9712 msgid "(Added in 1.0.82)"
9717 #: ../src/guestfs-actions.pod:1678
9718 msgid "guestfs_fill"
9723 #: ../src/guestfs-actions.pod:1680
9727 " guestfs_fill (guestfs_h *g,\n"
9730 " const char *path);\n"
9736 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
9738 "This command creates a new file called C<path>. The initial content of the "
9739 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9745 #: ../src/guestfs-actions.pod:1690
9747 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9748 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9749 "bytes use C<guestfs_fill_pattern>."
9754 #: ../src/guestfs-actions.pod:1702
9755 msgid "(Added in 1.0.79)"
9760 #: ../src/guestfs-actions.pod:1704
9761 msgid "guestfs_fill_pattern"
9766 #: ../src/guestfs-actions.pod:1706
9770 " guestfs_fill_pattern (guestfs_h *g,\n"
9771 " const char *pattern,\n"
9773 " const char *path);\n"
9779 #: ../src/guestfs-actions.pod:1712
9781 "This function is like C<guestfs_fill> except that it creates a new file of "
9782 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9783 "pattern is truncated if necessary to ensure the length of the file is "
9784 "exactly C<len> bytes."
9789 #: ../src/guestfs-actions.pod:1724
9790 msgid "(Added in 1.3.12)"
9795 #: ../src/guestfs-actions.pod:1726
9796 msgid "guestfs_find"
9801 #: ../src/guestfs-actions.pod:1728
9805 " guestfs_find (guestfs_h *g,\n"
9806 " const char *directory);\n"
9812 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
9814 "This command lists out all files and directories, recursively, starting at "
9815 "C<directory>. It is essentially equivalent to running the shell command "
9816 "C<find directory -print> but some post-processing happens on the output, "
9822 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9824 "This returns a list of strings I<without any prefix>. Thus if the directory "
9830 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
9841 #: ../src/guestfs-actions.pod:1744
9843 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9848 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
9860 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
9861 msgid "If C<directory> is not a directory, then this command returns an error."
9866 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
9867 msgid "The returned list is sorted."
9872 #: ../src/guestfs-actions.pod:1757
9873 msgid "See also C<guestfs_find0>."
9878 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092
9879 #: ../src/guestfs-actions.pod:5635
9880 msgid "(Added in 1.0.27)"
9885 #: ../src/guestfs-actions.pod:1768
9886 msgid "guestfs_find0"
9891 #: ../src/guestfs-actions.pod:1770
9895 " guestfs_find0 (guestfs_h *g,\n"
9896 " const char *directory,\n"
9897 " const char *files);\n"
9903 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
9905 "This command lists out all files and directories, recursively, starting at "
9906 "C<directory>, placing the resulting list in the external file called "
9912 #: ../src/guestfs-actions.pod:1779
9914 "This command works the same way as C<guestfs_find> with the following "
9920 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
9921 msgid "The resulting list is written to an external file."
9926 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9928 "Items (filenames) in the result are separated by C<\\0> characters. See "
9929 "L<find(1)> option I<-print0>."
9934 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9935 msgid "This command is not limited in the number of names that it can return."
9940 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9941 msgid "The result list is not sorted."
9946 #: ../src/guestfs-actions.pod:1806
9947 msgid "(Added in 1.0.74)"
9952 #: ../src/guestfs-actions.pod:1808
9953 msgid "guestfs_findfs_label"
9958 #: ../src/guestfs-actions.pod:1810
9962 " guestfs_findfs_label (guestfs_h *g,\n"
9963 " const char *label);\n"
9969 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9971 "This command searches the filesystems and returns the one which has the "
9972 "given label. An error is returned if no such filesystem can be found."
9977 #: ../src/guestfs-actions.pod:1818
9978 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9983 #: ../src/guestfs-actions.pod:1825
9984 msgid "guestfs_findfs_uuid"
9989 #: ../src/guestfs-actions.pod:1827
9993 " guestfs_findfs_uuid (guestfs_h *g,\n"
9994 " const char *uuid);\n"
10000 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
10002 "This command searches the filesystems and returns the one which has the "
10003 "given UUID. An error is returned if no such filesystem can be found."
10008 #: ../src/guestfs-actions.pod:1835
10009 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10014 #: ../src/guestfs-actions.pod:1842
10015 msgid "guestfs_fsck"
10020 #: ../src/guestfs-actions.pod:1844
10024 " guestfs_fsck (guestfs_h *g,\n"
10025 " const char *fstype,\n"
10026 " const char *device);\n"
10032 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
10034 "This runs the filesystem checker (fsck) on C<device> which should have "
10035 "filesystem type C<fstype>."
10040 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
10042 "The returned integer is the status. See L<fsck(8)> for the list of status "
10043 "codes from C<fsck>."
10048 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
10049 msgid "Multiple status codes can be summed together."
10054 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
10056 "A non-zero return code can mean \"success\", for example if errors have been "
10057 "corrected on the filesystem."
10062 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
10063 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10068 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
10070 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10075 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331
10076 msgid "(Added in 1.0.16)"
10081 #: ../src/guestfs-actions.pod:1881
10082 msgid "guestfs_get_append"
10087 #: ../src/guestfs-actions.pod:1883
10091 " guestfs_get_append (guestfs_h *g);\n"
10097 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
10099 "Return the additional kernel options which are added to the guest kernel "
10105 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
10106 msgid "If C<NULL> then no options are added."
10111 #: ../src/guestfs-actions.pod:1891
10113 "This function returns a string which may be NULL. There is no way to return "
10114 "an error from this function. The string is owned by the guest handle and "
10115 "must I<not> be freed."
10120 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313
10121 #: ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193
10122 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228
10123 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002
10124 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374
10125 msgid "(Added in 1.0.26)"
10129 #: ../src/guestfs-actions.pod:1897
10130 msgid "guestfs_get_attach_method"
10134 #: ../src/guestfs-actions.pod:1899
10138 " guestfs_get_attach_method (guestfs_h *g);\n"
10143 #: ../src/guestfs-actions.pod:1902
10144 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10149 #: ../src/guestfs-actions.pod:1907
10150 msgid "guestfs_get_autosync"
10155 #: ../src/guestfs-actions.pod:1909
10159 " guestfs_get_autosync (guestfs_h *g);\n"
10165 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
10166 msgid "Get the autosync flag."
10171 #: ../src/guestfs-actions.pod:1918
10172 msgid "guestfs_get_direct"
10177 #: ../src/guestfs-actions.pod:1920
10181 " guestfs_get_direct (guestfs_h *g);\n"
10187 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
10188 msgid "Return the direct appliance mode flag."
10193 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862
10194 msgid "(Added in 1.0.72)"
10199 #: ../src/guestfs-actions.pod:1929
10200 msgid "guestfs_get_e2label"
10205 #: ../src/guestfs-actions.pod:1931
10209 " guestfs_get_e2label (guestfs_h *g,\n"
10210 " const char *device);\n"
10216 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
10218 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10223 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
10225 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10230 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
10231 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899
10232 msgid "(Added in 1.0.15)"
10237 #: ../src/guestfs-actions.pod:1950
10238 msgid "guestfs_get_e2uuid"
10243 #: ../src/guestfs-actions.pod:1952
10247 " guestfs_get_e2uuid (guestfs_h *g,\n"
10248 " const char *device);\n"
10254 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
10256 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10261 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
10263 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10268 #: ../src/guestfs-actions.pod:1971
10269 msgid "guestfs_get_memsize"
10274 #: ../src/guestfs-actions.pod:1973
10278 " guestfs_get_memsize (guestfs_h *g);\n"
10284 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
10286 "This gets the memory size in megabytes allocated to the qemu subprocess."
10291 #: ../src/guestfs-actions.pod:1979
10293 "If C<guestfs_set_memsize> was not called on this handle, and if "
10294 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10295 "value for memsize."
10300 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
10301 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022
10302 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10303 #: ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072
10305 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10310 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383
10311 #: ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599
10312 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630
10313 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660
10314 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920
10315 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768
10316 msgid "(Added in 1.0.55)"
10321 #: ../src/guestfs-actions.pod:1990
10322 msgid "guestfs_get_network"
10327 #: ../src/guestfs-actions.pod:1992
10331 " guestfs_get_network (guestfs_h *g);\n"
10337 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
10338 msgid "This returns the enable network flag."
10343 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939
10344 msgid "(Added in 1.5.4)"
10349 #: ../src/guestfs-actions.pod:2001
10350 msgid "guestfs_get_path"
10355 #: ../src/guestfs-actions.pod:2003
10359 " guestfs_get_path (guestfs_h *g);\n"
10365 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
10366 msgid "Return the current search path."
10371 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
10373 "This is always non-NULL. If it wasn't set already, then this will return "
10374 "the default path."
10379 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
10381 "This function returns a string, or NULL on error. The string is owned by "
10382 "the guest handle and must I<not> be freed."
10387 #: ../src/guestfs-actions.pod:2016
10388 msgid "guestfs_get_pid"
10393 #: ../src/guestfs-actions.pod:2018
10397 " guestfs_get_pid (guestfs_h *g);\n"
10403 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
10405 "Return the process ID of the qemu subprocess. If there is no qemu "
10406 "subprocess, then this will return an error."
10411 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
10412 msgid "This is an internal call used for debugging and testing."
10417 #: ../src/guestfs-actions.pod:2028
10418 msgid "(Added in 1.0.56)"
10423 #: ../src/guestfs-actions.pod:2030
10424 msgid "guestfs_get_qemu"
10429 #: ../src/guestfs-actions.pod:2032
10433 " guestfs_get_qemu (guestfs_h *g);\n"
10439 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
10440 msgid "Return the current qemu binary."
10445 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
10447 "This is always non-NULL. If it wasn't set already, then this will return "
10448 "the default qemu binary name."
10453 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984
10454 msgid "(Added in 1.0.6)"
10459 #: ../src/guestfs-actions.pod:2045
10460 msgid "guestfs_get_recovery_proc"
10465 #: ../src/guestfs-actions.pod:2047
10469 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10475 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
10476 msgid "Return the recovery process enabled flag."
10481 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493
10482 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190
10483 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243
10484 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008
10485 #: ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691
10486 #: ../src/guestfs-actions.pod:6883
10487 msgid "(Added in 1.0.77)"
10492 #: ../src/guestfs-actions.pod:2056
10493 msgid "guestfs_get_selinux"
10498 #: ../src/guestfs-actions.pod:2058
10502 " guestfs_get_selinux (guestfs_h *g);\n"
10508 #: ../src/guestfs-actions.pod:2061
10510 "This returns the current setting of the selinux flag which is passed to the "
10511 "appliance at boot time. See C<guestfs_set_selinux>."
10516 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
10517 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085
10518 msgid "(Added in 1.0.67)"
10523 #: ../src/guestfs-actions.pod:2071
10524 msgid "guestfs_get_state"
10529 #: ../src/guestfs-actions.pod:2073
10533 " guestfs_get_state (guestfs_h *g);\n"
10539 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
10541 "This returns the current state as an opaque integer. This is only useful "
10542 "for printing debug and internal error messages."
10547 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291
10548 #: ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381
10549 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409
10550 #: ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333
10551 #: ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387
10552 msgid "For more information on states, see L<guestfs(3)>."
10557 #: ../src/guestfs-actions.pod:2085
10558 msgid "guestfs_get_trace"
10563 #: ../src/guestfs-actions.pod:2087
10567 " guestfs_get_trace (guestfs_h *g);\n"
10573 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
10574 msgid "Return the command trace flag."
10579 #: ../src/guestfs-actions.pod:2096
10580 msgid "guestfs_get_umask"
10585 #: ../src/guestfs-actions.pod:2098
10589 " guestfs_get_umask (guestfs_h *g);\n"
10595 #: ../src/guestfs-actions.pod:2101
10597 "Return the current umask. By default the umask is C<022> unless it has been "
10598 "set by calling C<guestfs_umask>."
10603 #: ../src/guestfs-actions.pod:2108
10604 msgid "guestfs_get_verbose"
10609 #: ../src/guestfs-actions.pod:2110
10613 " guestfs_get_verbose (guestfs_h *g);\n"
10619 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
10620 msgid "This returns the verbose messages flag."
10625 #: ../src/guestfs-actions.pod:2119
10626 msgid "guestfs_getcon"
10631 #: ../src/guestfs-actions.pod:2121
10635 " guestfs_getcon (guestfs_h *g);\n"
10641 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
10642 msgid "This gets the SELinux security context of the daemon."
10647 #: ../src/guestfs-actions.pod:2126
10649 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10654 #: ../src/guestfs-actions.pod:2134
10655 msgid "guestfs_getxattr"
10660 #: ../src/guestfs-actions.pod:2136
10664 " guestfs_getxattr (guestfs_h *g,\n"
10665 " const char *path,\n"
10666 " const char *name,\n"
10667 " size_t *size_r);\n"
10673 #: ../src/guestfs-actions.pod:2142
10675 "Get a single extended attribute from file C<path> named C<name>. This call "
10676 "follows symlinks. If you want to lookup an extended attribute for the "
10677 "symlink itself, use C<guestfs_lgetxattr>."
10682 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507
10684 "Normally it is better to get all extended attributes from a file in one go "
10685 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10686 "implementations are buggy and do not provide a way to list out attributes. "
10687 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10688 "extended attributes you want in advance and call this function."
10693 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514
10694 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452
10696 "Extended attribute values are blobs of binary data. If there is no extended "
10697 "attribute named C<name>, this returns an error."
10702 #: ../src/guestfs-actions.pod:2156
10703 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10708 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
10709 #: ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236
10710 #: ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443
10712 "This function returns a buffer, or NULL on error. The size of the returned "
10713 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10718 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523
10719 msgid "(Added in 1.7.24)"
10724 #: ../src/guestfs-actions.pod:2164
10725 msgid "guestfs_getxattrs"
10730 #: ../src/guestfs-actions.pod:2166
10733 " struct guestfs_xattr_list *\n"
10734 " guestfs_getxattrs (guestfs_h *g,\n"
10735 " const char *path);\n"
10741 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
10743 "This call lists the extended attributes of the file or directory C<path>."
10748 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
10750 "At the system call level, this is a combination of the L<listxattr(2)> and "
10751 "L<getxattr(2)> calls."
10756 #: ../src/guestfs-actions.pod:2176
10757 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10762 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535
10763 #: ../src/guestfs-actions.pod:4186
10765 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10766 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10771 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539
10772 #: ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740
10773 #: ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104
10774 #: ../src/guestfs-actions.pod:7439
10775 msgid "(Added in 1.0.59)"
10780 #: ../src/guestfs-actions.pod:2184
10781 msgid "guestfs_glob_expand"
10786 #: ../src/guestfs-actions.pod:2186
10790 " guestfs_glob_expand (guestfs_h *g,\n"
10791 " const char *pattern);\n"
10797 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
10799 "This command searches for all the pathnames matching C<pattern> according to "
10800 "the wildcard expansion rules used by the shell."
10805 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
10807 "If no paths match, then this returns an empty list (note: not an error)."
10812 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
10814 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10815 "GLOB_BRACE>. See that manual page for more details."
10820 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269
10821 #: ../src/guestfs-actions.pod:6286
10822 msgid "(Added in 1.0.50)"
10827 #: ../src/guestfs-actions.pod:2207
10828 msgid "guestfs_grep"
10833 #: ../src/guestfs-actions.pod:2209
10837 " guestfs_grep (guestfs_h *g,\n"
10838 " const char *regex,\n"
10839 " const char *path);\n"
10845 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
10846 msgid "This calls the external C<grep> program and returns the matching lines."
10851 #: ../src/guestfs-actions.pod:2226
10852 msgid "guestfs_grepi"
10857 #: ../src/guestfs-actions.pod:2228
10861 " guestfs_grepi (guestfs_h *g,\n"
10862 " const char *regex,\n"
10863 " const char *path);\n"
10869 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
10871 "This calls the external C<grep -i> program and returns the matching lines."
10876 #: ../src/guestfs-actions.pod:2245
10877 msgid "guestfs_grub_install"
10882 #: ../src/guestfs-actions.pod:2247
10886 " guestfs_grub_install (guestfs_h *g,\n"
10887 " const char *root,\n"
10888 " const char *device);\n"
10894 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
10896 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10897 "the root directory being C<root>."
10902 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
10904 "Note: If grub-install reports the error \"No suitable drive was found in the "
10905 "generated device map.\" it may be that you need to create a C</boot/grub/"
10906 "device.map> file first that contains the mapping between grub device names "
10907 "and Linux device names. It is usually sufficient to create a file "
10913 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
10916 " (hd0) /dev/vda\n"
10922 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
10923 msgid "replacing C</dev/vda> with the name of the installation device."
10928 #: ../src/guestfs-actions.pod:2268
10929 msgid "(Added in 1.0.17)"
10934 #: ../src/guestfs-actions.pod:2270
10935 msgid "guestfs_head"
10940 #: ../src/guestfs-actions.pod:2272
10944 " guestfs_head (guestfs_h *g,\n"
10945 " const char *path);\n"
10951 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
10953 "This command returns up to the first 10 lines of a file as a list of strings."
10958 #: ../src/guestfs-actions.pod:2288
10959 msgid "guestfs_head_n"
10964 #: ../src/guestfs-actions.pod:2290
10968 " guestfs_head_n (guestfs_h *g,\n"
10970 " const char *path);\n"
10976 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
10978 "If the parameter C<nrlines> is a positive number, this returns the first "
10979 "C<nrlines> lines of the file C<path>."
10984 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
10986 "If the parameter C<nrlines> is a negative number, this returns lines from "
10987 "the file C<path>, excluding the last C<nrlines> lines."
10992 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566
10993 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422
10994 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10999 #: ../src/guestfs-actions.pod:2312
11000 msgid "guestfs_hexdump"
11005 #: ../src/guestfs-actions.pod:2314
11009 " guestfs_hexdump (guestfs_h *g,\n"
11010 " const char *path);\n"
11016 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
11018 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11019 "readable, canonical hex dump of the file."
11024 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350
11025 #: ../src/guestfs-actions.pod:6405
11026 msgid "(Added in 1.0.22)"
11031 #: ../src/guestfs-actions.pod:2329
11032 msgid "guestfs_initrd_cat"
11037 #: ../src/guestfs-actions.pod:2331
11041 " guestfs_initrd_cat (guestfs_h *g,\n"
11042 " const char *initrdpath,\n"
11043 " const char *filename,\n"
11044 " size_t *size_r);\n"
11050 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
11052 "This command unpacks the file C<filename> from the initrd file called "
11053 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11059 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
11061 "For example, in guestfish you could use the following command to examine the "
11062 "boot script (usually called C</init>) contained in a Linux initrd or "
11068 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
11071 " initrd-cat /boot/initrd-<version>.img init\n"
11077 #: ../src/guestfs-actions.pod:2347
11078 msgid "See also C<guestfs_initrd_list>."
11083 #: ../src/guestfs-actions.pod:2358
11084 msgid "guestfs_initrd_list"
11089 #: ../src/guestfs-actions.pod:2360
11093 " guestfs_initrd_list (guestfs_h *g,\n"
11094 " const char *path);\n"
11100 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
11101 msgid "This command lists out files contained in an initrd."
11106 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
11108 "The files are listed without any initial C</> character. The files are "
11109 "listed in the order they appear (not necessarily alphabetical). Directory "
11110 "names are listed as separate items."
11115 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
11117 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11118 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11124 #: ../src/guestfs-actions.pod:2380
11125 msgid "guestfs_inotify_add_watch"
11130 #: ../src/guestfs-actions.pod:2382
11134 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11135 " const char *path,\n"
11142 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
11143 msgid "Watch C<path> for the events listed in C<mask>."
11148 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
11150 "Note that if C<path> is a directory then events within that directory are "
11151 "watched, but this does I<not> happen recursively (in subdirectories)."
11156 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
11158 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11159 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11164 #: ../src/guestfs-actions.pod:2401
11165 msgid "guestfs_inotify_close"
11170 #: ../src/guestfs-actions.pod:2403
11174 " guestfs_inotify_close (guestfs_h *g);\n"
11180 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
11182 "This closes the inotify handle which was previously opened by inotify_init. "
11183 "It removes all watches, throws away any pending events, and deallocates all "
11189 #: ../src/guestfs-actions.pod:2414
11190 msgid "guestfs_inotify_files"
11195 #: ../src/guestfs-actions.pod:2416
11199 " guestfs_inotify_files (guestfs_h *g);\n"
11205 #: ../src/guestfs-actions.pod:2419
11207 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11208 "returns a list of pathnames of objects that were touched. The returned "
11209 "pathnames are sorted and deduplicated."
11214 #: ../src/guestfs-actions.pod:2429
11215 msgid "guestfs_inotify_init"
11220 #: ../src/guestfs-actions.pod:2431
11224 " guestfs_inotify_init (guestfs_h *g,\n"
11225 " int maxevents);\n"
11231 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
11233 "This command creates a new inotify handle. The inotify subsystem can be "
11234 "used to notify events which happen to objects in the guest filesystem."
11239 #: ../src/guestfs-actions.pod:2439
11241 "C<maxevents> is the maximum number of events which will be queued up between "
11242 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11243 "passed as C<0>, then the kernel (or previously set) default is used. For "
11244 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11245 "throws away events, but records the fact that it threw them away by setting "
11246 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11247 "C<guestfs_inotify_read>)."
11252 #: ../src/guestfs-actions.pod:2449
11254 "Before any events are generated, you have to add some watches to the "
11255 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11256 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11261 #: ../src/guestfs-actions.pod:2455
11263 "Queued up events should be read periodically by calling "
11264 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11265 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11266 "often enough then you risk the internal queue overflowing."
11271 #: ../src/guestfs-actions.pod:2462
11273 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11274 "This also removes any watches automatically."
11279 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
11281 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11282 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11283 "that there is one global inotify handle per libguestfs instance."
11288 #: ../src/guestfs-actions.pod:2475
11289 msgid "guestfs_inotify_read"
11294 #: ../src/guestfs-actions.pod:2477
11297 " struct guestfs_inotify_event_list *\n"
11298 " guestfs_inotify_read (guestfs_h *g);\n"
11304 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
11306 "Return the complete queue of events that have happened since the previous "
11312 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
11313 msgid "If no events have happened, this returns an empty list."
11318 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
11320 "I<Note>: In order to make sure that all events have been read, you must call "
11321 "this function repeatedly until it returns an empty list. The reason is that "
11322 "the call will read events up to the maximum appliance-to-host message size "
11323 "and leave remaining events in the queue."
11328 #: ../src/guestfs-actions.pod:2491
11330 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11331 "there was an error. I<The caller must call "
11332 "C<guestfs_free_inotify_event_list> after use>."
11337 #: ../src/guestfs-actions.pod:2497
11338 msgid "guestfs_inotify_rm_watch"
11343 #: ../src/guestfs-actions.pod:2499
11347 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11354 #: ../src/guestfs-actions.pod:2503
11356 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11361 #: ../src/guestfs-actions.pod:2510
11362 msgid "guestfs_inspect_get_arch"
11367 #: ../src/guestfs-actions.pod:2512
11371 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11372 " const char *root);\n"
11378 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
11379 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668
11380 #: ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733
11381 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782
11382 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846
11383 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
11384 #: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985
11385 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048
11386 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088
11387 #: ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124
11389 "This function should only be called with a root device string as returned by "
11390 "C<guestfs_inspect_os>."
11395 #: ../src/guestfs-actions.pod:2519
11397 "This returns the architecture of the inspected operating system. The "
11398 "possible return values are listed under C<guestfs_file_architecture>."
11403 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
11405 "If the architecture could not be determined, then the string C<unknown> is "
11411 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611
11412 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742
11413 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862
11414 #: ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917
11415 #: ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014
11416 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058
11417 #: ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095
11418 #: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217
11419 #: ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698
11420 #: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864
11421 #: ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900
11422 #: ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994
11423 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054
11424 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105
11425 #: ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134
11426 #: ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162
11427 #: ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295
11428 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11433 #: ../src/guestfs-actions.pod:2533
11434 msgid "guestfs_inspect_get_distro"
11439 #: ../src/guestfs-actions.pod:2535
11443 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11444 " const char *root);\n"
11450 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
11452 "This returns the distro (distribution) of the inspected operating system."
11457 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
11458 msgid "Currently defined distros are:"
11463 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
11464 msgid "\"archlinux\""
11469 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
11470 msgid "Arch Linux."
11475 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
11481 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
11487 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
11493 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
11499 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
11505 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
11511 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
11512 msgid "\"linuxmint\""
11517 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
11518 msgid "Linux Mint."
11523 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
11524 msgid "\"mandriva\""
11529 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
11535 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
11541 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
11547 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
11553 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
11559 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
11560 msgid "\"redhat-based\""
11565 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
11566 msgid "Some Red Hat-derived distro."
11571 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
11577 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
11578 msgid "Red Hat Enterprise Linux and some derivatives."
11582 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
11583 msgid "\"slackware\""
11587 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
11593 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
11599 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
11605 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713
11606 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762
11607 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080
11608 msgid "\"unknown\""
11613 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
11614 msgid "The distro could not be determined."
11619 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997
11620 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072
11621 msgid "\"windows\""
11626 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
11628 "Windows does not have distributions. This string is returned if the OS type "
11634 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719
11635 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773
11636 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086
11638 "Future versions of libguestfs may return other strings here. The caller "
11639 "should be prepared to handle any string."
11643 #: ../src/guestfs-actions.pod:2618
11644 msgid "guestfs_inspect_get_drive_mappings"
11648 #: ../src/guestfs-actions.pod:2620
11652 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
11653 " const char *root);\n"
11658 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
11660 "This call is useful for Windows which uses a primitive system of assigning "
11661 "drive letters (like \"C:\") to partitions. This inspection API examines the "
11662 "Windows Registry to find out how disks/partitions are mapped to drive "
11663 "letters, and returns a hash table as in the example below:"
11667 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791
11670 " C => /dev/vda2\n"
11671 " E => /dev/vdb1\n"
11672 " F => /dev/vdc1\n"
11677 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
11679 "Note that keys are drive letters. For Windows, the key is case insensitive "
11680 "and just contains the drive letter, without the customary colon separator "
11685 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
11687 "In future we may support other operating systems that also used drive "
11688 "letters, but the keys for those might not be case insensitive and might be "
11689 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11694 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
11696 "For Windows guests, currently only hard drive mappings are returned. "
11697 "Removable disks (eg. DVD-ROMs) are ignored."
11701 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
11703 "For guests that do not use drive mappings, or if the drive mappings could "
11704 "not be determined, this returns an empty hash table."
11708 #: ../src/guestfs-actions.pod:2652
11710 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11711 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11716 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832
11717 #: ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802
11718 #: ../src/guestfs-actions.pod:6707
11720 "This function returns a NULL-terminated array of strings, or NULL if there "
11721 "was an error. The array of strings will always have length C<2n+1>, where "
11722 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11723 "caller must free the strings and the array after use>."
11728 #: ../src/guestfs-actions.pod:2662
11729 msgid "guestfs_inspect_get_filesystems"
11734 #: ../src/guestfs-actions.pod:2664
11738 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11739 " const char *root);\n"
11745 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
11747 "This returns a list of all the filesystems that we think are associated with "
11748 "this operating system. This includes the root filesystem, other ordinary "
11749 "filesystems, and non-mounted devices like swap partitions."
11754 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
11756 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11757 "to be shared between operating systems."
11762 #: ../src/guestfs-actions.pod:2679
11764 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11765 "C<guestfs_inspect_get_mountpoints>."
11769 #: ../src/guestfs-actions.pod:2688
11770 msgid "guestfs_inspect_get_format"
11774 #: ../src/guestfs-actions.pod:2690
11778 " guestfs_inspect_get_format (guestfs_h *g,\n"
11779 " const char *root);\n"
11784 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839
11786 "This returns the format of the inspected operating system. You can use it "
11787 "to detect install images, live CDs and similar."
11791 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842
11792 msgid "Currently defined formats are:"
11796 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846
11797 msgid "\"installed\""
11801 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848
11802 msgid "This is an installed operating system."
11806 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
11807 msgid "\"installer\""
11811 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
11813 "The disk image being inspected is not an installed operating system, but a "
11814 "I<bootable> install disk, live CD, or similar."
11818 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
11819 msgid "The format of this disk image is not known."
11824 #: ../src/guestfs-actions.pod:2727
11825 msgid "guestfs_inspect_get_hostname"
11830 #: ../src/guestfs-actions.pod:2729
11834 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11835 " const char *root);\n"
11841 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
11843 "This function returns the hostname of the operating system as found by "
11844 "inspection of the guest's configuration files."
11849 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876
11851 "If the hostname could not be determined, then the string C<unknown> is "
11857 #: ../src/guestfs-actions.pod:2747
11858 msgid "(Added in 1.7.9)"
11863 #: ../src/guestfs-actions.pod:2749
11864 msgid "guestfs_inspect_get_major_version"
11869 #: ../src/guestfs-actions.pod:2751
11873 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11874 " const char *root);\n"
11880 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888
11882 "This returns the major version number of the inspected operating system."
11887 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891
11889 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11890 "popular public names used by the operating system. Notably the operating "
11891 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11892 "1). You can find out the real versions corresponding to releases of Windows "
11893 "by consulting Wikipedia or MSDN."
11898 #: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788
11899 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912
11900 msgid "If the version could not be determined, then C<0> is returned."
11905 #: ../src/guestfs-actions.pod:2776
11906 msgid "guestfs_inspect_get_minor_version"
11911 #: ../src/guestfs-actions.pod:2778
11915 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11916 " const char *root);\n"
11922 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909
11924 "This returns the minor version number of the inspected operating system."
11929 #: ../src/guestfs-actions.pod:2790
11931 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11932 "C<guestfs_inspect_get_major_version>."
11937 #: ../src/guestfs-actions.pod:2797
11938 msgid "guestfs_inspect_get_mountpoints"
11943 #: ../src/guestfs-actions.pod:2799
11947 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11948 " const char *root);\n"
11953 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924
11955 "This returns a hash of where we think the filesystems associated with this "
11956 "operating system should be mounted. Callers should note that this is at "
11957 "best an educated guess made by reading configuration files such as C</etc/"
11958 "fstab>. I<In particular note> that this may return filesystems which are "
11959 "non-existent or not mountable and callers should be prepared to handle or "
11960 "ignore failures if they try to mount them."
11965 #: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933
11967 "Each element in the returned hashtable has a key which is the path of the "
11968 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11969 "mounted there (eg. C</dev/sda1>)."
11974 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
11976 "Non-mounted devices such as swap devices are I<not> returned in this list."
11980 #: ../src/guestfs-actions.pod:2823
11982 "For operating systems like Windows which still use drive letters, this call "
11983 "will only return an entry for the first drive \"mounted on\" C</>. For "
11984 "information about the mapping of drive letters to partitions, see "
11985 "C<guestfs_inspect_get_drive_mappings>."
11990 #: ../src/guestfs-actions.pod:2829
11992 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11993 "C<guestfs_inspect_get_filesystems>."
11998 #: ../src/guestfs-actions.pod:2840
11999 msgid "guestfs_inspect_get_package_format"
12004 #: ../src/guestfs-actions.pod:2842
12008 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
12009 " const char *root);\n"
12015 #: ../src/guestfs-actions.pod:2849
12017 "This function and C<guestfs_inspect_get_package_management> return the "
12018 "package format and package management tool used by the inspected operating "
12019 "system. For example for Fedora these functions would return C<rpm> (package "
12020 "format) and C<yum> (package management)."
12025 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963
12027 "This returns the string C<unknown> if we could not determine the package "
12028 "format I<or> if the operating system does not have a real packaging system "
12034 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967
12036 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
12037 "Future versions of libguestfs may return other strings."
12042 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898
12043 msgid "(Added in 1.7.5)"
12048 #: ../src/guestfs-actions.pod:2869
12049 msgid "guestfs_inspect_get_package_management"
12054 #: ../src/guestfs-actions.pod:2871
12058 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
12059 " const char *root);\n"
12065 #: ../src/guestfs-actions.pod:2878
12067 "C<guestfs_inspect_get_package_format> and this function return the package "
12068 "format and package management tool used by the inspected operating system. "
12069 "For example for Fedora these functions would return C<rpm> (package format) "
12070 "and C<yum> (package management)."
12075 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985
12077 "This returns the string C<unknown> if we could not determine the package "
12078 "management tool I<or> if the operating system does not have a real packaging "
12079 "system (eg. Windows)."
12084 #: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989
12086 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12087 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12088 "libguestfs may return other strings."
12093 #: ../src/guestfs-actions.pod:2900
12094 msgid "guestfs_inspect_get_product_name"
12099 #: ../src/guestfs-actions.pod:2902
12103 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12104 " const char *root);\n"
12110 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003
12112 "This returns the product name of the inspected operating system. The "
12113 "product name is generally some freeform string which can be displayed to the "
12114 "user, but should not be parsed by programs."
12119 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
12121 "If the product name could not be determined, then the string C<unknown> is "
12126 #: ../src/guestfs-actions.pod:2924
12127 msgid "guestfs_inspect_get_product_variant"
12131 #: ../src/guestfs-actions.pod:2926
12135 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12136 " const char *root);\n"
12141 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020
12142 msgid "This returns the product variant of the inspected operating system."
12146 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023
12148 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12149 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12150 "is usually a string such as C<Client> or C<Server> (other values are "
12151 "possible). This can be used to distinguish consumer and enterprise versions "
12152 "of Windows that have the same version number (for example, Windows 7 and "
12153 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12154 "the latter is C<Server>)."
12158 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032
12160 "For enterprise Linux guests, in future we intend this to return the product "
12161 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12162 "implemented at present."
12166 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036
12168 "If the product variant could not be determined, then the string C<unknown> "
12173 #: ../src/guestfs-actions.pod:2952
12175 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12176 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12181 #: ../src/guestfs-actions.pod:2959
12182 msgid "guestfs_inspect_get_roots"
12187 #: ../src/guestfs-actions.pod:2961
12191 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12197 #: ../src/guestfs-actions.pod:2964
12199 "This function is a convenient way to get the list of root devices, as "
12200 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12201 "the whole inspection process."
12206 #: ../src/guestfs-actions.pod:2968
12208 "This returns an empty list if either no root devices were found or the "
12209 "caller has not called C<guestfs_inspect_os>."
12214 #: ../src/guestfs-actions.pod:2977
12215 msgid "(Added in 1.7.3)"
12220 #: ../src/guestfs-actions.pod:2979
12221 msgid "guestfs_inspect_get_type"
12226 #: ../src/guestfs-actions.pod:2981
12230 " guestfs_inspect_get_type (guestfs_h *g,\n"
12231 " const char *root);\n"
12237 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063
12239 "This returns the type of the inspected operating system. Currently defined "
12245 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
12251 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070
12252 msgid "Any Linux-based operating system."
12257 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074
12258 msgid "Any Microsoft Windows operating system."
12263 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
12264 msgid "\"freebsd\""
12269 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
12275 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
12276 msgid "The operating system type could not be determined."
12280 #: ../src/guestfs-actions.pod:3021
12281 msgid "guestfs_inspect_get_windows_current_control_set"
12285 #: ../src/guestfs-actions.pod:3023
12289 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
12290 " const char *root);\n"
12295 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098
12297 "This returns the Windows CurrentControlSet of the inspected guest. The "
12298 "CurrentControlSet is a registry key name such as C<ControlSet001>."
12302 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101
12304 "This call assumes that the guest is Windows and that the Registry could be "
12305 "examined by inspection. If this is not the case then an error is returned."
12310 #: ../src/guestfs-actions.pod:3042
12311 msgid "guestfs_inspect_get_windows_systemroot"
12316 #: ../src/guestfs-actions.pod:3044
12320 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12321 " const char *root);\n"
12327 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2114
12329 "This returns the Windows systemroot of the inspected guest. The systemroot "
12330 "is a directory path such as C</WINDOWS>."
12335 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2117
12337 "This call assumes that the guest is Windows and that the systemroot could be "
12338 "determined by inspection. If this is not the case then an error is returned."
12343 #: ../src/guestfs-actions.pod:3063
12344 msgid "(Added in 1.5.25)"
12348 #: ../src/guestfs-actions.pod:3065
12349 msgid "guestfs_inspect_is_live"
12353 #: ../src/guestfs-actions.pod:3067
12357 " guestfs_inspect_is_live (guestfs_h *g,\n"
12358 " const char *root);\n"
12363 #: ../src/guestfs-actions.pod:3074
12365 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12366 "disk), then this returns true if a live image was detected on the disk."
12370 #: ../src/guestfs-actions.pod:3082
12371 msgid "guestfs_inspect_is_multipart"
12375 #: ../src/guestfs-actions.pod:3084
12379 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12380 " const char *root);\n"
12385 #: ../src/guestfs-actions.pod:3091
12387 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12388 "disk), then this returns true if the disk is part of a set."
12392 #: ../src/guestfs-actions.pod:3099
12393 msgid "guestfs_inspect_is_netinst"
12397 #: ../src/guestfs-actions.pod:3101
12401 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12402 " const char *root);\n"
12407 #: ../src/guestfs-actions.pod:3108
12409 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12410 "disk), then this returns true if the disk is a network installer, ie. not a "
12411 "self-contained install CD but one which is likely to require network access "
12412 "to complete the install."
12417 #: ../src/guestfs-actions.pod:3118
12418 msgid "guestfs_inspect_list_applications"
12423 #: ../src/guestfs-actions.pod:3120
12426 " struct guestfs_application_list *\n"
12427 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12428 " const char *root);\n"
12434 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2171
12435 msgid "Return the list of applications installed in the operating system."
12440 #: ../src/guestfs-actions.pod:3129
12442 "I<Note:> This call works differently from other parts of the inspection "
12443 "API. You have to call C<guestfs_inspect_os>, then "
12444 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12445 "this. Listing applications is a significantly more difficult operation "
12446 "which requires access to the full filesystem. Also note that unlike the "
12447 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12448 "the libguestfs handle, this call actually reads parts of the mounted "
12449 "filesystems during the call."
12454 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2183
12456 "This returns an empty list if the inspection code was not able to determine "
12457 "the list of applications."
12462 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2186
12463 msgid "The application structure contains the following fields:"
12468 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2190
12469 msgid "C<app_name>"
12474 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2192
12476 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12477 "guests, this is the package name."
12482 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
12483 msgid "C<app_display_name>"
12488 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
12490 "The display name of the application, sometimes localized to the install "
12491 "language of the guest operating system."
12496 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
12498 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12499 "to display something can use C<app_name> instead."
12504 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
12505 msgid "C<app_epoch>"
12510 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
12512 "For package managers which use epochs, this contains the epoch of the "
12513 "package (an integer). If unavailable, this is returned as C<0>."
12518 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
12519 msgid "C<app_version>"
12524 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
12526 "The version string of the application or package. If unavailable this is "
12527 "returned as an empty string C<\"\">."
12532 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
12533 msgid "C<app_release>"
12538 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
12540 "The release string of the application or package, for package managers that "
12541 "use this. If unavailable this is returned as an empty string C<\"\">."
12546 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2219
12547 msgid "C<app_install_path>"
12552 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
12554 "The installation path of the application (on operating systems such as "
12555 "Windows which use installation paths). This path is in the format used by "
12556 "the guest operating system, it is not a libguestfs path."
12561 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
12562 msgid "If unavailable this is returned as an empty string C<\"\">."
12567 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2228
12568 msgid "C<app_trans_path>"
12573 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2230
12575 "The install path translated into a libguestfs path. If unavailable this is "
12576 "returned as an empty string C<\"\">."
12581 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
12582 msgid "C<app_publisher>"
12587 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
12589 "The name of the publisher of the application, for package managers that use "
12590 "this. If unavailable this is returned as an empty string C<\"\">."
12595 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2239
12601 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
12603 "The URL (eg. upstream URL) of the application. If unavailable this is "
12604 "returned as an empty string C<\"\">."
12609 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
12610 msgid "C<app_source_package>"
12615 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
12617 "For packaging systems which support this, the name of the source package. "
12618 "If unavailable this is returned as an empty string C<\"\">."
12623 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
12624 msgid "C<app_summary>"
12629 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
12631 "A short (usually one line) description of the application or package. If "
12632 "unavailable this is returned as an empty string C<\"\">."
12637 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
12638 msgid "C<app_description>"
12643 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
12645 "A longer description of the application or package. If unavailable this is "
12646 "returned as an empty string C<\"\">."
12651 #: ../src/guestfs-actions.pod:3219
12653 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12654 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12660 #: ../src/guestfs-actions.pod:3223
12661 msgid "(Added in 1.7.8)"
12666 #: ../src/guestfs-actions.pod:3225
12667 msgid "guestfs_inspect_os"
12672 #: ../src/guestfs-actions.pod:3227
12676 " guestfs_inspect_os (guestfs_h *g);\n"
12682 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2267
12684 "This function uses other libguestfs functions and certain heuristics to "
12685 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12686 "for operating systems."
12691 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2271
12692 msgid "The list returned is empty if no operating systems were found."
12697 #: ../src/guestfs-actions.pod:3236 ../fish/guestfish-actions.pod:2273
12699 "If one operating system was found, then this returns a list with a single "
12700 "element, which is the name of the root filesystem of this operating system. "
12701 "It is also possible for this function to return a list containing more than "
12702 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12703 "element being the root filesystem of one of the operating systems."
12708 #: ../src/guestfs-actions.pod:3243
12710 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12711 "functions in order to query further information about each operating system, "
12712 "such as the name and version."
12717 #: ../src/guestfs-actions.pod:3248
12719 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12720 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12721 "the contents. This should be called with no disks currently mounted. The "
12722 "function may also use Augeas, so any existing Augeas handle will be closed."
12727 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2291
12729 "This function cannot decrypt encrypted disks. The caller must do that first "
12730 "(supplying the necessary keys) if the disk is encrypted."
12735 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3550
12736 #: ../src/guestfs-actions.pod:3612
12737 msgid "See also C<guestfs_list_filesystems>."
12742 #: ../src/guestfs-actions.pod:3268
12743 msgid "guestfs_is_blockdev"
12748 #: ../src/guestfs-actions.pod:3270
12752 " guestfs_is_blockdev (guestfs_h *g,\n"
12753 " const char *path);\n"
12759 #: ../src/guestfs-actions.pod:3274 ../fish/guestfish-actions.pod:2303
12761 "This returns C<true> if and only if there is a block device with the given "
12767 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3306
12768 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351
12769 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3423
12770 #: ../src/guestfs-actions.pod:3438
12771 msgid "See also C<guestfs_stat>."
12776 #: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3310
12777 #: ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3427
12778 #: ../src/guestfs-actions.pod:3442
12779 msgid "(Added in 1.5.10)"
12784 #: ../src/guestfs-actions.pod:3283
12785 msgid "guestfs_is_busy"
12790 #: ../src/guestfs-actions.pod:3285
12794 " guestfs_is_busy (guestfs_h *g);\n"
12800 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2312
12802 "This returns true iff this handle is busy processing a command (in the "
12808 #: ../src/guestfs-actions.pod:3297
12809 msgid "guestfs_is_chardev"
12814 #: ../src/guestfs-actions.pod:3299
12818 " guestfs_is_chardev (guestfs_h *g,\n"
12819 " const char *path);\n"
12825 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2321
12827 "This returns C<true> if and only if there is a character device with the "
12828 "given C<path> name."
12833 #: ../src/guestfs-actions.pod:3312
12834 msgid "guestfs_is_config"
12839 #: ../src/guestfs-actions.pod:3314
12843 " guestfs_is_config (guestfs_h *g);\n"
12849 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2330
12851 "This returns true iff this handle is being configured (in the C<CONFIG> "
12857 #: ../src/guestfs-actions.pod:3326
12858 msgid "guestfs_is_dir"
12863 #: ../src/guestfs-actions.pod:3328
12867 " guestfs_is_dir (guestfs_h *g,\n"
12868 " const char *path);\n"
12874 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2339
12876 "This returns C<true> if and only if there is a directory with the given "
12877 "C<path> name. Note that it returns false for other objects like files."
12882 #: ../src/guestfs-actions.pod:3342
12883 msgid "guestfs_is_fifo"
12888 #: ../src/guestfs-actions.pod:3344
12892 " guestfs_is_fifo (guestfs_h *g,\n"
12893 " const char *path);\n"
12899 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2349
12901 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12902 "given C<path> name."
12907 #: ../src/guestfs-actions.pod:3357
12908 msgid "guestfs_is_file"
12913 #: ../src/guestfs-actions.pod:3359
12917 " guestfs_is_file (guestfs_h *g,\n"
12918 " const char *path);\n"
12924 #: ../src/guestfs-actions.pod:3363 ../fish/guestfish-actions.pod:2358
12926 "This returns C<true> if and only if there is a regular file with the given "
12927 "C<path> name. Note that it returns false for other objects like directories."
12932 #: ../src/guestfs-actions.pod:3373
12933 msgid "guestfs_is_launching"
12938 #: ../src/guestfs-actions.pod:3375
12942 " guestfs_is_launching (guestfs_h *g);\n"
12948 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2368
12950 "This returns true iff this handle is launching the subprocess (in the "
12951 "C<LAUNCHING> state)."
12956 #: ../src/guestfs-actions.pod:3387
12957 msgid "guestfs_is_lv"
12962 #: ../src/guestfs-actions.pod:3389
12966 " guestfs_is_lv (guestfs_h *g,\n"
12967 " const char *device);\n"
12973 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2377
12975 "This command tests whether C<device> is a logical volume, and returns true "
12976 "iff this is the case."
12981 #: ../src/guestfs-actions.pod:3400
12982 msgid "guestfs_is_ready"
12987 #: ../src/guestfs-actions.pod:3402
12991 " guestfs_is_ready (guestfs_h *g);\n"
12997 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2384
12999 "This returns true iff this handle is ready to accept commands (in the "
13005 #: ../src/guestfs-actions.pod:3414
13006 msgid "guestfs_is_socket"
13011 #: ../src/guestfs-actions.pod:3416
13015 " guestfs_is_socket (guestfs_h *g,\n"
13016 " const char *path);\n"
13022 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2393
13024 "This returns C<true> if and only if there is a Unix domain socket with the "
13025 "given C<path> name."
13030 #: ../src/guestfs-actions.pod:3429
13031 msgid "guestfs_is_symlink"
13036 #: ../src/guestfs-actions.pod:3431
13040 " guestfs_is_symlink (guestfs_h *g,\n"
13041 " const char *path);\n"
13047 #: ../src/guestfs-actions.pod:3435 ../fish/guestfish-actions.pod:2402
13049 "This returns C<true> if and only if there is a symbolic link with the given "
13055 #: ../src/guestfs-actions.pod:3444
13056 msgid "guestfs_kill_subprocess"
13061 #: ../src/guestfs-actions.pod:3446
13065 " guestfs_kill_subprocess (guestfs_h *g);\n"
13071 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2411
13072 msgid "This kills the qemu subprocess. You should never need to call this."
13077 #: ../src/guestfs-actions.pod:3455
13078 msgid "guestfs_launch"
13083 #: ../src/guestfs-actions.pod:3457
13087 " guestfs_launch (guestfs_h *g);\n"
13093 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2419
13095 "Internally libguestfs is implemented by running a virtual machine using "
13101 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2422
13103 "You should call this after configuring the handle (eg. adding drives) but "
13104 "before performing any actions."
13109 #: ../src/guestfs-actions.pod:3475
13110 msgid "guestfs_lchown"
13115 #: ../src/guestfs-actions.pod:3477
13119 " guestfs_lchown (guestfs_h *g,\n"
13122 " const char *path);\n"
13128 #: ../src/guestfs-actions.pod:3483
13130 "Change the file owner to C<owner> and group to C<group>. This is like "
13131 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13132 "changed, not the target."
13137 #: ../src/guestfs-actions.pod:3495
13138 msgid "guestfs_lgetxattr"
13143 #: ../src/guestfs-actions.pod:3497
13147 " guestfs_lgetxattr (guestfs_h *g,\n"
13148 " const char *path,\n"
13149 " const char *name,\n"
13150 " size_t *size_r);\n"
13156 #: ../src/guestfs-actions.pod:3503 ../fish/guestfish-actions.pod:2441
13158 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13159 "is a symlink, then this call returns an extended attribute from the symlink."
13164 #: ../src/guestfs-actions.pod:3517
13165 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13170 #: ../src/guestfs-actions.pod:3525
13171 msgid "guestfs_lgetxattrs"
13176 #: ../src/guestfs-actions.pod:3527
13179 " struct guestfs_xattr_list *\n"
13180 " guestfs_lgetxattrs (guestfs_h *g,\n"
13181 " const char *path);\n"
13187 #: ../src/guestfs-actions.pod:3531
13189 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13190 "then it returns the extended attributes of the link itself."
13195 #: ../src/guestfs-actions.pod:3541
13196 msgid "guestfs_list_devices"
13201 #: ../src/guestfs-actions.pod:3543
13205 " guestfs_list_devices (guestfs_h *g);\n"
13211 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2469
13212 msgid "List all the block devices."
13217 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2471
13218 msgid "The full block device names are returned, eg. C</dev/sda>."
13223 #: ../src/guestfs-actions.pod:3558
13224 msgid "guestfs_list_filesystems"
13229 #: ../src/guestfs-actions.pod:3560
13233 " guestfs_list_filesystems (guestfs_h *g);\n"
13239 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2479
13241 "This inspection command looks for filesystems on partitions, block devices "
13242 "and logical volumes, returning a list of devices containing filesystems and "
13248 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2483
13250 "The return value is a hash, where the keys are the devices containing "
13251 "filesystems, and the values are the filesystem types. For example:"
13256 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
13259 " \"/dev/sda1\" => \"ntfs\"\n"
13260 " \"/dev/sda2\" => \"ext2\"\n"
13261 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13262 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13268 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
13270 "The value can have the special value \"unknown\", meaning the content of the "
13271 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13276 #: ../src/guestfs-actions.pod:3580
13278 "This command runs other libguestfs commands, which might include "
13279 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13280 "soon after launch and only when nothing is mounted."
13285 #: ../src/guestfs-actions.pod:3584
13287 "Not all of the filesystems returned will be mountable. In particular, swap "
13288 "partitions are returned in the list. Also this command does not check that "
13289 "each filesystem found is valid and mountable, and some filesystems might be "
13290 "mountable but require special options. Filesystems may not all belong to a "
13291 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13296 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:5203
13297 msgid "(Added in 1.5.15)"
13302 #: ../src/guestfs-actions.pod:3600
13303 msgid "guestfs_list_partitions"
13308 #: ../src/guestfs-actions.pod:3602
13312 " guestfs_list_partitions (guestfs_h *g);\n"
13318 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
13319 msgid "List all the partitions detected on all block devices."
13324 #: ../src/guestfs-actions.pod:3607 ../fish/guestfish-actions.pod:2514
13325 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13330 #: ../src/guestfs-actions.pod:3609
13332 "This does not return logical volumes. For that you will need to call "
13338 #: ../src/guestfs-actions.pod:3620
13344 #: ../src/guestfs-actions.pod:3622
13348 " guestfs_ll (guestfs_h *g,\n"
13349 " const char *directory);\n"
13355 #: ../src/guestfs-actions.pod:3626 ../fish/guestfish-actions.pod:2525
13357 "List the files in C<directory> (relative to the root directory, there is no "
13358 "cwd) in the format of 'ls -la'."
13363 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2528
13365 "This command is mostly useful for interactive sessions. It is I<not> "
13366 "intended that you try to parse the output string."
13371 #: ../src/guestfs-actions.pod:3637
13377 #: ../src/guestfs-actions.pod:3639
13381 " guestfs_ln (guestfs_h *g,\n"
13382 " const char *target,\n"
13383 " const char *linkname);\n"
13389 #: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2535
13390 msgid "This command creates a hard link using the C<ln> command."
13395 #: ../src/guestfs-actions.pod:3650
13396 msgid "guestfs_ln_f"
13401 #: ../src/guestfs-actions.pod:3652
13405 " guestfs_ln_f (guestfs_h *g,\n"
13406 " const char *target,\n"
13407 " const char *linkname);\n"
13413 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2541
13415 "This command creates a hard link using the C<ln -f> command. The C<-f> "
13416 "option removes the link (C<linkname>) if it exists already."
13421 #: ../src/guestfs-actions.pod:3664
13422 msgid "guestfs_ln_s"
13427 #: ../src/guestfs-actions.pod:3666
13431 " guestfs_ln_s (guestfs_h *g,\n"
13432 " const char *target,\n"
13433 " const char *linkname);\n"
13439 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2548
13440 msgid "This command creates a symbolic link using the C<ln -s> command."
13445 #: ../src/guestfs-actions.pod:3677
13446 msgid "guestfs_ln_sf"
13451 #: ../src/guestfs-actions.pod:3679
13455 " guestfs_ln_sf (guestfs_h *g,\n"
13456 " const char *target,\n"
13457 " const char *linkname);\n"
13463 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2554
13465 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
13466 "option removes the link (C<linkname>) if it exists already."
13471 #: ../src/guestfs-actions.pod:3691
13472 msgid "guestfs_lremovexattr"
13477 #: ../src/guestfs-actions.pod:3693
13481 " guestfs_lremovexattr (guestfs_h *g,\n"
13482 " const char *xattr,\n"
13483 " const char *path);\n"
13489 #: ../src/guestfs-actions.pod:3698
13491 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13492 "link, then it removes an extended attribute of the link itself."
13497 #: ../src/guestfs-actions.pod:3706
13503 #: ../src/guestfs-actions.pod:3708
13507 " guestfs_ls (guestfs_h *g,\n"
13508 " const char *directory);\n"
13514 #: ../src/guestfs-actions.pod:3712 ../fish/guestfish-actions.pod:2569
13516 "List the files in C<directory> (relative to the root directory, there is no "
13517 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13522 #: ../src/guestfs-actions.pod:3716
13524 "This command is mostly useful for interactive sessions. Programs should "
13525 "probably use C<guestfs_readdir> instead."
13530 #: ../src/guestfs-actions.pod:3725
13531 msgid "guestfs_lsetxattr"
13536 #: ../src/guestfs-actions.pod:3727
13540 " guestfs_lsetxattr (guestfs_h *g,\n"
13541 " const char *xattr,\n"
13542 " const char *val,\n"
13544 " const char *path);\n"
13550 #: ../src/guestfs-actions.pod:3734
13552 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13553 "then it sets an extended attribute of the link itself."
13558 #: ../src/guestfs-actions.pod:3742
13559 msgid "guestfs_lstat"
13564 #: ../src/guestfs-actions.pod:3744
13567 " struct guestfs_stat *\n"
13568 " guestfs_lstat (guestfs_h *g,\n"
13569 " const char *path);\n"
13575 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:6306
13576 #: ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:4257
13577 msgid "Returns file information for the given C<path>."
13582 #: ../src/guestfs-actions.pod:3750
13584 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13585 "link, then the link is stat-ed, not the file it refers to."
13590 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2594
13591 msgid "This is the same as the C<lstat(2)> system call."
13596 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6310
13598 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13599 "error. I<The caller must call C<guestfs_free_stat> after use>."
13604 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:6314
13605 #: ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6713
13606 msgid "(Added in 0.9.2)"
13611 #: ../src/guestfs-actions.pod:3762
13612 msgid "guestfs_lstatlist"
13617 #: ../src/guestfs-actions.pod:3764
13620 " struct guestfs_stat_list *\n"
13621 " guestfs_lstatlist (guestfs_h *g,\n"
13622 " const char *path,\n"
13623 " char *const *names);\n"
13629 #: ../src/guestfs-actions.pod:3769
13631 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13632 "files, where all files are in the directory C<path>. C<names> is the list "
13633 "of files from this directory."
13638 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2604
13640 "On return you get a list of stat structs, with a one-to-one correspondence "
13641 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13642 "then the C<ino> field of that structure is set to C<-1>."
13647 #: ../src/guestfs-actions.pod:3778
13649 "This call is intended for programs that want to efficiently list a directory "
13650 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13651 "for a similarly efficient call for getting extended attributes. Very long "
13652 "directory listings might cause the protocol message size to be exceeded, "
13653 "causing this call to fail. The caller must split up such requests into "
13654 "smaller groups of names."
13659 #: ../src/guestfs-actions.pod:3786
13661 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13662 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13667 #: ../src/guestfs-actions.pod:3792
13668 msgid "guestfs_luks_add_key"
13673 #: ../src/guestfs-actions.pod:3794
13677 " guestfs_luks_add_key (guestfs_h *g,\n"
13678 " const char *device,\n"
13679 " const char *key,\n"
13680 " const char *newkey,\n"
13687 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2621
13689 "This command adds a new key on LUKS device C<device>. C<key> is any "
13690 "existing key, and is used to access the device. C<newkey> is the new key to "
13691 "add. C<keyslot> is the key slot that will be replaced."
13696 #: ../src/guestfs-actions.pod:3806
13698 "Note that if C<keyslot> already contains a key, then this command will "
13699 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13704 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3852
13705 #: ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3895
13706 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3946
13708 "This function takes a key or passphrase parameter which could contain "
13709 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13715 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3856
13716 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3899
13717 msgid "(Added in 1.5.2)"
13722 #: ../src/guestfs-actions.pod:3818
13723 msgid "guestfs_luks_close"
13728 #: ../src/guestfs-actions.pod:3820
13732 " guestfs_luks_close (guestfs_h *g,\n"
13733 " const char *device);\n"
13739 #: ../src/guestfs-actions.pod:3824
13741 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13742 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13743 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13744 "underlying block device."
13749 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3931
13750 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4000
13751 #: ../src/guestfs-actions.pod:4048
13752 msgid "(Added in 1.5.1)"
13757 #: ../src/guestfs-actions.pod:3834
13758 msgid "guestfs_luks_format"
13763 #: ../src/guestfs-actions.pod:3836
13767 " guestfs_luks_format (guestfs_h *g,\n"
13768 " const char *device,\n"
13769 " const char *key,\n"
13776 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2647
13778 "This command erases existing data on C<device> and formats the device as a "
13779 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13780 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13785 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3872
13786 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4954
13787 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:6141
13788 #: ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6190
13789 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:2655
13790 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2752
13791 #: ../fish/guestfish-actions.pod:3326 ../fish/guestfish-actions.pod:3846
13792 #: ../fish/guestfish-actions.pod:4156 ../fish/guestfish-actions.pod:4172
13793 #: ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4902
13795 "B<This command is dangerous. Without careful use you can easily destroy all "
13801 #: ../src/guestfs-actions.pod:3858
13802 msgid "guestfs_luks_format_cipher"
13807 #: ../src/guestfs-actions.pod:3860
13811 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13812 " const char *device,\n"
13813 " const char *key,\n"
13815 " const char *cipher);\n"
13821 #: ../src/guestfs-actions.pod:3867
13823 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13824 "set the C<cipher> used."
13829 #: ../src/guestfs-actions.pod:3881
13830 msgid "guestfs_luks_kill_slot"
13835 #: ../src/guestfs-actions.pod:3883
13839 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13840 " const char *device,\n"
13841 " const char *key,\n"
13848 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2675
13850 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13851 "device C<device>. C<key> must be one of the I<other> keys."
13856 #: ../src/guestfs-actions.pod:3901
13857 msgid "guestfs_luks_open"
13862 #: ../src/guestfs-actions.pod:3903
13866 " guestfs_luks_open (guestfs_h *g,\n"
13867 " const char *device,\n"
13868 " const char *key,\n"
13869 " const char *mapname);\n"
13875 #: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:2686
13877 "This command opens a block device which has been encrypted according to the "
13878 "Linux Unified Key Setup (LUKS) standard."
13883 #: ../src/guestfs-actions.pod:3912 ../fish/guestfish-actions.pod:2689
13884 msgid "C<device> is the encrypted block device or partition."
13889 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
13891 "The caller must supply one of the keys associated with the LUKS block "
13892 "device, in the C<key> parameter."
13897 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
13899 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13900 "writes to this block device are decrypted from and encrypted to the "
13901 "underlying C<device> respectively."
13906 #: ../src/guestfs-actions.pod:3921
13908 "If this block device contains LVM volume groups, then calling "
13909 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13915 #: ../src/guestfs-actions.pod:3933
13916 msgid "guestfs_luks_open_ro"
13921 #: ../src/guestfs-actions.pod:3935
13925 " guestfs_luks_open_ro (guestfs_h *g,\n"
13926 " const char *device,\n"
13927 " const char *key,\n"
13928 " const char *mapname);\n"
13934 #: ../src/guestfs-actions.pod:3941
13936 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13942 #: ../src/guestfs-actions.pod:3952
13943 msgid "guestfs_lvcreate"
13948 #: ../src/guestfs-actions.pod:3954
13952 " guestfs_lvcreate (guestfs_h *g,\n"
13953 " const char *logvol,\n"
13954 " const char *volgroup,\n"
13961 #: ../src/guestfs-actions.pod:3960 ../fish/guestfish-actions.pod:2719
13963 "This creates an LVM logical volume called C<logvol> on the volume group "
13964 "C<volgroup>, with C<size> megabytes."
13969 #: ../src/guestfs-actions.pod:3967
13970 msgid "guestfs_lvm_canonical_lv_name"
13975 #: ../src/guestfs-actions.pod:3969
13979 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13980 " const char *lvname);\n"
13986 #: ../src/guestfs-actions.pod:3973 ../fish/guestfish-actions.pod:2726
13988 "This converts alternative naming schemes for LVs that you might find to the "
13989 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13995 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2730
13997 "This command returns an error if the C<lvname> parameter does not refer to a "
14003 #: ../src/guestfs-actions.pod:3980
14004 msgid "See also C<guestfs_is_lv>."
14009 #: ../src/guestfs-actions.pod:3985
14010 msgid "(Added in 1.5.24)"
14015 #: ../src/guestfs-actions.pod:3987
14016 msgid "guestfs_lvm_clear_filter"
14021 #: ../src/guestfs-actions.pod:3989
14025 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
14031 #: ../src/guestfs-actions.pod:3992
14033 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
14034 "see every block device."
14039 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4037
14040 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2773
14042 "This command also clears the LVM cache and performs a volume group scan."
14047 #: ../src/guestfs-actions.pod:4002
14048 msgid "guestfs_lvm_remove_all"
14053 #: ../src/guestfs-actions.pod:4004
14057 " guestfs_lvm_remove_all (guestfs_h *g);\n"
14063 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2749
14065 "This command removes all LVM logical volumes, volume groups and physical "
14071 #: ../src/guestfs-actions.pod:4017
14072 msgid "guestfs_lvm_set_filter"
14077 #: ../src/guestfs-actions.pod:4019
14081 " guestfs_lvm_set_filter (guestfs_h *g,\n"
14082 " char *const *devices);\n"
14088 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2759
14090 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
14091 "block devices in the list C<devices>, and will ignore all other attached "
14097 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2763
14099 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
14100 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
14101 "there are two types of duplication possible: either cloned PVs/VGs which "
14102 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
14103 "same name. In normal operation you cannot create this situation, but you "
14104 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
14105 "inside the LVM metadata."
14110 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2776
14111 msgid "You can filter whole block devices or individual partitions."
14116 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2778
14118 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14119 "filesystem), even if you are not filtering out that VG."
14124 #: ../src/guestfs-actions.pod:4050
14125 msgid "guestfs_lvremove"
14130 #: ../src/guestfs-actions.pod:4052
14134 " guestfs_lvremove (guestfs_h *g,\n"
14135 " const char *device);\n"
14141 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2786
14143 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14144 "LV, such as C</dev/VG/LV>."
14149 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2789
14151 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14157 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:5300
14158 #: ../src/guestfs-actions.pod:7089
14159 msgid "(Added in 1.0.13)"
14164 #: ../src/guestfs-actions.pod:4066
14165 msgid "guestfs_lvrename"
14170 #: ../src/guestfs-actions.pod:4068
14174 " guestfs_lvrename (guestfs_h *g,\n"
14175 " const char *logvol,\n"
14176 " const char *newlogvol);\n"
14182 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2796
14183 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14188 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:7102
14189 msgid "(Added in 1.0.83)"
14194 #: ../src/guestfs-actions.pod:4079
14195 msgid "guestfs_lvresize"
14200 #: ../src/guestfs-actions.pod:4081
14204 " guestfs_lvresize (guestfs_h *g,\n"
14205 " const char *device,\n"
14212 #: ../src/guestfs-actions.pod:4086 ../fish/guestfish-actions.pod:2802
14214 "This resizes (expands or shrinks) an existing LVM logical volume to "
14215 "C<mbytes>. When reducing, data in the reduced part is lost."
14220 #: ../src/guestfs-actions.pod:4094
14221 msgid "guestfs_lvresize_free"
14226 #: ../src/guestfs-actions.pod:4096
14230 " guestfs_lvresize_free (guestfs_h *g,\n"
14231 " const char *lv,\n"
14238 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2810
14240 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14241 "remaining free space in the volume group. Commonly you would call this with "
14242 "pc = 100 which expands the logical volume as much as possible, using all "
14243 "remaining free space in the volume group."
14248 #: ../src/guestfs-actions.pod:4109
14249 msgid "(Added in 1.3.3)"
14254 #: ../src/guestfs-actions.pod:4111
14255 msgid "guestfs_lvs"
14260 #: ../src/guestfs-actions.pod:4113
14264 " guestfs_lvs (guestfs_h *g);\n"
14270 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2820
14272 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14278 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2823
14280 "This returns a list of the logical volume device names (eg. C</dev/"
14281 "VolGroup00/LogVol00>)."
14286 #: ../src/guestfs-actions.pod:4122
14287 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14292 #: ../src/guestfs-actions.pod:4130
14293 msgid "guestfs_lvs_full"
14298 #: ../src/guestfs-actions.pod:4132
14301 " struct guestfs_lvm_lv_list *\n"
14302 " guestfs_lvs_full (guestfs_h *g);\n"
14308 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2832
14310 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14311 "(8)> command. The \"full\" version includes all fields."
14316 #: ../src/guestfs-actions.pod:4138
14318 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14319 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14324 #: ../src/guestfs-actions.pod:4144
14325 msgid "guestfs_lvuuid"
14330 #: ../src/guestfs-actions.pod:4146
14334 " guestfs_lvuuid (guestfs_h *g,\n"
14335 " const char *device);\n"
14341 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2839
14342 msgid "This command returns the UUID of the LVM LV C<device>."
14347 #: ../src/guestfs-actions.pod:4157
14348 msgid "guestfs_lxattrlist"
14353 #: ../src/guestfs-actions.pod:4159
14356 " struct guestfs_xattr_list *\n"
14357 " guestfs_lxattrlist (guestfs_h *g,\n"
14358 " const char *path,\n"
14359 " char *const *names);\n"
14365 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2845
14367 "This call allows you to get the extended attributes of multiple files, where "
14368 "all files are in the directory C<path>. C<names> is the list of files from "
14374 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:2849
14376 "On return you get a flat list of xattr structs which must be interpreted "
14377 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14378 "C<attrval> in this struct is zero-length to indicate there was an error "
14379 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14380 "number (the number of following attributes for this file, which could be C<"
14381 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14382 "for the first named file. This repeats for the second and subsequent files."
14387 #: ../src/guestfs-actions.pod:4178
14389 "This call is intended for programs that want to efficiently list a directory "
14390 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14391 "a similarly efficient call for getting standard stats. Very long directory "
14392 "listings might cause the protocol message size to be exceeded, causing this "
14393 "call to fail. The caller must split up such requests into smaller groups of "
14399 #: ../src/guestfs-actions.pod:4192
14400 msgid "guestfs_mkdir"
14405 #: ../src/guestfs-actions.pod:4194
14409 " guestfs_mkdir (guestfs_h *g,\n"
14410 " const char *path);\n"
14416 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2871
14417 msgid "Create a directory named C<path>."
14422 #: ../src/guestfs-actions.pod:4204
14423 msgid "guestfs_mkdir_mode"
14428 #: ../src/guestfs-actions.pod:4206
14432 " guestfs_mkdir_mode (guestfs_h *g,\n"
14433 " const char *path,\n"
14440 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2877
14442 "This command creates a directory, setting the initial permissions of the "
14443 "directory to C<mode>."
14448 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2880
14450 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14451 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14457 #: ../src/guestfs-actions.pod:4218
14458 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14463 #: ../src/guestfs-actions.pod:4224
14464 msgid "guestfs_mkdir_p"
14469 #: ../src/guestfs-actions.pod:4226
14473 " guestfs_mkdir_p (guestfs_h *g,\n"
14474 " const char *path);\n"
14480 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2890
14482 "Create a directory named C<path>, creating any parent directories as "
14483 "necessary. This is like the C<mkdir -p> shell command."
14488 #: ../src/guestfs-actions.pod:4237
14489 msgid "guestfs_mkdtemp"
14494 #: ../src/guestfs-actions.pod:4239
14498 " guestfs_mkdtemp (guestfs_h *g,\n"
14499 " const char *template);\n"
14505 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2897
14507 "This command creates a temporary directory. The C<template> parameter "
14508 "should be a full pathname for the temporary directory name with the final "
14509 "six characters being \"XXXXXX\"."
14514 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
14516 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14517 "being suitable for Windows filesystems."
14522 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
14523 msgid "The name of the temporary directory that was created is returned."
14528 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2908
14529 msgid "The temporary directory is created with mode 0700 and is owned by root."
14534 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2911
14536 "The caller is responsible for deleting the temporary directory and its "
14537 "contents after use."
14542 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2914
14543 msgid "See also: L<mkdtemp(3)>"
14548 #: ../src/guestfs-actions.pod:4267
14549 msgid "guestfs_mke2fs_J"
14554 #: ../src/guestfs-actions.pod:4269
14558 " guestfs_mke2fs_J (guestfs_h *g,\n"
14559 " const char *fstype,\n"
14560 " int blocksize,\n"
14561 " const char *device,\n"
14562 " const char *journal);\n"
14568 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2920
14570 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14571 "C<journal>. It is equivalent to the command:"
14576 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2924
14579 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14585 #: ../src/guestfs-actions.pod:4282
14586 msgid "See also C<guestfs_mke2journal>."
14591 #: ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:4304
14592 #: ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4338
14593 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366
14594 #: ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4690
14595 msgid "(Added in 1.0.68)"
14600 #: ../src/guestfs-actions.pod:4288
14601 msgid "guestfs_mke2fs_JL"
14606 #: ../src/guestfs-actions.pod:4290
14610 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14611 " const char *fstype,\n"
14612 " int blocksize,\n"
14613 " const char *device,\n"
14614 " const char *label);\n"
14620 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2932
14622 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14623 "the journal labeled C<label>."
14628 #: ../src/guestfs-actions.pod:4300
14629 msgid "See also C<guestfs_mke2journal_L>."
14634 #: ../src/guestfs-actions.pod:4306
14635 msgid "guestfs_mke2fs_JU"
14640 #: ../src/guestfs-actions.pod:4308
14644 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14645 " const char *fstype,\n"
14646 " int blocksize,\n"
14647 " const char *device,\n"
14648 " const char *uuid);\n"
14654 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2941
14656 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14657 "the journal with UUID C<uuid>."
14662 #: ../src/guestfs-actions.pod:4318
14663 msgid "See also C<guestfs_mke2journal_U>."
14668 #: ../src/guestfs-actions.pod:4324
14669 msgid "guestfs_mke2journal"
14674 #: ../src/guestfs-actions.pod:4326
14678 " guestfs_mke2journal (guestfs_h *g,\n"
14679 " int blocksize,\n"
14680 " const char *device);\n"
14686 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2950
14688 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14694 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2953
14697 " mke2fs -O journal_dev -b blocksize device\n"
14703 #: ../src/guestfs-actions.pod:4340
14704 msgid "guestfs_mke2journal_L"
14709 #: ../src/guestfs-actions.pod:4342
14713 " guestfs_mke2journal_L (guestfs_h *g,\n"
14714 " int blocksize,\n"
14715 " const char *label,\n"
14716 " const char *device);\n"
14722 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2959
14723 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14728 #: ../src/guestfs-actions.pod:4354
14729 msgid "guestfs_mke2journal_U"
14734 #: ../src/guestfs-actions.pod:4356
14738 " guestfs_mke2journal_U (guestfs_h *g,\n"
14739 " int blocksize,\n"
14740 " const char *uuid,\n"
14741 " const char *device);\n"
14747 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2965
14748 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14753 #: ../src/guestfs-actions.pod:4368
14754 msgid "guestfs_mkfifo"
14759 #: ../src/guestfs-actions.pod:4370
14763 " guestfs_mkfifo (guestfs_h *g,\n"
14765 " const char *path);\n"
14771 #: ../src/guestfs-actions.pod:4375
14773 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14774 "is just a convenient wrapper around C<guestfs_mknod>."
14779 #: ../src/guestfs-actions.pod:4385
14780 msgid "guestfs_mkfs"
14785 #: ../src/guestfs-actions.pod:4387
14789 " guestfs_mkfs (guestfs_h *g,\n"
14790 " const char *fstype,\n"
14791 " const char *device);\n"
14797 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2981
14799 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14800 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14805 #: ../src/guestfs-actions.pod:4400
14806 msgid "guestfs_mkfs_b"
14811 #: ../src/guestfs-actions.pod:4402
14815 " guestfs_mkfs_b (guestfs_h *g,\n"
14816 " const char *fstype,\n"
14817 " int blocksize,\n"
14818 " const char *device);\n"
14824 #: ../src/guestfs-actions.pod:4408
14826 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14827 "block size of the resulting filesystem. Supported block sizes depend on the "
14828 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14833 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4456
14834 #: ../fish/guestfish-actions.pod:2994 ../fish/guestfish-actions.pod:3021
14836 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14842 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2997
14844 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14849 #: ../src/guestfs-actions.pod:4427
14850 msgid "guestfs_mkfs_opts"
14855 #: ../src/guestfs-actions.pod:4429
14859 " guestfs_mkfs_opts (guestfs_h *g,\n"
14860 " const char *fstype,\n"
14861 " const char *device,\n"
14867 #: ../src/guestfs-actions.pod:4440
14870 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14871 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14877 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3008
14879 "This function creates a filesystem on C<device>. The filesystem type is "
14880 "C<fstype>, for example C<ext3>."
14885 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3015
14886 msgid "C<blocksize>"
14891 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3017
14893 "The filesystem block size. Supported block sizes depend on the filesystem "
14894 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14899 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3024
14900 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14904 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:3026
14905 msgid "C<features>"
14909 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3028
14910 msgid "This passes the C<-O> parameter to the external mkfs program."
14914 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:3030
14916 "For certain filesystem types, this allows extra filesystem features to be "
14917 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14921 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
14923 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14928 #: ../src/guestfs-actions.pod:4476
14929 msgid "(Added in 1.7.19)"
14934 #: ../src/guestfs-actions.pod:4478
14935 msgid "guestfs_mkfs_opts_va"
14940 #: ../src/guestfs-actions.pod:4480
14944 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14945 " const char *fstype,\n"
14946 " const char *device,\n"
14947 " va_list args);\n"
14953 #: ../src/guestfs-actions.pod:4486
14954 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14959 #: ../src/guestfs-actions.pod:4490
14960 msgid "guestfs_mkfs_opts_argv"
14965 #: ../src/guestfs-actions.pod:4492
14969 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14970 " const char *fstype,\n"
14971 " const char *device,\n"
14972 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14978 #: ../src/guestfs-actions.pod:4498
14979 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14984 #: ../src/guestfs-actions.pod:4502
14985 msgid "guestfs_mkmountpoint"
14990 #: ../src/guestfs-actions.pod:4504
14994 " guestfs_mkmountpoint (guestfs_h *g,\n"
14995 " const char *exemptpath);\n"
15001 #: ../src/guestfs-actions.pod:4508
15003 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
15004 "that can be used to create extra mountpoints before mounting the first "
15010 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3049
15012 "These calls are I<only> necessary in some very limited circumstances, mainly "
15013 "the case where you want to mount a mix of unrelated and/or read-only "
15014 "filesystems together."
15019 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3053
15021 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
15022 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
15023 "inside that. You can unpack this as follows in guestfish:"
15028 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
15031 " add-ro Fedora-11-i686-Live.iso\n"
15033 " mkmountpoint /cd\n"
15034 " mkmountpoint /sqsh\n"
15035 " mkmountpoint /ext3fs\n"
15036 " mount /dev/sda /cd\n"
15037 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
15038 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
15044 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3067
15045 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
15050 #: ../src/guestfs-actions.pod:4532
15052 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
15053 "may get unexpected errors if you try to mix these calls. It is safest to "
15054 "manually unmount filesystems and remove mountpoints after use."
15059 #: ../src/guestfs-actions.pod:4536
15061 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
15062 "first, so for this to work for manual mountpoints, you must ensure that the "
15063 "innermost mountpoints have the longest pathnames, as in the example code "
15069 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3078
15071 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
15075 #: ../src/guestfs-actions.pod:4543
15077 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
15078 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
15079 "can also trigger these issues."
15084 #: ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4808
15085 #: ../src/guestfs-actions.pod:5718
15086 msgid "(Added in 1.0.62)"
15091 #: ../src/guestfs-actions.pod:4551
15092 msgid "guestfs_mknod"
15097 #: ../src/guestfs-actions.pod:4553
15101 " guestfs_mknod (guestfs_h *g,\n"
15105 " const char *path);\n"
15111 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3088
15113 "This call creates block or character special devices, or named pipes (FIFOs)."
15118 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3091
15120 "The C<mode> parameter should be the mode, using the standard constants. "
15121 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15122 "used when creating block and character special devices."
15127 #: ../src/guestfs-actions.pod:4568
15129 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15130 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15131 "regular file). These constants are available in the standard Linux header "
15132 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15133 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15134 "the appropriate constant for you."
15139 #: ../src/guestfs-actions.pod:4582
15140 msgid "guestfs_mknod_b"
15145 #: ../src/guestfs-actions.pod:4584
15149 " guestfs_mknod_b (guestfs_h *g,\n"
15153 " const char *path);\n"
15159 #: ../src/guestfs-actions.pod:4591
15161 "This call creates a block device node called C<path> with mode C<mode> and "
15162 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15163 "wrapper around C<guestfs_mknod>."
15168 #: ../src/guestfs-actions.pod:4601
15169 msgid "guestfs_mknod_c"
15174 #: ../src/guestfs-actions.pod:4603
15178 " guestfs_mknod_c (guestfs_h *g,\n"
15182 " const char *path);\n"
15188 #: ../src/guestfs-actions.pod:4610
15190 "This call creates a char device node called C<path> with mode C<mode> and "
15191 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15192 "wrapper around C<guestfs_mknod>."
15197 #: ../src/guestfs-actions.pod:4620
15198 msgid "guestfs_mkswap"
15203 #: ../src/guestfs-actions.pod:4622
15207 " guestfs_mkswap (guestfs_h *g,\n"
15208 " const char *device);\n"
15214 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3130
15215 msgid "Create a swap partition on C<device>."
15220 #: ../src/guestfs-actions.pod:4632
15221 msgid "guestfs_mkswap_L"
15226 #: ../src/guestfs-actions.pod:4634
15230 " guestfs_mkswap_L (guestfs_h *g,\n"
15231 " const char *label,\n"
15232 " const char *device);\n"
15238 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3136
15239 msgid "Create a swap partition on C<device> with label C<label>."
15244 #: ../src/guestfs-actions.pod:4641 ../fish/guestfish-actions.pod:3138
15246 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15247 "sda>), just to a partition. This appears to be a limitation of the kernel "
15253 #: ../src/guestfs-actions.pod:4649
15254 msgid "guestfs_mkswap_U"
15259 #: ../src/guestfs-actions.pod:4651
15263 " guestfs_mkswap_U (guestfs_h *g,\n"
15264 " const char *uuid,\n"
15265 " const char *device);\n"
15271 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3146
15272 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15277 #: ../src/guestfs-actions.pod:4662
15278 msgid "guestfs_mkswap_file"
15283 #: ../src/guestfs-actions.pod:4664
15287 " guestfs_mkswap_file (guestfs_h *g,\n"
15288 " const char *path);\n"
15294 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3152
15295 msgid "Create a swap file."
15300 #: ../src/guestfs-actions.pod:4670
15302 "This command just writes a swap file signature to an existing file. To "
15303 "create the file itself, use something like C<guestfs_fallocate>."
15308 #: ../src/guestfs-actions.pod:4677
15309 msgid "guestfs_modprobe"
15314 #: ../src/guestfs-actions.pod:4679
15318 " guestfs_modprobe (guestfs_h *g,\n"
15319 " const char *modulename);\n"
15325 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3161
15326 msgid "This loads a kernel module in the appliance."
15331 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3163
15333 "The kernel module must have been whitelisted when libguestfs was built (see "
15334 "C<appliance/kmod.whitelist.in> in the source)."
15339 #: ../src/guestfs-actions.pod:4692
15340 msgid "guestfs_mount"
15345 #: ../src/guestfs-actions.pod:4694
15349 " guestfs_mount (guestfs_h *g,\n"
15350 " const char *device,\n"
15351 " const char *mountpoint);\n"
15357 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3170
15359 "Mount a guest disk at a position in the filesystem. Block devices are named "
15360 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15361 "those block devices contain partitions, they will have the usual names (eg. "
15362 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15367 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3176
15369 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15370 "mounted on C</> before others can be mounted. Other filesystems can only be "
15371 "mounted on directories which already exist."
15376 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
15378 "The mounted filesystem is writable, if we have sufficient permissions on the "
15379 "underlying device."
15384 #: ../src/guestfs-actions.pod:4713
15386 "B<Important note:> When you use this call, the filesystem options C<sync> "
15387 "and C<noatime> are set implicitly. This was originally done because we "
15388 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15389 "very large negative performance impact and negligible effect on "
15390 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15391 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15392 "(use an empty string for the first parameter if you don't want any options)."
15397 #: ../src/guestfs-actions.pod:4727
15398 msgid "guestfs_mount_loop"
15403 #: ../src/guestfs-actions.pod:4729
15407 " guestfs_mount_loop (guestfs_h *g,\n"
15408 " const char *file,\n"
15409 " const char *mountpoint);\n"
15415 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3198
15417 "This command lets you mount C<file> (a filesystem image in a file) on a "
15418 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15424 #: ../src/guestfs-actions.pod:4742
15425 msgid "guestfs_mount_options"
15430 #: ../src/guestfs-actions.pod:4744
15434 " guestfs_mount_options (guestfs_h *g,\n"
15435 " const char *options,\n"
15436 " const char *device,\n"
15437 " const char *mountpoint);\n"
15443 #: ../src/guestfs-actions.pod:4750
15445 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15446 "the mount options as for the L<mount(8)> I<-o> flag."
15451 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3210
15453 "If the C<options> parameter is an empty string, then no options are passed "
15454 "(all options default to whatever the filesystem uses)."
15459 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4774
15460 #: ../src/guestfs-actions.pod:4791
15461 msgid "(Added in 1.0.10)"
15466 #: ../src/guestfs-actions.pod:4762
15467 msgid "guestfs_mount_ro"
15472 #: ../src/guestfs-actions.pod:4764
15476 " guestfs_mount_ro (guestfs_h *g,\n"
15477 " const char *device,\n"
15478 " const char *mountpoint);\n"
15484 #: ../src/guestfs-actions.pod:4769
15486 "This is the same as the C<guestfs_mount> command, but it mounts the "
15487 "filesystem with the read-only (I<-o ro>) flag."
15492 #: ../src/guestfs-actions.pod:4776
15493 msgid "guestfs_mount_vfs"
15498 #: ../src/guestfs-actions.pod:4778
15502 " guestfs_mount_vfs (guestfs_h *g,\n"
15503 " const char *options,\n"
15504 " const char *vfstype,\n"
15505 " const char *device,\n"
15506 " const char *mountpoint);\n"
15512 #: ../src/guestfs-actions.pod:4785
15514 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15515 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15521 #: ../src/guestfs-actions.pod:4793
15522 msgid "guestfs_mountpoints"
15527 #: ../src/guestfs-actions.pod:4795
15531 " guestfs_mountpoints (guestfs_h *g);\n"
15537 #: ../src/guestfs-actions.pod:4798
15539 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15540 "devices. This one returns a hash table (map) of device name to directory "
15541 "where the device is mounted."
15546 #: ../src/guestfs-actions.pod:4810
15547 msgid "guestfs_mounts"
15552 #: ../src/guestfs-actions.pod:4812
15556 " guestfs_mounts (guestfs_h *g);\n"
15562 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3241
15564 "This returns the list of currently mounted filesystems. It returns the list "
15565 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15570 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3244
15571 msgid "Some internal mounts are not shown."
15576 #: ../src/guestfs-actions.pod:4820
15577 msgid "See also: C<guestfs_mountpoints>"
15582 #: ../src/guestfs-actions.pod:4828
15588 #: ../src/guestfs-actions.pod:4830
15592 " guestfs_mv (guestfs_h *g,\n"
15593 " const char *src,\n"
15594 " const char *dest);\n"
15600 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3252
15602 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15603 "destination filename or destination directory."
15608 #: ../src/guestfs-actions.pod:4842
15609 msgid "guestfs_ntfs_3g_probe"
15614 #: ../src/guestfs-actions.pod:4844
15618 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15620 " const char *device);\n"
15626 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3259
15628 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15629 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15630 "write, and some cannot be mounted at all)."
15635 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3263
15637 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15638 "can be mounted read-write. Set it to false if you want to test if the "
15639 "volume can be mounted read-only."
15644 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
15646 "The return value is an integer which C<0> if the operation would succeed, or "
15647 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15652 #: ../src/guestfs-actions.pod:4863
15653 msgid "(Added in 1.0.43)"
15658 #: ../src/guestfs-actions.pod:4865
15659 msgid "guestfs_ntfsresize"
15664 #: ../src/guestfs-actions.pod:4867
15668 " guestfs_ntfsresize (guestfs_h *g,\n"
15669 " const char *device);\n"
15675 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3275
15677 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15678 "size of the underlying device. See also L<ntfsresize(8)>."
15683 #: ../src/guestfs-actions.pod:4879
15684 msgid "guestfs_ntfsresize_size"
15689 #: ../src/guestfs-actions.pod:4881
15693 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15694 " const char *device,\n"
15695 " int64_t size);\n"
15701 #: ../src/guestfs-actions.pod:4886
15703 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15704 "to specify the new size (in bytes) explicitly."
15709 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5327
15710 #: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5666
15711 #: ../src/guestfs-actions.pod:7237
15712 msgid "(Added in 1.3.14)"
15717 #: ../src/guestfs-actions.pod:4893
15718 msgid "guestfs_part_add"
15723 #: ../src/guestfs-actions.pod:4895
15727 " guestfs_part_add (guestfs_h *g,\n"
15728 " const char *device,\n"
15729 " const char *prlogex,\n"
15730 " int64_t startsect,\n"
15731 " int64_t endsect);\n"
15737 #: ../src/guestfs-actions.pod:4902
15739 "This command adds a partition to C<device>. If there is no partition table "
15740 "on the device, call C<guestfs_part_init> first."
15745 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
15747 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15748 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15749 "C<logical>) and C<e> (or C<extended>) partition types."
15754 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3298
15756 "C<startsect> and C<endsect> are the start and end of the partition in "
15757 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15758 "from the end of the disk (C<-1> is the last sector)."
15763 #: ../src/guestfs-actions.pod:4914
15765 "Creating a partition which covers the whole disk is not so easy. Use "
15766 "C<guestfs_part_disk> to do that."
15771 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4957
15772 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5088
15773 #: ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5145
15774 #: ../src/guestfs-actions.pod:5185
15775 msgid "(Added in 1.0.78)"
15780 #: ../src/guestfs-actions.pod:4921
15781 msgid "guestfs_part_del"
15786 #: ../src/guestfs-actions.pod:4923
15790 " guestfs_part_del (guestfs_h *g,\n"
15791 " const char *device,\n"
15798 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3309
15799 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15804 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
15806 "Note that in the case of MBR partitioning, deleting an extended partition "
15807 "also deletes any logical partitions it contains."
15812 #: ../src/guestfs-actions.pod:4938
15813 msgid "guestfs_part_disk"
15818 #: ../src/guestfs-actions.pod:4940
15822 " guestfs_part_disk (guestfs_h *g,\n"
15823 " const char *device,\n"
15824 " const char *parttype);\n"
15830 #: ../src/guestfs-actions.pod:4945
15832 "This command is simply a combination of C<guestfs_part_init> followed by "
15833 "C<guestfs_part_add> to create a single primary partition covering the whole "
15839 #: ../src/guestfs-actions.pod:4949
15841 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15842 "possible values are described in C<guestfs_part_init>."
15847 #: ../src/guestfs-actions.pod:4959
15848 msgid "guestfs_part_get_bootable"
15853 #: ../src/guestfs-actions.pod:4961
15857 " guestfs_part_get_bootable (guestfs_h *g,\n"
15858 " const char *device,\n"
15865 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3333
15867 "This command returns true if the partition C<partnum> on C<device> has the "
15868 "bootable flag set."
15873 #: ../src/guestfs-actions.pod:4969
15874 msgid "See also C<guestfs_part_set_bootable>."
15879 #: ../src/guestfs-actions.pod:4975
15880 msgid "guestfs_part_get_mbr_id"
15885 #: ../src/guestfs-actions.pod:4977
15889 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15890 " const char *device,\n"
15897 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3342
15899 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15900 "partition C<partnum>."
15905 #: ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5161
15907 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15908 "undefined results for other partition table types (see "
15909 "C<guestfs_part_get_parttype>)."
15914 #: ../src/guestfs-actions.pod:4993
15915 msgid "guestfs_part_get_parttype"
15920 #: ../src/guestfs-actions.pod:4995
15924 " guestfs_part_get_parttype (guestfs_h *g,\n"
15925 " const char *device);\n"
15931 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3353
15933 "This command examines the partition table on C<device> and returns the "
15934 "partition table type (format) being used."
15939 #: ../src/guestfs-actions.pod:5002
15941 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15942 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15943 "possible, although unusual. See C<guestfs_part_init> for a full list."
15948 #: ../src/guestfs-actions.pod:5012
15949 msgid "guestfs_part_init"
15954 #: ../src/guestfs-actions.pod:5014
15958 " guestfs_part_init (guestfs_h *g,\n"
15959 " const char *device,\n"
15960 " const char *parttype);\n"
15966 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3365
15968 "This creates an empty partition table on C<device> of one of the partition "
15969 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15970 "(for large disks)."
15975 #: ../src/guestfs-actions.pod:5023
15977 "Initially there are no partitions. Following this, you should call "
15978 "C<guestfs_part_add> for each partition required."
15983 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3372
15984 msgid "Possible values for C<parttype> are:"
15989 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3376
15990 msgid "B<efi> | B<gpt>"
15995 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3378
15996 msgid "Intel EFI / GPT partition table."
16001 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
16003 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
16004 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
16005 "the C<mbr> format."
16010 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
16011 msgid "B<mbr> | B<msdos>"
16016 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
16018 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
16019 "Windows. This partition type will B<only> work for device sizes up to 2 "
16020 "TB. For large disks we recommend using C<gpt>."
16025 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
16027 "Other partition table types that may work but are not supported include:"
16032 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
16038 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3400
16039 msgid "AIX disk labels."
16044 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
16045 msgid "B<amiga> | B<rdb>"
16050 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
16051 msgid "Amiga \"Rigid Disk Block\" format."
16056 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
16062 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
16063 msgid "BSD disk labels."
16068 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
16074 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
16075 msgid "DASD, used on IBM mainframes."
16080 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
16086 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
16087 msgid "MIPS/SGI volumes."
16092 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
16098 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
16099 msgid "Old Mac partition format. Modern Macs use C<gpt>."
16104 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
16110 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
16111 msgid "NEC PC-98 format, common in Japan apparently."
16116 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
16122 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
16123 msgid "Sun disk labels."
16128 #: ../src/guestfs-actions.pod:5090
16129 msgid "guestfs_part_list"
16134 #: ../src/guestfs-actions.pod:5092
16137 " struct guestfs_partition_list *\n"
16138 " guestfs_part_list (guestfs_h *g,\n"
16139 " const char *device);\n"
16145 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3436
16147 "This command parses the partition table on C<device> and returns the list of "
16148 "partitions found."
16153 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3439
16154 msgid "The fields in the returned structure are:"
16159 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3443
16160 msgid "B<part_num>"
16165 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3445
16166 msgid "Partition number, counting from 1."
16171 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
16172 msgid "B<part_start>"
16177 #: ../src/guestfs-actions.pod:5109
16179 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16180 "the device's sector size, see C<guestfs_blockdev_getss>."
16185 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3452
16186 msgid "B<part_end>"
16191 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3454
16192 msgid "End of the partition in bytes."
16197 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3456
16198 msgid "B<part_size>"
16203 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3458
16204 msgid "Size of the partition in bytes."
16209 #: ../src/guestfs-actions.pod:5122
16211 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16212 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16218 #: ../src/guestfs-actions.pod:5128
16219 msgid "guestfs_part_set_bootable"
16224 #: ../src/guestfs-actions.pod:5130
16228 " guestfs_part_set_bootable (guestfs_h *g,\n"
16229 " const char *device,\n"
16231 " int bootable);\n"
16237 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3466
16239 "This sets the bootable flag on partition numbered C<partnum> on device "
16240 "C<device>. Note that partitions are numbered from 1."
16245 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3469
16247 "The bootable flag is used by some operating systems (notably Windows) to "
16248 "determine which partition to boot from. It is by no means universally "
16254 #: ../src/guestfs-actions.pod:5147
16255 msgid "guestfs_part_set_mbr_id"
16260 #: ../src/guestfs-actions.pod:5149
16264 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16265 " const char *device,\n"
16273 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3477
16275 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16276 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16277 "documentation are in fact hexadecimal numbers, but usually documented "
16278 "without any leading \"0x\" which might be confusing."
16283 #: ../src/guestfs-actions.pod:5169
16284 msgid "guestfs_part_set_name"
16289 #: ../src/guestfs-actions.pod:5171
16293 " guestfs_part_set_name (guestfs_h *g,\n"
16294 " const char *device,\n"
16296 " const char *name);\n"
16302 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3491
16304 "This sets the partition name on partition numbered C<partnum> on device "
16305 "C<device>. Note that partitions are numbered from 1."
16310 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3494
16312 "The partition name can only be set on certain types of partition table. "
16313 "This works on C<gpt> but not on C<mbr> partitions."
16318 #: ../src/guestfs-actions.pod:5187
16319 msgid "guestfs_part_to_dev"
16324 #: ../src/guestfs-actions.pod:5189
16328 " guestfs_part_to_dev (guestfs_h *g,\n"
16329 " const char *partition);\n"
16335 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3501
16337 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16338 "partition number, returning the device name (eg. \"/dev/sdb\")."
16343 #: ../src/guestfs-actions.pod:5197
16345 "The named partition must exist, for example as a string returned from "
16346 "C<guestfs_list_partitions>."
16351 #: ../src/guestfs-actions.pod:5205
16352 msgid "guestfs_ping_daemon"
16357 #: ../src/guestfs-actions.pod:5207
16361 " guestfs_ping_daemon (guestfs_h *g);\n"
16367 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3512
16369 "This is a test probe into the guestfs daemon running inside the qemu "
16370 "subprocess. Calling this function checks that the daemon responds to the "
16371 "ping message, without affecting the daemon or attached block device(s) in "
16377 #: ../src/guestfs-actions.pod:5219
16378 msgid "guestfs_pread"
16383 #: ../src/guestfs-actions.pod:5221
16387 " guestfs_pread (guestfs_h *g,\n"
16388 " const char *path,\n"
16390 " int64_t offset,\n"
16391 " size_t *size_r);\n"
16397 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3521
16399 "This command lets you read part of a file. It reads C<count> bytes of the "
16400 "file, starting at C<offset>, from file C<path>."
16405 #: ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5257
16406 #: ../fish/guestfish-actions.pod:3524 ../fish/guestfish-actions.pod:3539
16408 "This may read fewer bytes than requested. For further details see the "
16409 "L<pread(2)> system call."
16414 #: ../src/guestfs-actions.pod:5234
16415 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16420 #: ../src/guestfs-actions.pod:5245
16421 msgid "guestfs_pread_device"
16426 #: ../src/guestfs-actions.pod:5247
16430 " guestfs_pread_device (guestfs_h *g,\n"
16431 " const char *device,\n"
16433 " int64_t offset,\n"
16434 " size_t *size_r);\n"
16440 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3536
16442 "This command lets you read part of a file. It reads C<count> bytes of "
16443 "C<device>, starting at C<offset>."
16448 #: ../src/guestfs-actions.pod:5260
16449 msgid "See also C<guestfs_pread>."
16454 #: ../src/guestfs-actions.pod:5269
16455 msgid "(Added in 1.5.21)"
16460 #: ../src/guestfs-actions.pod:5271
16461 msgid "guestfs_pvcreate"
16466 #: ../src/guestfs-actions.pod:5273
16470 " guestfs_pvcreate (guestfs_h *g,\n"
16471 " const char *device);\n"
16477 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3551
16479 "This creates an LVM physical volume on the named C<device>, where C<device> "
16480 "should usually be a partition name such as C</dev/sda1>."
16485 #: ../src/guestfs-actions.pod:5285
16486 msgid "guestfs_pvremove"
16491 #: ../src/guestfs-actions.pod:5287
16495 " guestfs_pvremove (guestfs_h *g,\n"
16496 " const char *device);\n"
16502 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3559
16504 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16510 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3562
16512 "The implementation uses the C<pvremove> command which refuses to wipe "
16513 "physical volumes that contain any volume groups, so you have to remove those "
16519 #: ../src/guestfs-actions.pod:5302
16520 msgid "guestfs_pvresize"
16525 #: ../src/guestfs-actions.pod:5304
16529 " guestfs_pvresize (guestfs_h *g,\n"
16530 " const char *device);\n"
16536 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3570
16538 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16539 "the new size of the underlying device."
16544 #: ../src/guestfs-actions.pod:5315
16545 msgid "guestfs_pvresize_size"
16550 #: ../src/guestfs-actions.pod:5317
16554 " guestfs_pvresize_size (guestfs_h *g,\n"
16555 " const char *device,\n"
16556 " int64_t size);\n"
16562 #: ../src/guestfs-actions.pod:5322
16564 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16565 "specify the new size (in bytes) explicitly."
16570 #: ../src/guestfs-actions.pod:5329
16571 msgid "guestfs_pvs"
16576 #: ../src/guestfs-actions.pod:5331
16580 " guestfs_pvs (guestfs_h *g);\n"
16586 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3584
16588 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16594 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3587
16596 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16602 #: ../src/guestfs-actions.pod:5340
16603 msgid "See also C<guestfs_pvs_full>."
16608 #: ../src/guestfs-actions.pod:5348
16609 msgid "guestfs_pvs_full"
16614 #: ../src/guestfs-actions.pod:5350
16617 " struct guestfs_lvm_pv_list *\n"
16618 " guestfs_pvs_full (guestfs_h *g);\n"
16624 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3596
16626 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16627 "(8)> command. The \"full\" version includes all fields."
16632 #: ../src/guestfs-actions.pod:5356
16634 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16635 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16640 #: ../src/guestfs-actions.pod:5362
16641 msgid "guestfs_pvuuid"
16646 #: ../src/guestfs-actions.pod:5364
16650 " guestfs_pvuuid (guestfs_h *g,\n"
16651 " const char *device);\n"
16657 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3603
16658 msgid "This command returns the UUID of the LVM PV C<device>."
16663 #: ../src/guestfs-actions.pod:5375
16664 msgid "guestfs_pwrite"
16669 #: ../src/guestfs-actions.pod:5377
16673 " guestfs_pwrite (guestfs_h *g,\n"
16674 " const char *path,\n"
16675 " const char *content,\n"
16676 " size_t content_size,\n"
16677 " int64_t offset);\n"
16683 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3609
16685 "This command writes to part of a file. It writes the data buffer C<content> "
16686 "to the file C<path> starting at offset C<offset>."
16691 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3612
16693 "This command implements the L<pwrite(2)> system call, and like that system "
16694 "call it may not write the full data requested. The return value is the "
16695 "number of bytes that were actually written to the file. This could even be "
16696 "0, although short writes are unlikely for regular files in ordinary "
16702 #: ../src/guestfs-actions.pod:5393
16703 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16708 #: ../src/guestfs-actions.pod:5402
16709 msgid "guestfs_pwrite_device"
16714 #: ../src/guestfs-actions.pod:5404
16718 " guestfs_pwrite_device (guestfs_h *g,\n"
16719 " const char *device,\n"
16720 " const char *content,\n"
16721 " size_t content_size,\n"
16722 " int64_t offset);\n"
16728 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3627
16730 "This command writes to part of a device. It writes the data buffer "
16731 "C<content> to C<device> starting at offset C<offset>."
16736 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
16738 "This command implements the L<pwrite(2)> system call, and like that system "
16739 "call it may not write the full data requested (although short writes to disk "
16740 "devices and partitions are probably impossible with standard Linux kernels)."
16745 #: ../src/guestfs-actions.pod:5419
16746 msgid "See also C<guestfs_pwrite>."
16751 #: ../src/guestfs-actions.pod:5426
16752 msgid "(Added in 1.5.20)"
16757 #: ../src/guestfs-actions.pod:5428
16758 msgid "guestfs_read_file"
16763 #: ../src/guestfs-actions.pod:5430
16767 " guestfs_read_file (guestfs_h *g,\n"
16768 " const char *path,\n"
16769 " size_t *size_r);\n"
16775 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3644
16776 msgid "This calls returns the contents of the file C<path> as a buffer."
16781 #: ../src/guestfs-actions.pod:5438
16783 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16784 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16785 "function is limited in the total size of file that can be handled."
16790 #: ../src/guestfs-actions.pod:5450
16791 msgid "(Added in 1.0.63)"
16796 #: ../src/guestfs-actions.pod:5452
16797 msgid "guestfs_read_lines"
16802 #: ../src/guestfs-actions.pod:5454
16806 " guestfs_read_lines (guestfs_h *g,\n"
16807 " const char *path);\n"
16813 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3661
16815 "The file contents are returned as a list of lines. Trailing C<LF> and "
16816 "C<CRLF> character sequences are I<not> returned."
16821 #: ../src/guestfs-actions.pod:5463
16823 "Note that this function cannot correctly handle binary files (specifically, "
16824 "files containing C<\\0> character which is treated as end of line). For "
16825 "those you need to use the C<guestfs_read_file> function which has a more "
16826 "complex interface."
16831 #: ../src/guestfs-actions.pod:5474
16832 msgid "guestfs_readdir"
16837 #: ../src/guestfs-actions.pod:5476
16840 " struct guestfs_dirent_list *\n"
16841 " guestfs_readdir (guestfs_h *g,\n"
16842 " const char *dir);\n"
16848 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3673
16849 msgid "This returns the list of directory entries in directory C<dir>."
16854 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3675
16856 "All entries in the directory are returned, including C<.> and C<..>. The "
16857 "entries are I<not> sorted, but returned in the same order as the underlying "
16863 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3679
16865 "Also this call returns basic file type information about each file. The "
16866 "C<ftyp> field will contain one of the following characters:"
16871 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3684
16877 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3686
16878 msgid "Block special"
16883 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3688
16889 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3690
16890 msgid "Char special"
16895 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
16901 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
16907 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
16913 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
16914 msgid "FIFO (named pipe)"
16919 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
16925 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
16926 msgid "Symbolic link"
16931 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
16937 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
16938 msgid "Regular file"
16943 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
16949 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
16955 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
16961 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
16962 msgid "Unknown file type"
16967 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
16973 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
16975 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16980 #: ../src/guestfs-actions.pod:5530
16982 "This function is primarily intended for use by programs. To get a simple "
16983 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16984 "consumption, use C<guestfs_ll>."
16989 #: ../src/guestfs-actions.pod:5534
16991 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16992 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16997 #: ../src/guestfs-actions.pod:5540
16998 msgid "guestfs_readlink"
17003 #: ../src/guestfs-actions.pod:5542
17007 " guestfs_readlink (guestfs_h *g,\n"
17008 " const char *path);\n"
17014 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3731
17015 msgid "This command reads the target of a symbolic link."
17020 #: ../src/guestfs-actions.pod:5553
17021 msgid "guestfs_readlinklist"
17026 #: ../src/guestfs-actions.pod:5555
17030 " guestfs_readlinklist (guestfs_h *g,\n"
17031 " const char *path,\n"
17032 " char *const *names);\n"
17038 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3737
17040 "This call allows you to do a C<readlink> operation on multiple files, where "
17041 "all files are in the directory C<path>. C<names> is the list of files from "
17047 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3741
17049 "On return you get a list of strings, with a one-to-one correspondence to the "
17050 "C<names> list. Each string is the value of the symbolic link."
17055 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
17057 "If the C<readlink(2)> operation fails on any name, then the corresponding "
17058 "result string is the empty string C<\"\">. However the whole operation is "
17059 "completed even if there were C<readlink(2)> errors, and so you can call this "
17060 "function with names where you don't know if they are symbolic links already "
17061 "(albeit slightly less efficient)."
17066 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3752
17068 "This call is intended for programs that want to efficiently list a directory "
17069 "contents without making many round-trips. Very long directory listings "
17070 "might cause the protocol message size to be exceeded, causing this call to "
17071 "fail. The caller must split up such requests into smaller groups of names."
17076 #: ../src/guestfs-actions.pod:5588
17077 msgid "guestfs_realpath"
17082 #: ../src/guestfs-actions.pod:5590
17086 " guestfs_realpath (guestfs_h *g,\n"
17087 " const char *path);\n"
17093 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3763
17095 "Return the canonicalized absolute pathname of C<path>. The returned path "
17096 "has no C<.>, C<..> or symbolic link path elements."
17101 #: ../src/guestfs-actions.pod:5602
17102 msgid "guestfs_removexattr"
17107 #: ../src/guestfs-actions.pod:5604
17111 " guestfs_removexattr (guestfs_h *g,\n"
17112 " const char *xattr,\n"
17113 " const char *path);\n"
17119 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3770
17121 "This call removes the extended attribute named C<xattr> of the file C<path>."
17126 #: ../src/guestfs-actions.pod:5612
17127 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17132 #: ../src/guestfs-actions.pod:5618
17133 msgid "guestfs_resize2fs"
17138 #: ../src/guestfs-actions.pod:5620
17142 " guestfs_resize2fs (guestfs_h *g,\n"
17143 " const char *device);\n"
17149 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3779
17151 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17152 "underlying device."
17157 #: ../src/guestfs-actions.pod:5627
17159 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17160 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17161 "sometimes gives an error about this and sometimes not. In any case, it is "
17162 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17166 #: ../src/guestfs-actions.pod:5637
17167 msgid "guestfs_resize2fs_M"
17171 #: ../src/guestfs-actions.pod:5639
17175 " guestfs_resize2fs_M (guestfs_h *g,\n"
17176 " const char *device);\n"
17181 #: ../src/guestfs-actions.pod:5643
17183 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17184 "resized to its minimum size. This works like the C<-M> option to the "
17185 "C<resize2fs> command."
17189 #: ../src/guestfs-actions.pod:5647
17191 "To get the resulting size of the filesystem you should call "
17192 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17193 "These two numbers, multiplied together, give the resulting size of the "
17194 "minimal filesystem in bytes."
17199 #: ../src/guestfs-actions.pod:5654
17200 msgid "guestfs_resize2fs_size"
17205 #: ../src/guestfs-actions.pod:5656
17209 " guestfs_resize2fs_size (guestfs_h *g,\n"
17210 " const char *device,\n"
17211 " int64_t size);\n"
17217 #: ../src/guestfs-actions.pod:5661
17219 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17220 "to specify the new size (in bytes) explicitly."
17225 #: ../src/guestfs-actions.pod:5668
17231 #: ../src/guestfs-actions.pod:5670
17235 " guestfs_rm (guestfs_h *g,\n"
17236 " const char *path);\n"
17242 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3812
17243 msgid "Remove the single file C<path>."
17248 #: ../src/guestfs-actions.pod:5680
17249 msgid "guestfs_rm_rf"
17254 #: ../src/guestfs-actions.pod:5682
17258 " guestfs_rm_rf (guestfs_h *g,\n"
17259 " const char *path);\n"
17265 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3818
17267 "Remove the file or directory C<path>, recursively removing the contents if "
17268 "its a directory. This is like the C<rm -rf> shell command."
17273 #: ../src/guestfs-actions.pod:5694
17274 msgid "guestfs_rmdir"
17279 #: ../src/guestfs-actions.pod:5696
17283 " guestfs_rmdir (guestfs_h *g,\n"
17284 " const char *path);\n"
17290 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3826
17291 msgid "Remove the single directory C<path>."
17296 #: ../src/guestfs-actions.pod:5706
17297 msgid "guestfs_rmmountpoint"
17302 #: ../src/guestfs-actions.pod:5708
17306 " guestfs_rmmountpoint (guestfs_h *g,\n"
17307 " const char *exemptpath);\n"
17313 #: ../src/guestfs-actions.pod:5712
17315 "This calls removes a mountpoint that was previously created with "
17316 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17321 #: ../src/guestfs-actions.pod:5720
17322 msgid "guestfs_scrub_device"
17327 #: ../src/guestfs-actions.pod:5722
17331 " guestfs_scrub_device (guestfs_h *g,\n"
17332 " const char *device);\n"
17338 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3840
17340 "This command writes patterns over C<device> to make data retrieval more "
17346 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5750
17347 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3843
17348 #: ../fish/guestfish-actions.pod:3858 ../fish/guestfish-actions.pod:3871
17350 "It is an interface to the L<scrub(1)> program. See that manual page for "
17356 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5755
17357 #: ../src/guestfs-actions.pod:5774
17358 msgid "(Added in 1.0.52)"
17363 #: ../src/guestfs-actions.pod:5739
17364 msgid "guestfs_scrub_file"
17369 #: ../src/guestfs-actions.pod:5741
17373 " guestfs_scrub_file (guestfs_h *g,\n"
17374 " const char *file);\n"
17380 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3853
17382 "This command writes patterns over a file to make data retrieval more "
17388 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3856
17389 msgid "The file is I<removed> after scrubbing."
17394 #: ../src/guestfs-actions.pod:5757
17395 msgid "guestfs_scrub_freespace"
17400 #: ../src/guestfs-actions.pod:5759
17404 " guestfs_scrub_freespace (guestfs_h *g,\n"
17405 " const char *dir);\n"
17411 #: ../src/guestfs-actions.pod:5763
17413 "This command creates the directory C<dir> and then fills it with files until "
17414 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17415 "and deletes them. The intention is to scrub any free space on the partition "
17416 "containing C<dir>."
17421 #: ../src/guestfs-actions.pod:5776
17422 msgid "guestfs_set_append"
17427 #: ../src/guestfs-actions.pod:5778
17431 " guestfs_set_append (guestfs_h *g,\n"
17432 " const char *append);\n"
17438 #: ../src/guestfs-actions.pod:5782 ../fish/guestfish-actions.pod:3880
17440 "This function is used to add additional options to the guest kernel command "
17446 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3883
17448 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17449 "environment variable."
17454 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3886
17456 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17457 "(libguestfs always adds a few of its own)."
17461 #: ../src/guestfs-actions.pod:5795
17462 msgid "guestfs_set_attach_method"
17466 #: ../src/guestfs-actions.pod:5797
17470 " guestfs_set_attach_method (guestfs_h *g,\n"
17471 " const char *attachmethod);\n"
17476 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3895
17478 "Set the method that libguestfs uses to connect to the back end guestfsd "
17479 "daemon. Possible methods are:"
17483 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
17485 "Launch an appliance and connect to it. This is the ordinary method and the "
17490 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
17491 msgid "C<unix:I<path>>"
17495 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
17496 msgid "Connect to the Unix domain socket I<path>."
17500 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3909
17502 "This method lets you connect to an existing daemon or (using virtio-serial) "
17503 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17504 "RUNNING DAEMONS>."
17509 #: ../src/guestfs-actions.pod:5823
17510 msgid "guestfs_set_autosync"
17515 #: ../src/guestfs-actions.pod:5825
17519 " guestfs_set_autosync (guestfs_h *g,\n"
17520 " int autosync);\n"
17525 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3921
17527 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17528 "effort attempt to make filesystems consistent and synchronized when the "
17529 "handle is closed (also if the program exits without closing handles)."
17534 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3926
17536 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17537 "disabled by default)."
17542 #: ../src/guestfs-actions.pod:5841
17543 msgid "guestfs_set_direct"
17548 #: ../src/guestfs-actions.pod:5843
17552 " guestfs_set_direct (guestfs_h *g,\n"
17559 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3935
17561 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17562 "passed directly through to the appliance once it is launched."
17567 #: ../src/guestfs-actions.pod:5851
17569 "One consequence of this is that log messages aren't caught by the library "
17570 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17576 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
17577 msgid "You probably don't want to use this unless you know what you are doing."
17582 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3946
17583 msgid "The default is disabled."
17588 #: ../src/guestfs-actions.pod:5864
17589 msgid "guestfs_set_e2label"
17594 #: ../src/guestfs-actions.pod:5866
17598 " guestfs_set_e2label (guestfs_h *g,\n"
17599 " const char *device,\n"
17600 " const char *label);\n"
17606 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3952
17608 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17609 "C<label>. Filesystem labels are limited to 16 characters."
17614 #: ../src/guestfs-actions.pod:5875
17616 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17617 "the existing label on a filesystem."
17622 #: ../src/guestfs-actions.pod:5882
17623 msgid "guestfs_set_e2uuid"
17628 #: ../src/guestfs-actions.pod:5884
17632 " guestfs_set_e2uuid (guestfs_h *g,\n"
17633 " const char *device,\n"
17634 " const char *uuid);\n"
17640 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3963
17642 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17643 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17644 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17649 #: ../src/guestfs-actions.pod:5894
17651 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17652 "the existing UUID of a filesystem."
17657 #: ../src/guestfs-actions.pod:5901
17658 msgid "guestfs_set_memsize"
17663 #: ../src/guestfs-actions.pod:5903
17667 " guestfs_set_memsize (guestfs_h *g,\n"
17674 #: ../src/guestfs-actions.pod:5907
17676 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17677 "This only has any effect if called before C<guestfs_launch>."
17682 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3981
17684 "You can also change this by setting the environment variable "
17685 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17690 #: ../src/guestfs-actions.pod:5922
17691 msgid "guestfs_set_network"
17696 #: ../src/guestfs-actions.pod:5924
17700 " guestfs_set_network (guestfs_h *g,\n"
17707 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3994
17709 "If C<network> is true, then the network is enabled in the libguestfs "
17710 "appliance. The default is false."
17715 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3997
17717 "This affects whether commands are able to access the network (see L<guestfs"
17718 "(3)/RUNNING COMMANDS>)."
17723 #: ../src/guestfs-actions.pod:5934
17725 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17731 #: ../src/guestfs-actions.pod:5941
17732 msgid "guestfs_set_path"
17737 #: ../src/guestfs-actions.pod:5943
17741 " guestfs_set_path (guestfs_h *g,\n"
17742 " const char *searchpath);\n"
17748 #: ../src/guestfs-actions.pod:5947 ../fish/guestfish-actions.pod:4009
17749 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17754 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4011
17756 "The default is C<$libdir/guestfs> unless overridden by setting "
17757 "C<LIBGUESTFS_PATH> environment variable."
17762 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4014
17763 msgid "Setting C<path> to C<NULL> restores the default path."
17768 #: ../src/guestfs-actions.pod:5958
17769 msgid "guestfs_set_qemu"
17774 #: ../src/guestfs-actions.pod:5960
17778 " guestfs_set_qemu (guestfs_h *g,\n"
17779 " const char *qemu);\n"
17785 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4022
17786 msgid "Set the qemu binary that we will use."
17791 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4024
17793 "The default is chosen when the library was compiled by the configure script."
17798 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4027
17800 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17806 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
17807 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17812 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
17814 "Note that you should call this function as early as possible after creating "
17815 "the handle. This is because some pre-launch operations depend on testing "
17816 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17817 "don't retest features, and so you might see inconsistent results. Using the "
17818 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17819 "the qemu binary at the same time as the handle is created."
17824 #: ../src/guestfs-actions.pod:5986
17825 msgid "guestfs_set_recovery_proc"
17830 #: ../src/guestfs-actions.pod:5988
17834 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17835 " int recoveryproc);\n"
17841 #: ../src/guestfs-actions.pod:5992
17843 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17844 "not create a recovery process. The purpose of the recovery process is to "
17845 "stop runaway qemu processes in the case where the main program aborts "
17851 #: ../src/guestfs-actions.pod:5997
17853 "This only has any effect if called before C<guestfs_launch>, and the default "
17859 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4054
17861 "About the only time when you would want to disable this is if the main "
17862 "process will fork itself into the background (\"daemonize\" itself). In "
17863 "this case the recovery process thinks that the main program has disappeared "
17864 "and so kills qemu, which is not very helpful."
17869 #: ../src/guestfs-actions.pod:6010
17870 msgid "guestfs_set_selinux"
17875 #: ../src/guestfs-actions.pod:6012
17879 " guestfs_set_selinux (guestfs_h *g,\n"
17886 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4066
17888 "This sets the selinux flag that is passed to the appliance at boot time. "
17889 "The default is C<selinux=0> (disabled)."
17894 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4069
17896 "Note that if SELinux is enabled, it is always in Permissive mode "
17897 "(C<enforcing=0>)."
17902 #: ../src/guestfs-actions.pod:6029
17903 msgid "guestfs_set_trace"
17908 #: ../src/guestfs-actions.pod:6031
17912 " guestfs_set_trace (guestfs_h *g,\n"
17918 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4081
17920 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17921 "return values are traced."
17926 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4084
17928 "If you want to trace C API calls into libguestfs (and other libraries) then "
17929 "possibly a better way is to use the external ltrace(1) command."
17934 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4088
17936 "Command traces are disabled unless the environment variable "
17937 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17941 #: ../src/guestfs-actions.pod:6045
17943 "Trace messages are normally sent to C<stderr>, unless you register a "
17944 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17949 #: ../src/guestfs-actions.pod:6053
17950 msgid "guestfs_set_verbose"
17955 #: ../src/guestfs-actions.pod:6055
17959 " guestfs_set_verbose (guestfs_h *g,\n"
17965 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4101
17966 msgid "If C<verbose> is true, this turns on verbose messages."
17971 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4103
17973 "Verbose messages are disabled unless the environment variable "
17974 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17978 #: ../src/guestfs-actions.pod:6064
17980 "Verbose messages are normally sent to C<stderr>, unless you register a "
17981 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17986 #: ../src/guestfs-actions.pod:6072
17987 msgid "guestfs_setcon"
17992 #: ../src/guestfs-actions.pod:6074
17996 " guestfs_setcon (guestfs_h *g,\n"
17997 " const char *context);\n"
18003 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4114
18005 "This sets the SELinux security context of the daemon to the string "
18011 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4117
18012 msgid "See the documentation about SELINUX in L<guestfs(3)>."
18017 #: ../src/guestfs-actions.pod:6087
18018 msgid "guestfs_setxattr"
18023 #: ../src/guestfs-actions.pod:6089
18027 " guestfs_setxattr (guestfs_h *g,\n"
18028 " const char *xattr,\n"
18029 " const char *val,\n"
18031 " const char *path);\n"
18037 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4123
18039 "This call sets the extended attribute named C<xattr> of the file C<path> to "
18040 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
18045 #: ../src/guestfs-actions.pod:6100
18046 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
18051 #: ../src/guestfs-actions.pod:6106
18052 msgid "guestfs_sfdisk"
18057 #: ../src/guestfs-actions.pod:6108
18061 " guestfs_sfdisk (guestfs_h *g,\n"
18062 " const char *device,\n"
18066 " char *const *lines);\n"
18072 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4133
18074 "This is a direct interface to the L<sfdisk(8)> program for creating "
18075 "partitions on block devices."
18080 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4136
18081 msgid "C<device> should be a block device, for example C</dev/sda>."
18086 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4138
18088 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
18089 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
18090 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
18091 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
18092 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
18093 "the kernel) cannot work out the right geometry and you will need to tell it."
18098 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
18100 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
18101 "refer to the L<sfdisk(8)> manpage."
18106 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4149
18108 "To create a single partition occupying the whole disk, you would pass "
18109 "C<lines> as a single element list, when the single element being the string "
18115 #: ../src/guestfs-actions.pod:6136
18117 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18122 #: ../src/guestfs-actions.pod:6146
18123 msgid "guestfs_sfdiskM"
18128 #: ../src/guestfs-actions.pod:6148
18132 " guestfs_sfdiskM (guestfs_h *g,\n"
18133 " const char *device,\n"
18134 " char *const *lines);\n"
18140 #: ../src/guestfs-actions.pod:6153
18142 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18143 "partition sizes are specified in megabytes only (rounded to the nearest "
18144 "cylinder) and you don't need to specify the cyls, heads and sectors "
18145 "parameters which were rarely if ever used anyway."
18150 #: ../src/guestfs-actions.pod:6159
18152 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18153 "C<guestfs_part_disk>"
18158 #: ../src/guestfs-actions.pod:6169
18159 msgid "guestfs_sfdisk_N"
18164 #: ../src/guestfs-actions.pod:6171
18168 " guestfs_sfdisk_N (guestfs_h *g,\n"
18169 " const char *device,\n"
18174 " const char *line);\n"
18180 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4179
18182 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18183 "(note: C<n> counts from 1)."
18188 #: ../src/guestfs-actions.pod:6183
18190 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18191 "for the cyls/heads/sectors parameters."
18196 #: ../src/guestfs-actions.pod:6186
18197 msgid "See also: C<guestfs_part_add>"
18202 #: ../src/guestfs-actions.pod:6195
18203 msgid "guestfs_sfdisk_disk_geometry"
18208 #: ../src/guestfs-actions.pod:6197
18212 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18213 " const char *device);\n"
18219 #: ../src/guestfs-actions.pod:6201
18221 "This displays the disk geometry of C<device> read from the partition table. "
18222 "Especially in the case where the underlying block device has been resized, "
18223 "this can be different from the kernel's idea of the geometry (see "
18224 "C<guestfs_sfdisk_kernel_geometry>)."
18229 #: ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6222
18230 #: ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4208
18231 msgid "The result is in human-readable format, and not designed to be parsed."
18236 #: ../src/guestfs-actions.pod:6214
18237 msgid "guestfs_sfdisk_kernel_geometry"
18242 #: ../src/guestfs-actions.pod:6216
18246 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18247 " const char *device);\n"
18253 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4206
18254 msgid "This displays the kernel's idea of the geometry of C<device>."
18259 #: ../src/guestfs-actions.pod:6230
18260 msgid "guestfs_sfdisk_l"
18265 #: ../src/guestfs-actions.pod:6232
18269 " guestfs_sfdisk_l (guestfs_h *g,\n"
18270 " const char *device);\n"
18276 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4215
18278 "This displays the partition table on C<device>, in the human-readable output "
18279 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18284 #: ../src/guestfs-actions.pod:6240
18285 msgid "See also: C<guestfs_part_list>"
18290 #: ../src/guestfs-actions.pod:6247
18296 #: ../src/guestfs-actions.pod:6249
18300 " guestfs_sh (guestfs_h *g,\n"
18301 " const char *command);\n"
18307 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4225
18309 "This call runs a command from the guest filesystem via the guest's C</bin/"
18315 #: ../src/guestfs-actions.pod:6256
18316 msgid "This is like C<guestfs_command>, but passes the command to:"
18321 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4230
18324 " /bin/sh -c \"command\"\n"
18330 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4232
18332 "Depending on the guest's shell, this usually results in wildcards being "
18333 "expanded, shell expressions being interpolated and so on."
18338 #: ../src/guestfs-actions.pod:6264
18339 msgid "All the provisos about C<guestfs_command> apply to this call."
18344 #: ../src/guestfs-actions.pod:6271
18345 msgid "guestfs_sh_lines"
18350 #: ../src/guestfs-actions.pod:6273
18354 " guestfs_sh_lines (guestfs_h *g,\n"
18355 " const char *command);\n"
18361 #: ../src/guestfs-actions.pod:6277
18363 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18369 #: ../src/guestfs-actions.pod:6280
18370 msgid "See also: C<guestfs_command_lines>"
18375 #: ../src/guestfs-actions.pod:6288
18376 msgid "guestfs_sleep"
18381 #: ../src/guestfs-actions.pod:6290
18385 " guestfs_sleep (guestfs_h *g,\n"
18392 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4251
18393 msgid "Sleep for C<secs> seconds."
18398 #: ../src/guestfs-actions.pod:6298
18399 msgid "(Added in 1.0.41)"
18404 #: ../src/guestfs-actions.pod:6300 ../src/guestfs-structs.pod:109
18405 msgid "guestfs_stat"
18410 #: ../src/guestfs-actions.pod:6302
18413 " struct guestfs_stat *\n"
18414 " guestfs_stat (guestfs_h *g,\n"
18415 " const char *path);\n"
18421 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4259
18422 msgid "This is the same as the C<stat(2)> system call."
18427 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-structs.pod:135
18428 msgid "guestfs_statvfs"
18433 #: ../src/guestfs-actions.pod:6318
18436 " struct guestfs_statvfs *\n"
18437 " guestfs_statvfs (guestfs_h *g,\n"
18438 " const char *path);\n"
18444 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4265
18446 "Returns file system statistics for any mounted file system. C<path> should "
18447 "be a file or directory in the mounted file system (typically it is the mount "
18448 "point itself, but it doesn't need to be)."
18453 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4269
18454 msgid "This is the same as the C<statvfs(2)> system call."
18459 #: ../src/guestfs-actions.pod:6328
18461 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18462 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18467 #: ../src/guestfs-actions.pod:6334
18468 msgid "guestfs_strings"
18473 #: ../src/guestfs-actions.pod:6336
18477 " guestfs_strings (guestfs_h *g,\n"
18478 " const char *path);\n"
18484 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4275
18486 "This runs the L<strings(1)> command on a file and returns the list of "
18487 "printable strings found."
18492 #: ../src/guestfs-actions.pod:6352
18493 msgid "guestfs_strings_e"
18498 #: ../src/guestfs-actions.pod:6354
18502 " guestfs_strings_e (guestfs_h *g,\n"
18503 " const char *encoding,\n"
18504 " const char *path);\n"
18510 #: ../src/guestfs-actions.pod:6359
18512 "This is like the C<guestfs_strings> command, but allows you to specify the "
18513 "encoding of strings that are looked for in the source file C<path>."
18518 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4289
18519 msgid "Allowed encodings are:"
18524 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4293
18530 #: ../src/guestfs-actions.pod:6369
18532 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18533 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18538 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4298
18544 #: ../src/guestfs-actions.pod:6374 ../fish/guestfish-actions.pod:4300
18545 msgid "Single 8-bit-byte characters."
18550 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4302
18556 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4304
18557 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18562 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4307
18563 msgid "l (lower case letter L)"
18568 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4309
18570 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18571 "examining binaries in Windows guests."
18576 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
18582 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4314
18583 msgid "32-bit big endian such as UCS-4BE."
18588 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4316
18594 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4318
18595 msgid "32-bit little endian such as UCS-4LE."
18600 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
18601 msgid "The returned strings are transcoded to UTF-8."
18606 #: ../src/guestfs-actions.pod:6407
18607 msgid "guestfs_swapoff_device"
18612 #: ../src/guestfs-actions.pod:6409
18616 " guestfs_swapoff_device (guestfs_h *g,\n"
18617 " const char *device);\n"
18623 #: ../src/guestfs-actions.pod:6413
18625 "This command disables the libguestfs appliance swap device or partition "
18626 "named C<device>. See C<guestfs_swapon_device>."
18631 #: ../src/guestfs-actions.pod:6421
18632 msgid "guestfs_swapoff_file"
18637 #: ../src/guestfs-actions.pod:6423
18641 " guestfs_swapoff_file (guestfs_h *g,\n"
18642 " const char *file);\n"
18648 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4339
18649 msgid "This command disables the libguestfs appliance swap on file."
18654 #: ../src/guestfs-actions.pod:6433
18655 msgid "guestfs_swapoff_label"
18660 #: ../src/guestfs-actions.pod:6435
18664 " guestfs_swapoff_label (guestfs_h *g,\n"
18665 " const char *label);\n"
18671 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4345
18673 "This command disables the libguestfs appliance swap on labeled swap "
18679 #: ../src/guestfs-actions.pod:6446
18680 msgid "guestfs_swapoff_uuid"
18685 #: ../src/guestfs-actions.pod:6448
18689 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18690 " const char *uuid);\n"
18696 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4352
18698 "This command disables the libguestfs appliance swap partition with the given "
18704 #: ../src/guestfs-actions.pod:6459
18705 msgid "guestfs_swapon_device"
18710 #: ../src/guestfs-actions.pod:6461
18714 " guestfs_swapon_device (guestfs_h *g,\n"
18715 " const char *device);\n"
18721 #: ../src/guestfs-actions.pod:6465
18723 "This command enables the libguestfs appliance to use the swap device or "
18724 "partition named C<device>. The increased memory is made available for all "
18725 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18730 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4364
18732 "Note that you should not swap to existing guest swap partitions unless you "
18733 "know what you are doing. They may contain hibernation information, or other "
18734 "information that the guest doesn't want you to trash. You also risk leaking "
18735 "information about the host to the guest this way. Instead, attach a new "
18736 "host device to the guest and swap on that."
18741 #: ../src/guestfs-actions.pod:6481
18742 msgid "guestfs_swapon_file"
18747 #: ../src/guestfs-actions.pod:6483
18751 " guestfs_swapon_file (guestfs_h *g,\n"
18752 " const char *file);\n"
18758 #: ../src/guestfs-actions.pod:6487
18760 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18766 #: ../src/guestfs-actions.pod:6494
18767 msgid "guestfs_swapon_label"
18772 #: ../src/guestfs-actions.pod:6496
18776 " guestfs_swapon_label (guestfs_h *g,\n"
18777 " const char *label);\n"
18783 #: ../src/guestfs-actions.pod:6500
18785 "This command enables swap to a labeled swap partition. See "
18786 "C<guestfs_swapon_device> for other notes."
18791 #: ../src/guestfs-actions.pod:6507
18792 msgid "guestfs_swapon_uuid"
18797 #: ../src/guestfs-actions.pod:6509
18801 " guestfs_swapon_uuid (guestfs_h *g,\n"
18802 " const char *uuid);\n"
18808 #: ../src/guestfs-actions.pod:6513
18810 "This command enables swap to a swap partition with the given UUID. See "
18811 "C<guestfs_swapon_device> for other notes."
18816 #: ../src/guestfs-actions.pod:6520
18817 msgid "guestfs_sync"
18822 #: ../src/guestfs-actions.pod:6522
18826 " guestfs_sync (guestfs_h *g);\n"
18832 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4396
18834 "This syncs the disk, so that any writes are flushed through to the "
18835 "underlying disk image."
18840 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4399
18842 "You should always call this if you have modified a disk image, before "
18843 "closing the handle."
18848 #: ../src/guestfs-actions.pod:6535
18849 msgid "guestfs_tail"
18854 #: ../src/guestfs-actions.pod:6537
18858 " guestfs_tail (guestfs_h *g,\n"
18859 " const char *path);\n"
18865 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4406
18867 "This command returns up to the last 10 lines of a file as a list of strings."
18872 #: ../src/guestfs-actions.pod:6553
18873 msgid "guestfs_tail_n"
18878 #: ../src/guestfs-actions.pod:6555
18882 " guestfs_tail_n (guestfs_h *g,\n"
18884 " const char *path);\n"
18890 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4416
18892 "If the parameter C<nrlines> is a positive number, this returns the last "
18893 "C<nrlines> lines of the file C<path>."
18898 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4419
18900 "If the parameter C<nrlines> is a negative number, this returns lines from "
18901 "the file C<path>, starting with the C<-nrlines>th line."
18906 #: ../src/guestfs-actions.pod:6577
18907 msgid "guestfs_tar_in"
18912 #: ../src/guestfs-actions.pod:6579
18916 " guestfs_tar_in (guestfs_h *g,\n"
18917 " const char *tarfile,\n"
18918 " const char *directory);\n"
18924 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4431
18926 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18927 "tar file) into C<directory>."
18932 #: ../src/guestfs-actions.pod:6587
18934 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18939 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6609
18940 #: ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6641
18941 msgid "(Added in 1.0.3)"
18946 #: ../src/guestfs-actions.pod:6594
18947 msgid "guestfs_tar_out"
18952 #: ../src/guestfs-actions.pod:6596
18956 " guestfs_tar_out (guestfs_h *g,\n"
18957 " const char *directory,\n"
18958 " const char *tarfile);\n"
18964 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4443
18966 "This command packs the contents of C<directory> and downloads it to local "
18972 #: ../src/guestfs-actions.pod:6604
18974 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18975 "C<guestfs_txz_out>."
18980 #: ../src/guestfs-actions.pod:6611
18981 msgid "guestfs_tgz_in"
18986 #: ../src/guestfs-actions.pod:6613
18990 " guestfs_tgz_in (guestfs_h *g,\n"
18991 " const char *tarball,\n"
18992 " const char *directory);\n"
18998 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4455
19000 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
19001 "tar file) into C<directory>."
19006 #: ../src/guestfs-actions.pod:6621
19007 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
19012 #: ../src/guestfs-actions.pod:6627
19013 msgid "guestfs_tgz_out"
19018 #: ../src/guestfs-actions.pod:6629
19022 " guestfs_tgz_out (guestfs_h *g,\n"
19023 " const char *directory,\n"
19024 " const char *tarball);\n"
19030 #: ../src/guestfs-actions.pod:6634 ../fish/guestfish-actions.pod:4466
19032 "This command packs the contents of C<directory> and downloads it to local "
19038 #: ../src/guestfs-actions.pod:6637
19039 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
19044 #: ../src/guestfs-actions.pod:6643
19045 msgid "guestfs_touch"
19050 #: ../src/guestfs-actions.pod:6645
19054 " guestfs_touch (guestfs_h *g,\n"
19055 " const char *path);\n"
19061 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4477
19063 "Touch acts like the L<touch(1)> command. It can be used to update the "
19064 "timestamps on a file, or, if the file does not exist, to create a new zero-"
19070 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4481
19072 "This command only works on regular files, and will fail on other file types "
19073 "such as directories, symbolic links, block special etc."
19078 #: ../src/guestfs-actions.pod:6660
19079 msgid "guestfs_truncate"
19084 #: ../src/guestfs-actions.pod:6662
19088 " guestfs_truncate (guestfs_h *g,\n"
19089 " const char *path);\n"
19095 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4488
19097 "This command truncates C<path> to a zero-length file. The file must exist "
19103 #: ../src/guestfs-actions.pod:6673
19104 msgid "guestfs_truncate_size"
19109 #: ../src/guestfs-actions.pod:6675
19113 " guestfs_truncate_size (guestfs_h *g,\n"
19114 " const char *path,\n"
19115 " int64_t size);\n"
19121 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4495
19123 "This command truncates C<path> to size C<size> bytes. The file must exist "
19129 #: ../src/guestfs-actions.pod:6683
19131 "If the current file size is less than C<size> then the file is extended to "
19132 "the required size with zero bytes. This creates a sparse file (ie. disk "
19133 "blocks are not allocated for the file until you write to it). To create a "
19134 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19139 #: ../src/guestfs-actions.pod:6693
19140 msgid "guestfs_tune2fs_l"
19145 #: ../src/guestfs-actions.pod:6695
19149 " guestfs_tune2fs_l (guestfs_h *g,\n"
19150 " const char *device);\n"
19156 #: ../src/guestfs-actions.pod:6699 ../fish/guestfish-actions.pod:4508
19158 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19164 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4511
19166 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19167 "for more details. The list of fields returned isn't clearly defined, and "
19168 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19169 "and the filesystem itself."
19174 #: ../src/guestfs-actions.pod:6715
19175 msgid "guestfs_txz_in"
19180 #: ../src/guestfs-actions.pod:6717
19184 " guestfs_txz_in (guestfs_h *g,\n"
19185 " const char *tarball,\n"
19186 " const char *directory);\n"
19192 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4520
19194 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19195 "tar file) into C<directory>."
19200 #: ../src/guestfs-actions.pod:6729
19201 msgid "guestfs_txz_out"
19206 #: ../src/guestfs-actions.pod:6731
19210 " guestfs_txz_out (guestfs_h *g,\n"
19211 " const char *directory,\n"
19212 " const char *tarball);\n"
19218 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4529
19220 "This command packs the contents of C<directory> and downloads it to local "
19221 "file C<tarball> (as an xz compressed tar archive)."
19226 #: ../src/guestfs-actions.pod:6743
19227 msgid "guestfs_umask"
19232 #: ../src/guestfs-actions.pod:6745
19236 " guestfs_umask (guestfs_h *g,\n"
19243 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4538
19245 "This function sets the mask used for creating new files and device nodes to "
19251 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4541
19253 "Typical umask values would be C<022> which creates new files with "
19254 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19255 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19260 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
19262 "The default umask is C<022>. This is important because it means that "
19263 "directories and device nodes will be created with C<0644> or C<0755> mode "
19264 "even if you specify C<0777>."
19269 #: ../src/guestfs-actions.pod:6761
19271 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19272 "C<guestfs_mkdir>."
19277 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4553
19278 msgid "This call returns the previous umask."
19283 #: ../src/guestfs-actions.pod:6770
19284 msgid "guestfs_umount"
19289 #: ../src/guestfs-actions.pod:6772
19293 " guestfs_umount (guestfs_h *g,\n"
19294 " const char *pathordevice);\n"
19300 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4561
19302 "This unmounts the given filesystem. The filesystem may be specified either "
19303 "by its mountpoint (path) or the device which contains the filesystem."
19308 #: ../src/guestfs-actions.pod:6784
19309 msgid "guestfs_umount_all"
19314 #: ../src/guestfs-actions.pod:6786
19318 " guestfs_umount_all (guestfs_h *g);\n"
19324 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4571
19325 msgid "This unmounts all mounted filesystems."
19330 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4573
19331 msgid "Some internal mounts are not unmounted by this call."
19336 #: ../src/guestfs-actions.pod:6797
19337 msgid "guestfs_upload"
19342 #: ../src/guestfs-actions.pod:6799
19346 " guestfs_upload (guestfs_h *g,\n"
19347 " const char *filename,\n"
19348 " const char *remotefilename);\n"
19354 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828
19355 #: ../fish/guestfish-actions.pod:4579 ../fish/guestfish-actions.pod:4592
19356 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19361 #: ../src/guestfs-actions.pod:6809
19362 msgid "See also C<guestfs_download>."
19367 #: ../src/guestfs-actions.pod:6820
19368 msgid "guestfs_upload_offset"
19373 #: ../src/guestfs-actions.pod:6822
19377 " guestfs_upload_offset (guestfs_h *g,\n"
19378 " const char *filename,\n"
19379 " const char *remotefilename,\n"
19380 " int64_t offset);\n"
19386 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4595
19388 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19389 "The intention is to overwrite parts of existing files or devices, although "
19390 "if a non-existant file is specified then it is created with a \"hole\" "
19391 "before C<offset>. The size of the data written is implicit in the size of "
19392 "the source C<filename>."
19397 #: ../src/guestfs-actions.pod:6838
19399 "Note that there is no limit on the amount of data that can be uploaded with "
19400 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19401 "full amount unless an error occurs."
19406 #: ../src/guestfs-actions.pod:6843
19407 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19412 #: ../src/guestfs-actions.pod:6854
19413 msgid "guestfs_utimens"
19418 #: ../src/guestfs-actions.pod:6856
19422 " guestfs_utimens (guestfs_h *g,\n"
19423 " const char *path,\n"
19424 " int64_t atsecs,\n"
19425 " int64_t atnsecs,\n"
19426 " int64_t mtsecs,\n"
19427 " int64_t mtnsecs);\n"
19433 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4615
19434 msgid "This command sets the timestamps of a file with nanosecond precision."
19439 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4618
19441 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19447 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4621
19449 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19450 "nanoseconds from the epoch."
19455 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4624
19457 "If the C<*nsecs> field contains the special value C<-1> then the "
19458 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19459 "ignored in this case)."
19464 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628
19466 "If the C<*nsecs> field contains the special value C<-2> then the "
19467 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19473 #: ../src/guestfs-actions.pod:6885 ../src/guestfs-structs.pod:175
19474 msgid "guestfs_version"
19479 #: ../src/guestfs-actions.pod:6887
19482 " struct guestfs_version *\n"
19483 " guestfs_version (guestfs_h *g);\n"
19489 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4636
19491 "Return the libguestfs version number that the program is linked against."
19496 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4639
19498 "Note that because of dynamic linking this is not necessarily the version of "
19499 "libguestfs that you compiled against. You can compile the program, and then "
19500 "at runtime dynamically link against a completely different C<libguestfs.so> "
19506 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
19508 "This call was added in version C<1.0.58>. In previous versions of "
19509 "libguestfs there was no way to get the version number. From C code you can "
19510 "use dynamic linker functions to find out if this symbol exists (if it "
19511 "doesn't, then it's an earlier version)."
19516 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4650
19518 "The call returns a structure with four elements. The first three (C<major>, "
19519 "C<minor> and C<release>) are numbers and correspond to the usual version "
19520 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19521 "but may be used for distro-specific information."
19526 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4656
19528 "To construct the original version string: C<$major.$minor.$release$extra>"
19533 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4659
19534 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19539 #: ../src/guestfs-actions.pod:6915
19541 "I<Note:> Don't use this call to test for availability of features. In "
19542 "enterprise distributions we backport features from later versions into "
19543 "earlier versions, making this an unreliable way to test for features. Use "
19544 "C<guestfs_available> instead."
19549 #: ../src/guestfs-actions.pod:6921
19551 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19552 "error. I<The caller must call C<guestfs_free_version> after use>."
19557 #: ../src/guestfs-actions.pod:6925
19558 msgid "(Added in 1.0.58)"
19563 #: ../src/guestfs-actions.pod:6927
19564 msgid "guestfs_vfs_label"
19569 #: ../src/guestfs-actions.pod:6929
19573 " guestfs_vfs_label (guestfs_h *g,\n"
19574 " const char *device);\n"
19580 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4671
19581 msgid "This returns the filesystem label of the filesystem on C<device>."
19586 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4674
19587 msgid "If the filesystem is unlabeled, this returns the empty string."
19592 #: ../src/guestfs-actions.pod:6938
19593 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19598 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6980
19599 msgid "(Added in 1.3.18)"
19604 #: ../src/guestfs-actions.pod:6945
19605 msgid "guestfs_vfs_type"
19610 #: ../src/guestfs-actions.pod:6947
19614 " guestfs_vfs_type (guestfs_h *g,\n"
19615 " const char *device);\n"
19621 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4682
19623 "This command gets the filesystem type corresponding to the filesystem on "
19629 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4685
19631 "For most filesystems, the result is the name of the Linux VFS module which "
19632 "would be used to mount this filesystem if you mounted it without specifying "
19633 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19638 #: ../src/guestfs-actions.pod:6964
19639 msgid "guestfs_vfs_uuid"
19644 #: ../src/guestfs-actions.pod:6966
19648 " guestfs_vfs_uuid (guestfs_h *g,\n"
19649 " const char *device);\n"
19655 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4694
19656 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19661 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4697
19662 msgid "If the filesystem does not have a UUID, this returns the empty string."
19667 #: ../src/guestfs-actions.pod:6975
19668 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19673 #: ../src/guestfs-actions.pod:6982
19674 msgid "guestfs_vg_activate"
19679 #: ../src/guestfs-actions.pod:6984
19683 " guestfs_vg_activate (guestfs_h *g,\n"
19685 " char *const *volgroups);\n"
19691 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4705
19693 "This command activates or (if C<activate> is false) deactivates all logical "
19694 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19695 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19696 "deactivated, then those devices disappear."
19701 #: ../src/guestfs-actions.pod:6995 ../fish/guestfish-actions.pod:4711
19702 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19707 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
19709 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19710 "activated or deactivated."
19715 #: ../src/guestfs-actions.pod:7004
19716 msgid "guestfs_vg_activate_all"
19721 #: ../src/guestfs-actions.pod:7006
19725 " guestfs_vg_activate_all (guestfs_h *g,\n"
19726 " int activate);\n"
19732 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4720
19734 "This command activates or (if C<activate> is false) deactivates all logical "
19735 "volumes in all volume groups. If activated, then they are made known to the "
19736 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19737 "those devices disappear."
19742 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4726
19743 msgid "This command is the same as running C<vgchange -a y|n>"
19748 #: ../src/guestfs-actions.pod:7022
19749 msgid "guestfs_vgcreate"
19754 #: ../src/guestfs-actions.pod:7024
19758 " guestfs_vgcreate (guestfs_h *g,\n"
19759 " const char *volgroup,\n"
19760 " char *const *physvols);\n"
19766 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4732
19768 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19769 "of physical volumes C<physvols>."
19774 #: ../src/guestfs-actions.pod:7036
19775 msgid "guestfs_vglvuuids"
19780 #: ../src/guestfs-actions.pod:7038
19784 " guestfs_vglvuuids (guestfs_h *g,\n"
19785 " const char *vgname);\n"
19791 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4739
19793 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19794 "volumes created in this volume group."
19799 #: ../src/guestfs-actions.pod:7045
19801 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19802 "associate logical volumes and volume groups."
19807 #: ../src/guestfs-actions.pod:7048
19808 msgid "See also C<guestfs_vgpvuuids>."
19813 #: ../src/guestfs-actions.pod:7056
19814 msgid "guestfs_vgpvuuids"
19819 #: ../src/guestfs-actions.pod:7058
19823 " guestfs_vgpvuuids (guestfs_h *g,\n"
19824 " const char *vgname);\n"
19830 #: ../src/guestfs-actions.pod:7062 ../fish/guestfish-actions.pod:4751
19832 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19833 "volumes that this volume group resides on."
19838 #: ../src/guestfs-actions.pod:7065
19840 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
19841 "associate physical volumes and volume groups."
19846 #: ../src/guestfs-actions.pod:7068
19847 msgid "See also C<guestfs_vglvuuids>."
19852 #: ../src/guestfs-actions.pod:7076
19853 msgid "guestfs_vgremove"
19858 #: ../src/guestfs-actions.pod:7078
19862 " guestfs_vgremove (guestfs_h *g,\n"
19863 " const char *vgname);\n"
19869 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4763
19870 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19875 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4765
19877 "This also forcibly removes all logical volumes in the volume group (if any)."
19882 #: ../src/guestfs-actions.pod:7091
19883 msgid "guestfs_vgrename"
19888 #: ../src/guestfs-actions.pod:7093
19892 " guestfs_vgrename (guestfs_h *g,\n"
19893 " const char *volgroup,\n"
19894 " const char *newvolgroup);\n"
19900 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4772
19901 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19906 #: ../src/guestfs-actions.pod:7104
19907 msgid "guestfs_vgs"
19912 #: ../src/guestfs-actions.pod:7106
19916 " guestfs_vgs (guestfs_h *g);\n"
19922 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4778
19924 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19930 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4781
19932 "This returns a list of just the volume group names that were detected (eg. "
19938 #: ../src/guestfs-actions.pod:7115
19939 msgid "See also C<guestfs_vgs_full>."
19944 #: ../src/guestfs-actions.pod:7123
19945 msgid "guestfs_vgs_full"
19950 #: ../src/guestfs-actions.pod:7125
19953 " struct guestfs_lvm_vg_list *\n"
19954 " guestfs_vgs_full (guestfs_h *g);\n"
19960 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4790
19962 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19963 "> command. The \"full\" version includes all fields."
19968 #: ../src/guestfs-actions.pod:7131
19970 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
19971 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
19976 #: ../src/guestfs-actions.pod:7137
19977 msgid "guestfs_vgscan"
19982 #: ../src/guestfs-actions.pod:7139
19986 " guestfs_vgscan (guestfs_h *g);\n"
19992 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4797
19994 "This rescans all block devices and rebuilds the list of LVM physical "
19995 "volumes, volume groups and logical volumes."
20000 #: ../src/guestfs-actions.pod:7149
20001 msgid "guestfs_vguuid"
20006 #: ../src/guestfs-actions.pod:7151
20010 " guestfs_vguuid (guestfs_h *g,\n"
20011 " const char *vgname);\n"
20017 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4804
20018 msgid "This command returns the UUID of the LVM VG named C<vgname>."
20023 #: ../src/guestfs-actions.pod:7162
20024 msgid "guestfs_wait_ready"
20029 #: ../src/guestfs-actions.pod:7164
20033 " guestfs_wait_ready (guestfs_h *g);\n"
20039 #: ../src/guestfs-actions.pod:7167
20040 msgid "This function is a no op."
20045 #: ../src/guestfs-actions.pod:7169
20047 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
20048 "calling C<guestfs_launch> to wait for the launch to complete. However this "
20049 "is no longer necessary because C<guestfs_launch> now does the waiting."
20054 #: ../src/guestfs-actions.pod:7174
20056 "If you see any calls to this function in code then you can just remove them, "
20057 "unless you want to retain compatibility with older versions of the API."
20062 #: ../src/guestfs-actions.pod:7182
20063 msgid "guestfs_wc_c"
20068 #: ../src/guestfs-actions.pod:7184
20072 " guestfs_wc_c (guestfs_h *g,\n"
20073 " const char *path);\n"
20079 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4810
20081 "This command counts the characters in a file, using the C<wc -c> external "
20087 #: ../src/guestfs-actions.pod:7195
20088 msgid "guestfs_wc_l"
20093 #: ../src/guestfs-actions.pod:7197
20097 " guestfs_wc_l (guestfs_h *g,\n"
20098 " const char *path);\n"
20104 #: ../src/guestfs-actions.pod:7201 ../fish/guestfish-actions.pod:4817
20106 "This command counts the lines in a file, using the C<wc -l> external command."
20111 #: ../src/guestfs-actions.pod:7208
20112 msgid "guestfs_wc_w"
20117 #: ../src/guestfs-actions.pod:7210
20121 " guestfs_wc_w (guestfs_h *g,\n"
20122 " const char *path);\n"
20128 #: ../src/guestfs-actions.pod:7214 ../fish/guestfish-actions.pod:4824
20130 "This command counts the words in a file, using the C<wc -w> external command."
20135 #: ../src/guestfs-actions.pod:7221
20136 msgid "guestfs_write"
20141 #: ../src/guestfs-actions.pod:7223
20145 " guestfs_write (guestfs_h *g,\n"
20146 " const char *path,\n"
20147 " const char *content,\n"
20148 " size_t content_size);\n"
20154 #: ../src/guestfs-actions.pod:7229 ../fish/guestfish-actions.pod:4831
20156 "This call creates a file called C<path>. The content of the file is the "
20157 "string C<content> (which can contain any 8 bit data)."
20162 #: ../src/guestfs-actions.pod:7239
20163 msgid "guestfs_write_file"
20168 #: ../src/guestfs-actions.pod:7241
20172 " guestfs_write_file (guestfs_h *g,\n"
20173 " const char *path,\n"
20174 " const char *content,\n"
20181 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4841
20183 "This call creates a file called C<path>. The contents of the file is the "
20184 "string C<content> (which can contain any 8 bit data), with length C<size>."
20189 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4845
20191 "As a special case, if C<size> is C<0> then the length is calculated using "
20192 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20197 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
20199 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20200 "I<not> work, even if the length is specified."
20205 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4855
20207 "This function is deprecated. In new code, use the C<write> call instead."
20212 #: ../src/guestfs-actions.pod:7272
20213 msgid "guestfs_zegrep"
20218 #: ../src/guestfs-actions.pod:7274
20222 " guestfs_zegrep (guestfs_h *g,\n"
20223 " const char *regex,\n"
20224 " const char *path);\n"
20230 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4866
20232 "This calls the external C<zegrep> program and returns the matching lines."
20237 #: ../src/guestfs-actions.pod:7291
20238 msgid "guestfs_zegrepi"
20243 #: ../src/guestfs-actions.pod:7293
20247 " guestfs_zegrepi (guestfs_h *g,\n"
20248 " const char *regex,\n"
20249 " const char *path);\n"
20255 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4876
20257 "This calls the external C<zegrep -i> program and returns the matching lines."
20262 #: ../src/guestfs-actions.pod:7310
20263 msgid "guestfs_zero"
20268 #: ../src/guestfs-actions.pod:7312
20272 " guestfs_zero (guestfs_h *g,\n"
20273 " const char *device);\n"
20279 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4886
20280 msgid "This command writes zeroes over the first few blocks of C<device>."
20285 #: ../src/guestfs-actions.pod:7318 ../fish/guestfish-actions.pod:4888
20287 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20288 "securely wipe the device). It should be sufficient to remove any partition "
20289 "tables, filesystem superblocks and so on."
20294 #: ../src/guestfs-actions.pod:7322
20295 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20300 #: ../src/guestfs-actions.pod:7333
20301 msgid "guestfs_zero_device"
20306 #: ../src/guestfs-actions.pod:7335
20310 " guestfs_zero_device (guestfs_h *g,\n"
20311 " const char *device);\n"
20317 #: ../src/guestfs-actions.pod:7339
20319 "This command writes zeroes over the entire C<device>. Compare with "
20320 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20325 #: ../src/guestfs-actions.pod:7353
20326 msgid "(Added in 1.3.1)"
20331 #: ../src/guestfs-actions.pod:7355
20332 msgid "guestfs_zerofree"
20337 #: ../src/guestfs-actions.pod:7357
20341 " guestfs_zerofree (guestfs_h *g,\n"
20342 " const char *device);\n"
20348 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4909
20350 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20351 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20352 "possible to compress the filesystem more effectively."
20357 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4914
20358 msgid "You should B<not> run this program if the filesystem is mounted."
20363 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
20365 "It is possible that using this program can damage the filesystem or data on "
20371 #: ../src/guestfs-actions.pod:7376
20372 msgid "guestfs_zfgrep"
20377 #: ../src/guestfs-actions.pod:7378
20381 " guestfs_zfgrep (guestfs_h *g,\n"
20382 " const char *pattern,\n"
20383 " const char *path);\n"
20389 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4924
20391 "This calls the external C<zfgrep> program and returns the matching lines."
20396 #: ../src/guestfs-actions.pod:7395
20397 msgid "guestfs_zfgrepi"
20402 #: ../src/guestfs-actions.pod:7397
20406 " guestfs_zfgrepi (guestfs_h *g,\n"
20407 " const char *pattern,\n"
20408 " const char *path);\n"
20414 #: ../src/guestfs-actions.pod:7402 ../fish/guestfish-actions.pod:4934
20416 "This calls the external C<zfgrep -i> program and returns the matching lines."
20421 #: ../src/guestfs-actions.pod:7414
20422 msgid "guestfs_zfile"
20427 #: ../src/guestfs-actions.pod:7416
20431 " guestfs_zfile (guestfs_h *g,\n"
20432 " const char *meth,\n"
20433 " const char *path);\n"
20439 #: ../src/guestfs-actions.pod:7421 ../fish/guestfish-actions.pod:4944
20441 "This command runs C<file> after first decompressing C<path> using C<method>."
20446 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4947
20447 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20452 #: ../src/guestfs-actions.pod:7426
20454 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20460 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4952
20462 "This function is deprecated. In new code, use the C<file> call instead."
20467 #: ../src/guestfs-actions.pod:7441
20468 msgid "guestfs_zgrep"
20473 #: ../src/guestfs-actions.pod:7443
20477 " guestfs_zgrep (guestfs_h *g,\n"
20478 " const char *regex,\n"
20479 " const char *path);\n"
20485 #: ../src/guestfs-actions.pod:7448 ../fish/guestfish-actions.pod:4963
20487 "This calls the external C<zgrep> program and returns the matching lines."
20492 #: ../src/guestfs-actions.pod:7460
20493 msgid "guestfs_zgrepi"
20498 #: ../src/guestfs-actions.pod:7462
20502 " guestfs_zgrepi (guestfs_h *g,\n"
20503 " const char *regex,\n"
20504 " const char *path);\n"
20510 #: ../src/guestfs-actions.pod:7467 ../fish/guestfish-actions.pod:4973
20512 "This calls the external C<zgrep -i> program and returns the matching lines."
20517 #: ../src/guestfs-availability.pod:3
20523 #: ../src/guestfs-availability.pod:5
20525 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20526 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20527 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20528 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20529 "L</guestfs_aug_save> L</guestfs_aug_set>"
20534 #: ../src/guestfs-availability.pod:21
20540 #: ../src/guestfs-availability.pod:23
20542 "The following functions: L</guestfs_inotify_add_watch> L</"
20543 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20544 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20549 #: ../src/guestfs-availability.pod:31
20550 msgid "B<linuxfsuuid>"
20555 #: ../src/guestfs-availability.pod:33
20557 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20558 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20563 #: ../src/guestfs-availability.pod:40
20564 msgid "B<linuxmodules>"
20569 #: ../src/guestfs-availability.pod:42
20570 msgid "The following functions: L</guestfs_modprobe>"
20575 #: ../src/guestfs-availability.pod:45
20576 msgid "B<linuxxattrs>"
20581 #: ../src/guestfs-availability.pod:47
20583 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20584 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20585 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20586 "guestfs_setxattr>"
20591 #: ../src/guestfs-availability.pod:58
20597 #: ../src/guestfs-availability.pod:60
20599 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20600 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20601 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20606 #: ../src/guestfs-availability.pod:69
20612 #: ../src/guestfs-availability.pod:71
20614 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20615 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20616 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20617 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20618 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20619 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20620 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20625 #: ../src/guestfs-availability.pod:94
20631 #: ../src/guestfs-availability.pod:96
20633 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20634 "guestfs_mknod_b> L</guestfs_mknod_c>"
20639 #: ../src/guestfs-availability.pod:102
20645 #: ../src/guestfs-availability.pod:104
20646 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20651 #: ../src/guestfs-availability.pod:107
20652 msgid "B<ntfsprogs>"
20657 #: ../src/guestfs-availability.pod:109
20659 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20664 #: ../src/guestfs-availability.pod:113
20665 msgid "B<realpath>"
20670 #: ../src/guestfs-availability.pod:115
20671 msgid "The following functions: L</guestfs_realpath>"
20676 #: ../src/guestfs-availability.pod:118
20682 #: ../src/guestfs-availability.pod:120
20684 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20685 "guestfs_scrub_freespace>"
20690 #: ../src/guestfs-availability.pod:125
20696 #: ../src/guestfs-availability.pod:127
20697 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20702 #: ../src/guestfs-availability.pod:131
20708 #: ../src/guestfs-availability.pod:133
20709 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20714 #: ../src/guestfs-availability.pod:137
20715 msgid "B<zerofree>"
20720 #: ../src/guestfs-availability.pod:139
20721 msgid "The following functions: L</guestfs_zerofree>"
20726 #: ../src/guestfs-structs.pod:1
20727 msgid "guestfs_int_bool"
20732 #: ../src/guestfs-structs.pod:3
20735 " struct guestfs_int_bool {\n"
20744 #: ../src/guestfs-structs.pod:8
20747 " struct guestfs_int_bool_list {\n"
20748 " uint32_t len; /* Number of elements in list. */\n"
20749 " struct guestfs_int_bool *val; /* Elements. */\n"
20756 #: ../src/guestfs-structs.pod:13
20759 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20760 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20766 #: ../src/guestfs-structs.pod:16
20767 msgid "guestfs_lvm_pv"
20772 #: ../src/guestfs-structs.pod:18
20775 " struct guestfs_lvm_pv {\n"
20776 " char *pv_name;\n"
20777 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20778 " char pv_uuid[32];\n"
20780 " uint64_t pv_size;\n"
20781 " uint64_t dev_size;\n"
20782 " uint64_t pv_free;\n"
20783 " uint64_t pv_used;\n"
20784 " char *pv_attr;\n"
20785 " int64_t pv_pe_count;\n"
20786 " int64_t pv_pe_alloc_count;\n"
20787 " char *pv_tags;\n"
20788 " uint64_t pe_start;\n"
20789 " int64_t pv_mda_count;\n"
20790 " uint64_t pv_mda_free;\n"
20797 #: ../src/guestfs-structs.pod:36
20800 " struct guestfs_lvm_pv_list {\n"
20801 " uint32_t len; /* Number of elements in list. */\n"
20802 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20809 #: ../src/guestfs-structs.pod:41
20812 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20813 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20819 #: ../src/guestfs-structs.pod:44
20820 msgid "guestfs_lvm_vg"
20825 #: ../src/guestfs-structs.pod:46
20828 " struct guestfs_lvm_vg {\n"
20829 " char *vg_name;\n"
20830 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20831 " char vg_uuid[32];\n"
20833 " char *vg_attr;\n"
20834 " uint64_t vg_size;\n"
20835 " uint64_t vg_free;\n"
20836 " char *vg_sysid;\n"
20837 " uint64_t vg_extent_size;\n"
20838 " int64_t vg_extent_count;\n"
20839 " int64_t vg_free_count;\n"
20840 " int64_t max_lv;\n"
20841 " int64_t max_pv;\n"
20842 " int64_t pv_count;\n"
20843 " int64_t lv_count;\n"
20844 " int64_t snap_count;\n"
20845 " int64_t vg_seqno;\n"
20846 " char *vg_tags;\n"
20847 " int64_t vg_mda_count;\n"
20848 " uint64_t vg_mda_free;\n"
20855 #: ../src/guestfs-structs.pod:69
20858 " struct guestfs_lvm_vg_list {\n"
20859 " uint32_t len; /* Number of elements in list. */\n"
20860 " struct guestfs_lvm_vg *val; /* Elements. */\n"
20867 #: ../src/guestfs-structs.pod:74
20870 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
20871 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
20877 #: ../src/guestfs-structs.pod:77
20878 msgid "guestfs_lvm_lv"
20883 #: ../src/guestfs-structs.pod:79
20886 " struct guestfs_lvm_lv {\n"
20887 " char *lv_name;\n"
20888 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20889 " char lv_uuid[32];\n"
20890 " char *lv_attr;\n"
20891 " int64_t lv_major;\n"
20892 " int64_t lv_minor;\n"
20893 " int64_t lv_kernel_major;\n"
20894 " int64_t lv_kernel_minor;\n"
20895 " uint64_t lv_size;\n"
20896 " int64_t seg_count;\n"
20898 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20899 " float snap_percent;\n"
20900 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20901 " float copy_percent;\n"
20902 " char *move_pv;\n"
20903 " char *lv_tags;\n"
20904 " char *mirror_log;\n"
20905 " char *modules;\n"
20912 #: ../src/guestfs-structs.pod:101
20915 " struct guestfs_lvm_lv_list {\n"
20916 " uint32_t len; /* Number of elements in list. */\n"
20917 " struct guestfs_lvm_lv *val; /* Elements. */\n"
20924 #: ../src/guestfs-structs.pod:106
20927 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
20928 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
20934 #: ../src/guestfs-structs.pod:111
20937 " struct guestfs_stat {\n"
20941 " int64_t nlink;\n"
20946 " int64_t blksize;\n"
20947 " int64_t blocks;\n"
20948 " int64_t atime;\n"
20949 " int64_t mtime;\n"
20950 " int64_t ctime;\n"
20957 #: ../src/guestfs-structs.pod:127
20960 " struct guestfs_stat_list {\n"
20961 " uint32_t len; /* Number of elements in list. */\n"
20962 " struct guestfs_stat *val; /* Elements. */\n"
20969 #: ../src/guestfs-structs.pod:132
20972 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
20973 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
20979 #: ../src/guestfs-structs.pod:137
20982 " struct guestfs_statvfs {\n"
20983 " int64_t bsize;\n"
20984 " int64_t frsize;\n"
20985 " int64_t blocks;\n"
20986 " int64_t bfree;\n"
20987 " int64_t bavail;\n"
20988 " int64_t files;\n"
20989 " int64_t ffree;\n"
20990 " int64_t favail;\n"
20993 " int64_t namemax;\n"
21000 #: ../src/guestfs-structs.pod:151
21003 " struct guestfs_statvfs_list {\n"
21004 " uint32_t len; /* Number of elements in list. */\n"
21005 " struct guestfs_statvfs *val; /* Elements. */\n"
21012 #: ../src/guestfs-structs.pod:156
21015 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
21016 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
21022 #: ../src/guestfs-structs.pod:159
21023 msgid "guestfs_dirent"
21028 #: ../src/guestfs-structs.pod:161
21031 " struct guestfs_dirent {\n"
21041 #: ../src/guestfs-structs.pod:167
21044 " struct guestfs_dirent_list {\n"
21045 " uint32_t len; /* Number of elements in list. */\n"
21046 " struct guestfs_dirent *val; /* Elements. */\n"
21053 #: ../src/guestfs-structs.pod:172
21056 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
21057 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
21063 #: ../src/guestfs-structs.pod:177
21066 " struct guestfs_version {\n"
21067 " int64_t major;\n"
21068 " int64_t minor;\n"
21069 " int64_t release;\n"
21077 #: ../src/guestfs-structs.pod:184
21080 " struct guestfs_version_list {\n"
21081 " uint32_t len; /* Number of elements in list. */\n"
21082 " struct guestfs_version *val; /* Elements. */\n"
21089 #: ../src/guestfs-structs.pod:189
21092 " void guestfs_free_version (struct guestfs_free_version *);\n"
21093 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
21099 #: ../src/guestfs-structs.pod:192
21100 msgid "guestfs_xattr"
21105 #: ../src/guestfs-structs.pod:194
21108 " struct guestfs_xattr {\n"
21109 " char *attrname;\n"
21110 " /* The next two fields describe a byte array. */\n"
21111 " uint32_t attrval_len;\n"
21112 " char *attrval;\n"
21119 #: ../src/guestfs-structs.pod:201
21122 " struct guestfs_xattr_list {\n"
21123 " uint32_t len; /* Number of elements in list. */\n"
21124 " struct guestfs_xattr *val; /* Elements. */\n"
21131 #: ../src/guestfs-structs.pod:206
21134 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21135 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21141 #: ../src/guestfs-structs.pod:209
21142 msgid "guestfs_inotify_event"
21147 #: ../src/guestfs-structs.pod:211
21150 " struct guestfs_inotify_event {\n"
21151 " int64_t in_wd;\n"
21152 " uint32_t in_mask;\n"
21153 " uint32_t in_cookie;\n"
21154 " char *in_name;\n"
21161 #: ../src/guestfs-structs.pod:218
21164 " struct guestfs_inotify_event_list {\n"
21165 " uint32_t len; /* Number of elements in list. */\n"
21166 " struct guestfs_inotify_event *val; /* Elements. */\n"
21173 #: ../src/guestfs-structs.pod:223
21176 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21177 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21183 #: ../src/guestfs-structs.pod:226
21184 msgid "guestfs_partition"
21189 #: ../src/guestfs-structs.pod:228
21192 " struct guestfs_partition {\n"
21193 " int32_t part_num;\n"
21194 " uint64_t part_start;\n"
21195 " uint64_t part_end;\n"
21196 " uint64_t part_size;\n"
21203 #: ../src/guestfs-structs.pod:235
21206 " struct guestfs_partition_list {\n"
21207 " uint32_t len; /* Number of elements in list. */\n"
21208 " struct guestfs_partition *val; /* Elements. */\n"
21215 #: ../src/guestfs-structs.pod:240
21218 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21219 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21225 #: ../src/guestfs-structs.pod:243
21226 msgid "guestfs_application"
21231 #: ../src/guestfs-structs.pod:245
21234 " struct guestfs_application {\n"
21235 " char *app_name;\n"
21236 " char *app_display_name;\n"
21237 " int32_t app_epoch;\n"
21238 " char *app_version;\n"
21239 " char *app_release;\n"
21240 " char *app_install_path;\n"
21241 " char *app_trans_path;\n"
21242 " char *app_publisher;\n"
21243 " char *app_url;\n"
21244 " char *app_source_package;\n"
21245 " char *app_summary;\n"
21246 " char *app_description;\n"
21253 #: ../src/guestfs-structs.pod:260
21256 " struct guestfs_application_list {\n"
21257 " uint32_t len; /* Number of elements in list. */\n"
21258 " struct guestfs_application *val; /* Elements. */\n"
21265 #: ../src/guestfs-structs.pod:265
21268 " void guestfs_free_application (struct guestfs_free_application *);\n"
21269 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21275 #: ../fish/guestfish.pod:5
21276 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21281 #: ../fish/guestfish.pod:9
21284 " guestfish [--options] [commands]\n"
21290 #: ../fish/guestfish.pod:11
21299 #: ../fish/guestfish.pod:13
21302 " guestfish [--ro|--rw] -a disk.img\n"
21308 #: ../fish/guestfish.pod:15
21311 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21317 #: ../fish/guestfish.pod:17
21320 " guestfish -d libvirt-domain\n"
21326 #: ../fish/guestfish.pod:19
21329 " guestfish [--ro|--rw] -a disk.img -i\n"
21335 #: ../fish/guestfish.pod:21
21338 " guestfish -d libvirt-domain -i\n"
21344 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21345 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21351 #: ../fish/guestfish.pod:25
21353 "Using guestfish in read/write mode on live virtual machines can be "
21354 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21355 "option to use guestfish safely if the disk image or virtual machine might be "
21361 #: ../fish/guestfish.pod:32
21363 "Guestfish is a shell and command-line tool for examining and modifying "
21364 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21365 "functionality of the guestfs API, see L<guestfs(3)>."
21370 #: ../fish/guestfish.pod:36
21372 "Guestfish gives you structured access to the libguestfs API, from shell "
21373 "scripts or the command line or interactively. If you want to rescue a "
21374 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21380 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942
21381 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63
21382 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
21388 #: ../fish/guestfish.pod:43
21389 msgid "As an interactive shell"
21394 #: ../fish/guestfish.pod:45
21403 #: ../fish/guestfish.pod:47
21406 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21407 " editing virtual machine filesystems.\n"
21413 #: ../fish/guestfish.pod:50
21416 " Type: 'help' for a list of commands\n"
21417 " 'man' to read the manual\n"
21418 " 'quit' to quit the shell\n"
21424 #: ../fish/guestfish.pod:54
21427 " ><fs> add-ro disk.img\n"
21429 " ><fs> list-filesystems\n"
21430 " /dev/sda1: ext4\n"
21431 " /dev/vg_guest/lv_root: ext4\n"
21432 " /dev/vg_guest/lv_swap: swap\n"
21433 " ><fs> mount /dev/vg_guest/lv_root /\n"
21434 " ><fs> cat /etc/fstab\n"
21436 " # Created by anaconda\n"
21444 #: ../fish/guestfish.pod:67
21445 msgid "From shell scripts"
21450 #: ../fish/guestfish.pod:69
21451 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21456 #: ../fish/guestfish.pod:71
21459 " guestfish <<_EOF_\n"
21462 " mount /dev/vg_guest/lv_root /\n"
21463 " write /etc/motd \"Welcome, new users\"\n"
21470 #: ../fish/guestfish.pod:78
21471 msgid "List the LVM logical volumes in a disk image:"
21476 #: ../fish/guestfish.pod:80
21479 " guestfish -a disk.img --ro <<_EOF_\n"
21488 #: ../fish/guestfish.pod:85
21489 msgid "List all the filesystems in a disk image:"
21494 #: ../fish/guestfish.pod:87
21497 " guestfish -a disk.img --ro <<_EOF_\n"
21499 " list-filesystems\n"
21506 #: ../fish/guestfish.pod:92
21507 msgid "On one command line"
21512 #: ../fish/guestfish.pod:94
21513 msgid "Update C</etc/resolv.conf> in a guest:"
21518 #: ../fish/guestfish.pod:96
21522 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21523 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21529 #: ../fish/guestfish.pod:100
21530 msgid "Edit C</boot/grub/grub.conf> interactively:"
21535 #: ../fish/guestfish.pod:102
21538 " guestfish --rw --add disk.img \\\n"
21539 " --mount /dev/vg_guest/lv_root \\\n"
21540 " --mount /dev/sda1:/boot \\\n"
21541 " edit /boot/grub/grub.conf\n"
21547 #: ../fish/guestfish.pod:107
21548 msgid "Mount disks automatically"
21553 #: ../fish/guestfish.pod:109
21555 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21560 #: ../fish/guestfish.pod:112
21563 " guestfish --ro -a disk.img -i cat /etc/group\n"
21569 #: ../fish/guestfish.pod:114
21572 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21578 #: ../fish/guestfish.pod:116
21579 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21584 #: ../fish/guestfish.pod:118
21587 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21593 #: ../fish/guestfish.pod:120
21594 msgid "As a script interpreter"
21599 #: ../fish/guestfish.pod:122
21600 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21605 #: ../fish/guestfish.pod:124
21608 " #!/usr/bin/guestfish -f\n"
21609 " sparse test1.img 100M\n"
21611 " part-disk /dev/sda mbr\n"
21612 " mkfs ext2 /dev/sda1\n"
21618 #: ../fish/guestfish.pod:130
21619 msgid "Start with a prepared disk"
21624 #: ../fish/guestfish.pod:132
21626 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21627 "single ext2-formatted partition:"
21632 #: ../fish/guestfish.pod:135
21635 " guestfish -N fs\n"
21641 #: ../fish/guestfish.pod:137
21642 msgid "To list what is available do:"
21647 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
21650 " guestfish -N help | less\n"
21656 #: ../fish/guestfish.pod:141
21657 msgid "Remote control"
21662 #: ../fish/guestfish.pod:143
21665 " eval \"`guestfish --listen`\"\n"
21666 " guestfish --remote add-ro disk.img\n"
21667 " guestfish --remote run\n"
21668 " guestfish --remote lvs\n"
21674 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21675 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
21676 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
21677 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
21678 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
21684 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21685 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
21686 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
21687 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
21688 #: ../tools/virt-list-partitions.pl:62
21694 #: ../fish/guestfish.pod:154
21695 msgid "Displays general help on options."
21700 #: ../fish/guestfish.pod:156
21706 #: ../fish/guestfish.pod:158
21707 msgid "B<--cmd-help>"
21712 #: ../fish/guestfish.pod:160
21713 msgid "Lists all available guestfish commands."
21718 #: ../fish/guestfish.pod:162
21724 #: ../fish/guestfish.pod:164
21725 msgid "B<--cmd-help cmd>"
21730 #: ../fish/guestfish.pod:166
21731 msgid "Displays detailed help on a single command C<cmd>."
21736 #: ../fish/guestfish.pod:168
21737 msgid "B<-a image>"
21742 #: ../fish/guestfish.pod:170
21743 msgid "B<--add image>"
21748 #: ../fish/guestfish.pod:172
21749 msgid "Add a block device or virtual machine image to the shell."
21754 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21756 "The format of the disk image is auto-detected. To override this and force a "
21757 "particular format use the I<--format=..> option."
21762 #: ../fish/guestfish.pod:177
21764 "Using this flag is mostly equivalent to using the C<add> command, with "
21765 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21766 "the I<--format:...> flag was given."
21771 #: ../fish/guestfish.pod:181
21777 #: ../fish/guestfish.pod:183
21778 msgid "B<--connect URI>"
21783 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21785 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21786 "URI to use. The default is to use the default libvirt connection."
21791 #: ../fish/guestfish.pod:189
21797 #: ../fish/guestfish.pod:191
21799 "If using the I<--listen> option and a csh-like shell, use this option. See "
21800 "section L</REMOTE CONTROL AND CSH> below."
21805 #: ../fish/guestfish.pod:194
21806 msgid "B<-d libvirt-domain>"
21811 #: ../fish/guestfish.pod:196
21812 msgid "B<--domain libvirt-domain>"
21817 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21819 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21820 "used, then any libvirt domain can be used. However in write mode, only "
21821 "libvirt domains which are shut down can be named here."
21826 #: ../fish/guestfish.pod:202
21828 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21829 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21830 "if the I<--format:...> flag was given."
21835 #: ../fish/guestfish.pod:206
21841 #: ../fish/guestfish.pod:208
21842 msgid "B<--no-dest-paths>"
21847 #: ../fish/guestfish.pod:210
21849 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21850 "to hit the tab key to complete paths on the guest filesystem, but this "
21851 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21852 "allow this feature to be disabled."
21857 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
21858 msgid "B<--echo-keys>"
21863 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
21865 "When prompting for keys and passphrases, guestfish normally turns echoing "
21866 "off so you cannot see what you are typing. If you are not worried about "
21867 "Tempest attacks and there is no one else in the room you can specify this "
21868 "flag to see what you are typing."
21873 #: ../fish/guestfish.pod:222
21879 #: ../fish/guestfish.pod:224
21880 msgid "B<--file file>"
21885 #: ../fish/guestfish.pod:226
21886 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21891 #: ../fish/guestfish.pod:229
21894 " #!/usr/bin/guestfish -f\n"
21900 #: ../fish/guestfish.pod:231
21901 msgid "B<--format=raw|qcow2|..>"
21906 #: ../fish/guestfish.pod:233
21907 msgid "B<--format>"
21912 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
21914 "The default for the I<-a> option is to auto-detect the format of the disk "
21915 "image. Using this forces the disk format for I<-a> options which follow on "
21916 "the command line. Using I<--format> with no argument switches back to auto-"
21917 "detection for subsequent I<-a> options."
21922 #: ../fish/guestfish.pod:242
21925 " guestfish --format=raw -a disk.img\n"
21931 #: ../fish/guestfish.pod:244
21932 msgid "forces raw format (no auto-detection) for C<disk.img>."
21937 #: ../fish/guestfish.pod:246
21940 " guestfish --format=raw -a disk.img --format -a another.img\n"
21946 #: ../fish/guestfish.pod:248
21948 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
21949 "detection for C<another.img>."
21954 #: ../fish/guestfish.pod:251
21956 "If you have untrusted raw-format guest disk images, you should use this "
21957 "option to specify the disk format. This avoids a possible security problem "
21958 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21963 #: ../fish/guestfish.pod:256
21969 #: ../fish/guestfish.pod:258
21970 msgid "B<--inspector>"
21975 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
21977 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21978 "system and mount filesystems as they would be mounted on the real virtual "
21984 #: ../fish/guestfish.pod:264
21985 msgid "Typical usage is either:"
21990 #: ../fish/guestfish.pod:266
21993 " guestfish -d myguest -i\n"
21999 #: ../fish/guestfish.pod:268
22000 msgid "(for an inactive libvirt domain called I<myguest>), or:"
22005 #: ../fish/guestfish.pod:270
22008 " guestfish --ro -d myguest -i\n"
22014 #: ../fish/guestfish.pod:272
22015 msgid "(for active domains, readonly), or specify the block device directly:"
22020 #: ../fish/guestfish.pod:274
22023 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
22029 #: ../fish/guestfish.pod:276
22031 "Note that the command line syntax changed slightly over older versions of "
22032 "guestfish. You can still use the old syntax:"
22037 #: ../fish/guestfish.pod:279
22040 " guestfish [--ro] -i disk.img\n"
22046 #: ../fish/guestfish.pod:281
22049 " guestfish [--ro] -i libvirt-domain\n"
22055 #: ../fish/guestfish.pod:283
22057 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
22058 "then using other commands to mount the filesystems that were found."
22063 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
22064 msgid "B<--keys-from-stdin>"
22069 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
22071 "Read key or passphrase parameters from stdin. The default is to try to read "
22072 "passphrases from the user by opening C</dev/tty>."
22077 #: ../fish/guestfish.pod:292
22078 msgid "B<--listen>"
22083 #: ../fish/guestfish.pod:294
22085 "Fork into the background and listen for remote commands. See section L</"
22086 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
22090 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
22095 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
22097 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
22098 "ATTACHING TO RUNNING DAEMONS>)."
22102 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
22103 msgid "B<-m dev[:mountpoint[:options]]>"
22107 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
22108 msgid "B<--mount dev[:mountpoint[:options]]>"
22113 #: ../fish/guestfish.pod:306
22114 msgid "Mount the named partition or logical volume on the given mountpoint."
22119 #: ../fish/guestfish.pod:308
22120 msgid "If the mountpoint is omitted, it defaults to C</>."
22125 #: ../fish/guestfish.pod:310
22126 msgid "You have to mount something on C</> before most commands will work."
22131 #: ../fish/guestfish.pod:312
22133 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22139 #: ../fish/guestfish.pod:315
22141 "If you don't know what filesystems a disk image contains, you can either run "
22142 "guestfish without this option, then list the partitions, filesystems and LVs "
22143 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22144 "commands), or you can use the L<virt-filesystems(1)> program."
22148 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
22150 "The third (and rarely used) part of the mount parameter is the list of mount "
22151 "options used to mount the underlying filesystem. If this is not given, then "
22152 "the mount options are either the empty string or C<ro> (the latter if the "
22153 "I<--ro> flag is used). By specifying the mount options, you override this "
22154 "default choice. Probably the only time you would use this is to enable ACLs "
22155 "and/or extended attributes if the filesystem can support them:"
22159 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
22162 " -m /dev/sda1:/:acl,user_xattr\n"
22167 #: ../fish/guestfish.pod:331
22168 msgid "Using this flag is equivalent to using the C<mount-options> command."
22173 #: ../fish/guestfish.pod:333
22179 #: ../fish/guestfish.pod:335
22180 msgid "B<--no-sync>"
22185 #: ../fish/guestfish.pod:337
22187 "Disable autosync. This is enabled by default. See the discussion of "
22188 "autosync in the L<guestfs(3)> manpage."
22193 #: ../fish/guestfish.pod:340
22199 #: ../fish/guestfish.pod:342
22200 msgid "B<--new type>"
22205 #: ../fish/guestfish.pod:344
22211 #: ../fish/guestfish.pod:346
22213 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22214 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22215 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22221 #: ../fish/guestfish.pod:351
22222 msgid "B<--progress-bars>"
22227 #: ../fish/guestfish.pod:353
22228 msgid "Enable progress bars, even when guestfish is used non-interactively."
22233 #: ../fish/guestfish.pod:355
22235 "Progress bars are enabled by default when guestfish is used as an "
22236 "interactive shell."
22241 #: ../fish/guestfish.pod:358
22242 msgid "B<--no-progress-bars>"
22247 #: ../fish/guestfish.pod:360
22248 msgid "Disable progress bars."
22253 #: ../fish/guestfish.pod:362
22254 msgid "B<--remote[=pid]>"
22259 #: ../fish/guestfish.pod:364
22261 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22262 "CONTROL GUESTFISH OVER A SOCKET> below."
22267 #: ../fish/guestfish.pod:367
22273 #: ../fish/guestfish.pod:369
22279 #: ../fish/guestfish.pod:371
22281 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22282 "mounts are done read-only."
22287 #: ../fish/guestfish.pod:374
22289 "The option must always be used if the disk image or virtual machine might be "
22290 "running, and is generally recommended in cases where you don't need write "
22291 "access to the disk."
22296 #: ../fish/guestfish.pod:378
22298 "Note that prepared disk images created with I<-N> are not affected by this "
22299 "option. Also commands like C<add> are not affected - you have to specify "
22300 "the C<readonly:true> option explicitly if you need it."
22305 #: ../fish/guestfish.pod:382
22306 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22311 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
22312 msgid "B<--selinux>"
22317 #: ../fish/guestfish.pod:386
22318 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22323 #: ../fish/guestfish.pod:388
22329 #: ../fish/guestfish.pod:390
22330 msgid "B<--verbose>"
22335 #: ../fish/guestfish.pod:392
22337 "Enable very verbose messages. This is particularly useful if you find a bug."
22342 #: ../fish/guestfish.pod:395
22348 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
22349 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
22350 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22351 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22352 msgid "B<--version>"
22357 #: ../fish/guestfish.pod:399
22358 msgid "Display the guestfish / libguestfs version number and exit."
22363 #: ../fish/guestfish.pod:401
22369 #: ../fish/guestfish.pod:403
22374 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
22376 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22377 "mounts are done read-write."
22381 #: ../fish/guestfish.pod:408
22382 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22387 #: ../fish/guestfish.pod:410
22393 #: ../fish/guestfish.pod:412
22394 msgid "Echo each command before executing it."
22399 #: ../fish/guestfish.pod:416
22400 msgid "COMMANDS ON COMMAND LINE"
22405 #: ../fish/guestfish.pod:418
22407 "Any additional (non-option) arguments are treated as commands to execute."
22412 #: ../fish/guestfish.pod:421
22414 "Commands to execute should be separated by a colon (C<:>), where the colon "
22415 "is a separate parameter. Thus:"
22420 #: ../fish/guestfish.pod:424
22423 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22429 #: ../fish/guestfish.pod:426
22431 "If there are no additional arguments, then we enter a shell, either an "
22432 "interactive shell with a prompt (if the input is a terminal) or a non-"
22433 "interactive shell."
22438 #: ../fish/guestfish.pod:430
22440 "In either command line mode or non-interactive shell, the first command that "
22441 "gives an error causes the whole shell to exit. In interactive mode (with a "
22442 "prompt) if a command fails, you can continue to enter commands."
22447 #: ../fish/guestfish.pod:435
22448 msgid "USING launch (OR run)"
22453 #: ../fish/guestfish.pod:437
22455 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22456 "then launch it, then mount any disks you need, and finally issue actions/"
22457 "commands. So the general order of the day is:"
22462 #: ../fish/guestfish.pod:445
22463 msgid "add or -a/--add"
22468 #: ../fish/guestfish.pod:449
22469 msgid "launch (aka run)"
22474 #: ../fish/guestfish.pod:453
22475 msgid "mount or -m/--mount"
22480 #: ../fish/guestfish.pod:457
22481 msgid "any other commands"
22486 #: ../fish/guestfish.pod:461
22488 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22489 "guest before mounting or performing any other commands."
22494 #: ../fish/guestfish.pod:464
22496 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22497 "I<--new> options were given then C<run> is done automatically, simply "
22498 "because guestfish can't perform the action you asked for without doing this."
22503 #: ../fish/guestfish.pod:469
22504 msgid "OPENING DISKS FOR READ AND WRITE"
22508 #: ../fish/guestfish.pod:471
22510 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22511 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22512 "I<-i> and I<-m> open disk images read-only or for writing."
22516 #: ../fish/guestfish.pod:476
22518 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
22519 "opening disk images supplied on the command line for write. To open a disk "
22520 "image read-only you have to do I<-a image --ro>."
22525 #: ../fish/guestfish.pod:480
22527 "This matters: If you accidentally open a live VM disk image writable then "
22528 "you will cause irreversible disk corruption."
22532 #: ../fish/guestfish.pod:483
22534 "By libguestfs 1.10 we intend to change the default the other way. Disk "
22535 "images will be opened read-only. You will have to either specify "
22536 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22537 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22538 "access for disk images specified by those other command line options."
22542 #: ../fish/guestfish.pod:490
22544 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22545 "which does nothing (it is already the default). However it is highly "
22546 "recommended that you use this option to indicate that you need write access, "
22547 "and prepare your scripts for the day when this option will be required for "
22553 #: ../fish/guestfish.pod:496
22555 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22556 "other libguestfs program apart from guestfish and guestmount."
22561 #: ../fish/guestfish.pod:499
22567 #: ../fish/guestfish.pod:501
22569 "You can quote ordinary parameters using either single or double quotes. For "
22575 #: ../fish/guestfish.pod:504
22578 " add \"file with a space.img\"\n"
22584 #: ../fish/guestfish.pod:506
22587 " rm '/file name'\n"
22593 #: ../fish/guestfish.pod:508
22602 #: ../fish/guestfish.pod:510
22604 "A few commands require a list of strings to be passed. For these, use a "
22605 "whitespace-separated list, enclosed in quotes. Strings containing "
22606 "whitespace to be passed through must be enclosed in single quotes. A "
22607 "literal single quote must be escaped with a backslash."
22612 #: ../fish/guestfish.pod:515
22615 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22616 " command \"/bin/echo 'foo bar'\"\n"
22617 " command \"/bin/echo \\'foo\\'\"\n"
22623 #: ../fish/guestfish.pod:519
22624 msgid "OPTIONAL ARGUMENTS"
22629 #: ../fish/guestfish.pod:521
22631 "Some commands take optional arguments. These arguments appear in this "
22632 "documentation as C<[argname:..]>. You can use them as in these examples:"
22637 #: ../fish/guestfish.pod:525
22640 " add-drive-opts filename\n"
22646 #: ../fish/guestfish.pod:527
22649 " add-drive-opts filename readonly:true\n"
22655 #: ../fish/guestfish.pod:529
22658 " add-drive-opts filename format:qcow2 readonly:false\n"
22664 #: ../fish/guestfish.pod:531
22666 "Each optional argument can appear at most once. All optional arguments must "
22667 "appear after the required ones."
22672 #: ../fish/guestfish.pod:534
22678 #: ../fish/guestfish.pod:536
22680 "This section applies to all commands which can take integers as parameters."
22685 #: ../fish/guestfish.pod:539
22686 msgid "SIZE SUFFIX"
22691 #: ../fish/guestfish.pod:541
22693 "When the command takes a parameter measured in bytes, you can use one of the "
22694 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22699 #: ../fish/guestfish.pod:547
22700 msgid "B<k> or B<K> or B<KiB>"
22705 #: ../fish/guestfish.pod:549
22706 msgid "The size in kilobytes (multiplied by 1024)."
22711 #: ../fish/guestfish.pod:551
22717 #: ../fish/guestfish.pod:553
22718 msgid "The size in SI 1000 byte units."
22723 #: ../fish/guestfish.pod:555
22724 msgid "B<M> or B<MiB>"
22729 #: ../fish/guestfish.pod:557
22730 msgid "The size in megabytes (multiplied by 1048576)."
22735 #: ../fish/guestfish.pod:559
22741 #: ../fish/guestfish.pod:561
22742 msgid "The size in SI 1000000 byte units."
22747 #: ../fish/guestfish.pod:563
22748 msgid "B<G> or B<GiB>"
22753 #: ../fish/guestfish.pod:565
22754 msgid "The size in gigabytes (multiplied by 2**30)."
22759 #: ../fish/guestfish.pod:567
22765 #: ../fish/guestfish.pod:569
22766 msgid "The size in SI 10**9 byte units."
22771 #: ../fish/guestfish.pod:571
22772 msgid "B<T> or B<TiB>"
22777 #: ../fish/guestfish.pod:573
22778 msgid "The size in terabytes (multiplied by 2**40)."
22783 #: ../fish/guestfish.pod:575
22789 #: ../fish/guestfish.pod:577
22790 msgid "The size in SI 10**12 byte units."
22795 #: ../fish/guestfish.pod:579
22796 msgid "B<P> or B<PiB>"
22801 #: ../fish/guestfish.pod:581
22802 msgid "The size in petabytes (multiplied by 2**50)."
22807 #: ../fish/guestfish.pod:583
22813 #: ../fish/guestfish.pod:585
22814 msgid "The size in SI 10**15 byte units."
22819 #: ../fish/guestfish.pod:587
22820 msgid "B<E> or B<EiB>"
22825 #: ../fish/guestfish.pod:589
22826 msgid "The size in exabytes (multiplied by 2**60)."
22831 #: ../fish/guestfish.pod:591
22837 #: ../fish/guestfish.pod:593
22838 msgid "The size in SI 10**18 byte units."
22843 #: ../fish/guestfish.pod:595
22844 msgid "B<Z> or B<ZiB>"
22849 #: ../fish/guestfish.pod:597
22850 msgid "The size in zettabytes (multiplied by 2**70)."
22855 #: ../fish/guestfish.pod:599
22861 #: ../fish/guestfish.pod:601
22862 msgid "The size in SI 10**21 byte units."
22867 #: ../fish/guestfish.pod:603
22868 msgid "B<Y> or B<YiB>"
22873 #: ../fish/guestfish.pod:605
22874 msgid "The size in yottabytes (multiplied by 2**80)."
22879 #: ../fish/guestfish.pod:607
22885 #: ../fish/guestfish.pod:609
22886 msgid "The size in SI 10**24 byte units."
22891 #: ../fish/guestfish.pod:615
22894 " truncate-size /file 1G\n"
22900 #: ../fish/guestfish.pod:617
22901 msgid "would truncate the file to 1 gigabyte."
22906 #: ../fish/guestfish.pod:619
22908 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22909 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22910 "suffix will probably not do what you expect."
22915 #: ../fish/guestfish.pod:623
22916 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22921 #: ../fish/guestfish.pod:625
22923 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22924 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22929 #: ../fish/guestfish.pod:628
22932 " 1234 decimal number 1234\n"
22933 " 02322 octal number, equivalent to decimal 1234\n"
22934 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22940 #: ../fish/guestfish.pod:632
22942 "When using the C<chmod> command, you almost always want to specify an octal "
22943 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22944 "L<chmod(1)> program):"
22949 #: ../fish/guestfish.pod:636
22952 " chmod 0777 /public # OK\n"
22953 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22959 #: ../fish/guestfish.pod:639
22961 "Commands that return numbers usually print them in decimal, but some "
22962 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22963 "octal, preceeded by C<0>)."
22968 #: ../fish/guestfish.pod:643
22969 msgid "WILDCARDS AND GLOBBING"
22974 #: ../fish/guestfish.pod:645
22976 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22977 "(globbing) by default. So for example the following will not do what you "
22983 #: ../fish/guestfish.pod:649
22992 #: ../fish/guestfish.pod:651
22994 "Assuming you don't have a directory called literally C</home/*> then the "
22995 "above command will return an error."
23000 #: ../fish/guestfish.pod:654
23001 msgid "To perform wildcard expansion, use the C<glob> command."
23006 #: ../fish/guestfish.pod:656
23009 " glob rm-rf /home/*\n"
23015 #: ../fish/guestfish.pod:658
23017 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
23018 "many times), equivalent to:"
23023 #: ../fish/guestfish.pod:661
23026 " rm-rf /home/jim\n"
23027 " rm-rf /home/joe\n"
23028 " rm-rf /home/mary\n"
23034 #: ../fish/guestfish.pod:665
23035 msgid "C<glob> only works on simple guest paths and not on device names."
23040 #: ../fish/guestfish.pod:667
23042 "If you have several parameters, each containing a wildcard, then glob will "
23043 "perform a Cartesian product."
23048 #: ../fish/guestfish.pod:670
23054 #: ../fish/guestfish.pod:672
23056 "Any line which starts with a I<#> character is treated as a comment and "
23057 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
23058 "a command. For example:"
23063 #: ../fish/guestfish.pod:676
23066 " # this is a comment\n"
23067 " # this is a comment\n"
23068 " foo # NOT a comment\n"
23074 #: ../fish/guestfish.pod:680
23075 msgid "Blank lines are also ignored."
23080 #: ../fish/guestfish.pod:682
23081 msgid "RUNNING COMMANDS LOCALLY"
23086 #: ../fish/guestfish.pod:684
23088 "Any line which starts with a I<!> character is treated as a command sent to "
23089 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
23094 #: ../fish/guestfish.pod:688
23098 " tgz-out /remote local/remote-data.tar.gz\n"
23104 #: ../fish/guestfish.pod:691
23106 "will create a directory C<local> on the host, and then export the contents "
23107 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
23108 "(See C<tgz-out>)."
23113 #: ../fish/guestfish.pod:695
23115 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23116 "effect, due to the way that subprocesses work in Unix."
23120 #: ../fish/guestfish.pod:698
23121 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23125 #: ../fish/guestfish.pod:700
23127 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23128 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23129 "and executed as guestfish commands."
23133 #: ../fish/guestfish.pod:704
23135 "Thus you can use shell script to construct arbitrary guestfish commands "
23136 "which are then parsed by guestfish."
23140 #: ../fish/guestfish.pod:707
23142 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23143 "through C</foo.100>) using guestfish commands alone. However this is simple "
23144 "if we use a shell script to create the guestfish commands for us:"
23148 #: ../fish/guestfish.pod:712
23151 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23156 #: ../fish/guestfish.pod:714
23157 msgid "or with names like C</foo.001>:"
23161 #: ../fish/guestfish.pod:716
23164 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23169 #: ../fish/guestfish.pod:718
23171 "When using guestfish interactively it can be helpful to just run the shell "
23172 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23173 "ordinary I<!> local command), see what guestfish commands it would run, and "
23174 "when you are happy with those prepend the C<E<lt>> character to run the "
23175 "guestfish commands for real."
23180 #: ../fish/guestfish.pod:724
23186 #: ../fish/guestfish.pod:726
23188 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23189 "command (a guestfish command) to the second command (any host command). For "
23195 #: ../fish/guestfish.pod:730
23198 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23204 #: ../fish/guestfish.pod:732
23206 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23207 "program). The above command would list all accounts in the guest filesystem "
23208 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23213 #: ../fish/guestfish.pod:737
23216 " hexdump /bin/ls | head\n"
23217 " list-devices | tail -1\n"
23218 " tgz-out / - | tar ztf -\n"
23224 #: ../fish/guestfish.pod:741
23226 "The space before the pipe symbol is required, any space after the pipe "
23227 "symbol is optional. Everything after the pipe symbol is just passed "
23228 "straight to the host shell, so it can contain redirections, globs and "
23229 "anything else that makes sense on the host side."
23234 #: ../fish/guestfish.pod:746
23236 "To use a literal argument which begins with a pipe symbol, you have to quote "
23242 #: ../fish/guestfish.pod:749
23251 #: ../fish/guestfish.pod:751
23252 msgid "HOME DIRECTORIES"
23257 #: ../fish/guestfish.pod:753
23259 "If a parameter starts with the character C<~> then the tilde may be expanded "
23260 "as a home directory path (either C<~> for the current user's home directory, "
23261 "or C<~user> for another user)."
23266 #: ../fish/guestfish.pod:757
23268 "Note that home directory expansion happens for users known I<on the host>, "
23269 "not in the guest filesystem."
23274 #: ../fish/guestfish.pod:760
23276 "To use a literal argument which begins with a tilde, you have to quote it, "
23282 #: ../fish/guestfish.pod:763
23291 #: ../fish/guestfish.pod:767
23293 "Libguestfs has some support for Linux guests encrypted according to the "
23294 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23295 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23296 "LUKS is supported."
23301 #: ../fish/guestfish.pod:772
23302 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23307 #: ../fish/guestfish.pod:774
23310 " ><fs> vfs-type /dev/sda2\n"
23317 #: ../fish/guestfish.pod:777
23319 "Then open those devices using L</luks-open>. This creates a device-mapper "
23320 "device called C</dev/mapper/luksdev>."
23325 #: ../fish/guestfish.pod:780
23328 " ><fs> luks-open /dev/sda2 luksdev\n"
23329 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23335 #: ../fish/guestfish.pod:783
23337 "Finally you have to tell LVM to scan for volume groups on the newly created "
23343 #: ../fish/guestfish.pod:786
23347 " vg-activate-all true\n"
23353 #: ../fish/guestfish.pod:789
23354 msgid "The logical volume(s) can now be mounted in the usual way."
23359 #: ../fish/guestfish.pod:791
23361 "Before closing a LUKS device you must unmount any logical volumes on it and "
23362 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23363 "one. Then you can close the mapper device:"
23368 #: ../fish/guestfish.pod:795
23371 " vg-activate false /dev/VG\n"
23372 " luks-close /dev/mapper/luksdev\n"
23378 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
23379 msgid "WINDOWS PATHS"
23384 #: ../fish/guestfish.pod:800
23386 "If a path is prefixed with C<win:> then you can use Windows-style paths "
23387 "(with some limitations). The following commands are equivalent:"
23392 #: ../fish/guestfish.pod:803
23395 " file /WINDOWS/system32/config/system.LOG\n"
23401 #: ../fish/guestfish.pod:805
23404 " file win:/windows/system32/config/system.log\n"
23410 #: ../fish/guestfish.pod:807
23413 " file win:\\windows\\system32\\config\\system.log\n"
23419 #: ../fish/guestfish.pod:809
23422 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
23428 #: ../fish/guestfish.pod:811
23430 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
23431 "handles case insensitivity like Windows would. This only works in argument "
23432 "positions that expect a path."
23437 #: ../fish/guestfish.pod:815
23438 msgid "UPLOADING AND DOWNLOADING FILES"
23443 #: ../fish/guestfish.pod:817
23445 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23446 "others which upload from or download to a local file, you can use the "
23447 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23452 #: ../fish/guestfish.pod:821
23461 #: ../fish/guestfish.pod:823
23463 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23468 #: ../fish/guestfish.pod:826
23471 " tar-out /etc - | tar tf -\n"
23477 #: ../fish/guestfish.pod:828
23479 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23480 "command (see L</PIPES>)."
23485 #: ../fish/guestfish.pod:831
23487 "When using C<-> to read from stdin, the input is read up to the end of "
23488 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23489 "some arbitrary end marker:"
23494 #: ../fish/guestfish.pod:835
23497 " upload -<<END /foo\n"
23507 #: ../fish/guestfish.pod:841
23509 "Any string of characters can be used instead of C<END>. The end marker must "
23510 "appear on a line of its own, without any preceeding or following characters "
23511 "(not even spaces)."
23516 #: ../fish/guestfish.pod:845
23518 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23519 "upload local files (so-called \"FileIn\" parameters in the generator)."
23524 #: ../fish/guestfish.pod:848
23525 msgid "EXIT ON ERROR BEHAVIOUR"
23530 #: ../fish/guestfish.pod:850
23532 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23533 "taking commands from a human over a tty), and will exit on the first error "
23534 "in non-interactive mode (scripts, commands given on the command line)."
23539 #: ../fish/guestfish.pod:855
23541 "If you prefix a command with a I<-> character, then that command will not "
23542 "cause guestfish to exit, even if that (one) command returns an error."
23547 #: ../fish/guestfish.pod:859
23548 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23553 #: ../fish/guestfish.pod:861
23555 "Guestfish can be remote-controlled over a socket. This is useful "
23556 "particularly in shell scripts where you want to make several different "
23557 "changes to a filesystem, but you don't want the overhead of starting up a "
23558 "guestfish process each time."
23563 #: ../fish/guestfish.pod:866
23564 msgid "Start a guestfish server process using:"
23569 #: ../fish/guestfish.pod:868
23572 " eval \"`guestfish --listen`\"\n"
23578 #: ../fish/guestfish.pod:870
23579 msgid "and then send it commands by doing:"
23584 #: ../fish/guestfish.pod:872
23587 " guestfish --remote cmd [...]\n"
23593 #: ../fish/guestfish.pod:874
23594 msgid "To cause the server to exit, send it the exit command:"
23599 #: ../fish/guestfish.pod:876
23602 " guestfish --remote exit\n"
23608 #: ../fish/guestfish.pod:878
23610 "Note that the server will normally exit if there is an error in a command. "
23611 "You can change this in the usual way. See section L</EXIT ON ERROR "
23617 #: ../fish/guestfish.pod:882
23618 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23623 #: ../fish/guestfish.pod:884
23625 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23626 "is how the I<--remote> option knows where to send the commands. You can "
23627 "have several guestfish listener processes running using:"
23632 #: ../fish/guestfish.pod:888
23635 " eval \"`guestfish --listen`\"\n"
23636 " pid1=$GUESTFISH_PID\n"
23637 " eval \"`guestfish --listen`\"\n"
23638 " pid2=$GUESTFISH_PID\n"
23640 " guestfish --remote=$pid1 cmd\n"
23641 " guestfish --remote=$pid2 cmd\n"
23647 #: ../fish/guestfish.pod:896
23648 msgid "REMOTE CONTROL AND CSH"
23653 #: ../fish/guestfish.pod:898
23655 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23661 #: ../fish/guestfish.pod:901
23664 " eval \"`guestfish --listen --csh`\"\n"
23670 #: ../fish/guestfish.pod:903
23671 msgid "REMOTE CONTROL DETAILS"
23676 #: ../fish/guestfish.pod:905
23678 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23679 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23680 "and C<$PID> is the process ID of the server."
23685 #: ../fish/guestfish.pod:909
23686 msgid "Guestfish client and server versions must match exactly."
23691 #: ../fish/guestfish.pod:911
23692 msgid "PREPARED DISK IMAGES"
23697 #: ../fish/guestfish.pod:913
23699 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23700 "preformatted disk images that guestfish can make for you to save typing. "
23701 "This is particularly useful for testing purposes. This option is used "
23702 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23703 "can be mixed with I<-a>)."
23708 #: ../fish/guestfish.pod:919
23710 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23711 "the second and so on. Existing files in the current directory are "
23717 #: ../fish/guestfish.pod:923
23719 "The type briefly describes how the disk should be sized, partitioned, how "
23720 "filesystem(s) should be created, and how content should be added. "
23721 "Optionally the type can be followed by extra parameters, separated by C<:> "
23722 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23723 "allocated disk, containing a single partition, with the partition formatted "
23724 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23730 #: ../fish/guestfish.pod:931
23731 msgid "To list the available types and any extra parameters they take, run:"
23736 #: ../fish/guestfish.pod:935
23738 "Note that the prepared filesystem is not mounted. You would usually have to "
23739 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23744 #: ../fish/guestfish.pod:939
23746 "If any I<-N> or I<--new> options are given, the guest is automatically "
23752 #: ../fish/guestfish.pod:944
23753 msgid "Create a 100MB disk with an ext4-formatted partition:"
23758 #: ../fish/guestfish.pod:946
23761 " guestfish -N fs:ext4\n"
23767 #: ../fish/guestfish.pod:948
23768 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23773 #: ../fish/guestfish.pod:950
23776 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23782 #: ../fish/guestfish.pod:952
23783 msgid "Create a blank 200MB disk:"
23788 #: ../fish/guestfish.pod:954
23791 " guestfish -N disk:200M\n"
23797 #: ../fish/guestfish.pod:956
23798 msgid "PROGRESS BARS"
23803 #: ../fish/guestfish.pod:958
23805 "Some (not all) long-running commands send progress notification messages as "
23806 "they are running. Guestfish turns these messages into progress bars."
23811 #: ../fish/guestfish.pod:962
23813 "When a command that supports progress bars takes longer than two seconds to "
23814 "run, and if progress bars are enabled, then you will see one appearing below "
23820 #: ../fish/guestfish.pod:966
23823 " ><fs> copy-size /large-file /another-file 2048M\n"
23824 " / 10% [#####-----------------------------------------] 00:30\n"
23830 #: ../fish/guestfish.pod:969
23832 "The spinner on the left hand side moves round once for every progress "
23833 "notification received from the backend. This is a (reasonably) golden "
23834 "assurance that the command is \"doing something\" even if the progress bar "
23835 "is not moving, because the command is able to send the progress "
23836 "notifications. When the bar reaches 100% and the command finishes, the "
23837 "spinner disappears."
23842 #: ../fish/guestfish.pod:976
23844 "Progress bars are enabled by default when guestfish is used interactively. "
23845 "You can enable them even for non-interactive modes using I<--progress-bars>, "
23846 "and you can disable them completely using I<--no-progress-bars>."
23851 #: ../fish/guestfish.pod:981
23852 msgid "GUESTFISH COMMANDS"
23857 #: ../fish/guestfish.pod:983
23859 "The commands in this section are guestfish convenience commands, in other "
23860 "words, they are not part of the L<guestfs(3)> API."
23865 #: ../fish/guestfish.pod:986
23871 #: ../fish/guestfish.pod:988
23881 #: ../fish/guestfish.pod:991
23882 msgid "Without any parameter, this provides general help."
23887 #: ../fish/guestfish.pod:993
23888 msgid "With a C<cmd> parameter, this displays detailed help for that command."
23893 #: ../fish/guestfish.pod:995
23894 msgid "quit | exit"
23899 #: ../fish/guestfish.pod:997
23900 msgid "This exits guestfish. You can also use C<^D> key."
23905 #: ../fish/guestfish.pod:999
23906 msgid "@FISH_COMMANDS@"
23911 #: ../fish/guestfish.pod:1001
23917 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:83
23923 #: ../fish/guestfish.pod:1007
23925 "guestfish returns 0 if the commands completed without error, or 1 if there "
23931 #: ../fish/guestfish.pod:1014
23937 #: ../fish/guestfish.pod:1016
23939 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23945 #: ../fish/guestfish.pod:1019
23946 msgid "GUESTFISH_PID"
23951 #: ../fish/guestfish.pod:1021
23953 "Used with the I<--remote> option to specify the remote guestfish process to "
23954 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23959 #: ../fish/guestfish.pod:1025
23965 #: ../fish/guestfish.pod:1027
23967 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23968 "not specified, the external L<hexedit(1)> program is used."
23973 #: ../fish/guestfish.pod:1031
23979 #: ../fish/guestfish.pod:1033
23981 "If compiled with GNU readline support, various files in the home directory "
23982 "can be used. See L</FILES>."
23987 #: ../fish/guestfish.pod:1042
23989 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23990 "effect as using the B<-v> option."
23995 #: ../fish/guestfish.pod:1054
23997 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23998 "the discussion of paths in L<guestfs(3)>."
24003 #: ../fish/guestfish.pod:1065
24004 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
24009 #: ../fish/guestfish.pod:1067
24015 #: ../fish/guestfish.pod:1069
24017 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
24023 #: ../fish/guestfish.pod:1085 ../test-tool/libguestfs-test-tool.pod:88
24024 #: ../fuse/guestmount.pod:252
24029 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
24030 msgid "$HOME/.libguestfs-tools.rc"
24034 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
24035 msgid "/etc/libguestfs-tools.conf"
24039 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
24041 "This configuration file controls the default read-only or read-write mode "
24042 "(I<--ro> or I<--rw>)."
24046 #: ../fish/guestfish.pod:1096
24047 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
24052 #: ../fish/guestfish.pod:1098
24053 msgid "$HOME/.guestfish"
24058 #: ../fish/guestfish.pod:1100
24060 "If compiled with GNU readline support, then the command history is saved in "
24066 #: ../fish/guestfish.pod:1103
24067 msgid "$HOME/.inputrc"
24072 #: ../fish/guestfish.pod:1105
24073 msgid "/etc/inputrc"
24078 #: ../fish/guestfish.pod:1107
24080 "If compiled with GNU readline support, then these files can be used to "
24081 "configure readline. For further information, please see L<readline(3)/"
24082 "INITIALIZATION FILE>."
24087 #: ../fish/guestfish.pod:1111
24088 msgid "To write rules which only apply to guestfish, use:"
24093 #: ../fish/guestfish.pod:1113
24104 #: ../fish/guestfish.pod:1117
24106 "Variables that you can set in inputrc that change the behaviour of guestfish "
24107 "in useful ways include:"
24112 #: ../fish/guestfish.pod:1122
24113 msgid "completion-ignore-case (default: on)"
24118 #: ../fish/guestfish.pod:1124
24120 "By default, guestfish will ignore case when tab-completing paths on the "
24126 #: ../fish/guestfish.pod:1127
24129 " set completion-ignore-case off\n"
24135 #: ../fish/guestfish.pod:1129
24136 msgid "to make guestfish case sensitive."
24141 #: ../fish/guestfish.pod:1133
24147 #: ../fish/guestfish.pod:1135
24148 msgid "test2.img (etc)"
24153 #: ../fish/guestfish.pod:1137
24155 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
24156 "will be created in the file C<test1.img> in the current directory. The "
24157 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
24158 "the same name will be overwritten."
24162 #: ../fish/guestfish.pod:1146
24164 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24165 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24166 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24167 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24168 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24169 ">, L<hexedit(1)>."
24174 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:124
24175 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
24176 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518
24177 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
24178 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
24180 "This program is free software; you can redistribute it and/or modify it "
24181 "under the terms of the GNU General Public License as published by the Free "
24182 "Software Foundation; either version 2 of the License, or (at your option) "
24183 "any later version."
24188 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:129
24189 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
24190 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523
24191 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24192 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24194 "This program is distributed in the hope that it will be useful, but WITHOUT "
24195 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24196 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24202 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:134
24203 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
24204 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528
24205 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24206 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24208 "You should have received a copy of the GNU General Public License along with "
24209 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24210 "Ave, Cambridge, MA 02139, USA."
24215 #: ../fish/guestfish-actions.pod:1
24221 #: ../fish/guestfish-actions.pod:3
24224 " add-cdrom filename\n"
24230 #: ../fish/guestfish-actions.pod:15
24232 "This call checks for the existence of C<filename>. This stops you from "
24233 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24234 "and C<http:> URLs. To specify those, use the general L</config> call "
24240 #: ../fish/guestfish-actions.pod:22
24242 "If you just want to add an ISO file (often you use this as an efficient way "
24243 "to transfer large files into the guest), then you should probably use L</add-"
24244 "drive-ro> instead."
24249 #: ../fish/guestfish-actions.pod:35
24255 #: ../fish/guestfish-actions.pod:37
24260 #: ../fish/guestfish-actions.pod:39
24263 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24269 #: ../fish/guestfish-actions.pod:41
24271 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24272 "It works by connecting to libvirt, requesting the domain and domain XML from "
24273 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24278 #: ../fish/guestfish-actions.pod:71
24280 "The other optional parameters are passed directly through to L</add-drive-"
24286 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24287 #: ../fish/guestfish-actions.pod:3039
24289 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24294 #: ../fish/guestfish-actions.pod:76
24300 #: ../fish/guestfish-actions.pod:78
24303 " add-drive filename\n"
24309 #: ../fish/guestfish-actions.pod:80
24311 "This function is the equivalent of calling L</add-drive-opts> with no "
24312 "optional parameters, so the disk is added writable, with the format being "
24313 "detected automatically."
24318 #: ../fish/guestfish-actions.pod:84
24320 "Automatic detection of the format opens you up to a potential security hole "
24321 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24322 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24323 "you should think about replacing calls to this function with calls to L</add-"
24324 "drive-opts>, and specifying the format."
24329 #: ../fish/guestfish-actions.pod:91
24330 msgid "add-drive-opts"
24335 #: ../fish/guestfish-actions.pod:93
24341 #: ../fish/guestfish-actions.pod:95
24344 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24350 #: ../fish/guestfish-actions.pod:122
24352 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24353 "add-drive-ro>) then the format is automatically detected. Possible formats "
24354 "include C<raw> and C<qcow2>."
24359 #: ../fish/guestfish-actions.pod:133
24361 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24362 "add-drive-with-if> call (q.v.)"
24367 #: ../fish/guestfish-actions.pod:140
24368 msgid "add-drive-ro"
24373 #: ../fish/guestfish-actions.pod:142
24379 #: ../fish/guestfish-actions.pod:144
24382 " add-drive-ro filename\n"
24388 #: ../fish/guestfish-actions.pod:146
24390 "This function is the equivalent of calling L</add-drive-opts> with the "
24391 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24392 "is added read-only, with the format being detected automatically."
24397 #: ../fish/guestfish-actions.pod:151
24398 msgid "add-drive-ro-with-if"
24403 #: ../fish/guestfish-actions.pod:153
24406 " add-drive-ro-with-if filename iface\n"
24412 #: ../fish/guestfish-actions.pod:155
24414 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24415 "interface emulation to use at run time."
24420 #: ../fish/guestfish-actions.pod:165
24421 msgid "add-drive-with-if"
24426 #: ../fish/guestfish-actions.pod:167
24429 " add-drive-with-if filename iface\n"
24435 #: ../fish/guestfish-actions.pod:169
24437 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24438 "interface emulation to use at run time."
24443 #: ../fish/guestfish-actions.pod:179
24449 #: ../fish/guestfish-actions.pod:181
24452 " aug-clear augpath\n"
24458 #: ../fish/guestfish-actions.pod:186
24464 #: ../fish/guestfish-actions.pod:188
24473 #: ../fish/guestfish-actions.pod:190
24475 "Close the current Augeas handle and free up any resources used by it. After "
24476 "calling this, you have to call L</aug-init> again before you can use any "
24477 "other Augeas functions."
24482 #: ../fish/guestfish-actions.pod:195
24483 msgid "aug-defnode"
24488 #: ../fish/guestfish-actions.pod:197
24491 " aug-defnode name expr val\n"
24497 #: ../fish/guestfish-actions.pod:202
24499 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24500 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24501 "containing that single node."
24506 #: ../fish/guestfish-actions.pod:210
24512 #: ../fish/guestfish-actions.pod:212
24515 " aug-defvar name expr\n"
24521 #: ../fish/guestfish-actions.pod:221
24527 #: ../fish/guestfish-actions.pod:223
24530 " aug-get augpath\n"
24536 #: ../fish/guestfish-actions.pod:228
24542 #: ../fish/guestfish-actions.pod:230
24545 " aug-init root flags\n"
24551 #: ../fish/guestfish-actions.pod:236
24552 msgid "You must call this before using any other L</aug-*> commands."
24557 #: ../fish/guestfish-actions.pod:271
24558 msgid "Do not load the tree in L</aug-init>."
24563 #: ../fish/guestfish-actions.pod:275
24564 msgid "To close the handle, you can call L</aug-close>."
24569 #: ../fish/guestfish-actions.pod:279
24575 #: ../fish/guestfish-actions.pod:281
24578 " aug-insert augpath label true|false\n"
24584 #: ../fish/guestfish-actions.pod:291
24590 #: ../fish/guestfish-actions.pod:293
24599 #: ../fish/guestfish-actions.pod:300
24605 #: ../fish/guestfish-actions.pod:302
24608 " aug-ls augpath\n"
24614 #: ../fish/guestfish-actions.pod:304
24616 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24617 "resulting nodes into alphabetical order."
24622 #: ../fish/guestfish-actions.pod:307
24628 #: ../fish/guestfish-actions.pod:309
24631 " aug-match augpath\n"
24637 #: ../fish/guestfish-actions.pod:315
24643 #: ../fish/guestfish-actions.pod:317
24646 " aug-mv src dest\n"
24652 #: ../fish/guestfish-actions.pod:322
24658 #: ../fish/guestfish-actions.pod:324
24661 " aug-rm augpath\n"
24667 #: ../fish/guestfish-actions.pod:330
24673 #: ../fish/guestfish-actions.pod:332
24682 #: ../fish/guestfish-actions.pod:336
24684 "The flags which were passed to L</aug-init> affect exactly how files are "
24690 #: ../fish/guestfish-actions.pod:339
24696 #: ../fish/guestfish-actions.pod:341
24699 " aug-set augpath val\n"
24705 #: ../fish/guestfish-actions.pod:345
24707 "In the Augeas API, it is possible to clear a node by setting the value to "
24708 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24709 "this call. Instead you must use the L</aug-clear> call."
24714 #: ../fish/guestfish-actions.pod:350
24720 #: ../fish/guestfish-actions.pod:352
24723 " available 'groups ...'\n"
24729 #: ../fish/guestfish-actions.pod:358
24731 "The libguestfs groups, and the functions that those groups correspond to, "
24732 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24733 "runtime by calling L</available-all-groups>."
24738 #: ../fish/guestfish-actions.pod:382
24739 msgid "You must call L</launch> before calling this function."
24744 #: ../fish/guestfish-actions.pod:404
24746 "This call was added in version C<1.0.80>. In previous versions of "
24747 "libguestfs all you could do would be to speculatively execute a command to "
24748 "find out if the daemon implemented it. See also L</version>."
24753 #: ../fish/guestfish-actions.pod:411
24754 msgid "available-all-groups"
24759 #: ../fish/guestfish-actions.pod:413
24762 " available-all-groups\n"
24768 #: ../fish/guestfish-actions.pod:415
24770 "This command returns a list of all optional groups that this daemon knows "
24771 "about. Note this returns both supported and unsupported groups. To find "
24772 "out which ones the daemon can actually support you have to call L</"
24773 "available> on each member of the returned list."
24778 #: ../fish/guestfish-actions.pod:421
24779 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24784 #: ../fish/guestfish-actions.pod:423
24790 #: ../fish/guestfish-actions.pod:425
24793 " base64-in (base64file|-) filename\n"
24799 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24800 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24801 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24802 #: ../fish/guestfish-actions.pod:4437 ../fish/guestfish-actions.pod:4449
24803 #: ../fish/guestfish-actions.pod:4460 ../fish/guestfish-actions.pod:4471
24804 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4532
24805 #: ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4609
24806 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24811 #: ../fish/guestfish-actions.pod:432
24817 #: ../fish/guestfish-actions.pod:434
24820 " base64-out filename (base64file|-)\n"
24826 #: ../fish/guestfish-actions.pod:441
24827 msgid "blockdev-flushbufs"
24832 #: ../fish/guestfish-actions.pod:443
24835 " blockdev-flushbufs device\n"
24841 #: ../fish/guestfish-actions.pod:450
24842 msgid "blockdev-getbsz"
24847 #: ../fish/guestfish-actions.pod:452
24850 " blockdev-getbsz device\n"
24856 #: ../fish/guestfish-actions.pod:461
24857 msgid "blockdev-getro"
24862 #: ../fish/guestfish-actions.pod:463
24865 " blockdev-getro device\n"
24871 #: ../fish/guestfish-actions.pod:470
24872 msgid "blockdev-getsize64"
24877 #: ../fish/guestfish-actions.pod:472
24880 " blockdev-getsize64 device\n"
24886 #: ../fish/guestfish-actions.pod:476
24887 msgid "See also L</blockdev-getsz>."
24892 #: ../fish/guestfish-actions.pod:480
24893 msgid "blockdev-getss"
24898 #: ../fish/guestfish-actions.pod:482
24901 " blockdev-getss device\n"
24907 #: ../fish/guestfish-actions.pod:487
24909 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
24914 #: ../fish/guestfish-actions.pod:492
24915 msgid "blockdev-getsz"
24920 #: ../fish/guestfish-actions.pod:494
24923 " blockdev-getsz device\n"
24929 #: ../fish/guestfish-actions.pod:499
24931 "See also L</blockdev-getss> for the real sector size of the device, and L</"
24932 "blockdev-getsize64> for the more useful I<size in bytes>."
24937 #: ../fish/guestfish-actions.pod:505
24938 msgid "blockdev-rereadpt"
24943 #: ../fish/guestfish-actions.pod:507
24946 " blockdev-rereadpt device\n"
24952 #: ../fish/guestfish-actions.pod:513
24953 msgid "blockdev-setbsz"
24958 #: ../fish/guestfish-actions.pod:515
24961 " blockdev-setbsz device blocksize\n"
24967 #: ../fish/guestfish-actions.pod:524
24968 msgid "blockdev-setro"
24973 #: ../fish/guestfish-actions.pod:526
24976 " blockdev-setro device\n"
24982 #: ../fish/guestfish-actions.pod:532
24983 msgid "blockdev-setrw"
24988 #: ../fish/guestfish-actions.pod:534
24991 " blockdev-setrw device\n"
24997 #: ../fish/guestfish-actions.pod:540
24998 msgid "case-sensitive-path"
25003 #: ../fish/guestfish-actions.pod:542
25006 " case-sensitive-path path\n"
25012 #: ../fish/guestfish-actions.pod:566
25014 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
25015 "WINDOWS/system32\"> (the exact return value would depend on details of how "
25016 "the directories were originally created under Windows)."
25021 #: ../fish/guestfish-actions.pod:574
25022 msgid "See also L</realpath>."
25027 #: ../fish/guestfish-actions.pod:576
25033 #: ../fish/guestfish-actions.pod:578
25042 #: ../fish/guestfish-actions.pod:582
25044 "Note that this function cannot correctly handle binary files (specifically, "
25045 "files containing C<\\0> character which is treated as end of string). For "
25046 "those you need to use the L</read-file> or L</download> functions which have "
25047 "a more complex interface."
25052 #: ../fish/guestfish-actions.pod:590
25058 #: ../fish/guestfish-actions.pod:592
25061 " checksum csumtype path\n"
25067 #: ../fish/guestfish-actions.pod:635
25068 msgid "To get the checksum for a device, use L</checksum-device>."
25073 #: ../fish/guestfish-actions.pod:637
25074 msgid "To get the checksums for many files, use L</checksums-out>."
25079 #: ../fish/guestfish-actions.pod:639
25080 msgid "checksum-device"
25085 #: ../fish/guestfish-actions.pod:641
25088 " checksum-device csumtype device\n"
25094 #: ../fish/guestfish-actions.pod:643
25096 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25097 "device named C<device>. For the types of checksums supported see the L</"
25098 "checksum> command."
25103 #: ../fish/guestfish-actions.pod:647
25104 msgid "checksums-out"
25109 #: ../fish/guestfish-actions.pod:649
25112 " checksums-out csumtype directory (sumsfile|-)\n"
25118 #: ../fish/guestfish-actions.pod:665
25124 #: ../fish/guestfish-actions.pod:667
25127 " chmod mode path\n"
25133 #: ../fish/guestfish-actions.pod:678
25139 #: ../fish/guestfish-actions.pod:680
25142 " chown owner group path\n"
25148 #: ../fish/guestfish-actions.pod:688
25154 #: ../fish/guestfish-actions.pod:690
25157 " command 'arguments ...'\n"
25163 #: ../fish/guestfish-actions.pod:697
25165 "The single parameter is an argv-style list of arguments. The first element "
25166 "is the name of the program to run. Subsequent elements are parameters. The "
25167 "list must be non-empty (ie. must contain a program name). Note that the "
25168 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25173 #: ../fish/guestfish-actions.pod:725
25174 msgid "command-lines"
25179 #: ../fish/guestfish-actions.pod:727
25182 " command-lines 'arguments ...'\n"
25188 #: ../fish/guestfish-actions.pod:729
25190 "This is the same as L</command>, but splits the result into a list of lines."
25195 #: ../fish/guestfish-actions.pod:732
25196 msgid "See also: L</sh-lines>"
25201 #: ../fish/guestfish-actions.pod:737
25207 #: ../fish/guestfish-actions.pod:739
25210 " config qemuparam qemuvalue\n"
25216 #: ../fish/guestfish-actions.pod:750
25222 #: ../fish/guestfish-actions.pod:752
25225 " copy-size src dest size\n"
25231 #: ../fish/guestfish-actions.pod:760
25237 #: ../fish/guestfish-actions.pod:762
25246 #: ../fish/guestfish-actions.pod:767
25252 #: ../fish/guestfish-actions.pod:769
25261 #: ../fish/guestfish-actions.pod:774
25267 #: ../fish/guestfish-actions.pod:776
25276 #: ../fish/guestfish-actions.pod:783
25278 "If the destination is a device, it must be as large or larger than the "
25279 "source file or device, otherwise the copy will fail. This command cannot do "
25280 "partial copies (see L</copy-size>)."
25285 #: ../fish/guestfish-actions.pod:787
25291 #: ../fish/guestfish-actions.pod:789
25300 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25302 "This command is mostly useful for interactive sessions. It is I<not> "
25303 "intended that you try to parse the output string. Use L</statvfs> from "
25309 #: ../fish/guestfish-actions.pod:797
25315 #: ../fish/guestfish-actions.pod:799
25324 #: ../fish/guestfish-actions.pod:808
25330 #: ../fish/guestfish-actions.pod:810
25339 #: ../fish/guestfish-actions.pod:816
25341 "Another way to get the same information is to enable verbose messages with "
25342 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25343 "before running the program."
25348 #: ../fish/guestfish-actions.pod:821
25354 #: ../fish/guestfish-actions.pod:823
25357 " download remotefilename (filename|-)\n"
25363 #: ../fish/guestfish-actions.pod:830
25364 msgid "See also L</upload>, L</cat>."
25369 #: ../fish/guestfish-actions.pod:834
25370 msgid "download-offset"
25375 #: ../fish/guestfish-actions.pod:836
25378 " download-offset remotefilename (filename|-) offset size\n"
25384 #: ../fish/guestfish-actions.pod:844
25386 "Note that there is no limit on the amount of data that can be downloaded "
25387 "with this call, unlike with L</pread>, and this call always reads the full "
25388 "amount unless an error occurs."
25393 #: ../fish/guestfish-actions.pod:849
25394 msgid "See also L</download>, L</pread>."
25399 #: ../fish/guestfish-actions.pod:853
25400 msgid "drop-caches"
25405 #: ../fish/guestfish-actions.pod:855
25408 " drop-caches whattodrop\n"
25414 #: ../fish/guestfish-actions.pod:867
25420 #: ../fish/guestfish-actions.pod:869
25429 #: ../fish/guestfish-actions.pod:881
25435 #: ../fish/guestfish-actions.pod:883
25438 " e2fsck-f device\n"
25444 #: ../fish/guestfish-actions.pod:889
25446 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25447 "should use L</fsck>."
25452 #: ../fish/guestfish-actions.pod:892
25453 msgid "echo-daemon"
25458 #: ../fish/guestfish-actions.pod:894
25461 " echo-daemon 'words ...'\n"
25467 #: ../fish/guestfish-actions.pod:901
25468 msgid "See also L</ping-daemon>."
25473 #: ../fish/guestfish-actions.pod:903
25479 #: ../fish/guestfish-actions.pod:905
25482 " egrep regex path\n"
25488 #: ../fish/guestfish-actions.pod:913
25494 #: ../fish/guestfish-actions.pod:915
25497 " egrepi regex path\n"
25503 #: ../fish/guestfish-actions.pod:923
25509 #: ../fish/guestfish-actions.pod:925
25512 " equal file1 file2\n"
25518 #: ../fish/guestfish-actions.pod:932
25524 #: ../fish/guestfish-actions.pod:934
25533 #: ../fish/guestfish-actions.pod:939
25534 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25539 #: ../fish/guestfish-actions.pod:941
25545 #: ../fish/guestfish-actions.pod:943
25548 " fallocate path len\n"
25554 #: ../fish/guestfish-actions.pod:960
25555 msgid "fallocate64"
25560 #: ../fish/guestfish-actions.pod:962
25563 " fallocate64 path len\n"
25569 #: ../fish/guestfish-actions.pod:968
25571 "Note that this call allocates disk blocks for the file. To create a sparse "
25572 "file use L</truncate-size> instead."
25577 #: ../fish/guestfish-actions.pod:971
25579 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25580 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25581 "maximum size of files created through that call to 1GB."
25586 #: ../fish/guestfish-actions.pod:980
25592 #: ../fish/guestfish-actions.pod:982
25595 " fgrep pattern path\n"
25601 #: ../fish/guestfish-actions.pod:990
25607 #: ../fish/guestfish-actions.pod:992
25610 " fgrepi pattern path\n"
25616 #: ../fish/guestfish-actions.pod:1000
25622 #: ../fish/guestfish-actions.pod:1002
25631 #: ../fish/guestfish-actions.pod:1014
25633 "This command can also be used on C</dev/> devices (and partitions, LV "
25634 "names). You can for example use this to determine if a device contains a "
25635 "filesystem, although it's usually better to use L</vfs-type>."
25640 #: ../fish/guestfish-actions.pod:1024
25641 msgid "file-architecture"
25646 #: ../fish/guestfish-actions.pod:1026
25649 " file-architecture filename\n"
25655 #: ../fish/guestfish-actions.pod:1129
25661 #: ../fish/guestfish-actions.pod:1131
25670 #: ../fish/guestfish-actions.pod:1135
25672 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25673 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25678 #: ../fish/guestfish-actions.pod:1139
25684 #: ../fish/guestfish-actions.pod:1141
25687 " fill c len path\n"
25693 #: ../fish/guestfish-actions.pod:1147
25695 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25696 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25697 "L</fill-pattern>."
25702 #: ../fish/guestfish-actions.pod:1152
25703 msgid "fill-pattern"
25708 #: ../fish/guestfish-actions.pod:1154
25711 " fill-pattern pattern len path\n"
25717 #: ../fish/guestfish-actions.pod:1156
25719 "This function is like L</fill> except that it creates a new file of length "
25720 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25721 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25727 #: ../fish/guestfish-actions.pod:1161
25733 #: ../fish/guestfish-actions.pod:1163
25736 " find directory\n"
25742 #: ../fish/guestfish-actions.pod:1177
25743 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25748 #: ../fish/guestfish-actions.pod:1190
25749 msgid "See also L</find0>."
25754 #: ../fish/guestfish-actions.pod:1195
25760 #: ../fish/guestfish-actions.pod:1197
25763 " find0 directory (files|-)\n"
25769 #: ../fish/guestfish-actions.pod:1203
25771 "This command works the same way as L</find> with the following exceptions:"
25776 #: ../fish/guestfish-actions.pod:1230
25777 msgid "findfs-label"
25782 #: ../fish/guestfish-actions.pod:1232
25785 " findfs-label label\n"
25791 #: ../fish/guestfish-actions.pod:1238
25792 msgid "To find the label of a filesystem, use L</vfs-label>."
25797 #: ../fish/guestfish-actions.pod:1240
25798 msgid "findfs-uuid"
25803 #: ../fish/guestfish-actions.pod:1242
25806 " findfs-uuid uuid\n"
25812 #: ../fish/guestfish-actions.pod:1248
25813 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25818 #: ../fish/guestfish-actions.pod:1250
25824 #: ../fish/guestfish-actions.pod:1252
25827 " fsck fstype device\n"
25833 #: ../fish/guestfish-actions.pod:1282
25839 #: ../fish/guestfish-actions.pod:1284
25847 #: ../fish/guestfish-actions.pod:1291
25848 msgid "get-attach-method"
25852 #: ../fish/guestfish-actions.pod:1293
25855 " get-attach-method\n"
25860 #: ../fish/guestfish-actions.pod:1295
25861 msgid "Return the current attach method. See L</set-attach-method>."
25866 #: ../fish/guestfish-actions.pod:1297
25867 msgid "get-autosync"
25872 #: ../fish/guestfish-actions.pod:1299
25881 #: ../fish/guestfish-actions.pod:1303
25887 #: ../fish/guestfish-actions.pod:1305
25896 #: ../fish/guestfish-actions.pod:1309
25897 msgid "get-e2label"
25902 #: ../fish/guestfish-actions.pod:1311
25905 " get-e2label device\n"
25911 #: ../fish/guestfish-actions.pod:1323
25917 #: ../fish/guestfish-actions.pod:1325
25920 " get-e2uuid device\n"
25926 #: ../fish/guestfish-actions.pod:1337
25927 msgid "get-memsize"
25932 #: ../fish/guestfish-actions.pod:1339
25941 #: ../fish/guestfish-actions.pod:1344
25943 "If L</set-memsize> was not called on this handle, and if "
25944 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
25945 "value for memsize."
25950 #: ../fish/guestfish-actions.pod:1351
25951 msgid "get-network"
25956 #: ../fish/guestfish-actions.pod:1353
25965 #: ../fish/guestfish-actions.pod:1357
25971 #: ../fish/guestfish-actions.pod:1359
25980 #: ../fish/guestfish-actions.pod:1366
25986 #: ../fish/guestfish-actions.pod:1368
25992 #: ../fish/guestfish-actions.pod:1370
26001 #: ../fish/guestfish-actions.pod:1377
26007 #: ../fish/guestfish-actions.pod:1379
26016 #: ../fish/guestfish-actions.pod:1386
26017 msgid "get-recovery-proc"
26022 #: ../fish/guestfish-actions.pod:1388
26025 " get-recovery-proc\n"
26031 #: ../fish/guestfish-actions.pod:1392
26032 msgid "get-selinux"
26037 #: ../fish/guestfish-actions.pod:1394
26046 #: ../fish/guestfish-actions.pod:1396
26048 "This returns the current setting of the selinux flag which is passed to the "
26049 "appliance at boot time. See L</set-selinux>."
26054 #: ../fish/guestfish-actions.pod:1402
26060 #: ../fish/guestfish-actions.pod:1404
26069 #: ../fish/guestfish-actions.pod:1411
26075 #: ../fish/guestfish-actions.pod:1413
26084 #: ../fish/guestfish-actions.pod:1417
26090 #: ../fish/guestfish-actions.pod:1419
26099 #: ../fish/guestfish-actions.pod:1421
26101 "Return the current umask. By default the umask is C<022> unless it has been "
26102 "set by calling L</umask>."
26107 #: ../fish/guestfish-actions.pod:1424
26108 msgid "get-verbose"
26113 #: ../fish/guestfish-actions.pod:1426
26122 #: ../fish/guestfish-actions.pod:1430
26128 #: ../fish/guestfish-actions.pod:1432
26137 #: ../fish/guestfish-actions.pod:1436
26138 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26143 #: ../fish/guestfish-actions.pod:1439
26149 #: ../fish/guestfish-actions.pod:1441
26152 " getxattr path name\n"
26158 #: ../fish/guestfish-actions.pod:1443
26160 "Get a single extended attribute from file C<path> named C<name>. This call "
26161 "follows symlinks. If you want to lookup an extended attribute for the "
26162 "symlink itself, use L</lgetxattr>."
26167 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2445
26169 "Normally it is better to get all extended attributes from a file in one go "
26170 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26171 "buggy and do not provide a way to list out attributes. For these "
26172 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26173 "attributes you want in advance and call this function."
26178 #: ../fish/guestfish-actions.pod:1457
26179 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26184 #: ../fish/guestfish-actions.pod:1459
26190 #: ../fish/guestfish-actions.pod:1461
26193 " getxattrs path\n"
26199 #: ../fish/guestfish-actions.pod:1469
26200 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26205 #: ../fish/guestfish-actions.pod:1471
26206 msgid "glob-expand"
26211 #: ../fish/guestfish-actions.pod:1473
26214 " glob-expand pattern\n"
26220 #: ../fish/guestfish-actions.pod:1486
26226 #: ../fish/guestfish-actions.pod:1488
26229 " grep regex path\n"
26235 #: ../fish/guestfish-actions.pod:1496
26241 #: ../fish/guestfish-actions.pod:1498
26244 " grepi regex path\n"
26250 #: ../fish/guestfish-actions.pod:1506
26251 msgid "grub-install"
26256 #: ../fish/guestfish-actions.pod:1508
26259 " grub-install root device\n"
26265 #: ../fish/guestfish-actions.pod:1524
26271 #: ../fish/guestfish-actions.pod:1526
26280 #: ../fish/guestfish-actions.pod:1534
26286 #: ../fish/guestfish-actions.pod:1536
26289 " head-n nrlines path\n"
26295 #: ../fish/guestfish-actions.pod:1549
26301 #: ../fish/guestfish-actions.pod:1551
26310 #: ../fish/guestfish-actions.pod:1559
26316 #: ../fish/guestfish-actions.pod:1561
26319 " initrd-cat initrdpath filename\n"
26325 #: ../fish/guestfish-actions.pod:1573
26326 msgid "See also L</initrd-list>."
26331 #: ../fish/guestfish-actions.pod:1578
26332 msgid "initrd-list"
26337 #: ../fish/guestfish-actions.pod:1580
26340 " initrd-list path\n"
26346 #: ../fish/guestfish-actions.pod:1592
26347 msgid "inotify-add-watch"
26352 #: ../fish/guestfish-actions.pod:1594
26355 " inotify-add-watch path mask\n"
26361 #: ../fish/guestfish-actions.pod:1606
26362 msgid "inotify-close"
26367 #: ../fish/guestfish-actions.pod:1608
26376 #: ../fish/guestfish-actions.pod:1614
26377 msgid "inotify-files"
26382 #: ../fish/guestfish-actions.pod:1616
26391 #: ../fish/guestfish-actions.pod:1618
26393 "This function is a helpful wrapper around L</inotify-read> which just "
26394 "returns a list of pathnames of objects that were touched. The returned "
26395 "pathnames are sorted and deduplicated."
26400 #: ../fish/guestfish-actions.pod:1622
26401 msgid "inotify-init"
26406 #: ../fish/guestfish-actions.pod:1624
26409 " inotify-init maxevents\n"
26415 #: ../fish/guestfish-actions.pod:1630
26417 "C<maxevents> is the maximum number of events which will be queued up between "
26418 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26419 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26420 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26421 "but records the fact that it threw them away by setting a flag "
26422 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26427 #: ../fish/guestfish-actions.pod:1640
26429 "Before any events are generated, you have to add some watches to the "
26430 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26431 "L</inotify-watch-all>."
26436 #: ../fish/guestfish-actions.pod:1646
26438 "Queued up events should be read periodically by calling L</inotify-read> (or "
26439 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26440 "If you don't read the events out often enough then you risk the internal "
26441 "queue overflowing."
26446 #: ../fish/guestfish-actions.pod:1653
26448 "The handle should be closed after use by calling L</inotify-close>. This "
26449 "also removes any watches automatically."
26454 #: ../fish/guestfish-actions.pod:1662
26455 msgid "inotify-read"
26460 #: ../fish/guestfish-actions.pod:1664
26469 #: ../fish/guestfish-actions.pod:1677
26470 msgid "inotify-rm-watch"
26475 #: ../fish/guestfish-actions.pod:1679
26478 " inotify-rm-watch wd\n"
26484 #: ../fish/guestfish-actions.pod:1681
26485 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26490 #: ../fish/guestfish-actions.pod:1684
26491 msgid "inspect-get-arch"
26496 #: ../fish/guestfish-actions.pod:1686
26499 " inspect-get-arch root\n"
26505 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26506 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1818
26507 #: ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1870
26508 #: ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1906
26509 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1954
26510 #: ../fish/guestfish-actions.pod:1976 ../fish/guestfish-actions.pod:2000
26511 #: ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2060
26512 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2111
26513 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2140
26514 #: ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2168
26516 "This function should only be called with a root device string as returned by "
26522 #: ../fish/guestfish-actions.pod:1691
26524 "This returns the architecture of the inspected operating system. The "
26525 "possible return values are listed under L</file-architecture>."
26530 #: ../fish/guestfish-actions.pod:1700
26531 msgid "inspect-get-distro"
26536 #: ../fish/guestfish-actions.pod:1702
26539 " inspect-get-distro root\n"
26544 #: ../fish/guestfish-actions.pod:1778
26545 msgid "inspect-get-drive-mappings"
26549 #: ../fish/guestfish-actions.pod:1780
26552 " inspect-get-drive-mappings root\n"
26557 #: ../fish/guestfish-actions.pod:1810
26559 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26560 "get-mountpoints>, L</inspect-get-filesystems>."
26565 #: ../fish/guestfish-actions.pod:1814
26566 msgid "inspect-get-filesystems"
26571 #: ../fish/guestfish-actions.pod:1816
26574 " inspect-get-filesystems root\n"
26580 #: ../fish/guestfish-actions.pod:1829
26582 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26583 "get-mountpoints>."
26587 #: ../fish/guestfish-actions.pod:1832
26588 msgid "inspect-get-format"
26592 #: ../fish/guestfish-actions.pod:1834
26595 " inspect-get-format root\n"
26601 #: ../fish/guestfish-actions.pod:1866
26602 msgid "inspect-get-hostname"
26607 #: ../fish/guestfish-actions.pod:1868
26610 " inspect-get-hostname root\n"
26616 #: ../fish/guestfish-actions.pod:1881
26617 msgid "inspect-get-major-version"
26622 #: ../fish/guestfish-actions.pod:1883
26625 " inspect-get-major-version root\n"
26631 #: ../fish/guestfish-actions.pod:1902
26632 msgid "inspect-get-minor-version"
26637 #: ../fish/guestfish-actions.pod:1904
26640 " inspect-get-minor-version root\n"
26646 #: ../fish/guestfish-actions.pod:1914
26648 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26649 "get-major-version>."
26654 #: ../fish/guestfish-actions.pod:1917
26655 msgid "inspect-get-mountpoints"
26660 #: ../fish/guestfish-actions.pod:1919
26663 " inspect-get-mountpoints root\n"
26668 #: ../fish/guestfish-actions.pod:1941
26670 "For operating systems like Windows which still use drive letters, this call "
26671 "will only return an entry for the first drive \"mounted on\" C</>. For "
26672 "information about the mapping of drive letters to partitions, see L</inspect-"
26673 "get-drive-mappings>."
26678 #: ../fish/guestfish-actions.pod:1947
26680 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26681 "get-filesystems>."
26686 #: ../fish/guestfish-actions.pod:1950
26687 msgid "inspect-get-package-format"
26692 #: ../fish/guestfish-actions.pod:1952
26695 " inspect-get-package-format root\n"
26701 #: ../fish/guestfish-actions.pod:1957
26703 "This function and L</inspect-get-package-management> return the package "
26704 "format and package management tool used by the inspected operating system. "
26705 "For example for Fedora these functions would return C<rpm> (package format) "
26706 "and C<yum> (package management)."
26711 #: ../fish/guestfish-actions.pod:1972
26712 msgid "inspect-get-package-management"
26717 #: ../fish/guestfish-actions.pod:1974
26720 " inspect-get-package-management root\n"
26726 #: ../fish/guestfish-actions.pod:1979
26728 "L</inspect-get-package-format> and this function return the package format "
26729 "and package management tool used by the inspected operating system. For "
26730 "example for Fedora these functions would return C<rpm> (package format) and "
26731 "C<yum> (package management)."
26736 #: ../fish/guestfish-actions.pod:1996
26737 msgid "inspect-get-product-name"
26742 #: ../fish/guestfish-actions.pod:1998
26745 " inspect-get-product-name root\n"
26750 #: ../fish/guestfish-actions.pod:2013
26751 msgid "inspect-get-product-variant"
26755 #: ../fish/guestfish-actions.pod:2015
26758 " inspect-get-product-variant root\n"
26763 #: ../fish/guestfish-actions.pod:2039
26765 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26766 "get-product-name>, L</inspect-get-major-version>."
26771 #: ../fish/guestfish-actions.pod:2043
26772 msgid "inspect-get-roots"
26777 #: ../fish/guestfish-actions.pod:2045
26780 " inspect-get-roots\n"
26786 #: ../fish/guestfish-actions.pod:2047
26788 "This function is a convenient way to get the list of root devices, as "
26789 "returned from a previous call to L</inspect-os>, but without redoing the "
26790 "whole inspection process."
26795 #: ../fish/guestfish-actions.pod:2051
26797 "This returns an empty list if either no root devices were found or the "
26798 "caller has not called L</inspect-os>."
26803 #: ../fish/guestfish-actions.pod:2056
26804 msgid "inspect-get-type"
26809 #: ../fish/guestfish-actions.pod:2058
26812 " inspect-get-type root\n"
26817 #: ../fish/guestfish-actions.pod:2091
26818 msgid "inspect-get-windows-current-control-set"
26822 #: ../fish/guestfish-actions.pod:2093
26825 " inspect-get-windows-current-control-set root\n"
26831 #: ../fish/guestfish-actions.pod:2107
26832 msgid "inspect-get-windows-systemroot"
26837 #: ../fish/guestfish-actions.pod:2109
26840 " inspect-get-windows-systemroot root\n"
26845 #: ../fish/guestfish-actions.pod:2123
26846 msgid "inspect-is-live"
26850 #: ../fish/guestfish-actions.pod:2125
26853 " inspect-is-live root\n"
26858 #: ../fish/guestfish-actions.pod:2130
26860 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26861 "then this returns true if a live image was detected on the disk."
26865 #: ../fish/guestfish-actions.pod:2136
26866 msgid "inspect-is-multipart"
26870 #: ../fish/guestfish-actions.pod:2138
26873 " inspect-is-multipart root\n"
26878 #: ../fish/guestfish-actions.pod:2143
26880 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26881 "then this returns true if the disk is part of a set."
26885 #: ../fish/guestfish-actions.pod:2149
26886 msgid "inspect-is-netinst"
26890 #: ../fish/guestfish-actions.pod:2151
26893 " inspect-is-netinst root\n"
26898 #: ../fish/guestfish-actions.pod:2156
26900 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26901 "then this returns true if the disk is a network installer, ie. not a self-"
26902 "contained install CD but one which is likely to require network access to "
26903 "complete the install."
26908 #: ../fish/guestfish-actions.pod:2164
26909 msgid "inspect-list-applications"
26914 #: ../fish/guestfish-actions.pod:2166
26917 " inspect-list-applications root\n"
26923 #: ../fish/guestfish-actions.pod:2173
26925 "I<Note:> This call works differently from other parts of the inspection "
26926 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
26927 "then mount up the disks, before calling this. Listing applications is a "
26928 "significantly more difficult operation which requires access to the full "
26929 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
26930 "are just returning data cached in the libguestfs handle, this call actually "
26931 "reads parts of the mounted filesystems during the call."
26936 #: ../fish/guestfish-actions.pod:2263
26942 #: ../fish/guestfish-actions.pod:2265
26951 #: ../fish/guestfish-actions.pod:2280
26953 "You can pass the root string(s) returned to other L</inspect-get-*> "
26954 "functions in order to query further information about each operating system, "
26955 "such as the name and version."
26960 #: ../fish/guestfish-actions.pod:2285
26962 "This function uses other libguestfs features such as L</mount-ro> and L</"
26963 "umount-all> in order to mount and unmount filesystems and look at the "
26964 "contents. This should be called with no disks currently mounted. The "
26965 "function may also use Augeas, so any existing Augeas handle will be closed."
26970 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2473
26971 #: ../fish/guestfish-actions.pod:2519
26972 msgid "See also L</list-filesystems>."
26977 #: ../fish/guestfish-actions.pod:2299
26978 msgid "is-blockdev"
26983 #: ../fish/guestfish-actions.pod:2301
26986 " is-blockdev path\n"
26992 #: ../fish/guestfish-actions.pod:2306 ../fish/guestfish-actions.pod:2324
26993 #: ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2352
26994 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2396
26995 #: ../fish/guestfish-actions.pod:2405
26996 msgid "See also L</stat>."
27001 #: ../fish/guestfish-actions.pod:2308
27007 #: ../fish/guestfish-actions.pod:2310
27016 #: ../fish/guestfish-actions.pod:2317
27022 #: ../fish/guestfish-actions.pod:2319
27025 " is-chardev path\n"
27031 #: ../fish/guestfish-actions.pod:2326
27037 #: ../fish/guestfish-actions.pod:2328
27046 #: ../fish/guestfish-actions.pod:2335
27052 #: ../fish/guestfish-actions.pod:2337
27061 #: ../fish/guestfish-actions.pod:2345
27067 #: ../fish/guestfish-actions.pod:2347
27076 #: ../fish/guestfish-actions.pod:2354
27082 #: ../fish/guestfish-actions.pod:2356
27091 #: ../fish/guestfish-actions.pod:2364
27092 msgid "is-launching"
27097 #: ../fish/guestfish-actions.pod:2366
27106 #: ../fish/guestfish-actions.pod:2373
27112 #: ../fish/guestfish-actions.pod:2375
27121 #: ../fish/guestfish-actions.pod:2380
27127 #: ../fish/guestfish-actions.pod:2382
27136 #: ../fish/guestfish-actions.pod:2389
27142 #: ../fish/guestfish-actions.pod:2391
27145 " is-socket path\n"
27151 #: ../fish/guestfish-actions.pod:2398
27157 #: ../fish/guestfish-actions.pod:2400
27160 " is-symlink path\n"
27166 #: ../fish/guestfish-actions.pod:2407
27167 msgid "kill-subprocess"
27172 #: ../fish/guestfish-actions.pod:2409
27175 " kill-subprocess\n"
27181 #: ../fish/guestfish-actions.pod:2413
27187 #: ../fish/guestfish-actions.pod:2415
27193 #: ../fish/guestfish-actions.pod:2417
27202 #: ../fish/guestfish-actions.pod:2425
27208 #: ../fish/guestfish-actions.pod:2427
27211 " lchown owner group path\n"
27217 #: ../fish/guestfish-actions.pod:2429
27219 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27220 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27226 #: ../fish/guestfish-actions.pod:2437
27232 #: ../fish/guestfish-actions.pod:2439
27235 " lgetxattr path name\n"
27241 #: ../fish/guestfish-actions.pod:2455
27242 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27247 #: ../fish/guestfish-actions.pod:2457
27253 #: ../fish/guestfish-actions.pod:2459
27256 " lgetxattrs path\n"
27262 #: ../fish/guestfish-actions.pod:2461
27264 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27265 "it returns the extended attributes of the link itself."
27270 #: ../fish/guestfish-actions.pod:2465
27271 msgid "list-devices"
27276 #: ../fish/guestfish-actions.pod:2467
27285 #: ../fish/guestfish-actions.pod:2475
27286 msgid "list-filesystems"
27291 #: ../fish/guestfish-actions.pod:2477
27294 " list-filesystems\n"
27300 #: ../fish/guestfish-actions.pod:2496
27302 "This command runs other libguestfs commands, which might include L</mount> "
27303 "and L</umount>, and therefore you should use this soon after launch and only "
27304 "when nothing is mounted."
27309 #: ../fish/guestfish-actions.pod:2500
27311 "Not all of the filesystems returned will be mountable. In particular, swap "
27312 "partitions are returned in the list. Also this command does not check that "
27313 "each filesystem found is valid and mountable, and some filesystems might be "
27314 "mountable but require special options. Filesystems may not all belong to a "
27315 "single logical operating system (use L</inspect-os> to look for OSes)."
27320 #: ../fish/guestfish-actions.pod:2508
27321 msgid "list-partitions"
27326 #: ../fish/guestfish-actions.pod:2510
27329 " list-partitions\n"
27335 #: ../fish/guestfish-actions.pod:2516
27337 "This does not return logical volumes. For that you will need to call L</"
27343 #: ../fish/guestfish-actions.pod:2521
27349 #: ../fish/guestfish-actions.pod:2523
27358 #: ../fish/guestfish-actions.pod:2531
27364 #: ../fish/guestfish-actions.pod:2533
27367 " ln target linkname\n"
27373 #: ../fish/guestfish-actions.pod:2537
27379 #: ../fish/guestfish-actions.pod:2539
27382 " ln-f target linkname\n"
27388 #: ../fish/guestfish-actions.pod:2544
27394 #: ../fish/guestfish-actions.pod:2546
27397 " ln-s target linkname\n"
27403 #: ../fish/guestfish-actions.pod:2550
27409 #: ../fish/guestfish-actions.pod:2552
27412 " ln-sf target linkname\n"
27418 #: ../fish/guestfish-actions.pod:2557
27419 msgid "lremovexattr"
27424 #: ../fish/guestfish-actions.pod:2559
27427 " lremovexattr xattr path\n"
27433 #: ../fish/guestfish-actions.pod:2561
27435 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27436 "it removes an extended attribute of the link itself."
27441 #: ../fish/guestfish-actions.pod:2565
27447 #: ../fish/guestfish-actions.pod:2567
27456 #: ../fish/guestfish-actions.pod:2573
27458 "This command is mostly useful for interactive sessions. Programs should "
27459 "probably use L</readdir> instead."
27464 #: ../fish/guestfish-actions.pod:2576
27470 #: ../fish/guestfish-actions.pod:2578
27473 " lsetxattr xattr val vallen path\n"
27479 #: ../fish/guestfish-actions.pod:2580
27481 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27482 "sets an extended attribute of the link itself."
27487 #: ../fish/guestfish-actions.pod:2584
27493 #: ../fish/guestfish-actions.pod:2586
27502 #: ../fish/guestfish-actions.pod:2590
27504 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27505 "the link is stat-ed, not the file it refers to."
27510 #: ../fish/guestfish-actions.pod:2596
27516 #: ../fish/guestfish-actions.pod:2598
27519 " lstatlist path 'names ...'\n"
27525 #: ../fish/guestfish-actions.pod:2600
27527 "This call allows you to perform the L</lstat> operation on multiple files, "
27528 "where all files are in the directory C<path>. C<names> is the list of files "
27529 "from this directory."
27534 #: ../fish/guestfish-actions.pod:2609
27536 "This call is intended for programs that want to efficiently list a directory "
27537 "contents without making many round-trips. See also L</lxattrlist> for a "
27538 "similarly efficient call for getting extended attributes. Very long "
27539 "directory listings might cause the protocol message size to be exceeded, "
27540 "causing this call to fail. The caller must split up such requests into "
27541 "smaller groups of names."
27546 #: ../fish/guestfish-actions.pod:2617
27547 msgid "luks-add-key"
27552 #: ../fish/guestfish-actions.pod:2619
27555 " luks-add-key device keyslot\n"
27561 #: ../fish/guestfish-actions.pod:2626
27563 "Note that if C<keyslot> already contains a key, then this command will "
27564 "fail. You have to use L</luks-kill-slot> first to remove that key."
27569 #: ../fish/guestfish-actions.pod:2630 ../fish/guestfish-actions.pod:2652
27570 #: ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2679
27571 #: ../fish/guestfish-actions.pod:2702 ../fish/guestfish-actions.pod:2712
27573 "This command has one or more key or passphrase parameters. Guestfish will "
27574 "prompt for these separately."
27579 #: ../fish/guestfish-actions.pod:2633
27585 #: ../fish/guestfish-actions.pod:2635
27588 " luks-close device\n"
27594 #: ../fish/guestfish-actions.pod:2637
27596 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27597 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27598 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27604 #: ../fish/guestfish-actions.pod:2643
27605 msgid "luks-format"
27610 #: ../fish/guestfish-actions.pod:2645
27613 " luks-format device keyslot\n"
27619 #: ../fish/guestfish-actions.pod:2658
27620 msgid "luks-format-cipher"
27625 #: ../fish/guestfish-actions.pod:2660
27628 " luks-format-cipher device keyslot cipher\n"
27634 #: ../fish/guestfish-actions.pod:2662
27636 "This command is the same as L</luks-format> but it also allows you to set "
27637 "the C<cipher> used."
27642 #: ../fish/guestfish-actions.pod:2671
27643 msgid "luks-kill-slot"
27648 #: ../fish/guestfish-actions.pod:2673
27651 " luks-kill-slot device keyslot\n"
27657 #: ../fish/guestfish-actions.pod:2682
27663 #: ../fish/guestfish-actions.pod:2684
27666 " luks-open device mapname\n"
27672 #: ../fish/guestfish-actions.pod:2698
27674 "If this block device contains LVM volume groups, then calling L</vgscan> "
27675 "followed by L</vg-activate-all> will make them visible."
27680 #: ../fish/guestfish-actions.pod:2705
27681 msgid "luks-open-ro"
27686 #: ../fish/guestfish-actions.pod:2707
27689 " luks-open-ro device mapname\n"
27695 #: ../fish/guestfish-actions.pod:2709
27697 "This is the same as L</luks-open> except that a read-only mapping is created."
27702 #: ../fish/guestfish-actions.pod:2715
27708 #: ../fish/guestfish-actions.pod:2717
27711 " lvcreate logvol volgroup mbytes\n"
27717 #: ../fish/guestfish-actions.pod:2722
27718 msgid "lvm-canonical-lv-name"
27723 #: ../fish/guestfish-actions.pod:2724
27726 " lvm-canonical-lv-name lvname\n"
27732 #: ../fish/guestfish-actions.pod:2733
27733 msgid "See also L</is-lv>."
27738 #: ../fish/guestfish-actions.pod:2735
27739 msgid "lvm-clear-filter"
27744 #: ../fish/guestfish-actions.pod:2737
27747 " lvm-clear-filter\n"
27753 #: ../fish/guestfish-actions.pod:2739
27755 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27761 #: ../fish/guestfish-actions.pod:2745
27762 msgid "lvm-remove-all"
27767 #: ../fish/guestfish-actions.pod:2747
27770 " lvm-remove-all\n"
27776 #: ../fish/guestfish-actions.pod:2755
27777 msgid "lvm-set-filter"
27782 #: ../fish/guestfish-actions.pod:2757
27785 " lvm-set-filter 'devices ...'\n"
27791 #: ../fish/guestfish-actions.pod:2782
27797 #: ../fish/guestfish-actions.pod:2784
27800 " lvremove device\n"
27806 #: ../fish/guestfish-actions.pod:2792
27812 #: ../fish/guestfish-actions.pod:2794
27815 " lvrename logvol newlogvol\n"
27821 #: ../fish/guestfish-actions.pod:2798
27827 #: ../fish/guestfish-actions.pod:2800
27830 " lvresize device mbytes\n"
27836 #: ../fish/guestfish-actions.pod:2806
27837 msgid "lvresize-free"
27842 #: ../fish/guestfish-actions.pod:2808
27845 " lvresize-free lv percent\n"
27851 #: ../fish/guestfish-actions.pod:2816
27857 #: ../fish/guestfish-actions.pod:2818
27866 #: ../fish/guestfish-actions.pod:2826
27867 msgid "See also L</lvs-full>, L</list-filesystems>."
27872 #: ../fish/guestfish-actions.pod:2828
27878 #: ../fish/guestfish-actions.pod:2830
27887 #: ../fish/guestfish-actions.pod:2835
27893 #: ../fish/guestfish-actions.pod:2837
27902 #: ../fish/guestfish-actions.pod:2841
27908 #: ../fish/guestfish-actions.pod:2843
27911 " lxattrlist path 'names ...'\n"
27917 #: ../fish/guestfish-actions.pod:2859
27919 "This call is intended for programs that want to efficiently list a directory "
27920 "contents without making many round-trips. See also L</lstatlist> for a "
27921 "similarly efficient call for getting standard stats. Very long directory "
27922 "listings might cause the protocol message size to be exceeded, causing this "
27923 "call to fail. The caller must split up such requests into smaller groups of "
27929 #: ../fish/guestfish-actions.pod:2867
27935 #: ../fish/guestfish-actions.pod:2869
27944 #: ../fish/guestfish-actions.pod:2873
27950 #: ../fish/guestfish-actions.pod:2875
27953 " mkdir-mode path mode\n"
27959 #: ../fish/guestfish-actions.pod:2884
27960 msgid "See also L</mkdir>, L</umask>"
27965 #: ../fish/guestfish-actions.pod:2886
27971 #: ../fish/guestfish-actions.pod:2888
27980 #: ../fish/guestfish-actions.pod:2893
27986 #: ../fish/guestfish-actions.pod:2895
27989 " mkdtemp template\n"
27995 #: ../fish/guestfish-actions.pod:2916
28001 #: ../fish/guestfish-actions.pod:2918
28004 " mke2fs-J fstype blocksize device journal\n"
28010 #: ../fish/guestfish-actions.pod:2926
28011 msgid "See also L</mke2journal>."
28016 #: ../fish/guestfish-actions.pod:2928
28022 #: ../fish/guestfish-actions.pod:2930
28025 " mke2fs-JL fstype blocksize device label\n"
28031 #: ../fish/guestfish-actions.pod:2935
28032 msgid "See also L</mke2journal-L>."
28037 #: ../fish/guestfish-actions.pod:2937
28043 #: ../fish/guestfish-actions.pod:2939
28046 " mke2fs-JU fstype blocksize device uuid\n"
28052 #: ../fish/guestfish-actions.pod:2944
28053 msgid "See also L</mke2journal-U>."
28058 #: ../fish/guestfish-actions.pod:2946
28059 msgid "mke2journal"
28064 #: ../fish/guestfish-actions.pod:2948
28067 " mke2journal blocksize device\n"
28073 #: ../fish/guestfish-actions.pod:2955
28074 msgid "mke2journal-L"
28079 #: ../fish/guestfish-actions.pod:2957
28082 " mke2journal-L blocksize label device\n"
28088 #: ../fish/guestfish-actions.pod:2961
28089 msgid "mke2journal-U"
28094 #: ../fish/guestfish-actions.pod:2963
28097 " mke2journal-U blocksize uuid device\n"
28103 #: ../fish/guestfish-actions.pod:2967
28109 #: ../fish/guestfish-actions.pod:2969
28112 " mkfifo mode path\n"
28118 #: ../fish/guestfish-actions.pod:2971
28120 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
28121 "is just a convenient wrapper around L</mknod>."
28126 #: ../fish/guestfish-actions.pod:2977
28132 #: ../fish/guestfish-actions.pod:2979
28135 " mkfs fstype device\n"
28141 #: ../fish/guestfish-actions.pod:2985
28147 #: ../fish/guestfish-actions.pod:2987
28150 " mkfs-b fstype blocksize device\n"
28156 #: ../fish/guestfish-actions.pod:2989
28158 "This call is similar to L</mkfs>, but it allows you to control the block "
28159 "size of the resulting filesystem. Supported block sizes depend on the "
28160 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28165 #: ../fish/guestfish-actions.pod:3004
28170 #: ../fish/guestfish-actions.pod:3006
28173 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28179 #: ../fish/guestfish-actions.pod:3041
28180 msgid "mkmountpoint"
28185 #: ../fish/guestfish-actions.pod:3043
28188 " mkmountpoint exemptpath\n"
28194 #: ../fish/guestfish-actions.pod:3045
28196 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28197 "to create extra mountpoints before mounting the first filesystem."
28202 #: ../fish/guestfish-actions.pod:3069
28204 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28205 "unexpected errors if you try to mix these calls. It is safest to manually "
28206 "unmount filesystems and remove mountpoints after use."
28211 #: ../fish/guestfish-actions.pod:3073
28213 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28214 "for this to work for manual mountpoints, you must ensure that the innermost "
28215 "mountpoints have the longest pathnames, as in the example code above."
28219 #: ../fish/guestfish-actions.pod:3080
28221 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28222 "L</umount-all> to be called when the handle is closed which can also trigger "
28228 #: ../fish/guestfish-actions.pod:3084
28234 #: ../fish/guestfish-actions.pod:3086
28237 " mknod mode devmajor devminor path\n"
28243 #: ../fish/guestfish-actions.pod:3096
28245 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28246 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28247 "regular file). These constants are available in the standard Linux header "
28248 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28249 "wrappers around this command which bitwise OR in the appropriate constant "
28255 #: ../fish/guestfish-actions.pod:3106
28261 #: ../fish/guestfish-actions.pod:3108
28264 " mknod-b mode devmajor devminor path\n"
28270 #: ../fish/guestfish-actions.pod:3110
28272 "This call creates a block device node called C<path> with mode C<mode> and "
28273 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28274 "wrapper around L</mknod>."
28279 #: ../fish/guestfish-actions.pod:3116
28285 #: ../fish/guestfish-actions.pod:3118
28288 " mknod-c mode devmajor devminor path\n"
28294 #: ../fish/guestfish-actions.pod:3120
28296 "This call creates a char device node called C<path> with mode C<mode> and "
28297 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28298 "wrapper around L</mknod>."
28303 #: ../fish/guestfish-actions.pod:3126
28309 #: ../fish/guestfish-actions.pod:3128
28318 #: ../fish/guestfish-actions.pod:3132
28324 #: ../fish/guestfish-actions.pod:3134
28327 " mkswap-L label device\n"
28333 #: ../fish/guestfish-actions.pod:3142
28339 #: ../fish/guestfish-actions.pod:3144
28342 " mkswap-U uuid device\n"
28348 #: ../fish/guestfish-actions.pod:3148
28349 msgid "mkswap-file"
28354 #: ../fish/guestfish-actions.pod:3150
28357 " mkswap-file path\n"
28363 #: ../fish/guestfish-actions.pod:3154
28365 "This command just writes a swap file signature to an existing file. To "
28366 "create the file itself, use something like L</fallocate>."
28371 #: ../fish/guestfish-actions.pod:3157
28377 #: ../fish/guestfish-actions.pod:3159
28380 " modprobe modulename\n"
28386 #: ../fish/guestfish-actions.pod:3166
28392 #: ../fish/guestfish-actions.pod:3168
28395 " mount device mountpoint\n"
28401 #: ../fish/guestfish-actions.pod:3184
28403 "B<Important note:> When you use this call, the filesystem options C<sync> "
28404 "and C<noatime> are set implicitly. This was originally done because we "
28405 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28406 "very large negative performance impact and negligible effect on "
28407 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28408 "code that needs performance, and instead use L</mount-options> (use an empty "
28409 "string for the first parameter if you don't want any options)."
28414 #: ../fish/guestfish-actions.pod:3194
28420 #: ../fish/guestfish-actions.pod:3196
28423 " mount-loop file mountpoint\n"
28429 #: ../fish/guestfish-actions.pod:3202
28430 msgid "mount-options"
28435 #: ../fish/guestfish-actions.pod:3204
28438 " mount-options options device mountpoint\n"
28444 #: ../fish/guestfish-actions.pod:3206
28446 "This is the same as the L</mount> command, but it allows you to set the "
28447 "mount options as for the L<mount(8)> I<-o> flag."
28452 #: ../fish/guestfish-actions.pod:3214
28458 #: ../fish/guestfish-actions.pod:3216
28461 " mount-ro device mountpoint\n"
28467 #: ../fish/guestfish-actions.pod:3218
28469 "This is the same as the L</mount> command, but it mounts the filesystem with "
28470 "the read-only (I<-o ro>) flag."
28475 #: ../fish/guestfish-actions.pod:3221
28481 #: ../fish/guestfish-actions.pod:3223
28484 " mount-vfs options vfstype device mountpoint\n"
28490 #: ../fish/guestfish-actions.pod:3225
28492 "This is the same as the L</mount> command, but it allows you to set both the "
28493 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28498 #: ../fish/guestfish-actions.pod:3229
28499 msgid "mountpoints"
28504 #: ../fish/guestfish-actions.pod:3231
28513 #: ../fish/guestfish-actions.pod:3233
28515 "This call is similar to L</mounts>. That call returns a list of devices. "
28516 "This one returns a hash table (map) of device name to directory where the "
28517 "device is mounted."
28522 #: ../fish/guestfish-actions.pod:3237
28528 #: ../fish/guestfish-actions.pod:3239
28537 #: ../fish/guestfish-actions.pod:3246
28538 msgid "See also: L</mountpoints>"
28543 #: ../fish/guestfish-actions.pod:3248
28549 #: ../fish/guestfish-actions.pod:3250
28558 #: ../fish/guestfish-actions.pod:3255
28559 msgid "ntfs-3g-probe"
28564 #: ../fish/guestfish-actions.pod:3257
28567 " ntfs-3g-probe true|false device\n"
28573 #: ../fish/guestfish-actions.pod:3271
28579 #: ../fish/guestfish-actions.pod:3273
28582 " ntfsresize device\n"
28588 #: ../fish/guestfish-actions.pod:3279
28589 msgid "ntfsresize-size"
28594 #: ../fish/guestfish-actions.pod:3281
28597 " ntfsresize-size device size\n"
28603 #: ../fish/guestfish-actions.pod:3283
28605 "This command is the same as L</ntfsresize> except that it allows you to "
28606 "specify the new size (in bytes) explicitly."
28611 #: ../fish/guestfish-actions.pod:3286
28617 #: ../fish/guestfish-actions.pod:3288
28620 " part-add device prlogex startsect endsect\n"
28626 #: ../fish/guestfish-actions.pod:3290
28628 "This command adds a partition to C<device>. If there is no partition table "
28629 "on the device, call L</part-init> first."
28634 #: ../fish/guestfish-actions.pod:3302
28636 "Creating a partition which covers the whole disk is not so easy. Use L</"
28637 "part-disk> to do that."
28642 #: ../fish/guestfish-actions.pod:3305
28648 #: ../fish/guestfish-actions.pod:3307
28651 " part-del device partnum\n"
28657 #: ../fish/guestfish-actions.pod:3315
28663 #: ../fish/guestfish-actions.pod:3317
28666 " part-disk device parttype\n"
28672 #: ../fish/guestfish-actions.pod:3319
28674 "This command is simply a combination of L</part-init> followed by L</part-"
28675 "add> to create a single primary partition covering the whole disk."
28680 #: ../fish/guestfish-actions.pod:3323
28682 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28683 "possible values are described in L</part-init>."
28688 #: ../fish/guestfish-actions.pod:3329
28689 msgid "part-get-bootable"
28694 #: ../fish/guestfish-actions.pod:3331
28697 " part-get-bootable device partnum\n"
28703 #: ../fish/guestfish-actions.pod:3336
28704 msgid "See also L</part-set-bootable>."
28709 #: ../fish/guestfish-actions.pod:3338
28710 msgid "part-get-mbr-id"
28715 #: ../fish/guestfish-actions.pod:3340
28718 " part-get-mbr-id device partnum\n"
28724 #: ../fish/guestfish-actions.pod:3345 ../fish/guestfish-actions.pod:3483
28726 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28727 "undefined results for other partition table types (see L</part-get-"
28733 #: ../fish/guestfish-actions.pod:3349
28734 msgid "part-get-parttype"
28739 #: ../fish/guestfish-actions.pod:3351
28742 " part-get-parttype device\n"
28748 #: ../fish/guestfish-actions.pod:3356
28750 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28751 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28752 "possible, although unusual. See L</part-init> for a full list."
28757 #: ../fish/guestfish-actions.pod:3361
28763 #: ../fish/guestfish-actions.pod:3363
28766 " part-init device parttype\n"
28772 #: ../fish/guestfish-actions.pod:3369
28774 "Initially there are no partitions. Following this, you should call L</part-"
28775 "add> for each partition required."
28780 #: ../fish/guestfish-actions.pod:3432
28786 #: ../fish/guestfish-actions.pod:3434
28789 " part-list device\n"
28795 #: ../fish/guestfish-actions.pod:3449
28797 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28798 "the device's sector size, see L</blockdev-getss>."
28803 #: ../fish/guestfish-actions.pod:3462
28804 msgid "part-set-bootable"
28809 #: ../fish/guestfish-actions.pod:3464
28812 " part-set-bootable device partnum true|false\n"
28818 #: ../fish/guestfish-actions.pod:3473
28819 msgid "part-set-mbr-id"
28824 #: ../fish/guestfish-actions.pod:3475
28827 " part-set-mbr-id device partnum idbyte\n"
28833 #: ../fish/guestfish-actions.pod:3487
28834 msgid "part-set-name"
28839 #: ../fish/guestfish-actions.pod:3489
28842 " part-set-name device partnum name\n"
28848 #: ../fish/guestfish-actions.pod:3497
28849 msgid "part-to-dev"
28854 #: ../fish/guestfish-actions.pod:3499
28857 " part-to-dev partition\n"
28863 #: ../fish/guestfish-actions.pod:3505
28865 "The named partition must exist, for example as a string returned from L</"
28866 "list-partitions>."
28871 #: ../fish/guestfish-actions.pod:3508
28872 msgid "ping-daemon"
28877 #: ../fish/guestfish-actions.pod:3510
28886 #: ../fish/guestfish-actions.pod:3517
28892 #: ../fish/guestfish-actions.pod:3519
28895 " pread path count offset\n"
28901 #: ../fish/guestfish-actions.pod:3527
28902 msgid "See also L</pwrite>, L</pread-device>."
28907 #: ../fish/guestfish-actions.pod:3532
28908 msgid "pread-device"
28913 #: ../fish/guestfish-actions.pod:3534
28916 " pread-device device count offset\n"
28922 #: ../fish/guestfish-actions.pod:3542
28923 msgid "See also L</pread>."
28928 #: ../fish/guestfish-actions.pod:3547
28934 #: ../fish/guestfish-actions.pod:3549
28937 " pvcreate device\n"
28943 #: ../fish/guestfish-actions.pod:3555
28949 #: ../fish/guestfish-actions.pod:3557
28952 " pvremove device\n"
28958 #: ../fish/guestfish-actions.pod:3566
28964 #: ../fish/guestfish-actions.pod:3568
28967 " pvresize device\n"
28973 #: ../fish/guestfish-actions.pod:3573
28974 msgid "pvresize-size"
28979 #: ../fish/guestfish-actions.pod:3575
28982 " pvresize-size device size\n"
28988 #: ../fish/guestfish-actions.pod:3577
28990 "This command is the same as L</pvresize> except that it allows you to "
28991 "specify the new size (in bytes) explicitly."
28996 #: ../fish/guestfish-actions.pod:3580
29002 #: ../fish/guestfish-actions.pod:3582
29011 #: ../fish/guestfish-actions.pod:3590
29012 msgid "See also L</pvs-full>."
29017 #: ../fish/guestfish-actions.pod:3592
29023 #: ../fish/guestfish-actions.pod:3594
29032 #: ../fish/guestfish-actions.pod:3599
29038 #: ../fish/guestfish-actions.pod:3601
29047 #: ../fish/guestfish-actions.pod:3605
29053 #: ../fish/guestfish-actions.pod:3607
29056 " pwrite path content offset\n"
29062 #: ../fish/guestfish-actions.pod:3618
29063 msgid "See also L</pread>, L</pwrite-device>."
29068 #: ../fish/guestfish-actions.pod:3623
29069 msgid "pwrite-device"
29074 #: ../fish/guestfish-actions.pod:3625
29077 " pwrite-device device content offset\n"
29083 #: ../fish/guestfish-actions.pod:3635
29084 msgid "See also L</pwrite>."
29089 #: ../fish/guestfish-actions.pod:3640
29095 #: ../fish/guestfish-actions.pod:3642
29098 " read-file path\n"
29104 #: ../fish/guestfish-actions.pod:3647
29106 "Unlike L</cat>, this function can correctly handle files that contain "
29107 "embedded ASCII NUL characters. However unlike L</download>, this function "
29108 "is limited in the total size of file that can be handled."
29113 #: ../fish/guestfish-actions.pod:3655
29119 #: ../fish/guestfish-actions.pod:3657
29122 " read-lines path\n"
29128 #: ../fish/guestfish-actions.pod:3664
29130 "Note that this function cannot correctly handle binary files (specifically, "
29131 "files containing C<\\0> character which is treated as end of line). For "
29132 "those you need to use the L</read-file> function which has a more complex "
29138 #: ../fish/guestfish-actions.pod:3669
29144 #: ../fish/guestfish-actions.pod:3671
29153 #: ../fish/guestfish-actions.pod:3723
29155 "This function is primarily intended for use by programs. To get a simple "
29156 "list of names, use L</ls>. To get a printable directory for human "
29157 "consumption, use L</ll>."
29162 #: ../fish/guestfish-actions.pod:3727
29168 #: ../fish/guestfish-actions.pod:3729
29177 #: ../fish/guestfish-actions.pod:3733
29178 msgid "readlinklist"
29183 #: ../fish/guestfish-actions.pod:3735
29186 " readlinklist path 'names ...'\n"
29192 #: ../fish/guestfish-actions.pod:3759
29198 #: ../fish/guestfish-actions.pod:3761
29207 #: ../fish/guestfish-actions.pod:3766
29208 msgid "removexattr"
29213 #: ../fish/guestfish-actions.pod:3768
29216 " removexattr xattr path\n"
29222 #: ../fish/guestfish-actions.pod:3773
29223 msgid "See also: L</lremovexattr>, L<attr(5)>."
29228 #: ../fish/guestfish-actions.pod:3775
29234 #: ../fish/guestfish-actions.pod:3777
29237 " resize2fs device\n"
29243 #: ../fish/guestfish-actions.pod:3782
29245 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29246 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29247 "gives an error about this and sometimes not. In any case, it is always safe "
29248 "to call L</e2fsck-f> before calling this function."
29252 #: ../fish/guestfish-actions.pod:3788
29253 msgid "resize2fs-M"
29257 #: ../fish/guestfish-actions.pod:3790
29260 " resize2fs-M device\n"
29265 #: ../fish/guestfish-actions.pod:3792
29267 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29268 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
29273 #: ../fish/guestfish-actions.pod:3796
29275 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29276 "and read the C<Block size> and C<Block count> values. These two numbers, "
29277 "multiplied together, give the resulting size of the minimal filesystem in "
29283 #: ../fish/guestfish-actions.pod:3801
29284 msgid "resize2fs-size"
29289 #: ../fish/guestfish-actions.pod:3803
29292 " resize2fs-size device size\n"
29298 #: ../fish/guestfish-actions.pod:3805
29300 "This command is the same as L</resize2fs> except that it allows you to "
29301 "specify the new size (in bytes) explicitly."
29306 #: ../fish/guestfish-actions.pod:3808
29312 #: ../fish/guestfish-actions.pod:3810
29321 #: ../fish/guestfish-actions.pod:3814
29327 #: ../fish/guestfish-actions.pod:3816
29336 #: ../fish/guestfish-actions.pod:3822
29342 #: ../fish/guestfish-actions.pod:3824
29351 #: ../fish/guestfish-actions.pod:3828
29352 msgid "rmmountpoint"
29357 #: ../fish/guestfish-actions.pod:3830
29360 " rmmountpoint exemptpath\n"
29366 #: ../fish/guestfish-actions.pod:3832
29368 "This calls removes a mountpoint that was previously created with L</"
29369 "mkmountpoint>. See L</mkmountpoint> for full details."
29374 #: ../fish/guestfish-actions.pod:3836
29375 msgid "scrub-device"
29380 #: ../fish/guestfish-actions.pod:3838
29383 " scrub-device device\n"
29389 #: ../fish/guestfish-actions.pod:3849
29395 #: ../fish/guestfish-actions.pod:3851
29398 " scrub-file file\n"
29404 #: ../fish/guestfish-actions.pod:3861
29405 msgid "scrub-freespace"
29410 #: ../fish/guestfish-actions.pod:3863
29413 " scrub-freespace dir\n"
29419 #: ../fish/guestfish-actions.pod:3865
29421 "This command creates the directory C<dir> and then fills it with files until "
29422 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29423 "deletes them. The intention is to scrub any free space on the partition "
29424 "containing C<dir>."
29429 #: ../fish/guestfish-actions.pod:3874
29435 #: ../fish/guestfish-actions.pod:3876
29441 #: ../fish/guestfish-actions.pod:3878
29444 " set-append append\n"
29449 #: ../fish/guestfish-actions.pod:3889
29450 msgid "set-attach-method"
29454 #: ../fish/guestfish-actions.pod:3891
29455 msgid "attach-method"
29459 #: ../fish/guestfish-actions.pod:3893
29462 " set-attach-method attachmethod\n"
29468 #: ../fish/guestfish-actions.pod:3915
29469 msgid "set-autosync"
29474 #: ../fish/guestfish-actions.pod:3917
29480 #: ../fish/guestfish-actions.pod:3919
29483 " set-autosync true|false\n"
29489 #: ../fish/guestfish-actions.pod:3929
29495 #: ../fish/guestfish-actions.pod:3931
29501 #: ../fish/guestfish-actions.pod:3933
29504 " set-direct true|false\n"
29510 #: ../fish/guestfish-actions.pod:3939
29512 "One consequence of this is that log messages aren't caught by the library "
29513 "and handled by L</set-log-message-callback>, but go straight to stdout."
29518 #: ../fish/guestfish-actions.pod:3948
29519 msgid "set-e2label"
29524 #: ../fish/guestfish-actions.pod:3950
29527 " set-e2label device label\n"
29533 #: ../fish/guestfish-actions.pod:3956
29535 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29536 "label on a filesystem."
29541 #: ../fish/guestfish-actions.pod:3959
29547 #: ../fish/guestfish-actions.pod:3961
29550 " set-e2uuid device uuid\n"
29556 #: ../fish/guestfish-actions.pod:3968
29558 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29559 "UUID of a filesystem."
29564 #: ../fish/guestfish-actions.pod:3971
29565 msgid "set-memsize"
29570 #: ../fish/guestfish-actions.pod:3973
29576 #: ../fish/guestfish-actions.pod:3975
29579 " set-memsize memsize\n"
29585 #: ../fish/guestfish-actions.pod:3977
29587 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29588 "This only has any effect if called before L</launch>."
29593 #: ../fish/guestfish-actions.pod:3988
29594 msgid "set-network"
29599 #: ../fish/guestfish-actions.pod:3990
29605 #: ../fish/guestfish-actions.pod:3992
29608 " set-network true|false\n"
29614 #: ../fish/guestfish-actions.pod:4000
29616 "You must call this before calling L</launch>, otherwise it has no effect."
29621 #: ../fish/guestfish-actions.pod:4003
29627 #: ../fish/guestfish-actions.pod:4005
29633 #: ../fish/guestfish-actions.pod:4007
29636 " set-path searchpath\n"
29642 #: ../fish/guestfish-actions.pod:4016
29648 #: ../fish/guestfish-actions.pod:4018
29654 #: ../fish/guestfish-actions.pod:4020
29663 #: ../fish/guestfish-actions.pod:4040
29664 msgid "set-recovery-proc"
29669 #: ../fish/guestfish-actions.pod:4042
29670 msgid "recovery-proc"
29675 #: ../fish/guestfish-actions.pod:4044
29678 " set-recovery-proc true|false\n"
29684 #: ../fish/guestfish-actions.pod:4046
29686 "If this is called with the parameter C<false> then L</launch> does not "
29687 "create a recovery process. The purpose of the recovery process is to stop "
29688 "runaway qemu processes in the case where the main program aborts abruptly."
29693 #: ../fish/guestfish-actions.pod:4051
29695 "This only has any effect if called before L</launch>, and the default is "
29701 #: ../fish/guestfish-actions.pod:4060
29702 msgid "set-selinux"
29707 #: ../fish/guestfish-actions.pod:4062
29713 #: ../fish/guestfish-actions.pod:4064
29716 " set-selinux true|false\n"
29722 #: ../fish/guestfish-actions.pod:4075
29728 #: ../fish/guestfish-actions.pod:4077
29734 #: ../fish/guestfish-actions.pod:4079
29737 " set-trace true|false\n"
29742 #: ../fish/guestfish-actions.pod:4091
29744 "Trace messages are normally sent to C<stderr>, unless you register a "
29745 "callback to send them somewhere else (see L</set-event-callback>)."
29750 #: ../fish/guestfish-actions.pod:4095
29751 msgid "set-verbose"
29756 #: ../fish/guestfish-actions.pod:4097
29762 #: ../fish/guestfish-actions.pod:4099
29765 " set-verbose true|false\n"
29770 #: ../fish/guestfish-actions.pod:4106
29772 "Verbose messages are normally sent to C<stderr>, unless you register a "
29773 "callback to send them somewhere else (see L</set-event-callback>)."
29778 #: ../fish/guestfish-actions.pod:4110
29784 #: ../fish/guestfish-actions.pod:4112
29787 " setcon context\n"
29793 #: ../fish/guestfish-actions.pod:4119
29799 #: ../fish/guestfish-actions.pod:4121
29802 " setxattr xattr val vallen path\n"
29808 #: ../fish/guestfish-actions.pod:4127
29809 msgid "See also: L</lsetxattr>, L<attr(5)>."
29814 #: ../fish/guestfish-actions.pod:4129
29820 #: ../fish/guestfish-actions.pod:4131
29823 " sfdisk device cyls heads sectors 'lines ...'\n"
29829 #: ../fish/guestfish-actions.pod:4153
29830 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
29835 #: ../fish/guestfish-actions.pod:4159
29841 #: ../fish/guestfish-actions.pod:4161
29844 " sfdiskM device 'lines ...'\n"
29850 #: ../fish/guestfish-actions.pod:4163
29852 "This is a simplified interface to the L</sfdisk> command, where partition "
29853 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
29854 "you don't need to specify the cyls, heads and sectors parameters which were "
29855 "rarely if ever used anyway."
29860 #: ../fish/guestfish-actions.pod:4169
29861 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
29866 #: ../fish/guestfish-actions.pod:4175
29872 #: ../fish/guestfish-actions.pod:4177
29875 " sfdisk-N device partnum cyls heads sectors line\n"
29881 #: ../fish/guestfish-actions.pod:4182
29883 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
29884 "cyls/heads/sectors parameters."
29889 #: ../fish/guestfish-actions.pod:4185
29890 msgid "See also: L</part-add>"
29895 #: ../fish/guestfish-actions.pod:4190
29896 msgid "sfdisk-disk-geometry"
29901 #: ../fish/guestfish-actions.pod:4192
29904 " sfdisk-disk-geometry device\n"
29910 #: ../fish/guestfish-actions.pod:4194
29912 "This displays the disk geometry of C<device> read from the partition table. "
29913 "Especially in the case where the underlying block device has been resized, "
29914 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
29915 "kernel-geometry>)."
29920 #: ../fish/guestfish-actions.pod:4202
29921 msgid "sfdisk-kernel-geometry"
29926 #: ../fish/guestfish-actions.pod:4204
29929 " sfdisk-kernel-geometry device\n"
29935 #: ../fish/guestfish-actions.pod:4211
29941 #: ../fish/guestfish-actions.pod:4213
29944 " sfdisk-l device\n"
29950 #: ../fish/guestfish-actions.pod:4219
29951 msgid "See also: L</part-list>"
29956 #: ../fish/guestfish-actions.pod:4221
29962 #: ../fish/guestfish-actions.pod:4223
29971 #: ../fish/guestfish-actions.pod:4228
29972 msgid "This is like L</command>, but passes the command to:"
29977 #: ../fish/guestfish-actions.pod:4236
29978 msgid "All the provisos about L</command> apply to this call."
29983 #: ../fish/guestfish-actions.pod:4238
29989 #: ../fish/guestfish-actions.pod:4240
29992 " sh-lines command\n"
29998 #: ../fish/guestfish-actions.pod:4242
29999 msgid "This is the same as L</sh>, but splits the result into a list of lines."
30004 #: ../fish/guestfish-actions.pod:4245
30005 msgid "See also: L</command-lines>"
30010 #: ../fish/guestfish-actions.pod:4247
30016 #: ../fish/guestfish-actions.pod:4249
30025 #: ../fish/guestfish-actions.pod:4253
30031 #: ../fish/guestfish-actions.pod:4255
30040 #: ../fish/guestfish-actions.pod:4261
30046 #: ../fish/guestfish-actions.pod:4263
30055 #: ../fish/guestfish-actions.pod:4271
30061 #: ../fish/guestfish-actions.pod:4273
30070 #: ../fish/guestfish-actions.pod:4281
30076 #: ../fish/guestfish-actions.pod:4283
30079 " strings-e encoding path\n"
30085 #: ../fish/guestfish-actions.pod:4285
30087 "This is like the L</strings> command, but allows you to specify the encoding "
30088 "of strings that are looked for in the source file C<path>."
30093 #: ../fish/guestfish-actions.pod:4295
30095 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
30096 "ISO-8859-X (this is what L</strings> uses)."
30101 #: ../fish/guestfish-actions.pod:4327
30102 msgid "swapoff-device"
30107 #: ../fish/guestfish-actions.pod:4329
30110 " swapoff-device device\n"
30116 #: ../fish/guestfish-actions.pod:4331
30118 "This command disables the libguestfs appliance swap device or partition "
30119 "named C<device>. See L</swapon-device>."
30124 #: ../fish/guestfish-actions.pod:4335
30125 msgid "swapoff-file"
30130 #: ../fish/guestfish-actions.pod:4337
30133 " swapoff-file file\n"
30139 #: ../fish/guestfish-actions.pod:4341
30140 msgid "swapoff-label"
30145 #: ../fish/guestfish-actions.pod:4343
30148 " swapoff-label label\n"
30154 #: ../fish/guestfish-actions.pod:4348
30155 msgid "swapoff-uuid"
30160 #: ../fish/guestfish-actions.pod:4350
30163 " swapoff-uuid uuid\n"
30169 #: ../fish/guestfish-actions.pod:4355
30170 msgid "swapon-device"
30175 #: ../fish/guestfish-actions.pod:4357
30178 " swapon-device device\n"
30184 #: ../fish/guestfish-actions.pod:4359
30186 "This command enables the libguestfs appliance to use the swap device or "
30187 "partition named C<device>. The increased memory is made available for all "
30188 "commands, for example those run using L</command> or L</sh>."
30193 #: ../fish/guestfish-actions.pod:4371
30194 msgid "swapon-file"
30199 #: ../fish/guestfish-actions.pod:4373
30202 " swapon-file file\n"
30208 #: ../fish/guestfish-actions.pod:4375
30210 "This command enables swap to a file. See L</swapon-device> for other notes."
30215 #: ../fish/guestfish-actions.pod:4378
30216 msgid "swapon-label"
30221 #: ../fish/guestfish-actions.pod:4380
30224 " swapon-label label\n"
30230 #: ../fish/guestfish-actions.pod:4382
30232 "This command enables swap to a labeled swap partition. See L</swapon-"
30233 "device> for other notes."
30238 #: ../fish/guestfish-actions.pod:4385
30239 msgid "swapon-uuid"
30244 #: ../fish/guestfish-actions.pod:4387
30247 " swapon-uuid uuid\n"
30253 #: ../fish/guestfish-actions.pod:4389
30255 "This command enables swap to a swap partition with the given UUID. See L</"
30256 "swapon-device> for other notes."
30261 #: ../fish/guestfish-actions.pod:4392
30267 #: ../fish/guestfish-actions.pod:4394
30276 #: ../fish/guestfish-actions.pod:4402
30282 #: ../fish/guestfish-actions.pod:4404
30291 #: ../fish/guestfish-actions.pod:4412
30297 #: ../fish/guestfish-actions.pod:4414
30300 " tail-n nrlines path\n"
30306 #: ../fish/guestfish-actions.pod:4427
30312 #: ../fish/guestfish-actions.pod:4429
30315 " tar-in (tarfile|-) directory\n"
30321 #: ../fish/guestfish-actions.pod:4434
30322 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30327 #: ../fish/guestfish-actions.pod:4439
30333 #: ../fish/guestfish-actions.pod:4441
30336 " tar-out directory (tarfile|-)\n"
30342 #: ../fish/guestfish-actions.pod:4446
30343 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30348 #: ../fish/guestfish-actions.pod:4451
30354 #: ../fish/guestfish-actions.pod:4453
30357 " tgz-in (tarball|-) directory\n"
30363 #: ../fish/guestfish-actions.pod:4458
30364 msgid "To upload an uncompressed tarball, use L</tar-in>."
30369 #: ../fish/guestfish-actions.pod:4462
30375 #: ../fish/guestfish-actions.pod:4464
30378 " tgz-out directory (tarball|-)\n"
30384 #: ../fish/guestfish-actions.pod:4469
30385 msgid "To download an uncompressed tarball, use L</tar-out>."
30390 #: ../fish/guestfish-actions.pod:4473
30396 #: ../fish/guestfish-actions.pod:4475
30405 #: ../fish/guestfish-actions.pod:4484
30411 #: ../fish/guestfish-actions.pod:4486
30420 #: ../fish/guestfish-actions.pod:4491
30421 msgid "truncate-size"
30426 #: ../fish/guestfish-actions.pod:4493
30429 " truncate-size path size\n"
30435 #: ../fish/guestfish-actions.pod:4498
30437 "If the current file size is less than C<size> then the file is extended to "
30438 "the required size with zero bytes. This creates a sparse file (ie. disk "
30439 "blocks are not allocated for the file until you write to it). To create a "
30440 "non-sparse file of zeroes, use L</fallocate64> instead."
30445 #: ../fish/guestfish-actions.pod:4504
30451 #: ../fish/guestfish-actions.pod:4506
30454 " tune2fs-l device\n"
30460 #: ../fish/guestfish-actions.pod:4516
30466 #: ../fish/guestfish-actions.pod:4518
30469 " txz-in (tarball|-) directory\n"
30475 #: ../fish/guestfish-actions.pod:4525
30481 #: ../fish/guestfish-actions.pod:4527
30484 " txz-out directory (tarball|-)\n"
30490 #: ../fish/guestfish-actions.pod:4534
30496 #: ../fish/guestfish-actions.pod:4536
30505 #: ../fish/guestfish-actions.pod:4550
30506 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30511 #: ../fish/guestfish-actions.pod:4555
30517 #: ../fish/guestfish-actions.pod:4557
30523 #: ../fish/guestfish-actions.pod:4559
30526 " umount pathordevice\n"
30532 #: ../fish/guestfish-actions.pod:4565
30538 #: ../fish/guestfish-actions.pod:4567
30539 msgid "unmount-all"
30544 #: ../fish/guestfish-actions.pod:4569
30553 #: ../fish/guestfish-actions.pod:4575
30559 #: ../fish/guestfish-actions.pod:4577
30562 " upload (filename|-) remotefilename\n"
30568 #: ../fish/guestfish-actions.pod:4584
30569 msgid "See also L</download>."
30574 #: ../fish/guestfish-actions.pod:4588
30575 msgid "upload-offset"
30580 #: ../fish/guestfish-actions.pod:4590
30583 " upload-offset (filename|-) remotefilename offset\n"
30589 #: ../fish/guestfish-actions.pod:4602
30591 "Note that there is no limit on the amount of data that can be uploaded with "
30592 "this call, unlike with L</pwrite>, and this call always writes the full "
30593 "amount unless an error occurs."
30598 #: ../fish/guestfish-actions.pod:4607
30599 msgid "See also L</upload>, L</pwrite>."
30604 #: ../fish/guestfish-actions.pod:4611
30610 #: ../fish/guestfish-actions.pod:4613
30613 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30619 #: ../fish/guestfish-actions.pod:4632
30625 #: ../fish/guestfish-actions.pod:4634
30634 #: ../fish/guestfish-actions.pod:4661
30636 "I<Note:> Don't use this call to test for availability of features. In "
30637 "enterprise distributions we backport features from later versions into "
30638 "earlier versions, making this an unreliable way to test for features. Use "
30639 "L</available> instead."
30644 #: ../fish/guestfish-actions.pod:4667
30650 #: ../fish/guestfish-actions.pod:4669
30653 " vfs-label device\n"
30659 #: ../fish/guestfish-actions.pod:4676
30660 msgid "To find a filesystem from the label, use L</findfs-label>."
30665 #: ../fish/guestfish-actions.pod:4678
30671 #: ../fish/guestfish-actions.pod:4680
30674 " vfs-type device\n"
30680 #: ../fish/guestfish-actions.pod:4690
30686 #: ../fish/guestfish-actions.pod:4692
30689 " vfs-uuid device\n"
30695 #: ../fish/guestfish-actions.pod:4699
30696 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30701 #: ../fish/guestfish-actions.pod:4701
30702 msgid "vg-activate"
30707 #: ../fish/guestfish-actions.pod:4703
30710 " vg-activate true|false 'volgroups ...'\n"
30716 #: ../fish/guestfish-actions.pod:4716
30717 msgid "vg-activate-all"
30722 #: ../fish/guestfish-actions.pod:4718
30725 " vg-activate-all true|false\n"
30731 #: ../fish/guestfish-actions.pod:4728
30737 #: ../fish/guestfish-actions.pod:4730
30740 " vgcreate volgroup 'physvols ...'\n"
30746 #: ../fish/guestfish-actions.pod:4735
30752 #: ../fish/guestfish-actions.pod:4737
30755 " vglvuuids vgname\n"
30761 #: ../fish/guestfish-actions.pod:4742
30763 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30764 "logical volumes and volume groups."
30769 #: ../fish/guestfish-actions.pod:4745
30770 msgid "See also L</vgpvuuids>."
30775 #: ../fish/guestfish-actions.pod:4747
30781 #: ../fish/guestfish-actions.pod:4749
30784 " vgpvuuids vgname\n"
30790 #: ../fish/guestfish-actions.pod:4754
30792 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30793 "physical volumes and volume groups."
30798 #: ../fish/guestfish-actions.pod:4757
30799 msgid "See also L</vglvuuids>."
30804 #: ../fish/guestfish-actions.pod:4759
30810 #: ../fish/guestfish-actions.pod:4761
30813 " vgremove vgname\n"
30819 #: ../fish/guestfish-actions.pod:4768
30825 #: ../fish/guestfish-actions.pod:4770
30828 " vgrename volgroup newvolgroup\n"
30834 #: ../fish/guestfish-actions.pod:4774
30840 #: ../fish/guestfish-actions.pod:4776
30849 #: ../fish/guestfish-actions.pod:4784
30850 msgid "See also L</vgs-full>."
30855 #: ../fish/guestfish-actions.pod:4786
30861 #: ../fish/guestfish-actions.pod:4788
30870 #: ../fish/guestfish-actions.pod:4793
30876 #: ../fish/guestfish-actions.pod:4795
30885 #: ../fish/guestfish-actions.pod:4800
30891 #: ../fish/guestfish-actions.pod:4802
30900 #: ../fish/guestfish-actions.pod:4806
30906 #: ../fish/guestfish-actions.pod:4808
30915 #: ../fish/guestfish-actions.pod:4813
30921 #: ../fish/guestfish-actions.pod:4815
30930 #: ../fish/guestfish-actions.pod:4820
30936 #: ../fish/guestfish-actions.pod:4822
30945 #: ../fish/guestfish-actions.pod:4827
30951 #: ../fish/guestfish-actions.pod:4829
30954 " write path content\n"
30960 #: ../fish/guestfish-actions.pod:4837
30966 #: ../fish/guestfish-actions.pod:4839
30969 " write-file path content size\n"
30975 #: ../fish/guestfish-actions.pod:4862
30981 #: ../fish/guestfish-actions.pod:4864
30984 " zegrep regex path\n"
30990 #: ../fish/guestfish-actions.pod:4872
30996 #: ../fish/guestfish-actions.pod:4874
30999 " zegrepi regex path\n"
31005 #: ../fish/guestfish-actions.pod:4882
31011 #: ../fish/guestfish-actions.pod:4884
31020 #: ../fish/guestfish-actions.pod:4892
31021 msgid "See also: L</zero-device>, L</scrub-device>."
31026 #: ../fish/guestfish-actions.pod:4894
31027 msgid "zero-device"
31032 #: ../fish/guestfish-actions.pod:4896
31035 " zero-device device\n"
31041 #: ../fish/guestfish-actions.pod:4898
31043 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
31044 "which just zeroes the first few blocks of a device."
31049 #: ../fish/guestfish-actions.pod:4905
31055 #: ../fish/guestfish-actions.pod:4907
31058 " zerofree device\n"
31064 #: ../fish/guestfish-actions.pod:4920
31070 #: ../fish/guestfish-actions.pod:4922
31073 " zfgrep pattern path\n"
31079 #: ../fish/guestfish-actions.pod:4930
31085 #: ../fish/guestfish-actions.pod:4932
31088 " zfgrepi pattern path\n"
31094 #: ../fish/guestfish-actions.pod:4940
31100 #: ../fish/guestfish-actions.pod:4942
31103 " zfile meth path\n"
31109 #: ../fish/guestfish-actions.pod:4949
31111 "Since 1.0.63, use L</file> instead which can now process compressed files."
31116 #: ../fish/guestfish-actions.pod:4959
31122 #: ../fish/guestfish-actions.pod:4961
31125 " zgrep regex path\n"
31131 #: ../fish/guestfish-actions.pod:4969
31137 #: ../fish/guestfish-actions.pod:4971
31140 " zgrepi regex path\n"
31146 #: ../fish/guestfish-commands.pod:1
31152 #: ../fish/guestfish-commands.pod:3
31158 #: ../fish/guestfish-commands.pod:5
31161 " alloc filename size\n"
31167 #: ../fish/guestfish-commands.pod:7
31169 "This creates an empty (zeroed) file of the given size, and then adds so it "
31170 "can be further examined."
31175 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31176 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31181 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31182 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31187 #: ../fish/guestfish-commands.pod:14
31189 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31190 "image, see L</PREPARED DISK IMAGES>."
31195 #: ../fish/guestfish-commands.pod:17
31201 #: ../fish/guestfish-commands.pod:19
31204 " copy-in local [local ...] /remotedir\n"
31210 #: ../fish/guestfish-commands.pod:21
31212 "C<copy-in> copies local files or directories recursively into the disk "
31213 "image, placing them in the directory called C</remotedir> (which must "
31214 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31215 "other commands as necessary."
31220 #: ../fish/guestfish-commands.pod:26
31222 "Multiple local files and directories can be specified, but the last "
31223 "parameter must always be a remote directory. Wildcards cannot be used."
31228 #: ../fish/guestfish-commands.pod:30
31234 #: ../fish/guestfish-commands.pod:32
31237 " copy-out remote [remote ...] localdir\n"
31243 #: ../fish/guestfish-commands.pod:34
31245 "C<copy-out> copies remote files or directories recursively out of the disk "
31246 "image, placing them on the host disk in a local directory called C<localdir> "
31247 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31248 "download>, L</tar-out> and other commands as necessary."
31253 #: ../fish/guestfish-commands.pod:40
31255 "Multiple remote files and directories can be specified, but the last "
31256 "parameter must always be a local directory. To download to the current "
31257 "directory, use C<.> as in:"
31262 #: ../fish/guestfish-commands.pod:44
31265 " copy-out /home .\n"
31271 #: ../fish/guestfish-commands.pod:46
31273 "Wildcards cannot be used in the ordinary command, but you can use them with "
31274 "the help of L</glob> like this:"
31279 #: ../fish/guestfish-commands.pod:49
31282 " glob copy-out /home/* .\n"
31288 #: ../fish/guestfish-commands.pod:51
31294 #: ../fish/guestfish-commands.pod:53
31297 " echo [params ...]\n"
31303 #: ../fish/guestfish-commands.pod:55
31304 msgid "This echos the parameters to the terminal."
31309 #: ../fish/guestfish-commands.pod:57
31315 #: ../fish/guestfish-commands.pod:59
31321 #: ../fish/guestfish-commands.pod:61
31327 #: ../fish/guestfish-commands.pod:63
31336 #: ../fish/guestfish-commands.pod:65
31338 "This is used to edit a file. It downloads the file, edits it locally using "
31339 "your editor, then uploads the result."
31344 #: ../fish/guestfish-commands.pod:68
31346 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31347 "or C<emacs> you will get those corresponding editors."
31352 #: ../fish/guestfish-commands.pod:72
31358 #: ../fish/guestfish-commands.pod:74
31361 " glob command args...\n"
31367 #: ../fish/guestfish-commands.pod:76
31369 "Expand wildcards in any paths in the args list, and run C<command> "
31370 "repeatedly on each matching path."
31375 #: ../fish/guestfish-commands.pod:79
31376 msgid "See L</WILDCARDS AND GLOBBING>."
31381 #: ../fish/guestfish-commands.pod:81
31387 #: ../fish/guestfish-commands.pod:83
31390 " hexedit <filename|device>\n"
31391 " hexedit <filename|device> <max>\n"
31392 " hexedit <filename|device> <start> <max>\n"
31398 #: ../fish/guestfish-commands.pod:87
31400 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31406 #: ../fish/guestfish-commands.pod:90
31408 "This command works by downloading potentially the whole file or device, "
31409 "editing it locally, then uploading it. If the file or device is large, you "
31410 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31411 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31412 "usual modifiers allowed such as C<1M> (1 megabyte)."
31417 #: ../fish/guestfish-commands.pod:97
31418 msgid "For example to edit the first few sectors of a disk you might do:"
31423 #: ../fish/guestfish-commands.pod:100
31426 " hexedit /dev/sda 1M\n"
31432 #: ../fish/guestfish-commands.pod:102
31434 "which would allow you to edit anywhere within the first megabyte of the disk."
31439 #: ../fish/guestfish-commands.pod:105
31440 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31445 #: ../fish/guestfish-commands.pod:107
31448 " hexedit /dev/sda1 0x400 0x400\n"
31454 #: ../fish/guestfish-commands.pod:109
31455 msgid "(assuming the superblock is in the standard location)."
31460 #: ../fish/guestfish-commands.pod:111
31462 "This command requires the external L<hexedit(1)> program. You can specify "
31463 "another program to use by setting the C<HEXEDITOR> environment variable."
31468 #: ../fish/guestfish-commands.pod:115
31469 msgid "See also L</hexdump>."
31474 #: ../fish/guestfish-commands.pod:117
31480 #: ../fish/guestfish-commands.pod:119
31489 #: ../fish/guestfish-commands.pod:121
31491 "Change the local directory, ie. the current directory of guestfish itself."
31496 #: ../fish/guestfish-commands.pod:124
31497 msgid "Note that C<!cd> won't do what you might expect."
31502 #: ../fish/guestfish-commands.pod:126
31508 #: ../fish/guestfish-commands.pod:128
31514 #: ../fish/guestfish-commands.pod:130
31523 #: ../fish/guestfish-commands.pod:132
31524 msgid "Opens the manual page for guestfish."
31529 #: ../fish/guestfish-commands.pod:134
31535 #: ../fish/guestfish-commands.pod:136
31541 #: ../fish/guestfish-commands.pod:138
31550 #: ../fish/guestfish-commands.pod:140
31559 #: ../fish/guestfish-commands.pod:142
31560 msgid "This is used to view a file."
31565 #: ../fish/guestfish-commands.pod:144
31567 "The default viewer is C<$PAGER>. However if you use the alternate command "
31568 "C<less> you will get the C<less> command specifically."
31573 #: ../fish/guestfish-commands.pod:147
31579 #: ../fish/guestfish-commands.pod:149
31588 #: ../fish/guestfish-commands.pod:151
31590 "Close and reopen the libguestfs handle. It is not necessary to use this "
31591 "normally, because the handle is closed properly when guestfish exits. "
31592 "However this is occasionally useful for testing."
31597 #: ../fish/guestfish-commands.pod:155
31603 #: ../fish/guestfish-commands.pod:157
31606 " sparse filename size\n"
31612 #: ../fish/guestfish-commands.pod:159
31614 "This creates an empty sparse file of the given size, and then adds so it can "
31615 "be further examined."
31620 #: ../fish/guestfish-commands.pod:162
31622 "In all respects it works the same as the L</alloc> command, except that the "
31623 "image file is allocated sparsely, which means that disk blocks are not "
31624 "assigned to the file until they are needed. Sparse disk files only use "
31625 "space when written to, but they are slower and there is a danger you could "
31626 "run out of real disk space during a write operation."
31631 #: ../fish/guestfish-commands.pod:172
31637 #: ../fish/guestfish-commands.pod:174
31646 #: ../fish/guestfish-commands.pod:176
31648 "This command returns a list of the optional groups known to the daemon, and "
31649 "indicates which ones are supported by this build of the libguestfs appliance."
31654 #: ../fish/guestfish-commands.pod:180
31655 msgid "See also L<guestfs(3)/AVAILABILITY>."
31660 #: ../fish/guestfish-commands.pod:182
31666 #: ../fish/guestfish-commands.pod:184
31669 " time command args...\n"
31675 #: ../fish/guestfish-commands.pod:186
31677 "Run the command as usual, but print the elapsed time afterwards. This can "
31678 "be useful for benchmarking operations."
31683 #: ../test-tool/libguestfs-test-tool.pod:5
31684 msgid "libguestfs-test-tool - End user tests for libguestfs"
31689 #: ../test-tool/libguestfs-test-tool.pod:9
31692 " libguestfs-test-tool [--options]\n"
31698 #: ../test-tool/libguestfs-test-tool.pod:13
31700 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31701 "and developers, to allow them to check basic libguestfs functionality is "
31702 "working. This is needed because libguestfs occasionally breaks for reasons "
31703 "beyond our control: usually because of changes in the underlying qemu or "
31704 "kernel packages, or the host environment."
31709 #: ../test-tool/libguestfs-test-tool.pod:20
31710 msgid "If you suspect a problem in libguestfs, then just run:"
31715 #: ../test-tool/libguestfs-test-tool.pod:22
31718 " libguestfs-test-tool\n"
31724 #: ../test-tool/libguestfs-test-tool.pod:24
31725 msgid "It will print lots of diagnostic messages."
31730 #: ../test-tool/libguestfs-test-tool.pod:26
31731 msgid "If it runs to completion successfully, you will see this near the end:"
31736 #: ../test-tool/libguestfs-test-tool.pod:28
31739 " ===== TEST FINISHED OK =====\n"
31745 #: ../test-tool/libguestfs-test-tool.pod:30
31746 msgid "and the test tool will exit with code 0."
31751 #: ../test-tool/libguestfs-test-tool.pod:32
31753 "If it fails (and/or exits with non-zero error code), please paste the "
31754 "B<complete, unedited> output of the test tool into a bug report. More "
31755 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31761 #: ../test-tool/libguestfs-test-tool.pod:41
31767 #: ../test-tool/libguestfs-test-tool.pod:43
31768 msgid "Display short usage information and exit."
31773 #: ../test-tool/libguestfs-test-tool.pod:45
31774 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
31779 #: ../test-tool/libguestfs-test-tool.pod:47
31781 "Pass an alternate name for the helper program. libguestfs-test-tool will "
31782 "normally look in the C<$libexec> directory that was configured when the tool "
31788 #: ../test-tool/libguestfs-test-tool.pod:51
31789 msgid "I<--qemu qemu_binary>"
31794 #: ../test-tool/libguestfs-test-tool.pod:53
31796 "If you have downloaded another qemu binary, point this option at the full "
31797 "path of the binary to try it."
31802 #: ../test-tool/libguestfs-test-tool.pod:56
31803 msgid "I<--qemudir qemu_source_dir>"
31808 #: ../test-tool/libguestfs-test-tool.pod:58
31810 "If you have compiled qemu from source, point this option at the source "
31811 "directory to try it."
31816 #: ../test-tool/libguestfs-test-tool.pod:61
31817 msgid "I<--timeout N>"
31822 #: ../test-tool/libguestfs-test-tool.pod:63
31824 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31825 "does not usually need to be adjusted unless your machine is very slow."
31830 #: ../test-tool/libguestfs-test-tool.pod:69
31831 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31836 #: ../test-tool/libguestfs-test-tool.pod:71
31838 "If you have compiled another version of qemu from source and would like to "
31839 "try that, then you can use the I<--qemudir> option to point to the qemu "
31840 "source directory."
31845 #: ../test-tool/libguestfs-test-tool.pod:75
31847 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
31848 "option to point to the binary."
31853 #: ../test-tool/libguestfs-test-tool.pod:78
31855 "When using an alternate qemu with libguestfs, usually you would need to "
31856 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
31857 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
31858 "use either of the I<--qemudir> or I<--qemu> options."
31863 #: ../test-tool/libguestfs-test-tool.pod:85
31865 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
31866 "I<1> if there was an error."
31871 #: ../test-tool/libguestfs-test-tool.pod:92
31872 msgid "/usr/libexec/libguestfs-test-tool-helper"
31877 #: ../test-tool/libguestfs-test-tool.pod:94
31879 "This helper program is run inside the appliance and provides additional "
31885 #: ../test-tool/libguestfs-test-tool.pod:97
31886 msgid "/usr/bin/mkisofs"
31891 #: ../test-tool/libguestfs-test-tool.pod:99
31893 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
31894 "which is used as part of the tests."
31899 #: ../test-tool/libguestfs-test-tool.pod:106
31901 "For the full list of environment variables which may affect libguestfs, "
31902 "please see the L<guestfs(3)> manual page."
31907 #: ../test-tool/libguestfs-test-tool.pod:111
31908 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
31913 #: ../test-tool/libguestfs-test-tool.pod:121
31914 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
31919 #: ../fuse/guestmount.pod:5
31921 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
31926 #: ../fuse/guestmount.pod:9
31929 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
31935 #: ../fuse/guestmount.pod:11
31938 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
31944 #: ../fuse/guestmount.pod:13
31947 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
31953 #: ../fuse/guestmount.pod:17
31955 "You must I<not> use C<guestmount> in read-write mode on live virtual "
31956 "machines. If you do this, you risk disk corruption in the VM."
31961 #: ../fuse/guestmount.pod:22
31963 "The guestmount program can be used to mount virtual machine filesystems and "
31964 "other disk images on the host. It uses libguestfs for access to the guest "
31965 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
31966 "a mountable device."
31971 #: ../fuse/guestmount.pod:27
31973 "Along with other options, you have to give at least one device (I<-a> "
31974 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
31975 "option) or use the I<-i> inspection option. How this works is better "
31976 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
31982 #: ../fuse/guestmount.pod:33
31984 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
31985 "by you, and the filesystem will not be visible to any other users unless you "
31986 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
31987 "the filesystem, use the C<fusermount -u> command."
31992 #: ../fuse/guestmount.pod:41
31994 "For a typical Windows guest which has its main filesystem on the first "
32000 #: ../fuse/guestmount.pod:44
32003 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
32009 #: ../fuse/guestmount.pod:46
32011 "For a typical Linux guest which has a /boot filesystem on the first "
32012 "partition, and the root filesystem on a logical volume:"
32017 #: ../fuse/guestmount.pod:49
32020 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
32026 #: ../fuse/guestmount.pod:51
32027 msgid "To get libguestfs to detect guest mountpoints for you:"
32032 #: ../fuse/guestmount.pod:53
32035 " guestmount -a guest.img -i --ro /mnt\n"
32041 #: ../fuse/guestmount.pod:55
32042 msgid "For a libvirt guest called \"Guest\" you could do:"
32047 #: ../fuse/guestmount.pod:57
32050 " guestmount -d Guest -i --ro /mnt\n"
32056 #: ../fuse/guestmount.pod:59
32058 "If you don't know what filesystems are contained in a guest or disk image, "
32059 "use L<virt-filesystems(1)> first:"
32064 #: ../fuse/guestmount.pod:62
32067 " virt-filesystems MyGuest\n"
32073 #: ../fuse/guestmount.pod:64
32075 "If you want to trace the libguestfs calls but without excessive debugging "
32076 "information, we recommend:"
32081 #: ../fuse/guestmount.pod:67
32084 " guestmount [...] --trace /mnt\n"
32090 #: ../fuse/guestmount.pod:69
32091 msgid "If you want to debug the program, we recommend:"
32096 #: ../fuse/guestmount.pod:71
32099 " guestmount [...] --trace --verbose /mnt\n"
32105 #: ../fuse/guestmount.pod:77
32106 msgid "B<-a image> | B<--add image>"
32111 #: ../fuse/guestmount.pod:79
32112 msgid "Add a block device or virtual machine image."
32117 #: ../fuse/guestmount.pod:84
32118 msgid "B<-c URI> | B<--connect URI>"
32123 #: ../fuse/guestmount.pod:90
32124 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
32129 #: ../fuse/guestmount.pod:96
32130 msgid "B<--dir-cache-timeout N>"
32135 #: ../fuse/guestmount.pod:98
32137 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
32138 "seconds. The readdir cache [actually, there are several semi-independent "
32139 "caches] is populated after a readdir(2) call with the stat and extended "
32140 "attributes of the files in the directory, in anticipation that they will be "
32141 "requested soon after."
32146 #: ../fuse/guestmount.pod:104
32148 "There is also a different attribute cache implemented by FUSE (see the FUSE "
32149 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
32150 "requests, only cache existing ones."
32155 #: ../fuse/guestmount.pod:115
32156 msgid "B<--format=raw|qcow2|..> | B<--format>"
32161 #: ../fuse/guestmount.pod:122
32163 "If you have untrusted raw-format guest disk images, you should use this "
32164 "option to specify the disk format. This avoids a possible security problem "
32165 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32166 "guestfs_add_drive_opts>."
32171 #: ../fuse/guestmount.pod:127
32172 msgid "B<--fuse-help>"
32177 #: ../fuse/guestmount.pod:129
32178 msgid "Display help on special FUSE options (see I<-o> below)."
32183 #: ../fuse/guestmount.pod:133
32184 msgid "Display brief help and exit."
32189 #: ../fuse/guestmount.pod:135
32190 msgid "B<-i> | B<--inspector>"
32195 #: ../fuse/guestmount.pod:155
32197 "Mount the named partition or logical volume on the given mountpoint B<in the "
32198 "guest> (this has nothing to do with mountpoints in the host)."
32203 #: ../fuse/guestmount.pod:158
32205 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32206 "something on C</>."
32211 #: ../fuse/guestmount.pod:171
32212 msgid "B<-n> | B<--no-sync>"
32217 #: ../fuse/guestmount.pod:173
32219 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32220 "unmounted. If you specify this option, then we don't attempt to sync the "
32221 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32226 #: ../fuse/guestmount.pod:178
32227 msgid "B<-o option> | B<--option option>"
32232 #: ../fuse/guestmount.pod:180
32233 msgid "Pass extra options to FUSE."
32238 #: ../fuse/guestmount.pod:182
32240 "To get a list of all the extra options supported by FUSE, use the command "
32241 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32242 "of them are a good idea."
32247 #: ../fuse/guestmount.pod:186
32250 " guestmount --fuse-help\n"
32256 #: ../fuse/guestmount.pod:188
32257 msgid "Some potentially useful FUSE options:"
32262 #: ../fuse/guestmount.pod:192
32263 msgid "B<-o allow_other>"
32268 #: ../fuse/guestmount.pod:194
32269 msgid "Allow other users to see the filesystem."
32274 #: ../fuse/guestmount.pod:196
32275 msgid "B<-o attr_timeout=N>"
32280 #: ../fuse/guestmount.pod:198
32281 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32286 #: ../fuse/guestmount.pod:200
32287 msgid "B<-o kernel_cache>"
32292 #: ../fuse/guestmount.pod:202
32294 "Allow the kernel to cache files (reduces the number of reads that have to go "
32295 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32296 "afford the extra memory usage."
32301 #: ../fuse/guestmount.pod:206
32302 msgid "B<-o uid=N> B<-o gid=N>"
32307 #: ../fuse/guestmount.pod:208
32309 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32310 "the chosen values."
32315 #: ../fuse/guestmount.pod:213
32316 msgid "B<-r> | B<--ro>"
32321 #: ../fuse/guestmount.pod:215
32323 "Add devices and mount everything read-only. Also disallow writes and make "
32324 "the disk appear read-only to FUSE."
32329 #: ../fuse/guestmount.pod:218
32331 "This is highly recommended if you are not going to edit the guest disk. If "
32332 "the guest is running and this option is I<not> supplied, then there is a "
32333 "strong risk of disk corruption in the guest. We try to prevent this from "
32334 "happening, but it is not always possible."
32339 #: ../fuse/guestmount.pod:223
32340 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32345 #: ../fuse/guestmount.pod:227
32346 msgid "Enable SELinux support for the guest."
32351 #: ../fuse/guestmount.pod:229
32352 msgid "B<-v> | B<--verbose>"
32357 #: ../fuse/guestmount.pod:231
32358 msgid "Enable verbose messages from underlying libguestfs."
32363 #: ../fuse/guestmount.pod:233
32364 msgid "B<-V> | B<--version>"
32369 #: ../fuse/guestmount.pod:235
32370 msgid "Display the program version and exit."
32375 #: ../fuse/guestmount.pod:237
32376 msgid "B<-w> | B<--rw>"
32380 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
32381 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32386 #: ../fuse/guestmount.pod:244
32387 msgid "B<-x> | B<--trace>"
32392 #: ../fuse/guestmount.pod:246
32393 msgid "Trace libguestfs calls and entry into each FUSE function."
32398 #: ../fuse/guestmount.pod:248
32399 msgid "This also stops the daemon from forking into the background."
32404 #: ../fuse/guestmount.pod:269
32406 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32407 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32413 #: ../fuse/guestmount.pod:284
32414 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32419 #: ../tools/virt-edit.pl:34
32420 msgid "virt-edit - Edit a file in a virtual machine"
32425 #: ../tools/virt-edit.pl:38
32428 " virt-edit [--options] domname file\n"
32434 #: ../tools/virt-edit.pl:40
32437 " virt-edit [--options] disk.img [disk.img ...] file\n"
32443 #: ../tools/virt-edit.pl:42
32446 " virt-edit [domname|disk.img] file -e 'expr'\n"
32452 #: ../tools/virt-edit.pl:46
32454 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32455 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32456 "doing this, but doesn't catch all cases."
32461 #: ../tools/virt-edit.pl:52
32463 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32464 "the named virtual machine (or disk image)."
32468 #: ../tools/virt-edit.pl:55
32469 msgid "If you want to just view a file, use L<virt-cat(1)>."
32473 #: ../tools/virt-edit.pl:57
32475 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
32476 "USING GUESTFISH> below)."
32480 #: ../tools/virt-edit.pl:60
32482 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
32483 "files. L<guestfish(1)> can do that and much more."
32488 #: ../tools/virt-edit.pl:65
32489 msgid "Edit the named files interactively:"
32494 #: ../tools/virt-edit.pl:67
32497 " virt-edit mydomain /boot/grub/grub.conf\n"
32503 #: ../tools/virt-edit.pl:69
32506 " virt-edit mydomain /etc/passwd\n"
32511 #: ../tools/virt-edit.pl:71
32512 msgid "For Windows guests, some Windows paths are understood:"
32516 #: ../tools/virt-edit.pl:73
32519 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
32525 #: ../tools/virt-edit.pl:75
32527 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32528 "below). To change the init default level to 5:"
32533 #: ../tools/virt-edit.pl:79
32536 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32542 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
32543 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32544 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32545 msgid "Display brief help."
32550 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
32551 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
32552 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
32553 #: ../tools/virt-list-partitions.pl:72
32554 msgid "Display version number and exit."
32559 #: ../tools/virt-edit.pl:105
32560 msgid "B<--backup extension> | B<-b extension>"
32565 #: ../tools/virt-edit.pl:107
32567 "Create a backup of the original file I<in the guest disk image>. The backup "
32568 "has the original filename with C<extension> added."
32573 #: ../tools/virt-edit.pl:110
32575 "Usually the first character of C<extension> would be a dot C<.> so you would "
32581 #: ../tools/virt-edit.pl:113
32584 " virt-edit -b .orig [etc]\n"
32590 #: ../tools/virt-edit.pl:115
32591 msgid "By default, no backup file is made."
32596 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
32597 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32598 #: ../tools/virt-list-partitions.pl:78
32599 msgid "B<--connect URI> | B<-c URI>"
32604 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
32605 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32606 #: ../tools/virt-list-partitions.pl:80
32608 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32609 "to the default libvirt hypervisor."
32614 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
32615 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32616 #: ../tools/virt-list-partitions.pl:83
32618 "If you specify guest block devices directly, then libvirt is not used at all."
32623 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
32624 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
32625 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
32626 msgid "B<--format> raw"
32631 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
32632 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32633 #: ../tools/virt-list-partitions.pl:92
32635 "Specify the format of disk images given on the command line. If this is "
32636 "omitted then the format is autodetected from the content of the disk image."
32641 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
32642 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32643 #: ../tools/virt-list-partitions.pl:96
32645 "If disk images are requested from libvirt, then this program asks libvirt "
32646 "for this information. In this case, the value of the format parameter is "
32652 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
32653 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
32654 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32655 #: ../tools/virt-list-partitions.pl:100
32657 "If working with untrusted raw-format guest disk images, you should ensure "
32658 "the format is always specified."
32663 #: ../tools/virt-edit.pl:150
32664 msgid "B<--expr EXPR> | B<-e EXPR>"
32669 #: ../tools/virt-edit.pl:152
32671 "Instead of launching the external editor, non-interactively apply the Perl "
32672 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32678 #: ../tools/virt-edit.pl:156
32680 "Be careful to properly quote the expression to prevent it from being altered "
32686 #: ../tools/virt-edit.pl:280
32687 msgid "NON-INTERACTIVE EDITING"
32692 #: ../tools/virt-edit.pl:282
32694 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32695 "administrator can interactively edit the file."
32700 #: ../tools/virt-edit.pl:285
32702 "There are two ways also to use C<virt-edit> from scripts in order to make "
32703 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32704 "like this, it's less error-prone to write scripts directly using the "
32705 "libguestfs API and Augeas for configuration file editing.)"
32710 #: ../tools/virt-edit.pl:291
32712 "The first method is to temporarily set C<$EDITOR> to any script or program "
32713 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32714 "update C<tmpfile> in place however it likes."
32719 #: ../tools/virt-edit.pl:295
32721 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
32722 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32723 "instances of C<foo> with C<bar> in a file:"
32728 #: ../tools/virt-edit.pl:299
32731 " virt-edit domname filename -e 's/foo/bar/'\n"
32737 #: ../tools/virt-edit.pl:301
32739 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32740 "For example to delete root's password you could do:"
32745 #: ../tools/virt-edit.pl:304
32748 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32754 #: ../tools/virt-edit.pl:306
32756 "What really happens is that the snippet is evaluated as a Perl expression "
32757 "for each line of the file. The line, including the final C<\\n>, is passed "
32758 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32763 #: ../tools/virt-edit.pl:311
32765 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32766 "C<apache> user account from the password file you can do:"
32771 #: ../tools/virt-edit.pl:314
32774 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32780 #: ../tools/virt-edit.pl:316
32782 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32783 "the end of the file is rather difficult this way since there is no concept "
32784 "of \"last line of the file\" - your expression just doesn't get called "
32785 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32791 #: ../tools/virt-edit.pl:322
32793 "The variable C<$lineno> contains the current line number. As is "
32794 "traditional, the first line in the file is number C<1>."
32799 #: ../tools/virt-edit.pl:325
32801 "The return value from the expression is ignored, but the expression may call "
32802 "C<die> in order to abort the whole program, leaving the original file "
32808 #: ../tools/virt-edit.pl:329
32810 "Remember when matching the end of a line that C<$_> may contain the final C<"
32811 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32812 "newline then neither of these. Thus to match or substitute some text at the "
32813 "end of a line, use this regular expression:"
32818 #: ../tools/virt-edit.pl:334
32821 " /some text(\\r?\\n)?$/\n"
32827 #: ../tools/virt-edit.pl:336
32829 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32830 "$_> itself (since that would remove all newlines from the file):"
32835 #: ../tools/virt-edit.pl:340
32838 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32843 #: ../tools/virt-edit.pl:344
32845 "C<virt-edit> has a limited ability to understand Windows drive letters and "
32846 "paths (eg. C<E:\\foo\\bar.txt>)."
32850 #: ../tools/virt-edit.pl:347
32851 msgid "If and only if the guest is running Windows then:"
32855 #: ../tools/virt-edit.pl:353
32857 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
32858 "to the correct filesystem."
32862 #: ../tools/virt-edit.pl:358
32864 "Any backslash (C<\\>) characters in the path are replaced with forward "
32865 "slashes so that libguestfs can process it."
32869 #: ../tools/virt-edit.pl:363
32871 "The path is resolved case insensitively to locate the file that should be "
32876 #: ../tools/virt-edit.pl:368
32877 msgid "There are some known shortcomings:"
32881 #: ../tools/virt-edit.pl:374
32882 msgid "Some NTFS symbolic links may not be followed correctly."
32886 #: ../tools/virt-edit.pl:378
32887 msgid "NTFS junction points that cross filesystems are not followed."
32891 #: ../tools/virt-edit.pl:435
32892 msgid "USING GUESTFISH"
32896 #: ../tools/virt-edit.pl:437
32898 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
32899 "C<virt-edit> doesn't work."
32903 #: ../tools/virt-edit.pl:440
32904 msgid "Using C<virt-edit> is approximately equivalent to doing:"
32908 #: ../tools/virt-edit.pl:442
32911 " guestfish --rw -i -d domname edit /file\n"
32916 #: ../tools/virt-edit.pl:444
32918 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
32919 "path to the file."
32923 #: ../tools/virt-edit.pl:447
32925 "The command above uses libguestfs's guest inspection feature and so does not "
32926 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
32927 "disk images that don't contain guests. To edit a file on a disk image "
32932 #: ../tools/virt-edit.pl:452
32935 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
32940 #: ../tools/virt-edit.pl:454
32942 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
32943 "the disk image to edit, and C</file> is the full path to the file."
32947 #: ../tools/virt-edit.pl:458
32949 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
32950 "C<write> or C<upload> instead:"
32954 #: ../tools/virt-edit.pl:461
32957 " guestfish --rw -i -d domname touch /newfile\n"
32962 #: ../tools/virt-edit.pl:463
32965 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
32970 #: ../tools/virt-edit.pl:465
32973 " guestfish --rw -i -d domname upload localfile /newfile\n"
32978 #: ../tools/virt-edit.pl:467
32980 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
32984 #: ../tools/virt-edit.pl:470
32987 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
32993 #: ../tools/virt-edit.pl:480
32999 #: ../tools/virt-edit.pl:482
33001 "If set, this string is used as the editor. It may contain arguments, eg. C<"
33007 #: ../tools/virt-edit.pl:485
33008 msgid "If not set, C<vi> is used."
33013 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
33014 #: ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182
33015 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
33016 #: ../tools/virt-list-partitions.pl:250
33017 msgid "SHELL QUOTING"
33022 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
33023 #: ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184
33024 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
33025 #: ../tools/virt-list-partitions.pl:252
33027 "Libvirt guest names can contain arbitrary characters, some of which have "
33028 "meaning to the shell such as C<#> and space. You may need to quote or "
33029 "escape these characters on the command line. See the shell manual page L<sh"
33030 "(1)> for details."
33034 #: ../tools/virt-edit.pl:498
33036 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
33037 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
33038 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
33043 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
33044 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202
33045 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
33046 #: ../tools/virt-list-partitions.pl:269
33052 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
33053 #: ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204
33054 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
33055 #: ../tools/virt-list-partitions.pl:271
33056 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
33060 #: ../tools/virt-edit.pl:516
33061 msgid "Copyright (C) 2009-2011 Red Hat Inc."
33066 #: ../tools/virt-win-reg.pl:37
33068 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
33073 #: ../tools/virt-win-reg.pl:41
33076 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
33082 #: ../tools/virt-win-reg.pl:43
33085 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
33091 #: ../tools/virt-win-reg.pl:45
33094 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
33100 #: ../tools/virt-win-reg.pl:47
33103 " virt-win-reg --merge domname [input.reg ...]\n"
33109 #: ../tools/virt-win-reg.pl:49
33112 " virt-win-reg [--options] disk.img ... # instead of domname\n"
33118 #: ../tools/virt-win-reg.pl:53
33120 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
33121 "virtual machines. If you do this, you I<will> get irreversible disk "
33122 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
33123 "but doesn't catch all cases."
33128 #: ../tools/virt-win-reg.pl:58
33130 "Modifying the Windows Registry is an inherently risky operation. The format "
33131 "is deliberately obscure and undocumented, and Registry changes can leave the "
33132 "system unbootable. Therefore when using the C<--merge> option, make sure "
33133 "you have a reliable backup first."
33138 #: ../tools/virt-win-reg.pl:65
33140 "This program can export and merge Windows Registry entries from a Windows "
33146 #: ../tools/virt-win-reg.pl:68
33148 "The first parameter is the libvirt guest name or the raw disk image of a "
33154 #: ../tools/virt-win-reg.pl:71
33156 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
33157 "exported (recursively). For example:"
33162 #: ../tools/virt-win-reg.pl:74
33165 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
33171 #: ../tools/virt-win-reg.pl:76
33173 "You can also display single values from within registry keys, for example:"
33178 #: ../tools/virt-win-reg.pl:79
33181 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
33182 " $ virt-win-reg Windows7 $cvkey ProductName\n"
33183 " Windows 7 Enterprise\n"
33189 #: ../tools/virt-win-reg.pl:83
33191 "With C<--merge>, you can merge a textual regedit file into the Windows "
33197 #: ../tools/virt-win-reg.pl:86
33200 " $ virt-win-reg --merge Windows7 changes.reg\n"
33206 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
33212 #: ../tools/virt-win-reg.pl:90
33214 "This program is only meant for simple access to the registry. If you want "
33215 "to do complicated things with the registry, we suggest you download the "
33216 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
33217 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
33218 "L<hivexregedit(1)>."
33223 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
33229 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
33230 msgid "Enable debugging messages."
33235 #: ../tools/virt-win-reg.pl:157
33241 #: ../tools/virt-win-reg.pl:159
33243 "In merge mode, this merges a textual regedit file into the Windows Registry "
33244 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
33245 "displays or exports Registry entries instead."
33250 #: ../tools/virt-win-reg.pl:163
33252 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
33253 "result in disk corruption. However exporting (without this flag) is always "
33259 #: ../tools/virt-win-reg.pl:171
33260 msgid "B<--encoding> UTF-16LE|ASCII"
33265 #: ../tools/virt-win-reg.pl:173
33267 "When merging (only), you may need to specify the encoding for strings to be "
33268 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
33269 "(3)/ENCODING STRINGS>."
33274 #: ../tools/virt-win-reg.pl:177
33276 "The default is to use UTF-16LE, which should work with recent versions of "
33282 #: ../tools/virt-win-reg.pl:402
33283 msgid "SUPPORTED SYSTEMS"
33288 #: ../tools/virt-win-reg.pl:404
33290 "The program currently supports Windows NT-derived guests starting with "
33291 "Windows XP through to at least Windows 7."
33296 #: ../tools/virt-win-reg.pl:407
33298 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
33299 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
33300 "and C<HKEY_USERS\\.DEFAULT>."
33305 #: ../tools/virt-win-reg.pl:411
33307 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
33313 #: ../tools/virt-win-reg.pl:414
33315 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
33321 #: ../tools/virt-win-reg.pl:417
33327 #: ../tools/virt-win-reg.pl:419
33329 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33330 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33331 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33332 "Windows-style line endings, you may need to reencode the whole file before "
33333 "or after processing."
33338 #: ../tools/virt-win-reg.pl:425
33340 "To reencode a file from Windows format to Linux (before processing it with "
33341 "the C<--merge> option), you would do something like this:"
33346 #: ../tools/virt-win-reg.pl:428
33349 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33355 #: ../tools/virt-win-reg.pl:430
33357 "To go in the opposite direction, after exporting and before sending the file "
33358 "to a Windows user, do something like this:"
33363 #: ../tools/virt-win-reg.pl:433
33366 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33372 #: ../tools/virt-win-reg.pl:435
33373 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33378 #: ../tools/virt-win-reg.pl:437
33380 "If you are unsure about the current encoding, use the L<file(1)> command. "
33381 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33382 "style (CRLF) line endings, like this:"
33387 #: ../tools/virt-win-reg.pl:441
33390 " $ file software.reg\n"
33391 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33392 " with CRLF line terminators\n"
33398 #: ../tools/virt-win-reg.pl:445
33399 msgid "This file would need conversion before you could C<--merge> it."
33404 #: ../tools/virt-win-reg.pl:447
33405 msgid "CurrentControlSet etc."
33410 #: ../tools/virt-win-reg.pl:449
33412 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33413 "Registry at the level of the hive file, and therefore you cannot modify "
33419 #: ../tools/virt-win-reg.pl:453
33421 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33422 "circumstances it might refer to another control set. The way to find out is "
33423 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33428 #: ../tools/virt-win-reg.pl:457
33431 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33432 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33433 " \"Current\"=dword:00000001\n"
33434 " \"Default\"=dword:00000001\n"
33435 " \"Failed\"=dword:00000000\n"
33436 " \"LastKnownGood\"=dword:00000002\n"
33442 #: ../tools/virt-win-reg.pl:464
33443 msgid "\"Current\" is the one which Windows will choose when it boots."
33448 #: ../tools/virt-win-reg.pl:466
33450 "Similarly, other C<Current...> keys in the path may need to be replaced."
33455 #: ../tools/virt-win-reg.pl:469
33456 msgid "WINDOWS TIPS"
33461 #: ../tools/virt-win-reg.pl:471
33463 "Note that some of these tips modify the guest disk image. The guest I<must> "
33464 "be shut off, else you will get disk corruption."
33469 #: ../tools/virt-win-reg.pl:474
33470 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33475 #: ../tools/virt-win-reg.pl:476
33477 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33478 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33479 "is uploaded into C<C:\\>:"
33484 #: ../tools/virt-win-reg.pl:480
33487 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33493 #: ../tools/virt-win-reg.pl:482
33494 msgid "Prepare a regedit file containing the registry change:"
33499 #: ../tools/virt-win-reg.pl:484
33502 " cat > test.reg <<'EOF'\n"
33503 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33504 " \"Test\"=\"c:\\\\test.bat\"\n"
33511 #: ../tools/virt-win-reg.pl:489
33513 "In this example we use the key C<RunOnce> which means that the script will "
33514 "run precisely once when the first user logs in. If you want it to run every "
33515 "time a user logs in, replace C<RunOnce> with C<Run>."
33520 #: ../tools/virt-win-reg.pl:493
33521 msgid "Now update the registry:"
33526 #: ../tools/virt-win-reg.pl:495
33529 " virt-win-reg --merge WindowsGuest test.reg\n"
33535 #: ../tools/virt-win-reg.pl:497
33536 msgid "INSTALLING A SERVICE"
33541 #: ../tools/virt-win-reg.pl:499
33543 "This section assumes you are familiar with Windows services, and you either "
33544 "have a program which handles the Windows Service Control Protocol directly "
33545 "or you want to run any program using a service wrapper like SrvAny or the "
33551 #: ../tools/virt-win-reg.pl:504
33553 "First upload the program and optionally the service wrapper. In this case "
33554 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33559 #: ../tools/virt-win-reg.pl:508
33562 " guestfish -i -d WindowsGuest <<EOF\n"
33563 " upload rhsrvany.exe /rhsrvany.exe\n"
33564 " upload test.exe /test.exe\n"
33571 #: ../tools/virt-win-reg.pl:513
33573 "Prepare a regedit file containing the registry changes. In this example, "
33574 "the first registry change is needed for the service itself or the service "
33575 "wrapper (if used). The second registry change is only needed because I am "
33576 "using the RHSrvAny service wrapper."
33581 #: ../tools/virt-win-reg.pl:518
33584 " cat > service.reg <<'EOF'\n"
33585 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33586 " \"Type\"=dword:00000010\n"
33587 " \"Start\"=dword:00000002\n"
33588 " \"ErrorControl\"=dword:00000001\n"
33589 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33590 " \"DisplayName\"=\"RHSrvAny\"\n"
33591 " \"ObjectName\"=\"NetworkService\"\n"
33597 #: ../tools/virt-win-reg.pl:527
33600 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33601 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33602 " \"PWD\"=\"c:\\\\Temp\"\n"
33609 #: ../tools/virt-win-reg.pl:538
33611 "For use of C<ControlSet001> see the section above in this manual page. You "
33612 "may need to adjust this according to the control set that is in use by the "
33618 #: ../tools/virt-win-reg.pl:544
33620 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33621 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33622 "privileged account."
33627 #: ../tools/virt-win-reg.pl:550
33629 "For the meaning of the magic numbers, see this Microsoft KB article: "
33630 "L<http://support.microsoft.com/kb/103000>."
33635 #: ../tools/virt-win-reg.pl:555
33636 msgid "Update the registry:"
33641 #: ../tools/virt-win-reg.pl:557
33644 " virt-win-reg --merge WindowsGuest service.reg\n"
33650 #: ../tools/virt-win-reg.pl:561
33652 "Be careful when passing parameters containing C<\\> (backslash) in the "
33653 "shell. Usually you will have to use 'single quotes' or double backslashes "
33654 "(but not both) to protect them from the shell."
33659 #: ../tools/virt-win-reg.pl:565
33660 msgid "Paths and value names are case-insensitive."
33665 #: ../tools/virt-win-reg.pl:574
33667 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33668 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33669 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33674 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33676 "When reporting bugs, please enable debugging and capture the I<complete> "
33682 #: ../tools/virt-win-reg.pl:592
33685 " export LIBGUESTFS_DEBUG=1\n"
33686 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33692 #: ../tools/virt-win-reg.pl:595
33694 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33700 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516
33701 #: ../tools/virt-make-fs.pl:570
33702 msgid "Copyright (C) 2010 Red Hat Inc."
33707 #: ../tools/virt-resize.pl:42
33708 msgid "virt-resize - Resize a virtual machine disk"
33713 #: ../tools/virt-resize.pl:46
33716 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
33717 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
33718 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
33724 #: ../tools/virt-resize.pl:52
33726 "Virt-resize is a tool which can resize a virtual machine disk, making it "
33727 "larger or smaller overall, and resizing or deleting any partitions contained "
33733 #: ../tools/virt-resize.pl:56
33735 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
33736 "not> be used on live virtual machines - for consistent results, shut the "
33737 "virtual machine down before resizing it."
33742 #: ../tools/virt-resize.pl:60
33744 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
33745 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
33750 #: ../tools/virt-resize.pl:66
33752 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
33753 "fill the extra 5GB of space."
33757 #: ../tools/virt-resize.pl:69
33760 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
33761 " virt-filesystems --long -h --all -a olddisk\n"
33762 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
33763 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
33769 #: ../tools/virt-resize.pl:74
33771 "As above, but make the /boot partition 200MB bigger, while giving the "
33772 "remaining space to /dev/sda2:"
33777 #: ../tools/virt-resize.pl:77
33780 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
33786 #: ../tools/virt-resize.pl:79
33787 msgid "As above, but the output format will be uncompressed qcow2:"
33792 #: ../tools/virt-resize.pl:81
33795 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
33796 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
33802 #: ../tools/virt-resize.pl:84
33803 msgid "DETAILED USAGE"
33808 #: ../tools/virt-resize.pl:86
33809 msgid "EXPANDING A VIRTUAL MACHINE DISK"
33814 #: ../tools/virt-resize.pl:90
33815 msgid "1. Shut down the virtual machine"
33820 #: ../tools/virt-resize.pl:92
33821 msgid "2. Locate input disk image"
33826 #: ../tools/virt-resize.pl:94
33828 "Locate the input disk image (ie. the file or device on the host containing "
33829 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
33830 "dumpxml> like this to find the disk image name:"
33835 #: ../tools/virt-resize.pl:98
33838 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
33839 " Found 1 nodes:\n"
33841 " <source dev=\"/dev/vg/lv_guest\" />\n"
33847 #: ../tools/virt-resize.pl:103
33848 msgid "3. Look at current sizing"
33853 #: ../tools/virt-resize.pl:105
33854 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
33859 #: ../tools/virt-resize.pl:108
33862 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
33863 " Name Type Size Parent\n"
33864 " /dev/sda1 partition 101M /dev/sda\n"
33865 " /dev/sda2 partition 7.9G /dev/sda\n"
33866 " /dev/sda device 8.0G -\n"
33872 #: ../tools/virt-resize.pl:114
33874 "(This example is a virtual machine with an 8 GB disk which we would like to "
33875 "expand up to 10 GB)."
33880 #: ../tools/virt-resize.pl:117
33881 msgid "4. Create output disk"
33886 #: ../tools/virt-resize.pl:119
33888 "Virt-resize cannot do in-place disk modifications. You have to have space "
33889 "to store the resized output disk."
33894 #: ../tools/virt-resize.pl:122
33896 "To store the resized disk image in a file, create a file of a suitable size:"
33901 #: ../tools/virt-resize.pl:125
33904 " # rm -f outdisk\n"
33905 " # truncate -s 10G outdisk\n"
33911 #: ../tools/virt-resize.pl:128
33912 msgid "Or use L<lvcreate(1)> to create a logical volume:"
33917 #: ../tools/virt-resize.pl:130
33920 " # lvcreate -L 10G -n lv_name vg_name\n"
33926 #: ../tools/virt-resize.pl:132
33927 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
33932 #: ../tools/virt-resize.pl:134
33935 " # virsh pool-list\n"
33936 " # virsh vol-create-as poolname newvol 10G\n"
33942 #: ../tools/virt-resize.pl:137
33948 #: ../tools/virt-resize.pl:139
33950 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
33951 "file) and the output disk. The output disk is the one created in the "
33957 #: ../tools/virt-resize.pl:143
33960 " # virt-resize indisk outdisk\n"
33966 #: ../tools/virt-resize.pl:145
33968 "This command just copies disk image C<indisk> to disk image C<outdisk> "
33969 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
33970 "larger, then an extra, empty partition is created at the end of the disk "
33971 "covering the extra space. If C<outdisk> is smaller, then it will give an "
33977 #: ../tools/virt-resize.pl:151
33979 "More realistically you'd want to expand existing partitions in the disk "
33980 "image by passing extra options (for the full list see the L</OPTIONS> "
33986 #: ../tools/virt-resize.pl:155
33988 "L</--expand> is the most useful option. It expands the named partition "
33989 "within the disk to fill any extra space:"
33994 #: ../tools/virt-resize.pl:158
33997 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
34003 #: ../tools/virt-resize.pl:160
34005 "(In this case, an extra partition is I<not> created at the end of the disk, "
34006 "because there will be no unused space)."
34011 #: ../tools/virt-resize.pl:163
34013 "L</--resize> is the other commonly used option. The following would "
34014 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
34015 "rest of the available space:"
34020 #: ../tools/virt-resize.pl:167
34023 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
34024 " indisk outdisk\n"
34030 #: ../tools/virt-resize.pl:170
34032 "If the expanded partition in the image contains a filesystem or LVM PV, then "
34033 "if virt-resize knows how, it will resize the contents, the equivalent of "
34034 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
34035 ">. However virt-resize does not know how to resize some filesystems, so you "
34036 "would have to online resize them after booting the guest."
34041 #: ../tools/virt-resize.pl:177
34042 msgid "Other options are covered below."
34047 #: ../tools/virt-resize.pl:179
34053 #: ../tools/virt-resize.pl:181
34054 msgid "Thoroughly test the new disk image I<before> discarding the old one."
34059 #: ../tools/virt-resize.pl:183
34060 msgid "If you are using libvirt, edit the XML to point at the new disk:"
34065 #: ../tools/virt-resize.pl:185
34068 " # virsh edit guestname\n"
34074 #: ../tools/virt-resize.pl:187
34076 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
34077 "html#elementsDisks>"
34082 #: ../tools/virt-resize.pl:190
34083 msgid "Then start up the domain with the new, resized disk:"
34088 #: ../tools/virt-resize.pl:192
34091 " # virsh start guestname\n"
34097 #: ../tools/virt-resize.pl:194
34099 "and check that it still works. See also the L</NOTES> section below for "
34100 "additional information."
34105 #: ../tools/virt-resize.pl:197
34106 msgid "7. Resize LVs etc inside the guest"
34111 #: ../tools/virt-resize.pl:199
34112 msgid "(This can also be done offline using L<guestfish(1)>)"
34117 #: ../tools/virt-resize.pl:201
34119 "Once the guest has booted you should see the new space available, at least "
34120 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
34121 "may need to resize LVs inside PVs, and also resize filesystem types that "
34122 "virt-resize does not know how to expand."
34127 #: ../tools/virt-resize.pl:208
34128 msgid "SHRINKING A VIRTUAL MACHINE DISK"
34133 #: ../tools/virt-resize.pl:210
34135 "Shrinking is somewhat more complex than expanding, and only an overview is "
34141 #: ../tools/virt-resize.pl:213
34143 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
34144 "filesystems). The user has to shrink content before passing the disk image "
34145 "to virt-resize, and virt-resize will check that the content has been shrunk "
34151 #: ../tools/virt-resize.pl:218
34152 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
34157 #: ../tools/virt-resize.pl:220
34159 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
34160 "steps 3 and 4 above to allocate a new disk image."
34165 #: ../tools/virt-resize.pl:223
34167 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
34172 #: ../tools/virt-resize.pl:226
34173 msgid "IGNORING OR DELETING PARTITIONS"
34178 #: ../tools/virt-resize.pl:228
34180 "virt-resize also gives a convenient way to ignore or delete partitions when "
34181 "copying from the input disk to the output disk. Ignoring a partition speeds "
34182 "up the copy where you don't care about the existing contents of a "
34183 "partition. Deleting a partition removes it completely, but note that it "
34184 "also renumbers any partitions after the one which is deleted, which can "
34185 "leave some guests unbootable."
34190 #: ../tools/virt-resize.pl:235
34191 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
34196 #: ../tools/virt-resize.pl:237
34198 "If the input disk is in qcow2 format, then you may prefer that the output is "
34199 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
34200 "the fly. The output format is simply determined by the format of the empty "
34201 "output container that you provide. Thus to create qcow2 output, use:"
34206 #: ../tools/virt-resize.pl:243
34209 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
34215 #: ../tools/virt-resize.pl:245
34216 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
34221 #: ../tools/virt-resize.pl:247
34222 msgid "Similarly, to get non-sparse raw output use:"
34227 #: ../tools/virt-resize.pl:249
34230 " fallocate -l size outdisk\n"
34236 #: ../tools/virt-resize.pl:251
34238 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
34239 "dev/zero of=outdisk bs=1M count=..>)"
34244 #: ../tools/virt-resize.pl:264
34245 msgid "Display help."
34250 #: ../tools/virt-resize.pl:278
34251 msgid "B<--resize part=size>"
34256 #: ../tools/virt-resize.pl:280
34258 "Resize the named partition (expanding or shrinking it) so that it has the "
34264 #: ../tools/virt-resize.pl:283
34266 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
34267 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
34268 "Exabytes; or as a percentage of the current size; or as a relative number or "
34269 "percentage. For example:"
34274 #: ../tools/virt-resize.pl:288
34277 " --resize /dev/sda2=10G\n"
34283 #: ../tools/virt-resize.pl:290
34286 " --resize /dev/sda4=90%\n"
34292 #: ../tools/virt-resize.pl:292
34295 " --resize /dev/sda2=+1G\n"
34301 #: ../tools/virt-resize.pl:294
34304 " --resize /dev/sda2=-200M\n"
34310 #: ../tools/virt-resize.pl:296
34313 " --resize /dev/sda1=+128K\n"
34319 #: ../tools/virt-resize.pl:298
34322 " --resize /dev/sda1=+10%\n"
34328 #: ../tools/virt-resize.pl:300
34331 " --resize /dev/sda1=-10%\n"
34337 #: ../tools/virt-resize.pl:302
34339 "You can increase the size of any partition. Virt-resize will expand the "
34340 "direct content of the partition if it knows how (see C<--expand> below)."
34345 #: ../tools/virt-resize.pl:306
34347 "You can only I<decrease> the size of partitions that contain filesystems or "
34348 "PVs which have already been shrunk. Virt-resize will check this has been "
34349 "done before proceeding, or else will print an error (see also C<--resize-"
34355 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
34356 #: ../tools/virt-resize.pl:420
34357 msgid "You can give this option multiple times."
34362 #: ../tools/virt-resize.pl:317
34363 msgid "B<--resize-force part=size>"
34368 #: ../tools/virt-resize.pl:319
34370 "This is the same as C<--resize> except that it will let you decrease the "
34371 "size of any partition. Generally this means you will lose any data which "
34372 "was at the end of the partition you shrink, but you may not care about that "
34373 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
34374 "as a swap partition)."
34379 #: ../tools/virt-resize.pl:325
34380 msgid "See also the C<--ignore> option."
34385 #: ../tools/virt-resize.pl:331
34386 msgid "B<--expand part>"
34391 #: ../tools/virt-resize.pl:333
34393 "Expand the named partition so it uses up all extra space (space left over "
34394 "after any other resize changes that you request have been done)."
34399 #: ../tools/virt-resize.pl:336
34401 "If virt-resize knows how, it will expand the direct content of the "
34402 "partition. For example, if the partition is an LVM PV, it will expand the "
34403 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
34404 "content it doesn't know about alone."
34409 #: ../tools/virt-resize.pl:341
34410 msgid "Currently virt-resize can resize:"
34415 #: ../tools/virt-resize.pl:347
34417 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
34423 #: ../tools/virt-resize.pl:352
34425 "NTFS filesystems contained directly in a partition, if libguestfs was "
34426 "compiled with support for NTFS."
34431 #: ../tools/virt-resize.pl:355
34433 "The filesystem must have been shut down consistently last time it was used. "
34434 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
34435 "consistency check, so at the first boot after resizing Windows will check "
34441 #: ../tools/virt-resize.pl:362
34443 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
34444 "inside the PV, but see the C<--LV-expand> option. The user could also "
34445 "resize LVs as desired after boot."
34450 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
34451 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
34456 #: ../tools/virt-resize.pl:374
34457 msgid "B<--shrink part>"
34462 #: ../tools/virt-resize.pl:376
34464 "Shrink the named partition until the overall disk image fits in the "
34465 "destination. The named partition B<must> contain a filesystem or PV which "
34466 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
34467 "online tools). Virt-resize will check this and give an error if it has not "
34473 #: ../tools/virt-resize.pl:382
34475 "The amount by which the overall disk must be shrunk (after carrying out all "
34476 "other operations requested by the user) is called the \"deficit\". For "
34477 "example, a straight copy (assume no other operations) from a 5GB disk image "
34478 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
34479 "would give an error unless the user specified a partition to shrink and that "
34480 "partition had more than a gigabyte of free space."
34485 #: ../tools/virt-resize.pl:396
34486 msgid "B<--ignore part>"
34491 #: ../tools/virt-resize.pl:398
34493 "Ignore the named partition. Effectively this means the partition is "
34494 "allocated on the destination disk, but the content is not copied across from "
34495 "the source disk. The content of the partition will be blank (all zero "
34501 #: ../tools/virt-resize.pl:409
34502 msgid "B<--delete part>"
34507 #: ../tools/virt-resize.pl:411
34509 "Delete the named partition. It would be more accurate to describe this as "
34510 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
34511 "the original disk image is left intact."
34516 #: ../tools/virt-resize.pl:415
34518 "Note that when you delete a partition, then anything contained in the "
34519 "partition is also deleted. Furthermore, this causes any partitions that "
34520 "come after to be I<renumbered>, which can easily make your guest unbootable."
34525 #: ../tools/virt-resize.pl:426
34526 msgid "B<--LV-expand logvol>"
34531 #: ../tools/virt-resize.pl:428
34533 "This takes the logical volume and, as a final step, expands it to fill all "
34534 "the space available in its volume group. A typical usage, assuming a Linux "
34535 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
34536 "lv_root> would be:"
34541 #: ../tools/virt-resize.pl:433
34544 " virt-resize indisk outdisk \\\n"
34545 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
34551 #: ../tools/virt-resize.pl:436
34553 "This would first expand the partition (and PV), and then expand the root "
34554 "device to fill the extra space in the PV."
34559 #: ../tools/virt-resize.pl:439
34561 "The contents of the LV are also resized if virt-resize knows how to do "
34562 "that. You can stop virt-resize from trying to expand the content by using "
34563 "the option C<--no-expand-content>."
34568 #: ../tools/virt-resize.pl:443
34569 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
34574 #: ../tools/virt-resize.pl:446
34576 "You can give this option multiple times, I<but> it doesn't make sense to do "
34577 "this unless the logical volumes you specify are all in different volume "
34583 #: ../tools/virt-resize.pl:454
34584 msgid "B<--no-copy-boot-loader>"
34589 #: ../tools/virt-resize.pl:456
34591 "By default, virt-resize copies over some sectors at the start of the disk "
34592 "(up to the beginning of the first partition). Commonly these sectors "
34593 "contain the Master Boot Record (MBR) and the boot loader, and are required "
34594 "in order for the guest to boot correctly."
34599 #: ../tools/virt-resize.pl:461
34601 "If you specify this flag, then this initial copy is not done. You may need "
34602 "to reinstall the boot loader in this case."
34607 #: ../tools/virt-resize.pl:469
34608 msgid "B<--no-extra-partition>"
34613 #: ../tools/virt-resize.pl:471
34615 "By default, virt-resize creates an extra partition if there is any extra, "
34616 "unused space after all resizing has happened. Use this option to prevent "
34617 "the extra partition from being created. If you do this then the extra space "
34618 "will be inaccessible until you run fdisk, parted, or some other partitioning "
34619 "tool in the guest."
34624 #: ../tools/virt-resize.pl:477
34626 "Note that if the surplus space is smaller than 10 MB, no extra partition "
34632 #: ../tools/virt-resize.pl:484
34633 msgid "B<--no-expand-content>"
34638 #: ../tools/virt-resize.pl:486
34640 "By default, virt-resize will try to expand the direct contents of "
34641 "partitions, if it knows how (see C<--expand> option above)."
34646 #: ../tools/virt-resize.pl:489
34648 "If you give the C<--no-expand-content> option then virt-resize will not "
34654 #: ../tools/virt-resize.pl:496
34655 msgid "B<-d> | B<--debug>"
34660 #: ../tools/virt-resize.pl:504
34661 msgid "B<-n> | B<--dryrun>"
34666 #: ../tools/virt-resize.pl:506
34667 msgid "Print a summary of what would be done, but don't do anything."
34672 #: ../tools/virt-resize.pl:512
34673 msgid "B<-q> | B<--quiet>"
34678 #: ../tools/virt-resize.pl:514
34679 msgid "Don't print the summary."
34684 #: ../tools/virt-resize.pl:522
34686 "Specify the format of the input disk image. If this flag is not given then "
34687 "it is auto-detected from the image itself."
34692 #: ../tools/virt-resize.pl:528
34694 "Note that this option I<does not> affect the output format. See L</QCOW2 "
34695 "AND NON-SPARSE RAW FORMATS>."
34700 #: ../tools/virt-resize.pl:535
34701 msgid "B<--output-format> raw"
34706 #: ../tools/virt-resize.pl:537
34708 "Specify the format of the output disk image. If this flag is not given then "
34709 "it is auto-detected from the image itself."
34714 #: ../tools/virt-resize.pl:543
34716 "Note that you still need to create the output disk with the right format. "
34717 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
34722 #: ../tools/virt-resize.pl:1425
34728 #: ../tools/virt-resize.pl:1427
34729 msgid "\"Partition 1 does not end on cylinder boundary.\""
34734 #: ../tools/virt-resize.pl:1429
34736 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
34737 "means the partitions will not be aligned to the ancient CHS geometry. "
34738 "However CHS geometry is meaningless for disks manufactured since the early "
34739 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
34740 "cylinders is not required by any modern operating system."
34745 #: ../tools/virt-resize.pl:1436
34746 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
34751 #: ../tools/virt-resize.pl:1438
34753 "In Windows Vista and later versions, Microsoft switched to using a separate "
34754 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
34755 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
34756 "the boot partition. Doing so seems to break the guest completely. However "
34757 "expanding the second partition (ie. C: drive) should work."
34762 #: ../tools/virt-resize.pl:1445
34764 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
34765 "NTFS partitions have been expanded. This is just a safety check and (unless "
34766 "it find errors) is nothing to worry about."
34771 #: ../tools/virt-resize.pl:1449
34772 msgid "GUEST BOOT STUCK AT \"GRUB\""
34777 #: ../tools/virt-resize.pl:1451
34779 "If a Linux guest does not boot after resizing, and the boot is stuck after "
34780 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
34781 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
34782 "although we think is to do with partition alignment."
34787 #: ../tools/virt-resize.pl:1456
34790 " guestfish -i -a newdisk\n"
34791 " ><fs> cat /boot/grub/device.map\n"
34792 " # check the contents of this file are sensible or\n"
34793 " # edit the file if necessary\n"
34794 " ><fs> grub-install / /dev/vda\n"
34801 #: ../tools/virt-resize.pl:1463
34803 "For more flexible guest reconfiguration, including if you need to specify "
34804 "other parameters to grub-install, use L<virt-rescue(1)>."
34809 #: ../tools/virt-resize.pl:1466
34810 msgid "ALTERNATIVE TOOLS"
34815 #: ../tools/virt-resize.pl:1468
34817 "There are several proprietary tools for resizing partitions. We won't "
34818 "mention any here."
34823 #: ../tools/virt-resize.pl:1471
34825 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
34826 "operations on disk images. They can resize and move partitions, but I don't "
34827 "think they can do anything with the contents, and they certainly don't "
34833 #: ../tools/virt-resize.pl:1476
34835 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
34836 "but at a much lower level. You will probably end up hand-calculating sector "
34837 "offsets, which is something that virt-resize was designed to avoid. If you "
34838 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
34844 #: ../tools/virt-resize.pl:1491
34846 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
34847 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
34848 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
34849 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
34850 "libguestfs.org/>."
34855 #: ../tools/virt-list-filesystems.pl:32
34857 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34862 #: ../tools/virt-list-filesystems.pl:36
34865 " virt-list-filesystems [--options] domname\n"
34871 #: ../tools/virt-list-filesystems.pl:38
34874 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34880 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34882 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34888 #: ../tools/virt-list-filesystems.pl:45
34890 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34891 "are contained in a virtual machine or disk image."
34896 #: ../tools/virt-list-filesystems.pl:49
34898 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34899 "functionality. For more complex cases you should look at the L<guestfish(1)"
34905 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34906 msgid "B<-l> | B<--long>"
34911 #: ../tools/virt-list-filesystems.pl:108
34913 "With this option, C<virt-list-filesystems> displays the type of each "
34914 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34919 #: ../tools/virt-list-filesystems.pl:115
34920 msgid "B<-a> | B<--all>"
34925 #: ../tools/virt-list-filesystems.pl:117
34927 "Normally we only show mountable filesystems. If this option is given then "
34928 "swap devices are shown too."
34933 #: ../tools/virt-list-filesystems.pl:191
34935 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34936 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34937 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34942 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34943 msgid "Copyright (C) 2009 Red Hat Inc."
34948 #: ../tools/virt-tar.pl:33
34949 msgid "virt-tar - Extract or upload files to a virtual machine"
34954 #: ../tools/virt-tar.pl:37
34957 " virt-tar [--options] -x domname directory tarball\n"
34963 #: ../tools/virt-tar.pl:39
34966 " virt-tar [--options] -u domname tarball directory\n"
34972 #: ../tools/virt-tar.pl:41
34975 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34981 #: ../tools/virt-tar.pl:43
34984 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34989 #: ../tools/virt-tar.pl:47
34991 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34992 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34997 #: ../tools/virt-tar.pl:52
34998 msgid "Download C</home> from the VM into a local tarball:"
35003 #: ../tools/virt-tar.pl:54
35006 " virt-tar -x domname /home home.tar\n"
35012 #: ../tools/virt-tar.pl:56
35015 " virt-tar -zx domname /home home.tar.gz\n"
35021 #: ../tools/virt-tar.pl:58
35022 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
35027 #: ../tools/virt-tar.pl:60
35030 " virt-tar -u domname uploadstuff.tar /tmp\n"
35036 #: ../tools/virt-tar.pl:62
35039 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
35045 #: ../tools/virt-tar.pl:66
35047 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
35048 "virtual machines. If you do this, you risk disk corruption in the VM. "
35049 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
35054 #: ../tools/virt-tar.pl:71
35056 "You can use C<-x> (extract) on live virtual machines, but you might get "
35057 "inconsistent results or errors if there is filesystem activity inside the "
35058 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
35059 "work, but the only way to guarantee consistent results is if the virtual "
35060 "machine is shut down."
35065 #: ../tools/virt-tar.pl:79
35067 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
35068 "parts of a guest filesystem. There are many possibilities: making backups, "
35069 "uploading data files, snooping on guest activity, fixing or customizing "
35075 #: ../tools/virt-tar.pl:84
35077 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
35078 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
35079 "should look at the L<guestfish(1)> tool."
35084 #: ../tools/virt-tar.pl:88
35086 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
35087 "its contents (recursively) from the virtual machine into a local tarball. "
35088 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
35089 "virtual machine. You cannot use these two options together."
35094 #: ../tools/virt-tar.pl:94
35096 "In addition, you may need to use the C<-z> (gZip) option to enable "
35097 "compression. When uploading, you have to specify C<-z> if the upload file "
35098 "is compressed because virt-tar won't detect this on its own."
35103 #: ../tools/virt-tar.pl:98
35105 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
35106 "example it cannot do PKZip files or bzip2 compression. If you want that "
35107 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
35108 "the L<libguestfs(3)> API)."
35113 #: ../tools/virt-tar.pl:156
35114 msgid "B<-x> | B<--extract> | B<--download>"
35119 #: ../tools/virt-tar.pl:158
35120 msgid "B<-u> | B<--upload>"
35125 #: ../tools/virt-tar.pl:160
35127 "Use C<-x> to extract (download) a directory from a virtual machine to a "
35133 #: ../tools/virt-tar.pl:163
35135 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
35136 "Please read the L</WARNING> section above before using this option."
35141 #: ../tools/virt-tar.pl:167
35142 msgid "You must specify exactly one of these options."
35147 #: ../tools/virt-tar.pl:173
35148 msgid "B<-z> | B<--gzip>"
35153 #: ../tools/virt-tar.pl:175
35154 msgid "Specify that the input or output tarball is gzip-compressed."
35158 #: ../tools/virt-tar.pl:288
35160 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
35161 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
35162 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
35168 #: ../tools/virt-make-fs.pl:37
35169 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
35174 #: ../tools/virt-make-fs.pl:41
35177 " virt-make-fs [--options] input.tar output.img\n"
35183 #: ../tools/virt-make-fs.pl:43
35186 " virt-make-fs [--options] input.tar.gz output.img\n"
35192 #: ../tools/virt-make-fs.pl:45
35195 " virt-make-fs [--options] directory output.img\n"
35201 #: ../tools/virt-make-fs.pl:49
35203 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
35204 "archive or some files in a directory. It is similar to tools like L<mkisofs"
35205 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
35206 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
35207 "you want to attach these filesystems to existing virtual machines (eg. to "
35208 "import large amounts of read-only data to a VM)."
35213 #: ../tools/virt-make-fs.pl:57
35214 msgid "Basic usage is:"
35219 #: ../tools/virt-make-fs.pl:59
35222 " virt-make-fs input output\n"
35228 #: ../tools/virt-make-fs.pl:61
35230 "where C<input> is either a directory containing files that you want to add, "
35231 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
35232 "C<output> is a disk image. The input type is detected automatically. The "
35233 "output disk image defaults to a raw ext2 image unless you specify extra "
35234 "flags (see L</OPTIONS> below)."
35239 #: ../tools/virt-make-fs.pl:67
35240 msgid "EXTRA SPACE"
35245 #: ../tools/virt-make-fs.pl:69
35247 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
35248 "the files that it contains, but might have extra space. Depending on how "
35249 "you are going to use the output, you might think this extra space is wasted "
35250 "and want to minimize it, or you might want to leave space so that more files "
35251 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
35252 "but you can use the C<--size> flag to leave space in the filesystem if you "
35258 #: ../tools/virt-make-fs.pl:77
35260 "An alternative way to leave extra space but not make the output image any "
35261 "bigger is to use an alternative disk image format (instead of the default "
35262 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
35263 "image format (check your hypervisor supports this before using it). This "
35264 "allows you to choose a large C<--size> but the extra space won't actually be "
35265 "allocated in the image until you try to store something in it."
35269 #: ../tools/virt-make-fs.pl:85
35271 "Don't forget that you can also use local commands including L<resize2fs(8)> "
35272 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
35273 "to build another image from scratch."
35278 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
35279 #: ../tools/virt-make-fs.pl:142
35285 #: ../tools/virt-make-fs.pl:91
35288 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
35294 #: ../tools/virt-make-fs.pl:93
35295 msgid "FILESYSTEM TYPE"
35300 #: ../tools/virt-make-fs.pl:95
35302 "The default filesystem type is C<ext2>. Just about any filesystem type that "
35303 "libguestfs supports can be used (but I<not> read-only formats like "
35304 "ISO9660). Here are some of the more common choices:"
35309 #: ../tools/virt-make-fs.pl:101
35315 #: ../tools/virt-make-fs.pl:103
35317 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
35318 "you are not going to use the filesystem in a way that requires the journal, "
35319 "then this is just wasted overhead."
35324 #: ../tools/virt-make-fs.pl:107
35325 msgid "I<ntfs> or I<vfat>"
35330 #: ../tools/virt-make-fs.pl:109
35331 msgid "Useful if exporting data to a Windows guest."
35336 #: ../tools/virt-make-fs.pl:111
35338 "I<Note for vfat>: The tar archive or local directory must only contain files "
35339 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
35340 "program running within libguestfs is unable to change the ownership of non-"
35341 "root files, since vfat itself does not support this."
35346 #: ../tools/virt-make-fs.pl:116
35352 #: ../tools/virt-make-fs.pl:118
35354 "Lower overhead than C<ext2>, but certain limitations on filename length and "
35355 "total filesystem size."
35360 #: ../tools/virt-make-fs.pl:125
35363 " virt-make-fs --type=minix input minixfs.img\n"
35369 #: ../tools/virt-make-fs.pl:127
35370 msgid "TO PARTITION OR NOT TO PARTITION"
35375 #: ../tools/virt-make-fs.pl:129
35376 msgid "Optionally virt-make-fs can add a partition table to the output disk."
35381 #: ../tools/virt-make-fs.pl:131
35383 "Adding a partition can make the disk image more compatible with certain "
35384 "virtualized operating systems which don't expect to see a filesystem "
35385 "directly located on a block device (Linux doesn't care and will happily "
35386 "handle both types)."
35391 #: ../tools/virt-make-fs.pl:136
35393 "On the other hand, if you have a partition table then the output image is no "
35394 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
35395 "directly on a partitioned disk image. (However libguestfs tools such as "
35396 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
35401 #: ../tools/virt-make-fs.pl:144
35402 msgid "Add an MBR partition:"
35407 #: ../tools/virt-make-fs.pl:146
35410 " virt-make-fs --partition -- input disk.img\n"
35416 #: ../tools/virt-make-fs.pl:148
35418 "If the output disk image could be terabyte-sized or larger, it's better to "
35419 "use an EFI/GPT-compatible partition table:"
35424 #: ../tools/virt-make-fs.pl:151
35427 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
35433 #: ../tools/virt-make-fs.pl:179
35434 msgid "Enable debugging information."
35439 #: ../tools/virt-make-fs.pl:185
35440 msgid "B<--size=E<lt>NE<gt>>"
35445 #: ../tools/virt-make-fs.pl:187
35446 msgid "B<--size=+E<lt>NE<gt>>"
35451 #: ../tools/virt-make-fs.pl:189
35452 msgid "B<-s E<lt>NE<gt>>"
35457 #: ../tools/virt-make-fs.pl:191
35458 msgid "B<-s +E<lt>NE<gt>>"
35463 #: ../tools/virt-make-fs.pl:193
35465 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
35470 #: ../tools/virt-make-fs.pl:196
35472 "If this option is I<not> given, then the output image will be just large "
35473 "enough to contain all the files, with not much wasted space."
35478 #: ../tools/virt-make-fs.pl:199
35480 "To choose a fixed size output disk, specify an absolute number followed by b/"
35481 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35482 "Petabytes or Exabytes. This must be large enough to contain all the input "
35483 "files, else you will get an error."
35488 #: ../tools/virt-make-fs.pl:204
35490 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
35491 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35492 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
35493 "the input files, and (approximately) an extra 200 MB free space."
35498 #: ../tools/virt-make-fs.pl:210
35500 "Note that virt-make-fs estimates free space, and therefore will not produce "
35501 "filesystems containing precisely the free space requested. (It is much more "
35502 "expensive and time-consuming to produce a filesystem which has precisely the "
35503 "desired free space)."
35508 #: ../tools/virt-make-fs.pl:219
35509 msgid "B<--format=E<lt>fmtE<gt>>"
35514 #: ../tools/virt-make-fs.pl:221
35515 msgid "B<-F E<lt>fmtE<gt>>"
35520 #: ../tools/virt-make-fs.pl:223
35521 msgid "Choose the output disk image format."
35526 #: ../tools/virt-make-fs.pl:225
35527 msgid "The default is C<raw> (raw disk image)."
35532 #: ../tools/virt-make-fs.pl:227
35534 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
35535 "that would really make sense here is C<qcow2>."
35540 #: ../tools/virt-make-fs.pl:234
35541 msgid "B<--type=E<lt>fsE<gt>>"
35546 #: ../tools/virt-make-fs.pl:236
35547 msgid "B<-t E<lt>fsE<gt>>"
35552 #: ../tools/virt-make-fs.pl:238
35553 msgid "Choose the output filesystem type."
35558 #: ../tools/virt-make-fs.pl:240
35559 msgid "The default is C<ext2>."
35564 #: ../tools/virt-make-fs.pl:242
35566 "Any filesystem which is supported read-write by libguestfs can be used here."
35571 #: ../tools/virt-make-fs.pl:249
35572 msgid "B<--partition>"
35577 #: ../tools/virt-make-fs.pl:251
35578 msgid "B<--partition=E<lt>parttypeE<gt>>"
35583 #: ../tools/virt-make-fs.pl:253
35585 "If specified, this flag adds an MBR partition table to the output disk image."
35590 #: ../tools/virt-make-fs.pl:256
35592 "You can change the partition table type, eg. C<--partition=gpt> for large "
35598 #: ../tools/virt-make-fs.pl:259
35600 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
35601 "might consider the next parameter to be the partition type. For example:"
35606 #: ../tools/virt-make-fs.pl:263
35609 " virt-make-fs --partition input.tar ...\n"
35615 #: ../tools/virt-make-fs.pl:265
35617 "would cause virt-make-fs to think you wanted to use a partition type of "
35618 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
35619 "dash) between options and the input file argument:"
35624 #: ../tools/virt-make-fs.pl:269
35627 " virt-make-fs --partition -- input.tar ...\n"
35632 #: ../tools/virt-make-fs.pl:541
35634 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
35635 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
35636 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
35641 #: ../tools/virt-make-fs.pl:558
35644 " export LIBGUESTFS_DEBUG=1\n"
35645 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
35651 #: ../tools/virt-make-fs.pl:561
35653 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
35659 #: ../tools/virt-list-partitions.pl:32
35661 "virt-list-partitions - List partitions in a virtual machine or disk image"
35666 #: ../tools/virt-list-partitions.pl:36
35669 " virt-list-partitions [--options] domname\n"
35675 #: ../tools/virt-list-partitions.pl:38
35678 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35684 #: ../tools/virt-list-partitions.pl:45
35686 "C<virt-list-partitions> is a command line tool to list the partitions that "
35687 "are contained in a virtual machine or disk image. It is mainly useful as a "
35688 "first step to using L<virt-resize(1)>."
35693 #: ../tools/virt-list-partitions.pl:50
35695 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35696 "functionality. For more complex cases you should look at the L<guestfish(1)"
35702 #: ../tools/virt-list-partitions.pl:107
35703 msgid "B<-h> | B<--human-readable>"
35708 #: ../tools/virt-list-partitions.pl:109
35709 msgid "Show sizes in human-readable form (eg. \"1G\")."
35714 #: ../tools/virt-list-partitions.pl:117
35716 "With this option, C<virt-list-partitions> displays the type and size of each "
35717 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35722 #: ../tools/virt-list-partitions.pl:124
35723 msgid "B<-t> | B<--total>"
35728 #: ../tools/virt-list-partitions.pl:126
35730 "Display the total size of each block device (as a separate row or rows)."
35735 #: ../tools/virt-list-partitions.pl:259
35737 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
35738 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
35739 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35744 #: ../tools/virt-list-partitions.pl:275
35745 msgid "Copyright (C) 2009-2010 Red Hat Inc."