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-01 20:21+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-win-reg.pl:536
957 #: ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548
958 #: ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350
959 #: ../tools/virt-resize.pl:360
965 #: ../src/guestfs.pod:390
967 "The kernel version that the command runs under will be different from what "
973 #: ../src/guestfs.pod:395
975 "If the command needs to communicate with daemons, then most likely they "
981 #: ../src/guestfs.pod:400
982 msgid "The command will be running in limited memory."
987 #: ../src/guestfs.pod:404
989 "The network may not be available unless you enable it (see L</"
990 "guestfs_set_network>)."
995 #: ../src/guestfs.pod:409
996 msgid "Only supports Linux guests (not Windows, BSD, etc)."
1001 #: ../src/guestfs.pod:413
1003 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1008 #: ../src/guestfs.pod:418
1010 "For SELinux guests, you may need to enable SELinux and load policy first. "
1011 "See L</SELINUX> in this manpage."
1016 #: ../src/guestfs.pod:423
1018 "I<Security:> It is not safe to run commands from untrusted, possibly "
1019 "malicious guests. These commands may attempt to exploit your program by "
1020 "sending unexpected output. They could also try to exploit the Linux kernel "
1021 "or qemu provided by the libguestfs appliance. They could use the network "
1022 "provided by the libguestfs appliance to bypass ordinary network partitions "
1023 "and firewalls. They could use the elevated privileges or different SELinux "
1024 "context of your program to their advantage."
1029 #: ../src/guestfs.pod:432
1031 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1032 "(a script which runs when the guest next boots normally), and to have this "
1033 "script run the commands you want in the normal context of the running guest, "
1034 "network security and so on. For information about other security issues, "
1040 #: ../src/guestfs.pod:440
1042 "The two main API calls to run commands are L</guestfs_command> and L</"
1043 "guestfs_sh> (there are also variations)."
1048 #: ../src/guestfs.pod:443
1050 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1051 "shell globs, redirections, etc will work."
1056 #: ../src/guestfs.pod:446
1057 msgid "CONFIGURATION FILES"
1062 #: ../src/guestfs.pod:448
1064 "To read and write configuration files in Linux guest filesystems, we "
1065 "strongly recommend using Augeas. For example, Augeas understands how to "
1066 "read and write, say, a Linux shadow password file or X.org configuration "
1067 "file, and so avoids you having to write that code."
1072 #: ../src/guestfs.pod:453
1074 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1075 "document Augeas itself here because there is excellent documentation on the "
1076 "L<http://augeas.net/> website."
1081 #: ../src/guestfs.pod:457
1083 "If you don't want to use Augeas (you fool!) then try calling L</"
1084 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1090 #: ../src/guestfs.pod:461
1096 #: ../src/guestfs.pod:463
1098 "We support SELinux guests. To ensure that labeling happens correctly in "
1099 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1104 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1105 #: ../src/guestfs.pod:2441
1111 #: ../src/guestfs.pod:471
1112 msgid "Before launching, do:"
1117 #: ../src/guestfs.pod:473
1120 " guestfs_set_selinux (g, 1);\n"
1126 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1127 #: ../src/guestfs.pod:2466
1133 #: ../src/guestfs.pod:477
1135 "After mounting the guest's filesystem(s), load the policy. This is best "
1136 "done by running the L<load_policy(8)> command in the guest itself:"
1141 #: ../src/guestfs.pod:481
1144 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1150 #: ../src/guestfs.pod:483
1152 "(Older versions of C<load_policy> require you to specify the name of the "
1158 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1164 #: ../src/guestfs.pod:488
1166 "Optionally, set the security context for the API. The correct security "
1167 "context to use can only be known by inspecting the guest. As an example:"
1172 #: ../src/guestfs.pod:492
1175 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1181 #: ../src/guestfs.pod:496
1182 msgid "This will work for running commands and editing existing files."
1187 #: ../src/guestfs.pod:498
1189 "When new files are created, you may need to label them explicitly, for "
1190 "example by running the external command C<restorecon pathname>."
1195 #: ../src/guestfs.pod:502
1201 #: ../src/guestfs.pod:504
1203 "Certain calls are affected by the current file mode creation mask (the "
1204 "\"umask\"). In particular ones which create files or directories, such as "
1205 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1206 "either the default mode that the file is created with or modifies the mode "
1212 #: ../src/guestfs.pod:510
1214 "The default umask is C<022>, so files are created with modes such as C<0644> "
1215 "and directories with C<0755>."
1220 #: ../src/guestfs.pod:513
1222 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1223 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1224 "guestfs_chmod> after creating each file or directory."
1229 #: ../src/guestfs.pod:517
1230 msgid "For more information about umask, see L<umask(2)>."
1235 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1236 msgid "ENCRYPTED DISKS"
1241 #: ../src/guestfs.pod:521
1243 "Libguestfs allows you to access Linux guests which have been encrypted using "
1244 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1245 "standard. This includes nearly all whole disk encryption systems used by "
1246 "modern Linux guests."
1251 #: ../src/guestfs.pod:527
1253 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1254 "returns the string C<crypto_LUKS>)."
1259 #: ../src/guestfs.pod:530
1261 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1262 "will require the passphrase!"
1267 #: ../src/guestfs.pod:533
1269 "Opening a LUKS device creates a new device mapper device called C</dev/"
1270 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1271 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1272 "from and encrypted to the underlying block device respectively."
1277 #: ../src/guestfs.pod:539
1279 "LVM volume groups on the device can be made visible by calling L</"
1280 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1281 "(s) can now be mounted in the usual way."
1286 #: ../src/guestfs.pod:543
1288 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1289 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1290 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1291 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1292 "underlying encrypted block device)."
1297 #: ../src/guestfs.pod:550
1302 #: ../src/guestfs.pod:552
1304 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1305 "contains operating systems, an install CD or a live CD. (These APIs used to "
1306 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1307 "version 1.5.3 the most frequently used part of this library has been "
1308 "rewritten in C and moved into the core code)."
1313 #: ../src/guestfs.pod:559
1315 "Add all disks belonging to the unknown virtual machine and call L</"
1316 "guestfs_launch> in the usual way."
1321 #: ../src/guestfs.pod:562
1323 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1324 "and certain heuristics, and returns a list of operating systems that were "
1325 "found. An empty list means none were found. A single element is the root "
1326 "filesystem of the operating system. For dual- or multi-boot guests, "
1327 "multiple roots can be returned, each one corresponding to a separate "
1328 "operating system. (Multi-boot virtual machines are extremely rare in the "
1329 "world of virtualization, but since this scenario can happen, we have built "
1330 "libguestfs to deal with it.)"
1335 #: ../src/guestfs.pod:571
1337 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1338 "to get additional details about that operating system. For example, call L</"
1339 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1340 "Windows and Linux-based operating systems respectively."
1345 #: ../src/guestfs.pod:577
1347 "Un*x-like and Linux-based operating systems usually consist of several "
1348 "filesystems which are mounted at boot time (for example, a separate boot "
1349 "partition mounted on C</boot>). The inspection rules are able to detect how "
1350 "filesystems correspond to mount points. Call "
1351 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1352 "hash table like this example:"
1357 #: ../src/guestfs.pod:584
1360 " /boot => /dev/sda1\n"
1361 " / => /dev/vg_guest/lv_root\n"
1362 " /usr => /dev/vg_guest/lv_usr\n"
1368 #: ../src/guestfs.pod:588
1370 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1371 "filesystems as suggested."
1376 #: ../src/guestfs.pod:591
1378 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1379 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1384 #: ../src/guestfs.pod:595
1386 "Inspection currently only works for some common operating systems. "
1387 "Contributors are welcome to send patches for other operating systems that we "
1388 "currently cannot detect."
1393 #: ../src/guestfs.pod:599
1395 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1396 "for more details. The L</guestfs_inspect_os> function just ignores any "
1397 "encrypted devices."
1402 #: ../src/guestfs.pod:603
1404 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1405 "inspection and caches the results in the guest handle. Subsequent calls to "
1406 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1407 "read the disks. If you change the content of the guest disks, you can redo "
1408 "inspection by calling L</guestfs_inspect_os> again. (L</"
1409 "guestfs_inspect_list_applications> works a little differently from the other "
1410 "calls and does read the disks. See documentation for that function for "
1415 #: ../src/guestfs.pod:612
1416 msgid "INSPECTING INSTALL DISKS"
1420 #: ../src/guestfs.pod:614
1422 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1427 #: ../src/guestfs.pod:617
1429 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1430 "system, which currently can be C<installed> (a regular operating system) or "
1431 "C<installer> (some sort of install disk)."
1435 #: ../src/guestfs.pod:621
1437 "Further information is available about the operating system that can be "
1438 "installed using the regular inspection APIs like L</"
1439 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1443 #: ../src/guestfs.pod:626
1445 "Some additional information specific to installer disks is also available "
1446 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1447 "guestfs_inspect_is_multipart> calls."
1452 #: ../src/guestfs.pod:631
1453 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1458 #: ../src/guestfs.pod:633
1460 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1461 "ntfs-3g.org/> driver."
1466 #: ../src/guestfs.pod:636
1467 msgid "DRIVE LETTERS AND PATHS"
1472 #: ../src/guestfs.pod:638
1474 "DOS and Windows still use drive letters, and the filesystems are always "
1475 "treated as case insensitive by Windows itself, and therefore you might find "
1476 "a Windows configuration file referring to a path like C<c:\\windows"
1477 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1478 "might be referred to as C</WINDOWS/System32>."
1483 #: ../src/guestfs.pod:644
1485 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1486 "libguestfs to read the appropriate Windows Registry and configuration files, "
1487 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1493 #: ../src/guestfs.pod:649
1495 "Replacing backslash characters with forward slash characters is also outside "
1496 "the scope of libguestfs, but something that you can easily do."
1501 #: ../src/guestfs.pod:652
1503 "Where we can help is in resolving the case insensitivity of paths. For "
1504 "this, call L</guestfs_case_sensitive_path>."
1509 #: ../src/guestfs.pod:655
1510 msgid "ACCESSING THE WINDOWS REGISTRY"
1515 #: ../src/guestfs.pod:657
1517 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1518 "files, through the library C<hivex> which is part of the libguestfs project "
1519 "although ships as a separate tarball. You have to locate and download the "
1520 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1521 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1522 "reg(1)> for more help on this issue."
1527 #: ../src/guestfs.pod:665
1528 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1533 #: ../src/guestfs.pod:667
1535 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1536 "provide something which looks like a Linux symlink. The way it tries to do "
1537 "the rewriting is described here:"
1542 #: ../src/guestfs.pod:671
1544 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1550 #: ../src/guestfs.pod:673
1552 "The essential problem is that ntfs-3g simply does not have enough "
1553 "information to do a correct job. NTFS links can contain drive letters and "
1554 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1555 "It is almost certainly the case that libguestfs callers should ignore what "
1556 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1561 #: ../src/guestfs.pod:680
1563 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1564 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1565 "attribute, and read the raw reparse data from that (you can find the format "
1566 "documented in various places around the web)."
1571 #: ../src/guestfs.pod:685
1572 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1577 #: ../src/guestfs.pod:687
1579 "There are other useful extended attributes that can be read from ntfs-3g "
1580 "filesystems (using L</guestfs_getxattr>). See:"
1585 #: ../src/guestfs.pod:690
1587 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1592 #: ../src/guestfs.pod:692
1593 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1598 #: ../src/guestfs.pod:694
1600 "Although we don't want to discourage you from using the C API, we will "
1601 "mention here that the same API is also available in other languages."
1605 #: ../src/guestfs.pod:697
1607 "The API is broadly identical in all supported languages. This means that "
1608 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1609 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1610 "OCaml. In other words, a straightforward, predictable isomorphism between "
1616 #: ../src/guestfs.pod:703
1618 "Error messages are automatically transformed into exceptions if the language "
1624 #: ../src/guestfs.pod:706
1626 "We don't try to \"object orientify\" parts of the API in OO languages, "
1627 "although contributors are welcome to write higher level APIs above what we "
1628 "provide in their favourite languages if they wish."
1633 #: ../src/guestfs.pod:712
1639 #: ../src/guestfs.pod:714
1641 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1642 "identical to the C API. C++ classes and exceptions are not used."
1647 #: ../src/guestfs.pod:718
1653 #: ../src/guestfs.pod:720
1655 "The C# bindings are highly experimental. Please read the warnings at the "
1656 "top of C<csharp/Libguestfs.cs>."
1661 #: ../src/guestfs.pod:723
1667 #: ../src/guestfs.pod:725
1669 "This is the only language binding that is working but incomplete. Only "
1670 "calls which return simple integers have been bound in Haskell, and we are "
1671 "looking for help to complete this binding."
1676 #: ../src/guestfs.pod:729
1682 #: ../src/guestfs.pod:731
1684 "Full documentation is contained in the Javadoc which is distributed with "
1690 #: ../src/guestfs.pod:734
1695 #: ../src/guestfs.pod:736
1696 msgid "See L<guestfs-ocaml(3)>."
1701 #: ../src/guestfs.pod:738
1706 #: ../src/guestfs.pod:740
1707 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1712 #: ../src/guestfs.pod:742
1718 #: ../src/guestfs.pod:744
1720 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1721 "the php-libguestfs package for your distribution."
1726 #: ../src/guestfs.pod:747
1727 msgid "The PHP binding only works correctly on 64 bit machines."
1732 #: ../src/guestfs.pod:749
1737 #: ../src/guestfs.pod:751
1738 msgid "See L<guestfs-python(3)>."
1743 #: ../src/guestfs.pod:753
1748 #: ../src/guestfs.pod:755
1749 msgid "See L<guestfs-ruby(3)>."
1754 #: ../src/guestfs.pod:757
1755 msgid "B<shell scripts>"
1759 #: ../src/guestfs.pod:759
1760 msgid "See L<guestfish(1)>."
1765 #: ../src/guestfs.pod:763
1766 msgid "LIBGUESTFS GOTCHAS"
1771 #: ../src/guestfs.pod:765
1773 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1774 "system [...] that works in the way it is documented but is counterintuitive "
1775 "and almost invites mistakes.\""
1780 #: ../src/guestfs.pod:769
1782 "Since we developed libguestfs and the associated tools, there are several "
1783 "things we would have designed differently, but are now stuck with for "
1784 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1785 "release, you can expect these to change. Beware of them."
1790 #: ../src/guestfs.pod:777
1791 msgid "Autosync / forgetting to sync."
1796 #: ../src/guestfs.pod:779
1798 "When modifying a filesystem from C or another language, you B<must> unmount "
1799 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1800 "libguestfs handle. You can also call:"
1805 #: ../src/guestfs.pod:783
1808 " guestfs_set_autosync (g, 1);\n"
1814 #: ../src/guestfs.pod:785
1816 "to have the unmount/sync done automatically for you when the handle 'g' is "
1817 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1822 #: ../src/guestfs.pod:789
1824 "If you forget to do this, then it is entirely possible that your changes "
1825 "won't be written out, or will be partially written, or (very rarely) that "
1826 "you'll get disk corruption."
1831 #: ../src/guestfs.pod:793
1833 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1834 "guestfish scripts that forget to sync will work just fine, which can make "
1835 "this very puzzling if you are trying to debug a problem."
1840 #: ../src/guestfs.pod:797
1842 "Update: Autosync is enabled by default for all API users starting from "
1843 "libguestfs 1.5.24."
1848 #: ../src/guestfs.pod:800
1849 msgid "Mount option C<-o sync> should not be the default."
1854 #: ../src/guestfs.pod:802
1856 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1857 "However C<-o sync> does not add any reliability benefit, but does have a "
1858 "very large performance impact."
1863 #: ../src/guestfs.pod:806
1865 "The work around is to use L</guestfs_mount_options> and set the mount "
1866 "options that you actually want to use."
1871 #: ../src/guestfs.pod:809
1872 msgid "Read-only should be the default."
1877 #: ../src/guestfs.pod:811
1879 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1880 "specify I<--rw> if you want to make changes to the image."
1885 #: ../src/guestfs.pod:814
1886 msgid "This would reduce the potential to corrupt live VM images."
1891 #: ../src/guestfs.pod:816
1893 "Note that many filesystems change the disk when you just mount and unmount, "
1894 "even if you didn't perform any writes. You need to use L</"
1895 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1900 #: ../src/guestfs.pod:820
1901 msgid "guestfish command line is hard to use."
1906 #: ../src/guestfs.pod:822
1908 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1909 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1910 "exist, so it fails. In earlier versions of guestfish the error message was "
1911 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1912 "we should have used C<guestfish -c command> to run commands."
1917 #: ../src/guestfs.pod:829
1918 msgid "guestfish megabyte modifiers don't work right on all commands"
1923 #: ../src/guestfs.pod:831
1925 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1926 "other modifiers). What guestfish actually does is to multiply the number "
1927 "part by the modifier part and pass the result to the C API. However this "
1928 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1929 "expecting some other unit (eg. megabytes)."
1934 #: ../src/guestfs.pod:838
1935 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1940 #: ../src/guestfs.pod:840
1943 " lvcreate LV VG 100M\n"
1949 #: ../src/guestfs.pod:842
1951 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1952 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1953 "megabytes * megabytes) logical volume. The error message you get from this "
1954 "is also a little obscure."
1959 #: ../src/guestfs.pod:847
1961 "This could be fixed in the generator by specially marking parameters and "
1962 "return values which take bytes or other units."
1967 #: ../src/guestfs.pod:850
1968 msgid "Ambiguity between devices and paths"
1973 #: ../src/guestfs.pod:852
1975 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1976 "sdb2>) and a similar pathname. A file might just happen to be called "
1977 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1982 #: ../src/guestfs.pod:857
1984 "In the current API we usually resolve this ambiguity by having two separate "
1985 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1986 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1987 "detecting if the path supplied begins with C</dev/>."
1992 #: ../src/guestfs.pod:863
1994 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1995 "make paths/devices into structured names. One way to do this would be to "
1996 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1997 "aspect of grub. Another way would be to use a structured type, equivalent "
1998 "to this OCaml type:"
2003 #: ../src/guestfs.pod:869
2006 " type path = Path of string | Device of int | Partition of int * int\n"
2012 #: ../src/guestfs.pod:871
2013 msgid "which would allow you to pass arguments like:"
2018 #: ../src/guestfs.pod:873
2021 " Path \"/foo/bar\"\n"
2022 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2023 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2024 " Path \"/dev/sdb2\" (* not a device *)\n"
2030 #: ../src/guestfs.pod:878
2032 "As you can see there are still problems to resolve even with this "
2033 "representation. Also consider how it might work in guestfish."
2038 #: ../src/guestfs.pod:883
2039 msgid "PROTOCOL LIMITS"
2044 #: ../src/guestfs.pod:885
2046 "Internally libguestfs uses a message-based protocol to pass API calls and "
2047 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2048 "plenty more detail about this). The maximum message size used by the "
2049 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2050 "aware of this limit. The API calls which may be affected are individually "
2051 "documented, with a link back to this section of the documentation."
2056 #: ../src/guestfs.pod:893
2058 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2059 "a simple string. Because this string is at some point internally encoded as "
2060 "a message, the maximum size that it can return is slightly under 4 MB. If "
2061 "the requested file is larger than this then you will get an error."
2066 #: ../src/guestfs.pod:899
2068 "In order to transfer large files into and out of the guest filesystem, you "
2069 "need to use particular calls that support this. The sections L</UPLOADING> "
2070 "and L</DOWNLOADING> document how to do this."
2075 #: ../src/guestfs.pod:903
2077 "You might also consider mounting the disk image using our FUSE filesystem "
2078 "support (L<guestmount(1)>)."
2083 #: ../src/guestfs.pod:906
2084 msgid "KEYS AND PASSPHRASES"
2089 #: ../src/guestfs.pod:908
2091 "Certain libguestfs calls take a parameter that contains sensitive key "
2092 "material, passed in as a C string."
2097 #: ../src/guestfs.pod:911
2099 "In the future we would hope to change the libguestfs implementation so that "
2100 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2101 "swap. However this is I<not> done at the moment, because of the complexity "
2102 "of such an implementation."
2107 #: ../src/guestfs.pod:916
2109 "Therefore you should be aware that any key parameter you pass to libguestfs "
2110 "might end up being written out to the swap partition. If this is a concern, "
2111 "scrub the swap partition or don't use libguestfs on encrypted devices."
2116 #: ../src/guestfs.pod:921
2117 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2122 #: ../src/guestfs.pod:923
2124 "All high-level libguestfs actions are synchronous. If you want to use "
2125 "libguestfs asynchronously then you must create a thread."
2130 #: ../src/guestfs.pod:926
2132 "Only use the handle from a single thread. Either use the handle exclusively "
2133 "from one thread, or provide your own mutex so that two threads cannot issue "
2134 "calls on the same handle at the same time."
2139 #: ../src/guestfs.pod:930
2141 "See the graphical program guestfs-browser for one possible architecture for "
2142 "multithreaded programs using libvirt and libguestfs."
2147 #: ../src/guestfs.pod:933
2152 #: ../src/guestfs.pod:935
2154 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2160 #: ../src/guestfs.pod:938
2162 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2163 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2168 #: ../src/guestfs.pod:941
2170 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2171 "to change the directories that libguestfs will search in. The value is a "
2172 "colon-separated list of paths. The current directory is I<not> searched "
2173 "unless the path contains an empty element or C<.>. For example "
2174 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2175 "then C</usr/lib/guestfs>."
2180 #: ../src/guestfs.pod:948
2181 msgid "QEMU WRAPPERS"
2186 #: ../src/guestfs.pod:950
2188 "If you want to compile your own qemu, run qemu from a non-standard location, "
2189 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2195 #: ../src/guestfs.pod:954
2197 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2198 "last command in the shell script (so that qemu replaces the shell and "
2199 "becomes the direct child of the libguestfs-using program). If you don't do "
2200 "this, then the qemu process won't be cleaned up correctly."
2205 #: ../src/guestfs.pod:959
2207 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2213 #: ../src/guestfs.pod:962
2217 " qemudir=/home/rjones/d/qemu\n"
2218 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2224 #: ../src/guestfs.pod:966
2226 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2227 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2233 #: ../src/guestfs.pod:970
2236 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2242 #: ../src/guestfs.pod:972
2244 "Note that libguestfs also calls qemu with the -help and -version options in "
2245 "order to determine features."
2249 #: ../src/guestfs.pod:975
2250 msgid "ATTACHING TO RUNNING DAEMONS"
2254 #: ../src/guestfs.pod:977
2256 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2257 "babies. Use with caution."
2261 #: ../src/guestfs.pod:980
2263 "I<Note (2):> This section explains how to attach to a running daemon from a "
2264 "low level perspective. For most users, simply using virt tools such as "
2265 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2269 #: ../src/guestfs.pod:984
2270 msgid "Using guestfs_set_attach_method"
2274 #: ../src/guestfs.pod:986
2276 "By calling L</guestfs_set_attach_method> you can change how the library "
2277 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2278 "ARCHITECTURE> for some background)."
2282 #: ../src/guestfs.pod:990
2284 "The normal attach method is C<appliance>, where a small appliance is created "
2285 "containing the daemon, and then the library connects to this."
2289 #: ../src/guestfs.pod:993
2291 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2292 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2293 "daemon over the Unix domain socket."
2297 #: ../src/guestfs.pod:997
2299 "The normal use for this is to connect to a running virtual machine that "
2300 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2301 "files inside the live virtual machine."
2305 #: ../src/guestfs.pod:1001
2306 msgid "Using guestfs_add_domain with live flag"
2310 #: ../src/guestfs.pod:1003
2312 "L</guestfs_add_domain> provides some help for getting the correct attach "
2313 "method. If you pass the C<live> option to this function, then (if the "
2314 "virtual machine is running) it will examine the libvirt XML looking for a "
2315 "virtio-serial channel to connect to:"
2319 #: ../src/guestfs.pod:1009
2326 " <channel type='unix'>\n"
2327 " <source mode='bind' path='/path/to/socket'/>\n"
2328 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2337 #: ../src/guestfs.pod:1021
2339 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2340 "method to C<unix:/path/to/socket>."
2344 #: ../src/guestfs.pod:1024
2346 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2347 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2348 "to attach to and modify live virtual machines."
2352 #: ../src/guestfs.pod:1028
2354 "The virtual machine needs to have been set up beforehand so that it has the "
2355 "virtio-serial channel and so that guestfsd is running inside it."
2360 #: ../src/guestfs.pod:1032
2361 msgid "ABI GUARANTEE"
2366 #: ../src/guestfs.pod:1034
2368 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2369 "actions as outlined in this section. Although we will deprecate some "
2370 "actions, for example if they get replaced by newer calls, we will keep the "
2371 "old actions forever. This allows you the developer to program in confidence "
2372 "against the libguestfs API."
2377 #: ../src/guestfs.pod:1040
2378 msgid "BLOCK DEVICE NAMING"
2383 #: ../src/guestfs.pod:1042
2385 "In the kernel there is now quite a profusion of schemata for naming block "
2386 "devices (in this context, by I<block device> I mean a physical or virtual "
2387 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2388 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2389 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2390 "for the old IDE driver (particularly for SATA devices) those devices also "
2391 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2392 "paravirtualized drivers. This has created several different naming systems, "
2393 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2398 #: ../src/guestfs.pod:1054
2400 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2401 "Linux kernel to access block devices. We can run a variety of appliances "
2402 "based on a variety of Linux kernels."
2407 #: ../src/guestfs.pod:1058
2409 "This causes a problem for libguestfs because many API calls use device or "
2410 "partition names. Working scripts and the recipe (example) scripts that we "
2411 "make available over the internet could fail if the naming scheme changes."
2416 #: ../src/guestfs.pod:1063
2418 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2419 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2420 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2421 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2426 #: ../src/guestfs.pod:1069
2428 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2429 "L</guestfs_list_partitions> and similar calls return the true names of the "
2430 "devices and partitions as known to the appliance."
2435 #: ../src/guestfs.pod:1074
2436 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2441 #: ../src/guestfs.pod:1076
2443 "Usually this translation is transparent. However in some (very rare) cases "
2444 "you may need to know the exact algorithm. Such cases include where you use "
2445 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2446 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2451 #: ../src/guestfs.pod:1082
2453 "The algorithm is applied only to I<parameters> which are known to be either "
2454 "device or partition names. Return values from functions such as L</"
2455 "guestfs_list_devices> are never changed."
2460 #: ../src/guestfs.pod:1090
2461 msgid "Is the string a parameter which is a device or partition name?"
2466 #: ../src/guestfs.pod:1094
2467 msgid "Does the string begin with C</dev/sd>?"
2472 #: ../src/guestfs.pod:1098
2474 "Does the named device exist? If so, we use that device. However if I<not> "
2475 "then we continue with this algorithm."
2480 #: ../src/guestfs.pod:1103
2481 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2486 #: ../src/guestfs.pod:1105
2487 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2492 #: ../src/guestfs.pod:1107
2493 msgid "If that named device exists, use it. If not, continue."
2498 #: ../src/guestfs.pod:1111
2499 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2504 #: ../src/guestfs.pod:1113
2505 msgid "If that named device exists, use it. If not, return an error."
2510 #: ../src/guestfs.pod:1117
2511 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2516 #: ../src/guestfs.pod:1119
2518 "Although the standard naming scheme and automatic translation is useful for "
2519 "simple programs and guestfish scripts, for larger programs it is best not to "
2520 "rely on this mechanism."
2525 #: ../src/guestfs.pod:1123
2527 "Where possible for maximum future portability programs using libguestfs "
2528 "should use these future-proof techniques:"
2533 #: ../src/guestfs.pod:1130
2535 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2536 "device names, and then use those names directly."
2541 #: ../src/guestfs.pod:1133
2543 "Since those device names exist by definition, they will never be translated."
2548 #: ../src/guestfs.pod:1138
2550 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2551 "filesystem labels."
2556 #: ../src/guestfs.pod:1143
2562 #: ../src/guestfs.pod:1145
2564 "This section discusses security implications of using libguestfs, "
2565 "particularly with untrusted or malicious guests or disk images."
2570 #: ../src/guestfs.pod:1148
2571 msgid "GENERAL SECURITY CONSIDERATIONS"
2576 #: ../src/guestfs.pod:1150
2578 "Be careful with any files or data that you download from a guest (by "
2579 "\"download\" we mean not just the L</guestfs_download> command but any "
2580 "command that reads files, filenames, directories or anything else from a "
2581 "disk image). An attacker could manipulate the data to fool your program "
2582 "into doing the wrong thing. Consider cases such as:"
2587 #: ../src/guestfs.pod:1160
2588 msgid "the data (file etc) not being present"
2593 #: ../src/guestfs.pod:1164
2594 msgid "being present but empty"
2599 #: ../src/guestfs.pod:1168
2600 msgid "being much larger than normal"
2605 #: ../src/guestfs.pod:1172
2606 msgid "containing arbitrary 8 bit data"
2611 #: ../src/guestfs.pod:1176
2612 msgid "being in an unexpected character encoding"
2617 #: ../src/guestfs.pod:1180
2618 msgid "containing homoglyphs."
2623 #: ../src/guestfs.pod:1184
2624 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2629 #: ../src/guestfs.pod:1186
2631 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2632 "(VFS) module can sometimes be escalated into exploits by deliberately "
2633 "creating a malicious, malformed filesystem. These exploits are very severe "
2634 "for two reasons. Firstly there are very many filesystem drivers in the "
2635 "kernel, and many of them are infrequently used and not much developer "
2636 "attention has been paid to the code. Linux userspace helps potential "
2637 "crackers by detecting the filesystem type and automatically choosing the "
2638 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2639 "the administrator. Secondly, a kernel-level exploit is like a local root "
2640 "exploit (worse in some ways), giving immediate and total access to the "
2641 "system right down to the hardware level."
2646 #: ../src/guestfs.pod:1199
2648 "That explains why you should never mount a filesystem from an untrusted "
2649 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2650 "inside a qemu virtual machine, usually running as a non-root user. The "
2651 "attacker would need to write a filesystem which first exploited the kernel, "
2652 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2653 "the libguestfs protocol, and finally to be as serious as the host kernel "
2654 "exploit it would need to escalate its privileges to root. This multi-step "
2655 "escalation, performed by a static piece of data, is thought to be extremely "
2656 "hard to do, although we never say 'never' about security issues."
2661 #: ../src/guestfs.pod:1210
2663 "In any case callers can reduce the attack surface by forcing the filesystem "
2664 "type when mounting (use L</guestfs_mount_vfs>)."
2669 #: ../src/guestfs.pod:1213
2670 msgid "PROTOCOL SECURITY"
2675 #: ../src/guestfs.pod:1215
2677 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2678 "defined upper message size. However a program that uses libguestfs must "
2679 "also take care - for example you can write a program that downloads a binary "
2680 "from a disk image and executes it locally, and no amount of protocol "
2681 "security will save you from the consequences."
2686 #: ../src/guestfs.pod:1221
2687 msgid "INSPECTION SECURITY"
2692 #: ../src/guestfs.pod:1223
2694 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2695 "directly from the guest, and these could contain any 8 bit data. Callers "
2696 "should be careful to escape these before printing them to a structured file "
2697 "(for example, use HTML escaping if creating a web page)."
2702 #: ../src/guestfs.pod:1229
2704 "Guest configuration may be altered in unusual ways by the administrator of "
2705 "the virtual machine, and may not reflect reality (particularly for untrusted "
2706 "or actively malicious guests). For example we parse the hostname from "
2707 "configuration files like C</etc/sysconfig/network> that we find in the "
2708 "guest, but the guest administrator can easily manipulate these files to "
2709 "provide the wrong hostname."
2714 #: ../src/guestfs.pod:1237
2716 "The inspection API parses guest configuration using two external libraries: "
2717 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2718 "designed to be robust in the face of malicious data, although denial of "
2719 "service attacks are still possible, for example with oversized configuration "
2725 #: ../src/guestfs.pod:1243
2726 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2731 #: ../src/guestfs.pod:1245
2733 "Be very cautious about running commands from the guest. By running a "
2734 "command in the guest, you are giving CPU time to a binary that you do not "
2735 "control, under the same user account as the library, albeit wrapped in qemu "
2736 "virtualization. More information and alternatives can be found in the "
2737 "section L</RUNNING COMMANDS>."
2742 #: ../src/guestfs.pod:1251
2743 msgid "CVE-2010-3851"
2748 #: ../src/guestfs.pod:1253
2749 msgid "https://bugzilla.redhat.com/642934"
2754 #: ../src/guestfs.pod:1255
2756 "This security bug concerns the automatic disk format detection that qemu "
2757 "does on disk images."
2762 #: ../src/guestfs.pod:1258
2764 "A raw disk image is just the raw bytes, there is no header. Other disk "
2765 "images like qcow2 contain a special header. Qemu deals with this by looking "
2766 "for one of the known headers, and if none is found then assuming the disk "
2767 "image must be raw."
2772 #: ../src/guestfs.pod:1263
2774 "This allows a guest which has been given a raw disk image to write some "
2775 "other header. At next boot (or when the disk image is accessed by "
2776 "libguestfs) qemu would do autodetection and think the disk image format was, "
2777 "say, qcow2 based on the header written by the guest."
2782 #: ../src/guestfs.pod:1268
2784 "This in itself would not be a problem, but qcow2 offers many features, one "
2785 "of which is to allow a disk image to refer to another image (called the "
2786 "\"backing disk\"). It does this by placing the path to the backing disk "
2787 "into the qcow2 header. This path is not validated and could point to any "
2788 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2789 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2790 "control of the attacker."
2795 #: ../src/guestfs.pod:1276
2797 "In libguestfs this is rather hard to exploit except under two circumstances:"
2802 #: ../src/guestfs.pod:1283
2803 msgid "You have enabled the network or have opened the disk in write mode."
2808 #: ../src/guestfs.pod:1287
2810 "You are also running untrusted code from the guest (see L</RUNNING "
2816 #: ../src/guestfs.pod:1292
2818 "The way to avoid this is to specify the expected disk format when adding "
2819 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2820 "should always do this if the disk is raw format, and it's a good idea for "
2826 #: ../src/guestfs.pod:1297
2828 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2829 "format is fetched from libvirt and passed through."
2834 #: ../src/guestfs.pod:1300
2836 "For libguestfs tools, use the I<--format> command line parameter as "
2842 #: ../src/guestfs.pod:1303
2843 msgid "CONNECTION MANAGEMENT"
2848 #: ../src/guestfs.pod:1305
2854 #: ../src/guestfs.pod:1307
2856 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2857 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2858 "handle and release all resources used."
2863 #: ../src/guestfs.pod:1311
2865 "For information on using multiple handles and threads, see the section L</"
2866 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2871 #: ../src/guestfs.pod:1314
2872 msgid "guestfs_create"
2877 #: ../src/guestfs.pod:1316
2880 " guestfs_h *guestfs_create (void);\n"
2886 #: ../src/guestfs.pod:1318
2887 msgid "Create a connection handle."
2892 #: ../src/guestfs.pod:1320
2894 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2895 "on the handle at least once."
2900 #: ../src/guestfs.pod:1323
2902 "This function returns a non-NULL pointer to a handle on success or NULL on "
2908 #: ../src/guestfs.pod:1326
2909 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2914 #: ../src/guestfs.pod:1328
2916 "You may also want to configure error handling for the handle. See L</ERROR "
2917 "HANDLING> section below."
2922 #: ../src/guestfs.pod:1331
2923 msgid "guestfs_close"
2928 #: ../src/guestfs.pod:1333
2931 " void guestfs_close (guestfs_h *g);\n"
2937 #: ../src/guestfs.pod:1335
2938 msgid "This closes the connection handle and frees up all resources used."
2943 #: ../src/guestfs.pod:1337
2944 msgid "ERROR HANDLING"
2949 #: ../src/guestfs.pod:1339
2951 "API functions can return errors. For example, almost all functions that "
2952 "return C<int> will return C<-1> to indicate an error."
2957 #: ../src/guestfs.pod:1342
2959 "Additional information is available for errors: an error message string and "
2960 "optionally an error number (errno) if the thing that failed was a system "
2966 #: ../src/guestfs.pod:1346
2968 "You can get at the additional information about the last error on the handle "
2969 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2970 "up an error handler with L</guestfs_set_error_handler>."
2975 #: ../src/guestfs.pod:1351
2977 "When the handle is created, a default error handler is installed which "
2978 "prints the error message string to C<stderr>. For small short-running "
2979 "command line programs it is sufficient to do:"
2984 #: ../src/guestfs.pod:1355
2987 " if (guestfs_launch (g) == -1)\n"
2988 " exit (EXIT_FAILURE);\n"
2994 #: ../src/guestfs.pod:1358
2996 "since the default error handler will ensure that an error message has been "
2997 "printed to C<stderr> before the program exits."
3002 #: ../src/guestfs.pod:1361
3004 "For other programs the caller will almost certainly want to install an "
3005 "alternate error handler or do error handling in-line like this:"
3010 #: ../src/guestfs.pod:1364
3013 " g = guestfs_create ();\n"
3019 #: ../src/guestfs.pod:1366
3022 " /* This disables the default behaviour of printing errors\n"
3024 " guestfs_set_error_handler (g, NULL, NULL);\n"
3030 #: ../src/guestfs.pod:1370
3033 " if (guestfs_launch (g) == -1) {\n"
3034 " /* Examine the error message and print it etc. */\n"
3035 " char *msg = guestfs_last_error (g);\n"
3036 " int errnum = guestfs_last_errno (g);\n"
3037 " fprintf (stderr, \"%s\\n\", msg);\n"
3045 #: ../src/guestfs.pod:1378
3047 "Out of memory errors are handled differently. The default action is to call "
3048 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3049 "guestfs_set_out_of_memory_handler>."
3054 #: ../src/guestfs.pod:1382
3056 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3057 "because there is no handle if this happens there is no way to get additional "
3058 "error information. However L</guestfs_create> is supposed to be a "
3059 "lightweight operation which can only fail because of insufficient memory (it "
3060 "returns NULL in this case)."
3065 #: ../src/guestfs.pod:1388
3066 msgid "guestfs_last_error"
3071 #: ../src/guestfs.pod:1390
3074 " const char *guestfs_last_error (guestfs_h *g);\n"
3080 #: ../src/guestfs.pod:1392
3082 "This returns the last error message that happened on C<g>. If there has not "
3083 "been an error since the handle was created, then this returns C<NULL>."
3088 #: ../src/guestfs.pod:1396
3090 "The lifetime of the returned string is until the next error occurs, or L</"
3091 "guestfs_close> is called."
3096 #: ../src/guestfs.pod:1399
3097 msgid "guestfs_last_errno"
3102 #: ../src/guestfs.pod:1401
3105 " int guestfs_last_errno (guestfs_h *g);\n"
3111 #: ../src/guestfs.pod:1403
3112 msgid "This returns the last error number (errno) that happened on C<g>."
3117 #: ../src/guestfs.pod:1405
3118 msgid "If successful, an errno integer not equal to zero is returned."
3123 #: ../src/guestfs.pod:1407
3125 "If no error, this returns 0. This call can return 0 in three situations:"
3130 #: ../src/guestfs.pod:1414
3131 msgid "There has not been any error on the handle."
3136 #: ../src/guestfs.pod:1418
3138 "There has been an error but the errno was meaningless. This corresponds to "
3139 "the case where the error did not come from a failed system call, but for "
3140 "some other reason."
3145 #: ../src/guestfs.pod:1424
3147 "There was an error from a failed system call, but for some reason the errno "
3148 "was not captured and returned. This usually indicates a bug in libguestfs."
3153 #: ../src/guestfs.pod:1430
3155 "Libguestfs tries to convert the errno from inside the applicance into a "
3156 "corresponding errno for the caller (not entirely trivial: the appliance "
3157 "might be running a completely different operating system from the library "
3158 "and error numbers are not standardized across Un*xen). If this could not be "
3159 "done, then the error is translated to C<EINVAL>. In practice this should "
3160 "only happen in very rare circumstances."
3165 #: ../src/guestfs.pod:1438
3166 msgid "guestfs_set_error_handler"
3171 #: ../src/guestfs.pod:1440
3174 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3176 " const char *msg);\n"
3177 " void guestfs_set_error_handler (guestfs_h *g,\n"
3178 " guestfs_error_handler_cb cb,\n"
3185 #: ../src/guestfs.pod:1447
3187 "The callback C<cb> will be called if there is an error. The parameters "
3188 "passed to the callback are an opaque data pointer and the error message "
3194 #: ../src/guestfs.pod:1451
3196 "C<errno> is not passed to the callback. To get that the callback must call "
3197 "L</guestfs_last_errno>."
3202 #: ../src/guestfs.pod:1454
3204 "Note that the message string C<msg> is freed as soon as the callback "
3205 "function returns, so if you want to stash it somewhere you must make your "
3211 #: ../src/guestfs.pod:1458
3212 msgid "The default handler prints messages on C<stderr>."
3217 #: ../src/guestfs.pod:1460
3218 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3223 #: ../src/guestfs.pod:1462
3224 msgid "guestfs_get_error_handler"
3229 #: ../src/guestfs.pod:1464
3232 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3233 " void **opaque_rtn);\n"
3239 #: ../src/guestfs.pod:1467
3240 msgid "Returns the current error handler callback."
3245 #: ../src/guestfs.pod:1469
3246 msgid "guestfs_set_out_of_memory_handler"
3251 #: ../src/guestfs.pod:1471
3254 " typedef void (*guestfs_abort_cb) (void);\n"
3255 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3256 " guestfs_abort_cb);\n"
3262 #: ../src/guestfs.pod:1475
3264 "The callback C<cb> will be called if there is an out of memory situation. "
3265 "I<Note this callback must not return>."
3270 #: ../src/guestfs.pod:1478
3271 msgid "The default is to call L<abort(3)>."
3276 #: ../src/guestfs.pod:1480
3278 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3283 #: ../src/guestfs.pod:1483
3284 msgid "guestfs_get_out_of_memory_handler"
3289 #: ../src/guestfs.pod:1485
3292 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3298 #: ../src/guestfs.pod:1487
3299 msgid "This returns the current out of memory handler."
3304 #: ../src/guestfs.pod:1489
3310 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
3316 #: ../src/guestfs.pod:1493
3322 #: ../src/guestfs.pod:1495
3328 #: ../src/guestfs.pod:1497
3329 msgid "AVAILABILITY"
3334 #: ../src/guestfs.pod:1499
3335 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3340 #: ../src/guestfs.pod:1501
3342 "Using L</guestfs_available> you can test availability of the following "
3343 "groups of functions. This test queries the appliance to see if the "
3344 "appliance you are currently using supports the functionality."
3349 #: ../src/guestfs.pod:1506
3350 msgid "@AVAILABILITY@"
3355 #: ../src/guestfs.pod:1508
3356 msgid "GUESTFISH supported COMMAND"
3361 #: ../src/guestfs.pod:1510
3363 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3364 "prints out the available groups and whether they are supported by this build "
3365 "of libguestfs. Note however that you have to do C<run> first."
3370 #: ../src/guestfs.pod:1515
3371 msgid "SINGLE CALLS AT COMPILE TIME"
3376 #: ../src/guestfs.pod:1517
3378 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3379 "function, such as:"
3384 #: ../src/guestfs.pod:1520
3387 " #define LIBGUESTFS_HAVE_DD 1\n"
3393 #: ../src/guestfs.pod:1522
3394 msgid "if L</guestfs_dd> is available."
3399 #: ../src/guestfs.pod:1524
3401 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3402 "function is available at compile time, we recommended using build tools such "
3403 "as autoconf or cmake. For example in autotools you could use:"
3408 #: ../src/guestfs.pod:1529
3411 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3412 " AC_CHECK_FUNCS([guestfs_dd])\n"
3418 #: ../src/guestfs.pod:1532
3420 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3426 #: ../src/guestfs.pod:1535
3427 msgid "SINGLE CALLS AT RUN TIME"
3432 #: ../src/guestfs.pod:1537
3434 "Testing at compile time doesn't guarantee that a function really exists in "
3435 "the library. The reason is that you might be dynamically linked against a "
3436 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3437 "This situation unfortunately results in a segmentation fault, which is a "
3438 "shortcoming of the C dynamic linking system itself."
3443 #: ../src/guestfs.pod:1544
3445 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3446 "in this example program (note that you still need the compile time check as "
3452 #: ../src/guestfs.pod:1548
3455 " #include <stdio.h>\n"
3456 " #include <stdlib.h>\n"
3457 " #include <unistd.h>\n"
3458 " #include <dlfcn.h>\n"
3459 " #include <guestfs.h>\n"
3465 #: ../src/guestfs.pod:1554
3470 " #ifdef LIBGUESTFS_HAVE_DD\n"
3472 " int has_function;\n"
3478 #: ../src/guestfs.pod:1560
3481 " /* Test if the function guestfs_dd is really available. */\n"
3482 " dl = dlopen (NULL, RTLD_LAZY);\n"
3484 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3485 " exit (EXIT_FAILURE);\n"
3487 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3494 #: ../src/guestfs.pod:1569
3497 " if (!has_function)\n"
3498 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3500 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3501 " /* Now it's safe to call\n"
3502 " guestfs_dd (g, \"foo\", \"bar\");\n"
3506 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3514 #: ../src/guestfs.pod:1582
3516 "You may think the above is an awful lot of hassle, and it is. There are "
3517 "other ways outside of the C linking system to ensure that this kind of "
3518 "incompatibility never arises, such as using package versioning:"
3523 #: ../src/guestfs.pod:1587
3526 " Requires: libguestfs >= 1.0.80\n"
3532 #: ../src/guestfs.pod:1589
3533 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3538 #: ../src/guestfs.pod:1591
3540 "A recent feature of the API is the introduction of calls which take optional "
3541 "arguments. In C these are declared 3 ways. The main way is as a call which "
3542 "takes variable arguments (ie. C<...>), as in this example:"
3547 #: ../src/guestfs.pod:1596
3550 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3556 #: ../src/guestfs.pod:1598
3558 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3559 "call with no optional arguments specified:"
3564 #: ../src/guestfs.pod:1601
3567 " guestfs_add_drive_opts (g, filename, -1);\n"
3573 #: ../src/guestfs.pod:1603
3574 msgid "With a single optional argument:"
3579 #: ../src/guestfs.pod:1605
3582 " guestfs_add_drive_opts (g, filename,\n"
3583 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3590 #: ../src/guestfs.pod:1609
3596 #: ../src/guestfs.pod:1611
3599 " guestfs_add_drive_opts (g, filename,\n"
3600 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3601 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3608 #: ../src/guestfs.pod:1616
3610 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3616 #: ../src/guestfs.pod:1619
3617 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3622 #: ../src/guestfs.pod:1621
3624 "The second variant has the same name with the suffix C<_va>, which works the "
3625 "same way but takes a C<va_list>. See the C manual for details. For the "
3626 "example function, this is declared:"
3631 #: ../src/guestfs.pod:1625
3634 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3641 #: ../src/guestfs.pod:1628
3642 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3647 #: ../src/guestfs.pod:1630
3649 "The third variant is useful where you need to construct these calls. You "
3650 "pass in a structure where you fill in the optional fields. The structure "
3651 "has a bitmask as the first element which you must set to indicate which "
3652 "fields you have filled in. For our example function the structure and call "
3658 #: ../src/guestfs.pod:1636
3661 " struct guestfs_add_drive_opts_argv {\n"
3662 " uint64_t bitmask;\n"
3664 " const char *format;\n"
3667 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3668 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3674 #: ../src/guestfs.pod:1645
3675 msgid "You could call it like this:"
3680 #: ../src/guestfs.pod:1647
3683 " struct guestfs_add_drive_opts_argv optargs = {\n"
3684 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3685 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3687 " .format = \"qcow2\"\n"
3694 #: ../src/guestfs.pod:1654
3697 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3703 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3704 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3705 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3711 #: ../src/guestfs.pod:1662
3712 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3717 #: ../src/guestfs.pod:1667
3718 msgid "You do not need to fill in all fields of the structure."
3723 #: ../src/guestfs.pod:1671
3725 "There must be a one-to-one correspondence between fields of the structure "
3726 "that are filled in, and bits set in the bitmask."
3731 #: ../src/guestfs.pod:1676
3732 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3737 #: ../src/guestfs.pod:1678
3739 "In other languages, optional arguments are expressed in the way that is "
3740 "natural for that language. We refer you to the language-specific "
3741 "documentation for more details on that."
3746 #: ../src/guestfs.pod:1682
3747 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3752 #: ../src/guestfs.pod:1684
3753 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3757 #: ../src/guestfs.pod:1686
3759 "B<Note:> This section documents the generic event mechanism introduced in "
3760 "libguestfs 1.10, which you should use in new code if possible. The old "
3761 "functions C<guestfs_set_log_message_callback>, "
3762 "C<guestfs_set_subprocess_quit_callback>, "
3763 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3764 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3769 #: ../src/guestfs.pod:1694
3771 "Handles generate events when certain things happen, such as log messages "
3772 "being generated, progress messages during long-running operations, or the "
3773 "handle being closed. The API calls described below let you register a "
3774 "callback to be called when events happen. You can register multiple "
3775 "callbacks (for the same, different or overlapping sets of events), and "
3776 "individually remove callbacks. If callbacks are not removed, then they "
3777 "remain in force until the handle is closed."
3781 #: ../src/guestfs.pod:1702
3783 "In the current implementation, events are only generated synchronously: that "
3784 "means that events (and hence callbacks) can only happen while you are in the "
3785 "middle of making another libguestfs call. The callback is called in the "
3790 #: ../src/guestfs.pod:1707
3792 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3793 "unsigned integers, or a message buffer. Payloads are discussed later on."
3797 #: ../src/guestfs.pod:1711
3798 msgid "CLASSES OF EVENTS"
3802 #: ../src/guestfs.pod:1715
3803 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3807 #: ../src/guestfs.pod:1718
3809 "The callback function will be called while the handle is being closed "
3810 "(synchronously from L</guestfs_close>)."
3815 #: ../src/guestfs.pod:1721
3817 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3818 "handles that are open when the program exits. This means that this callback "
3819 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3820 "problems in higher-level languages (eg. if your HLL interpreter has already "
3821 "been cleaned up by the time this is called, and if your callback then jumps "
3822 "into some HLL function)."
3826 #: ../src/guestfs.pod:1728
3828 "If no callback is registered: the handle is closed without any callback "
3833 #: ../src/guestfs.pod:1731
3834 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3838 #: ../src/guestfs.pod:1734
3840 "The callback function will be called when the child process quits, either "
3841 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3842 "corresponds to a transition from any state to the CONFIG state)."
3846 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3847 msgid "If no callback is registered: the event is ignored."
3851 #: ../src/guestfs.pod:1740
3852 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3856 #: ../src/guestfs.pod:1743
3858 "The callback function will be called when the child process becomes ready "
3859 "first time after it has been launched. (This corresponds to a transition "
3860 "from LAUNCHING to the READY state)."
3864 #: ../src/guestfs.pod:1749
3865 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3870 #: ../src/guestfs.pod:1752
3872 "Some long-running operations can generate progress messages. If this "
3873 "callback is registered, then it will be called each time a progress message "
3874 "is generated (usually two seconds after the operation started, and three "
3875 "times per second thereafter until it completes, although the frequency may "
3876 "change in future versions)."
3880 #: ../src/guestfs.pod:1758
3882 "The callback receives in the payload four unsigned 64 bit numbers which are "
3883 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3887 #: ../src/guestfs.pod:1761
3889 "The units of C<total> are not defined, although for some operations C<total> "
3890 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3891 "or megabytes), and C<position> may be the portion which has been transferred."
3896 #: ../src/guestfs.pod:1766
3897 msgid "The only defined and stable parts of the API are:"
3902 #: ../src/guestfs.pod:1772
3904 "The callback can display to the user some type of progress bar or indicator "
3905 "which shows the ratio of C<position>:C<total>."
3910 #: ../src/guestfs.pod:1777
3911 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3915 #: ../src/guestfs.pod:1781
3917 "If any progress notification is sent during a call, then a final progress "
3918 "notification is always sent when C<position> = C<total> (I<unless> the call "
3919 "fails with an error)."
3924 #: ../src/guestfs.pod:1785
3926 "This is to simplify caller code, so callers can easily set the progress "
3927 "indicator to \"100%\" at the end of the operation, without requiring special "
3928 "code to detect this case."
3932 #: ../src/guestfs.pod:1791
3934 "For some calls we are unable to estimate the progress of the call, but we "
3935 "can still generate progress messages to indicate activity. This is known as "
3936 "\"pulse mode\", and is directly supported by certain progress bar "
3937 "implementations (eg. GtkProgressBar)."
3941 #: ../src/guestfs.pod:1796
3943 "For these calls, zero or more progress messages are generated with "
3944 "C<position = 0> and C<total = 1>, followed by a final message with "
3945 "C<position = total = 1>."
3949 #: ../src/guestfs.pod:1800
3951 "As noted above, if the call fails with an error then the final message may "
3956 #: ../src/guestfs.pod:1805
3958 "The callback also receives the procedure number (C<proc_nr>) and serial "
3959 "number (C<serial>) of the call. These are only useful for debugging "
3960 "protocol issues, and the callback can normally ignore them. The callback "
3961 "may want to print these numbers in error messages or debugging messages."
3965 #: ../src/guestfs.pod:1811
3966 msgid "If no callback is registered: progress messages are discarded."
3970 #: ../src/guestfs.pod:1813
3971 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3975 #: ../src/guestfs.pod:1816
3977 "The callback function is called whenever a log message is generated by qemu, "
3978 "the appliance kernel, guestfsd (daemon), or utility programs."
3982 #: ../src/guestfs.pod:1819
3984 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3985 "guestfs_launch>) then additional debug messages are generated."
3989 #: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
3991 "If no callback is registered: the messages are discarded unless the verbose "
3992 "flag is set in which case they are sent to stderr. You can override the "
3993 "printing of verbose messages to stderr by setting up a callback."
3997 #: ../src/guestfs.pod:1827
3998 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
4002 #: ../src/guestfs.pod:1830
4004 "The callback function is called whenever a log message is generated by the "
4005 "library part of libguestfs."
4009 #: ../src/guestfs.pod:1833
4011 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
4012 "messages are generated."
4016 #: ../src/guestfs.pod:1841
4017 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
4021 #: ../src/guestfs.pod:1844
4023 "The callback function is called whenever a trace message is generated. This "
4024 "only applies if the trace flag (L</guestfs_set_trace>) is set."
4028 #: ../src/guestfs.pod:1847
4030 "If no callback is registered: the messages are sent to stderr. You can "
4031 "override the printing of trace messages to stderr by setting up a callback."
4035 #: ../src/guestfs.pod:1853
4036 msgid "guestfs_set_event_callback"
4040 #: ../src/guestfs.pod:1855
4043 " int guestfs_set_event_callback (guestfs_h *g,\n"
4044 " guestfs_event_callback cb,\n"
4045 " uint64_t event_bitmask,\n"
4052 #: ../src/guestfs.pod:1861
4054 "This function registers a callback (C<cb>) for all event classes in the "
4059 #: ../src/guestfs.pod:1864
4061 "For example, to register for all log message events, you could call this "
4062 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4063 "To register a single callback for all possible classes of events, use "
4064 "C<GUESTFS_EVENT_ALL>."
4068 #: ../src/guestfs.pod:1870
4069 msgid "C<flags> should always be passed as 0."
4073 #: ../src/guestfs.pod:1872
4075 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4076 "it for any purpose."
4080 #: ../src/guestfs.pod:1875
4082 "The return value is the event handle (an integer) which you can use to "
4083 "delete the callback (see below)."
4087 #: ../src/guestfs.pod:1878
4089 "If there is an error, this function returns C<-1>, and sets the error in the "
4090 "handle in the usual way (see L</guestfs_last_error> etc.)"
4094 #: ../src/guestfs.pod:1881
4096 "Callbacks remain in effect until they are deleted, or until the handle is "
4101 #: ../src/guestfs.pod:1884
4103 "In the case where multiple callbacks are registered for a particular event "
4104 "class, all of the callbacks are called. The order in which multiple "
4105 "callbacks are called is not defined."
4109 #: ../src/guestfs.pod:1888
4110 msgid "guestfs_delete_event_callback"
4114 #: ../src/guestfs.pod:1890
4117 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4122 #: ../src/guestfs.pod:1892
4124 "Delete a callback that was previously registered. C<event_handle> should be "
4125 "the integer that was returned by a previous call to "
4126 "C<guestfs_set_event_callback> on the same handle."
4130 #: ../src/guestfs.pod:1896
4131 msgid "guestfs_event_callback"
4135 #: ../src/guestfs.pod:1898
4138 " typedef void (*guestfs_event_callback) (\n"
4141 " uint64_t event,\n"
4142 " int event_handle,\n"
4144 " const char *buf, size_t buf_len,\n"
4145 " const uint64_t *array, size_t array_len);\n"
4150 #: ../src/guestfs.pod:1907
4152 "This is the type of the event callback function that you have to provide."
4156 #: ../src/guestfs.pod:1910
4158 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4159 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4160 "handle, and C<flags> which in the current API you should ignore."
4164 #: ../src/guestfs.pod:1914
4166 "The remaining parameters contain the event payload (if any). Each event may "
4167 "contain a payload, which usually relates to the event class, but for future "
4168 "proofing your code should be written to handle any payload for any event "
4173 #: ../src/guestfs.pod:1919
4175 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4176 "there is no message buffer). Note that this message buffer can contain "
4177 "arbitrary 8 bit data, including NUL bytes."
4181 #: ../src/guestfs.pod:1923
4183 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4184 "moment this is only used for progress messages."
4188 #: ../src/guestfs.pod:1926
4189 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4193 #: ../src/guestfs.pod:1928
4195 "One motivation for the generic event API was to allow GUI programs to "
4196 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4197 "unconditionally to C<stderr>."
4201 #: ../src/guestfs.pod:1932
4203 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4204 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4205 "messages are not events; you must capture error messages separately)."
4209 #: ../src/guestfs.pod:1937
4211 "Programs have to set up a callback to capture the classes of events of "
4216 #: ../src/guestfs.pod:1940
4220 " guestfs_set_event_callback\n"
4221 " (g, message_callback,\n"
4222 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4223 " GUESTFS_EVENT_TRACE,\n"
4224 " 0, NULL) == -1)\n"
4225 " if (eh == -1) {\n"
4226 " // handle error in the usual way\n"
4232 #: ../src/guestfs.pod:1950
4234 "The callback can then direct messages to the appropriate place. In this "
4235 "example, messages are directed to syslog:"
4239 #: ../src/guestfs.pod:1953
4243 " message_callback (\n"
4246 " uint64_t event,\n"
4247 " int event_handle,\n"
4249 " const char *buf, size_t buf_len,\n"
4250 " const uint64_t *array, size_t array_len)\n"
4252 " const int priority = LOG_USER|LOG_INFO;\n"
4253 " if (buf_len > 0)\n"
4254 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4261 #: ../src/guestfs.pod:1968
4262 msgid "PRIVATE DATA AREA"
4266 #: ../src/guestfs.pod:1970
4268 "You can attach named pieces of private data to the libguestfs handle, fetch "
4269 "them by name, and walk over them, for the lifetime of the handle. This is "
4270 "called the private data area and is only available from the C API."
4275 #: ../src/guestfs.pod:1975
4276 msgid "To attach a named piece of data, use the following call:"
4281 #: ../src/guestfs.pod:1977
4284 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4290 #: ../src/guestfs.pod:1979
4292 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4293 "pointer (which can be C<NULL>). Any previous item with the same name is "
4299 #: ../src/guestfs.pod:1983
4301 "You can use any C<key> you want, but names beginning with an underscore "
4302 "character are reserved for internal libguestfs purposes (for implementing "
4303 "language bindings). It is recommended to prefix the name with some unique "
4304 "string to avoid collisions with other users."
4309 #: ../src/guestfs.pod:1988
4310 msgid "To retrieve the pointer, use:"
4315 #: ../src/guestfs.pod:1990
4318 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4324 #: ../src/guestfs.pod:1992
4326 "This function returns C<NULL> if either no data is found associated with "
4327 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4332 #: ../src/guestfs.pod:1996
4334 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4335 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4336 "all. In particular, libguestfs does I<not> try to free the data when the "
4337 "handle is closed. If the data must be freed, then the caller must either "
4338 "free it before calling L</guestfs_close> or must set up a close callback to "
4339 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4343 #: ../src/guestfs.pod:2003
4344 msgid "To walk over all entries, use these two functions:"
4348 #: ../src/guestfs.pod:2005
4351 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4356 #: ../src/guestfs.pod:2007
4359 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4364 #: ../src/guestfs.pod:2009
4366 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4367 "not have any particular meaning -- keys are not returned in any defined "
4368 "order). A pointer to the key is returned in C<*key_rtn> and the "
4369 "corresponding data pointer is returned from the function. C<NULL> is "
4370 "returned if there are no keys stored in the handle."
4374 #: ../src/guestfs.pod:2015
4376 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4377 "value of this function is also C<NULL> is there are no further entries to "
4382 #: ../src/guestfs.pod:2019
4383 msgid "Notes about walking over entries:"
4387 #: ../src/guestfs.pod:2025
4389 "You must not call C<guestfs_set_private> while walking over the entries."
4393 #: ../src/guestfs.pod:2030
4395 "The handle maintains an internal iterator which is reset when you call "
4396 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4397 "call C<guestfs_set_private>."
4401 #: ../src/guestfs.pod:2036
4402 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4406 #: ../src/guestfs.pod:2038
4409 " guestfs_set_private (g, key, NULL);\n"
4414 #: ../src/guestfs.pod:2040
4415 msgid "then that C<key> is not returned when walking."
4419 #: ../src/guestfs.pod:2044
4421 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4422 "C<guestfs_next_private> or C<guestfs_set_private>."
4426 #: ../src/guestfs.pod:2050
4428 "The following example code shows how to print all keys and data pointers "
4429 "that are associated with the handle C<g>:"
4433 #: ../src/guestfs.pod:2053
4436 " const char *key;\n"
4437 " void *data = guestfs_first_private (g, &key);\n"
4438 " while (data != NULL)\n"
4440 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4441 " data = guestfs_next_private (g, &key);\n"
4447 #: ../src/guestfs.pod:2061
4449 "More commonly you are only interested in keys that begin with an application-"
4450 "specific prefix C<foo_>. Modify the loop like so:"
4454 #: ../src/guestfs.pod:2064
4457 " const char *key;\n"
4458 " void *data = guestfs_first_private (g, &key);\n"
4459 " while (data != NULL)\n"
4461 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4462 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4463 " data = guestfs_next_private (g, &key);\n"
4469 #: ../src/guestfs.pod:2073
4471 "If you need to modify keys while walking, then you have to jump back to the "
4472 "beginning of the loop. For example, to delete all keys prefixed with "
4477 #: ../src/guestfs.pod:2077
4480 " const char *key;\n"
4483 " data = guestfs_first_private (g, &key);\n"
4484 " while (data != NULL)\n"
4486 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4488 " guestfs_set_private (g, key, NULL);\n"
4489 " /* note that 'key' pointer is now invalid, and so is\n"
4490 " the internal iterator */\n"
4493 " data = guestfs_next_private (g, &key);\n"
4499 #: ../src/guestfs.pod:2093
4501 "Note that the above loop is guaranteed to terminate because the keys are "
4502 "being deleted, but other manipulations of keys within the loop might not "
4503 "terminate unless you also maintain an indication of which keys have been "
4509 #: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
4515 #: ../src/guestfs.pod:2100
4517 "<!-- old anchor for the next section --> <a name="
4518 "\"state_machine_and_low_level_event_api\"/>"
4523 #: ../src/guestfs.pod:2105
4524 msgid "ARCHITECTURE"
4529 #: ../src/guestfs.pod:2107
4531 "Internally, libguestfs is implemented by running an appliance (a special "
4532 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4533 "process of the main program."
4538 #: ../src/guestfs.pod:2111
4541 " ___________________\n"
4543 " | main program |\n"
4545 " | | child process / appliance\n"
4546 " | | __________________________\n"
4548 " +-------------------+ RPC | +-----------------+ |\n"
4549 " | libguestfs <--------------------> guestfsd | |\n"
4550 " | | | +-----------------+ |\n"
4551 " \\___________________/ | | Linux kernel | |\n"
4552 " | +--^--------------+ |\n"
4553 " \\_________|________________/\n"
4559 " \\______________/\n"
4565 #: ../src/guestfs.pod:2131
4567 "The library, linked to the main program, creates the child process and hence "
4568 "the appliance in the L</guestfs_launch> function."
4573 #: ../src/guestfs.pod:2134
4575 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4576 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4577 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4578 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4579 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4580 "attached to the qemu process which translates device access by the "
4581 "appliance's Linux kernel into accesses to the image."
4586 #: ../src/guestfs.pod:2143
4588 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4589 "Although the disk image you are attached to might also be used by some "
4590 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4591 "care if both libguestfs's qemu process and your virtual machine are trying "
4592 "to update the disk image at the same time, since these usually results in "
4593 "massive disk corruption)."
4598 #: ../src/guestfs.pod:2150
4599 msgid "STATE MACHINE"
4604 #: ../src/guestfs.pod:2152
4605 msgid "libguestfs uses a state machine to model the child process:"
4610 #: ../src/guestfs.pod:2154
4622 " / | \\ \\ guestfs_launch\n"
4623 " / | _\\__V______\n"
4625 " / | | LAUNCHING |\n"
4626 " / | \\___________/\n"
4628 " / | guestfs_launch\n"
4630 " ______ / __|____V\n"
4631 " / \\ ------> / \\\n"
4632 " | BUSY | | READY |\n"
4633 " \\______/ <------ \\________/\n"
4639 #: ../src/guestfs.pod:2176
4641 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4642 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4643 "(3) alternating between READY and BUSY as commands are issued to, and "
4644 "carried out by, the child process."
4649 #: ../src/guestfs.pod:2181
4651 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4652 "asynchronously at any time (eg. due to some internal error), and that causes "
4653 "the state to transition back to CONFIG."
4658 #: ../src/guestfs.pod:2185
4660 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4661 "issued when in the CONFIG state."
4666 #: ../src/guestfs.pod:2188
4668 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4669 "L</guestfs_launch> blocks until the child process is READY to accept "
4670 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4671 "moves the state from CONFIG to LAUNCHING while it is running."
4676 #: ../src/guestfs.pod:2194
4678 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4679 "state. These API calls block waiting for the command to be carried out (ie. "
4680 "the state to transition to BUSY and then back to READY). There are no non-"
4681 "blocking versions, and no way to issue more than one command per handle at "
4687 #: ../src/guestfs.pod:2200
4689 "Finally, the child process sends asynchronous messages back to the main "
4690 "program, such as kernel log messages. You can register a callback to "
4691 "receive these messages."
4696 #: ../src/guestfs.pod:2204
4702 #: ../src/guestfs.pod:2206
4703 msgid "COMMUNICATION PROTOCOL"
4708 #: ../src/guestfs.pod:2208
4710 "Don't rely on using this protocol directly. This section documents how it "
4711 "currently works, but it may change at any time."
4716 #: ../src/guestfs.pod:2211
4718 "The protocol used to talk between the library and the daemon running inside "
4719 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4720 "1014, RFC 1832, RFC 4506)."
4725 #: ../src/guestfs.pod:2215
4727 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4728 "this file is automatically generated)."
4733 #: ../src/guestfs.pod:2218
4735 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4736 "and C<FileOut> parameters, which are handled with very simple request/reply "
4737 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4738 "parameters, which use the same request and reply messages, but they may also "
4739 "be followed by files sent using a chunked encoding."
4744 #: ../src/guestfs.pod:2225
4745 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4750 #: ../src/guestfs.pod:2227
4751 msgid "For ordinary functions, the request message is:"
4756 #: ../src/guestfs.pod:2229
4759 " total length (header + arguments,\n"
4760 " but not including the length word itself)\n"
4761 " struct guestfs_message_header (encoded as XDR)\n"
4762 " struct guestfs_<foo>_args (encoded as XDR)\n"
4768 #: ../src/guestfs.pod:2234
4770 "The total length field allows the daemon to allocate a fixed size buffer "
4771 "into which it slurps the rest of the message. As a result, the total length "
4772 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4773 "effective size of any request is limited to somewhere under this size."
4778 #: ../src/guestfs.pod:2240
4780 "Note also that many functions don't take any arguments, in which case the "
4781 "C<guestfs_I<foo>_args> is completely omitted."
4786 #: ../src/guestfs.pod:2243
4788 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4789 "receiver knows what type of args structure to expect, or none at all."
4794 #: ../src/guestfs.pod:2247
4796 "For functions that take optional arguments, the optional arguments are "
4797 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4798 "arguments. A bitmask in the header indicates which optional arguments are "
4799 "meaningful. The bitmask is also checked to see if it contains bits set "
4800 "which the daemon does not know about (eg. if more optional arguments were "
4801 "added in a later version of the library), and this causes the call to be "
4807 #: ../src/guestfs.pod:2255
4808 msgid "The reply message for ordinary functions is:"
4813 #: ../src/guestfs.pod:2257
4816 " total length (header + ret,\n"
4817 " but not including the length word itself)\n"
4818 " struct guestfs_message_header (encoded as XDR)\n"
4819 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4825 #: ../src/guestfs.pod:2262
4827 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4828 "functions that return no formal return values."
4833 #: ../src/guestfs.pod:2265
4835 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4840 #: ../src/guestfs.pod:2268
4842 "In the case of an error, a flag is set in the header, and the reply message "
4843 "is slightly changed:"
4848 #: ../src/guestfs.pod:2271
4851 " total length (header + error,\n"
4852 " but not including the length word itself)\n"
4853 " struct guestfs_message_header (encoded as XDR)\n"
4854 " struct guestfs_message_error (encoded as XDR)\n"
4860 #: ../src/guestfs.pod:2276
4862 "The C<guestfs_message_error> structure contains the error message as a "
4868 #: ../src/guestfs.pod:2279
4869 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4874 #: ../src/guestfs.pod:2281
4876 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4877 "The normal request message is sent (see above). However this is followed by "
4878 "a sequence of file chunks."
4883 #: ../src/guestfs.pod:2285
4886 " total length (header + arguments,\n"
4887 " but not including the length word itself,\n"
4888 " and not including the chunks)\n"
4889 " struct guestfs_message_header (encoded as XDR)\n"
4890 " struct guestfs_<foo>_args (encoded as XDR)\n"
4891 " sequence of chunks for FileIn param #0\n"
4892 " sequence of chunks for FileIn param #1 etc.\n"
4898 #: ../src/guestfs.pod:2293
4899 msgid "The \"sequence of chunks\" is:"
4904 #: ../src/guestfs.pod:2295
4907 " length of chunk (not including length word itself)\n"
4908 " struct guestfs_chunk (encoded as XDR)\n"
4909 " length of chunk\n"
4910 " struct guestfs_chunk (encoded as XDR)\n"
4912 " length of chunk\n"
4913 " struct guestfs_chunk (with data.data_len == 0)\n"
4919 #: ../src/guestfs.pod:2303
4921 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4922 "is set in the final chunk to indicate either successful completion or early "
4928 #: ../src/guestfs.pod:2307
4930 "At time of writing there are no functions that have more than one FileIn "
4931 "parameter. However this is (theoretically) supported, by sending the "
4932 "sequence of chunks for each FileIn parameter one after another (from left to "
4938 #: ../src/guestfs.pod:2312
4940 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4941 "transfer. The library does this by sending a chunk with a special flag set "
4942 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4943 "RPC, does I<not> send any reply, and goes back to reading the next request."
4948 #: ../src/guestfs.pod:2318
4950 "The daemon may also cancel. It does this by writing a special word "
4951 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4952 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4953 "cancel chunk). The special word is chosen so that even if cancellation "
4954 "happens right at the end of the transfer (after the library has finished "
4955 "writing and has started listening for the reply), the \"spurious\" cancel "
4956 "flag will not be confused with the reply message."
4961 #: ../src/guestfs.pod:2327
4963 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4964 "limit), and also files where the size is not known in advance (eg. from "
4965 "pipes or sockets). However the chunks are rather small "
4966 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4967 "to keep much in memory."
4972 #: ../src/guestfs.pod:2333
4973 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4978 #: ../src/guestfs.pod:2335
4980 "The protocol for FileOut parameters is exactly the same as for FileIn "
4981 "parameters, but with the roles of daemon and library reversed."
4986 #: ../src/guestfs.pod:2338
4989 " total length (header + ret,\n"
4990 " but not including the length word itself,\n"
4991 " and not including the chunks)\n"
4992 " struct guestfs_message_header (encoded as XDR)\n"
4993 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4994 " sequence of chunks for FileOut param #0\n"
4995 " sequence of chunks for FileOut param #1 etc.\n"
5001 #: ../src/guestfs.pod:2346
5002 msgid "INITIAL MESSAGE"
5007 #: ../src/guestfs.pod:2348
5009 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
5010 "which indicates that the guest and daemon is alive. This is what L</"
5011 "guestfs_launch> waits for."
5016 #: ../src/guestfs.pod:2352
5017 msgid "PROGRESS NOTIFICATION MESSAGES"
5022 #: ../src/guestfs.pod:2354
5024 "The daemon may send progress notification messages at any time. These are "
5025 "distinguished by the normal length word being replaced by "
5026 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
5030 #: ../src/guestfs.pod:2358
5032 "The library turns them into progress callbacks (see L</"
5033 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5039 #: ../src/guestfs.pod:2362
5041 "The daemon self-limits the frequency of progress messages it sends (see "
5042 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5048 #: ../src/guestfs.pod:2366
5049 msgid "LIBGUESTFS VERSION NUMBERS"
5054 #: ../src/guestfs.pod:2368
5056 "Since April 2010, libguestfs has started to make separate development and "
5057 "stable releases, along with corresponding branches in our git repository. "
5058 "These separate releases can be identified by version number:"
5063 #: ../src/guestfs.pod:2373
5066 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5067 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5073 " | `-------- sub-version\n"
5075 " `------ always '1' because we don't change the ABI\n"
5081 #: ../src/guestfs.pod:2384
5082 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5087 #: ../src/guestfs.pod:2386
5089 "As time passes we cherry pick fixes from the development branch and backport "
5090 "those into the stable branch, the effect being that the stable branch should "
5091 "get more stable and less buggy over time. So the stable releases are ideal "
5092 "for people who don't need new features but would just like the software to "
5098 #: ../src/guestfs.pod:2392
5099 msgid "Our criteria for backporting changes are:"
5104 #: ../src/guestfs.pod:2398
5106 "Documentation changes which don't affect any code are backported unless the "
5107 "documentation refers to a future feature which is not in stable."
5112 #: ../src/guestfs.pod:2404
5114 "Bug fixes which are not controversial, fix obvious problems, and have been "
5115 "well tested are backported."
5120 #: ../src/guestfs.pod:2409
5122 "Simple rearrangements of code which shouldn't affect how it works get "
5123 "backported. This is so that the code in the two branches doesn't get too "
5124 "far out of step, allowing us to backport future fixes more easily."
5129 #: ../src/guestfs.pod:2415
5131 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5132 "exceptional case: the new feature is required in order to implement an "
5133 "important bug fix."
5138 #: ../src/guestfs.pod:2421
5140 "A new stable branch starts when we think the new features in development are "
5141 "substantial and compelling enough over the current stable branch to warrant "
5142 "it. When that happens we create new stable and development versions 1.N.0 "
5143 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5144 "stable at this point, but by backporting fixes from development, that branch "
5145 "will stabilize over time."
5149 #: ../src/guestfs.pod:2429
5150 msgid "EXTENDING LIBGUESTFS"
5154 #: ../src/guestfs.pod:2431
5155 msgid "ADDING A NEW API ACTION"
5159 #: ../src/guestfs.pod:2433
5161 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5162 "documentation) are generated, and this makes it easy to extend the "
5167 #: ../src/guestfs.pod:2437
5168 msgid "To add a new API action there are two changes:"
5172 #: ../src/guestfs.pod:2443
5174 "You need to add a description of the call (name, parameters, return type, "
5175 "tests, documentation) to C<generator/generator_actions.ml>."
5179 #: ../src/guestfs.pod:2446
5181 "There are two sorts of API action, depending on whether the call goes "
5182 "through to the daemon in the appliance, or is serviced entirely by the "
5183 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5184 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5185 "an example of the latter, since a trace flag is maintained in the handle and "
5186 "all tracing is done on the library side."
5190 #: ../src/guestfs.pod:2454
5192 "Most new actions are of the first type, and get added to the "
5193 "C<daemon_functions> list. Each function has a unique procedure number used "
5194 "in the RPC protocol which is assigned to that action when we publish "
5195 "libguestfs and cannot be reused. Take the latest procedure number and "
5200 #: ../src/guestfs.pod:2460
5202 "For library-only actions of the second type, add to the "
5203 "C<non_daemon_functions> list. Since these functions are serviced by the "
5204 "library and do not travel over the RPC mechanism to the daemon, these "
5205 "functions do not need a procedure number, and so the procedure number is set "
5210 #: ../src/guestfs.pod:2468
5211 msgid "Implement the action (in C):"
5215 #: ../src/guestfs.pod:2470
5217 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5218 "C<daemon/> directory."
5222 #: ../src/guestfs.pod:2473
5224 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5225 "(note: double underscore) in the C<src/> directory."
5229 #: ../src/guestfs.pod:2476
5230 msgid "In either case, use another function as an example of what to do."
5234 #: ../src/guestfs.pod:2480
5235 msgid "After making these changes, use C<make> to compile."
5239 #: ../src/guestfs.pod:2482
5241 "Note that you don't need to implement the RPC, language bindings, manual "
5242 "pages or anything else. It's all automatically generated from the OCaml "
5247 #: ../src/guestfs.pod:2486
5248 msgid "ADDING TESTS FOR AN API ACTION"
5252 #: ../src/guestfs.pod:2488
5254 "You can supply zero or as many tests as you want per API call. The tests "
5255 "can either be added as part of the API description (C<generator/"
5256 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5257 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5258 "slower, so if possible use the first method."
5262 #: ../src/guestfs.pod:2494
5264 "The following describes the test environment used when you add an API test "
5265 "in C<generator_actions.ml>."
5269 #: ../src/guestfs.pod:2497
5270 msgid "The test environment has 4 block devices:"
5274 #: ../src/guestfs.pod:2501
5275 msgid "C</dev/sda> 500MB"
5279 #: ../src/guestfs.pod:2503
5280 msgid "General block device for testing."
5284 #: ../src/guestfs.pod:2505
5285 msgid "C</dev/sdb> 50MB"
5289 #: ../src/guestfs.pod:2507
5291 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5296 #: ../src/guestfs.pod:2510
5297 msgid "C</dev/sdc> 10MB"
5301 #: ../src/guestfs.pod:2512
5302 msgid "Used in a few tests where two block devices are needed."
5306 #: ../src/guestfs.pod:2514
5311 #: ../src/guestfs.pod:2516
5312 msgid "ISO with fixed content (see C<images/test.iso>)."
5316 #: ../src/guestfs.pod:2520
5318 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5319 "appliance and block devices are reused between tests. So don't try testing "
5320 "L</guestfs_kill_subprocess> :-x"
5324 #: ../src/guestfs.pod:2524
5326 "Each test starts with an initial scenario, selected using one of the "
5327 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5328 "initialize the disks mentioned above in a particular way as documented in "
5329 "C<generator_types.ml>. You should not assume anything about the previous "
5330 "contents of other disks that are not initialized."
5334 #: ../src/guestfs.pod:2530
5336 "You can add a prerequisite clause to any individual test. This is a run-"
5337 "time check, which, if it fails, causes the test to be skipped. Useful if "
5338 "testing a command which might not work on all variations of libguestfs "
5339 "builds. A test that has prerequisite of C<Always> means to run "
5344 #: ../src/guestfs.pod:2536
5346 "In addition, packagers can skip individual tests by setting environment "
5347 "variables before running C<make check>."
5351 #: ../src/guestfs.pod:2539
5354 " SKIP_TEST_<CMD>_<NUM>=1\n"
5359 #: ../src/guestfs.pod:2541
5360 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5364 #: ../src/guestfs.pod:2543
5369 #: ../src/guestfs.pod:2545
5372 " SKIP_TEST_<CMD>=1\n"
5377 #: ../src/guestfs.pod:2547
5378 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5382 #: ../src/guestfs.pod:2549
5383 msgid "Packagers can run only certain tests by setting for example:"
5387 #: ../src/guestfs.pod:2551
5390 " TEST_ONLY=\"vfs_type zerofree\"\n"
5395 #: ../src/guestfs.pod:2553
5397 "See C<capitests/tests.c> for more details of how these environment variables "
5402 #: ../src/guestfs.pod:2556
5403 msgid "DEBUGGING NEW API ACTIONS"
5407 #: ../src/guestfs.pod:2558
5408 msgid "Test new actions work before submitting them."
5412 #: ../src/guestfs.pod:2560
5413 msgid "You can use guestfish to try out new commands."
5417 #: ../src/guestfs.pod:2562
5419 "Debugging the daemon is a problem because it runs inside a minimal "
5420 "environment. However you can fprintf messages in the daemon to stderr, and "
5421 "they will show up if you use C<guestfish -v>."
5425 #: ../src/guestfs.pod:2566
5426 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5430 #: ../src/guestfs.pod:2568
5432 "Our C source code generally adheres to some basic code-formatting "
5433 "conventions. The existing code base is not totally consistent on this "
5434 "front, but we do prefer that contributed code be formatted similarly. In "
5435 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5436 "indentation level, and other than that, follow the K&R style."
5440 #: ../src/guestfs.pod:2574
5442 "If you use Emacs, add the following to one of one of your start-up files (e."
5443 "g., ~/.emacs), to help ensure that you get indentation right:"
5447 #: ../src/guestfs.pod:2577
5450 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5451 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5452 " (add-hook 'find-file-hook\n"
5453 " '(lambda () (if (and buffer-file-name\n"
5454 " (string-match \"/libguestfs\\\\>\"\n"
5455 " (buffer-file-name))\n"
5456 " (not (string-equal mode-name \"Change Log\"))\n"
5457 " (not (string-equal mode-name \"Makefile\")))\n"
5458 " (setq indent-tabs-mode nil))))\n"
5463 #: ../src/guestfs.pod:2587
5466 " ;;; When editing C sources in libguestfs, use this style.\n"
5467 " (defun libguestfs-c-mode ()\n"
5468 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5470 " (c-set-style \"K&R\")\n"
5471 " (setq c-indent-level 2)\n"
5472 " (setq c-basic-offset 2))\n"
5473 " (add-hook 'c-mode-hook\n"
5474 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5475 " (buffer-file-name))\n"
5476 " (libguestfs-c-mode))))\n"
5481 #: ../src/guestfs.pod:2599
5482 msgid "Enable warnings when compiling (and fix any problems this finds):"
5486 #: ../src/guestfs.pod:2602
5489 " ./configure --enable-gcc-warnings\n"
5494 #: ../src/guestfs.pod:2604
5495 msgid "Useful targets are:"
5499 #: ../src/guestfs.pod:2606
5502 " make syntax-check # checks the syntax of the C code\n"
5503 " make check # runs the test suite\n"
5508 #: ../src/guestfs.pod:2609
5509 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5513 #: ../src/guestfs.pod:2611
5515 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5516 "which are used to do shell quoting."
5520 #: ../src/guestfs.pod:2616
5525 #: ../src/guestfs.pod:2618
5527 "Simple shell quoted string. Any spaces or other shell characters are "
5532 #: ../src/guestfs.pod:2621
5537 #: ../src/guestfs.pod:2623
5539 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5545 #: ../src/guestfs.pod:2628 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5546 msgid "For example:"
5550 #: ../src/guestfs.pod:2630
5553 " asprintf (&cmd, \"cat %R\", path);\n"
5558 #: ../src/guestfs.pod:2632
5559 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5563 #: ../src/guestfs.pod:2634
5565 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5566 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5567 "they are not passed via the shell (instead, straight to exec). You probably "
5568 "want to use the C<sysroot_path()> function however."
5572 #: ../src/guestfs.pod:2640
5573 msgid "SUBMITTING YOUR NEW API ACTIONS"
5577 #: ../src/guestfs.pod:2642
5579 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5580 "libguestfs> and CC to L<rjones@redhat.com>."
5584 #: ../src/guestfs.pod:2646
5585 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5589 #: ../src/guestfs.pod:2648
5590 msgid "We support i18n (gettext anyhow) in the library."
5594 #: ../src/guestfs.pod:2650
5596 "However many messages come from the daemon, and we don't translate those at "
5597 "the moment. One reason is that the appliance generally has all locale files "
5598 "removed from it, because they take up a lot of space. So we'd have to readd "
5599 "some of those, as well as copying our PO files into the appliance."
5603 #: ../src/guestfs.pod:2656
5605 "Debugging messages are never translated, since they are intended for the "
5610 #: ../src/guestfs.pod:2659
5611 msgid "SOURCE CODE SUBDIRECTORIES"
5615 #: ../src/guestfs.pod:2663 ../src/guestfs-actions.pod:5735
5616 #: ../fish/guestfish-actions.pod:3842
5617 msgid "C<appliance>"
5621 #: ../src/guestfs.pod:2665
5622 msgid "The libguestfs appliance, build scripts and so on."
5626 #: ../src/guestfs.pod:2667
5627 msgid "C<capitests>"
5631 #: ../src/guestfs.pod:2669
5632 msgid "Automated tests of the C API."
5636 #: ../src/guestfs.pod:2671
5641 #: ../src/guestfs.pod:2673
5643 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5648 #: ../src/guestfs.pod:2676
5653 #: ../src/guestfs.pod:2678
5654 msgid "Outside contributions, experimental parts."
5658 #: ../src/guestfs.pod:2680
5663 #: ../src/guestfs.pod:2682
5665 "The daemon that runs inside the libguestfs appliance and carries out actions."
5669 #: ../src/guestfs.pod:2685
5674 #: ../src/guestfs.pod:2687
5675 msgid "L<virt-df(1)> command and documentation."
5679 #: ../src/guestfs.pod:2689
5684 #: ../src/guestfs.pod:2691
5685 msgid "C API example code."
5689 #: ../src/guestfs.pod:2693
5694 #: ../src/guestfs.pod:2695
5696 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5697 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5698 "L<virt-tar-out(1)>."
5702 #: ../src/guestfs.pod:2699
5707 #: ../src/guestfs.pod:2701
5709 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5713 #: ../src/guestfs.pod:2703
5714 msgid "C<generator>"
5718 #: ../src/guestfs.pod:2705
5720 "The crucially important generator, used to automatically generate large "
5721 "amounts of boilerplate C code for things like RPC and bindings."
5725 #: ../src/guestfs.pod:2708
5730 #: ../src/guestfs.pod:2710
5731 msgid "Files used by the test suite."
5735 #: ../src/guestfs.pod:2712
5736 msgid "Some \"phony\" guest images which we test against."
5740 #: ../src/guestfs.pod:2714
5741 msgid "C<inspector>"
5745 #: ../src/guestfs.pod:2716
5746 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5750 #: ../src/guestfs.pod:2718
5755 #: ../src/guestfs.pod:2720
5756 msgid "Logo used on the website. The fish is called Arthur by the way."
5760 #: ../src/guestfs.pod:2722
5765 #: ../src/guestfs.pod:2724
5766 msgid "M4 macros used by autoconf."
5770 #: ../src/guestfs.pod:2726
5775 #: ../src/guestfs.pod:2728
5776 msgid "Translations of simple gettext strings."
5780 #: ../src/guestfs.pod:2730
5785 #: ../src/guestfs.pod:2732
5787 "The build infrastructure and PO files for translations of manpages and POD "
5788 "files. Eventually this will be combined with the C<po> directory, but that "
5789 "is rather complicated."
5793 #: ../src/guestfs.pod:2736
5794 msgid "C<regressions>"
5798 #: ../src/guestfs.pod:2738
5799 msgid "Regression tests."
5803 #: ../src/guestfs.pod:2740
5808 #: ../src/guestfs.pod:2742
5809 msgid "L<virt-rescue(1)> command and documentation."
5813 #: ../src/guestfs.pod:2744
5818 #: ../src/guestfs.pod:2746
5819 msgid "Source code to the C library."
5823 #: ../src/guestfs.pod:2748
5828 #: ../src/guestfs.pod:2750
5829 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5833 #: ../src/guestfs.pod:2752
5834 msgid "C<test-tool>"
5838 #: ../src/guestfs.pod:2754
5840 "Test tool for end users to test if their qemu/kernel combination will work "
5845 #: ../src/guestfs.pod:2757
5850 #: ../src/guestfs.pod:2759
5855 #: ../src/guestfs.pod:2761
5860 #: ../src/guestfs.pod:2763
5865 #: ../src/guestfs.pod:2765
5870 #: ../src/guestfs.pod:2767
5875 #: ../src/guestfs.pod:2769
5880 #: ../src/guestfs.pod:2771
5885 #: ../src/guestfs.pod:2773
5886 msgid "Language bindings."
5891 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1010
5892 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5893 msgid "ENVIRONMENT VARIABLES"
5898 #: ../src/guestfs.pod:2781 ../fish/guestfish.pod:1036
5899 msgid "LIBGUESTFS_APPEND"
5904 #: ../src/guestfs.pod:2783 ../fish/guestfish.pod:1038
5905 msgid "Pass additional options to the guest kernel."
5910 #: ../src/guestfs.pod:2785 ../fish/guestfish.pod:1040
5911 msgid "LIBGUESTFS_DEBUG"
5916 #: ../src/guestfs.pod:2787
5918 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5919 "effect as calling C<guestfs_set_verbose (g, 1)>."
5924 #: ../src/guestfs.pod:2790 ../fish/guestfish.pod:1045
5925 msgid "LIBGUESTFS_MEMSIZE"
5930 #: ../src/guestfs.pod:2792 ../fish/guestfish.pod:1047
5932 "Set the memory allocated to the qemu process, in megabytes. For example:"
5937 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1050
5940 " LIBGUESTFS_MEMSIZE=700\n"
5946 #: ../src/guestfs.pod:2797 ../fish/guestfish.pod:1052
5947 msgid "LIBGUESTFS_PATH"
5951 #: ../src/guestfs.pod:2799
5953 "Set the path that libguestfs uses to search for a supermin appliance. See "
5954 "the discussion of paths in section L</PATH> above."
5959 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1057
5960 msgid "LIBGUESTFS_QEMU"
5965 #: ../src/guestfs.pod:2804 ../fish/guestfish.pod:1059
5967 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5968 "which was found at compile time by the configure script is used."
5973 #: ../src/guestfs.pod:2808
5974 msgid "See also L</QEMU WRAPPERS> above."
5979 #: ../src/guestfs.pod:2810 ../fish/guestfish.pod:1063
5980 msgid "LIBGUESTFS_TRACE"
5985 #: ../src/guestfs.pod:2812
5987 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5988 "effect as calling C<guestfs_set_trace (g, 1)>."
5993 #: ../src/guestfs.pod:2815 ../fish/guestfish.pod:1072
5998 #: ../src/guestfs.pod:2817 ../fish/guestfish.pod:1074
6000 "Location of temporary directory, defaults to C</tmp> except for the cached "
6001 "supermin appliance which defaults to C</var/tmp>."
6005 #: ../src/guestfs.pod:2820 ../fish/guestfish.pod:1077
6007 "If libguestfs was compiled to use the supermin appliance then the real "
6008 "appliance is cached in this directory, shared between all handles belonging "
6009 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
6010 "use in case C</var/tmp> is not large enough."
6015 #: ../src/guestfs.pod:2828 ../fish/guestfish.pod:1144
6016 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:267
6017 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572
6018 #: ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189
6019 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
6020 #: ../tools/virt-list-partitions.pl:257
6025 #: ../src/guestfs.pod:2830
6027 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6028 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6029 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6030 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6031 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6032 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6033 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6038 #: ../src/guestfs.pod:2857
6040 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6041 "(8)>, L<disktype(1)>."
6046 #: ../src/guestfs.pod:2864 ../tools/virt-win-reg.pl:587
6047 #: ../tools/virt-make-fs.pl:553
6053 #: ../src/guestfs.pod:2866
6054 msgid "To get a list of bugs against libguestfs use this link:"
6059 #: ../src/guestfs.pod:2868
6061 "L<https://bugzilla.redhat.com/buglist.cgi?"
6062 "component=libguestfs&product=Virtualization+Tools>"
6067 #: ../src/guestfs.pod:2870
6068 msgid "To report a new bug against libguestfs use this link:"
6073 #: ../src/guestfs.pod:2872
6075 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6076 "component=libguestfs&product=Virtualization+Tools>"
6081 #: ../src/guestfs.pod:2874
6082 msgid "When reporting a bug, please check:"
6087 #: ../src/guestfs.pod:2880
6088 msgid "That the bug hasn't been reported already."
6093 #: ../src/guestfs.pod:2884
6094 msgid "That you are testing a recent version."
6099 #: ../src/guestfs.pod:2888
6100 msgid "Describe the bug accurately, and give a way to reproduce it."
6105 #: ../src/guestfs.pod:2892
6107 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6113 #: ../src/guestfs.pod:2897 ../fish/guestfish.pod:1167
6114 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:278
6120 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1169
6121 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:280
6122 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6127 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1171
6128 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:282
6129 #: ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602
6130 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206
6131 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6132 #: ../tools/virt-list-partitions.pl:273
6137 #: ../src/guestfs.pod:2903 ../fish/guestfish.pod:1173
6138 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
6143 #: ../src/guestfs.pod:2906
6145 "This library is free software; you can redistribute it and/or modify it "
6146 "under the terms of the GNU Lesser General Public License as published by the "
6147 "Free Software Foundation; either version 2 of the License, or (at your "
6148 "option) any later version."
6153 #: ../src/guestfs.pod:2911
6155 "This library is distributed in the hope that it will be useful, but WITHOUT "
6156 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6157 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6163 #: ../src/guestfs.pod:2916
6165 "You should have received a copy of the GNU Lesser General Public License "
6166 "along with this library; if not, write to the Free Software Foundation, "
6167 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6172 #: ../src/guestfs-actions.pod:1
6173 msgid "guestfs_add_cdrom"
6178 #: ../src/guestfs-actions.pod:3
6182 " guestfs_add_cdrom (guestfs_h *g,\n"
6183 " const char *filename);\n"
6189 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6190 msgid "This function adds a virtual CD-ROM disk image to the guest."
6195 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6196 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
6201 #: ../src/guestfs-actions.pod:17
6203 "This call checks for the existence of C<filename>. This stops you from "
6204 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6205 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6211 #: ../src/guestfs-actions.pod:24
6213 "If you just want to add an ISO file (often you use this as an efficient way "
6214 "to transfer large files into the guest), then you should probably use "
6215 "C<guestfs_add_drive_ro> instead."
6220 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6221 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6222 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6223 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6224 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6225 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6226 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6227 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6228 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6229 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6230 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6231 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6232 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6233 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6234 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6235 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6236 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
6237 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
6238 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
6239 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
6240 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
6241 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3380
6242 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3420
6243 #: ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3589
6244 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3616
6245 #: ../src/guestfs-actions.pod:3631 ../src/guestfs-actions.pod:3667
6246 #: ../src/guestfs-actions.pod:3739 ../src/guestfs-actions.pod:3759
6247 #: ../src/guestfs-actions.pod:3776 ../src/guestfs-actions.pod:3799
6248 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3854
6249 #: ../src/guestfs-actions.pod:3873 ../src/guestfs-actions.pod:3892
6250 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3939
6251 #: ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:3991
6252 #: ../src/guestfs-actions.pod:4004 ../src/guestfs-actions.pod:4019
6253 #: ../src/guestfs-actions.pod:4036 ../src/guestfs-actions.pod:4129
6254 #: ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:4162
6255 #: ../src/guestfs-actions.pod:4213 ../src/guestfs-actions.pod:4231
6256 #: ../src/guestfs-actions.pod:4249 ../src/guestfs-actions.pod:4265
6257 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4293
6258 #: ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4325
6259 #: ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4403
6260 #: ../src/guestfs-actions.pod:4476 ../src/guestfs-actions.pod:4507
6261 #: ../src/guestfs-actions.pod:4526 ../src/guestfs-actions.pod:4545
6262 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4574
6263 #: ../src/guestfs-actions.pod:4587 ../src/guestfs-actions.pod:4602
6264 #: ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4652
6265 #: ../src/guestfs-actions.pod:4667 ../src/guestfs-actions.pod:4687
6266 #: ../src/guestfs-actions.pod:4701 ../src/guestfs-actions.pod:4718
6267 #: ../src/guestfs-actions.pod:4767 ../src/guestfs-actions.pod:4804
6268 #: ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:4846
6269 #: ../src/guestfs-actions.pod:4863 ../src/guestfs-actions.pod:4881
6270 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5072
6271 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5112
6272 #: ../src/guestfs-actions.pod:5144 ../src/guestfs-actions.pod:5210
6273 #: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5240
6274 #: ../src/guestfs-actions.pod:5254 ../src/guestfs-actions.pod:5543
6275 #: ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5581
6276 #: ../src/guestfs-actions.pod:5593 ../src/guestfs-actions.pod:5605
6277 #: ../src/guestfs-actions.pod:5619 ../src/guestfs-actions.pod:5631
6278 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5661
6279 #: ../src/guestfs-actions.pod:5682 ../src/guestfs-actions.pod:5701
6280 #: ../src/guestfs-actions.pod:5720 ../src/guestfs-actions.pod:5750
6281 #: ../src/guestfs-actions.pod:5766 ../src/guestfs-actions.pod:5789
6282 #: ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5826
6283 #: ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5866
6284 #: ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5911
6285 #: ../src/guestfs-actions.pod:5935 ../src/guestfs-actions.pod:5954
6286 #: ../src/guestfs-actions.pod:5978 ../src/guestfs-actions.pod:5997
6287 #: ../src/guestfs-actions.pod:6012 ../src/guestfs-actions.pod:6031
6288 #: ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6091
6289 #: ../src/guestfs-actions.pod:6117 ../src/guestfs-actions.pod:6225
6290 #: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6358
6291 #: ../src/guestfs-actions.pod:6371 ../src/guestfs-actions.pod:6384
6292 #: ../src/guestfs-actions.pod:6406 ../src/guestfs-actions.pod:6419
6293 #: ../src/guestfs-actions.pod:6432 ../src/guestfs-actions.pod:6445
6294 #: ../src/guestfs-actions.pod:6460 ../src/guestfs-actions.pod:6519
6295 #: ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6552
6296 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:6585
6297 #: ../src/guestfs-actions.pod:6598 ../src/guestfs-actions.pod:6618
6298 #: ../src/guestfs-actions.pod:6654 ../src/guestfs-actions.pod:6668
6299 #: ../src/guestfs-actions.pod:6709 ../src/guestfs-actions.pod:6722
6300 #: ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:6774
6301 #: ../src/guestfs-actions.pod:6810 ../src/guestfs-actions.pod:6929
6302 #: ../src/guestfs-actions.pod:6947 ../src/guestfs-actions.pod:6961
6303 #: ../src/guestfs-actions.pod:7016 ../src/guestfs-actions.pod:7029
6304 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7107
6305 #: ../src/guestfs-actions.pod:7161 ../src/guestfs-actions.pod:7187
6306 #: ../src/guestfs-actions.pod:7253 ../src/guestfs-actions.pod:7272
6307 #: ../src/guestfs-actions.pod:7301
6308 msgid "This function returns 0 on success or -1 on error."
6313 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6314 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6315 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6317 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6323 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6324 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6325 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
6326 #: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:7195
6327 #: ../src/guestfs-actions.pod:7364 ../fish/guestfish-actions.pod:31
6328 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6329 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6330 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:2942
6331 #: ../fish/guestfish-actions.pod:4800 ../fish/guestfish-actions.pod:4897
6333 "Deprecated functions will not be removed from the API, but the fact that "
6334 "they are deprecated indicates that there are problems with correct use of "
6340 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6341 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
6342 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
6343 #: ../src/guestfs-actions.pod:3382 ../src/guestfs-actions.pod:3402
6344 #: ../src/guestfs-actions.pod:4654 ../src/guestfs-actions.pod:5768
6345 #: ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:5999
6346 #: ../src/guestfs-actions.pod:6462 ../src/guestfs-actions.pod:6587
6347 #: ../src/guestfs-actions.pod:7109
6348 msgid "(Added in 0.3)"
6353 #: ../src/guestfs-actions.pod:41
6354 msgid "guestfs_add_domain"
6359 #: ../src/guestfs-actions.pod:43
6363 " guestfs_add_domain (guestfs_h *g,\n"
6364 " const char *dom,\n"
6371 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6372 #: ../src/guestfs-actions.pod:4364
6374 "You may supply a list of optional arguments to this call. Use zero or more "
6375 "of the following pairs of parameters, and terminate the list with C<-1> on "
6376 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6380 #: ../src/guestfs-actions.pod:53
6383 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6384 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6385 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6386 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6392 #: ../src/guestfs-actions.pod:58
6394 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6395 "It works by connecting to libvirt, requesting the domain and domain XML from "
6396 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6402 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6404 "The number of disks added is returned. This operation is atomic: if an "
6405 "error is returned, then no disks are added."
6410 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6412 "This function does some minimal checks to make sure the libvirt domain is "
6413 "not running (unless C<readonly> is true). In a future version we will try "
6414 "to acquire the libvirt lock on each disk."
6419 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6421 "Disks must be accessible locally. This often means that adding disks from a "
6422 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6423 "unless those disks are accessible via the same device path locally too."
6427 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6429 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6430 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6431 "libvirt URI (or one set through an environment variable, see the libvirt "
6432 "documentation for full details)."
6436 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6438 "The optional C<live> flag controls whether this call will try to connect to "
6439 "a running virtual machine C<guestfsd> process if it sees a suitable "
6440 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6441 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6442 "DAEMONS> for more information."
6447 #: ../src/guestfs-actions.pod:88
6449 "The other optional parameters are passed directly through to "
6450 "C<guestfs_add_drive_opts>."
6455 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6456 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6457 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6458 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6459 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
6460 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
6461 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
6462 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2728
6463 #: ../src/guestfs-actions.pod:2749 ../src/guestfs-actions.pod:4790
6464 #: ../src/guestfs-actions.pod:4918 ../src/guestfs-actions.pod:5324
6465 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:6695
6466 #: ../src/guestfs-actions.pod:7120 ../src/guestfs-actions.pod:7133
6467 #: ../src/guestfs-actions.pod:7146
6468 msgid "On error this function returns -1."
6473 #: ../src/guestfs-actions.pod:93
6474 msgid "(Added in 1.7.4)"
6479 #: ../src/guestfs-actions.pod:95
6480 msgid "guestfs_add_domain_va"
6485 #: ../src/guestfs-actions.pod:97
6489 " guestfs_add_domain_va (guestfs_h *g,\n"
6490 " const char *dom,\n"
6497 #: ../src/guestfs-actions.pod:102
6498 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6503 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6504 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6505 #: ../src/guestfs-actions.pod:4417 ../src/guestfs-actions.pod:4429
6506 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6511 #: ../src/guestfs-actions.pod:106
6512 msgid "guestfs_add_domain_argv"
6517 #: ../src/guestfs-actions.pod:108
6521 " guestfs_add_domain_argv (guestfs_h *g,\n"
6522 " const char *dom,\n"
6523 " const struct guestfs_add_domain_argv *optargs);\n"
6529 #: ../src/guestfs-actions.pod:113
6530 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6535 #: ../src/guestfs-actions.pod:117
6536 msgid "guestfs_add_drive"
6541 #: ../src/guestfs-actions.pod:119
6545 " guestfs_add_drive (guestfs_h *g,\n"
6546 " const char *filename);\n"
6552 #: ../src/guestfs-actions.pod:123
6554 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6555 "optional parameters, so the disk is added writable, with the format being "
6556 "detected automatically."
6561 #: ../src/guestfs-actions.pod:127
6563 "Automatic detection of the format opens you up to a potential security hole "
6564 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6565 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6566 "you should think about replacing calls to this function with calls to "
6567 "C<guestfs_add_drive_opts>, and specifying the format."
6572 #: ../src/guestfs-actions.pod:138
6573 msgid "guestfs_add_drive_opts"
6578 #: ../src/guestfs-actions.pod:140
6582 " guestfs_add_drive_opts (guestfs_h *g,\n"
6583 " const char *filename,\n"
6590 #: ../src/guestfs-actions.pod:150
6593 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6594 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6595 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6601 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6603 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6604 "The first time you call this function, the disk appears as C</dev/sda>, the "
6605 "second time as C</dev/sdb>, and so on."
6610 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6612 "You don't necessarily need to be root when using libguestfs. However you "
6613 "obviously do need sufficient permissions to access the filename for whatever "
6614 "operations you want to perform (ie. read access if you just want to read the "
6615 "image or write access if you want to modify the image)."
6620 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6621 msgid "This call checks that C<filename> exists."
6626 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4375
6627 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2953
6628 msgid "The optional arguments are:"
6633 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6639 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6641 "If true then the image is treated as read-only. Writes are still allowed, "
6642 "but they are stored in a temporary snapshot overlay which is discarded at "
6643 "the end. The disk that you add is not modified."
6648 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6654 #: ../src/guestfs-actions.pod:179
6656 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6657 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6658 "Possible formats include C<raw> and C<qcow2>."
6663 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6665 "Automatic detection of the format opens you up to a potential security hole "
6666 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6667 "RHBZ#642934. Specifying the format closes this security hole."
6672 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6678 #: ../src/guestfs-actions.pod:190
6680 "This rarely-used option lets you emulate the behaviour of the deprecated "
6681 "C<guestfs_add_drive_with_if> call (q.v.)"
6686 #: ../src/guestfs-actions.pod:197
6687 msgid "(Added in 1.5.23)"
6692 #: ../src/guestfs-actions.pod:199
6693 msgid "guestfs_add_drive_opts_va"
6698 #: ../src/guestfs-actions.pod:201
6702 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6703 " const char *filename,\n"
6710 #: ../src/guestfs-actions.pod:206
6711 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6716 #: ../src/guestfs-actions.pod:210
6717 msgid "guestfs_add_drive_opts_argv"
6722 #: ../src/guestfs-actions.pod:212
6726 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6727 " const char *filename,\n"
6728 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6734 #: ../src/guestfs-actions.pod:217
6735 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6740 #: ../src/guestfs-actions.pod:221
6741 msgid "guestfs_add_drive_ro"
6746 #: ../src/guestfs-actions.pod:223
6750 " guestfs_add_drive_ro (guestfs_h *g,\n"
6751 " const char *filename);\n"
6757 #: ../src/guestfs-actions.pod:227
6759 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6760 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6761 "disk is added read-only, with the format being detected automatically."
6766 #: ../src/guestfs-actions.pod:234
6767 msgid "(Added in 1.0.38)"
6772 #: ../src/guestfs-actions.pod:236
6773 msgid "guestfs_add_drive_ro_with_if"
6778 #: ../src/guestfs-actions.pod:238
6782 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6783 " const char *filename,\n"
6784 " const char *iface);\n"
6790 #: ../src/guestfs-actions.pod:243
6792 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6793 "QEMU interface emulation to use at run time."
6798 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6799 #: ../src/guestfs-actions.pod:2356
6800 msgid "(Added in 1.0.84)"
6805 #: ../src/guestfs-actions.pod:257
6806 msgid "guestfs_add_drive_with_if"
6811 #: ../src/guestfs-actions.pod:259
6815 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6816 " const char *filename,\n"
6817 " const char *iface);\n"
6823 #: ../src/guestfs-actions.pod:264
6825 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6826 "QEMU interface emulation to use at run time."
6831 #: ../src/guestfs-actions.pod:278
6832 msgid "guestfs_aug_clear"
6837 #: ../src/guestfs-actions.pod:280
6841 " guestfs_aug_clear (guestfs_h *g,\n"
6842 " const char *augpath);\n"
6848 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6850 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6851 "L<augtool(1)> C<clear> command."
6856 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6857 msgid "(Added in 1.3.4)"
6862 #: ../src/guestfs-actions.pod:291
6863 msgid "guestfs_aug_close"
6868 #: ../src/guestfs-actions.pod:293
6872 " guestfs_aug_close (guestfs_h *g);\n"
6878 #: ../src/guestfs-actions.pod:296
6880 "Close the current Augeas handle and free up any resources used by it. After "
6881 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6882 "any other Augeas functions."
6887 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6888 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6889 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6890 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6891 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6892 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6893 #: ../src/guestfs-actions.pod:5401
6894 msgid "(Added in 0.7)"
6899 #: ../src/guestfs-actions.pod:305
6900 msgid "guestfs_aug_defnode"
6905 #: ../src/guestfs-actions.pod:307
6908 " struct guestfs_int_bool *\n"
6909 " guestfs_aug_defnode (guestfs_h *g,\n"
6910 " const char *name,\n"
6911 " const char *expr,\n"
6912 " const char *val);\n"
6918 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6920 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6925 #: ../src/guestfs-actions.pod:316
6927 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6928 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6929 "containing that single node."
6934 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6936 "On success this returns a pair containing the number of nodes in the "
6937 "nodeset, and a boolean flag if a node was created."
6942 #: ../src/guestfs-actions.pod:324
6944 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6945 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6950 #: ../src/guestfs-actions.pod:330
6951 msgid "guestfs_aug_defvar"
6956 #: ../src/guestfs-actions.pod:332
6960 " guestfs_aug_defvar (guestfs_h *g,\n"
6961 " const char *name,\n"
6962 " const char *expr);\n"
6968 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6970 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6971 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6976 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6978 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6979 "evaluates to something which is not a nodeset."
6984 #: ../src/guestfs-actions.pod:348
6985 msgid "guestfs_aug_get"
6990 #: ../src/guestfs-actions.pod:350
6994 " guestfs_aug_get (guestfs_h *g,\n"
6995 " const char *augpath);\n"
7001 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
7003 "Look up the value associated with C<path>. If C<path> matches exactly one "
7004 "node, the C<value> is returned."
7009 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
7010 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
7011 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
7012 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
7013 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
7014 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
7015 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
7016 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
7017 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
7018 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
7019 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2680
7020 #: ../src/guestfs-actions.pod:2700 ../src/guestfs-actions.pod:2814
7021 #: ../src/guestfs-actions.pod:2845 ../src/guestfs-actions.pod:2869
7022 #: ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:2966
7023 #: ../src/guestfs-actions.pod:2989 ../src/guestfs-actions.pod:3561
7024 #: ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:4081
7025 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:4936
7026 #: ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:5299
7027 #: ../src/guestfs-actions.pod:5477 ../src/guestfs-actions.pod:5526
7028 #: ../src/guestfs-actions.pod:6138 ../src/guestfs-actions.pod:6154
7029 #: ../src/guestfs-actions.pod:6171 ../src/guestfs-actions.pod:6195
7030 #: ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6888
7031 #: ../src/guestfs-actions.pod:6906 ../src/guestfs-actions.pod:7086
7032 #: ../src/guestfs-actions.pod:7358
7034 "This function returns a string, or NULL on error. I<The caller must free "
7035 "the returned string after use>."
7040 #: ../src/guestfs-actions.pod:362
7041 msgid "guestfs_aug_init"
7046 #: ../src/guestfs-actions.pod:364
7050 " guestfs_aug_init (guestfs_h *g,\n"
7051 " const char *root,\n"
7058 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7060 "Create a new Augeas handle for editing configuration files. If there was "
7061 "any previous Augeas handle associated with this guestfs session, then it is "
7067 #: ../src/guestfs-actions.pod:373
7068 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7073 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7075 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7080 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7082 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7083 "logical I<or> of the following integers:"
7088 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7089 msgid "C<AUG_SAVE_BACKUP> = 1"
7094 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7095 msgid "Keep the original file with a C<.augsave> extension."
7100 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7101 msgid "C<AUG_SAVE_NEWFILE> = 2"
7106 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7108 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7109 "original. Overrides C<AUG_SAVE_BACKUP>."
7114 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7115 msgid "C<AUG_TYPE_CHECK> = 4"
7120 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7121 msgid "Typecheck lenses (can be expensive)."
7126 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7127 msgid "C<AUG_NO_STDINC> = 8"
7132 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7133 msgid "Do not use standard load path for modules."
7138 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7139 msgid "C<AUG_SAVE_NOOP> = 16"
7144 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7145 msgid "Make save a no-op, just record what would have been changed."
7150 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7151 msgid "C<AUG_NO_LOAD> = 32"
7156 #: ../src/guestfs-actions.pod:408
7157 msgid "Do not load the tree in C<guestfs_aug_init>."
7162 #: ../src/guestfs-actions.pod:412
7163 msgid "To close the handle, you can call C<guestfs_aug_close>."
7168 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7169 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7174 #: ../src/guestfs-actions.pod:420
7175 msgid "guestfs_aug_insert"
7180 #: ../src/guestfs-actions.pod:422
7184 " guestfs_aug_insert (guestfs_h *g,\n"
7185 " const char *augpath,\n"
7186 " const char *label,\n"
7193 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7195 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7196 "or after C<path> (depending on the boolean flag C<before>)."
7201 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7203 "C<path> must match exactly one existing node in the tree, and C<label> must "
7204 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7209 #: ../src/guestfs-actions.pod:440
7210 msgid "guestfs_aug_load"
7215 #: ../src/guestfs-actions.pod:442
7219 " guestfs_aug_load (guestfs_h *g);\n"
7225 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7226 msgid "Load files into the tree."
7231 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7232 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7237 #: ../src/guestfs-actions.pod:454
7238 msgid "guestfs_aug_ls"
7243 #: ../src/guestfs-actions.pod:456
7247 " guestfs_aug_ls (guestfs_h *g,\n"
7248 " const char *augpath);\n"
7254 #: ../src/guestfs-actions.pod:460
7256 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7257 "sorting the resulting nodes into alphabetical order."
7262 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7263 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7264 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
7265 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
7266 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
7267 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
7268 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
7269 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
7270 #: ../src/guestfs-actions.pod:2638 ../src/guestfs-actions.pod:2923
7271 #: ../src/guestfs-actions.pod:3191 ../src/guestfs-actions.pod:3481
7272 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3648
7273 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4751
7274 #: ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5397
7275 #: ../src/guestfs-actions.pod:5511 ../src/guestfs-actions.pod:6211
7276 #: ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6327
7277 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6497
7278 #: ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:6999
7279 #: ../src/guestfs-actions.pod:7046 ../src/guestfs-actions.pod:7211
7280 #: ../src/guestfs-actions.pod:7230 ../src/guestfs-actions.pod:7315
7281 #: ../src/guestfs-actions.pod:7334 ../src/guestfs-actions.pod:7380
7282 #: ../src/guestfs-actions.pod:7399
7284 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7285 ">), or NULL if there was an error. I<The caller must free the strings and "
7286 "the array after use>."
7291 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7292 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
7293 #: ../src/guestfs-actions.pod:3269 ../src/guestfs-actions.pod:3300
7294 #: ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:3944
7295 #: ../src/guestfs-actions.pod:4131 ../src/guestfs-actions.pod:4164
7296 #: ../src/guestfs-actions.pod:4327 ../src/guestfs-actions.pod:4755
7297 #: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5607
7298 #: ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5633
7299 #: ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6711
7300 #: ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6963
7301 #: ../src/guestfs-actions.pod:7199
7302 msgid "(Added in 0.8)"
7307 #: ../src/guestfs-actions.pod:469
7308 msgid "guestfs_aug_match"
7313 #: ../src/guestfs-actions.pod:471
7317 " guestfs_aug_match (guestfs_h *g,\n"
7318 " const char *augpath);\n"
7324 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7326 "Returns a list of paths which match the path expression C<path>. The "
7327 "returned paths are sufficiently qualified so that they match exactly one "
7328 "node in the current tree."
7333 #: ../src/guestfs-actions.pod:485
7334 msgid "guestfs_aug_mv"
7339 #: ../src/guestfs-actions.pod:487
7343 " guestfs_aug_mv (guestfs_h *g,\n"
7344 " const char *src,\n"
7345 " const char *dest);\n"
7351 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7353 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7354 "C<dest> is overwritten if it exists."
7359 #: ../src/guestfs-actions.pod:499
7360 msgid "guestfs_aug_rm"
7365 #: ../src/guestfs-actions.pod:501
7369 " guestfs_aug_rm (guestfs_h *g,\n"
7370 " const char *augpath);\n"
7376 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7377 msgid "Remove C<path> and all of its children."
7382 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7383 msgid "On success this returns the number of entries which were removed."
7388 #: ../src/guestfs-actions.pod:513
7389 msgid "guestfs_aug_save"
7394 #: ../src/guestfs-actions.pod:515
7398 " guestfs_aug_save (guestfs_h *g);\n"
7404 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7405 msgid "This writes all pending changes to disk."
7410 #: ../src/guestfs-actions.pod:520
7412 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7418 #: ../src/guestfs-actions.pod:527
7419 msgid "guestfs_aug_set"
7424 #: ../src/guestfs-actions.pod:529
7428 " guestfs_aug_set (guestfs_h *g,\n"
7429 " const char *augpath,\n"
7430 " const char *val);\n"
7436 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7437 msgid "Set the value associated with C<path> to C<val>."
7442 #: ../src/guestfs-actions.pod:536
7444 "In the Augeas API, it is possible to clear a node by setting the value to "
7445 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7446 "this call. Instead you must use the C<guestfs_aug_clear> call."
7451 #: ../src/guestfs-actions.pod:545
7452 msgid "guestfs_available"
7457 #: ../src/guestfs-actions.pod:547
7461 " guestfs_available (guestfs_h *g,\n"
7462 " char *const *groups);\n"
7468 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7470 "This command is used to check the availability of some groups of "
7471 "functionality in the appliance, which not all builds of the libguestfs "
7472 "appliance will be able to provide."
7477 #: ../src/guestfs-actions.pod:555
7479 "The libguestfs groups, and the functions that those groups correspond to, "
7480 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7481 "runtime by calling C<guestfs_available_all_groups>."
7486 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7488 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7489 "\"]> would check for the availability of the Linux inotify functions and "
7490 "Augeas (configuration file editing) functions."
7495 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7496 msgid "The command returns no error if I<all> requested groups are available."
7501 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7503 "It fails with an error if one or more of the requested groups is unavailable "
7509 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7511 "If an unknown group name is included in the list of groups then an error is "
7517 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7523 #: ../src/guestfs-actions.pod:579
7524 msgid "You must call C<guestfs_launch> before calling this function."
7529 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7531 "The reason is because we don't know what groups are supported by the "
7532 "appliance/daemon until it is running and can be queried."
7537 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7539 "If a group of functions is available, this does not necessarily mean that "
7540 "they will work. You still have to check for errors when calling individual "
7541 "API functions even if they are available."
7546 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7548 "It is usually the job of distro packagers to build complete functionality "
7549 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7550 "with all requirements satisfied, will support everything."
7555 #: ../src/guestfs-actions.pod:601
7557 "This call was added in version C<1.0.80>. In previous versions of "
7558 "libguestfs all you could do would be to speculatively execute a command to "
7559 "find out if the daemon implemented it. See also C<guestfs_version>."
7564 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7565 msgid "(Added in 1.0.80)"
7570 #: ../src/guestfs-actions.pod:612
7571 msgid "guestfs_available_all_groups"
7576 #: ../src/guestfs-actions.pod:614
7580 " guestfs_available_all_groups (guestfs_h *g);\n"
7586 #: ../src/guestfs-actions.pod:617
7588 "This command returns a list of all optional groups that this daemon knows "
7589 "about. Note this returns both supported and unsupported groups. To find "
7590 "out which ones the daemon can actually support you have to call "
7591 "C<guestfs_available> on each member of the returned list."
7596 #: ../src/guestfs-actions.pod:623
7597 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7602 #: ../src/guestfs-actions.pod:629
7603 msgid "(Added in 1.3.15)"
7608 #: ../src/guestfs-actions.pod:631
7609 msgid "guestfs_base64_in"
7614 #: ../src/guestfs-actions.pod:633
7618 " guestfs_base64_in (guestfs_h *g,\n"
7619 " const char *base64file,\n"
7620 " const char *filename);\n"
7626 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7628 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7633 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7634 msgid "(Added in 1.3.5)"
7639 #: ../src/guestfs-actions.pod:645
7640 msgid "guestfs_base64_out"
7645 #: ../src/guestfs-actions.pod:647
7649 " guestfs_base64_out (guestfs_h *g,\n"
7650 " const char *filename,\n"
7651 " const char *base64file);\n"
7657 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7659 "This command downloads the contents of C<filename>, writing it out to local "
7660 "file C<base64file> encoded as base64."
7665 #: ../src/guestfs-actions.pod:659
7666 msgid "guestfs_blockdev_flushbufs"
7671 #: ../src/guestfs-actions.pod:661
7675 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7676 " const char *device);\n"
7682 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7684 "This tells the kernel to flush internal buffers associated with C<device>."
7689 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7690 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7691 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7692 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7693 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7694 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7695 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7696 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7697 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7698 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7699 msgid "This uses the L<blockdev(8)> command."
7704 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7705 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7706 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7707 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7708 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7709 msgid "(Added in 0.9.3)"
7714 #: ../src/guestfs-actions.pod:674
7715 msgid "guestfs_blockdev_getbsz"
7720 #: ../src/guestfs-actions.pod:676
7724 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7725 " const char *device);\n"
7731 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7732 msgid "This returns the block size of a device."
7737 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7738 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7740 "(Note this is different from both I<size in blocks> and I<filesystem block "
7746 #: ../src/guestfs-actions.pod:691
7747 msgid "guestfs_blockdev_getro"
7752 #: ../src/guestfs-actions.pod:693
7756 " guestfs_blockdev_getro (guestfs_h *g,\n"
7757 " const char *device);\n"
7763 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7765 "Returns a boolean indicating if the block device is read-only (true if read-"
7766 "only, false if not)."
7771 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7772 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7773 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7774 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7775 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7776 #: ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3026
7777 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3208
7778 #: ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3237
7779 #: ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3267
7780 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3298
7781 #: ../src/guestfs-actions.pod:3312 ../src/guestfs-actions.pod:3325
7782 #: ../src/guestfs-actions.pod:3339 ../src/guestfs-actions.pod:3354
7783 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:4900
7784 msgid "This function returns a C truth value on success or -1 on error."
7789 #: ../src/guestfs-actions.pod:706
7790 msgid "guestfs_blockdev_getsize64"
7795 #: ../src/guestfs-actions.pod:708
7799 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7800 " const char *device);\n"
7806 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7807 msgid "This returns the size of the device in bytes."
7812 #: ../src/guestfs-actions.pod:714
7813 msgid "See also C<guestfs_blockdev_getsz>."
7818 #: ../src/guestfs-actions.pod:722
7819 msgid "guestfs_blockdev_getss"
7824 #: ../src/guestfs-actions.pod:724
7828 " guestfs_blockdev_getss (guestfs_h *g,\n"
7829 " const char *device);\n"
7835 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7837 "This returns the size of sectors on a block device. Usually 512, but can be "
7838 "larger for modern devices."
7843 #: ../src/guestfs-actions.pod:731
7845 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7851 #: ../src/guestfs-actions.pod:740
7852 msgid "guestfs_blockdev_getsz"
7857 #: ../src/guestfs-actions.pod:742
7861 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7862 " const char *device);\n"
7868 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7870 "This returns the size of the device in units of 512-byte sectors (even if "
7871 "the sectorsize isn't 512 bytes ... weird)."
7876 #: ../src/guestfs-actions.pod:749
7878 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7879 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7884 #: ../src/guestfs-actions.pod:759
7885 msgid "guestfs_blockdev_rereadpt"
7890 #: ../src/guestfs-actions.pod:761
7894 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7895 " const char *device);\n"
7901 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7902 msgid "Reread the partition table on C<device>."
7907 #: ../src/guestfs-actions.pod:773
7908 msgid "guestfs_blockdev_setbsz"
7913 #: ../src/guestfs-actions.pod:775
7917 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7918 " const char *device,\n"
7919 " int blocksize);\n"
7925 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7926 msgid "This sets the block size of a device."
7931 #: ../src/guestfs-actions.pod:791
7932 msgid "guestfs_blockdev_setro"
7937 #: ../src/guestfs-actions.pod:793
7941 " guestfs_blockdev_setro (guestfs_h *g,\n"
7942 " const char *device);\n"
7948 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7949 msgid "Sets the block device named C<device> to read-only."
7954 #: ../src/guestfs-actions.pod:805
7955 msgid "guestfs_blockdev_setrw"
7960 #: ../src/guestfs-actions.pod:807
7964 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7965 " const char *device);\n"
7971 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7972 msgid "Sets the block device named C<device> to read-write."
7977 #: ../src/guestfs-actions.pod:819
7978 msgid "guestfs_case_sensitive_path"
7983 #: ../src/guestfs-actions.pod:821
7987 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7988 " const char *path);\n"
7994 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7996 "This can be used to resolve case insensitive paths on a filesystem which is "
7997 "case sensitive. The use case is to resolve paths which you have read from "
7998 "Windows configuration files or the Windows Registry, to the true path."
8003 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
8005 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
8006 "(and probably others), which is that although the underlying filesystem is "
8007 "case-insensitive, the driver exports the filesystem to Linux as case-"
8013 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
8015 "One consequence of this is that special directories such as C<c:\\windows> "
8016 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
8017 "precise details of how they were created. In Windows itself this would not "
8023 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8025 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8031 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8033 "This function resolves the true case of each element in the path and returns "
8034 "the case-sensitive path."
8039 #: ../src/guestfs-actions.pod:847
8041 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8042 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8043 "how the directories were originally created under Windows)."
8048 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8049 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8054 #: ../src/guestfs-actions.pod:855
8055 msgid "See also C<guestfs_realpath>."
8060 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6891
8061 msgid "(Added in 1.0.75)"
8066 #: ../src/guestfs-actions.pod:862
8072 #: ../src/guestfs-actions.pod:864
8076 " guestfs_cat (guestfs_h *g,\n"
8077 " const char *path);\n"
8083 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5387
8084 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3601
8085 msgid "Return the contents of the file named C<path>."
8090 #: ../src/guestfs-actions.pod:870
8092 "Note that this function cannot correctly handle binary files (specifically, "
8093 "files containing C<\\0> character which is treated as end of string). For "
8094 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8095 "functions which have a more complex interface."
8100 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8101 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
8102 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
8103 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
8104 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
8105 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
8106 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
8107 #: ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:5195
8108 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5352
8109 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:6276
8110 #: ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6477
8111 #: ../src/guestfs-actions.pod:6501 ../src/guestfs-actions.pod:7163
8112 #: ../src/guestfs-actions.pod:7189 ../src/guestfs-actions.pod:7215
8113 #: ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7319
8114 #: ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7384
8115 #: ../src/guestfs-actions.pod:7403 ../fish/guestfish-actions.pod:587
8116 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8117 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8118 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8119 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8120 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8121 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8122 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3471
8123 #: ../fish/guestfish-actions.pod:3486 ../fish/guestfish-actions.pod:3562
8124 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3594
8125 #: ../fish/guestfish-actions.pod:4220 ../fish/guestfish-actions.pod:4266
8126 #: ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4366
8127 #: ../fish/guestfish-actions.pod:4776 ../fish/guestfish-actions.pod:4794
8128 #: ../fish/guestfish-actions.pod:4811 ../fish/guestfish-actions.pod:4821
8129 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
8130 #: ../fish/guestfish-actions.pod:4908 ../fish/guestfish-actions.pod:4918
8132 "Because of the message protocol, there is a transfer limit of somewhere "
8133 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8138 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3485
8139 #: ../src/guestfs-actions.pod:3547 ../src/guestfs-actions.pod:3564
8140 #: ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:4057
8141 #: ../src/guestfs-actions.pod:4071 ../src/guestfs-actions.pod:5275
8142 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:7050
8143 #: ../src/guestfs-actions.pod:7064
8144 msgid "(Added in 0.4)"
8149 #: ../src/guestfs-actions.pod:883
8150 msgid "guestfs_checksum"
8155 #: ../src/guestfs-actions.pod:885
8159 " guestfs_checksum (guestfs_h *g,\n"
8160 " const char *csumtype,\n"
8161 " const char *path);\n"
8167 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8169 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8174 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8176 "The type of checksum to compute is given by the C<csumtype> parameter which "
8177 "must have one of the following values:"
8182 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8188 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8190 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8196 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8202 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8203 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8208 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8214 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8215 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8220 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8226 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8227 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8232 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8238 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8239 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8244 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8250 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8251 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8256 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8262 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8263 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8268 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8269 msgid "The checksum is returned as a printable string."
8274 #: ../src/guestfs-actions.pod:931
8275 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8280 #: ../src/guestfs-actions.pod:933
8281 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8286 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8287 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3224
8288 #: ../src/guestfs-actions.pod:3253 ../src/guestfs-actions.pod:3314
8289 #: ../src/guestfs-actions.pod:3341 ../src/guestfs-actions.pod:6747
8290 msgid "(Added in 1.0.2)"
8295 #: ../src/guestfs-actions.pod:940
8296 msgid "guestfs_checksum_device"
8301 #: ../src/guestfs-actions.pod:942
8305 " guestfs_checksum_device (guestfs_h *g,\n"
8306 " const char *csumtype,\n"
8307 " const char *device);\n"
8313 #: ../src/guestfs-actions.pod:947
8315 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8316 "device named C<device>. For the types of checksums supported see the "
8317 "C<guestfs_checksum> command."
8322 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4806
8323 #: ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:4902
8324 #: ../src/guestfs-actions.pod:4920 ../src/guestfs-actions.pod:5096
8325 #: ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6670
8326 #: ../src/guestfs-actions.pod:7076
8327 msgid "(Added in 1.3.2)"
8332 #: ../src/guestfs-actions.pod:956
8333 msgid "guestfs_checksums_out"
8338 #: ../src/guestfs-actions.pod:958
8342 " guestfs_checksums_out (guestfs_h *g,\n"
8343 " const char *csumtype,\n"
8344 " const char *directory,\n"
8345 " const char *sumsfile);\n"
8351 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8353 "This command computes the checksums of all regular files in C<directory> and "
8354 "then emits a list of those checksums to the local output file C<sumsfile>."
8359 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8361 "This can be used for verifying the integrity of a virtual machine. However "
8362 "to be properly secure you should pay attention to the output of the checksum "
8363 "command (it uses the ones from GNU coreutils). In particular when the "
8364 "filename is not printable, coreutils uses a special backslash syntax. For "
8365 "more information, see the GNU coreutils info file."
8370 #: ../src/guestfs-actions.pod:978
8371 msgid "(Added in 1.3.7)"
8376 #: ../src/guestfs-actions.pod:980
8377 msgid "guestfs_chmod"
8382 #: ../src/guestfs-actions.pod:982
8386 " guestfs_chmod (guestfs_h *g,\n"
8388 " const char *path);\n"
8394 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8396 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8402 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8404 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8405 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8411 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4308
8412 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4524
8413 #: ../src/guestfs-actions.pod:4543 ../fish/guestfish-actions.pod:676
8414 #: ../fish/guestfish-actions.pod:2917 ../fish/guestfish-actions.pod:3046
8415 #: ../fish/guestfish-actions.pod:3056 ../fish/guestfish-actions.pod:3066
8416 msgid "The mode actually set is affected by the umask."
8421 #: ../src/guestfs-actions.pod:1000
8422 msgid "guestfs_chown"
8427 #: ../src/guestfs-actions.pod:1002
8431 " guestfs_chown (guestfs_h *g,\n"
8434 " const char *path);\n"
8440 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8441 msgid "Change the file owner to C<owner> and group to C<group>."
8446 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3416
8447 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2375
8449 "Only numeric uid and gid are supported. If you want to use names, you will "
8450 "need to locate and parse the password file yourself (Augeas support makes "
8451 "this relatively easy)."
8456 #: ../src/guestfs-actions.pod:1018
8457 msgid "guestfs_command"
8462 #: ../src/guestfs-actions.pod:1020
8466 " guestfs_command (guestfs_h *g,\n"
8467 " char *const *arguments);\n"
8473 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8475 "This call runs a command from the guest filesystem. The filesystem must be "
8476 "mounted, and must contain a compatible operating system (ie. something "
8477 "Linux, with the same or compatible processor architecture)."
8482 #: ../src/guestfs-actions.pod:1029
8484 "The single parameter is an argv-style list of arguments. The first element "
8485 "is the name of the program to run. Subsequent elements are parameters. The "
8486 "list must be non-empty (ie. must contain a program name). Note that the "
8487 "command runs directly, and is I<not> invoked via the shell (see "
8493 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8494 msgid "The return value is anything printed to I<stdout> by the command."
8499 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8501 "If the command returns a non-zero exit status, then this function returns an "
8502 "error message. The error message string is the content of I<stderr> from "
8508 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8510 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8511 "bin>. If you require a program from another location, you should provide "
8512 "the full path in the first parameter."
8517 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8519 "Shared libraries and data files required by the program must be available on "
8520 "filesystems which are mounted in the correct places. It is the caller's "
8521 "responsibility to ensure all filesystems that are needed are mounted at the "
8527 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8528 #: ../src/guestfs-actions.pod:1548
8529 msgid "(Added in 0.9.1)"
8534 #: ../src/guestfs-actions.pod:1062
8535 msgid "guestfs_command_lines"
8540 #: ../src/guestfs-actions.pod:1064
8544 " guestfs_command_lines (guestfs_h *g,\n"
8545 " char *const *arguments);\n"
8551 #: ../src/guestfs-actions.pod:1068
8553 "This is the same as C<guestfs_command>, but splits the result into a list of "
8559 #: ../src/guestfs-actions.pod:1071
8560 msgid "See also: C<guestfs_sh_lines>"
8565 #: ../src/guestfs-actions.pod:1082
8566 msgid "guestfs_config"
8571 #: ../src/guestfs-actions.pod:1084
8575 " guestfs_config (guestfs_h *g,\n"
8576 " const char *qemuparam,\n"
8577 " const char *qemuvalue);\n"
8583 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8585 "This can be used to add arbitrary qemu command line parameters of the form "
8586 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8587 "setting some parameters which would interfere with parameters that we use."
8592 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8593 msgid "The first character of C<param> string must be a C<-> (dash)."
8598 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8599 msgid "C<value> can be NULL."
8604 #: ../src/guestfs-actions.pod:1102
8605 msgid "guestfs_copy_size"
8610 #: ../src/guestfs-actions.pod:1104
8614 " guestfs_copy_size (guestfs_h *g,\n"
8615 " const char *src,\n"
8616 " const char *dest,\n"
8623 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8625 "This command copies exactly C<size> bytes from one source device or file "
8626 "C<src> to another destination device or file C<dest>."
8631 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8633 "Note this will fail if the source is too short or if the destination is not "
8638 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8639 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8640 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
8641 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:6742
8642 #: ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:7255
8643 #: ../src/guestfs-actions.pod:7274
8645 "This long-running command can generate progress notification messages so "
8646 "that the caller can display a progress bar or indicator. To receive these "
8647 "messages, the caller must register a progress event callback. See L<guestfs"
8648 "(3)/GUESTFS_EVENT_PROGRESS>."
8653 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4084
8654 #: ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:6983
8655 #: ../src/guestfs-actions.pod:7003 ../src/guestfs-actions.pod:7089
8656 msgid "(Added in 1.0.87)"
8661 #: ../src/guestfs-actions.pod:1125
8667 #: ../src/guestfs-actions.pod:1127
8671 " guestfs_cp (guestfs_h *g,\n"
8672 " const char *src,\n"
8673 " const char *dest);\n"
8679 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8681 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8682 "destination filename or destination directory."
8687 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8688 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8689 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4769
8690 #: ../src/guestfs-actions.pod:5146
8691 msgid "(Added in 1.0.18)"
8696 #: ../src/guestfs-actions.pod:1139
8697 msgid "guestfs_cp_a"
8702 #: ../src/guestfs-actions.pod:1141
8706 " guestfs_cp_a (guestfs_h *g,\n"
8707 " const char *src,\n"
8708 " const char *dest);\n"
8714 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8716 "This copies a file or directory from C<src> to C<dest> recursively using the "
8722 #: ../src/guestfs-actions.pod:1153
8728 #: ../src/guestfs-actions.pod:1155
8732 " guestfs_dd (guestfs_h *g,\n"
8733 " const char *src,\n"
8734 " const char *dest);\n"
8740 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8742 "This command copies from one source device or file C<src> to another "
8743 "destination device or file C<dest>. Normally you would use this to copy to "
8744 "or from a device or partition, for example to duplicate a filesystem."
8749 #: ../src/guestfs-actions.pod:1165
8751 "If the destination is a device, it must be as large or larger than the "
8752 "source file or device, otherwise the copy will fail. This command cannot do "
8753 "partial copies (see C<guestfs_copy_size>)."
8758 #: ../src/guestfs-actions.pod:1173
8764 #: ../src/guestfs-actions.pod:1175
8768 " guestfs_df (guestfs_h *g);\n"
8774 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8775 msgid "This command runs the C<df> command to report disk space used."
8780 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8782 "This command is mostly useful for interactive sessions. It is I<not> "
8783 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8789 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8790 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8791 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8792 #: ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4669
8793 #: ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6504
8794 #: ../src/guestfs-actions.pod:7122 ../src/guestfs-actions.pod:7135
8795 #: ../src/guestfs-actions.pod:7148
8796 msgid "(Added in 1.0.54)"
8801 #: ../src/guestfs-actions.pod:1189
8802 msgid "guestfs_df_h"
8807 #: ../src/guestfs-actions.pod:1191
8811 " guestfs_df_h (guestfs_h *g);\n"
8817 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8819 "This command runs the C<df -h> command to report disk space used in human-"
8825 #: ../src/guestfs-actions.pod:1206
8826 msgid "guestfs_dmesg"
8831 #: ../src/guestfs-actions.pod:1208
8835 " guestfs_dmesg (guestfs_h *g);\n"
8841 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8843 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8844 "This is sometimes useful for extended debugging of problems."
8849 #: ../src/guestfs-actions.pod:1215
8851 "Another way to get the same information is to enable verbose messages with "
8852 "C<guestfs_set_verbose> or by setting the environment variable "
8853 "C<LIBGUESTFS_DEBUG=1> before running the program."
8858 #: ../src/guestfs-actions.pod:1225
8859 msgid "guestfs_download"
8864 #: ../src/guestfs-actions.pod:1227
8868 " guestfs_download (guestfs_h *g,\n"
8869 " const char *remotefilename,\n"
8870 " const char *filename);\n"
8876 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8877 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8879 "Download file C<remotefilename> and save it as C<filename> on the local "
8885 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6736
8886 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4524
8887 msgid "C<filename> can also be a named pipe."
8892 #: ../src/guestfs-actions.pod:1237
8893 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8898 #: ../src/guestfs-actions.pod:1248
8899 msgid "guestfs_download_offset"
8904 #: ../src/guestfs-actions.pod:1250
8908 " guestfs_download_offset (guestfs_h *g,\n"
8909 " const char *remotefilename,\n"
8910 " const char *filename,\n"
8911 " int64_t offset,\n"
8918 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8920 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8921 "region must be within the file or device)."
8926 #: ../src/guestfs-actions.pod:1263
8928 "Note that there is no limit on the amount of data that can be downloaded "
8929 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8930 "full amount unless an error occurs."
8935 #: ../src/guestfs-actions.pod:1268
8936 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8941 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6781
8942 msgid "(Added in 1.5.17)"
8947 #: ../src/guestfs-actions.pod:1279
8948 msgid "guestfs_drop_caches"
8953 #: ../src/guestfs-actions.pod:1281
8957 " guestfs_drop_caches (guestfs_h *g,\n"
8958 " int whattodrop);\n"
8964 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8966 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8967 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8968 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8973 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8974 msgid "Setting C<whattodrop> to 3 should drop everything."
8979 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8981 "This automatically calls L<sync(2)> before the operation, so that the "
8982 "maximum guest memory is freed."
8987 #: ../src/guestfs-actions.pod:1299
8993 #: ../src/guestfs-actions.pod:1301
8997 " guestfs_du (guestfs_h *g,\n"
8998 " const char *path);\n"
9004 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
9006 "This command runs the C<du -s> command to estimate file space usage for "
9012 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
9014 "C<path> can be a file or a directory. If C<path> is a directory then the "
9015 "estimate includes the contents of the directory and all subdirectories "
9021 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9023 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9028 #: ../src/guestfs-actions.pod:1324
9029 msgid "guestfs_e2fsck_f"
9034 #: ../src/guestfs-actions.pod:1326
9038 " guestfs_e2fsck_f (guestfs_h *g,\n"
9039 " const char *device);\n"
9045 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
9047 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9048 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
9054 #: ../src/guestfs-actions.pod:1334
9056 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9057 "Normally you should use C<guestfs_fsck>."
9062 #: ../src/guestfs-actions.pod:1339
9063 msgid "(Added in 1.0.29)"
9068 #: ../src/guestfs-actions.pod:1341
9069 msgid "guestfs_echo_daemon"
9074 #: ../src/guestfs-actions.pod:1343
9078 " guestfs_echo_daemon (guestfs_h *g,\n"
9079 " char *const *words);\n"
9085 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
9087 "This command concatenates the list of C<words> passed with single spaces "
9088 "between them and returns the resulting string."
9093 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
9094 msgid "You can use this command to test the connection through to the daemon."
9099 #: ../src/guestfs-actions.pod:1352
9100 msgid "See also C<guestfs_ping_daemon>."
9105 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
9106 #: ../src/guestfs-actions.pod:5980
9107 msgid "(Added in 1.0.69)"
9112 #: ../src/guestfs-actions.pod:1359
9113 msgid "guestfs_egrep"
9118 #: ../src/guestfs-actions.pod:1361
9122 " guestfs_egrep (guestfs_h *g,\n"
9123 " const char *regex,\n"
9124 " const char *path);\n"
9130 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
9132 "This calls the external C<egrep> program and returns the matching lines."
9137 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
9138 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
9139 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
9140 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
9141 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
9142 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
9143 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3577
9144 #: ../src/guestfs-actions.pod:3591 ../src/guestfs-actions.pod:3604
9145 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:4604
9146 #: ../src/guestfs-actions.pod:5480 ../src/guestfs-actions.pod:5529
9147 #: ../src/guestfs-actions.pod:6348 ../src/guestfs-actions.pod:6360
9148 #: ../src/guestfs-actions.pod:6373 ../src/guestfs-actions.pod:6386
9149 #: ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6421
9150 #: ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6447
9151 #: ../src/guestfs-actions.pod:7218 ../src/guestfs-actions.pod:7237
9152 #: ../src/guestfs-actions.pod:7322 ../src/guestfs-actions.pod:7341
9153 #: ../src/guestfs-actions.pod:7387 ../src/guestfs-actions.pod:7406
9154 msgid "(Added in 1.0.66)"
9159 #: ../src/guestfs-actions.pod:1378
9160 msgid "guestfs_egrepi"
9165 #: ../src/guestfs-actions.pod:1380
9169 " guestfs_egrepi (guestfs_h *g,\n"
9170 " const char *regex,\n"
9171 " const char *path);\n"
9177 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
9179 "This calls the external C<egrep -i> program and returns the matching lines."
9184 #: ../src/guestfs-actions.pod:1397
9185 msgid "guestfs_equal"
9190 #: ../src/guestfs-actions.pod:1399
9194 " guestfs_equal (guestfs_h *g,\n"
9195 " const char *file1,\n"
9196 " const char *file2);\n"
9202 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
9204 "This compares the two files C<file1> and C<file2> and returns true if their "
9205 "content is exactly equal, or false otherwise."
9210 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
9211 msgid "The external L<cmp(1)> program is used for the comparison."
9216 #: ../src/guestfs-actions.pod:1413
9217 msgid "guestfs_exists"
9222 #: ../src/guestfs-actions.pod:1415
9226 " guestfs_exists (guestfs_h *g,\n"
9227 " const char *path);\n"
9233 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
9235 "This returns C<true> if and only if there is a file, directory (or anything) "
9236 "with the given C<path> name."
9241 #: ../src/guestfs-actions.pod:1422
9242 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9247 #: ../src/guestfs-actions.pod:1428
9248 msgid "guestfs_fallocate"
9253 #: ../src/guestfs-actions.pod:1430
9257 " guestfs_fallocate (guestfs_h *g,\n"
9258 " const char *path,\n"
9265 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
9266 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9268 "This command preallocates a file (containing zero bytes) named C<path> of "
9269 "size C<len> bytes. If the file exists already, it is overwritten."
9274 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
9276 "Do not confuse this with the guestfish-specific C<alloc> command which "
9277 "allocates a file in the host and attaches it as a device."
9282 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
9284 "This function is deprecated. In new code, use the C<fallocate64> call "
9290 #: ../src/guestfs-actions.pod:1454
9291 msgid "guestfs_fallocate64"
9296 #: ../src/guestfs-actions.pod:1456
9300 " guestfs_fallocate64 (guestfs_h *g,\n"
9301 " const char *path,\n"
9308 #: ../src/guestfs-actions.pod:1465
9310 "Note that this call allocates disk blocks for the file. To create a sparse "
9311 "file use C<guestfs_truncate_size> instead."
9316 #: ../src/guestfs-actions.pod:1468
9318 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9319 "oversight it only allowed 30 bit lengths to be specified, effectively "
9320 "limiting the maximum size of files created through that call to 1GB."
9325 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
9327 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9328 "commands which create a file in the host and attach it as a device."
9333 #: ../src/guestfs-actions.pod:1479
9334 msgid "(Added in 1.3.17)"
9339 #: ../src/guestfs-actions.pod:1481
9340 msgid "guestfs_fgrep"
9345 #: ../src/guestfs-actions.pod:1483
9349 " guestfs_fgrep (guestfs_h *g,\n"
9350 " const char *pattern,\n"
9351 " const char *path);\n"
9357 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
9359 "This calls the external C<fgrep> program and returns the matching lines."
9364 #: ../src/guestfs-actions.pod:1500
9365 msgid "guestfs_fgrepi"
9370 #: ../src/guestfs-actions.pod:1502
9374 " guestfs_fgrepi (guestfs_h *g,\n"
9375 " const char *pattern,\n"
9376 " const char *path);\n"
9382 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
9384 "This calls the external C<fgrep -i> program and returns the matching lines."
9389 #: ../src/guestfs-actions.pod:1519
9390 msgid "guestfs_file"
9395 #: ../src/guestfs-actions.pod:1521
9399 " guestfs_file (guestfs_h *g,\n"
9400 " const char *path);\n"
9406 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
9408 "This call uses the standard L<file(1)> command to determine the type or "
9409 "contents of the file."
9414 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
9416 "This call will also transparently look inside various types of compressed "
9422 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
9424 "The exact command which runs is C<file -zb path>. Note in particular that "
9425 "the filename is not prepended to the output (the C<-b> option)."
9430 #: ../src/guestfs-actions.pod:1535
9432 "This command can also be used on C</dev/> devices (and partitions, LV "
9433 "names). You can for example use this to determine if a device contains a "
9434 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9439 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
9441 "If the C<path> does not begin with C</dev/> then this command only works for "
9442 "the content of regular files. For other file types (directory, symbolic "
9443 "link etc) it will just return the string C<directory> etc."
9448 #: ../src/guestfs-actions.pod:1550
9449 msgid "guestfs_file_architecture"
9454 #: ../src/guestfs-actions.pod:1552
9458 " guestfs_file_architecture (guestfs_h *g,\n"
9459 " const char *filename);\n"
9465 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
9467 "This detects the architecture of the binary C<filename>, and returns it if "
9473 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
9474 msgid "Currently defined architectures are:"
9479 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
9485 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
9487 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9488 "irrespective of the precise processor requirements of the binary."
9493 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
9499 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
9500 msgid "64 bit x86-64."
9505 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
9511 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
9512 msgid "32 bit SPARC."
9517 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
9523 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
9524 msgid "64 bit SPARC V9 and above."
9529 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
9535 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
9536 msgid "Intel Itanium."
9541 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
9547 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
9548 msgid "32 bit Power PC."
9553 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
9559 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
9560 msgid "64 bit Power PC."
9565 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
9566 msgid "Libguestfs may return other architecture strings in future."
9571 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
9572 msgid "The function works on at least the following types of files:"
9577 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
9578 msgid "many types of Un*x and Linux binary"
9583 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
9584 msgid "many types of Un*x and Linux shared library"
9589 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
9590 msgid "Windows Win32 and Win64 binaries"
9595 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
9596 msgid "Windows Win32 and Win64 DLLs"
9601 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
9602 msgid "Win32 binaries and DLLs return C<i386>."
9607 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
9608 msgid "Win64 binaries and DLLs return C<x86_64>."
9613 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
9614 msgid "Linux kernel modules"
9619 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
9620 msgid "Linux new-style initrd images"
9625 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
9626 msgid "some non-x86 Linux vmlinuz kernels"
9631 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
9632 msgid "What it can't do currently:"
9637 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
9638 msgid "static libraries (libfoo.a)"
9643 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
9644 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9649 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
9650 msgid "x86 Linux vmlinuz kernels"
9655 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
9657 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9658 "compressed code, and are horribly hard to unpack. If you want to find the "
9659 "architecture of a kernel, use the architecture of the associated initrd or "
9660 "kernel module(s) instead."
9665 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
9666 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
9667 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2642
9668 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2751
9669 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2872
9670 #: ../src/guestfs-actions.pod:2969 ../src/guestfs-actions.pod:3195
9671 #: ../src/guestfs-actions.pod:3327
9672 msgid "(Added in 1.5.3)"
9677 #: ../src/guestfs-actions.pod:1662
9678 msgid "guestfs_filesize"
9683 #: ../src/guestfs-actions.pod:1664
9687 " guestfs_filesize (guestfs_h *g,\n"
9688 " const char *file);\n"
9694 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
9695 msgid "This command returns the size of C<file> in bytes."
9700 #: ../src/guestfs-actions.pod:1670
9702 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9703 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9704 "devices, use C<guestfs_blockdev_getsize64>."
9709 #: ../src/guestfs-actions.pod:1676
9710 msgid "(Added in 1.0.82)"
9715 #: ../src/guestfs-actions.pod:1678
9716 msgid "guestfs_fill"
9721 #: ../src/guestfs-actions.pod:1680
9725 " guestfs_fill (guestfs_h *g,\n"
9728 " const char *path);\n"
9734 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
9736 "This command creates a new file called C<path>. The initial content of the "
9737 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9743 #: ../src/guestfs-actions.pod:1690
9745 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9746 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9747 "bytes use C<guestfs_fill_pattern>."
9752 #: ../src/guestfs-actions.pod:1702
9753 msgid "(Added in 1.0.79)"
9758 #: ../src/guestfs-actions.pod:1704
9759 msgid "guestfs_fill_pattern"
9764 #: ../src/guestfs-actions.pod:1706
9768 " guestfs_fill_pattern (guestfs_h *g,\n"
9769 " const char *pattern,\n"
9771 " const char *path);\n"
9777 #: ../src/guestfs-actions.pod:1712
9779 "This function is like C<guestfs_fill> except that it creates a new file of "
9780 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9781 "pattern is truncated if necessary to ensure the length of the file is "
9782 "exactly C<len> bytes."
9787 #: ../src/guestfs-actions.pod:1724
9788 msgid "(Added in 1.3.12)"
9793 #: ../src/guestfs-actions.pod:1726
9794 msgid "guestfs_find"
9799 #: ../src/guestfs-actions.pod:1728
9803 " guestfs_find (guestfs_h *g,\n"
9804 " const char *directory);\n"
9810 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
9812 "This command lists out all files and directories, recursively, starting at "
9813 "C<directory>. It is essentially equivalent to running the shell command "
9814 "C<find directory -print> but some post-processing happens on the output, "
9820 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9822 "This returns a list of strings I<without any prefix>. Thus if the directory "
9828 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
9839 #: ../src/guestfs-actions.pod:1744
9841 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9846 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
9858 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
9859 msgid "If C<directory> is not a directory, then this command returns an error."
9864 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
9865 msgid "The returned list is sorted."
9870 #: ../src/guestfs-actions.pod:1757
9871 msgid "See also C<guestfs_find0>."
9876 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4021
9877 #: ../src/guestfs-actions.pod:5564
9878 msgid "(Added in 1.0.27)"
9883 #: ../src/guestfs-actions.pod:1768
9884 msgid "guestfs_find0"
9889 #: ../src/guestfs-actions.pod:1770
9893 " guestfs_find0 (guestfs_h *g,\n"
9894 " const char *directory,\n"
9895 " const char *files);\n"
9901 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
9903 "This command lists out all files and directories, recursively, starting at "
9904 "C<directory>, placing the resulting list in the external file called "
9910 #: ../src/guestfs-actions.pod:1779
9912 "This command works the same way as C<guestfs_find> with the following "
9918 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
9919 msgid "The resulting list is written to an external file."
9924 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9926 "Items (filenames) in the result are separated by C<\\0> characters. See "
9927 "L<find(1)> option I<-print0>."
9932 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9933 msgid "This command is not limited in the number of names that it can return."
9938 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9939 msgid "The result list is not sorted."
9944 #: ../src/guestfs-actions.pod:1806
9945 msgid "(Added in 1.0.74)"
9950 #: ../src/guestfs-actions.pod:1808
9951 msgid "guestfs_findfs_label"
9956 #: ../src/guestfs-actions.pod:1810
9960 " guestfs_findfs_label (guestfs_h *g,\n"
9961 " const char *label);\n"
9967 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9969 "This command searches the filesystems and returns the one which has the "
9970 "given label. An error is returned if no such filesystem can be found."
9975 #: ../src/guestfs-actions.pod:1818
9976 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9981 #: ../src/guestfs-actions.pod:1825
9982 msgid "guestfs_findfs_uuid"
9987 #: ../src/guestfs-actions.pod:1827
9991 " guestfs_findfs_uuid (guestfs_h *g,\n"
9992 " const char *uuid);\n"
9998 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
10000 "This command searches the filesystems and returns the one which has the "
10001 "given UUID. An error is returned if no such filesystem can be found."
10006 #: ../src/guestfs-actions.pod:1835
10007 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
10012 #: ../src/guestfs-actions.pod:1842
10013 msgid "guestfs_fsck"
10018 #: ../src/guestfs-actions.pod:1844
10022 " guestfs_fsck (guestfs_h *g,\n"
10023 " const char *fstype,\n"
10024 " const char *device);\n"
10030 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
10032 "This runs the filesystem checker (fsck) on C<device> which should have "
10033 "filesystem type C<fstype>."
10038 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
10040 "The returned integer is the status. See L<fsck(8)> for the list of status "
10041 "codes from C<fsck>."
10046 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
10047 msgid "Multiple status codes can be summed together."
10052 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
10054 "A non-zero return code can mean \"success\", for example if errors have been "
10055 "corrected on the filesystem."
10060 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
10061 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10066 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
10068 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10073 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7260
10074 msgid "(Added in 1.0.16)"
10079 #: ../src/guestfs-actions.pod:1881
10080 msgid "guestfs_get_append"
10085 #: ../src/guestfs-actions.pod:1883
10089 " guestfs_get_append (guestfs_h *g);\n"
10095 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
10097 "Return the additional kernel options which are added to the guest kernel "
10103 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
10104 msgid "If C<NULL> then no options are added."
10109 #: ../src/guestfs-actions.pod:1891
10111 "This function returns a string which may be NULL. There is no way to return "
10112 "an error from this function. The string is owned by the guest handle and "
10113 "must I<not> be freed."
10118 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5242
10119 #: ../src/guestfs-actions.pod:5722 ../src/guestfs-actions.pod:6122
10120 #: ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6157
10121 #: ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6931
10122 #: ../src/guestfs-actions.pod:6949 ../src/guestfs-actions.pod:7303
10123 msgid "(Added in 1.0.26)"
10127 #: ../src/guestfs-actions.pod:1897
10128 msgid "guestfs_get_attach_method"
10132 #: ../src/guestfs-actions.pod:1899
10136 " guestfs_get_attach_method (guestfs_h *g);\n"
10141 #: ../src/guestfs-actions.pod:1902
10142 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10147 #: ../src/guestfs-actions.pod:1907
10148 msgid "guestfs_get_autosync"
10153 #: ../src/guestfs-actions.pod:1909
10157 " guestfs_get_autosync (guestfs_h *g);\n"
10163 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
10164 msgid "Get the autosync flag."
10169 #: ../src/guestfs-actions.pod:1918
10170 msgid "guestfs_get_direct"
10175 #: ../src/guestfs-actions.pod:1920
10179 " guestfs_get_direct (guestfs_h *g);\n"
10185 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
10186 msgid "Return the direct appliance mode flag."
10191 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5791
10192 msgid "(Added in 1.0.72)"
10197 #: ../src/guestfs-actions.pod:1929
10198 msgid "guestfs_get_e2label"
10203 #: ../src/guestfs-actions.pod:1931
10207 " guestfs_get_e2label (guestfs_h *g,\n"
10208 " const char *device);\n"
10214 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
10216 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10221 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
10223 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10228 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
10229 #: ../src/guestfs-actions.pod:5809 ../src/guestfs-actions.pod:5828
10230 msgid "(Added in 1.0.15)"
10235 #: ../src/guestfs-actions.pod:1950
10236 msgid "guestfs_get_e2uuid"
10241 #: ../src/guestfs-actions.pod:1952
10245 " guestfs_get_e2uuid (guestfs_h *g,\n"
10246 " const char *device);\n"
10252 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
10254 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10259 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
10261 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10266 #: ../src/guestfs-actions.pod:1971
10267 msgid "guestfs_get_memsize"
10272 #: ../src/guestfs-actions.pod:1973
10276 " guestfs_get_memsize (guestfs_h *g);\n"
10282 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
10284 "This gets the memory size in megabytes allocated to the qemu subprocess."
10289 #: ../src/guestfs-actions.pod:1979
10291 "If C<guestfs_set_memsize> was not called on this handle, and if "
10292 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10293 "value for memsize."
10298 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
10299 #: ../src/guestfs-actions.pod:5844 ../src/guestfs-actions.pod:5951
10300 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10301 #: ../fish/guestfish-actions.pod:3927 ../fish/guestfish-actions.pod:4014
10303 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10308 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4312
10309 #: ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4528
10310 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4559
10311 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4589
10312 #: ../src/guestfs-actions.pod:5467 ../src/guestfs-actions.pod:5849
10313 #: ../src/guestfs-actions.pod:6096 ../src/guestfs-actions.pod:6697
10314 msgid "(Added in 1.0.55)"
10319 #: ../src/guestfs-actions.pod:1990
10320 msgid "guestfs_get_network"
10325 #: ../src/guestfs-actions.pod:1992
10329 " guestfs_get_network (guestfs_h *g);\n"
10335 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
10336 msgid "This returns the enable network flag."
10341 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5868
10342 msgid "(Added in 1.5.4)"
10347 #: ../src/guestfs-actions.pod:2001
10348 msgid "guestfs_get_path"
10353 #: ../src/guestfs-actions.pod:2003
10357 " guestfs_get_path (guestfs_h *g);\n"
10363 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
10364 msgid "Return the current search path."
10369 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
10371 "This is always non-NULL. If it wasn't set already, then this will return "
10372 "the default path."
10377 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
10379 "This function returns a string, or NULL on error. The string is owned by "
10380 "the guest handle and must I<not> be freed."
10385 #: ../src/guestfs-actions.pod:2016
10386 msgid "guestfs_get_pid"
10391 #: ../src/guestfs-actions.pod:2018
10395 " guestfs_get_pid (guestfs_h *g);\n"
10401 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
10403 "Return the process ID of the qemu subprocess. If there is no qemu "
10404 "subprocess, then this will return an error."
10409 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
10410 msgid "This is an internal call used for debugging and testing."
10415 #: ../src/guestfs-actions.pod:2028
10416 msgid "(Added in 1.0.56)"
10421 #: ../src/guestfs-actions.pod:2030
10422 msgid "guestfs_get_qemu"
10427 #: ../src/guestfs-actions.pod:2032
10431 " guestfs_get_qemu (guestfs_h *g);\n"
10437 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
10438 msgid "Return the current qemu binary."
10443 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
10445 "This is always non-NULL. If it wasn't set already, then this will return "
10446 "the default qemu binary name."
10451 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5913
10452 msgid "(Added in 1.0.6)"
10457 #: ../src/guestfs-actions.pod:2045
10458 msgid "guestfs_get_recovery_proc"
10463 #: ../src/guestfs-actions.pod:2047
10467 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10473 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
10474 msgid "Return the recovery process enabled flag."
10479 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3422
10480 #: ../src/guestfs-actions.pod:3719 ../src/guestfs-actions.pod:4119
10481 #: ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:5172
10482 #: ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5937
10483 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6620
10484 #: ../src/guestfs-actions.pod:6812
10485 msgid "(Added in 1.0.77)"
10490 #: ../src/guestfs-actions.pod:2056
10491 msgid "guestfs_get_selinux"
10496 #: ../src/guestfs-actions.pod:2058
10500 " guestfs_get_selinux (guestfs_h *g);\n"
10506 #: ../src/guestfs-actions.pod:2061
10508 "This returns the current setting of the selinux flag which is passed to the "
10509 "appliance at boot time. See C<guestfs_set_selinux>."
10514 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
10515 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6014
10516 msgid "(Added in 1.0.67)"
10521 #: ../src/guestfs-actions.pod:2071
10522 msgid "guestfs_get_state"
10527 #: ../src/guestfs-actions.pod:2073
10531 " guestfs_get_state (guestfs_h *g);\n"
10537 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
10539 "This returns the current state as an opaque integer. This is only useful "
10540 "for printing debug and internal error messages."
10545 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3220
10546 #: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3310
10547 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:1409
10548 #: ../fish/guestfish-actions.pod:2257 ../fish/guestfish-actions.pod:2275
10549 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2329
10550 msgid "For more information on states, see L<guestfs(3)>."
10555 #: ../src/guestfs-actions.pod:2085
10556 msgid "guestfs_get_trace"
10561 #: ../src/guestfs-actions.pod:2087
10565 " guestfs_get_trace (guestfs_h *g);\n"
10571 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
10572 msgid "Return the command trace flag."
10577 #: ../src/guestfs-actions.pod:2096
10578 msgid "guestfs_get_umask"
10583 #: ../src/guestfs-actions.pod:2098
10587 " guestfs_get_umask (guestfs_h *g);\n"
10593 #: ../src/guestfs-actions.pod:2101
10595 "Return the current umask. By default the umask is C<022> unless it has been "
10596 "set by calling C<guestfs_umask>."
10601 #: ../src/guestfs-actions.pod:2108
10602 msgid "guestfs_get_verbose"
10607 #: ../src/guestfs-actions.pod:2110
10611 " guestfs_get_verbose (guestfs_h *g);\n"
10617 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
10618 msgid "This returns the verbose messages flag."
10623 #: ../src/guestfs-actions.pod:2119
10624 msgid "guestfs_getcon"
10629 #: ../src/guestfs-actions.pod:2121
10633 " guestfs_getcon (guestfs_h *g);\n"
10639 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
10640 msgid "This gets the SELinux security context of the daemon."
10645 #: ../src/guestfs-actions.pod:2126
10647 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10652 #: ../src/guestfs-actions.pod:2134
10653 msgid "guestfs_getxattr"
10658 #: ../src/guestfs-actions.pod:2136
10662 " guestfs_getxattr (guestfs_h *g,\n"
10663 " const char *path,\n"
10664 " const char *name,\n"
10665 " size_t *size_r);\n"
10671 #: ../src/guestfs-actions.pod:2142
10673 "Get a single extended attribute from file C<path> named C<name>. This call "
10674 "follows symlinks. If you want to lookup an extended attribute for the "
10675 "symlink itself, use C<guestfs_lgetxattr>."
10680 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3436
10682 "Normally it is better to get all extended attributes from a file in one go "
10683 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10684 "implementations are buggy and do not provide a way to list out attributes. "
10685 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10686 "extended attributes you want in advance and call this function."
10691 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3443
10692 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2394
10694 "Extended attribute values are blobs of binary data. If there is no extended "
10695 "attribute named C<name>, this returns an error."
10700 #: ../src/guestfs-actions.pod:2156
10701 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10706 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
10707 #: ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:5165
10708 #: ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5372
10710 "This function returns a buffer, or NULL on error. The size of the returned "
10711 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10716 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3452
10717 msgid "(Added in 1.7.24)"
10722 #: ../src/guestfs-actions.pod:2164
10723 msgid "guestfs_getxattrs"
10728 #: ../src/guestfs-actions.pod:2166
10731 " struct guestfs_xattr_list *\n"
10732 " guestfs_getxattrs (guestfs_h *g,\n"
10733 " const char *path);\n"
10739 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
10741 "This call lists the extended attributes of the file or directory C<path>."
10746 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
10748 "At the system call level, this is a combination of the L<listxattr(2)> and "
10749 "L<getxattr(2)> calls."
10754 #: ../src/guestfs-actions.pod:2176
10755 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10760 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3464
10761 #: ../src/guestfs-actions.pod:4115
10763 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10764 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10769 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3468
10770 #: ../src/guestfs-actions.pod:3633 ../src/guestfs-actions.pod:3669
10771 #: ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:6033
10772 #: ../src/guestfs-actions.pod:7368
10773 msgid "(Added in 1.0.59)"
10778 #: ../src/guestfs-actions.pod:2184
10779 msgid "guestfs_glob_expand"
10784 #: ../src/guestfs-actions.pod:2186
10788 " guestfs_glob_expand (guestfs_h *g,\n"
10789 " const char *pattern);\n"
10795 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
10797 "This command searches for all the pathnames matching C<pattern> according to "
10798 "the wildcard expansion rules used by the shell."
10803 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
10805 "If no paths match, then this returns an empty list (note: not an error)."
10810 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
10812 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10813 "GLOB_BRACE>. See that manual page for more details."
10818 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6198
10819 #: ../src/guestfs-actions.pod:6215
10820 msgid "(Added in 1.0.50)"
10825 #: ../src/guestfs-actions.pod:2207
10826 msgid "guestfs_grep"
10831 #: ../src/guestfs-actions.pod:2209
10835 " guestfs_grep (guestfs_h *g,\n"
10836 " const char *regex,\n"
10837 " const char *path);\n"
10843 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
10844 msgid "This calls the external C<grep> program and returns the matching lines."
10849 #: ../src/guestfs-actions.pod:2226
10850 msgid "guestfs_grepi"
10855 #: ../src/guestfs-actions.pod:2228
10859 " guestfs_grepi (guestfs_h *g,\n"
10860 " const char *regex,\n"
10861 " const char *path);\n"
10867 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
10869 "This calls the external C<grep -i> program and returns the matching lines."
10874 #: ../src/guestfs-actions.pod:2245
10875 msgid "guestfs_grub_install"
10880 #: ../src/guestfs-actions.pod:2247
10884 " guestfs_grub_install (guestfs_h *g,\n"
10885 " const char *root,\n"
10886 " const char *device);\n"
10892 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
10894 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10895 "the root directory being C<root>."
10900 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
10902 "Note: If grub-install reports the error \"No suitable drive was found in the "
10903 "generated device map.\" it may be that you need to create a C</boot/grub/"
10904 "device.map> file first that contains the mapping between grub device names "
10905 "and Linux device names. It is usually sufficient to create a file "
10911 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
10914 " (hd0) /dev/vda\n"
10920 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
10921 msgid "replacing C</dev/vda> with the name of the installation device."
10926 #: ../src/guestfs-actions.pod:2268
10927 msgid "(Added in 1.0.17)"
10932 #: ../src/guestfs-actions.pod:2270
10933 msgid "guestfs_head"
10938 #: ../src/guestfs-actions.pod:2272
10942 " guestfs_head (guestfs_h *g,\n"
10943 " const char *path);\n"
10949 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
10951 "This command returns up to the first 10 lines of a file as a list of strings."
10956 #: ../src/guestfs-actions.pod:2288
10957 msgid "guestfs_head_n"
10962 #: ../src/guestfs-actions.pod:2290
10966 " guestfs_head_n (guestfs_h *g,\n"
10968 " const char *path);\n"
10974 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
10976 "If the parameter C<nrlines> is a positive number, this returns the first "
10977 "C<nrlines> lines of the file C<path>."
10982 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
10984 "If the parameter C<nrlines> is a negative number, this returns lines from "
10985 "the file C<path>, excluding the last C<nrlines> lines."
10990 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6495
10991 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4364
10992 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10997 #: ../src/guestfs-actions.pod:2312
10998 msgid "guestfs_hexdump"
11003 #: ../src/guestfs-actions.pod:2314
11007 " guestfs_hexdump (guestfs_h *g,\n"
11008 " const char *path);\n"
11014 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
11016 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
11017 "readable, canonical hex dump of the file."
11022 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6279
11023 #: ../src/guestfs-actions.pod:6334
11024 msgid "(Added in 1.0.22)"
11029 #: ../src/guestfs-actions.pod:2329
11030 msgid "guestfs_initrd_cat"
11035 #: ../src/guestfs-actions.pod:2331
11039 " guestfs_initrd_cat (guestfs_h *g,\n"
11040 " const char *initrdpath,\n"
11041 " const char *filename,\n"
11042 " size_t *size_r);\n"
11048 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
11050 "This command unpacks the file C<filename> from the initrd file called "
11051 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11057 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
11059 "For example, in guestfish you could use the following command to examine the "
11060 "boot script (usually called C</init>) contained in a Linux initrd or "
11066 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
11069 " initrd-cat /boot/initrd-<version>.img init\n"
11075 #: ../src/guestfs-actions.pod:2347
11076 msgid "See also C<guestfs_initrd_list>."
11081 #: ../src/guestfs-actions.pod:2358
11082 msgid "guestfs_initrd_list"
11087 #: ../src/guestfs-actions.pod:2360
11091 " guestfs_initrd_list (guestfs_h *g,\n"
11092 " const char *path);\n"
11098 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
11099 msgid "This command lists out files contained in an initrd."
11104 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
11106 "The files are listed without any initial C</> character. The files are "
11107 "listed in the order they appear (not necessarily alphabetical). Directory "
11108 "names are listed as separate items."
11113 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
11115 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11116 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11122 #: ../src/guestfs-actions.pod:2380
11123 msgid "guestfs_inotify_add_watch"
11128 #: ../src/guestfs-actions.pod:2382
11132 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11133 " const char *path,\n"
11140 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
11141 msgid "Watch C<path> for the events listed in C<mask>."
11146 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
11148 "Note that if C<path> is a directory then events within that directory are "
11149 "watched, but this does I<not> happen recursively (in subdirectories)."
11154 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
11156 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11157 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11162 #: ../src/guestfs-actions.pod:2401
11163 msgid "guestfs_inotify_close"
11168 #: ../src/guestfs-actions.pod:2403
11172 " guestfs_inotify_close (guestfs_h *g);\n"
11178 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
11180 "This closes the inotify handle which was previously opened by inotify_init. "
11181 "It removes all watches, throws away any pending events, and deallocates all "
11187 #: ../src/guestfs-actions.pod:2414
11188 msgid "guestfs_inotify_files"
11193 #: ../src/guestfs-actions.pod:2416
11197 " guestfs_inotify_files (guestfs_h *g);\n"
11203 #: ../src/guestfs-actions.pod:2419
11205 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11206 "returns a list of pathnames of objects that were touched. The returned "
11207 "pathnames are sorted and deduplicated."
11212 #: ../src/guestfs-actions.pod:2429
11213 msgid "guestfs_inotify_init"
11218 #: ../src/guestfs-actions.pod:2431
11222 " guestfs_inotify_init (guestfs_h *g,\n"
11223 " int maxevents);\n"
11229 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
11231 "This command creates a new inotify handle. The inotify subsystem can be "
11232 "used to notify events which happen to objects in the guest filesystem."
11237 #: ../src/guestfs-actions.pod:2439
11239 "C<maxevents> is the maximum number of events which will be queued up between "
11240 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11241 "passed as C<0>, then the kernel (or previously set) default is used. For "
11242 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11243 "throws away events, but records the fact that it threw them away by setting "
11244 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11245 "C<guestfs_inotify_read>)."
11250 #: ../src/guestfs-actions.pod:2449
11252 "Before any events are generated, you have to add some watches to the "
11253 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11254 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11259 #: ../src/guestfs-actions.pod:2455
11261 "Queued up events should be read periodically by calling "
11262 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11263 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11264 "often enough then you risk the internal queue overflowing."
11269 #: ../src/guestfs-actions.pod:2462
11271 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11272 "This also removes any watches automatically."
11277 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
11279 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11280 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11281 "that there is one global inotify handle per libguestfs instance."
11286 #: ../src/guestfs-actions.pod:2475
11287 msgid "guestfs_inotify_read"
11292 #: ../src/guestfs-actions.pod:2477
11295 " struct guestfs_inotify_event_list *\n"
11296 " guestfs_inotify_read (guestfs_h *g);\n"
11302 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
11304 "Return the complete queue of events that have happened since the previous "
11310 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
11311 msgid "If no events have happened, this returns an empty list."
11316 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
11318 "I<Note>: In order to make sure that all events have been read, you must call "
11319 "this function repeatedly until it returns an empty list. The reason is that "
11320 "the call will read events up to the maximum appliance-to-host message size "
11321 "and leave remaining events in the queue."
11326 #: ../src/guestfs-actions.pod:2491
11328 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11329 "there was an error. I<The caller must call "
11330 "C<guestfs_free_inotify_event_list> after use>."
11335 #: ../src/guestfs-actions.pod:2497
11336 msgid "guestfs_inotify_rm_watch"
11341 #: ../src/guestfs-actions.pod:2499
11345 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11352 #: ../src/guestfs-actions.pod:2503
11354 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11359 #: ../src/guestfs-actions.pod:2510
11360 msgid "guestfs_inspect_get_arch"
11365 #: ../src/guestfs-actions.pod:2512
11369 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11370 " const char *root);\n"
11376 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
11377 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2650
11378 #: ../src/guestfs-actions.pod:2689 ../src/guestfs-actions.pod:2711
11379 #: ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2759
11380 #: ../src/guestfs-actions.pod:2796 ../src/guestfs-actions.pod:2825
11381 #: ../src/guestfs-actions.pod:2856 ../src/guestfs-actions.pod:2880
11382 #: ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2977
11383 #: ../src/guestfs-actions.pod:3000 ../src/guestfs-actions.pod:3017
11384 #: ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3053
11386 "This function should only be called with a root device string as returned by "
11387 "C<guestfs_inspect_os>."
11392 #: ../src/guestfs-actions.pod:2519
11394 "This returns the architecture of the inspected operating system. The "
11395 "possible return values are listed under C<guestfs_file_architecture>."
11400 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
11402 "If the architecture could not be determined, then the string C<unknown> is "
11408 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611
11409 #: ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:2698
11410 #: ../src/guestfs-actions.pod:2726 ../src/guestfs-actions.pod:2812
11411 #: ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2867
11412 #: ../src/guestfs-actions.pod:2921 ../src/guestfs-actions.pod:2964
11413 #: ../src/guestfs-actions.pod:2987 ../src/guestfs-actions.pod:3007
11414 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3043
11415 #: ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3187
11416 #: ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1776
11417 #: ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:1843
11418 #: ../fish/guestfish-actions.pod:1864 ../fish/guestfish-actions.pod:1928
11419 #: ../fish/guestfish-actions.pod:1952 ../fish/guestfish-actions.pod:1969
11420 #: ../fish/guestfish-actions.pod:2012 ../fish/guestfish-actions.pod:2047
11421 #: ../fish/guestfish-actions.pod:2063 ../fish/guestfish-actions.pod:2076
11422 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2104
11423 #: ../fish/guestfish-actions.pod:2203 ../fish/guestfish-actions.pod:2237
11424 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11429 #: ../src/guestfs-actions.pod:2533
11430 msgid "guestfs_inspect_get_distro"
11435 #: ../src/guestfs-actions.pod:2535
11439 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11440 " const char *root);\n"
11446 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
11448 "This returns the distro (distribution) of the inspected operating system."
11453 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
11454 msgid "Currently defined distros are:"
11459 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
11460 msgid "\"archlinux\""
11465 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
11466 msgid "Arch Linux."
11471 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
11477 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
11483 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
11489 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
11495 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
11501 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
11507 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
11508 msgid "\"linuxmint\""
11513 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
11514 msgid "Linux Mint."
11519 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
11520 msgid "\"mandriva\""
11525 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
11531 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
11537 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
11543 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
11549 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
11555 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
11556 msgid "\"redhat-based\""
11561 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
11562 msgid "Some Red Hat-derived distro."
11567 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
11573 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
11574 msgid "Red Hat Enterprise Linux and some derivatives."
11578 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
11579 msgid "\"slackware\""
11583 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
11589 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
11595 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
11601 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2669
11602 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:1762
11603 #: ../fish/guestfish-actions.pod:1819 ../fish/guestfish-actions.pod:2038
11604 msgid "\"unknown\""
11609 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
11610 msgid "The distro could not be determined."
11615 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2947
11616 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2030
11617 msgid "\"windows\""
11622 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
11624 "Windows does not have distributions. This string is returned if the OS type "
11630 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2675
11631 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:1773
11632 #: ../fish/guestfish-actions.pod:1825 ../fish/guestfish-actions.pod:2044
11634 "Future versions of libguestfs may return other strings here. The caller "
11635 "should be prepared to handle any string."
11640 #: ../src/guestfs-actions.pod:2618
11641 msgid "guestfs_inspect_get_filesystems"
11646 #: ../src/guestfs-actions.pod:2620
11650 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11651 " const char *root);\n"
11657 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
11659 "This returns a list of all the filesystems that we think are associated with "
11660 "this operating system. This includes the root filesystem, other ordinary "
11661 "filesystems, and non-mounted devices like swap partitions."
11666 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1790
11668 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11669 "to be shared between operating systems."
11674 #: ../src/guestfs-actions.pod:2635
11676 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11677 "C<guestfs_inspect_get_mountpoints>."
11681 #: ../src/guestfs-actions.pod:2644
11682 msgid "guestfs_inspect_get_format"
11686 #: ../src/guestfs-actions.pod:2646
11690 " guestfs_inspect_get_format (guestfs_h *g,\n"
11691 " const char *root);\n"
11696 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1803
11698 "This returns the format of the inspected operating system. You can use it "
11699 "to detect install images, live CDs and similar."
11703 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1806
11704 msgid "Currently defined formats are:"
11708 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1810
11709 msgid "\"installed\""
11713 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1812
11714 msgid "This is an installed operating system."
11718 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1814
11719 msgid "\"installer\""
11723 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1816
11725 "The disk image being inspected is not an installed operating system, but a "
11726 "I<bootable> install disk, live CD, or similar."
11730 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
11731 msgid "The format of this disk image is not known."
11736 #: ../src/guestfs-actions.pod:2683
11737 msgid "guestfs_inspect_get_hostname"
11742 #: ../src/guestfs-actions.pod:2685
11746 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11747 " const char *root);\n"
11753 #: ../src/guestfs-actions.pod:2692 ../fish/guestfish-actions.pod:1837
11755 "This function returns the hostname of the operating system as found by "
11756 "inspection of the guest's configuration files."
11761 #: ../src/guestfs-actions.pod:2695 ../fish/guestfish-actions.pod:1840
11763 "If the hostname could not be determined, then the string C<unknown> is "
11769 #: ../src/guestfs-actions.pod:2703
11770 msgid "(Added in 1.7.9)"
11775 #: ../src/guestfs-actions.pod:2705
11776 msgid "guestfs_inspect_get_major_version"
11781 #: ../src/guestfs-actions.pod:2707
11785 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11786 " const char *root);\n"
11792 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1852
11794 "This returns the major version number of the inspected operating system."
11799 #: ../src/guestfs-actions.pod:2717 ../fish/guestfish-actions.pod:1855
11801 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11802 "popular public names used by the operating system. Notably the operating "
11803 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11804 "1). You can find out the real versions corresponding to releases of Windows "
11805 "by consulting Wikipedia or MSDN."
11810 #: ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2744
11811 #: ../fish/guestfish-actions.pod:1862 ../fish/guestfish-actions.pod:1876
11812 msgid "If the version could not be determined, then C<0> is returned."
11817 #: ../src/guestfs-actions.pod:2732
11818 msgid "guestfs_inspect_get_minor_version"
11823 #: ../src/guestfs-actions.pod:2734
11827 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11828 " const char *root);\n"
11834 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1873
11836 "This returns the minor version number of the inspected operating system."
11841 #: ../src/guestfs-actions.pod:2746
11843 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11844 "C<guestfs_inspect_get_major_version>."
11849 #: ../src/guestfs-actions.pod:2753
11850 msgid "guestfs_inspect_get_mountpoints"
11855 #: ../src/guestfs-actions.pod:2755
11859 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11860 " const char *root);\n"
11865 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1888
11867 "This returns a hash of where we think the filesystems associated with this "
11868 "operating system should be mounted. Callers should note that this is at "
11869 "best an educated guess made by reading configuration files such as C</etc/"
11870 "fstab>. I<In particular note> that this may return filesystems which are "
11871 "non-existent or not mountable and callers should be prepared to handle or "
11872 "ignore failures if they try to mount them."
11877 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1897
11879 "Each element in the returned hashtable has a key which is the path of the "
11880 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11881 "mounted there (eg. C</dev/sda1>)."
11886 #: ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1902
11888 "Non-mounted devices such as swap devices are I<not> returned in this list."
11893 #: ../src/guestfs-actions.pod:2779
11895 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11896 "C<guestfs_inspect_get_filesystems>."
11901 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:3521
11902 #: ../src/guestfs-actions.pod:4731 ../src/guestfs-actions.pod:6636
11904 "This function returns a NULL-terminated array of strings, or NULL if there "
11905 "was an error. The array of strings will always have length C<2n+1>, where "
11906 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11907 "caller must free the strings and the array after use>."
11912 #: ../src/guestfs-actions.pod:2790
11913 msgid "guestfs_inspect_get_package_format"
11918 #: ../src/guestfs-actions.pod:2792
11922 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11923 " const char *root);\n"
11929 #: ../src/guestfs-actions.pod:2799
11931 "This function and C<guestfs_inspect_get_package_management> return the "
11932 "package format and package management tool used by the inspected operating "
11933 "system. For example for Fedora these functions would return C<rpm> (package "
11934 "format) and C<yum> (package management)."
11939 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1921
11941 "This returns the string C<unknown> if we could not determine the package "
11942 "format I<or> if the operating system does not have a real packaging system "
11948 #: ../src/guestfs-actions.pod:2809 ../fish/guestfish-actions.pod:1925
11950 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11951 "Future versions of libguestfs may return other strings."
11956 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2848
11957 msgid "(Added in 1.7.5)"
11962 #: ../src/guestfs-actions.pod:2819
11963 msgid "guestfs_inspect_get_package_management"
11968 #: ../src/guestfs-actions.pod:2821
11972 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11973 " const char *root);\n"
11979 #: ../src/guestfs-actions.pod:2828
11981 "C<guestfs_inspect_get_package_format> and this function return the package "
11982 "format and package management tool used by the inspected operating system. "
11983 "For example for Fedora these functions would return C<rpm> (package format) "
11984 "and C<yum> (package management)."
11989 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1943
11991 "This returns the string C<unknown> if we could not determine the package "
11992 "management tool I<or> if the operating system does not have a real packaging "
11993 "system (eg. Windows)."
11998 #: ../src/guestfs-actions.pod:2838 ../fish/guestfish-actions.pod:1947
12000 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
12001 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
12002 "libguestfs may return other strings."
12007 #: ../src/guestfs-actions.pod:2850
12008 msgid "guestfs_inspect_get_product_name"
12013 #: ../src/guestfs-actions.pod:2852
12017 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
12018 " const char *root);\n"
12024 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1961
12026 "This returns the product name of the inspected operating system. The "
12027 "product name is generally some freeform string which can be displayed to the "
12028 "user, but should not be parsed by programs."
12033 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:1966
12035 "If the product name could not be determined, then the string C<unknown> is "
12040 #: ../src/guestfs-actions.pod:2874
12041 msgid "guestfs_inspect_get_product_variant"
12045 #: ../src/guestfs-actions.pod:2876
12049 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12050 " const char *root);\n"
12055 #: ../src/guestfs-actions.pod:2883 ../fish/guestfish-actions.pod:1978
12056 msgid "This returns the product variant of the inspected operating system."
12060 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1981
12062 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12063 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12064 "is usually a string such as C<Client> or C<Server> (other values are "
12065 "possible). This can be used to distinguish consumer and enterprise versions "
12066 "of Windows that have the same version number (for example, Windows 7 and "
12067 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12068 "the latter is C<Server>)."
12072 #: ../src/guestfs-actions.pod:2895 ../fish/guestfish-actions.pod:1990
12074 "For enterprise Linux guests, in future we intend this to return the product "
12075 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12076 "implemented at present."
12080 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1994
12082 "If the product variant could not be determined, then the string C<unknown> "
12087 #: ../src/guestfs-actions.pod:2902
12089 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12090 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12095 #: ../src/guestfs-actions.pod:2909
12096 msgid "guestfs_inspect_get_roots"
12101 #: ../src/guestfs-actions.pod:2911
12105 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12111 #: ../src/guestfs-actions.pod:2914
12113 "This function is a convenient way to get the list of root devices, as "
12114 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12115 "the whole inspection process."
12120 #: ../src/guestfs-actions.pod:2918
12122 "This returns an empty list if either no root devices were found or the "
12123 "caller has not called C<guestfs_inspect_os>."
12128 #: ../src/guestfs-actions.pod:2927
12129 msgid "(Added in 1.7.3)"
12134 #: ../src/guestfs-actions.pod:2929
12135 msgid "guestfs_inspect_get_type"
12140 #: ../src/guestfs-actions.pod:2931
12144 " guestfs_inspect_get_type (guestfs_h *g,\n"
12145 " const char *root);\n"
12151 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2021
12153 "This returns the type of the inspected operating system. Currently defined "
12159 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2026
12165 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2028
12166 msgid "Any Linux-based operating system."
12171 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2032
12172 msgid "Any Microsoft Windows operating system."
12177 #: ../src/guestfs-actions.pod:2951 ../fish/guestfish-actions.pod:2034
12178 msgid "\"freebsd\""
12183 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2036
12189 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2040
12190 msgid "The operating system type could not be determined."
12195 #: ../src/guestfs-actions.pod:2971
12196 msgid "guestfs_inspect_get_windows_systemroot"
12201 #: ../src/guestfs-actions.pod:2973
12205 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12206 " const char *root);\n"
12212 #: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2056
12214 "This returns the Windows systemroot of the inspected guest. The systemroot "
12215 "is a directory path such as C</WINDOWS>."
12220 #: ../src/guestfs-actions.pod:2983 ../fish/guestfish-actions.pod:2059
12222 "This call assumes that the guest is Windows and that the systemroot could be "
12223 "determined by inspection. If this is not the case then an error is returned."
12228 #: ../src/guestfs-actions.pod:2992
12229 msgid "(Added in 1.5.25)"
12233 #: ../src/guestfs-actions.pod:2994
12234 msgid "guestfs_inspect_is_live"
12238 #: ../src/guestfs-actions.pod:2996
12242 " guestfs_inspect_is_live (guestfs_h *g,\n"
12243 " const char *root);\n"
12248 #: ../src/guestfs-actions.pod:3003
12250 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12251 "disk), then this returns true if a live image was detected on the disk."
12255 #: ../src/guestfs-actions.pod:3011
12256 msgid "guestfs_inspect_is_multipart"
12260 #: ../src/guestfs-actions.pod:3013
12264 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12265 " const char *root);\n"
12270 #: ../src/guestfs-actions.pod:3020
12272 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12273 "disk), then this returns true if the disk is part of a set."
12277 #: ../src/guestfs-actions.pod:3028
12278 msgid "guestfs_inspect_is_netinst"
12282 #: ../src/guestfs-actions.pod:3030
12286 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12287 " const char *root);\n"
12292 #: ../src/guestfs-actions.pod:3037
12294 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12295 "disk), then this returns true if the disk is a network installer, ie. not a "
12296 "self-contained install CD but one which is likely to require network access "
12297 "to complete the install."
12302 #: ../src/guestfs-actions.pod:3047
12303 msgid "guestfs_inspect_list_applications"
12308 #: ../src/guestfs-actions.pod:3049
12311 " struct guestfs_application_list *\n"
12312 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12313 " const char *root);\n"
12319 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2113
12320 msgid "Return the list of applications installed in the operating system."
12325 #: ../src/guestfs-actions.pod:3058
12327 "I<Note:> This call works differently from other parts of the inspection "
12328 "API. You have to call C<guestfs_inspect_os>, then "
12329 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12330 "this. Listing applications is a significantly more difficult operation "
12331 "which requires access to the full filesystem. Also note that unlike the "
12332 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12333 "the libguestfs handle, this call actually reads parts of the mounted "
12334 "filesystems during the call."
12339 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2125
12341 "This returns an empty list if the inspection code was not able to determine "
12342 "the list of applications."
12347 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2128
12348 msgid "The application structure contains the following fields:"
12353 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2132
12354 msgid "C<app_name>"
12359 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2134
12361 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12362 "guests, this is the package name."
12367 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2137
12368 msgid "C<app_display_name>"
12373 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2139
12375 "The display name of the application, sometimes localized to the install "
12376 "language of the guest operating system."
12381 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2142
12383 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12384 "to display something can use C<app_name> instead."
12389 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2145
12390 msgid "C<app_epoch>"
12395 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2147
12397 "For package managers which use epochs, this contains the epoch of the "
12398 "package (an integer). If unavailable, this is returned as C<0>."
12403 #: ../src/guestfs-actions.pod:3093 ../fish/guestfish-actions.pod:2150
12404 msgid "C<app_version>"
12409 #: ../src/guestfs-actions.pod:3095 ../fish/guestfish-actions.pod:2152
12411 "The version string of the application or package. If unavailable this is "
12412 "returned as an empty string C<\"\">."
12417 #: ../src/guestfs-actions.pod:3098 ../fish/guestfish-actions.pod:2155
12418 msgid "C<app_release>"
12423 #: ../src/guestfs-actions.pod:3100 ../fish/guestfish-actions.pod:2157
12425 "The release string of the application or package, for package managers that "
12426 "use this. If unavailable this is returned as an empty string C<\"\">."
12431 #: ../src/guestfs-actions.pod:3104 ../fish/guestfish-actions.pod:2161
12432 msgid "C<app_install_path>"
12437 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2163
12439 "The installation path of the application (on operating systems such as "
12440 "Windows which use installation paths). This path is in the format used by "
12441 "the guest operating system, it is not a libguestfs path."
12446 #: ../src/guestfs-actions.pod:3111 ../fish/guestfish-actions.pod:2168
12447 msgid "If unavailable this is returned as an empty string C<\"\">."
12452 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2170
12453 msgid "C<app_trans_path>"
12458 #: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2172
12460 "The install path translated into a libguestfs path. If unavailable this is "
12461 "returned as an empty string C<\"\">."
12466 #: ../src/guestfs-actions.pod:3118 ../fish/guestfish-actions.pod:2175
12467 msgid "C<app_publisher>"
12472 #: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2177
12474 "The name of the publisher of the application, for package managers that use "
12475 "this. If unavailable this is returned as an empty string C<\"\">."
12480 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2181
12486 #: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2183
12488 "The URL (eg. upstream URL) of the application. If unavailable this is "
12489 "returned as an empty string C<\"\">."
12494 #: ../src/guestfs-actions.pod:3129 ../fish/guestfish-actions.pod:2186
12495 msgid "C<app_source_package>"
12500 #: ../src/guestfs-actions.pod:3131 ../fish/guestfish-actions.pod:2188
12502 "For packaging systems which support this, the name of the source package. "
12503 "If unavailable this is returned as an empty string C<\"\">."
12508 #: ../src/guestfs-actions.pod:3134 ../fish/guestfish-actions.pod:2191
12509 msgid "C<app_summary>"
12514 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2193
12516 "A short (usually one line) description of the application or package. If "
12517 "unavailable this is returned as an empty string C<\"\">."
12522 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2196
12523 msgid "C<app_description>"
12528 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2198
12530 "A longer description of the application or package. If unavailable this is "
12531 "returned as an empty string C<\"\">."
12536 #: ../src/guestfs-actions.pod:3148
12538 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12539 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12545 #: ../src/guestfs-actions.pod:3152
12546 msgid "(Added in 1.7.8)"
12551 #: ../src/guestfs-actions.pod:3154
12552 msgid "guestfs_inspect_os"
12557 #: ../src/guestfs-actions.pod:3156
12561 " guestfs_inspect_os (guestfs_h *g);\n"
12567 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2209
12569 "This function uses other libguestfs functions and certain heuristics to "
12570 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12571 "for operating systems."
12576 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2213
12577 msgid "The list returned is empty if no operating systems were found."
12582 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2215
12584 "If one operating system was found, then this returns a list with a single "
12585 "element, which is the name of the root filesystem of this operating system. "
12586 "It is also possible for this function to return a list containing more than "
12587 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12588 "element being the root filesystem of one of the operating systems."
12593 #: ../src/guestfs-actions.pod:3172
12595 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12596 "functions in order to query further information about each operating system, "
12597 "such as the name and version."
12602 #: ../src/guestfs-actions.pod:3177
12604 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12605 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12606 "the contents. This should be called with no disks currently mounted. The "
12607 "function may also use Augeas, so any existing Augeas handle will be closed."
12612 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2233
12614 "This function cannot decrypt encrypted disks. The caller must do that first "
12615 "(supplying the necessary keys) if the disk is encrypted."
12620 #: ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3479
12621 #: ../src/guestfs-actions.pod:3541
12622 msgid "See also C<guestfs_list_filesystems>."
12627 #: ../src/guestfs-actions.pod:3197
12628 msgid "guestfs_is_blockdev"
12633 #: ../src/guestfs-actions.pod:3199
12637 " guestfs_is_blockdev (guestfs_h *g,\n"
12638 " const char *path);\n"
12644 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2245
12646 "This returns C<true> if and only if there is a block device with the given "
12652 #: ../src/guestfs-actions.pod:3206 ../src/guestfs-actions.pod:3235
12653 #: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3280
12654 #: ../src/guestfs-actions.pod:3296 ../src/guestfs-actions.pod:3352
12655 #: ../src/guestfs-actions.pod:3367
12656 msgid "See also C<guestfs_stat>."
12661 #: ../src/guestfs-actions.pod:3210 ../src/guestfs-actions.pod:3239
12662 #: ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3356
12663 #: ../src/guestfs-actions.pod:3371
12664 msgid "(Added in 1.5.10)"
12669 #: ../src/guestfs-actions.pod:3212
12670 msgid "guestfs_is_busy"
12675 #: ../src/guestfs-actions.pod:3214
12679 " guestfs_is_busy (guestfs_h *g);\n"
12685 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2254
12687 "This returns true iff this handle is busy processing a command (in the "
12693 #: ../src/guestfs-actions.pod:3226
12694 msgid "guestfs_is_chardev"
12699 #: ../src/guestfs-actions.pod:3228
12703 " guestfs_is_chardev (guestfs_h *g,\n"
12704 " const char *path);\n"
12710 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2263
12712 "This returns C<true> if and only if there is a character device with the "
12713 "given C<path> name."
12718 #: ../src/guestfs-actions.pod:3241
12719 msgid "guestfs_is_config"
12724 #: ../src/guestfs-actions.pod:3243
12728 " guestfs_is_config (guestfs_h *g);\n"
12734 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2272
12736 "This returns true iff this handle is being configured (in the C<CONFIG> "
12742 #: ../src/guestfs-actions.pod:3255
12743 msgid "guestfs_is_dir"
12748 #: ../src/guestfs-actions.pod:3257
12752 " guestfs_is_dir (guestfs_h *g,\n"
12753 " const char *path);\n"
12759 #: ../src/guestfs-actions.pod:3261 ../fish/guestfish-actions.pod:2281
12761 "This returns C<true> if and only if there is a directory with the given "
12762 "C<path> name. Note that it returns false for other objects like files."
12767 #: ../src/guestfs-actions.pod:3271
12768 msgid "guestfs_is_fifo"
12773 #: ../src/guestfs-actions.pod:3273
12777 " guestfs_is_fifo (guestfs_h *g,\n"
12778 " const char *path);\n"
12784 #: ../src/guestfs-actions.pod:3277 ../fish/guestfish-actions.pod:2291
12786 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12787 "given C<path> name."
12792 #: ../src/guestfs-actions.pod:3286
12793 msgid "guestfs_is_file"
12798 #: ../src/guestfs-actions.pod:3288
12802 " guestfs_is_file (guestfs_h *g,\n"
12803 " const char *path);\n"
12809 #: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2300
12811 "This returns C<true> if and only if there is a regular file with the given "
12812 "C<path> name. Note that it returns false for other objects like directories."
12817 #: ../src/guestfs-actions.pod:3302
12818 msgid "guestfs_is_launching"
12823 #: ../src/guestfs-actions.pod:3304
12827 " guestfs_is_launching (guestfs_h *g);\n"
12833 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2310
12835 "This returns true iff this handle is launching the subprocess (in the "
12836 "C<LAUNCHING> state)."
12841 #: ../src/guestfs-actions.pod:3316
12842 msgid "guestfs_is_lv"
12847 #: ../src/guestfs-actions.pod:3318
12851 " guestfs_is_lv (guestfs_h *g,\n"
12852 " const char *device);\n"
12858 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2319
12860 "This command tests whether C<device> is a logical volume, and returns true "
12861 "iff this is the case."
12866 #: ../src/guestfs-actions.pod:3329
12867 msgid "guestfs_is_ready"
12872 #: ../src/guestfs-actions.pod:3331
12876 " guestfs_is_ready (guestfs_h *g);\n"
12882 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2326
12884 "This returns true iff this handle is ready to accept commands (in the "
12890 #: ../src/guestfs-actions.pod:3343
12891 msgid "guestfs_is_socket"
12896 #: ../src/guestfs-actions.pod:3345
12900 " guestfs_is_socket (guestfs_h *g,\n"
12901 " const char *path);\n"
12907 #: ../src/guestfs-actions.pod:3349 ../fish/guestfish-actions.pod:2335
12909 "This returns C<true> if and only if there is a Unix domain socket with the "
12910 "given C<path> name."
12915 #: ../src/guestfs-actions.pod:3358
12916 msgid "guestfs_is_symlink"
12921 #: ../src/guestfs-actions.pod:3360
12925 " guestfs_is_symlink (guestfs_h *g,\n"
12926 " const char *path);\n"
12932 #: ../src/guestfs-actions.pod:3364 ../fish/guestfish-actions.pod:2344
12934 "This returns C<true> if and only if there is a symbolic link with the given "
12940 #: ../src/guestfs-actions.pod:3373
12941 msgid "guestfs_kill_subprocess"
12946 #: ../src/guestfs-actions.pod:3375
12950 " guestfs_kill_subprocess (guestfs_h *g);\n"
12956 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2353
12957 msgid "This kills the qemu subprocess. You should never need to call this."
12962 #: ../src/guestfs-actions.pod:3384
12963 msgid "guestfs_launch"
12968 #: ../src/guestfs-actions.pod:3386
12972 " guestfs_launch (guestfs_h *g);\n"
12978 #: ../src/guestfs-actions.pod:3389 ../fish/guestfish-actions.pod:2361
12980 "Internally libguestfs is implemented by running a virtual machine using "
12986 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2364
12988 "You should call this after configuring the handle (eg. adding drives) but "
12989 "before performing any actions."
12994 #: ../src/guestfs-actions.pod:3404
12995 msgid "guestfs_lchown"
13000 #: ../src/guestfs-actions.pod:3406
13004 " guestfs_lchown (guestfs_h *g,\n"
13007 " const char *path);\n"
13013 #: ../src/guestfs-actions.pod:3412
13015 "Change the file owner to C<owner> and group to C<group>. This is like "
13016 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
13017 "changed, not the target."
13022 #: ../src/guestfs-actions.pod:3424
13023 msgid "guestfs_lgetxattr"
13028 #: ../src/guestfs-actions.pod:3426
13032 " guestfs_lgetxattr (guestfs_h *g,\n"
13033 " const char *path,\n"
13034 " const char *name,\n"
13035 " size_t *size_r);\n"
13041 #: ../src/guestfs-actions.pod:3432 ../fish/guestfish-actions.pod:2383
13043 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13044 "is a symlink, then this call returns an extended attribute from the symlink."
13049 #: ../src/guestfs-actions.pod:3446
13050 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13055 #: ../src/guestfs-actions.pod:3454
13056 msgid "guestfs_lgetxattrs"
13061 #: ../src/guestfs-actions.pod:3456
13064 " struct guestfs_xattr_list *\n"
13065 " guestfs_lgetxattrs (guestfs_h *g,\n"
13066 " const char *path);\n"
13072 #: ../src/guestfs-actions.pod:3460
13074 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13075 "then it returns the extended attributes of the link itself."
13080 #: ../src/guestfs-actions.pod:3470
13081 msgid "guestfs_list_devices"
13086 #: ../src/guestfs-actions.pod:3472
13090 " guestfs_list_devices (guestfs_h *g);\n"
13096 #: ../src/guestfs-actions.pod:3475 ../fish/guestfish-actions.pod:2411
13097 msgid "List all the block devices."
13102 #: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2413
13103 msgid "The full block device names are returned, eg. C</dev/sda>."
13108 #: ../src/guestfs-actions.pod:3487
13109 msgid "guestfs_list_filesystems"
13114 #: ../src/guestfs-actions.pod:3489
13118 " guestfs_list_filesystems (guestfs_h *g);\n"
13124 #: ../src/guestfs-actions.pod:3492 ../fish/guestfish-actions.pod:2421
13126 "This inspection command looks for filesystems on partitions, block devices "
13127 "and logical volumes, returning a list of devices containing filesystems and "
13133 #: ../src/guestfs-actions.pod:3496 ../fish/guestfish-actions.pod:2425
13135 "The return value is a hash, where the keys are the devices containing "
13136 "filesystems, and the values are the filesystem types. For example:"
13141 #: ../src/guestfs-actions.pod:3500 ../fish/guestfish-actions.pod:2429
13144 " \"/dev/sda1\" => \"ntfs\"\n"
13145 " \"/dev/sda2\" => \"ext2\"\n"
13146 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13147 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13153 #: ../src/guestfs-actions.pod:3505 ../fish/guestfish-actions.pod:2434
13155 "The value can have the special value \"unknown\", meaning the content of the "
13156 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13161 #: ../src/guestfs-actions.pod:3509
13163 "This command runs other libguestfs commands, which might include "
13164 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13165 "soon after launch and only when nothing is mounted."
13170 #: ../src/guestfs-actions.pod:3513
13172 "Not all of the filesystems returned will be mountable. In particular, swap "
13173 "partitions are returned in the list. Also this command does not check that "
13174 "each filesystem found is valid and mountable, and some filesystems might be "
13175 "mountable but require special options. Filesystems may not all belong to a "
13176 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13181 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:5132
13182 msgid "(Added in 1.5.15)"
13187 #: ../src/guestfs-actions.pod:3529
13188 msgid "guestfs_list_partitions"
13193 #: ../src/guestfs-actions.pod:3531
13197 " guestfs_list_partitions (guestfs_h *g);\n"
13203 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2454
13204 msgid "List all the partitions detected on all block devices."
13209 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2456
13210 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13215 #: ../src/guestfs-actions.pod:3538
13217 "This does not return logical volumes. For that you will need to call "
13223 #: ../src/guestfs-actions.pod:3549
13229 #: ../src/guestfs-actions.pod:3551
13233 " guestfs_ll (guestfs_h *g,\n"
13234 " const char *directory);\n"
13240 #: ../src/guestfs-actions.pod:3555 ../fish/guestfish-actions.pod:2467
13242 "List the files in C<directory> (relative to the root directory, there is no "
13243 "cwd) in the format of 'ls -la'."
13248 #: ../src/guestfs-actions.pod:3558 ../fish/guestfish-actions.pod:2470
13250 "This command is mostly useful for interactive sessions. It is I<not> "
13251 "intended that you try to parse the output string."
13256 #: ../src/guestfs-actions.pod:3566
13262 #: ../src/guestfs-actions.pod:3568
13266 " guestfs_ln (guestfs_h *g,\n"
13267 " const char *target,\n"
13268 " const char *linkname);\n"
13274 #: ../src/guestfs-actions.pod:3573 ../fish/guestfish-actions.pod:2477
13275 msgid "This command creates a hard link using the C<ln> command."
13280 #: ../src/guestfs-actions.pod:3579
13281 msgid "guestfs_ln_f"
13286 #: ../src/guestfs-actions.pod:3581
13290 " guestfs_ln_f (guestfs_h *g,\n"
13291 " const char *target,\n"
13292 " const char *linkname);\n"
13298 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2483
13300 "This command creates a hard link using the C<ln -f> command. The C<-f> "
13301 "option removes the link (C<linkname>) if it exists already."
13306 #: ../src/guestfs-actions.pod:3593
13307 msgid "guestfs_ln_s"
13312 #: ../src/guestfs-actions.pod:3595
13316 " guestfs_ln_s (guestfs_h *g,\n"
13317 " const char *target,\n"
13318 " const char *linkname);\n"
13324 #: ../src/guestfs-actions.pod:3600 ../fish/guestfish-actions.pod:2490
13325 msgid "This command creates a symbolic link using the C<ln -s> command."
13330 #: ../src/guestfs-actions.pod:3606
13331 msgid "guestfs_ln_sf"
13336 #: ../src/guestfs-actions.pod:3608
13340 " guestfs_ln_sf (guestfs_h *g,\n"
13341 " const char *target,\n"
13342 " const char *linkname);\n"
13348 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2496
13350 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
13351 "option removes the link (C<linkname>) if it exists already."
13356 #: ../src/guestfs-actions.pod:3620
13357 msgid "guestfs_lremovexattr"
13362 #: ../src/guestfs-actions.pod:3622
13366 " guestfs_lremovexattr (guestfs_h *g,\n"
13367 " const char *xattr,\n"
13368 " const char *path);\n"
13374 #: ../src/guestfs-actions.pod:3627
13376 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13377 "link, then it removes an extended attribute of the link itself."
13382 #: ../src/guestfs-actions.pod:3635
13388 #: ../src/guestfs-actions.pod:3637
13392 " guestfs_ls (guestfs_h *g,\n"
13393 " const char *directory);\n"
13399 #: ../src/guestfs-actions.pod:3641 ../fish/guestfish-actions.pod:2511
13401 "List the files in C<directory> (relative to the root directory, there is no "
13402 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13407 #: ../src/guestfs-actions.pod:3645
13409 "This command is mostly useful for interactive sessions. Programs should "
13410 "probably use C<guestfs_readdir> instead."
13415 #: ../src/guestfs-actions.pod:3654
13416 msgid "guestfs_lsetxattr"
13421 #: ../src/guestfs-actions.pod:3656
13425 " guestfs_lsetxattr (guestfs_h *g,\n"
13426 " const char *xattr,\n"
13427 " const char *val,\n"
13429 " const char *path);\n"
13435 #: ../src/guestfs-actions.pod:3663
13437 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13438 "then it sets an extended attribute of the link itself."
13443 #: ../src/guestfs-actions.pod:3671
13444 msgid "guestfs_lstat"
13449 #: ../src/guestfs-actions.pod:3673
13452 " struct guestfs_stat *\n"
13453 " guestfs_lstat (guestfs_h *g,\n"
13454 " const char *path);\n"
13460 #: ../src/guestfs-actions.pod:3677 ../src/guestfs-actions.pod:6235
13461 #: ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:4199
13462 msgid "Returns file information for the given C<path>."
13467 #: ../src/guestfs-actions.pod:3679
13469 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13470 "link, then the link is stat-ed, not the file it refers to."
13475 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2536
13476 msgid "This is the same as the C<lstat(2)> system call."
13481 #: ../src/guestfs-actions.pod:3685 ../src/guestfs-actions.pod:6239
13483 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13484 "error. I<The caller must call C<guestfs_free_stat> after use>."
13489 #: ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:6243
13490 #: ../src/guestfs-actions.pod:6261 ../src/guestfs-actions.pod:6642
13491 msgid "(Added in 0.9.2)"
13496 #: ../src/guestfs-actions.pod:3691
13497 msgid "guestfs_lstatlist"
13502 #: ../src/guestfs-actions.pod:3693
13505 " struct guestfs_stat_list *\n"
13506 " guestfs_lstatlist (guestfs_h *g,\n"
13507 " const char *path,\n"
13508 " char *const *names);\n"
13514 #: ../src/guestfs-actions.pod:3698
13516 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13517 "files, where all files are in the directory C<path>. C<names> is the list "
13518 "of files from this directory."
13523 #: ../src/guestfs-actions.pod:3702 ../fish/guestfish-actions.pod:2546
13525 "On return you get a list of stat structs, with a one-to-one correspondence "
13526 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13527 "then the C<ino> field of that structure is set to C<-1>."
13532 #: ../src/guestfs-actions.pod:3707
13534 "This call is intended for programs that want to efficiently list a directory "
13535 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13536 "for a similarly efficient call for getting extended attributes. Very long "
13537 "directory listings might cause the protocol message size to be exceeded, "
13538 "causing this call to fail. The caller must split up such requests into "
13539 "smaller groups of names."
13544 #: ../src/guestfs-actions.pod:3715
13546 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13547 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13552 #: ../src/guestfs-actions.pod:3721
13553 msgid "guestfs_luks_add_key"
13558 #: ../src/guestfs-actions.pod:3723
13562 " guestfs_luks_add_key (guestfs_h *g,\n"
13563 " const char *device,\n"
13564 " const char *key,\n"
13565 " const char *newkey,\n"
13572 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2563
13574 "This command adds a new key on LUKS device C<device>. C<key> is any "
13575 "existing key, and is used to access the device. C<newkey> is the new key to "
13576 "add. C<keyslot> is the key slot that will be replaced."
13581 #: ../src/guestfs-actions.pod:3735
13583 "Note that if C<keyslot> already contains a key, then this command will "
13584 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13589 #: ../src/guestfs-actions.pod:3741 ../src/guestfs-actions.pod:3781
13590 #: ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:3824
13591 #: ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:3875
13593 "This function takes a key or passphrase parameter which could contain "
13594 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13600 #: ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:3785
13601 #: ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:3828
13602 msgid "(Added in 1.5.2)"
13607 #: ../src/guestfs-actions.pod:3747
13608 msgid "guestfs_luks_close"
13613 #: ../src/guestfs-actions.pod:3749
13617 " guestfs_luks_close (guestfs_h *g,\n"
13618 " const char *device);\n"
13624 #: ../src/guestfs-actions.pod:3753
13626 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13627 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13628 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13629 "underlying block device."
13634 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:3860
13635 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3929
13636 #: ../src/guestfs-actions.pod:3977
13637 msgid "(Added in 1.5.1)"
13642 #: ../src/guestfs-actions.pod:3763
13643 msgid "guestfs_luks_format"
13648 #: ../src/guestfs-actions.pod:3765
13652 " guestfs_luks_format (guestfs_h *g,\n"
13653 " const char *device,\n"
13654 " const char *key,\n"
13661 #: ../src/guestfs-actions.pod:3771 ../fish/guestfish-actions.pod:2589
13663 "This command erases existing data on C<device> and formats the device as a "
13664 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13665 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13670 #: ../src/guestfs-actions.pod:3778 ../src/guestfs-actions.pod:3801
13671 #: ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:4883
13672 #: ../src/guestfs-actions.pod:5663 ../src/guestfs-actions.pod:6070
13673 #: ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6119
13674 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:2597
13675 #: ../fish/guestfish-actions.pod:2610 ../fish/guestfish-actions.pod:2694
13676 #: ../fish/guestfish-actions.pod:3268 ../fish/guestfish-actions.pod:3788
13677 #: ../fish/guestfish-actions.pod:4098 ../fish/guestfish-actions.pod:4114
13678 #: ../fish/guestfish-actions.pod:4129 ../fish/guestfish-actions.pod:4844
13680 "B<This command is dangerous. Without careful use you can easily destroy all "
13686 #: ../src/guestfs-actions.pod:3787
13687 msgid "guestfs_luks_format_cipher"
13692 #: ../src/guestfs-actions.pod:3789
13696 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13697 " const char *device,\n"
13698 " const char *key,\n"
13700 " const char *cipher);\n"
13706 #: ../src/guestfs-actions.pod:3796
13708 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13709 "set the C<cipher> used."
13714 #: ../src/guestfs-actions.pod:3810
13715 msgid "guestfs_luks_kill_slot"
13720 #: ../src/guestfs-actions.pod:3812
13724 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13725 " const char *device,\n"
13726 " const char *key,\n"
13733 #: ../src/guestfs-actions.pod:3818 ../fish/guestfish-actions.pod:2617
13735 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13736 "device C<device>. C<key> must be one of the I<other> keys."
13741 #: ../src/guestfs-actions.pod:3830
13742 msgid "guestfs_luks_open"
13747 #: ../src/guestfs-actions.pod:3832
13751 " guestfs_luks_open (guestfs_h *g,\n"
13752 " const char *device,\n"
13753 " const char *key,\n"
13754 " const char *mapname);\n"
13760 #: ../src/guestfs-actions.pod:3838 ../fish/guestfish-actions.pod:2628
13762 "This command opens a block device which has been encrypted according to the "
13763 "Linux Unified Key Setup (LUKS) standard."
13768 #: ../src/guestfs-actions.pod:3841 ../fish/guestfish-actions.pod:2631
13769 msgid "C<device> is the encrypted block device or partition."
13774 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2633
13776 "The caller must supply one of the keys associated with the LUKS block "
13777 "device, in the C<key> parameter."
13782 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2636
13784 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13785 "writes to this block device are decrypted from and encrypted to the "
13786 "underlying C<device> respectively."
13791 #: ../src/guestfs-actions.pod:3850
13793 "If this block device contains LVM volume groups, then calling "
13794 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13800 #: ../src/guestfs-actions.pod:3862
13801 msgid "guestfs_luks_open_ro"
13806 #: ../src/guestfs-actions.pod:3864
13810 " guestfs_luks_open_ro (guestfs_h *g,\n"
13811 " const char *device,\n"
13812 " const char *key,\n"
13813 " const char *mapname);\n"
13819 #: ../src/guestfs-actions.pod:3870
13821 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13827 #: ../src/guestfs-actions.pod:3881
13828 msgid "guestfs_lvcreate"
13833 #: ../src/guestfs-actions.pod:3883
13837 " guestfs_lvcreate (guestfs_h *g,\n"
13838 " const char *logvol,\n"
13839 " const char *volgroup,\n"
13846 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2661
13848 "This creates an LVM logical volume called C<logvol> on the volume group "
13849 "C<volgroup>, with C<size> megabytes."
13854 #: ../src/guestfs-actions.pod:3896
13855 msgid "guestfs_lvm_canonical_lv_name"
13860 #: ../src/guestfs-actions.pod:3898
13864 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13865 " const char *lvname);\n"
13871 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2668
13873 "This converts alternative naming schemes for LVs that you might find to the "
13874 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13880 #: ../src/guestfs-actions.pod:3906 ../fish/guestfish-actions.pod:2672
13882 "This command returns an error if the C<lvname> parameter does not refer to a "
13888 #: ../src/guestfs-actions.pod:3909
13889 msgid "See also C<guestfs_is_lv>."
13894 #: ../src/guestfs-actions.pod:3914
13895 msgid "(Added in 1.5.24)"
13900 #: ../src/guestfs-actions.pod:3916
13901 msgid "guestfs_lvm_clear_filter"
13906 #: ../src/guestfs-actions.pod:3918
13910 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13916 #: ../src/guestfs-actions.pod:3921
13918 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13919 "see every block device."
13924 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:3966
13925 #: ../fish/guestfish-actions.pod:2684 ../fish/guestfish-actions.pod:2715
13927 "This command also clears the LVM cache and performs a volume group scan."
13932 #: ../src/guestfs-actions.pod:3931
13933 msgid "guestfs_lvm_remove_all"
13938 #: ../src/guestfs-actions.pod:3933
13942 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13948 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2691
13950 "This command removes all LVM logical volumes, volume groups and physical "
13956 #: ../src/guestfs-actions.pod:3946
13957 msgid "guestfs_lvm_set_filter"
13962 #: ../src/guestfs-actions.pod:3948
13966 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13967 " char *const *devices);\n"
13973 #: ../src/guestfs-actions.pod:3952 ../fish/guestfish-actions.pod:2701
13975 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13976 "block devices in the list C<devices>, and will ignore all other attached "
13982 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2705
13984 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13985 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13986 "there are two types of duplication possible: either cloned PVs/VGs which "
13987 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13988 "same name. In normal operation you cannot create this situation, but you "
13989 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13990 "inside the LVM metadata."
13995 #: ../src/guestfs-actions.pod:3969 ../fish/guestfish-actions.pod:2718
13996 msgid "You can filter whole block devices or individual partitions."
14001 #: ../src/guestfs-actions.pod:3971 ../fish/guestfish-actions.pod:2720
14003 "You cannot use this if any VG is currently in use (eg. contains a mounted "
14004 "filesystem), even if you are not filtering out that VG."
14009 #: ../src/guestfs-actions.pod:3979
14010 msgid "guestfs_lvremove"
14015 #: ../src/guestfs-actions.pod:3981
14019 " guestfs_lvremove (guestfs_h *g,\n"
14020 " const char *device);\n"
14026 #: ../src/guestfs-actions.pod:3985 ../fish/guestfish-actions.pod:2728
14028 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14029 "LV, such as C</dev/VG/LV>."
14034 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2731
14036 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14042 #: ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:5229
14043 #: ../src/guestfs-actions.pod:7018
14044 msgid "(Added in 1.0.13)"
14049 #: ../src/guestfs-actions.pod:3995
14050 msgid "guestfs_lvrename"
14055 #: ../src/guestfs-actions.pod:3997
14059 " guestfs_lvrename (guestfs_h *g,\n"
14060 " const char *logvol,\n"
14061 " const char *newlogvol);\n"
14067 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2738
14068 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14073 #: ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:7031
14074 msgid "(Added in 1.0.83)"
14079 #: ../src/guestfs-actions.pod:4008
14080 msgid "guestfs_lvresize"
14085 #: ../src/guestfs-actions.pod:4010
14089 " guestfs_lvresize (guestfs_h *g,\n"
14090 " const char *device,\n"
14097 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2744
14099 "This resizes (expands or shrinks) an existing LVM logical volume to "
14100 "C<mbytes>. When reducing, data in the reduced part is lost."
14105 #: ../src/guestfs-actions.pod:4023
14106 msgid "guestfs_lvresize_free"
14111 #: ../src/guestfs-actions.pod:4025
14115 " guestfs_lvresize_free (guestfs_h *g,\n"
14116 " const char *lv,\n"
14123 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2752
14125 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14126 "remaining free space in the volume group. Commonly you would call this with "
14127 "pc = 100 which expands the logical volume as much as possible, using all "
14128 "remaining free space in the volume group."
14133 #: ../src/guestfs-actions.pod:4038
14134 msgid "(Added in 1.3.3)"
14139 #: ../src/guestfs-actions.pod:4040
14140 msgid "guestfs_lvs"
14145 #: ../src/guestfs-actions.pod:4042
14149 " guestfs_lvs (guestfs_h *g);\n"
14155 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2762
14157 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14163 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2765
14165 "This returns a list of the logical volume device names (eg. C</dev/"
14166 "VolGroup00/LogVol00>)."
14171 #: ../src/guestfs-actions.pod:4051
14172 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14177 #: ../src/guestfs-actions.pod:4059
14178 msgid "guestfs_lvs_full"
14183 #: ../src/guestfs-actions.pod:4061
14186 " struct guestfs_lvm_lv_list *\n"
14187 " guestfs_lvs_full (guestfs_h *g);\n"
14193 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2774
14195 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14196 "(8)> command. The \"full\" version includes all fields."
14201 #: ../src/guestfs-actions.pod:4067
14203 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14204 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14209 #: ../src/guestfs-actions.pod:4073
14210 msgid "guestfs_lvuuid"
14215 #: ../src/guestfs-actions.pod:4075
14219 " guestfs_lvuuid (guestfs_h *g,\n"
14220 " const char *device);\n"
14226 #: ../src/guestfs-actions.pod:4079 ../fish/guestfish-actions.pod:2781
14227 msgid "This command returns the UUID of the LVM LV C<device>."
14232 #: ../src/guestfs-actions.pod:4086
14233 msgid "guestfs_lxattrlist"
14238 #: ../src/guestfs-actions.pod:4088
14241 " struct guestfs_xattr_list *\n"
14242 " guestfs_lxattrlist (guestfs_h *g,\n"
14243 " const char *path,\n"
14244 " char *const *names);\n"
14250 #: ../src/guestfs-actions.pod:4093 ../fish/guestfish-actions.pod:2787
14252 "This call allows you to get the extended attributes of multiple files, where "
14253 "all files are in the directory C<path>. C<names> is the list of files from "
14259 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2791
14261 "On return you get a flat list of xattr structs which must be interpreted "
14262 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14263 "C<attrval> in this struct is zero-length to indicate there was an error "
14264 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14265 "number (the number of following attributes for this file, which could be C<"
14266 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14267 "for the first named file. This repeats for the second and subsequent files."
14272 #: ../src/guestfs-actions.pod:4107
14274 "This call is intended for programs that want to efficiently list a directory "
14275 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14276 "a similarly efficient call for getting standard stats. Very long directory "
14277 "listings might cause the protocol message size to be exceeded, causing this "
14278 "call to fail. The caller must split up such requests into smaller groups of "
14284 #: ../src/guestfs-actions.pod:4121
14285 msgid "guestfs_mkdir"
14290 #: ../src/guestfs-actions.pod:4123
14294 " guestfs_mkdir (guestfs_h *g,\n"
14295 " const char *path);\n"
14301 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2813
14302 msgid "Create a directory named C<path>."
14307 #: ../src/guestfs-actions.pod:4133
14308 msgid "guestfs_mkdir_mode"
14313 #: ../src/guestfs-actions.pod:4135
14317 " guestfs_mkdir_mode (guestfs_h *g,\n"
14318 " const char *path,\n"
14325 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2819
14327 "This command creates a directory, setting the initial permissions of the "
14328 "directory to C<mode>."
14333 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:2822
14335 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14336 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14342 #: ../src/guestfs-actions.pod:4147
14343 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14348 #: ../src/guestfs-actions.pod:4153
14349 msgid "guestfs_mkdir_p"
14354 #: ../src/guestfs-actions.pod:4155
14358 " guestfs_mkdir_p (guestfs_h *g,\n"
14359 " const char *path);\n"
14365 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2832
14367 "Create a directory named C<path>, creating any parent directories as "
14368 "necessary. This is like the C<mkdir -p> shell command."
14373 #: ../src/guestfs-actions.pod:4166
14374 msgid "guestfs_mkdtemp"
14379 #: ../src/guestfs-actions.pod:4168
14383 " guestfs_mkdtemp (guestfs_h *g,\n"
14384 " const char *template);\n"
14390 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2839
14392 "This command creates a temporary directory. The C<template> parameter "
14393 "should be a full pathname for the temporary directory name with the final "
14394 "six characters being \"XXXXXX\"."
14399 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2844
14401 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14402 "being suitable for Windows filesystems."
14407 #: ../src/guestfs-actions.pod:4180 ../fish/guestfish-actions.pod:2847
14408 msgid "The name of the temporary directory that was created is returned."
14413 #: ../src/guestfs-actions.pod:4183 ../fish/guestfish-actions.pod:2850
14414 msgid "The temporary directory is created with mode 0700 and is owned by root."
14419 #: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:2853
14421 "The caller is responsible for deleting the temporary directory and its "
14422 "contents after use."
14427 #: ../src/guestfs-actions.pod:4189 ../fish/guestfish-actions.pod:2856
14428 msgid "See also: L<mkdtemp(3)>"
14433 #: ../src/guestfs-actions.pod:4196
14434 msgid "guestfs_mke2fs_J"
14439 #: ../src/guestfs-actions.pod:4198
14443 " guestfs_mke2fs_J (guestfs_h *g,\n"
14444 " const char *fstype,\n"
14445 " int blocksize,\n"
14446 " const char *device,\n"
14447 " const char *journal);\n"
14453 #: ../src/guestfs-actions.pod:4205 ../fish/guestfish-actions.pod:2862
14455 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14456 "C<journal>. It is equivalent to the command:"
14461 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2866
14464 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14470 #: ../src/guestfs-actions.pod:4211
14471 msgid "See also C<guestfs_mke2journal>."
14476 #: ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4233
14477 #: ../src/guestfs-actions.pod:4251 ../src/guestfs-actions.pod:4267
14478 #: ../src/guestfs-actions.pod:4281 ../src/guestfs-actions.pod:4295
14479 #: ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4619
14480 msgid "(Added in 1.0.68)"
14485 #: ../src/guestfs-actions.pod:4217
14486 msgid "guestfs_mke2fs_JL"
14491 #: ../src/guestfs-actions.pod:4219
14495 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14496 " const char *fstype,\n"
14497 " int blocksize,\n"
14498 " const char *device,\n"
14499 " const char *label);\n"
14505 #: ../src/guestfs-actions.pod:4226 ../fish/guestfish-actions.pod:2874
14507 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14508 "the journal labeled C<label>."
14513 #: ../src/guestfs-actions.pod:4229
14514 msgid "See also C<guestfs_mke2journal_L>."
14519 #: ../src/guestfs-actions.pod:4235
14520 msgid "guestfs_mke2fs_JU"
14525 #: ../src/guestfs-actions.pod:4237
14529 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14530 " const char *fstype,\n"
14531 " int blocksize,\n"
14532 " const char *device,\n"
14533 " const char *uuid);\n"
14539 #: ../src/guestfs-actions.pod:4244 ../fish/guestfish-actions.pod:2883
14541 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14542 "the journal with UUID C<uuid>."
14547 #: ../src/guestfs-actions.pod:4247
14548 msgid "See also C<guestfs_mke2journal_U>."
14553 #: ../src/guestfs-actions.pod:4253
14554 msgid "guestfs_mke2journal"
14559 #: ../src/guestfs-actions.pod:4255
14563 " guestfs_mke2journal (guestfs_h *g,\n"
14564 " int blocksize,\n"
14565 " const char *device);\n"
14571 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2892
14573 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14579 #: ../src/guestfs-actions.pod:4263 ../fish/guestfish-actions.pod:2895
14582 " mke2fs -O journal_dev -b blocksize device\n"
14588 #: ../src/guestfs-actions.pod:4269
14589 msgid "guestfs_mke2journal_L"
14594 #: ../src/guestfs-actions.pod:4271
14598 " guestfs_mke2journal_L (guestfs_h *g,\n"
14599 " int blocksize,\n"
14600 " const char *label,\n"
14601 " const char *device);\n"
14607 #: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:2901
14608 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14613 #: ../src/guestfs-actions.pod:4283
14614 msgid "guestfs_mke2journal_U"
14619 #: ../src/guestfs-actions.pod:4285
14623 " guestfs_mke2journal_U (guestfs_h *g,\n"
14624 " int blocksize,\n"
14625 " const char *uuid,\n"
14626 " const char *device);\n"
14632 #: ../src/guestfs-actions.pod:4291 ../fish/guestfish-actions.pod:2907
14633 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14638 #: ../src/guestfs-actions.pod:4297
14639 msgid "guestfs_mkfifo"
14644 #: ../src/guestfs-actions.pod:4299
14648 " guestfs_mkfifo (guestfs_h *g,\n"
14650 " const char *path);\n"
14656 #: ../src/guestfs-actions.pod:4304
14658 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14659 "is just a convenient wrapper around C<guestfs_mknod>."
14664 #: ../src/guestfs-actions.pod:4314
14665 msgid "guestfs_mkfs"
14670 #: ../src/guestfs-actions.pod:4316
14674 " guestfs_mkfs (guestfs_h *g,\n"
14675 " const char *fstype,\n"
14676 " const char *device);\n"
14682 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2923
14684 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14685 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14690 #: ../src/guestfs-actions.pod:4329
14691 msgid "guestfs_mkfs_b"
14696 #: ../src/guestfs-actions.pod:4331
14700 " guestfs_mkfs_b (guestfs_h *g,\n"
14701 " const char *fstype,\n"
14702 " int blocksize,\n"
14703 " const char *device);\n"
14709 #: ../src/guestfs-actions.pod:4337
14711 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14712 "block size of the resulting filesystem. Supported block sizes depend on the "
14713 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14718 #: ../src/guestfs-actions.pod:4342 ../src/guestfs-actions.pod:4385
14719 #: ../fish/guestfish-actions.pod:2936 ../fish/guestfish-actions.pod:2963
14721 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14727 #: ../src/guestfs-actions.pod:4347 ../fish/guestfish-actions.pod:2939
14729 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14734 #: ../src/guestfs-actions.pod:4356
14735 msgid "guestfs_mkfs_opts"
14740 #: ../src/guestfs-actions.pod:4358
14744 " guestfs_mkfs_opts (guestfs_h *g,\n"
14745 " const char *fstype,\n"
14746 " const char *device,\n"
14752 #: ../src/guestfs-actions.pod:4369
14755 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14756 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14762 #: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:2950
14764 "This function creates a filesystem on C<device>. The filesystem type is "
14765 "C<fstype>, for example C<ext3>."
14770 #: ../src/guestfs-actions.pod:4379 ../fish/guestfish-actions.pod:2957
14771 msgid "C<blocksize>"
14776 #: ../src/guestfs-actions.pod:4381 ../fish/guestfish-actions.pod:2959
14778 "The filesystem block size. Supported block sizes depend on the filesystem "
14779 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14784 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:2966
14785 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14789 #: ../src/guestfs-actions.pod:4390 ../fish/guestfish-actions.pod:2968
14790 msgid "C<features>"
14794 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2970
14795 msgid "This passes the C<-O> parameter to the external mkfs program."
14799 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2972
14801 "For certain filesystem types, this allows extra filesystem features to be "
14802 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14806 #: ../src/guestfs-actions.pod:4398 ../fish/guestfish-actions.pod:2976
14808 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14813 #: ../src/guestfs-actions.pod:4405
14814 msgid "(Added in 1.7.19)"
14819 #: ../src/guestfs-actions.pod:4407
14820 msgid "guestfs_mkfs_opts_va"
14825 #: ../src/guestfs-actions.pod:4409
14829 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14830 " const char *fstype,\n"
14831 " const char *device,\n"
14832 " va_list args);\n"
14838 #: ../src/guestfs-actions.pod:4415
14839 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14844 #: ../src/guestfs-actions.pod:4419
14845 msgid "guestfs_mkfs_opts_argv"
14850 #: ../src/guestfs-actions.pod:4421
14854 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14855 " const char *fstype,\n"
14856 " const char *device,\n"
14857 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14863 #: ../src/guestfs-actions.pod:4427
14864 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14869 #: ../src/guestfs-actions.pod:4431
14870 msgid "guestfs_mkmountpoint"
14875 #: ../src/guestfs-actions.pod:4433
14879 " guestfs_mkmountpoint (guestfs_h *g,\n"
14880 " const char *exemptpath);\n"
14886 #: ../src/guestfs-actions.pod:4437
14888 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14889 "that can be used to create extra mountpoints before mounting the first "
14895 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2991
14897 "These calls are I<only> necessary in some very limited circumstances, mainly "
14898 "the case where you want to mount a mix of unrelated and/or read-only "
14899 "filesystems together."
14904 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2995
14906 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14907 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14908 "inside that. You can unpack this as follows in guestfish:"
14913 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3000
14916 " add-ro Fedora-11-i686-Live.iso\n"
14918 " mkmountpoint /cd\n"
14919 " mkmountpoint /sqsh\n"
14920 " mkmountpoint /ext3fs\n"
14921 " mount /dev/sda /cd\n"
14922 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14923 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14929 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3009
14930 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14935 #: ../src/guestfs-actions.pod:4461
14937 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14938 "may get unexpected errors if you try to mix these calls. It is safest to "
14939 "manually unmount filesystems and remove mountpoints after use."
14944 #: ../src/guestfs-actions.pod:4465
14946 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14947 "first, so for this to work for manual mountpoints, you must ensure that the "
14948 "innermost mountpoints have the longest pathnames, as in the example code "
14954 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3020
14956 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14960 #: ../src/guestfs-actions.pod:4472
14962 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14963 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14964 "can also trigger these issues."
14969 #: ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4737
14970 #: ../src/guestfs-actions.pod:5647
14971 msgid "(Added in 1.0.62)"
14976 #: ../src/guestfs-actions.pod:4480
14977 msgid "guestfs_mknod"
14982 #: ../src/guestfs-actions.pod:4482
14986 " guestfs_mknod (guestfs_h *g,\n"
14990 " const char *path);\n"
14996 #: ../src/guestfs-actions.pod:4489 ../fish/guestfish-actions.pod:3030
14998 "This call creates block or character special devices, or named pipes (FIFOs)."
15003 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:3033
15005 "The C<mode> parameter should be the mode, using the standard constants. "
15006 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
15007 "used when creating block and character special devices."
15012 #: ../src/guestfs-actions.pod:4497
15014 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
15015 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
15016 "regular file). These constants are available in the standard Linux header "
15017 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
15018 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
15019 "the appropriate constant for you."
15024 #: ../src/guestfs-actions.pod:4511
15025 msgid "guestfs_mknod_b"
15030 #: ../src/guestfs-actions.pod:4513
15034 " guestfs_mknod_b (guestfs_h *g,\n"
15038 " const char *path);\n"
15044 #: ../src/guestfs-actions.pod:4520
15046 "This call creates a block device node called C<path> with mode C<mode> and "
15047 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15048 "wrapper around C<guestfs_mknod>."
15053 #: ../src/guestfs-actions.pod:4530
15054 msgid "guestfs_mknod_c"
15059 #: ../src/guestfs-actions.pod:4532
15063 " guestfs_mknod_c (guestfs_h *g,\n"
15067 " const char *path);\n"
15073 #: ../src/guestfs-actions.pod:4539
15075 "This call creates a char device node called C<path> with mode C<mode> and "
15076 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15077 "wrapper around C<guestfs_mknod>."
15082 #: ../src/guestfs-actions.pod:4549
15083 msgid "guestfs_mkswap"
15088 #: ../src/guestfs-actions.pod:4551
15092 " guestfs_mkswap (guestfs_h *g,\n"
15093 " const char *device);\n"
15099 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3072
15100 msgid "Create a swap partition on C<device>."
15105 #: ../src/guestfs-actions.pod:4561
15106 msgid "guestfs_mkswap_L"
15111 #: ../src/guestfs-actions.pod:4563
15115 " guestfs_mkswap_L (guestfs_h *g,\n"
15116 " const char *label,\n"
15117 " const char *device);\n"
15123 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3078
15124 msgid "Create a swap partition on C<device> with label C<label>."
15129 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3080
15131 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15132 "sda>), just to a partition. This appears to be a limitation of the kernel "
15138 #: ../src/guestfs-actions.pod:4578
15139 msgid "guestfs_mkswap_U"
15144 #: ../src/guestfs-actions.pod:4580
15148 " guestfs_mkswap_U (guestfs_h *g,\n"
15149 " const char *uuid,\n"
15150 " const char *device);\n"
15156 #: ../src/guestfs-actions.pod:4585 ../fish/guestfish-actions.pod:3088
15157 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15162 #: ../src/guestfs-actions.pod:4591
15163 msgid "guestfs_mkswap_file"
15168 #: ../src/guestfs-actions.pod:4593
15172 " guestfs_mkswap_file (guestfs_h *g,\n"
15173 " const char *path);\n"
15179 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3094
15180 msgid "Create a swap file."
15185 #: ../src/guestfs-actions.pod:4599
15187 "This command just writes a swap file signature to an existing file. To "
15188 "create the file itself, use something like C<guestfs_fallocate>."
15193 #: ../src/guestfs-actions.pod:4606
15194 msgid "guestfs_modprobe"
15199 #: ../src/guestfs-actions.pod:4608
15203 " guestfs_modprobe (guestfs_h *g,\n"
15204 " const char *modulename);\n"
15210 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3103
15211 msgid "This loads a kernel module in the appliance."
15216 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3105
15218 "The kernel module must have been whitelisted when libguestfs was built (see "
15219 "C<appliance/kmod.whitelist.in> in the source)."
15224 #: ../src/guestfs-actions.pod:4621
15225 msgid "guestfs_mount"
15230 #: ../src/guestfs-actions.pod:4623
15234 " guestfs_mount (guestfs_h *g,\n"
15235 " const char *device,\n"
15236 " const char *mountpoint);\n"
15242 #: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:3112
15244 "Mount a guest disk at a position in the filesystem. Block devices are named "
15245 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15246 "those block devices contain partitions, they will have the usual names (eg. "
15247 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15252 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3118
15254 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15255 "mounted on C</> before others can be mounted. Other filesystems can only be "
15256 "mounted on directories which already exist."
15261 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3123
15263 "The mounted filesystem is writable, if we have sufficient permissions on the "
15264 "underlying device."
15269 #: ../src/guestfs-actions.pod:4642
15271 "B<Important note:> When you use this call, the filesystem options C<sync> "
15272 "and C<noatime> are set implicitly. This was originally done because we "
15273 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15274 "very large negative performance impact and negligible effect on "
15275 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15276 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15277 "(use an empty string for the first parameter if you don't want any options)."
15282 #: ../src/guestfs-actions.pod:4656
15283 msgid "guestfs_mount_loop"
15288 #: ../src/guestfs-actions.pod:4658
15292 " guestfs_mount_loop (guestfs_h *g,\n"
15293 " const char *file,\n"
15294 " const char *mountpoint);\n"
15300 #: ../src/guestfs-actions.pod:4663 ../fish/guestfish-actions.pod:3140
15302 "This command lets you mount C<file> (a filesystem image in a file) on a "
15303 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15309 #: ../src/guestfs-actions.pod:4671
15310 msgid "guestfs_mount_options"
15315 #: ../src/guestfs-actions.pod:4673
15319 " guestfs_mount_options (guestfs_h *g,\n"
15320 " const char *options,\n"
15321 " const char *device,\n"
15322 " const char *mountpoint);\n"
15328 #: ../src/guestfs-actions.pod:4679
15330 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15331 "the mount options as for the L<mount(8)> I<-o> flag."
15336 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3152
15338 "If the C<options> parameter is an empty string, then no options are passed "
15339 "(all options default to whatever the filesystem uses)."
15344 #: ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4703
15345 #: ../src/guestfs-actions.pod:4720
15346 msgid "(Added in 1.0.10)"
15351 #: ../src/guestfs-actions.pod:4691
15352 msgid "guestfs_mount_ro"
15357 #: ../src/guestfs-actions.pod:4693
15361 " guestfs_mount_ro (guestfs_h *g,\n"
15362 " const char *device,\n"
15363 " const char *mountpoint);\n"
15369 #: ../src/guestfs-actions.pod:4698
15371 "This is the same as the C<guestfs_mount> command, but it mounts the "
15372 "filesystem with the read-only (I<-o ro>) flag."
15377 #: ../src/guestfs-actions.pod:4705
15378 msgid "guestfs_mount_vfs"
15383 #: ../src/guestfs-actions.pod:4707
15387 " guestfs_mount_vfs (guestfs_h *g,\n"
15388 " const char *options,\n"
15389 " const char *vfstype,\n"
15390 " const char *device,\n"
15391 " const char *mountpoint);\n"
15397 #: ../src/guestfs-actions.pod:4714
15399 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15400 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15406 #: ../src/guestfs-actions.pod:4722
15407 msgid "guestfs_mountpoints"
15412 #: ../src/guestfs-actions.pod:4724
15416 " guestfs_mountpoints (guestfs_h *g);\n"
15422 #: ../src/guestfs-actions.pod:4727
15424 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15425 "devices. This one returns a hash table (map) of device name to directory "
15426 "where the device is mounted."
15431 #: ../src/guestfs-actions.pod:4739
15432 msgid "guestfs_mounts"
15437 #: ../src/guestfs-actions.pod:4741
15441 " guestfs_mounts (guestfs_h *g);\n"
15447 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3183
15449 "This returns the list of currently mounted filesystems. It returns the list "
15450 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15455 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3186
15456 msgid "Some internal mounts are not shown."
15461 #: ../src/guestfs-actions.pod:4749
15462 msgid "See also: C<guestfs_mountpoints>"
15467 #: ../src/guestfs-actions.pod:4757
15473 #: ../src/guestfs-actions.pod:4759
15477 " guestfs_mv (guestfs_h *g,\n"
15478 " const char *src,\n"
15479 " const char *dest);\n"
15485 #: ../src/guestfs-actions.pod:4764 ../fish/guestfish-actions.pod:3194
15487 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15488 "destination filename or destination directory."
15493 #: ../src/guestfs-actions.pod:4771
15494 msgid "guestfs_ntfs_3g_probe"
15499 #: ../src/guestfs-actions.pod:4773
15503 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15505 " const char *device);\n"
15511 #: ../src/guestfs-actions.pod:4778 ../fish/guestfish-actions.pod:3201
15513 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15514 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15515 "write, and some cannot be mounted at all)."
15520 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3205
15522 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15523 "can be mounted read-write. Set it to false if you want to test if the "
15524 "volume can be mounted read-only."
15529 #: ../src/guestfs-actions.pod:4786 ../fish/guestfish-actions.pod:3209
15531 "The return value is an integer which C<0> if the operation would succeed, or "
15532 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15537 #: ../src/guestfs-actions.pod:4792
15538 msgid "(Added in 1.0.43)"
15543 #: ../src/guestfs-actions.pod:4794
15544 msgid "guestfs_ntfsresize"
15549 #: ../src/guestfs-actions.pod:4796
15553 " guestfs_ntfsresize (guestfs_h *g,\n"
15554 " const char *device);\n"
15560 #: ../src/guestfs-actions.pod:4800 ../fish/guestfish-actions.pod:3217
15562 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15563 "size of the underlying device. See also L<ntfsresize(8)>."
15568 #: ../src/guestfs-actions.pod:4808
15569 msgid "guestfs_ntfsresize_size"
15574 #: ../src/guestfs-actions.pod:4810
15578 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15579 " const char *device,\n"
15580 " int64_t size);\n"
15586 #: ../src/guestfs-actions.pod:4815
15588 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15589 "to specify the new size (in bytes) explicitly."
15594 #: ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:5256
15595 #: ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5595
15596 #: ../src/guestfs-actions.pod:7166
15597 msgid "(Added in 1.3.14)"
15602 #: ../src/guestfs-actions.pod:4822
15603 msgid "guestfs_part_add"
15608 #: ../src/guestfs-actions.pod:4824
15612 " guestfs_part_add (guestfs_h *g,\n"
15613 " const char *device,\n"
15614 " const char *prlogex,\n"
15615 " int64_t startsect,\n"
15616 " int64_t endsect);\n"
15622 #: ../src/guestfs-actions.pod:4831
15624 "This command adds a partition to C<device>. If there is no partition table "
15625 "on the device, call C<guestfs_part_init> first."
15630 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3235
15632 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15633 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15634 "C<logical>) and C<e> (or C<extended>) partition types."
15639 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3240
15641 "C<startsect> and C<endsect> are the start and end of the partition in "
15642 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15643 "from the end of the disk (C<-1> is the last sector)."
15648 #: ../src/guestfs-actions.pod:4843
15650 "Creating a partition which covers the whole disk is not so easy. Use "
15651 "C<guestfs_part_disk> to do that."
15656 #: ../src/guestfs-actions.pod:4848 ../src/guestfs-actions.pod:4886
15657 #: ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5017
15658 #: ../src/guestfs-actions.pod:5055 ../src/guestfs-actions.pod:5074
15659 #: ../src/guestfs-actions.pod:5114
15660 msgid "(Added in 1.0.78)"
15665 #: ../src/guestfs-actions.pod:4850
15666 msgid "guestfs_part_del"
15671 #: ../src/guestfs-actions.pod:4852
15675 " guestfs_part_del (guestfs_h *g,\n"
15676 " const char *device,\n"
15683 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3251
15684 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15689 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3253
15691 "Note that in the case of MBR partitioning, deleting an extended partition "
15692 "also deletes any logical partitions it contains."
15697 #: ../src/guestfs-actions.pod:4867
15698 msgid "guestfs_part_disk"
15703 #: ../src/guestfs-actions.pod:4869
15707 " guestfs_part_disk (guestfs_h *g,\n"
15708 " const char *device,\n"
15709 " const char *parttype);\n"
15715 #: ../src/guestfs-actions.pod:4874
15717 "This command is simply a combination of C<guestfs_part_init> followed by "
15718 "C<guestfs_part_add> to create a single primary partition covering the whole "
15724 #: ../src/guestfs-actions.pod:4878
15726 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15727 "possible values are described in C<guestfs_part_init>."
15732 #: ../src/guestfs-actions.pod:4888
15733 msgid "guestfs_part_get_bootable"
15738 #: ../src/guestfs-actions.pod:4890
15742 " guestfs_part_get_bootable (guestfs_h *g,\n"
15743 " const char *device,\n"
15750 #: ../src/guestfs-actions.pod:4895 ../fish/guestfish-actions.pod:3275
15752 "This command returns true if the partition C<partnum> on C<device> has the "
15753 "bootable flag set."
15758 #: ../src/guestfs-actions.pod:4898
15759 msgid "See also C<guestfs_part_set_bootable>."
15764 #: ../src/guestfs-actions.pod:4904
15765 msgid "guestfs_part_get_mbr_id"
15770 #: ../src/guestfs-actions.pod:4906
15774 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15775 " const char *device,\n"
15782 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3284
15784 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15785 "partition C<partnum>."
15790 #: ../src/guestfs-actions.pod:4914 ../src/guestfs-actions.pod:5090
15792 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15793 "undefined results for other partition table types (see "
15794 "C<guestfs_part_get_parttype>)."
15799 #: ../src/guestfs-actions.pod:4922
15800 msgid "guestfs_part_get_parttype"
15805 #: ../src/guestfs-actions.pod:4924
15809 " guestfs_part_get_parttype (guestfs_h *g,\n"
15810 " const char *device);\n"
15816 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3295
15818 "This command examines the partition table on C<device> and returns the "
15819 "partition table type (format) being used."
15824 #: ../src/guestfs-actions.pod:4931
15826 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15827 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15828 "possible, although unusual. See C<guestfs_part_init> for a full list."
15833 #: ../src/guestfs-actions.pod:4941
15834 msgid "guestfs_part_init"
15839 #: ../src/guestfs-actions.pod:4943
15843 " guestfs_part_init (guestfs_h *g,\n"
15844 " const char *device,\n"
15845 " const char *parttype);\n"
15851 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3307
15853 "This creates an empty partition table on C<device> of one of the partition "
15854 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15855 "(for large disks)."
15860 #: ../src/guestfs-actions.pod:4952
15862 "Initially there are no partitions. Following this, you should call "
15863 "C<guestfs_part_add> for each partition required."
15868 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3314
15869 msgid "Possible values for C<parttype> are:"
15874 #: ../src/guestfs-actions.pod:4959 ../fish/guestfish-actions.pod:3318
15875 msgid "B<efi> | B<gpt>"
15880 #: ../src/guestfs-actions.pod:4961 ../fish/guestfish-actions.pod:3320
15881 msgid "Intel EFI / GPT partition table."
15886 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3322
15888 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15889 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15890 "the C<mbr> format."
15895 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3326
15896 msgid "B<mbr> | B<msdos>"
15901 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3328
15903 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15904 "Windows. This partition type will B<only> work for device sizes up to 2 "
15905 "TB. For large disks we recommend using C<gpt>."
15910 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3335
15912 "Other partition table types that may work but are not supported include:"
15917 #: ../src/guestfs-actions.pod:4981 ../fish/guestfish-actions.pod:3340
15923 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3342
15924 msgid "AIX disk labels."
15929 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3344
15930 msgid "B<amiga> | B<rdb>"
15935 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3346
15936 msgid "Amiga \"Rigid Disk Block\" format."
15941 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3348
15947 #: ../src/guestfs-actions.pod:4991 ../fish/guestfish-actions.pod:3350
15948 msgid "BSD disk labels."
15953 #: ../src/guestfs-actions.pod:4993 ../fish/guestfish-actions.pod:3352
15959 #: ../src/guestfs-actions.pod:4995 ../fish/guestfish-actions.pod:3354
15960 msgid "DASD, used on IBM mainframes."
15965 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3356
15971 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3358
15972 msgid "MIPS/SGI volumes."
15977 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3360
15983 #: ../src/guestfs-actions.pod:5003 ../fish/guestfish-actions.pod:3362
15984 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15989 #: ../src/guestfs-actions.pod:5005 ../fish/guestfish-actions.pod:3364
15995 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3366
15996 msgid "NEC PC-98 format, common in Japan apparently."
16001 #: ../src/guestfs-actions.pod:5009 ../fish/guestfish-actions.pod:3368
16007 #: ../src/guestfs-actions.pod:5011 ../fish/guestfish-actions.pod:3370
16008 msgid "Sun disk labels."
16013 #: ../src/guestfs-actions.pod:5019
16014 msgid "guestfs_part_list"
16019 #: ../src/guestfs-actions.pod:5021
16022 " struct guestfs_partition_list *\n"
16023 " guestfs_part_list (guestfs_h *g,\n"
16024 " const char *device);\n"
16030 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3378
16032 "This command parses the partition table on C<device> and returns the list of "
16033 "partitions found."
16038 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3381
16039 msgid "The fields in the returned structure are:"
16044 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3385
16045 msgid "B<part_num>"
16050 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3387
16051 msgid "Partition number, counting from 1."
16056 #: ../src/guestfs-actions.pod:5036 ../fish/guestfish-actions.pod:3389
16057 msgid "B<part_start>"
16062 #: ../src/guestfs-actions.pod:5038
16064 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16065 "the device's sector size, see C<guestfs_blockdev_getss>."
16070 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3394
16071 msgid "B<part_end>"
16076 #: ../src/guestfs-actions.pod:5043 ../fish/guestfish-actions.pod:3396
16077 msgid "End of the partition in bytes."
16082 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3398
16083 msgid "B<part_size>"
16088 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3400
16089 msgid "Size of the partition in bytes."
16094 #: ../src/guestfs-actions.pod:5051
16096 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16097 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16103 #: ../src/guestfs-actions.pod:5057
16104 msgid "guestfs_part_set_bootable"
16109 #: ../src/guestfs-actions.pod:5059
16113 " guestfs_part_set_bootable (guestfs_h *g,\n"
16114 " const char *device,\n"
16116 " int bootable);\n"
16122 #: ../src/guestfs-actions.pod:5065 ../fish/guestfish-actions.pod:3408
16124 "This sets the bootable flag on partition numbered C<partnum> on device "
16125 "C<device>. Note that partitions are numbered from 1."
16130 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3411
16132 "The bootable flag is used by some operating systems (notably Windows) to "
16133 "determine which partition to boot from. It is by no means universally "
16139 #: ../src/guestfs-actions.pod:5076
16140 msgid "guestfs_part_set_mbr_id"
16145 #: ../src/guestfs-actions.pod:5078
16149 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16150 " const char *device,\n"
16158 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3419
16160 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16161 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16162 "documentation are in fact hexadecimal numbers, but usually documented "
16163 "without any leading \"0x\" which might be confusing."
16168 #: ../src/guestfs-actions.pod:5098
16169 msgid "guestfs_part_set_name"
16174 #: ../src/guestfs-actions.pod:5100
16178 " guestfs_part_set_name (guestfs_h *g,\n"
16179 " const char *device,\n"
16181 " const char *name);\n"
16187 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3433
16189 "This sets the partition name on partition numbered C<partnum> on device "
16190 "C<device>. Note that partitions are numbered from 1."
16195 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3436
16197 "The partition name can only be set on certain types of partition table. "
16198 "This works on C<gpt> but not on C<mbr> partitions."
16203 #: ../src/guestfs-actions.pod:5116
16204 msgid "guestfs_part_to_dev"
16209 #: ../src/guestfs-actions.pod:5118
16213 " guestfs_part_to_dev (guestfs_h *g,\n"
16214 " const char *partition);\n"
16220 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3443
16222 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16223 "partition number, returning the device name (eg. \"/dev/sdb\")."
16228 #: ../src/guestfs-actions.pod:5126
16230 "The named partition must exist, for example as a string returned from "
16231 "C<guestfs_list_partitions>."
16236 #: ../src/guestfs-actions.pod:5134
16237 msgid "guestfs_ping_daemon"
16242 #: ../src/guestfs-actions.pod:5136
16246 " guestfs_ping_daemon (guestfs_h *g);\n"
16252 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3454
16254 "This is a test probe into the guestfs daemon running inside the qemu "
16255 "subprocess. Calling this function checks that the daemon responds to the "
16256 "ping message, without affecting the daemon or attached block device(s) in "
16262 #: ../src/guestfs-actions.pod:5148
16263 msgid "guestfs_pread"
16268 #: ../src/guestfs-actions.pod:5150
16272 " guestfs_pread (guestfs_h *g,\n"
16273 " const char *path,\n"
16275 " int64_t offset,\n"
16276 " size_t *size_r);\n"
16282 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3463
16284 "This command lets you read part of a file. It reads C<count> bytes of the "
16285 "file, starting at C<offset>, from file C<path>."
16290 #: ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5186
16291 #: ../fish/guestfish-actions.pod:3466 ../fish/guestfish-actions.pod:3481
16293 "This may read fewer bytes than requested. For further details see the "
16294 "L<pread(2)> system call."
16299 #: ../src/guestfs-actions.pod:5163
16300 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16305 #: ../src/guestfs-actions.pod:5174
16306 msgid "guestfs_pread_device"
16311 #: ../src/guestfs-actions.pod:5176
16315 " guestfs_pread_device (guestfs_h *g,\n"
16316 " const char *device,\n"
16318 " int64_t offset,\n"
16319 " size_t *size_r);\n"
16325 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3478
16327 "This command lets you read part of a file. It reads C<count> bytes of "
16328 "C<device>, starting at C<offset>."
16333 #: ../src/guestfs-actions.pod:5189
16334 msgid "See also C<guestfs_pread>."
16339 #: ../src/guestfs-actions.pod:5198
16340 msgid "(Added in 1.5.21)"
16345 #: ../src/guestfs-actions.pod:5200
16346 msgid "guestfs_pvcreate"
16351 #: ../src/guestfs-actions.pod:5202
16355 " guestfs_pvcreate (guestfs_h *g,\n"
16356 " const char *device);\n"
16362 #: ../src/guestfs-actions.pod:5206 ../fish/guestfish-actions.pod:3493
16364 "This creates an LVM physical volume on the named C<device>, where C<device> "
16365 "should usually be a partition name such as C</dev/sda1>."
16370 #: ../src/guestfs-actions.pod:5214
16371 msgid "guestfs_pvremove"
16376 #: ../src/guestfs-actions.pod:5216
16380 " guestfs_pvremove (guestfs_h *g,\n"
16381 " const char *device);\n"
16387 #: ../src/guestfs-actions.pod:5220 ../fish/guestfish-actions.pod:3501
16389 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16395 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
16397 "The implementation uses the C<pvremove> command which refuses to wipe "
16398 "physical volumes that contain any volume groups, so you have to remove those "
16404 #: ../src/guestfs-actions.pod:5231
16405 msgid "guestfs_pvresize"
16410 #: ../src/guestfs-actions.pod:5233
16414 " guestfs_pvresize (guestfs_h *g,\n"
16415 " const char *device);\n"
16421 #: ../src/guestfs-actions.pod:5237 ../fish/guestfish-actions.pod:3512
16423 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16424 "the new size of the underlying device."
16429 #: ../src/guestfs-actions.pod:5244
16430 msgid "guestfs_pvresize_size"
16435 #: ../src/guestfs-actions.pod:5246
16439 " guestfs_pvresize_size (guestfs_h *g,\n"
16440 " const char *device,\n"
16441 " int64_t size);\n"
16447 #: ../src/guestfs-actions.pod:5251
16449 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16450 "specify the new size (in bytes) explicitly."
16455 #: ../src/guestfs-actions.pod:5258
16456 msgid "guestfs_pvs"
16461 #: ../src/guestfs-actions.pod:5260
16465 " guestfs_pvs (guestfs_h *g);\n"
16471 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3526
16473 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16479 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3529
16481 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16487 #: ../src/guestfs-actions.pod:5269
16488 msgid "See also C<guestfs_pvs_full>."
16493 #: ../src/guestfs-actions.pod:5277
16494 msgid "guestfs_pvs_full"
16499 #: ../src/guestfs-actions.pod:5279
16502 " struct guestfs_lvm_pv_list *\n"
16503 " guestfs_pvs_full (guestfs_h *g);\n"
16509 #: ../src/guestfs-actions.pod:5282 ../fish/guestfish-actions.pod:3538
16511 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16512 "(8)> command. The \"full\" version includes all fields."
16517 #: ../src/guestfs-actions.pod:5285
16519 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16520 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16525 #: ../src/guestfs-actions.pod:5291
16526 msgid "guestfs_pvuuid"
16531 #: ../src/guestfs-actions.pod:5293
16535 " guestfs_pvuuid (guestfs_h *g,\n"
16536 " const char *device);\n"
16542 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3545
16543 msgid "This command returns the UUID of the LVM PV C<device>."
16548 #: ../src/guestfs-actions.pod:5304
16549 msgid "guestfs_pwrite"
16554 #: ../src/guestfs-actions.pod:5306
16558 " guestfs_pwrite (guestfs_h *g,\n"
16559 " const char *path,\n"
16560 " const char *content,\n"
16561 " size_t content_size,\n"
16562 " int64_t offset);\n"
16568 #: ../src/guestfs-actions.pod:5313 ../fish/guestfish-actions.pod:3551
16570 "This command writes to part of a file. It writes the data buffer C<content> "
16571 "to the file C<path> starting at offset C<offset>."
16576 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3554
16578 "This command implements the L<pwrite(2)> system call, and like that system "
16579 "call it may not write the full data requested. The return value is the "
16580 "number of bytes that were actually written to the file. This could even be "
16581 "0, although short writes are unlikely for regular files in ordinary "
16587 #: ../src/guestfs-actions.pod:5322
16588 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16593 #: ../src/guestfs-actions.pod:5331
16594 msgid "guestfs_pwrite_device"
16599 #: ../src/guestfs-actions.pod:5333
16603 " guestfs_pwrite_device (guestfs_h *g,\n"
16604 " const char *device,\n"
16605 " const char *content,\n"
16606 " size_t content_size,\n"
16607 " int64_t offset);\n"
16613 #: ../src/guestfs-actions.pod:5340 ../fish/guestfish-actions.pod:3569
16615 "This command writes to part of a device. It writes the data buffer "
16616 "C<content> to C<device> starting at offset C<offset>."
16621 #: ../src/guestfs-actions.pod:5343 ../fish/guestfish-actions.pod:3572
16623 "This command implements the L<pwrite(2)> system call, and like that system "
16624 "call it may not write the full data requested (although short writes to disk "
16625 "devices and partitions are probably impossible with standard Linux kernels)."
16630 #: ../src/guestfs-actions.pod:5348
16631 msgid "See also C<guestfs_pwrite>."
16636 #: ../src/guestfs-actions.pod:5355
16637 msgid "(Added in 1.5.20)"
16642 #: ../src/guestfs-actions.pod:5357
16643 msgid "guestfs_read_file"
16648 #: ../src/guestfs-actions.pod:5359
16652 " guestfs_read_file (guestfs_h *g,\n"
16653 " const char *path,\n"
16654 " size_t *size_r);\n"
16660 #: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3586
16661 msgid "This calls returns the contents of the file C<path> as a buffer."
16666 #: ../src/guestfs-actions.pod:5367
16668 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16669 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16670 "function is limited in the total size of file that can be handled."
16675 #: ../src/guestfs-actions.pod:5379
16676 msgid "(Added in 1.0.63)"
16681 #: ../src/guestfs-actions.pod:5381
16682 msgid "guestfs_read_lines"
16687 #: ../src/guestfs-actions.pod:5383
16691 " guestfs_read_lines (guestfs_h *g,\n"
16692 " const char *path);\n"
16698 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3603
16700 "The file contents are returned as a list of lines. Trailing C<LF> and "
16701 "C<CRLF> character sequences are I<not> returned."
16706 #: ../src/guestfs-actions.pod:5392
16708 "Note that this function cannot correctly handle binary files (specifically, "
16709 "files containing C<\\0> character which is treated as end of line). For "
16710 "those you need to use the C<guestfs_read_file> function which has a more "
16711 "complex interface."
16716 #: ../src/guestfs-actions.pod:5403
16717 msgid "guestfs_readdir"
16722 #: ../src/guestfs-actions.pod:5405
16725 " struct guestfs_dirent_list *\n"
16726 " guestfs_readdir (guestfs_h *g,\n"
16727 " const char *dir);\n"
16733 #: ../src/guestfs-actions.pod:5409 ../fish/guestfish-actions.pod:3615
16734 msgid "This returns the list of directory entries in directory C<dir>."
16739 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3617
16741 "All entries in the directory are returned, including C<.> and C<..>. The "
16742 "entries are I<not> sorted, but returned in the same order as the underlying "
16748 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3621
16750 "Also this call returns basic file type information about each file. The "
16751 "C<ftyp> field will contain one of the following characters:"
16756 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3626
16762 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3628
16763 msgid "Block special"
16768 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3630
16774 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3632
16775 msgid "Char special"
16780 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3634
16786 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3636
16792 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3638
16798 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3640
16799 msgid "FIFO (named pipe)"
16804 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3642
16810 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3644
16811 msgid "Symbolic link"
16816 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3646
16822 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:3648
16823 msgid "Regular file"
16828 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3650
16834 #: ../src/guestfs-actions.pod:5446 ../fish/guestfish-actions.pod:3652
16840 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3654
16846 #: ../src/guestfs-actions.pod:5450 ../fish/guestfish-actions.pod:3656
16847 msgid "Unknown file type"
16852 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3658
16858 #: ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:3660
16860 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16865 #: ../src/guestfs-actions.pod:5459
16867 "This function is primarily intended for use by programs. To get a simple "
16868 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16869 "consumption, use C<guestfs_ll>."
16874 #: ../src/guestfs-actions.pod:5463
16876 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16877 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16882 #: ../src/guestfs-actions.pod:5469
16883 msgid "guestfs_readlink"
16888 #: ../src/guestfs-actions.pod:5471
16892 " guestfs_readlink (guestfs_h *g,\n"
16893 " const char *path);\n"
16899 #: ../src/guestfs-actions.pod:5475 ../fish/guestfish-actions.pod:3673
16900 msgid "This command reads the target of a symbolic link."
16905 #: ../src/guestfs-actions.pod:5482
16906 msgid "guestfs_readlinklist"
16911 #: ../src/guestfs-actions.pod:5484
16915 " guestfs_readlinklist (guestfs_h *g,\n"
16916 " const char *path,\n"
16917 " char *const *names);\n"
16923 #: ../src/guestfs-actions.pod:5489 ../fish/guestfish-actions.pod:3679
16925 "This call allows you to do a C<readlink> operation on multiple files, where "
16926 "all files are in the directory C<path>. C<names> is the list of files from "
16932 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3683
16934 "On return you get a list of strings, with a one-to-one correspondence to the "
16935 "C<names> list. Each string is the value of the symbolic link."
16940 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3687
16942 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16943 "result string is the empty string C<\"\">. However the whole operation is "
16944 "completed even if there were C<readlink(2)> errors, and so you can call this "
16945 "function with names where you don't know if they are symbolic links already "
16946 "(albeit slightly less efficient)."
16951 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:3694
16953 "This call is intended for programs that want to efficiently list a directory "
16954 "contents without making many round-trips. Very long directory listings "
16955 "might cause the protocol message size to be exceeded, causing this call to "
16956 "fail. The caller must split up such requests into smaller groups of names."
16961 #: ../src/guestfs-actions.pod:5517
16962 msgid "guestfs_realpath"
16967 #: ../src/guestfs-actions.pod:5519
16971 " guestfs_realpath (guestfs_h *g,\n"
16972 " const char *path);\n"
16978 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3705
16980 "Return the canonicalized absolute pathname of C<path>. The returned path "
16981 "has no C<.>, C<..> or symbolic link path elements."
16986 #: ../src/guestfs-actions.pod:5531
16987 msgid "guestfs_removexattr"
16992 #: ../src/guestfs-actions.pod:5533
16996 " guestfs_removexattr (guestfs_h *g,\n"
16997 " const char *xattr,\n"
16998 " const char *path);\n"
17004 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3712
17006 "This call removes the extended attribute named C<xattr> of the file C<path>."
17011 #: ../src/guestfs-actions.pod:5541
17012 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
17017 #: ../src/guestfs-actions.pod:5547
17018 msgid "guestfs_resize2fs"
17023 #: ../src/guestfs-actions.pod:5549
17027 " guestfs_resize2fs (guestfs_h *g,\n"
17028 " const char *device);\n"
17034 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3721
17036 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17037 "underlying device."
17042 #: ../src/guestfs-actions.pod:5556
17044 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17045 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17046 "sometimes gives an error about this and sometimes not. In any case, it is "
17047 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17051 #: ../src/guestfs-actions.pod:5566
17052 msgid "guestfs_resize2fs_M"
17056 #: ../src/guestfs-actions.pod:5568
17060 " guestfs_resize2fs_M (guestfs_h *g,\n"
17061 " const char *device);\n"
17066 #: ../src/guestfs-actions.pod:5572
17068 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17069 "resized to its minimum size. This works like the C<-M> option to the "
17070 "C<resize2fs> command."
17074 #: ../src/guestfs-actions.pod:5576
17076 "To get the resulting size of the filesystem you should call "
17077 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17078 "These two numbers, multiplied together, give the resulting size of the "
17079 "minimal filesystem in bytes."
17084 #: ../src/guestfs-actions.pod:5583
17085 msgid "guestfs_resize2fs_size"
17090 #: ../src/guestfs-actions.pod:5585
17094 " guestfs_resize2fs_size (guestfs_h *g,\n"
17095 " const char *device,\n"
17096 " int64_t size);\n"
17102 #: ../src/guestfs-actions.pod:5590
17104 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17105 "to specify the new size (in bytes) explicitly."
17110 #: ../src/guestfs-actions.pod:5597
17116 #: ../src/guestfs-actions.pod:5599
17120 " guestfs_rm (guestfs_h *g,\n"
17121 " const char *path);\n"
17127 #: ../src/guestfs-actions.pod:5603 ../fish/guestfish-actions.pod:3754
17128 msgid "Remove the single file C<path>."
17133 #: ../src/guestfs-actions.pod:5609
17134 msgid "guestfs_rm_rf"
17139 #: ../src/guestfs-actions.pod:5611
17143 " guestfs_rm_rf (guestfs_h *g,\n"
17144 " const char *path);\n"
17150 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3760
17152 "Remove the file or directory C<path>, recursively removing the contents if "
17153 "its a directory. This is like the C<rm -rf> shell command."
17158 #: ../src/guestfs-actions.pod:5623
17159 msgid "guestfs_rmdir"
17164 #: ../src/guestfs-actions.pod:5625
17168 " guestfs_rmdir (guestfs_h *g,\n"
17169 " const char *path);\n"
17175 #: ../src/guestfs-actions.pod:5629 ../fish/guestfish-actions.pod:3768
17176 msgid "Remove the single directory C<path>."
17181 #: ../src/guestfs-actions.pod:5635
17182 msgid "guestfs_rmmountpoint"
17187 #: ../src/guestfs-actions.pod:5637
17191 " guestfs_rmmountpoint (guestfs_h *g,\n"
17192 " const char *exemptpath);\n"
17198 #: ../src/guestfs-actions.pod:5641
17200 "This calls removes a mountpoint that was previously created with "
17201 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17206 #: ../src/guestfs-actions.pod:5649
17207 msgid "guestfs_scrub_device"
17212 #: ../src/guestfs-actions.pod:5651
17216 " guestfs_scrub_device (guestfs_h *g,\n"
17217 " const char *device);\n"
17223 #: ../src/guestfs-actions.pod:5655 ../fish/guestfish-actions.pod:3782
17225 "This command writes patterns over C<device> to make data retrieval more "
17231 #: ../src/guestfs-actions.pod:5658 ../src/guestfs-actions.pod:5679
17232 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3785
17233 #: ../fish/guestfish-actions.pod:3800 ../fish/guestfish-actions.pod:3813
17235 "It is an interface to the L<scrub(1)> program. See that manual page for "
17241 #: ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5684
17242 #: ../src/guestfs-actions.pod:5703
17243 msgid "(Added in 1.0.52)"
17248 #: ../src/guestfs-actions.pod:5668
17249 msgid "guestfs_scrub_file"
17254 #: ../src/guestfs-actions.pod:5670
17258 " guestfs_scrub_file (guestfs_h *g,\n"
17259 " const char *file);\n"
17265 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3795
17267 "This command writes patterns over a file to make data retrieval more "
17273 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:3798
17274 msgid "The file is I<removed> after scrubbing."
17279 #: ../src/guestfs-actions.pod:5686
17280 msgid "guestfs_scrub_freespace"
17285 #: ../src/guestfs-actions.pod:5688
17289 " guestfs_scrub_freespace (guestfs_h *g,\n"
17290 " const char *dir);\n"
17296 #: ../src/guestfs-actions.pod:5692
17298 "This command creates the directory C<dir> and then fills it with files until "
17299 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17300 "and deletes them. The intention is to scrub any free space on the partition "
17301 "containing C<dir>."
17306 #: ../src/guestfs-actions.pod:5705
17307 msgid "guestfs_set_append"
17312 #: ../src/guestfs-actions.pod:5707
17316 " guestfs_set_append (guestfs_h *g,\n"
17317 " const char *append);\n"
17323 #: ../src/guestfs-actions.pod:5711 ../fish/guestfish-actions.pod:3822
17325 "This function is used to add additional options to the guest kernel command "
17331 #: ../src/guestfs-actions.pod:5714 ../fish/guestfish-actions.pod:3825
17333 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17334 "environment variable."
17339 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:3828
17341 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17342 "(libguestfs always adds a few of its own)."
17346 #: ../src/guestfs-actions.pod:5724
17347 msgid "guestfs_set_attach_method"
17351 #: ../src/guestfs-actions.pod:5726
17355 " guestfs_set_attach_method (guestfs_h *g,\n"
17356 " const char *attachmethod);\n"
17361 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3837
17363 "Set the method that libguestfs uses to connect to the back end guestfsd "
17364 "daemon. Possible methods are:"
17368 #: ../src/guestfs-actions.pod:5737 ../fish/guestfish-actions.pod:3844
17370 "Launch an appliance and connect to it. This is the ordinary method and the "
17375 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3847
17376 msgid "C<unix:I<path>>"
17380 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3849
17381 msgid "Connect to the Unix domain socket I<path>."
17385 #: ../src/guestfs-actions.pod:5744 ../fish/guestfish-actions.pod:3851
17387 "This method lets you connect to an existing daemon or (using virtio-serial) "
17388 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17389 "RUNNING DAEMONS>."
17394 #: ../src/guestfs-actions.pod:5752
17395 msgid "guestfs_set_autosync"
17400 #: ../src/guestfs-actions.pod:5754
17404 " guestfs_set_autosync (guestfs_h *g,\n"
17405 " int autosync);\n"
17410 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:3863
17412 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17413 "effort attempt to make filesystems consistent and synchronized when the "
17414 "handle is closed (also if the program exits without closing handles)."
17419 #: ../src/guestfs-actions.pod:5763 ../fish/guestfish-actions.pod:3868
17421 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17422 "disabled by default)."
17427 #: ../src/guestfs-actions.pod:5770
17428 msgid "guestfs_set_direct"
17433 #: ../src/guestfs-actions.pod:5772
17437 " guestfs_set_direct (guestfs_h *g,\n"
17444 #: ../src/guestfs-actions.pod:5776 ../fish/guestfish-actions.pod:3877
17446 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17447 "passed directly through to the appliance once it is launched."
17452 #: ../src/guestfs-actions.pod:5780
17454 "One consequence of this is that log messages aren't caught by the library "
17455 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17461 #: ../src/guestfs-actions.pod:5784 ../fish/guestfish-actions.pod:3885
17462 msgid "You probably don't want to use this unless you know what you are doing."
17467 #: ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3888
17468 msgid "The default is disabled."
17473 #: ../src/guestfs-actions.pod:5793
17474 msgid "guestfs_set_e2label"
17479 #: ../src/guestfs-actions.pod:5795
17483 " guestfs_set_e2label (guestfs_h *g,\n"
17484 " const char *device,\n"
17485 " const char *label);\n"
17491 #: ../src/guestfs-actions.pod:5800 ../fish/guestfish-actions.pod:3894
17493 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17494 "C<label>. Filesystem labels are limited to 16 characters."
17499 #: ../src/guestfs-actions.pod:5804
17501 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17502 "the existing label on a filesystem."
17507 #: ../src/guestfs-actions.pod:5811
17508 msgid "guestfs_set_e2uuid"
17513 #: ../src/guestfs-actions.pod:5813
17517 " guestfs_set_e2uuid (guestfs_h *g,\n"
17518 " const char *device,\n"
17519 " const char *uuid);\n"
17525 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3905
17527 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17528 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17529 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17534 #: ../src/guestfs-actions.pod:5823
17536 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17537 "the existing UUID of a filesystem."
17542 #: ../src/guestfs-actions.pod:5830
17543 msgid "guestfs_set_memsize"
17548 #: ../src/guestfs-actions.pod:5832
17552 " guestfs_set_memsize (guestfs_h *g,\n"
17559 #: ../src/guestfs-actions.pod:5836
17561 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17562 "This only has any effect if called before C<guestfs_launch>."
17567 #: ../src/guestfs-actions.pod:5840 ../fish/guestfish-actions.pod:3923
17569 "You can also change this by setting the environment variable "
17570 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17575 #: ../src/guestfs-actions.pod:5851
17576 msgid "guestfs_set_network"
17581 #: ../src/guestfs-actions.pod:5853
17585 " guestfs_set_network (guestfs_h *g,\n"
17592 #: ../src/guestfs-actions.pod:5857 ../fish/guestfish-actions.pod:3936
17594 "If C<network> is true, then the network is enabled in the libguestfs "
17595 "appliance. The default is false."
17600 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3939
17602 "This affects whether commands are able to access the network (see L<guestfs"
17603 "(3)/RUNNING COMMANDS>)."
17608 #: ../src/guestfs-actions.pod:5863
17610 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17616 #: ../src/guestfs-actions.pod:5870
17617 msgid "guestfs_set_path"
17622 #: ../src/guestfs-actions.pod:5872
17626 " guestfs_set_path (guestfs_h *g,\n"
17627 " const char *searchpath);\n"
17633 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3951
17634 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17639 #: ../src/guestfs-actions.pod:5878 ../fish/guestfish-actions.pod:3953
17641 "The default is C<$libdir/guestfs> unless overridden by setting "
17642 "C<LIBGUESTFS_PATH> environment variable."
17647 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3956
17648 msgid "Setting C<path> to C<NULL> restores the default path."
17653 #: ../src/guestfs-actions.pod:5887
17654 msgid "guestfs_set_qemu"
17659 #: ../src/guestfs-actions.pod:5889
17663 " guestfs_set_qemu (guestfs_h *g,\n"
17664 " const char *qemu);\n"
17670 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3964
17671 msgid "Set the qemu binary that we will use."
17676 #: ../src/guestfs-actions.pod:5895 ../fish/guestfish-actions.pod:3966
17678 "The default is chosen when the library was compiled by the configure script."
17683 #: ../src/guestfs-actions.pod:5898 ../fish/guestfish-actions.pod:3969
17685 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17691 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3972
17692 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17697 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3974
17699 "Note that you should call this function as early as possible after creating "
17700 "the handle. This is because some pre-launch operations depend on testing "
17701 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17702 "don't retest features, and so you might see inconsistent results. Using the "
17703 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17704 "the qemu binary at the same time as the handle is created."
17709 #: ../src/guestfs-actions.pod:5915
17710 msgid "guestfs_set_recovery_proc"
17715 #: ../src/guestfs-actions.pod:5917
17719 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17720 " int recoveryproc);\n"
17726 #: ../src/guestfs-actions.pod:5921
17728 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17729 "not create a recovery process. The purpose of the recovery process is to "
17730 "stop runaway qemu processes in the case where the main program aborts "
17736 #: ../src/guestfs-actions.pod:5926
17738 "This only has any effect if called before C<guestfs_launch>, and the default "
17744 #: ../src/guestfs-actions.pod:5929 ../fish/guestfish-actions.pod:3996
17746 "About the only time when you would want to disable this is if the main "
17747 "process will fork itself into the background (\"daemonize\" itself). In "
17748 "this case the recovery process thinks that the main program has disappeared "
17749 "and so kills qemu, which is not very helpful."
17754 #: ../src/guestfs-actions.pod:5939
17755 msgid "guestfs_set_selinux"
17760 #: ../src/guestfs-actions.pod:5941
17764 " guestfs_set_selinux (guestfs_h *g,\n"
17771 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:4008
17773 "This sets the selinux flag that is passed to the appliance at boot time. "
17774 "The default is C<selinux=0> (disabled)."
17779 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4011
17781 "Note that if SELinux is enabled, it is always in Permissive mode "
17782 "(C<enforcing=0>)."
17787 #: ../src/guestfs-actions.pod:5958
17788 msgid "guestfs_set_trace"
17793 #: ../src/guestfs-actions.pod:5960
17797 " guestfs_set_trace (guestfs_h *g,\n"
17803 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4023
17805 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17806 "return values are traced."
17811 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:4026
17813 "If you want to trace C API calls into libguestfs (and other libraries) then "
17814 "possibly a better way is to use the external ltrace(1) command."
17819 #: ../src/guestfs-actions.pod:5971 ../fish/guestfish-actions.pod:4030
17821 "Command traces are disabled unless the environment variable "
17822 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17826 #: ../src/guestfs-actions.pod:5974
17828 "Trace messages are normally sent to C<stderr>, unless you register a "
17829 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17834 #: ../src/guestfs-actions.pod:5982
17835 msgid "guestfs_set_verbose"
17840 #: ../src/guestfs-actions.pod:5984
17844 " guestfs_set_verbose (guestfs_h *g,\n"
17850 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:4043
17851 msgid "If C<verbose> is true, this turns on verbose messages."
17856 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4045
17858 "Verbose messages are disabled unless the environment variable "
17859 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17863 #: ../src/guestfs-actions.pod:5993
17865 "Verbose messages are normally sent to C<stderr>, unless you register a "
17866 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17871 #: ../src/guestfs-actions.pod:6001
17872 msgid "guestfs_setcon"
17877 #: ../src/guestfs-actions.pod:6003
17881 " guestfs_setcon (guestfs_h *g,\n"
17882 " const char *context);\n"
17888 #: ../src/guestfs-actions.pod:6007 ../fish/guestfish-actions.pod:4056
17890 "This sets the SELinux security context of the daemon to the string "
17896 #: ../src/guestfs-actions.pod:6010 ../fish/guestfish-actions.pod:4059
17897 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17902 #: ../src/guestfs-actions.pod:6016
17903 msgid "guestfs_setxattr"
17908 #: ../src/guestfs-actions.pod:6018
17912 " guestfs_setxattr (guestfs_h *g,\n"
17913 " const char *xattr,\n"
17914 " const char *val,\n"
17916 " const char *path);\n"
17922 #: ../src/guestfs-actions.pod:6025 ../fish/guestfish-actions.pod:4065
17924 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17925 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17930 #: ../src/guestfs-actions.pod:6029
17931 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17936 #: ../src/guestfs-actions.pod:6035
17937 msgid "guestfs_sfdisk"
17942 #: ../src/guestfs-actions.pod:6037
17946 " guestfs_sfdisk (guestfs_h *g,\n"
17947 " const char *device,\n"
17951 " char *const *lines);\n"
17957 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:4075
17959 "This is a direct interface to the L<sfdisk(8)> program for creating "
17960 "partitions on block devices."
17965 #: ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:4078
17966 msgid "C<device> should be a block device, for example C</dev/sda>."
17971 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4080
17973 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17974 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17975 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17976 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17977 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17978 "the kernel) cannot work out the right geometry and you will need to tell it."
17983 #: ../src/guestfs-actions.pod:6058 ../fish/guestfish-actions.pod:4088
17985 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17986 "refer to the L<sfdisk(8)> manpage."
17991 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4091
17993 "To create a single partition occupying the whole disk, you would pass "
17994 "C<lines> as a single element list, when the single element being the string "
18000 #: ../src/guestfs-actions.pod:6065
18002 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
18007 #: ../src/guestfs-actions.pod:6075
18008 msgid "guestfs_sfdiskM"
18013 #: ../src/guestfs-actions.pod:6077
18017 " guestfs_sfdiskM (guestfs_h *g,\n"
18018 " const char *device,\n"
18019 " char *const *lines);\n"
18025 #: ../src/guestfs-actions.pod:6082
18027 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18028 "partition sizes are specified in megabytes only (rounded to the nearest "
18029 "cylinder) and you don't need to specify the cyls, heads and sectors "
18030 "parameters which were rarely if ever used anyway."
18035 #: ../src/guestfs-actions.pod:6088
18037 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18038 "C<guestfs_part_disk>"
18043 #: ../src/guestfs-actions.pod:6098
18044 msgid "guestfs_sfdisk_N"
18049 #: ../src/guestfs-actions.pod:6100
18053 " guestfs_sfdisk_N (guestfs_h *g,\n"
18054 " const char *device,\n"
18059 " const char *line);\n"
18065 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4121
18067 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18068 "(note: C<n> counts from 1)."
18073 #: ../src/guestfs-actions.pod:6112
18075 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18076 "for the cyls/heads/sectors parameters."
18081 #: ../src/guestfs-actions.pod:6115
18082 msgid "See also: C<guestfs_part_add>"
18087 #: ../src/guestfs-actions.pod:6124
18088 msgid "guestfs_sfdisk_disk_geometry"
18093 #: ../src/guestfs-actions.pod:6126
18097 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18098 " const char *device);\n"
18104 #: ../src/guestfs-actions.pod:6130
18106 "This displays the disk geometry of C<device> read from the partition table. "
18107 "Especially in the case where the underlying block device has been resized, "
18108 "this can be different from the kernel's idea of the geometry (see "
18109 "C<guestfs_sfdisk_kernel_geometry>)."
18114 #: ../src/guestfs-actions.pod:6135 ../src/guestfs-actions.pod:6151
18115 #: ../fish/guestfish-actions.pod:4141 ../fish/guestfish-actions.pod:4150
18116 msgid "The result is in human-readable format, and not designed to be parsed."
18121 #: ../src/guestfs-actions.pod:6143
18122 msgid "guestfs_sfdisk_kernel_geometry"
18127 #: ../src/guestfs-actions.pod:6145
18131 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18132 " const char *device);\n"
18138 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4148
18139 msgid "This displays the kernel's idea of the geometry of C<device>."
18144 #: ../src/guestfs-actions.pod:6159
18145 msgid "guestfs_sfdisk_l"
18150 #: ../src/guestfs-actions.pod:6161
18154 " guestfs_sfdisk_l (guestfs_h *g,\n"
18155 " const char *device);\n"
18161 #: ../src/guestfs-actions.pod:6165 ../fish/guestfish-actions.pod:4157
18163 "This displays the partition table on C<device>, in the human-readable output "
18164 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18169 #: ../src/guestfs-actions.pod:6169
18170 msgid "See also: C<guestfs_part_list>"
18175 #: ../src/guestfs-actions.pod:6176
18181 #: ../src/guestfs-actions.pod:6178
18185 " guestfs_sh (guestfs_h *g,\n"
18186 " const char *command);\n"
18192 #: ../src/guestfs-actions.pod:6182 ../fish/guestfish-actions.pod:4167
18194 "This call runs a command from the guest filesystem via the guest's C</bin/"
18200 #: ../src/guestfs-actions.pod:6185
18201 msgid "This is like C<guestfs_command>, but passes the command to:"
18206 #: ../src/guestfs-actions.pod:6187 ../fish/guestfish-actions.pod:4172
18209 " /bin/sh -c \"command\"\n"
18215 #: ../src/guestfs-actions.pod:6189 ../fish/guestfish-actions.pod:4174
18217 "Depending on the guest's shell, this usually results in wildcards being "
18218 "expanded, shell expressions being interpolated and so on."
18223 #: ../src/guestfs-actions.pod:6193
18224 msgid "All the provisos about C<guestfs_command> apply to this call."
18229 #: ../src/guestfs-actions.pod:6200
18230 msgid "guestfs_sh_lines"
18235 #: ../src/guestfs-actions.pod:6202
18239 " guestfs_sh_lines (guestfs_h *g,\n"
18240 " const char *command);\n"
18246 #: ../src/guestfs-actions.pod:6206
18248 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18254 #: ../src/guestfs-actions.pod:6209
18255 msgid "See also: C<guestfs_command_lines>"
18260 #: ../src/guestfs-actions.pod:6217
18261 msgid "guestfs_sleep"
18266 #: ../src/guestfs-actions.pod:6219
18270 " guestfs_sleep (guestfs_h *g,\n"
18277 #: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4193
18278 msgid "Sleep for C<secs> seconds."
18283 #: ../src/guestfs-actions.pod:6227
18284 msgid "(Added in 1.0.41)"
18289 #: ../src/guestfs-actions.pod:6229 ../src/guestfs-structs.pod:109
18290 msgid "guestfs_stat"
18295 #: ../src/guestfs-actions.pod:6231
18298 " struct guestfs_stat *\n"
18299 " guestfs_stat (guestfs_h *g,\n"
18300 " const char *path);\n"
18306 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4201
18307 msgid "This is the same as the C<stat(2)> system call."
18312 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-structs.pod:135
18313 msgid "guestfs_statvfs"
18318 #: ../src/guestfs-actions.pod:6247
18321 " struct guestfs_statvfs *\n"
18322 " guestfs_statvfs (guestfs_h *g,\n"
18323 " const char *path);\n"
18329 #: ../src/guestfs-actions.pod:6251 ../fish/guestfish-actions.pod:4207
18331 "Returns file system statistics for any mounted file system. C<path> should "
18332 "be a file or directory in the mounted file system (typically it is the mount "
18333 "point itself, but it doesn't need to be)."
18338 #: ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4211
18339 msgid "This is the same as the C<statvfs(2)> system call."
18344 #: ../src/guestfs-actions.pod:6257
18346 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18347 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18352 #: ../src/guestfs-actions.pod:6263
18353 msgid "guestfs_strings"
18358 #: ../src/guestfs-actions.pod:6265
18362 " guestfs_strings (guestfs_h *g,\n"
18363 " const char *path);\n"
18369 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4217
18371 "This runs the L<strings(1)> command on a file and returns the list of "
18372 "printable strings found."
18377 #: ../src/guestfs-actions.pod:6281
18378 msgid "guestfs_strings_e"
18383 #: ../src/guestfs-actions.pod:6283
18387 " guestfs_strings_e (guestfs_h *g,\n"
18388 " const char *encoding,\n"
18389 " const char *path);\n"
18395 #: ../src/guestfs-actions.pod:6288
18397 "This is like the C<guestfs_strings> command, but allows you to specify the "
18398 "encoding of strings that are looked for in the source file C<path>."
18403 #: ../src/guestfs-actions.pod:6292 ../fish/guestfish-actions.pod:4231
18404 msgid "Allowed encodings are:"
18409 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4235
18415 #: ../src/guestfs-actions.pod:6298
18417 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18418 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18423 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4240
18429 #: ../src/guestfs-actions.pod:6303 ../fish/guestfish-actions.pod:4242
18430 msgid "Single 8-bit-byte characters."
18435 #: ../src/guestfs-actions.pod:6305 ../fish/guestfish-actions.pod:4244
18441 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4246
18442 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18447 #: ../src/guestfs-actions.pod:6310 ../fish/guestfish-actions.pod:4249
18448 msgid "l (lower case letter L)"
18453 #: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4251
18455 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18456 "examining binaries in Windows guests."
18461 #: ../src/guestfs-actions.pod:6315 ../fish/guestfish-actions.pod:4254
18467 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4256
18468 msgid "32-bit big endian such as UCS-4BE."
18473 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4258
18479 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4260
18480 msgid "32-bit little endian such as UCS-4LE."
18485 #: ../src/guestfs-actions.pod:6325 ../fish/guestfish-actions.pod:4264
18486 msgid "The returned strings are transcoded to UTF-8."
18491 #: ../src/guestfs-actions.pod:6336
18492 msgid "guestfs_swapoff_device"
18497 #: ../src/guestfs-actions.pod:6338
18501 " guestfs_swapoff_device (guestfs_h *g,\n"
18502 " const char *device);\n"
18508 #: ../src/guestfs-actions.pod:6342
18510 "This command disables the libguestfs appliance swap device or partition "
18511 "named C<device>. See C<guestfs_swapon_device>."
18516 #: ../src/guestfs-actions.pod:6350
18517 msgid "guestfs_swapoff_file"
18522 #: ../src/guestfs-actions.pod:6352
18526 " guestfs_swapoff_file (guestfs_h *g,\n"
18527 " const char *file);\n"
18533 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4281
18534 msgid "This command disables the libguestfs appliance swap on file."
18539 #: ../src/guestfs-actions.pod:6362
18540 msgid "guestfs_swapoff_label"
18545 #: ../src/guestfs-actions.pod:6364
18549 " guestfs_swapoff_label (guestfs_h *g,\n"
18550 " const char *label);\n"
18556 #: ../src/guestfs-actions.pod:6368 ../fish/guestfish-actions.pod:4287
18558 "This command disables the libguestfs appliance swap on labeled swap "
18564 #: ../src/guestfs-actions.pod:6375
18565 msgid "guestfs_swapoff_uuid"
18570 #: ../src/guestfs-actions.pod:6377
18574 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18575 " const char *uuid);\n"
18581 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4294
18583 "This command disables the libguestfs appliance swap partition with the given "
18589 #: ../src/guestfs-actions.pod:6388
18590 msgid "guestfs_swapon_device"
18595 #: ../src/guestfs-actions.pod:6390
18599 " guestfs_swapon_device (guestfs_h *g,\n"
18600 " const char *device);\n"
18606 #: ../src/guestfs-actions.pod:6394
18608 "This command enables the libguestfs appliance to use the swap device or "
18609 "partition named C<device>. The increased memory is made available for all "
18610 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18615 #: ../src/guestfs-actions.pod:6399 ../fish/guestfish-actions.pod:4306
18617 "Note that you should not swap to existing guest swap partitions unless you "
18618 "know what you are doing. They may contain hibernation information, or other "
18619 "information that the guest doesn't want you to trash. You also risk leaking "
18620 "information about the host to the guest this way. Instead, attach a new "
18621 "host device to the guest and swap on that."
18626 #: ../src/guestfs-actions.pod:6410
18627 msgid "guestfs_swapon_file"
18632 #: ../src/guestfs-actions.pod:6412
18636 " guestfs_swapon_file (guestfs_h *g,\n"
18637 " const char *file);\n"
18643 #: ../src/guestfs-actions.pod:6416
18645 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18651 #: ../src/guestfs-actions.pod:6423
18652 msgid "guestfs_swapon_label"
18657 #: ../src/guestfs-actions.pod:6425
18661 " guestfs_swapon_label (guestfs_h *g,\n"
18662 " const char *label);\n"
18668 #: ../src/guestfs-actions.pod:6429
18670 "This command enables swap to a labeled swap partition. See "
18671 "C<guestfs_swapon_device> for other notes."
18676 #: ../src/guestfs-actions.pod:6436
18677 msgid "guestfs_swapon_uuid"
18682 #: ../src/guestfs-actions.pod:6438
18686 " guestfs_swapon_uuid (guestfs_h *g,\n"
18687 " const char *uuid);\n"
18693 #: ../src/guestfs-actions.pod:6442
18695 "This command enables swap to a swap partition with the given UUID. See "
18696 "C<guestfs_swapon_device> for other notes."
18701 #: ../src/guestfs-actions.pod:6449
18702 msgid "guestfs_sync"
18707 #: ../src/guestfs-actions.pod:6451
18711 " guestfs_sync (guestfs_h *g);\n"
18717 #: ../src/guestfs-actions.pod:6454 ../fish/guestfish-actions.pod:4338
18719 "This syncs the disk, so that any writes are flushed through to the "
18720 "underlying disk image."
18725 #: ../src/guestfs-actions.pod:6457 ../fish/guestfish-actions.pod:4341
18727 "You should always call this if you have modified a disk image, before "
18728 "closing the handle."
18733 #: ../src/guestfs-actions.pod:6464
18734 msgid "guestfs_tail"
18739 #: ../src/guestfs-actions.pod:6466
18743 " guestfs_tail (guestfs_h *g,\n"
18744 " const char *path);\n"
18750 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4348
18752 "This command returns up to the last 10 lines of a file as a list of strings."
18757 #: ../src/guestfs-actions.pod:6482
18758 msgid "guestfs_tail_n"
18763 #: ../src/guestfs-actions.pod:6484
18767 " guestfs_tail_n (guestfs_h *g,\n"
18769 " const char *path);\n"
18775 #: ../src/guestfs-actions.pod:6489 ../fish/guestfish-actions.pod:4358
18777 "If the parameter C<nrlines> is a positive number, this returns the last "
18778 "C<nrlines> lines of the file C<path>."
18783 #: ../src/guestfs-actions.pod:6492 ../fish/guestfish-actions.pod:4361
18785 "If the parameter C<nrlines> is a negative number, this returns lines from "
18786 "the file C<path>, starting with the C<-nrlines>th line."
18791 #: ../src/guestfs-actions.pod:6506
18792 msgid "guestfs_tar_in"
18797 #: ../src/guestfs-actions.pod:6508
18801 " guestfs_tar_in (guestfs_h *g,\n"
18802 " const char *tarfile,\n"
18803 " const char *directory);\n"
18809 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4373
18811 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18812 "tar file) into C<directory>."
18817 #: ../src/guestfs-actions.pod:6516
18819 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18824 #: ../src/guestfs-actions.pod:6521 ../src/guestfs-actions.pod:6538
18825 #: ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6570
18826 msgid "(Added in 1.0.3)"
18831 #: ../src/guestfs-actions.pod:6523
18832 msgid "guestfs_tar_out"
18837 #: ../src/guestfs-actions.pod:6525
18841 " guestfs_tar_out (guestfs_h *g,\n"
18842 " const char *directory,\n"
18843 " const char *tarfile);\n"
18849 #: ../src/guestfs-actions.pod:6530 ../fish/guestfish-actions.pod:4385
18851 "This command packs the contents of C<directory> and downloads it to local "
18857 #: ../src/guestfs-actions.pod:6533
18859 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18860 "C<guestfs_txz_out>."
18865 #: ../src/guestfs-actions.pod:6540
18866 msgid "guestfs_tgz_in"
18871 #: ../src/guestfs-actions.pod:6542
18875 " guestfs_tgz_in (guestfs_h *g,\n"
18876 " const char *tarball,\n"
18877 " const char *directory);\n"
18883 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4397
18885 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18886 "tar file) into C<directory>."
18891 #: ../src/guestfs-actions.pod:6550
18892 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18897 #: ../src/guestfs-actions.pod:6556
18898 msgid "guestfs_tgz_out"
18903 #: ../src/guestfs-actions.pod:6558
18907 " guestfs_tgz_out (guestfs_h *g,\n"
18908 " const char *directory,\n"
18909 " const char *tarball);\n"
18915 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4408
18917 "This command packs the contents of C<directory> and downloads it to local "
18923 #: ../src/guestfs-actions.pod:6566
18924 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18929 #: ../src/guestfs-actions.pod:6572
18930 msgid "guestfs_touch"
18935 #: ../src/guestfs-actions.pod:6574
18939 " guestfs_touch (guestfs_h *g,\n"
18940 " const char *path);\n"
18946 #: ../src/guestfs-actions.pod:6578 ../fish/guestfish-actions.pod:4419
18948 "Touch acts like the L<touch(1)> command. It can be used to update the "
18949 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18955 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4423
18957 "This command only works on regular files, and will fail on other file types "
18958 "such as directories, symbolic links, block special etc."
18963 #: ../src/guestfs-actions.pod:6589
18964 msgid "guestfs_truncate"
18969 #: ../src/guestfs-actions.pod:6591
18973 " guestfs_truncate (guestfs_h *g,\n"
18974 " const char *path);\n"
18980 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4430
18982 "This command truncates C<path> to a zero-length file. The file must exist "
18988 #: ../src/guestfs-actions.pod:6602
18989 msgid "guestfs_truncate_size"
18994 #: ../src/guestfs-actions.pod:6604
18998 " guestfs_truncate_size (guestfs_h *g,\n"
18999 " const char *path,\n"
19000 " int64_t size);\n"
19006 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4437
19008 "This command truncates C<path> to size C<size> bytes. The file must exist "
19014 #: ../src/guestfs-actions.pod:6612
19016 "If the current file size is less than C<size> then the file is extended to "
19017 "the required size with zero bytes. This creates a sparse file (ie. disk "
19018 "blocks are not allocated for the file until you write to it). To create a "
19019 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19024 #: ../src/guestfs-actions.pod:6622
19025 msgid "guestfs_tune2fs_l"
19030 #: ../src/guestfs-actions.pod:6624
19034 " guestfs_tune2fs_l (guestfs_h *g,\n"
19035 " const char *device);\n"
19041 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4450
19043 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19049 #: ../src/guestfs-actions.pod:6631 ../fish/guestfish-actions.pod:4453
19051 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19052 "for more details. The list of fields returned isn't clearly defined, and "
19053 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19054 "and the filesystem itself."
19059 #: ../src/guestfs-actions.pod:6644
19060 msgid "guestfs_txz_in"
19065 #: ../src/guestfs-actions.pod:6646
19069 " guestfs_txz_in (guestfs_h *g,\n"
19070 " const char *tarball,\n"
19071 " const char *directory);\n"
19077 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4462
19079 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19080 "tar file) into C<directory>."
19085 #: ../src/guestfs-actions.pod:6658
19086 msgid "guestfs_txz_out"
19091 #: ../src/guestfs-actions.pod:6660
19095 " guestfs_txz_out (guestfs_h *g,\n"
19096 " const char *directory,\n"
19097 " const char *tarball);\n"
19103 #: ../src/guestfs-actions.pod:6665 ../fish/guestfish-actions.pod:4471
19105 "This command packs the contents of C<directory> and downloads it to local "
19106 "file C<tarball> (as an xz compressed tar archive)."
19111 #: ../src/guestfs-actions.pod:6672
19112 msgid "guestfs_umask"
19117 #: ../src/guestfs-actions.pod:6674
19121 " guestfs_umask (guestfs_h *g,\n"
19128 #: ../src/guestfs-actions.pod:6678 ../fish/guestfish-actions.pod:4480
19130 "This function sets the mask used for creating new files and device nodes to "
19136 #: ../src/guestfs-actions.pod:6681 ../fish/guestfish-actions.pod:4483
19138 "Typical umask values would be C<022> which creates new files with "
19139 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19140 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19145 #: ../src/guestfs-actions.pod:6686 ../fish/guestfish-actions.pod:4488
19147 "The default umask is C<022>. This is important because it means that "
19148 "directories and device nodes will be created with C<0644> or C<0755> mode "
19149 "even if you specify C<0777>."
19154 #: ../src/guestfs-actions.pod:6690
19156 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19157 "C<guestfs_mkdir>."
19162 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4495
19163 msgid "This call returns the previous umask."
19168 #: ../src/guestfs-actions.pod:6699
19169 msgid "guestfs_umount"
19174 #: ../src/guestfs-actions.pod:6701
19178 " guestfs_umount (guestfs_h *g,\n"
19179 " const char *pathordevice);\n"
19185 #: ../src/guestfs-actions.pod:6705 ../fish/guestfish-actions.pod:4503
19187 "This unmounts the given filesystem. The filesystem may be specified either "
19188 "by its mountpoint (path) or the device which contains the filesystem."
19193 #: ../src/guestfs-actions.pod:6713
19194 msgid "guestfs_umount_all"
19199 #: ../src/guestfs-actions.pod:6715
19203 " guestfs_umount_all (guestfs_h *g);\n"
19209 #: ../src/guestfs-actions.pod:6718 ../fish/guestfish-actions.pod:4513
19210 msgid "This unmounts all mounted filesystems."
19215 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4515
19216 msgid "Some internal mounts are not unmounted by this call."
19221 #: ../src/guestfs-actions.pod:6726
19222 msgid "guestfs_upload"
19227 #: ../src/guestfs-actions.pod:6728
19231 " guestfs_upload (guestfs_h *g,\n"
19232 " const char *filename,\n"
19233 " const char *remotefilename);\n"
19239 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6757
19240 #: ../fish/guestfish-actions.pod:4521 ../fish/guestfish-actions.pod:4534
19241 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19246 #: ../src/guestfs-actions.pod:6738
19247 msgid "See also C<guestfs_download>."
19252 #: ../src/guestfs-actions.pod:6749
19253 msgid "guestfs_upload_offset"
19258 #: ../src/guestfs-actions.pod:6751
19262 " guestfs_upload_offset (guestfs_h *g,\n"
19263 " const char *filename,\n"
19264 " const char *remotefilename,\n"
19265 " int64_t offset);\n"
19271 #: ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:4537
19273 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19274 "The intention is to overwrite parts of existing files or devices, although "
19275 "if a non-existant file is specified then it is created with a \"hole\" "
19276 "before C<offset>. The size of the data written is implicit in the size of "
19277 "the source C<filename>."
19282 #: ../src/guestfs-actions.pod:6767
19284 "Note that there is no limit on the amount of data that can be uploaded with "
19285 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19286 "full amount unless an error occurs."
19291 #: ../src/guestfs-actions.pod:6772
19292 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19297 #: ../src/guestfs-actions.pod:6783
19298 msgid "guestfs_utimens"
19303 #: ../src/guestfs-actions.pod:6785
19307 " guestfs_utimens (guestfs_h *g,\n"
19308 " const char *path,\n"
19309 " int64_t atsecs,\n"
19310 " int64_t atnsecs,\n"
19311 " int64_t mtsecs,\n"
19312 " int64_t mtnsecs);\n"
19318 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4557
19319 msgid "This command sets the timestamps of a file with nanosecond precision."
19324 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4560
19326 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19332 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4563
19334 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19335 "nanoseconds from the epoch."
19340 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4566
19342 "If the C<*nsecs> field contains the special value C<-1> then the "
19343 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19344 "ignored in this case)."
19349 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4570
19351 "If the C<*nsecs> field contains the special value C<-2> then the "
19352 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19358 #: ../src/guestfs-actions.pod:6814 ../src/guestfs-structs.pod:175
19359 msgid "guestfs_version"
19364 #: ../src/guestfs-actions.pod:6816
19367 " struct guestfs_version *\n"
19368 " guestfs_version (guestfs_h *g);\n"
19374 #: ../src/guestfs-actions.pod:6819 ../fish/guestfish-actions.pod:4578
19376 "Return the libguestfs version number that the program is linked against."
19381 #: ../src/guestfs-actions.pod:6822 ../fish/guestfish-actions.pod:4581
19383 "Note that because of dynamic linking this is not necessarily the version of "
19384 "libguestfs that you compiled against. You can compile the program, and then "
19385 "at runtime dynamically link against a completely different C<libguestfs.so> "
19391 #: ../src/guestfs-actions.pod:6827 ../fish/guestfish-actions.pod:4586
19393 "This call was added in version C<1.0.58>. In previous versions of "
19394 "libguestfs there was no way to get the version number. From C code you can "
19395 "use dynamic linker functions to find out if this symbol exists (if it "
19396 "doesn't, then it's an earlier version)."
19401 #: ../src/guestfs-actions.pod:6833 ../fish/guestfish-actions.pod:4592
19403 "The call returns a structure with four elements. The first three (C<major>, "
19404 "C<minor> and C<release>) are numbers and correspond to the usual version "
19405 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19406 "but may be used for distro-specific information."
19411 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4598
19413 "To construct the original version string: C<$major.$minor.$release$extra>"
19418 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4601
19419 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19424 #: ../src/guestfs-actions.pod:6844
19426 "I<Note:> Don't use this call to test for availability of features. In "
19427 "enterprise distributions we backport features from later versions into "
19428 "earlier versions, making this an unreliable way to test for features. Use "
19429 "C<guestfs_available> instead."
19434 #: ../src/guestfs-actions.pod:6850
19436 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19437 "error. I<The caller must call C<guestfs_free_version> after use>."
19442 #: ../src/guestfs-actions.pod:6854
19443 msgid "(Added in 1.0.58)"
19448 #: ../src/guestfs-actions.pod:6856
19449 msgid "guestfs_vfs_label"
19454 #: ../src/guestfs-actions.pod:6858
19458 " guestfs_vfs_label (guestfs_h *g,\n"
19459 " const char *device);\n"
19465 #: ../src/guestfs-actions.pod:6862 ../fish/guestfish-actions.pod:4613
19466 msgid "This returns the filesystem label of the filesystem on C<device>."
19471 #: ../src/guestfs-actions.pod:6865 ../fish/guestfish-actions.pod:4616
19472 msgid "If the filesystem is unlabeled, this returns the empty string."
19477 #: ../src/guestfs-actions.pod:6867
19478 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19483 #: ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6909
19484 msgid "(Added in 1.3.18)"
19489 #: ../src/guestfs-actions.pod:6874
19490 msgid "guestfs_vfs_type"
19495 #: ../src/guestfs-actions.pod:6876
19499 " guestfs_vfs_type (guestfs_h *g,\n"
19500 " const char *device);\n"
19506 #: ../src/guestfs-actions.pod:6880 ../fish/guestfish-actions.pod:4624
19508 "This command gets the filesystem type corresponding to the filesystem on "
19514 #: ../src/guestfs-actions.pod:6883 ../fish/guestfish-actions.pod:4627
19516 "For most filesystems, the result is the name of the Linux VFS module which "
19517 "would be used to mount this filesystem if you mounted it without specifying "
19518 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19523 #: ../src/guestfs-actions.pod:6893
19524 msgid "guestfs_vfs_uuid"
19529 #: ../src/guestfs-actions.pod:6895
19533 " guestfs_vfs_uuid (guestfs_h *g,\n"
19534 " const char *device);\n"
19540 #: ../src/guestfs-actions.pod:6899 ../fish/guestfish-actions.pod:4636
19541 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19546 #: ../src/guestfs-actions.pod:6902 ../fish/guestfish-actions.pod:4639
19547 msgid "If the filesystem does not have a UUID, this returns the empty string."
19552 #: ../src/guestfs-actions.pod:6904
19553 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19558 #: ../src/guestfs-actions.pod:6911
19559 msgid "guestfs_vg_activate"
19564 #: ../src/guestfs-actions.pod:6913
19568 " guestfs_vg_activate (guestfs_h *g,\n"
19570 " char *const *volgroups);\n"
19576 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4647
19578 "This command activates or (if C<activate> is false) deactivates all logical "
19579 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19580 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19581 "deactivated, then those devices disappear."
19586 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4653
19587 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19592 #: ../src/guestfs-actions.pod:6926 ../fish/guestfish-actions.pod:4655
19594 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19595 "activated or deactivated."
19600 #: ../src/guestfs-actions.pod:6933
19601 msgid "guestfs_vg_activate_all"
19606 #: ../src/guestfs-actions.pod:6935
19610 " guestfs_vg_activate_all (guestfs_h *g,\n"
19611 " int activate);\n"
19617 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4662
19619 "This command activates or (if C<activate> is false) deactivates all logical "
19620 "volumes in all volume groups. If activated, then they are made known to the "
19621 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19622 "those devices disappear."
19627 #: ../src/guestfs-actions.pod:6945 ../fish/guestfish-actions.pod:4668
19628 msgid "This command is the same as running C<vgchange -a y|n>"
19633 #: ../src/guestfs-actions.pod:6951
19634 msgid "guestfs_vgcreate"
19639 #: ../src/guestfs-actions.pod:6953
19643 " guestfs_vgcreate (guestfs_h *g,\n"
19644 " const char *volgroup,\n"
19645 " char *const *physvols);\n"
19651 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4674
19653 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19654 "of physical volumes C<physvols>."
19659 #: ../src/guestfs-actions.pod:6965
19660 msgid "guestfs_vglvuuids"
19665 #: ../src/guestfs-actions.pod:6967
19669 " guestfs_vglvuuids (guestfs_h *g,\n"
19670 " const char *vgname);\n"
19676 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4681
19678 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19679 "volumes created in this volume group."
19684 #: ../src/guestfs-actions.pod:6974
19686 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19687 "associate logical volumes and volume groups."
19692 #: ../src/guestfs-actions.pod:6977
19693 msgid "See also C<guestfs_vgpvuuids>."
19698 #: ../src/guestfs-actions.pod:6985
19699 msgid "guestfs_vgpvuuids"
19704 #: ../src/guestfs-actions.pod:6987
19708 " guestfs_vgpvuuids (guestfs_h *g,\n"
19709 " const char *vgname);\n"
19715 #: ../src/guestfs-actions.pod:6991 ../fish/guestfish-actions.pod:4693
19717 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19718 "volumes that this volume group resides on."
19723 #: ../src/guestfs-actions.pod:6994
19725 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
19726 "associate physical volumes and volume groups."
19731 #: ../src/guestfs-actions.pod:6997
19732 msgid "See also C<guestfs_vglvuuids>."
19737 #: ../src/guestfs-actions.pod:7005
19738 msgid "guestfs_vgremove"
19743 #: ../src/guestfs-actions.pod:7007
19747 " guestfs_vgremove (guestfs_h *g,\n"
19748 " const char *vgname);\n"
19754 #: ../src/guestfs-actions.pod:7011 ../fish/guestfish-actions.pod:4705
19755 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19760 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4707
19762 "This also forcibly removes all logical volumes in the volume group (if any)."
19767 #: ../src/guestfs-actions.pod:7020
19768 msgid "guestfs_vgrename"
19773 #: ../src/guestfs-actions.pod:7022
19777 " guestfs_vgrename (guestfs_h *g,\n"
19778 " const char *volgroup,\n"
19779 " const char *newvolgroup);\n"
19785 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4714
19786 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19791 #: ../src/guestfs-actions.pod:7033
19792 msgid "guestfs_vgs"
19797 #: ../src/guestfs-actions.pod:7035
19801 " guestfs_vgs (guestfs_h *g);\n"
19807 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4720
19809 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19815 #: ../src/guestfs-actions.pod:7041 ../fish/guestfish-actions.pod:4723
19817 "This returns a list of just the volume group names that were detected (eg. "
19823 #: ../src/guestfs-actions.pod:7044
19824 msgid "See also C<guestfs_vgs_full>."
19829 #: ../src/guestfs-actions.pod:7052
19830 msgid "guestfs_vgs_full"
19835 #: ../src/guestfs-actions.pod:7054
19838 " struct guestfs_lvm_vg_list *\n"
19839 " guestfs_vgs_full (guestfs_h *g);\n"
19845 #: ../src/guestfs-actions.pod:7057 ../fish/guestfish-actions.pod:4732
19847 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19848 "> command. The \"full\" version includes all fields."
19853 #: ../src/guestfs-actions.pod:7060
19855 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
19856 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
19861 #: ../src/guestfs-actions.pod:7066
19862 msgid "guestfs_vgscan"
19867 #: ../src/guestfs-actions.pod:7068
19871 " guestfs_vgscan (guestfs_h *g);\n"
19877 #: ../src/guestfs-actions.pod:7071 ../fish/guestfish-actions.pod:4739
19879 "This rescans all block devices and rebuilds the list of LVM physical "
19880 "volumes, volume groups and logical volumes."
19885 #: ../src/guestfs-actions.pod:7078
19886 msgid "guestfs_vguuid"
19891 #: ../src/guestfs-actions.pod:7080
19895 " guestfs_vguuid (guestfs_h *g,\n"
19896 " const char *vgname);\n"
19902 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4746
19903 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19908 #: ../src/guestfs-actions.pod:7091
19909 msgid "guestfs_wait_ready"
19914 #: ../src/guestfs-actions.pod:7093
19918 " guestfs_wait_ready (guestfs_h *g);\n"
19924 #: ../src/guestfs-actions.pod:7096
19925 msgid "This function is a no op."
19930 #: ../src/guestfs-actions.pod:7098
19932 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19933 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19934 "is no longer necessary because C<guestfs_launch> now does the waiting."
19939 #: ../src/guestfs-actions.pod:7103
19941 "If you see any calls to this function in code then you can just remove them, "
19942 "unless you want to retain compatibility with older versions of the API."
19947 #: ../src/guestfs-actions.pod:7111
19948 msgid "guestfs_wc_c"
19953 #: ../src/guestfs-actions.pod:7113
19957 " guestfs_wc_c (guestfs_h *g,\n"
19958 " const char *path);\n"
19964 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4752
19966 "This command counts the characters in a file, using the C<wc -c> external "
19972 #: ../src/guestfs-actions.pod:7124
19973 msgid "guestfs_wc_l"
19978 #: ../src/guestfs-actions.pod:7126
19982 " guestfs_wc_l (guestfs_h *g,\n"
19983 " const char *path);\n"
19989 #: ../src/guestfs-actions.pod:7130 ../fish/guestfish-actions.pod:4759
19991 "This command counts the lines in a file, using the C<wc -l> external command."
19996 #: ../src/guestfs-actions.pod:7137
19997 msgid "guestfs_wc_w"
20002 #: ../src/guestfs-actions.pod:7139
20006 " guestfs_wc_w (guestfs_h *g,\n"
20007 " const char *path);\n"
20013 #: ../src/guestfs-actions.pod:7143 ../fish/guestfish-actions.pod:4766
20015 "This command counts the words in a file, using the C<wc -w> external command."
20020 #: ../src/guestfs-actions.pod:7150
20021 msgid "guestfs_write"
20026 #: ../src/guestfs-actions.pod:7152
20030 " guestfs_write (guestfs_h *g,\n"
20031 " const char *path,\n"
20032 " const char *content,\n"
20033 " size_t content_size);\n"
20039 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4773
20041 "This call creates a file called C<path>. The content of the file is the "
20042 "string C<content> (which can contain any 8 bit data)."
20047 #: ../src/guestfs-actions.pod:7168
20048 msgid "guestfs_write_file"
20053 #: ../src/guestfs-actions.pod:7170
20057 " guestfs_write_file (guestfs_h *g,\n"
20058 " const char *path,\n"
20059 " const char *content,\n"
20066 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4783
20068 "This call creates a file called C<path>. The contents of the file is the "
20069 "string C<content> (which can contain any 8 bit data), with length C<size>."
20074 #: ../src/guestfs-actions.pod:7180 ../fish/guestfish-actions.pod:4787
20076 "As a special case, if C<size> is C<0> then the length is calculated using "
20077 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20082 #: ../src/guestfs-actions.pod:7184 ../fish/guestfish-actions.pod:4791
20084 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20085 "I<not> work, even if the length is specified."
20090 #: ../src/guestfs-actions.pod:7192 ../fish/guestfish-actions.pod:4797
20092 "This function is deprecated. In new code, use the C<write> call instead."
20097 #: ../src/guestfs-actions.pod:7201
20098 msgid "guestfs_zegrep"
20103 #: ../src/guestfs-actions.pod:7203
20107 " guestfs_zegrep (guestfs_h *g,\n"
20108 " const char *regex,\n"
20109 " const char *path);\n"
20115 #: ../src/guestfs-actions.pod:7208 ../fish/guestfish-actions.pod:4808
20117 "This calls the external C<zegrep> program and returns the matching lines."
20122 #: ../src/guestfs-actions.pod:7220
20123 msgid "guestfs_zegrepi"
20128 #: ../src/guestfs-actions.pod:7222
20132 " guestfs_zegrepi (guestfs_h *g,\n"
20133 " const char *regex,\n"
20134 " const char *path);\n"
20140 #: ../src/guestfs-actions.pod:7227 ../fish/guestfish-actions.pod:4818
20142 "This calls the external C<zegrep -i> program and returns the matching lines."
20147 #: ../src/guestfs-actions.pod:7239
20148 msgid "guestfs_zero"
20153 #: ../src/guestfs-actions.pod:7241
20157 " guestfs_zero (guestfs_h *g,\n"
20158 " const char *device);\n"
20164 #: ../src/guestfs-actions.pod:7245 ../fish/guestfish-actions.pod:4828
20165 msgid "This command writes zeroes over the first few blocks of C<device>."
20170 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4830
20172 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20173 "securely wipe the device). It should be sufficient to remove any partition "
20174 "tables, filesystem superblocks and so on."
20179 #: ../src/guestfs-actions.pod:7251
20180 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20185 #: ../src/guestfs-actions.pod:7262
20186 msgid "guestfs_zero_device"
20191 #: ../src/guestfs-actions.pod:7264
20195 " guestfs_zero_device (guestfs_h *g,\n"
20196 " const char *device);\n"
20202 #: ../src/guestfs-actions.pod:7268
20204 "This command writes zeroes over the entire C<device>. Compare with "
20205 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20210 #: ../src/guestfs-actions.pod:7282
20211 msgid "(Added in 1.3.1)"
20216 #: ../src/guestfs-actions.pod:7284
20217 msgid "guestfs_zerofree"
20222 #: ../src/guestfs-actions.pod:7286
20226 " guestfs_zerofree (guestfs_h *g,\n"
20227 " const char *device);\n"
20233 #: ../src/guestfs-actions.pod:7290 ../fish/guestfish-actions.pod:4851
20235 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20236 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20237 "possible to compress the filesystem more effectively."
20242 #: ../src/guestfs-actions.pod:7295 ../fish/guestfish-actions.pod:4856
20243 msgid "You should B<not> run this program if the filesystem is mounted."
20248 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4859
20250 "It is possible that using this program can damage the filesystem or data on "
20256 #: ../src/guestfs-actions.pod:7305
20257 msgid "guestfs_zfgrep"
20262 #: ../src/guestfs-actions.pod:7307
20266 " guestfs_zfgrep (guestfs_h *g,\n"
20267 " const char *pattern,\n"
20268 " const char *path);\n"
20274 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4866
20276 "This calls the external C<zfgrep> program and returns the matching lines."
20281 #: ../src/guestfs-actions.pod:7324
20282 msgid "guestfs_zfgrepi"
20287 #: ../src/guestfs-actions.pod:7326
20291 " guestfs_zfgrepi (guestfs_h *g,\n"
20292 " const char *pattern,\n"
20293 " const char *path);\n"
20299 #: ../src/guestfs-actions.pod:7331 ../fish/guestfish-actions.pod:4876
20301 "This calls the external C<zfgrep -i> program and returns the matching lines."
20306 #: ../src/guestfs-actions.pod:7343
20307 msgid "guestfs_zfile"
20312 #: ../src/guestfs-actions.pod:7345
20316 " guestfs_zfile (guestfs_h *g,\n"
20317 " const char *meth,\n"
20318 " const char *path);\n"
20324 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:4886
20326 "This command runs C<file> after first decompressing C<path> using C<method>."
20331 #: ../src/guestfs-actions.pod:7353 ../fish/guestfish-actions.pod:4889
20332 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20337 #: ../src/guestfs-actions.pod:7355
20339 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20345 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4894
20347 "This function is deprecated. In new code, use the C<file> call instead."
20352 #: ../src/guestfs-actions.pod:7370
20353 msgid "guestfs_zgrep"
20358 #: ../src/guestfs-actions.pod:7372
20362 " guestfs_zgrep (guestfs_h *g,\n"
20363 " const char *regex,\n"
20364 " const char *path);\n"
20370 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4905
20372 "This calls the external C<zgrep> program and returns the matching lines."
20377 #: ../src/guestfs-actions.pod:7389
20378 msgid "guestfs_zgrepi"
20383 #: ../src/guestfs-actions.pod:7391
20387 " guestfs_zgrepi (guestfs_h *g,\n"
20388 " const char *regex,\n"
20389 " const char *path);\n"
20395 #: ../src/guestfs-actions.pod:7396 ../fish/guestfish-actions.pod:4915
20397 "This calls the external C<zgrep -i> program and returns the matching lines."
20402 #: ../src/guestfs-availability.pod:3
20408 #: ../src/guestfs-availability.pod:5
20410 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20411 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20412 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20413 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20414 "L</guestfs_aug_save> L</guestfs_aug_set>"
20419 #: ../src/guestfs-availability.pod:21
20425 #: ../src/guestfs-availability.pod:23
20427 "The following functions: L</guestfs_inotify_add_watch> L</"
20428 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20429 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20434 #: ../src/guestfs-availability.pod:31
20435 msgid "B<linuxfsuuid>"
20440 #: ../src/guestfs-availability.pod:33
20442 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20443 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20448 #: ../src/guestfs-availability.pod:40
20449 msgid "B<linuxmodules>"
20454 #: ../src/guestfs-availability.pod:42
20455 msgid "The following functions: L</guestfs_modprobe>"
20460 #: ../src/guestfs-availability.pod:45
20461 msgid "B<linuxxattrs>"
20466 #: ../src/guestfs-availability.pod:47
20468 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20469 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20470 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20471 "guestfs_setxattr>"
20476 #: ../src/guestfs-availability.pod:58
20482 #: ../src/guestfs-availability.pod:60
20484 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20485 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20486 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20491 #: ../src/guestfs-availability.pod:69
20497 #: ../src/guestfs-availability.pod:71
20499 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20500 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20501 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20502 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20503 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20504 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20505 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20510 #: ../src/guestfs-availability.pod:94
20516 #: ../src/guestfs-availability.pod:96
20518 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20519 "guestfs_mknod_b> L</guestfs_mknod_c>"
20524 #: ../src/guestfs-availability.pod:102
20530 #: ../src/guestfs-availability.pod:104
20531 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20536 #: ../src/guestfs-availability.pod:107
20537 msgid "B<ntfsprogs>"
20542 #: ../src/guestfs-availability.pod:109
20544 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20549 #: ../src/guestfs-availability.pod:113
20550 msgid "B<realpath>"
20555 #: ../src/guestfs-availability.pod:115
20556 msgid "The following functions: L</guestfs_realpath>"
20561 #: ../src/guestfs-availability.pod:118
20567 #: ../src/guestfs-availability.pod:120
20569 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20570 "guestfs_scrub_freespace>"
20575 #: ../src/guestfs-availability.pod:125
20581 #: ../src/guestfs-availability.pod:127
20582 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20587 #: ../src/guestfs-availability.pod:131
20593 #: ../src/guestfs-availability.pod:133
20594 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20599 #: ../src/guestfs-availability.pod:137
20600 msgid "B<zerofree>"
20605 #: ../src/guestfs-availability.pod:139
20606 msgid "The following functions: L</guestfs_zerofree>"
20611 #: ../src/guestfs-structs.pod:1
20612 msgid "guestfs_int_bool"
20617 #: ../src/guestfs-structs.pod:3
20620 " struct guestfs_int_bool {\n"
20629 #: ../src/guestfs-structs.pod:8
20632 " struct guestfs_int_bool_list {\n"
20633 " uint32_t len; /* Number of elements in list. */\n"
20634 " struct guestfs_int_bool *val; /* Elements. */\n"
20641 #: ../src/guestfs-structs.pod:13
20644 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20645 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20651 #: ../src/guestfs-structs.pod:16
20652 msgid "guestfs_lvm_pv"
20657 #: ../src/guestfs-structs.pod:18
20660 " struct guestfs_lvm_pv {\n"
20661 " char *pv_name;\n"
20662 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20663 " char pv_uuid[32];\n"
20665 " uint64_t pv_size;\n"
20666 " uint64_t dev_size;\n"
20667 " uint64_t pv_free;\n"
20668 " uint64_t pv_used;\n"
20669 " char *pv_attr;\n"
20670 " int64_t pv_pe_count;\n"
20671 " int64_t pv_pe_alloc_count;\n"
20672 " char *pv_tags;\n"
20673 " uint64_t pe_start;\n"
20674 " int64_t pv_mda_count;\n"
20675 " uint64_t pv_mda_free;\n"
20682 #: ../src/guestfs-structs.pod:36
20685 " struct guestfs_lvm_pv_list {\n"
20686 " uint32_t len; /* Number of elements in list. */\n"
20687 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20694 #: ../src/guestfs-structs.pod:41
20697 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20698 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20704 #: ../src/guestfs-structs.pod:44
20705 msgid "guestfs_lvm_vg"
20710 #: ../src/guestfs-structs.pod:46
20713 " struct guestfs_lvm_vg {\n"
20714 " char *vg_name;\n"
20715 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20716 " char vg_uuid[32];\n"
20718 " char *vg_attr;\n"
20719 " uint64_t vg_size;\n"
20720 " uint64_t vg_free;\n"
20721 " char *vg_sysid;\n"
20722 " uint64_t vg_extent_size;\n"
20723 " int64_t vg_extent_count;\n"
20724 " int64_t vg_free_count;\n"
20725 " int64_t max_lv;\n"
20726 " int64_t max_pv;\n"
20727 " int64_t pv_count;\n"
20728 " int64_t lv_count;\n"
20729 " int64_t snap_count;\n"
20730 " int64_t vg_seqno;\n"
20731 " char *vg_tags;\n"
20732 " int64_t vg_mda_count;\n"
20733 " uint64_t vg_mda_free;\n"
20740 #: ../src/guestfs-structs.pod:69
20743 " struct guestfs_lvm_vg_list {\n"
20744 " uint32_t len; /* Number of elements in list. */\n"
20745 " struct guestfs_lvm_vg *val; /* Elements. */\n"
20752 #: ../src/guestfs-structs.pod:74
20755 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
20756 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
20762 #: ../src/guestfs-structs.pod:77
20763 msgid "guestfs_lvm_lv"
20768 #: ../src/guestfs-structs.pod:79
20771 " struct guestfs_lvm_lv {\n"
20772 " char *lv_name;\n"
20773 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20774 " char lv_uuid[32];\n"
20775 " char *lv_attr;\n"
20776 " int64_t lv_major;\n"
20777 " int64_t lv_minor;\n"
20778 " int64_t lv_kernel_major;\n"
20779 " int64_t lv_kernel_minor;\n"
20780 " uint64_t lv_size;\n"
20781 " int64_t seg_count;\n"
20783 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20784 " float snap_percent;\n"
20785 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20786 " float copy_percent;\n"
20787 " char *move_pv;\n"
20788 " char *lv_tags;\n"
20789 " char *mirror_log;\n"
20790 " char *modules;\n"
20797 #: ../src/guestfs-structs.pod:101
20800 " struct guestfs_lvm_lv_list {\n"
20801 " uint32_t len; /* Number of elements in list. */\n"
20802 " struct guestfs_lvm_lv *val; /* Elements. */\n"
20809 #: ../src/guestfs-structs.pod:106
20812 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
20813 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
20819 #: ../src/guestfs-structs.pod:111
20822 " struct guestfs_stat {\n"
20826 " int64_t nlink;\n"
20831 " int64_t blksize;\n"
20832 " int64_t blocks;\n"
20833 " int64_t atime;\n"
20834 " int64_t mtime;\n"
20835 " int64_t ctime;\n"
20842 #: ../src/guestfs-structs.pod:127
20845 " struct guestfs_stat_list {\n"
20846 " uint32_t len; /* Number of elements in list. */\n"
20847 " struct guestfs_stat *val; /* Elements. */\n"
20854 #: ../src/guestfs-structs.pod:132
20857 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
20858 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
20864 #: ../src/guestfs-structs.pod:137
20867 " struct guestfs_statvfs {\n"
20868 " int64_t bsize;\n"
20869 " int64_t frsize;\n"
20870 " int64_t blocks;\n"
20871 " int64_t bfree;\n"
20872 " int64_t bavail;\n"
20873 " int64_t files;\n"
20874 " int64_t ffree;\n"
20875 " int64_t favail;\n"
20878 " int64_t namemax;\n"
20885 #: ../src/guestfs-structs.pod:151
20888 " struct guestfs_statvfs_list {\n"
20889 " uint32_t len; /* Number of elements in list. */\n"
20890 " struct guestfs_statvfs *val; /* Elements. */\n"
20897 #: ../src/guestfs-structs.pod:156
20900 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
20901 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20907 #: ../src/guestfs-structs.pod:159
20908 msgid "guestfs_dirent"
20913 #: ../src/guestfs-structs.pod:161
20916 " struct guestfs_dirent {\n"
20926 #: ../src/guestfs-structs.pod:167
20929 " struct guestfs_dirent_list {\n"
20930 " uint32_t len; /* Number of elements in list. */\n"
20931 " struct guestfs_dirent *val; /* Elements. */\n"
20938 #: ../src/guestfs-structs.pod:172
20941 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20942 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20948 #: ../src/guestfs-structs.pod:177
20951 " struct guestfs_version {\n"
20952 " int64_t major;\n"
20953 " int64_t minor;\n"
20954 " int64_t release;\n"
20962 #: ../src/guestfs-structs.pod:184
20965 " struct guestfs_version_list {\n"
20966 " uint32_t len; /* Number of elements in list. */\n"
20967 " struct guestfs_version *val; /* Elements. */\n"
20974 #: ../src/guestfs-structs.pod:189
20977 " void guestfs_free_version (struct guestfs_free_version *);\n"
20978 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20984 #: ../src/guestfs-structs.pod:192
20985 msgid "guestfs_xattr"
20990 #: ../src/guestfs-structs.pod:194
20993 " struct guestfs_xattr {\n"
20994 " char *attrname;\n"
20995 " /* The next two fields describe a byte array. */\n"
20996 " uint32_t attrval_len;\n"
20997 " char *attrval;\n"
21004 #: ../src/guestfs-structs.pod:201
21007 " struct guestfs_xattr_list {\n"
21008 " uint32_t len; /* Number of elements in list. */\n"
21009 " struct guestfs_xattr *val; /* Elements. */\n"
21016 #: ../src/guestfs-structs.pod:206
21019 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
21020 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21026 #: ../src/guestfs-structs.pod:209
21027 msgid "guestfs_inotify_event"
21032 #: ../src/guestfs-structs.pod:211
21035 " struct guestfs_inotify_event {\n"
21036 " int64_t in_wd;\n"
21037 " uint32_t in_mask;\n"
21038 " uint32_t in_cookie;\n"
21039 " char *in_name;\n"
21046 #: ../src/guestfs-structs.pod:218
21049 " struct guestfs_inotify_event_list {\n"
21050 " uint32_t len; /* Number of elements in list. */\n"
21051 " struct guestfs_inotify_event *val; /* Elements. */\n"
21058 #: ../src/guestfs-structs.pod:223
21061 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21062 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21068 #: ../src/guestfs-structs.pod:226
21069 msgid "guestfs_partition"
21074 #: ../src/guestfs-structs.pod:228
21077 " struct guestfs_partition {\n"
21078 " int32_t part_num;\n"
21079 " uint64_t part_start;\n"
21080 " uint64_t part_end;\n"
21081 " uint64_t part_size;\n"
21088 #: ../src/guestfs-structs.pod:235
21091 " struct guestfs_partition_list {\n"
21092 " uint32_t len; /* Number of elements in list. */\n"
21093 " struct guestfs_partition *val; /* Elements. */\n"
21100 #: ../src/guestfs-structs.pod:240
21103 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21104 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21110 #: ../src/guestfs-structs.pod:243
21111 msgid "guestfs_application"
21116 #: ../src/guestfs-structs.pod:245
21119 " struct guestfs_application {\n"
21120 " char *app_name;\n"
21121 " char *app_display_name;\n"
21122 " int32_t app_epoch;\n"
21123 " char *app_version;\n"
21124 " char *app_release;\n"
21125 " char *app_install_path;\n"
21126 " char *app_trans_path;\n"
21127 " char *app_publisher;\n"
21128 " char *app_url;\n"
21129 " char *app_source_package;\n"
21130 " char *app_summary;\n"
21131 " char *app_description;\n"
21138 #: ../src/guestfs-structs.pod:260
21141 " struct guestfs_application_list {\n"
21142 " uint32_t len; /* Number of elements in list. */\n"
21143 " struct guestfs_application *val; /* Elements. */\n"
21150 #: ../src/guestfs-structs.pod:265
21153 " void guestfs_free_application (struct guestfs_free_application *);\n"
21154 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21160 #: ../fish/guestfish.pod:5
21161 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21166 #: ../fish/guestfish.pod:9
21169 " guestfish [--options] [commands]\n"
21175 #: ../fish/guestfish.pod:11
21184 #: ../fish/guestfish.pod:13
21187 " guestfish [--ro|--rw] -a disk.img\n"
21193 #: ../fish/guestfish.pod:15
21196 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21202 #: ../fish/guestfish.pod:17
21205 " guestfish -d libvirt-domain\n"
21211 #: ../fish/guestfish.pod:19
21214 " guestfish [--ro|--rw] -a disk.img -i\n"
21220 #: ../fish/guestfish.pod:21
21223 " guestfish -d libvirt-domain -i\n"
21229 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21230 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21236 #: ../fish/guestfish.pod:25
21238 "Using guestfish in read/write mode on live virtual machines can be "
21239 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21240 "option to use guestfish safely if the disk image or virtual machine might be "
21246 #: ../fish/guestfish.pod:32
21248 "Guestfish is a shell and command-line tool for examining and modifying "
21249 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21250 "functionality of the guestfs API, see L<guestfs(3)>."
21255 #: ../fish/guestfish.pod:36
21257 "Guestfish gives you structured access to the libguestfs API, from shell "
21258 "scripts or the command line or interactively. If you want to rescue a "
21259 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21265 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942
21266 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
21267 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
21273 #: ../fish/guestfish.pod:43
21274 msgid "As an interactive shell"
21279 #: ../fish/guestfish.pod:45
21288 #: ../fish/guestfish.pod:47
21291 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21292 " editing virtual machine filesystems.\n"
21298 #: ../fish/guestfish.pod:50
21301 " Type: 'help' for a list of commands\n"
21302 " 'man' to read the manual\n"
21303 " 'quit' to quit the shell\n"
21309 #: ../fish/guestfish.pod:54
21312 " ><fs> add-ro disk.img\n"
21314 " ><fs> list-filesystems\n"
21315 " /dev/sda1: ext4\n"
21316 " /dev/vg_guest/lv_root: ext4\n"
21317 " /dev/vg_guest/lv_swap: swap\n"
21318 " ><fs> mount /dev/vg_guest/lv_root /\n"
21319 " ><fs> cat /etc/fstab\n"
21321 " # Created by anaconda\n"
21329 #: ../fish/guestfish.pod:67
21330 msgid "From shell scripts"
21335 #: ../fish/guestfish.pod:69
21336 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21341 #: ../fish/guestfish.pod:71
21344 " guestfish <<_EOF_\n"
21347 " mount /dev/vg_guest/lv_root /\n"
21348 " write /etc/motd \"Welcome, new users\"\n"
21355 #: ../fish/guestfish.pod:78
21356 msgid "List the LVM logical volumes in a disk image:"
21361 #: ../fish/guestfish.pod:80
21364 " guestfish -a disk.img --ro <<_EOF_\n"
21373 #: ../fish/guestfish.pod:85
21374 msgid "List all the filesystems in a disk image:"
21379 #: ../fish/guestfish.pod:87
21382 " guestfish -a disk.img --ro <<_EOF_\n"
21384 " list-filesystems\n"
21391 #: ../fish/guestfish.pod:92
21392 msgid "On one command line"
21397 #: ../fish/guestfish.pod:94
21398 msgid "Update C</etc/resolv.conf> in a guest:"
21403 #: ../fish/guestfish.pod:96
21407 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21408 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21414 #: ../fish/guestfish.pod:100
21415 msgid "Edit C</boot/grub/grub.conf> interactively:"
21420 #: ../fish/guestfish.pod:102
21423 " guestfish --rw --add disk.img \\\n"
21424 " --mount /dev/vg_guest/lv_root \\\n"
21425 " --mount /dev/sda1:/boot \\\n"
21426 " edit /boot/grub/grub.conf\n"
21432 #: ../fish/guestfish.pod:107
21433 msgid "Mount disks automatically"
21438 #: ../fish/guestfish.pod:109
21440 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21445 #: ../fish/guestfish.pod:112
21448 " guestfish --ro -a disk.img -i cat /etc/group\n"
21454 #: ../fish/guestfish.pod:114
21457 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21463 #: ../fish/guestfish.pod:116
21464 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21469 #: ../fish/guestfish.pod:118
21472 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21478 #: ../fish/guestfish.pod:120
21479 msgid "As a script interpreter"
21484 #: ../fish/guestfish.pod:122
21485 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21490 #: ../fish/guestfish.pod:124
21493 " #!/usr/bin/guestfish -f\n"
21494 " sparse test1.img 100M\n"
21496 " part-disk /dev/sda mbr\n"
21497 " mkfs ext2 /dev/sda1\n"
21503 #: ../fish/guestfish.pod:130
21504 msgid "Start with a prepared disk"
21509 #: ../fish/guestfish.pod:132
21511 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21512 "single ext2-formatted partition:"
21517 #: ../fish/guestfish.pod:135
21520 " guestfish -N fs\n"
21526 #: ../fish/guestfish.pod:137
21527 msgid "To list what is available do:"
21532 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
21535 " guestfish -N help | less\n"
21541 #: ../fish/guestfish.pod:141
21542 msgid "Remote control"
21547 #: ../fish/guestfish.pod:143
21550 " eval \"`guestfish --listen`\"\n"
21551 " guestfish --remote add-ro disk.img\n"
21552 " guestfish --remote run\n"
21553 " guestfish --remote lvs\n"
21559 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21560 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
21561 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
21562 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
21563 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
21569 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21570 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104
21571 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
21572 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
21573 #: ../tools/virt-list-partitions.pl:62
21579 #: ../fish/guestfish.pod:154
21580 msgid "Displays general help on options."
21585 #: ../fish/guestfish.pod:156
21591 #: ../fish/guestfish.pod:158
21592 msgid "B<--cmd-help>"
21597 #: ../fish/guestfish.pod:160
21598 msgid "Lists all available guestfish commands."
21603 #: ../fish/guestfish.pod:162
21609 #: ../fish/guestfish.pod:164
21610 msgid "B<--cmd-help cmd>"
21615 #: ../fish/guestfish.pod:166
21616 msgid "Displays detailed help on a single command C<cmd>."
21621 #: ../fish/guestfish.pod:168
21622 msgid "B<-a image>"
21627 #: ../fish/guestfish.pod:170
21628 msgid "B<--add image>"
21633 #: ../fish/guestfish.pod:172
21634 msgid "Add a block device or virtual machine image to the shell."
21639 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21641 "The format of the disk image is auto-detected. To override this and force a "
21642 "particular format use the I<--format=..> option."
21647 #: ../fish/guestfish.pod:177
21649 "Using this flag is mostly equivalent to using the C<add> command, with "
21650 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21651 "the I<--format:...> flag was given."
21656 #: ../fish/guestfish.pod:181
21662 #: ../fish/guestfish.pod:183
21663 msgid "B<--connect URI>"
21668 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21670 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21671 "URI to use. The default is to use the default libvirt connection."
21676 #: ../fish/guestfish.pod:189
21682 #: ../fish/guestfish.pod:191
21684 "If using the I<--listen> option and a csh-like shell, use this option. See "
21685 "section L</REMOTE CONTROL AND CSH> below."
21690 #: ../fish/guestfish.pod:194
21691 msgid "B<-d libvirt-domain>"
21696 #: ../fish/guestfish.pod:196
21697 msgid "B<--domain libvirt-domain>"
21702 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21704 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21705 "used, then any libvirt domain can be used. However in write mode, only "
21706 "libvirt domains which are shut down can be named here."
21711 #: ../fish/guestfish.pod:202
21713 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21714 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21715 "if the I<--format:...> flag was given."
21720 #: ../fish/guestfish.pod:206
21726 #: ../fish/guestfish.pod:208
21727 msgid "B<--no-dest-paths>"
21732 #: ../fish/guestfish.pod:210
21734 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21735 "to hit the tab key to complete paths on the guest filesystem, but this "
21736 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21737 "allow this feature to be disabled."
21742 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
21743 msgid "B<--echo-keys>"
21748 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
21750 "When prompting for keys and passphrases, guestfish normally turns echoing "
21751 "off so you cannot see what you are typing. If you are not worried about "
21752 "Tempest attacks and there is no one else in the room you can specify this "
21753 "flag to see what you are typing."
21758 #: ../fish/guestfish.pod:222
21764 #: ../fish/guestfish.pod:224
21765 msgid "B<--file file>"
21770 #: ../fish/guestfish.pod:226
21771 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21776 #: ../fish/guestfish.pod:229
21779 " #!/usr/bin/guestfish -f\n"
21785 #: ../fish/guestfish.pod:231
21786 msgid "B<--format=raw|qcow2|..>"
21791 #: ../fish/guestfish.pod:233
21792 msgid "B<--format>"
21797 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
21799 "The default for the I<-a> option is to auto-detect the format of the disk "
21800 "image. Using this forces the disk format for I<-a> options which follow on "
21801 "the command line. Using I<--format> with no argument switches back to auto-"
21802 "detection for subsequent I<-a> options."
21807 #: ../fish/guestfish.pod:242
21810 " guestfish --format=raw -a disk.img\n"
21816 #: ../fish/guestfish.pod:244
21817 msgid "forces raw format (no auto-detection) for C<disk.img>."
21822 #: ../fish/guestfish.pod:246
21825 " guestfish --format=raw -a disk.img --format -a another.img\n"
21831 #: ../fish/guestfish.pod:248
21833 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
21834 "detection for C<another.img>."
21839 #: ../fish/guestfish.pod:251
21841 "If you have untrusted raw-format guest disk images, you should use this "
21842 "option to specify the disk format. This avoids a possible security problem "
21843 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21848 #: ../fish/guestfish.pod:256
21854 #: ../fish/guestfish.pod:258
21855 msgid "B<--inspector>"
21860 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
21862 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21863 "system and mount filesystems as they would be mounted on the real virtual "
21869 #: ../fish/guestfish.pod:264
21870 msgid "Typical usage is either:"
21875 #: ../fish/guestfish.pod:266
21878 " guestfish -d myguest -i\n"
21884 #: ../fish/guestfish.pod:268
21885 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21890 #: ../fish/guestfish.pod:270
21893 " guestfish --ro -d myguest -i\n"
21899 #: ../fish/guestfish.pod:272
21900 msgid "(for active domains, readonly), or specify the block device directly:"
21905 #: ../fish/guestfish.pod:274
21908 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21914 #: ../fish/guestfish.pod:276
21916 "Note that the command line syntax changed slightly over older versions of "
21917 "guestfish. You can still use the old syntax:"
21922 #: ../fish/guestfish.pod:279
21925 " guestfish [--ro] -i disk.img\n"
21931 #: ../fish/guestfish.pod:281
21934 " guestfish [--ro] -i libvirt-domain\n"
21940 #: ../fish/guestfish.pod:283
21942 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21943 "then using other commands to mount the filesystems that were found."
21948 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21949 msgid "B<--keys-from-stdin>"
21954 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21956 "Read key or passphrase parameters from stdin. The default is to try to read "
21957 "passphrases from the user by opening C</dev/tty>."
21962 #: ../fish/guestfish.pod:292
21963 msgid "B<--listen>"
21968 #: ../fish/guestfish.pod:294
21970 "Fork into the background and listen for remote commands. See section L</"
21971 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21975 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
21980 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
21982 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
21983 "ATTACHING TO RUNNING DAEMONS>)."
21987 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
21988 msgid "B<-m dev[:mountpoint[:options]]>"
21992 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
21993 msgid "B<--mount dev[:mountpoint[:options]]>"
21998 #: ../fish/guestfish.pod:306
21999 msgid "Mount the named partition or logical volume on the given mountpoint."
22004 #: ../fish/guestfish.pod:308
22005 msgid "If the mountpoint is omitted, it defaults to C</>."
22010 #: ../fish/guestfish.pod:310
22011 msgid "You have to mount something on C</> before most commands will work."
22016 #: ../fish/guestfish.pod:312
22018 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22024 #: ../fish/guestfish.pod:315
22026 "If you don't know what filesystems a disk image contains, you can either run "
22027 "guestfish without this option, then list the partitions, filesystems and LVs "
22028 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22029 "commands), or you can use the L<virt-filesystems(1)> program."
22033 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
22035 "The third (and rarely used) part of the mount parameter is the list of mount "
22036 "options used to mount the underlying filesystem. If this is not given, then "
22037 "the mount options are either the empty string or C<ro> (the latter if the "
22038 "I<--ro> flag is used). By specifying the mount options, you override this "
22039 "default choice. Probably the only time you would use this is to enable ACLs "
22040 "and/or extended attributes if the filesystem can support them:"
22044 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
22047 " -m /dev/sda1:/:acl,user_xattr\n"
22052 #: ../fish/guestfish.pod:331
22053 msgid "Using this flag is equivalent to using the C<mount-options> command."
22058 #: ../fish/guestfish.pod:333
22064 #: ../fish/guestfish.pod:335
22065 msgid "B<--no-sync>"
22070 #: ../fish/guestfish.pod:337
22072 "Disable autosync. This is enabled by default. See the discussion of "
22073 "autosync in the L<guestfs(3)> manpage."
22078 #: ../fish/guestfish.pod:340
22084 #: ../fish/guestfish.pod:342
22085 msgid "B<--new type>"
22090 #: ../fish/guestfish.pod:344
22096 #: ../fish/guestfish.pod:346
22098 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22099 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22100 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22106 #: ../fish/guestfish.pod:351
22107 msgid "B<--progress-bars>"
22112 #: ../fish/guestfish.pod:353
22113 msgid "Enable progress bars, even when guestfish is used non-interactively."
22118 #: ../fish/guestfish.pod:355
22120 "Progress bars are enabled by default when guestfish is used as an "
22121 "interactive shell."
22126 #: ../fish/guestfish.pod:358
22127 msgid "B<--no-progress-bars>"
22132 #: ../fish/guestfish.pod:360
22133 msgid "Disable progress bars."
22138 #: ../fish/guestfish.pod:362
22139 msgid "B<--remote[=pid]>"
22144 #: ../fish/guestfish.pod:364
22146 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22147 "CONTROL GUESTFISH OVER A SOCKET> below."
22152 #: ../fish/guestfish.pod:367
22158 #: ../fish/guestfish.pod:369
22164 #: ../fish/guestfish.pod:371
22166 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22167 "mounts are done read-only."
22172 #: ../fish/guestfish.pod:374
22174 "The option must always be used if the disk image or virtual machine might be "
22175 "running, and is generally recommended in cases where you don't need write "
22176 "access to the disk."
22181 #: ../fish/guestfish.pod:378
22183 "Note that prepared disk images created with I<-N> are not affected by this "
22184 "option. Also commands like C<add> are not affected - you have to specify "
22185 "the C<readonly:true> option explicitly if you need it."
22190 #: ../fish/guestfish.pod:382
22191 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22196 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
22197 msgid "B<--selinux>"
22202 #: ../fish/guestfish.pod:386
22203 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22208 #: ../fish/guestfish.pod:388
22214 #: ../fish/guestfish.pod:390
22215 msgid "B<--verbose>"
22220 #: ../fish/guestfish.pod:392
22222 "Enable very verbose messages. This is particularly useful if you find a bug."
22227 #: ../fish/guestfish.pod:395
22233 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:88
22234 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
22235 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22236 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22237 msgid "B<--version>"
22242 #: ../fish/guestfish.pod:399
22243 msgid "Display the guestfish / libguestfs version number and exit."
22248 #: ../fish/guestfish.pod:401
22254 #: ../fish/guestfish.pod:403
22259 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
22261 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22262 "mounts are done read-write."
22266 #: ../fish/guestfish.pod:408
22267 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22272 #: ../fish/guestfish.pod:410
22278 #: ../fish/guestfish.pod:412
22279 msgid "Echo each command before executing it."
22284 #: ../fish/guestfish.pod:416
22285 msgid "COMMANDS ON COMMAND LINE"
22290 #: ../fish/guestfish.pod:418
22292 "Any additional (non-option) arguments are treated as commands to execute."
22297 #: ../fish/guestfish.pod:421
22299 "Commands to execute should be separated by a colon (C<:>), where the colon "
22300 "is a separate parameter. Thus:"
22305 #: ../fish/guestfish.pod:424
22308 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22314 #: ../fish/guestfish.pod:426
22316 "If there are no additional arguments, then we enter a shell, either an "
22317 "interactive shell with a prompt (if the input is a terminal) or a non-"
22318 "interactive shell."
22323 #: ../fish/guestfish.pod:430
22325 "In either command line mode or non-interactive shell, the first command that "
22326 "gives an error causes the whole shell to exit. In interactive mode (with a "
22327 "prompt) if a command fails, you can continue to enter commands."
22332 #: ../fish/guestfish.pod:435
22333 msgid "USING launch (OR run)"
22338 #: ../fish/guestfish.pod:437
22340 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22341 "then launch it, then mount any disks you need, and finally issue actions/"
22342 "commands. So the general order of the day is:"
22347 #: ../fish/guestfish.pod:445
22348 msgid "add or -a/--add"
22353 #: ../fish/guestfish.pod:449
22354 msgid "launch (aka run)"
22359 #: ../fish/guestfish.pod:453
22360 msgid "mount or -m/--mount"
22365 #: ../fish/guestfish.pod:457
22366 msgid "any other commands"
22371 #: ../fish/guestfish.pod:461
22373 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22374 "guest before mounting or performing any other commands."
22379 #: ../fish/guestfish.pod:464
22381 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22382 "I<--new> options were given then C<run> is done automatically, simply "
22383 "because guestfish can't perform the action you asked for without doing this."
22388 #: ../fish/guestfish.pod:469
22389 msgid "OPENING DISKS FOR READ AND WRITE"
22393 #: ../fish/guestfish.pod:471
22395 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22396 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22397 "I<-i> and I<-m> open disk images read-only or for writing."
22401 #: ../fish/guestfish.pod:476
22403 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
22404 "opening disk images supplied on the command line for write. To open a disk "
22405 "image read-only you have to do I<-a image --ro>."
22410 #: ../fish/guestfish.pod:480
22412 "This matters: If you accidentally open a live VM disk image writable then "
22413 "you will cause irreversible disk corruption."
22417 #: ../fish/guestfish.pod:483
22419 "By libguestfs 1.10 we intend to change the default the other way. Disk "
22420 "images will be opened read-only. You will have to either specify "
22421 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22422 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22423 "access for disk images specified by those other command line options."
22427 #: ../fish/guestfish.pod:490
22429 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22430 "which does nothing (it is already the default). However it is highly "
22431 "recommended that you use this option to indicate that you need write access, "
22432 "and prepare your scripts for the day when this option will be required for "
22438 #: ../fish/guestfish.pod:496
22440 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22441 "other libguestfs program apart from guestfish and guestmount."
22446 #: ../fish/guestfish.pod:499
22452 #: ../fish/guestfish.pod:501
22454 "You can quote ordinary parameters using either single or double quotes. For "
22460 #: ../fish/guestfish.pod:504
22463 " add \"file with a space.img\"\n"
22469 #: ../fish/guestfish.pod:506
22472 " rm '/file name'\n"
22478 #: ../fish/guestfish.pod:508
22487 #: ../fish/guestfish.pod:510
22489 "A few commands require a list of strings to be passed. For these, use a "
22490 "whitespace-separated list, enclosed in quotes. Strings containing "
22491 "whitespace to be passed through must be enclosed in single quotes. A "
22492 "literal single quote must be escaped with a backslash."
22497 #: ../fish/guestfish.pod:515
22500 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22501 " command \"/bin/echo 'foo bar'\"\n"
22502 " command \"/bin/echo \\'foo\\'\"\n"
22508 #: ../fish/guestfish.pod:519
22509 msgid "OPTIONAL ARGUMENTS"
22514 #: ../fish/guestfish.pod:521
22516 "Some commands take optional arguments. These arguments appear in this "
22517 "documentation as C<[argname:..]>. You can use them as in these examples:"
22522 #: ../fish/guestfish.pod:525
22525 " add-drive-opts filename\n"
22531 #: ../fish/guestfish.pod:527
22534 " add-drive-opts filename readonly:true\n"
22540 #: ../fish/guestfish.pod:529
22543 " add-drive-opts filename format:qcow2 readonly:false\n"
22549 #: ../fish/guestfish.pod:531
22551 "Each optional argument can appear at most once. All optional arguments must "
22552 "appear after the required ones."
22557 #: ../fish/guestfish.pod:534
22563 #: ../fish/guestfish.pod:536
22565 "This section applies to all commands which can take integers as parameters."
22570 #: ../fish/guestfish.pod:539
22571 msgid "SIZE SUFFIX"
22576 #: ../fish/guestfish.pod:541
22578 "When the command takes a parameter measured in bytes, you can use one of the "
22579 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22584 #: ../fish/guestfish.pod:547
22585 msgid "B<k> or B<K> or B<KiB>"
22590 #: ../fish/guestfish.pod:549
22591 msgid "The size in kilobytes (multiplied by 1024)."
22596 #: ../fish/guestfish.pod:551
22602 #: ../fish/guestfish.pod:553
22603 msgid "The size in SI 1000 byte units."
22608 #: ../fish/guestfish.pod:555
22609 msgid "B<M> or B<MiB>"
22614 #: ../fish/guestfish.pod:557
22615 msgid "The size in megabytes (multiplied by 1048576)."
22620 #: ../fish/guestfish.pod:559
22626 #: ../fish/guestfish.pod:561
22627 msgid "The size in SI 1000000 byte units."
22632 #: ../fish/guestfish.pod:563
22633 msgid "B<G> or B<GiB>"
22638 #: ../fish/guestfish.pod:565
22639 msgid "The size in gigabytes (multiplied by 2**30)."
22644 #: ../fish/guestfish.pod:567
22650 #: ../fish/guestfish.pod:569
22651 msgid "The size in SI 10**9 byte units."
22656 #: ../fish/guestfish.pod:571
22657 msgid "B<T> or B<TiB>"
22662 #: ../fish/guestfish.pod:573
22663 msgid "The size in terabytes (multiplied by 2**40)."
22668 #: ../fish/guestfish.pod:575
22674 #: ../fish/guestfish.pod:577
22675 msgid "The size in SI 10**12 byte units."
22680 #: ../fish/guestfish.pod:579
22681 msgid "B<P> or B<PiB>"
22686 #: ../fish/guestfish.pod:581
22687 msgid "The size in petabytes (multiplied by 2**50)."
22692 #: ../fish/guestfish.pod:583
22698 #: ../fish/guestfish.pod:585
22699 msgid "The size in SI 10**15 byte units."
22704 #: ../fish/guestfish.pod:587
22705 msgid "B<E> or B<EiB>"
22710 #: ../fish/guestfish.pod:589
22711 msgid "The size in exabytes (multiplied by 2**60)."
22716 #: ../fish/guestfish.pod:591
22722 #: ../fish/guestfish.pod:593
22723 msgid "The size in SI 10**18 byte units."
22728 #: ../fish/guestfish.pod:595
22729 msgid "B<Z> or B<ZiB>"
22734 #: ../fish/guestfish.pod:597
22735 msgid "The size in zettabytes (multiplied by 2**70)."
22740 #: ../fish/guestfish.pod:599
22746 #: ../fish/guestfish.pod:601
22747 msgid "The size in SI 10**21 byte units."
22752 #: ../fish/guestfish.pod:603
22753 msgid "B<Y> or B<YiB>"
22758 #: ../fish/guestfish.pod:605
22759 msgid "The size in yottabytes (multiplied by 2**80)."
22764 #: ../fish/guestfish.pod:607
22770 #: ../fish/guestfish.pod:609
22771 msgid "The size in SI 10**24 byte units."
22776 #: ../fish/guestfish.pod:615
22779 " truncate-size /file 1G\n"
22785 #: ../fish/guestfish.pod:617
22786 msgid "would truncate the file to 1 gigabyte."
22791 #: ../fish/guestfish.pod:619
22793 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22794 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22795 "suffix will probably not do what you expect."
22800 #: ../fish/guestfish.pod:623
22801 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22806 #: ../fish/guestfish.pod:625
22808 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22809 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22814 #: ../fish/guestfish.pod:628
22817 " 1234 decimal number 1234\n"
22818 " 02322 octal number, equivalent to decimal 1234\n"
22819 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22825 #: ../fish/guestfish.pod:632
22827 "When using the C<chmod> command, you almost always want to specify an octal "
22828 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22829 "L<chmod(1)> program):"
22834 #: ../fish/guestfish.pod:636
22837 " chmod 0777 /public # OK\n"
22838 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22844 #: ../fish/guestfish.pod:639
22846 "Commands that return numbers usually print them in decimal, but some "
22847 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22848 "octal, preceeded by C<0>)."
22853 #: ../fish/guestfish.pod:643
22854 msgid "WILDCARDS AND GLOBBING"
22859 #: ../fish/guestfish.pod:645
22861 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22862 "(globbing) by default. So for example the following will not do what you "
22868 #: ../fish/guestfish.pod:649
22877 #: ../fish/guestfish.pod:651
22879 "Assuming you don't have a directory called literally C</home/*> then the "
22880 "above command will return an error."
22885 #: ../fish/guestfish.pod:654
22886 msgid "To perform wildcard expansion, use the C<glob> command."
22891 #: ../fish/guestfish.pod:656
22894 " glob rm-rf /home/*\n"
22900 #: ../fish/guestfish.pod:658
22902 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
22903 "many times), equivalent to:"
22908 #: ../fish/guestfish.pod:661
22911 " rm-rf /home/jim\n"
22912 " rm-rf /home/joe\n"
22913 " rm-rf /home/mary\n"
22919 #: ../fish/guestfish.pod:665
22920 msgid "C<glob> only works on simple guest paths and not on device names."
22925 #: ../fish/guestfish.pod:667
22927 "If you have several parameters, each containing a wildcard, then glob will "
22928 "perform a Cartesian product."
22933 #: ../fish/guestfish.pod:670
22939 #: ../fish/guestfish.pod:672
22941 "Any line which starts with a I<#> character is treated as a comment and "
22942 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22943 "a command. For example:"
22948 #: ../fish/guestfish.pod:676
22951 " # this is a comment\n"
22952 " # this is a comment\n"
22953 " foo # NOT a comment\n"
22959 #: ../fish/guestfish.pod:680
22960 msgid "Blank lines are also ignored."
22965 #: ../fish/guestfish.pod:682
22966 msgid "RUNNING COMMANDS LOCALLY"
22971 #: ../fish/guestfish.pod:684
22973 "Any line which starts with a I<!> character is treated as a command sent to "
22974 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22979 #: ../fish/guestfish.pod:688
22983 " tgz-out /remote local/remote-data.tar.gz\n"
22989 #: ../fish/guestfish.pod:691
22991 "will create a directory C<local> on the host, and then export the contents "
22992 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22993 "(See C<tgz-out>)."
22998 #: ../fish/guestfish.pod:695
23000 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
23001 "effect, due to the way that subprocesses work in Unix."
23005 #: ../fish/guestfish.pod:698
23006 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
23010 #: ../fish/guestfish.pod:700
23012 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
23013 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
23014 "and executed as guestfish commands."
23018 #: ../fish/guestfish.pod:704
23020 "Thus you can use shell script to construct arbitrary guestfish commands "
23021 "which are then parsed by guestfish."
23025 #: ../fish/guestfish.pod:707
23027 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23028 "through C</foo.100>) using guestfish commands alone. However this is simple "
23029 "if we use a shell script to create the guestfish commands for us:"
23033 #: ../fish/guestfish.pod:712
23036 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23041 #: ../fish/guestfish.pod:714
23042 msgid "or with names like C</foo.001>:"
23046 #: ../fish/guestfish.pod:716
23049 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23054 #: ../fish/guestfish.pod:718
23056 "When using guestfish interactively it can be helpful to just run the shell "
23057 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23058 "ordinary I<!> local command), see what guestfish commands it would run, and "
23059 "when you are happy with those prepend the C<E<lt>> character to run the "
23060 "guestfish commands for real."
23065 #: ../fish/guestfish.pod:724
23071 #: ../fish/guestfish.pod:726
23073 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23074 "command (a guestfish command) to the second command (any host command). For "
23080 #: ../fish/guestfish.pod:730
23083 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23089 #: ../fish/guestfish.pod:732
23091 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23092 "program). The above command would list all accounts in the guest filesystem "
23093 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23098 #: ../fish/guestfish.pod:737
23101 " hexdump /bin/ls | head\n"
23102 " list-devices | tail -1\n"
23103 " tgz-out / - | tar ztf -\n"
23109 #: ../fish/guestfish.pod:741
23111 "The space before the pipe symbol is required, any space after the pipe "
23112 "symbol is optional. Everything after the pipe symbol is just passed "
23113 "straight to the host shell, so it can contain redirections, globs and "
23114 "anything else that makes sense on the host side."
23119 #: ../fish/guestfish.pod:746
23121 "To use a literal argument which begins with a pipe symbol, you have to quote "
23127 #: ../fish/guestfish.pod:749
23136 #: ../fish/guestfish.pod:751
23137 msgid "HOME DIRECTORIES"
23142 #: ../fish/guestfish.pod:753
23144 "If a parameter starts with the character C<~> then the tilde may be expanded "
23145 "as a home directory path (either C<~> for the current user's home directory, "
23146 "or C<~user> for another user)."
23151 #: ../fish/guestfish.pod:757
23153 "Note that home directory expansion happens for users known I<on the host>, "
23154 "not in the guest filesystem."
23159 #: ../fish/guestfish.pod:760
23161 "To use a literal argument which begins with a tilde, you have to quote it, "
23167 #: ../fish/guestfish.pod:763
23176 #: ../fish/guestfish.pod:767
23178 "Libguestfs has some support for Linux guests encrypted according to the "
23179 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23180 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23181 "LUKS is supported."
23186 #: ../fish/guestfish.pod:772
23187 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23192 #: ../fish/guestfish.pod:774
23195 " ><fs> vfs-type /dev/sda2\n"
23202 #: ../fish/guestfish.pod:777
23204 "Then open those devices using L</luks-open>. This creates a device-mapper "
23205 "device called C</dev/mapper/luksdev>."
23210 #: ../fish/guestfish.pod:780
23213 " ><fs> luks-open /dev/sda2 luksdev\n"
23214 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23220 #: ../fish/guestfish.pod:783
23222 "Finally you have to tell LVM to scan for volume groups on the newly created "
23228 #: ../fish/guestfish.pod:786
23232 " vg-activate-all true\n"
23238 #: ../fish/guestfish.pod:789
23239 msgid "The logical volume(s) can now be mounted in the usual way."
23244 #: ../fish/guestfish.pod:791
23246 "Before closing a LUKS device you must unmount any logical volumes on it and "
23247 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23248 "one. Then you can close the mapper device:"
23253 #: ../fish/guestfish.pod:795
23256 " vg-activate false /dev/VG\n"
23257 " luks-close /dev/mapper/luksdev\n"
23263 #: ../fish/guestfish.pod:798
23264 msgid "WINDOWS PATHS"
23269 #: ../fish/guestfish.pod:800
23271 "If a path is prefixed with C<win:> then you can use Windows-style paths "
23272 "(with some limitations). The following commands are equivalent:"
23277 #: ../fish/guestfish.pod:803
23280 " file /WINDOWS/system32/config/system.LOG\n"
23286 #: ../fish/guestfish.pod:805
23289 " file win:/windows/system32/config/system.log\n"
23295 #: ../fish/guestfish.pod:807
23298 " file win:\\windows\\system32\\config\\system.log\n"
23304 #: ../fish/guestfish.pod:809
23307 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
23313 #: ../fish/guestfish.pod:811
23315 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
23316 "handles case insensitivity like Windows would. This only works in argument "
23317 "positions that expect a path."
23322 #: ../fish/guestfish.pod:815
23323 msgid "UPLOADING AND DOWNLOADING FILES"
23328 #: ../fish/guestfish.pod:817
23330 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23331 "others which upload from or download to a local file, you can use the "
23332 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23337 #: ../fish/guestfish.pod:821
23346 #: ../fish/guestfish.pod:823
23348 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23353 #: ../fish/guestfish.pod:826
23356 " tar-out /etc - | tar tf -\n"
23362 #: ../fish/guestfish.pod:828
23364 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23365 "command (see L</PIPES>)."
23370 #: ../fish/guestfish.pod:831
23372 "When using C<-> to read from stdin, the input is read up to the end of "
23373 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23374 "some arbitrary end marker:"
23379 #: ../fish/guestfish.pod:835
23382 " upload -<<END /foo\n"
23392 #: ../fish/guestfish.pod:841
23394 "Any string of characters can be used instead of C<END>. The end marker must "
23395 "appear on a line of its own, without any preceeding or following characters "
23396 "(not even spaces)."
23401 #: ../fish/guestfish.pod:845
23403 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23404 "upload local files (so-called \"FileIn\" parameters in the generator)."
23409 #: ../fish/guestfish.pod:848
23410 msgid "EXIT ON ERROR BEHAVIOUR"
23415 #: ../fish/guestfish.pod:850
23417 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23418 "taking commands from a human over a tty), and will exit on the first error "
23419 "in non-interactive mode (scripts, commands given on the command line)."
23424 #: ../fish/guestfish.pod:855
23426 "If you prefix a command with a I<-> character, then that command will not "
23427 "cause guestfish to exit, even if that (one) command returns an error."
23432 #: ../fish/guestfish.pod:859
23433 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23438 #: ../fish/guestfish.pod:861
23440 "Guestfish can be remote-controlled over a socket. This is useful "
23441 "particularly in shell scripts where you want to make several different "
23442 "changes to a filesystem, but you don't want the overhead of starting up a "
23443 "guestfish process each time."
23448 #: ../fish/guestfish.pod:866
23449 msgid "Start a guestfish server process using:"
23454 #: ../fish/guestfish.pod:868
23457 " eval \"`guestfish --listen`\"\n"
23463 #: ../fish/guestfish.pod:870
23464 msgid "and then send it commands by doing:"
23469 #: ../fish/guestfish.pod:872
23472 " guestfish --remote cmd [...]\n"
23478 #: ../fish/guestfish.pod:874
23479 msgid "To cause the server to exit, send it the exit command:"
23484 #: ../fish/guestfish.pod:876
23487 " guestfish --remote exit\n"
23493 #: ../fish/guestfish.pod:878
23495 "Note that the server will normally exit if there is an error in a command. "
23496 "You can change this in the usual way. See section L</EXIT ON ERROR "
23502 #: ../fish/guestfish.pod:882
23503 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23508 #: ../fish/guestfish.pod:884
23510 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23511 "is how the I<--remote> option knows where to send the commands. You can "
23512 "have several guestfish listener processes running using:"
23517 #: ../fish/guestfish.pod:888
23520 " eval \"`guestfish --listen`\"\n"
23521 " pid1=$GUESTFISH_PID\n"
23522 " eval \"`guestfish --listen`\"\n"
23523 " pid2=$GUESTFISH_PID\n"
23525 " guestfish --remote=$pid1 cmd\n"
23526 " guestfish --remote=$pid2 cmd\n"
23532 #: ../fish/guestfish.pod:896
23533 msgid "REMOTE CONTROL AND CSH"
23538 #: ../fish/guestfish.pod:898
23540 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23546 #: ../fish/guestfish.pod:901
23549 " eval \"`guestfish --listen --csh`\"\n"
23555 #: ../fish/guestfish.pod:903
23556 msgid "REMOTE CONTROL DETAILS"
23561 #: ../fish/guestfish.pod:905
23563 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23564 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23565 "and C<$PID> is the process ID of the server."
23570 #: ../fish/guestfish.pod:909
23571 msgid "Guestfish client and server versions must match exactly."
23576 #: ../fish/guestfish.pod:911
23577 msgid "PREPARED DISK IMAGES"
23582 #: ../fish/guestfish.pod:913
23584 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23585 "preformatted disk images that guestfish can make for you to save typing. "
23586 "This is particularly useful for testing purposes. This option is used "
23587 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23588 "can be mixed with I<-a>)."
23593 #: ../fish/guestfish.pod:919
23595 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23596 "the second and so on. Existing files in the current directory are "
23602 #: ../fish/guestfish.pod:923
23604 "The type briefly describes how the disk should be sized, partitioned, how "
23605 "filesystem(s) should be created, and how content should be added. "
23606 "Optionally the type can be followed by extra parameters, separated by C<:> "
23607 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23608 "allocated disk, containing a single partition, with the partition formatted "
23609 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23615 #: ../fish/guestfish.pod:931
23616 msgid "To list the available types and any extra parameters they take, run:"
23621 #: ../fish/guestfish.pod:935
23623 "Note that the prepared filesystem is not mounted. You would usually have to "
23624 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23629 #: ../fish/guestfish.pod:939
23631 "If any I<-N> or I<--new> options are given, the guest is automatically "
23637 #: ../fish/guestfish.pod:944
23638 msgid "Create a 100MB disk with an ext4-formatted partition:"
23643 #: ../fish/guestfish.pod:946
23646 " guestfish -N fs:ext4\n"
23652 #: ../fish/guestfish.pod:948
23653 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23658 #: ../fish/guestfish.pod:950
23661 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23667 #: ../fish/guestfish.pod:952
23668 msgid "Create a blank 200MB disk:"
23673 #: ../fish/guestfish.pod:954
23676 " guestfish -N disk:200M\n"
23682 #: ../fish/guestfish.pod:956
23683 msgid "PROGRESS BARS"
23688 #: ../fish/guestfish.pod:958
23690 "Some (not all) long-running commands send progress notification messages as "
23691 "they are running. Guestfish turns these messages into progress bars."
23696 #: ../fish/guestfish.pod:962
23698 "When a command that supports progress bars takes longer than two seconds to "
23699 "run, and if progress bars are enabled, then you will see one appearing below "
23705 #: ../fish/guestfish.pod:966
23708 " ><fs> copy-size /large-file /another-file 2048M\n"
23709 " / 10% [#####-----------------------------------------] 00:30\n"
23715 #: ../fish/guestfish.pod:969
23717 "The spinner on the left hand side moves round once for every progress "
23718 "notification received from the backend. This is a (reasonably) golden "
23719 "assurance that the command is \"doing something\" even if the progress bar "
23720 "is not moving, because the command is able to send the progress "
23721 "notifications. When the bar reaches 100% and the command finishes, the "
23722 "spinner disappears."
23727 #: ../fish/guestfish.pod:976
23729 "Progress bars are enabled by default when guestfish is used interactively. "
23730 "You can enable them even for non-interactive modes using I<--progress-bars>, "
23731 "and you can disable them completely using I<--no-progress-bars>."
23736 #: ../fish/guestfish.pod:981
23737 msgid "GUESTFISH COMMANDS"
23742 #: ../fish/guestfish.pod:983
23744 "The commands in this section are guestfish convenience commands, in other "
23745 "words, they are not part of the L<guestfs(3)> API."
23750 #: ../fish/guestfish.pod:986
23756 #: ../fish/guestfish.pod:988
23766 #: ../fish/guestfish.pod:991
23767 msgid "Without any parameter, this provides general help."
23772 #: ../fish/guestfish.pod:993
23773 msgid "With a C<cmd> parameter, this displays detailed help for that command."
23778 #: ../fish/guestfish.pod:995
23779 msgid "quit | exit"
23784 #: ../fish/guestfish.pod:997
23785 msgid "This exits guestfish. You can also use C<^D> key."
23790 #: ../fish/guestfish.pod:999
23791 msgid "@FISH_COMMANDS@"
23796 #: ../fish/guestfish.pod:1001
23802 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:83
23808 #: ../fish/guestfish.pod:1007
23810 "guestfish returns 0 if the commands completed without error, or 1 if there "
23816 #: ../fish/guestfish.pod:1014
23822 #: ../fish/guestfish.pod:1016
23824 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23830 #: ../fish/guestfish.pod:1019
23831 msgid "GUESTFISH_PID"
23836 #: ../fish/guestfish.pod:1021
23838 "Used with the I<--remote> option to specify the remote guestfish process to "
23839 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23844 #: ../fish/guestfish.pod:1025
23850 #: ../fish/guestfish.pod:1027
23852 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23853 "not specified, the external L<hexedit(1)> program is used."
23858 #: ../fish/guestfish.pod:1031
23864 #: ../fish/guestfish.pod:1033
23866 "If compiled with GNU readline support, various files in the home directory "
23867 "can be used. See L</FILES>."
23872 #: ../fish/guestfish.pod:1042
23874 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23875 "effect as using the B<-v> option."
23880 #: ../fish/guestfish.pod:1054
23882 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23883 "the discussion of paths in L<guestfs(3)>."
23888 #: ../fish/guestfish.pod:1065
23889 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
23894 #: ../fish/guestfish.pod:1067
23900 #: ../fish/guestfish.pod:1069
23902 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
23908 #: ../fish/guestfish.pod:1085 ../test-tool/libguestfs-test-tool.pod:88
23909 #: ../fuse/guestmount.pod:252
23914 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
23915 msgid "$HOME/.libguestfs-tools.rc"
23919 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
23920 msgid "/etc/libguestfs-tools.conf"
23924 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
23926 "This configuration file controls the default read-only or read-write mode "
23927 "(I<--ro> or I<--rw>)."
23931 #: ../fish/guestfish.pod:1096
23932 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
23937 #: ../fish/guestfish.pod:1098
23938 msgid "$HOME/.guestfish"
23943 #: ../fish/guestfish.pod:1100
23945 "If compiled with GNU readline support, then the command history is saved in "
23951 #: ../fish/guestfish.pod:1103
23952 msgid "$HOME/.inputrc"
23957 #: ../fish/guestfish.pod:1105
23958 msgid "/etc/inputrc"
23963 #: ../fish/guestfish.pod:1107
23965 "If compiled with GNU readline support, then these files can be used to "
23966 "configure readline. For further information, please see L<readline(3)/"
23967 "INITIALIZATION FILE>."
23972 #: ../fish/guestfish.pod:1111
23973 msgid "To write rules which only apply to guestfish, use:"
23978 #: ../fish/guestfish.pod:1113
23989 #: ../fish/guestfish.pod:1117
23991 "Variables that you can set in inputrc that change the behaviour of guestfish "
23992 "in useful ways include:"
23997 #: ../fish/guestfish.pod:1122
23998 msgid "completion-ignore-case (default: on)"
24003 #: ../fish/guestfish.pod:1124
24005 "By default, guestfish will ignore case when tab-completing paths on the "
24011 #: ../fish/guestfish.pod:1127
24014 " set completion-ignore-case off\n"
24020 #: ../fish/guestfish.pod:1129
24021 msgid "to make guestfish case sensitive."
24026 #: ../fish/guestfish.pod:1133
24032 #: ../fish/guestfish.pod:1135
24033 msgid "test2.img (etc)"
24038 #: ../fish/guestfish.pod:1137
24040 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
24041 "will be created in the file C<test1.img> in the current directory. The "
24042 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
24043 "the same name will be overwritten."
24047 #: ../fish/guestfish.pod:1146
24049 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24050 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24051 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24052 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24053 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24054 ">, L<hexedit(1)>."
24059 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:124
24060 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:372
24061 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518
24062 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
24063 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
24065 "This program is free software; you can redistribute it and/or modify it "
24066 "under the terms of the GNU General Public License as published by the Free "
24067 "Software Foundation; either version 2 of the License, or (at your option) "
24068 "any later version."
24073 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:129
24074 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:377
24075 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523
24076 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24077 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24079 "This program is distributed in the hope that it will be useful, but WITHOUT "
24080 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24081 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24087 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:134
24088 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:382
24089 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528
24090 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24091 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24093 "You should have received a copy of the GNU General Public License along with "
24094 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24095 "Ave, Cambridge, MA 02139, USA."
24100 #: ../fish/guestfish-actions.pod:1
24106 #: ../fish/guestfish-actions.pod:3
24109 " add-cdrom filename\n"
24115 #: ../fish/guestfish-actions.pod:15
24117 "This call checks for the existence of C<filename>. This stops you from "
24118 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24119 "and C<http:> URLs. To specify those, use the general L</config> call "
24125 #: ../fish/guestfish-actions.pod:22
24127 "If you just want to add an ISO file (often you use this as an efficient way "
24128 "to transfer large files into the guest), then you should probably use L</add-"
24129 "drive-ro> instead."
24134 #: ../fish/guestfish-actions.pod:35
24140 #: ../fish/guestfish-actions.pod:37
24145 #: ../fish/guestfish-actions.pod:39
24148 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24154 #: ../fish/guestfish-actions.pod:41
24156 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24157 "It works by connecting to libvirt, requesting the domain and domain XML from "
24158 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24163 #: ../fish/guestfish-actions.pod:71
24165 "The other optional parameters are passed directly through to L</add-drive-"
24171 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24172 #: ../fish/guestfish-actions.pod:2981
24174 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24179 #: ../fish/guestfish-actions.pod:76
24185 #: ../fish/guestfish-actions.pod:78
24188 " add-drive filename\n"
24194 #: ../fish/guestfish-actions.pod:80
24196 "This function is the equivalent of calling L</add-drive-opts> with no "
24197 "optional parameters, so the disk is added writable, with the format being "
24198 "detected automatically."
24203 #: ../fish/guestfish-actions.pod:84
24205 "Automatic detection of the format opens you up to a potential security hole "
24206 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24207 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24208 "you should think about replacing calls to this function with calls to L</add-"
24209 "drive-opts>, and specifying the format."
24214 #: ../fish/guestfish-actions.pod:91
24215 msgid "add-drive-opts"
24220 #: ../fish/guestfish-actions.pod:93
24226 #: ../fish/guestfish-actions.pod:95
24229 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24235 #: ../fish/guestfish-actions.pod:122
24237 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24238 "add-drive-ro>) then the format is automatically detected. Possible formats "
24239 "include C<raw> and C<qcow2>."
24244 #: ../fish/guestfish-actions.pod:133
24246 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24247 "add-drive-with-if> call (q.v.)"
24252 #: ../fish/guestfish-actions.pod:140
24253 msgid "add-drive-ro"
24258 #: ../fish/guestfish-actions.pod:142
24264 #: ../fish/guestfish-actions.pod:144
24267 " add-drive-ro filename\n"
24273 #: ../fish/guestfish-actions.pod:146
24275 "This function is the equivalent of calling L</add-drive-opts> with the "
24276 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24277 "is added read-only, with the format being detected automatically."
24282 #: ../fish/guestfish-actions.pod:151
24283 msgid "add-drive-ro-with-if"
24288 #: ../fish/guestfish-actions.pod:153
24291 " add-drive-ro-with-if filename iface\n"
24297 #: ../fish/guestfish-actions.pod:155
24299 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24300 "interface emulation to use at run time."
24305 #: ../fish/guestfish-actions.pod:165
24306 msgid "add-drive-with-if"
24311 #: ../fish/guestfish-actions.pod:167
24314 " add-drive-with-if filename iface\n"
24320 #: ../fish/guestfish-actions.pod:169
24322 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24323 "interface emulation to use at run time."
24328 #: ../fish/guestfish-actions.pod:179
24334 #: ../fish/guestfish-actions.pod:181
24337 " aug-clear augpath\n"
24343 #: ../fish/guestfish-actions.pod:186
24349 #: ../fish/guestfish-actions.pod:188
24358 #: ../fish/guestfish-actions.pod:190
24360 "Close the current Augeas handle and free up any resources used by it. After "
24361 "calling this, you have to call L</aug-init> again before you can use any "
24362 "other Augeas functions."
24367 #: ../fish/guestfish-actions.pod:195
24368 msgid "aug-defnode"
24373 #: ../fish/guestfish-actions.pod:197
24376 " aug-defnode name expr val\n"
24382 #: ../fish/guestfish-actions.pod:202
24384 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24385 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24386 "containing that single node."
24391 #: ../fish/guestfish-actions.pod:210
24397 #: ../fish/guestfish-actions.pod:212
24400 " aug-defvar name expr\n"
24406 #: ../fish/guestfish-actions.pod:221
24412 #: ../fish/guestfish-actions.pod:223
24415 " aug-get augpath\n"
24421 #: ../fish/guestfish-actions.pod:228
24427 #: ../fish/guestfish-actions.pod:230
24430 " aug-init root flags\n"
24436 #: ../fish/guestfish-actions.pod:236
24437 msgid "You must call this before using any other L</aug-*> commands."
24442 #: ../fish/guestfish-actions.pod:271
24443 msgid "Do not load the tree in L</aug-init>."
24448 #: ../fish/guestfish-actions.pod:275
24449 msgid "To close the handle, you can call L</aug-close>."
24454 #: ../fish/guestfish-actions.pod:279
24460 #: ../fish/guestfish-actions.pod:281
24463 " aug-insert augpath label true|false\n"
24469 #: ../fish/guestfish-actions.pod:291
24475 #: ../fish/guestfish-actions.pod:293
24484 #: ../fish/guestfish-actions.pod:300
24490 #: ../fish/guestfish-actions.pod:302
24493 " aug-ls augpath\n"
24499 #: ../fish/guestfish-actions.pod:304
24501 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24502 "resulting nodes into alphabetical order."
24507 #: ../fish/guestfish-actions.pod:307
24513 #: ../fish/guestfish-actions.pod:309
24516 " aug-match augpath\n"
24522 #: ../fish/guestfish-actions.pod:315
24528 #: ../fish/guestfish-actions.pod:317
24531 " aug-mv src dest\n"
24537 #: ../fish/guestfish-actions.pod:322
24543 #: ../fish/guestfish-actions.pod:324
24546 " aug-rm augpath\n"
24552 #: ../fish/guestfish-actions.pod:330
24558 #: ../fish/guestfish-actions.pod:332
24567 #: ../fish/guestfish-actions.pod:336
24569 "The flags which were passed to L</aug-init> affect exactly how files are "
24575 #: ../fish/guestfish-actions.pod:339
24581 #: ../fish/guestfish-actions.pod:341
24584 " aug-set augpath val\n"
24590 #: ../fish/guestfish-actions.pod:345
24592 "In the Augeas API, it is possible to clear a node by setting the value to "
24593 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24594 "this call. Instead you must use the L</aug-clear> call."
24599 #: ../fish/guestfish-actions.pod:350
24605 #: ../fish/guestfish-actions.pod:352
24608 " available 'groups ...'\n"
24614 #: ../fish/guestfish-actions.pod:358
24616 "The libguestfs groups, and the functions that those groups correspond to, "
24617 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24618 "runtime by calling L</available-all-groups>."
24623 #: ../fish/guestfish-actions.pod:382
24624 msgid "You must call L</launch> before calling this function."
24629 #: ../fish/guestfish-actions.pod:404
24631 "This call was added in version C<1.0.80>. In previous versions of "
24632 "libguestfs all you could do would be to speculatively execute a command to "
24633 "find out if the daemon implemented it. See also L</version>."
24638 #: ../fish/guestfish-actions.pod:411
24639 msgid "available-all-groups"
24644 #: ../fish/guestfish-actions.pod:413
24647 " available-all-groups\n"
24653 #: ../fish/guestfish-actions.pod:415
24655 "This command returns a list of all optional groups that this daemon knows "
24656 "about. Note this returns both supported and unsupported groups. To find "
24657 "out which ones the daemon can actually support you have to call L</"
24658 "available> on each member of the returned list."
24663 #: ../fish/guestfish-actions.pod:421
24664 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24669 #: ../fish/guestfish-actions.pod:423
24675 #: ../fish/guestfish-actions.pod:425
24678 " base64-in (base64file|-) filename\n"
24684 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24685 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24686 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24687 #: ../fish/guestfish-actions.pod:4379 ../fish/guestfish-actions.pod:4391
24688 #: ../fish/guestfish-actions.pod:4402 ../fish/guestfish-actions.pod:4413
24689 #: ../fish/guestfish-actions.pod:4465 ../fish/guestfish-actions.pod:4474
24690 #: ../fish/guestfish-actions.pod:4528 ../fish/guestfish-actions.pod:4551
24691 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24696 #: ../fish/guestfish-actions.pod:432
24702 #: ../fish/guestfish-actions.pod:434
24705 " base64-out filename (base64file|-)\n"
24711 #: ../fish/guestfish-actions.pod:441
24712 msgid "blockdev-flushbufs"
24717 #: ../fish/guestfish-actions.pod:443
24720 " blockdev-flushbufs device\n"
24726 #: ../fish/guestfish-actions.pod:450
24727 msgid "blockdev-getbsz"
24732 #: ../fish/guestfish-actions.pod:452
24735 " blockdev-getbsz device\n"
24741 #: ../fish/guestfish-actions.pod:461
24742 msgid "blockdev-getro"
24747 #: ../fish/guestfish-actions.pod:463
24750 " blockdev-getro device\n"
24756 #: ../fish/guestfish-actions.pod:470
24757 msgid "blockdev-getsize64"
24762 #: ../fish/guestfish-actions.pod:472
24765 " blockdev-getsize64 device\n"
24771 #: ../fish/guestfish-actions.pod:476
24772 msgid "See also L</blockdev-getsz>."
24777 #: ../fish/guestfish-actions.pod:480
24778 msgid "blockdev-getss"
24783 #: ../fish/guestfish-actions.pod:482
24786 " blockdev-getss device\n"
24792 #: ../fish/guestfish-actions.pod:487
24794 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
24799 #: ../fish/guestfish-actions.pod:492
24800 msgid "blockdev-getsz"
24805 #: ../fish/guestfish-actions.pod:494
24808 " blockdev-getsz device\n"
24814 #: ../fish/guestfish-actions.pod:499
24816 "See also L</blockdev-getss> for the real sector size of the device, and L</"
24817 "blockdev-getsize64> for the more useful I<size in bytes>."
24822 #: ../fish/guestfish-actions.pod:505
24823 msgid "blockdev-rereadpt"
24828 #: ../fish/guestfish-actions.pod:507
24831 " blockdev-rereadpt device\n"
24837 #: ../fish/guestfish-actions.pod:513
24838 msgid "blockdev-setbsz"
24843 #: ../fish/guestfish-actions.pod:515
24846 " blockdev-setbsz device blocksize\n"
24852 #: ../fish/guestfish-actions.pod:524
24853 msgid "blockdev-setro"
24858 #: ../fish/guestfish-actions.pod:526
24861 " blockdev-setro device\n"
24867 #: ../fish/guestfish-actions.pod:532
24868 msgid "blockdev-setrw"
24873 #: ../fish/guestfish-actions.pod:534
24876 " blockdev-setrw device\n"
24882 #: ../fish/guestfish-actions.pod:540
24883 msgid "case-sensitive-path"
24888 #: ../fish/guestfish-actions.pod:542
24891 " case-sensitive-path path\n"
24897 #: ../fish/guestfish-actions.pod:566
24899 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
24900 "WINDOWS/system32\"> (the exact return value would depend on details of how "
24901 "the directories were originally created under Windows)."
24906 #: ../fish/guestfish-actions.pod:574
24907 msgid "See also L</realpath>."
24912 #: ../fish/guestfish-actions.pod:576
24918 #: ../fish/guestfish-actions.pod:578
24927 #: ../fish/guestfish-actions.pod:582
24929 "Note that this function cannot correctly handle binary files (specifically, "
24930 "files containing C<\\0> character which is treated as end of string). For "
24931 "those you need to use the L</read-file> or L</download> functions which have "
24932 "a more complex interface."
24937 #: ../fish/guestfish-actions.pod:590
24943 #: ../fish/guestfish-actions.pod:592
24946 " checksum csumtype path\n"
24952 #: ../fish/guestfish-actions.pod:635
24953 msgid "To get the checksum for a device, use L</checksum-device>."
24958 #: ../fish/guestfish-actions.pod:637
24959 msgid "To get the checksums for many files, use L</checksums-out>."
24964 #: ../fish/guestfish-actions.pod:639
24965 msgid "checksum-device"
24970 #: ../fish/guestfish-actions.pod:641
24973 " checksum-device csumtype device\n"
24979 #: ../fish/guestfish-actions.pod:643
24981 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
24982 "device named C<device>. For the types of checksums supported see the L</"
24983 "checksum> command."
24988 #: ../fish/guestfish-actions.pod:647
24989 msgid "checksums-out"
24994 #: ../fish/guestfish-actions.pod:649
24997 " checksums-out csumtype directory (sumsfile|-)\n"
25003 #: ../fish/guestfish-actions.pod:665
25009 #: ../fish/guestfish-actions.pod:667
25012 " chmod mode path\n"
25018 #: ../fish/guestfish-actions.pod:678
25024 #: ../fish/guestfish-actions.pod:680
25027 " chown owner group path\n"
25033 #: ../fish/guestfish-actions.pod:688
25039 #: ../fish/guestfish-actions.pod:690
25042 " command 'arguments ...'\n"
25048 #: ../fish/guestfish-actions.pod:697
25050 "The single parameter is an argv-style list of arguments. The first element "
25051 "is the name of the program to run. Subsequent elements are parameters. The "
25052 "list must be non-empty (ie. must contain a program name). Note that the "
25053 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25058 #: ../fish/guestfish-actions.pod:725
25059 msgid "command-lines"
25064 #: ../fish/guestfish-actions.pod:727
25067 " command-lines 'arguments ...'\n"
25073 #: ../fish/guestfish-actions.pod:729
25075 "This is the same as L</command>, but splits the result into a list of lines."
25080 #: ../fish/guestfish-actions.pod:732
25081 msgid "See also: L</sh-lines>"
25086 #: ../fish/guestfish-actions.pod:737
25092 #: ../fish/guestfish-actions.pod:739
25095 " config qemuparam qemuvalue\n"
25101 #: ../fish/guestfish-actions.pod:750
25107 #: ../fish/guestfish-actions.pod:752
25110 " copy-size src dest size\n"
25116 #: ../fish/guestfish-actions.pod:760
25122 #: ../fish/guestfish-actions.pod:762
25131 #: ../fish/guestfish-actions.pod:767
25137 #: ../fish/guestfish-actions.pod:769
25146 #: ../fish/guestfish-actions.pod:774
25152 #: ../fish/guestfish-actions.pod:776
25161 #: ../fish/guestfish-actions.pod:783
25163 "If the destination is a device, it must be as large or larger than the "
25164 "source file or device, otherwise the copy will fail. This command cannot do "
25165 "partial copies (see L</copy-size>)."
25170 #: ../fish/guestfish-actions.pod:787
25176 #: ../fish/guestfish-actions.pod:789
25185 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25187 "This command is mostly useful for interactive sessions. It is I<not> "
25188 "intended that you try to parse the output string. Use L</statvfs> from "
25194 #: ../fish/guestfish-actions.pod:797
25200 #: ../fish/guestfish-actions.pod:799
25209 #: ../fish/guestfish-actions.pod:808
25215 #: ../fish/guestfish-actions.pod:810
25224 #: ../fish/guestfish-actions.pod:816
25226 "Another way to get the same information is to enable verbose messages with "
25227 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25228 "before running the program."
25233 #: ../fish/guestfish-actions.pod:821
25239 #: ../fish/guestfish-actions.pod:823
25242 " download remotefilename (filename|-)\n"
25248 #: ../fish/guestfish-actions.pod:830
25249 msgid "See also L</upload>, L</cat>."
25254 #: ../fish/guestfish-actions.pod:834
25255 msgid "download-offset"
25260 #: ../fish/guestfish-actions.pod:836
25263 " download-offset remotefilename (filename|-) offset size\n"
25269 #: ../fish/guestfish-actions.pod:844
25271 "Note that there is no limit on the amount of data that can be downloaded "
25272 "with this call, unlike with L</pread>, and this call always reads the full "
25273 "amount unless an error occurs."
25278 #: ../fish/guestfish-actions.pod:849
25279 msgid "See also L</download>, L</pread>."
25284 #: ../fish/guestfish-actions.pod:853
25285 msgid "drop-caches"
25290 #: ../fish/guestfish-actions.pod:855
25293 " drop-caches whattodrop\n"
25299 #: ../fish/guestfish-actions.pod:867
25305 #: ../fish/guestfish-actions.pod:869
25314 #: ../fish/guestfish-actions.pod:881
25320 #: ../fish/guestfish-actions.pod:883
25323 " e2fsck-f device\n"
25329 #: ../fish/guestfish-actions.pod:889
25331 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25332 "should use L</fsck>."
25337 #: ../fish/guestfish-actions.pod:892
25338 msgid "echo-daemon"
25343 #: ../fish/guestfish-actions.pod:894
25346 " echo-daemon 'words ...'\n"
25352 #: ../fish/guestfish-actions.pod:901
25353 msgid "See also L</ping-daemon>."
25358 #: ../fish/guestfish-actions.pod:903
25364 #: ../fish/guestfish-actions.pod:905
25367 " egrep regex path\n"
25373 #: ../fish/guestfish-actions.pod:913
25379 #: ../fish/guestfish-actions.pod:915
25382 " egrepi regex path\n"
25388 #: ../fish/guestfish-actions.pod:923
25394 #: ../fish/guestfish-actions.pod:925
25397 " equal file1 file2\n"
25403 #: ../fish/guestfish-actions.pod:932
25409 #: ../fish/guestfish-actions.pod:934
25418 #: ../fish/guestfish-actions.pod:939
25419 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25424 #: ../fish/guestfish-actions.pod:941
25430 #: ../fish/guestfish-actions.pod:943
25433 " fallocate path len\n"
25439 #: ../fish/guestfish-actions.pod:960
25440 msgid "fallocate64"
25445 #: ../fish/guestfish-actions.pod:962
25448 " fallocate64 path len\n"
25454 #: ../fish/guestfish-actions.pod:968
25456 "Note that this call allocates disk blocks for the file. To create a sparse "
25457 "file use L</truncate-size> instead."
25462 #: ../fish/guestfish-actions.pod:971
25464 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25465 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25466 "maximum size of files created through that call to 1GB."
25471 #: ../fish/guestfish-actions.pod:980
25477 #: ../fish/guestfish-actions.pod:982
25480 " fgrep pattern path\n"
25486 #: ../fish/guestfish-actions.pod:990
25492 #: ../fish/guestfish-actions.pod:992
25495 " fgrepi pattern path\n"
25501 #: ../fish/guestfish-actions.pod:1000
25507 #: ../fish/guestfish-actions.pod:1002
25516 #: ../fish/guestfish-actions.pod:1014
25518 "This command can also be used on C</dev/> devices (and partitions, LV "
25519 "names). You can for example use this to determine if a device contains a "
25520 "filesystem, although it's usually better to use L</vfs-type>."
25525 #: ../fish/guestfish-actions.pod:1024
25526 msgid "file-architecture"
25531 #: ../fish/guestfish-actions.pod:1026
25534 " file-architecture filename\n"
25540 #: ../fish/guestfish-actions.pod:1129
25546 #: ../fish/guestfish-actions.pod:1131
25555 #: ../fish/guestfish-actions.pod:1135
25557 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25558 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25563 #: ../fish/guestfish-actions.pod:1139
25569 #: ../fish/guestfish-actions.pod:1141
25572 " fill c len path\n"
25578 #: ../fish/guestfish-actions.pod:1147
25580 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25581 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25582 "L</fill-pattern>."
25587 #: ../fish/guestfish-actions.pod:1152
25588 msgid "fill-pattern"
25593 #: ../fish/guestfish-actions.pod:1154
25596 " fill-pattern pattern len path\n"
25602 #: ../fish/guestfish-actions.pod:1156
25604 "This function is like L</fill> except that it creates a new file of length "
25605 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25606 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25612 #: ../fish/guestfish-actions.pod:1161
25618 #: ../fish/guestfish-actions.pod:1163
25621 " find directory\n"
25627 #: ../fish/guestfish-actions.pod:1177
25628 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25633 #: ../fish/guestfish-actions.pod:1190
25634 msgid "See also L</find0>."
25639 #: ../fish/guestfish-actions.pod:1195
25645 #: ../fish/guestfish-actions.pod:1197
25648 " find0 directory (files|-)\n"
25654 #: ../fish/guestfish-actions.pod:1203
25656 "This command works the same way as L</find> with the following exceptions:"
25661 #: ../fish/guestfish-actions.pod:1230
25662 msgid "findfs-label"
25667 #: ../fish/guestfish-actions.pod:1232
25670 " findfs-label label\n"
25676 #: ../fish/guestfish-actions.pod:1238
25677 msgid "To find the label of a filesystem, use L</vfs-label>."
25682 #: ../fish/guestfish-actions.pod:1240
25683 msgid "findfs-uuid"
25688 #: ../fish/guestfish-actions.pod:1242
25691 " findfs-uuid uuid\n"
25697 #: ../fish/guestfish-actions.pod:1248
25698 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25703 #: ../fish/guestfish-actions.pod:1250
25709 #: ../fish/guestfish-actions.pod:1252
25712 " fsck fstype device\n"
25718 #: ../fish/guestfish-actions.pod:1282
25724 #: ../fish/guestfish-actions.pod:1284
25732 #: ../fish/guestfish-actions.pod:1291
25733 msgid "get-attach-method"
25737 #: ../fish/guestfish-actions.pod:1293
25740 " get-attach-method\n"
25745 #: ../fish/guestfish-actions.pod:1295
25746 msgid "Return the current attach method. See L</set-attach-method>."
25751 #: ../fish/guestfish-actions.pod:1297
25752 msgid "get-autosync"
25757 #: ../fish/guestfish-actions.pod:1299
25766 #: ../fish/guestfish-actions.pod:1303
25772 #: ../fish/guestfish-actions.pod:1305
25781 #: ../fish/guestfish-actions.pod:1309
25782 msgid "get-e2label"
25787 #: ../fish/guestfish-actions.pod:1311
25790 " get-e2label device\n"
25796 #: ../fish/guestfish-actions.pod:1323
25802 #: ../fish/guestfish-actions.pod:1325
25805 " get-e2uuid device\n"
25811 #: ../fish/guestfish-actions.pod:1337
25812 msgid "get-memsize"
25817 #: ../fish/guestfish-actions.pod:1339
25826 #: ../fish/guestfish-actions.pod:1344
25828 "If L</set-memsize> was not called on this handle, and if "
25829 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
25830 "value for memsize."
25835 #: ../fish/guestfish-actions.pod:1351
25836 msgid "get-network"
25841 #: ../fish/guestfish-actions.pod:1353
25850 #: ../fish/guestfish-actions.pod:1357
25856 #: ../fish/guestfish-actions.pod:1359
25865 #: ../fish/guestfish-actions.pod:1366
25871 #: ../fish/guestfish-actions.pod:1368
25877 #: ../fish/guestfish-actions.pod:1370
25886 #: ../fish/guestfish-actions.pod:1377
25892 #: ../fish/guestfish-actions.pod:1379
25901 #: ../fish/guestfish-actions.pod:1386
25902 msgid "get-recovery-proc"
25907 #: ../fish/guestfish-actions.pod:1388
25910 " get-recovery-proc\n"
25916 #: ../fish/guestfish-actions.pod:1392
25917 msgid "get-selinux"
25922 #: ../fish/guestfish-actions.pod:1394
25931 #: ../fish/guestfish-actions.pod:1396
25933 "This returns the current setting of the selinux flag which is passed to the "
25934 "appliance at boot time. See L</set-selinux>."
25939 #: ../fish/guestfish-actions.pod:1402
25945 #: ../fish/guestfish-actions.pod:1404
25954 #: ../fish/guestfish-actions.pod:1411
25960 #: ../fish/guestfish-actions.pod:1413
25969 #: ../fish/guestfish-actions.pod:1417
25975 #: ../fish/guestfish-actions.pod:1419
25984 #: ../fish/guestfish-actions.pod:1421
25986 "Return the current umask. By default the umask is C<022> unless it has been "
25987 "set by calling L</umask>."
25992 #: ../fish/guestfish-actions.pod:1424
25993 msgid "get-verbose"
25998 #: ../fish/guestfish-actions.pod:1426
26007 #: ../fish/guestfish-actions.pod:1430
26013 #: ../fish/guestfish-actions.pod:1432
26022 #: ../fish/guestfish-actions.pod:1436
26023 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26028 #: ../fish/guestfish-actions.pod:1439
26034 #: ../fish/guestfish-actions.pod:1441
26037 " getxattr path name\n"
26043 #: ../fish/guestfish-actions.pod:1443
26045 "Get a single extended attribute from file C<path> named C<name>. This call "
26046 "follows symlinks. If you want to lookup an extended attribute for the "
26047 "symlink itself, use L</lgetxattr>."
26052 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2387
26054 "Normally it is better to get all extended attributes from a file in one go "
26055 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26056 "buggy and do not provide a way to list out attributes. For these "
26057 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26058 "attributes you want in advance and call this function."
26063 #: ../fish/guestfish-actions.pod:1457
26064 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26069 #: ../fish/guestfish-actions.pod:1459
26075 #: ../fish/guestfish-actions.pod:1461
26078 " getxattrs path\n"
26084 #: ../fish/guestfish-actions.pod:1469
26085 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26090 #: ../fish/guestfish-actions.pod:1471
26091 msgid "glob-expand"
26096 #: ../fish/guestfish-actions.pod:1473
26099 " glob-expand pattern\n"
26105 #: ../fish/guestfish-actions.pod:1486
26111 #: ../fish/guestfish-actions.pod:1488
26114 " grep regex path\n"
26120 #: ../fish/guestfish-actions.pod:1496
26126 #: ../fish/guestfish-actions.pod:1498
26129 " grepi regex path\n"
26135 #: ../fish/guestfish-actions.pod:1506
26136 msgid "grub-install"
26141 #: ../fish/guestfish-actions.pod:1508
26144 " grub-install root device\n"
26150 #: ../fish/guestfish-actions.pod:1524
26156 #: ../fish/guestfish-actions.pod:1526
26165 #: ../fish/guestfish-actions.pod:1534
26171 #: ../fish/guestfish-actions.pod:1536
26174 " head-n nrlines path\n"
26180 #: ../fish/guestfish-actions.pod:1549
26186 #: ../fish/guestfish-actions.pod:1551
26195 #: ../fish/guestfish-actions.pod:1559
26201 #: ../fish/guestfish-actions.pod:1561
26204 " initrd-cat initrdpath filename\n"
26210 #: ../fish/guestfish-actions.pod:1573
26211 msgid "See also L</initrd-list>."
26216 #: ../fish/guestfish-actions.pod:1578
26217 msgid "initrd-list"
26222 #: ../fish/guestfish-actions.pod:1580
26225 " initrd-list path\n"
26231 #: ../fish/guestfish-actions.pod:1592
26232 msgid "inotify-add-watch"
26237 #: ../fish/guestfish-actions.pod:1594
26240 " inotify-add-watch path mask\n"
26246 #: ../fish/guestfish-actions.pod:1606
26247 msgid "inotify-close"
26252 #: ../fish/guestfish-actions.pod:1608
26261 #: ../fish/guestfish-actions.pod:1614
26262 msgid "inotify-files"
26267 #: ../fish/guestfish-actions.pod:1616
26276 #: ../fish/guestfish-actions.pod:1618
26278 "This function is a helpful wrapper around L</inotify-read> which just "
26279 "returns a list of pathnames of objects that were touched. The returned "
26280 "pathnames are sorted and deduplicated."
26285 #: ../fish/guestfish-actions.pod:1622
26286 msgid "inotify-init"
26291 #: ../fish/guestfish-actions.pod:1624
26294 " inotify-init maxevents\n"
26300 #: ../fish/guestfish-actions.pod:1630
26302 "C<maxevents> is the maximum number of events which will be queued up between "
26303 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26304 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26305 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26306 "but records the fact that it threw them away by setting a flag "
26307 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26312 #: ../fish/guestfish-actions.pod:1640
26314 "Before any events are generated, you have to add some watches to the "
26315 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26316 "L</inotify-watch-all>."
26321 #: ../fish/guestfish-actions.pod:1646
26323 "Queued up events should be read periodically by calling L</inotify-read> (or "
26324 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26325 "If you don't read the events out often enough then you risk the internal "
26326 "queue overflowing."
26331 #: ../fish/guestfish-actions.pod:1653
26333 "The handle should be closed after use by calling L</inotify-close>. This "
26334 "also removes any watches automatically."
26339 #: ../fish/guestfish-actions.pod:1662
26340 msgid "inotify-read"
26345 #: ../fish/guestfish-actions.pod:1664
26354 #: ../fish/guestfish-actions.pod:1677
26355 msgid "inotify-rm-watch"
26360 #: ../fish/guestfish-actions.pod:1679
26363 " inotify-rm-watch wd\n"
26369 #: ../fish/guestfish-actions.pod:1681
26370 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26375 #: ../fish/guestfish-actions.pod:1684
26376 msgid "inspect-get-arch"
26381 #: ../fish/guestfish-actions.pod:1686
26384 " inspect-get-arch root\n"
26390 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26391 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1800
26392 #: ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1849
26393 #: ../fish/guestfish-actions.pod:1870 ../fish/guestfish-actions.pod:1885
26394 #: ../fish/guestfish-actions.pod:1912 ../fish/guestfish-actions.pod:1934
26395 #: ../fish/guestfish-actions.pod:1958 ../fish/guestfish-actions.pod:1975
26396 #: ../fish/guestfish-actions.pod:2018 ../fish/guestfish-actions.pod:2053
26397 #: ../fish/guestfish-actions.pod:2069 ../fish/guestfish-actions.pod:2082
26398 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2110
26400 "This function should only be called with a root device string as returned by "
26406 #: ../fish/guestfish-actions.pod:1691
26408 "This returns the architecture of the inspected operating system. The "
26409 "possible return values are listed under L</file-architecture>."
26414 #: ../fish/guestfish-actions.pod:1700
26415 msgid "inspect-get-distro"
26420 #: ../fish/guestfish-actions.pod:1702
26423 " inspect-get-distro root\n"
26429 #: ../fish/guestfish-actions.pod:1778
26430 msgid "inspect-get-filesystems"
26435 #: ../fish/guestfish-actions.pod:1780
26438 " inspect-get-filesystems root\n"
26444 #: ../fish/guestfish-actions.pod:1793
26446 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26447 "get-mountpoints>."
26451 #: ../fish/guestfish-actions.pod:1796
26452 msgid "inspect-get-format"
26456 #: ../fish/guestfish-actions.pod:1798
26459 " inspect-get-format root\n"
26465 #: ../fish/guestfish-actions.pod:1830
26466 msgid "inspect-get-hostname"
26471 #: ../fish/guestfish-actions.pod:1832
26474 " inspect-get-hostname root\n"
26480 #: ../fish/guestfish-actions.pod:1845
26481 msgid "inspect-get-major-version"
26486 #: ../fish/guestfish-actions.pod:1847
26489 " inspect-get-major-version root\n"
26495 #: ../fish/guestfish-actions.pod:1866
26496 msgid "inspect-get-minor-version"
26501 #: ../fish/guestfish-actions.pod:1868
26504 " inspect-get-minor-version root\n"
26510 #: ../fish/guestfish-actions.pod:1878
26512 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26513 "get-major-version>."
26518 #: ../fish/guestfish-actions.pod:1881
26519 msgid "inspect-get-mountpoints"
26524 #: ../fish/guestfish-actions.pod:1883
26527 " inspect-get-mountpoints root\n"
26533 #: ../fish/guestfish-actions.pod:1905
26535 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26536 "get-filesystems>."
26541 #: ../fish/guestfish-actions.pod:1908
26542 msgid "inspect-get-package-format"
26547 #: ../fish/guestfish-actions.pod:1910
26550 " inspect-get-package-format root\n"
26556 #: ../fish/guestfish-actions.pod:1915
26558 "This function and L</inspect-get-package-management> return the package "
26559 "format and package management tool used by the inspected operating system. "
26560 "For example for Fedora these functions would return C<rpm> (package format) "
26561 "and C<yum> (package management)."
26566 #: ../fish/guestfish-actions.pod:1930
26567 msgid "inspect-get-package-management"
26572 #: ../fish/guestfish-actions.pod:1932
26575 " inspect-get-package-management root\n"
26581 #: ../fish/guestfish-actions.pod:1937
26583 "L</inspect-get-package-format> and this function return the package format "
26584 "and package management tool used by the inspected operating system. For "
26585 "example for Fedora these functions would return C<rpm> (package format) and "
26586 "C<yum> (package management)."
26591 #: ../fish/guestfish-actions.pod:1954
26592 msgid "inspect-get-product-name"
26597 #: ../fish/guestfish-actions.pod:1956
26600 " inspect-get-product-name root\n"
26605 #: ../fish/guestfish-actions.pod:1971
26606 msgid "inspect-get-product-variant"
26610 #: ../fish/guestfish-actions.pod:1973
26613 " inspect-get-product-variant root\n"
26618 #: ../fish/guestfish-actions.pod:1997
26620 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26621 "get-product-name>, L</inspect-get-major-version>."
26626 #: ../fish/guestfish-actions.pod:2001
26627 msgid "inspect-get-roots"
26632 #: ../fish/guestfish-actions.pod:2003
26635 " inspect-get-roots\n"
26641 #: ../fish/guestfish-actions.pod:2005
26643 "This function is a convenient way to get the list of root devices, as "
26644 "returned from a previous call to L</inspect-os>, but without redoing the "
26645 "whole inspection process."
26650 #: ../fish/guestfish-actions.pod:2009
26652 "This returns an empty list if either no root devices were found or the "
26653 "caller has not called L</inspect-os>."
26658 #: ../fish/guestfish-actions.pod:2014
26659 msgid "inspect-get-type"
26664 #: ../fish/guestfish-actions.pod:2016
26667 " inspect-get-type root\n"
26673 #: ../fish/guestfish-actions.pod:2049
26674 msgid "inspect-get-windows-systemroot"
26679 #: ../fish/guestfish-actions.pod:2051
26682 " inspect-get-windows-systemroot root\n"
26687 #: ../fish/guestfish-actions.pod:2065
26688 msgid "inspect-is-live"
26692 #: ../fish/guestfish-actions.pod:2067
26695 " inspect-is-live root\n"
26700 #: ../fish/guestfish-actions.pod:2072
26702 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26703 "then this returns true if a live image was detected on the disk."
26707 #: ../fish/guestfish-actions.pod:2078
26708 msgid "inspect-is-multipart"
26712 #: ../fish/guestfish-actions.pod:2080
26715 " inspect-is-multipart root\n"
26720 #: ../fish/guestfish-actions.pod:2085
26722 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26723 "then this returns true if the disk is part of a set."
26727 #: ../fish/guestfish-actions.pod:2091
26728 msgid "inspect-is-netinst"
26732 #: ../fish/guestfish-actions.pod:2093
26735 " inspect-is-netinst root\n"
26740 #: ../fish/guestfish-actions.pod:2098
26742 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26743 "then this returns true if the disk is a network installer, ie. not a self-"
26744 "contained install CD but one which is likely to require network access to "
26745 "complete the install."
26750 #: ../fish/guestfish-actions.pod:2106
26751 msgid "inspect-list-applications"
26756 #: ../fish/guestfish-actions.pod:2108
26759 " inspect-list-applications root\n"
26765 #: ../fish/guestfish-actions.pod:2115
26767 "I<Note:> This call works differently from other parts of the inspection "
26768 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
26769 "then mount up the disks, before calling this. Listing applications is a "
26770 "significantly more difficult operation which requires access to the full "
26771 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
26772 "are just returning data cached in the libguestfs handle, this call actually "
26773 "reads parts of the mounted filesystems during the call."
26778 #: ../fish/guestfish-actions.pod:2205
26784 #: ../fish/guestfish-actions.pod:2207
26793 #: ../fish/guestfish-actions.pod:2222
26795 "You can pass the root string(s) returned to other L</inspect-get-*> "
26796 "functions in order to query further information about each operating system, "
26797 "such as the name and version."
26802 #: ../fish/guestfish-actions.pod:2227
26804 "This function uses other libguestfs features such as L</mount-ro> and L</"
26805 "umount-all> in order to mount and unmount filesystems and look at the "
26806 "contents. This should be called with no disks currently mounted. The "
26807 "function may also use Augeas, so any existing Augeas handle will be closed."
26812 #: ../fish/guestfish-actions.pod:2239 ../fish/guestfish-actions.pod:2415
26813 #: ../fish/guestfish-actions.pod:2461
26814 msgid "See also L</list-filesystems>."
26819 #: ../fish/guestfish-actions.pod:2241
26820 msgid "is-blockdev"
26825 #: ../fish/guestfish-actions.pod:2243
26828 " is-blockdev path\n"
26834 #: ../fish/guestfish-actions.pod:2248 ../fish/guestfish-actions.pod:2266
26835 #: ../fish/guestfish-actions.pod:2285 ../fish/guestfish-actions.pod:2294
26836 #: ../fish/guestfish-actions.pod:2304 ../fish/guestfish-actions.pod:2338
26837 #: ../fish/guestfish-actions.pod:2347
26838 msgid "See also L</stat>."
26843 #: ../fish/guestfish-actions.pod:2250
26849 #: ../fish/guestfish-actions.pod:2252
26858 #: ../fish/guestfish-actions.pod:2259
26864 #: ../fish/guestfish-actions.pod:2261
26867 " is-chardev path\n"
26873 #: ../fish/guestfish-actions.pod:2268
26879 #: ../fish/guestfish-actions.pod:2270
26888 #: ../fish/guestfish-actions.pod:2277
26894 #: ../fish/guestfish-actions.pod:2279
26903 #: ../fish/guestfish-actions.pod:2287
26909 #: ../fish/guestfish-actions.pod:2289
26918 #: ../fish/guestfish-actions.pod:2296
26924 #: ../fish/guestfish-actions.pod:2298
26933 #: ../fish/guestfish-actions.pod:2306
26934 msgid "is-launching"
26939 #: ../fish/guestfish-actions.pod:2308
26948 #: ../fish/guestfish-actions.pod:2315
26954 #: ../fish/guestfish-actions.pod:2317
26963 #: ../fish/guestfish-actions.pod:2322
26969 #: ../fish/guestfish-actions.pod:2324
26978 #: ../fish/guestfish-actions.pod:2331
26984 #: ../fish/guestfish-actions.pod:2333
26987 " is-socket path\n"
26993 #: ../fish/guestfish-actions.pod:2340
26999 #: ../fish/guestfish-actions.pod:2342
27002 " is-symlink path\n"
27008 #: ../fish/guestfish-actions.pod:2349
27009 msgid "kill-subprocess"
27014 #: ../fish/guestfish-actions.pod:2351
27017 " kill-subprocess\n"
27023 #: ../fish/guestfish-actions.pod:2355
27029 #: ../fish/guestfish-actions.pod:2357
27035 #: ../fish/guestfish-actions.pod:2359
27044 #: ../fish/guestfish-actions.pod:2367
27050 #: ../fish/guestfish-actions.pod:2369
27053 " lchown owner group path\n"
27059 #: ../fish/guestfish-actions.pod:2371
27061 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27062 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27068 #: ../fish/guestfish-actions.pod:2379
27074 #: ../fish/guestfish-actions.pod:2381
27077 " lgetxattr path name\n"
27083 #: ../fish/guestfish-actions.pod:2397
27084 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27089 #: ../fish/guestfish-actions.pod:2399
27095 #: ../fish/guestfish-actions.pod:2401
27098 " lgetxattrs path\n"
27104 #: ../fish/guestfish-actions.pod:2403
27106 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27107 "it returns the extended attributes of the link itself."
27112 #: ../fish/guestfish-actions.pod:2407
27113 msgid "list-devices"
27118 #: ../fish/guestfish-actions.pod:2409
27127 #: ../fish/guestfish-actions.pod:2417
27128 msgid "list-filesystems"
27133 #: ../fish/guestfish-actions.pod:2419
27136 " list-filesystems\n"
27142 #: ../fish/guestfish-actions.pod:2438
27144 "This command runs other libguestfs commands, which might include L</mount> "
27145 "and L</umount>, and therefore you should use this soon after launch and only "
27146 "when nothing is mounted."
27151 #: ../fish/guestfish-actions.pod:2442
27153 "Not all of the filesystems returned will be mountable. In particular, swap "
27154 "partitions are returned in the list. Also this command does not check that "
27155 "each filesystem found is valid and mountable, and some filesystems might be "
27156 "mountable but require special options. Filesystems may not all belong to a "
27157 "single logical operating system (use L</inspect-os> to look for OSes)."
27162 #: ../fish/guestfish-actions.pod:2450
27163 msgid "list-partitions"
27168 #: ../fish/guestfish-actions.pod:2452
27171 " list-partitions\n"
27177 #: ../fish/guestfish-actions.pod:2458
27179 "This does not return logical volumes. For that you will need to call L</"
27185 #: ../fish/guestfish-actions.pod:2463
27191 #: ../fish/guestfish-actions.pod:2465
27200 #: ../fish/guestfish-actions.pod:2473
27206 #: ../fish/guestfish-actions.pod:2475
27209 " ln target linkname\n"
27215 #: ../fish/guestfish-actions.pod:2479
27221 #: ../fish/guestfish-actions.pod:2481
27224 " ln-f target linkname\n"
27230 #: ../fish/guestfish-actions.pod:2486
27236 #: ../fish/guestfish-actions.pod:2488
27239 " ln-s target linkname\n"
27245 #: ../fish/guestfish-actions.pod:2492
27251 #: ../fish/guestfish-actions.pod:2494
27254 " ln-sf target linkname\n"
27260 #: ../fish/guestfish-actions.pod:2499
27261 msgid "lremovexattr"
27266 #: ../fish/guestfish-actions.pod:2501
27269 " lremovexattr xattr path\n"
27275 #: ../fish/guestfish-actions.pod:2503
27277 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27278 "it removes an extended attribute of the link itself."
27283 #: ../fish/guestfish-actions.pod:2507
27289 #: ../fish/guestfish-actions.pod:2509
27298 #: ../fish/guestfish-actions.pod:2515
27300 "This command is mostly useful for interactive sessions. Programs should "
27301 "probably use L</readdir> instead."
27306 #: ../fish/guestfish-actions.pod:2518
27312 #: ../fish/guestfish-actions.pod:2520
27315 " lsetxattr xattr val vallen path\n"
27321 #: ../fish/guestfish-actions.pod:2522
27323 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27324 "sets an extended attribute of the link itself."
27329 #: ../fish/guestfish-actions.pod:2526
27335 #: ../fish/guestfish-actions.pod:2528
27344 #: ../fish/guestfish-actions.pod:2532
27346 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27347 "the link is stat-ed, not the file it refers to."
27352 #: ../fish/guestfish-actions.pod:2538
27358 #: ../fish/guestfish-actions.pod:2540
27361 " lstatlist path 'names ...'\n"
27367 #: ../fish/guestfish-actions.pod:2542
27369 "This call allows you to perform the L</lstat> operation on multiple files, "
27370 "where all files are in the directory C<path>. C<names> is the list of files "
27371 "from this directory."
27376 #: ../fish/guestfish-actions.pod:2551
27378 "This call is intended for programs that want to efficiently list a directory "
27379 "contents without making many round-trips. See also L</lxattrlist> for a "
27380 "similarly efficient call for getting extended attributes. Very long "
27381 "directory listings might cause the protocol message size to be exceeded, "
27382 "causing this call to fail. The caller must split up such requests into "
27383 "smaller groups of names."
27388 #: ../fish/guestfish-actions.pod:2559
27389 msgid "luks-add-key"
27394 #: ../fish/guestfish-actions.pod:2561
27397 " luks-add-key device keyslot\n"
27403 #: ../fish/guestfish-actions.pod:2568
27405 "Note that if C<keyslot> already contains a key, then this command will "
27406 "fail. You have to use L</luks-kill-slot> first to remove that key."
27411 #: ../fish/guestfish-actions.pod:2572 ../fish/guestfish-actions.pod:2594
27412 #: ../fish/guestfish-actions.pod:2607 ../fish/guestfish-actions.pod:2621
27413 #: ../fish/guestfish-actions.pod:2644 ../fish/guestfish-actions.pod:2654
27415 "This command has one or more key or passphrase parameters. Guestfish will "
27416 "prompt for these separately."
27421 #: ../fish/guestfish-actions.pod:2575
27427 #: ../fish/guestfish-actions.pod:2577
27430 " luks-close device\n"
27436 #: ../fish/guestfish-actions.pod:2579
27438 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27439 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27440 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27446 #: ../fish/guestfish-actions.pod:2585
27447 msgid "luks-format"
27452 #: ../fish/guestfish-actions.pod:2587
27455 " luks-format device keyslot\n"
27461 #: ../fish/guestfish-actions.pod:2600
27462 msgid "luks-format-cipher"
27467 #: ../fish/guestfish-actions.pod:2602
27470 " luks-format-cipher device keyslot cipher\n"
27476 #: ../fish/guestfish-actions.pod:2604
27478 "This command is the same as L</luks-format> but it also allows you to set "
27479 "the C<cipher> used."
27484 #: ../fish/guestfish-actions.pod:2613
27485 msgid "luks-kill-slot"
27490 #: ../fish/guestfish-actions.pod:2615
27493 " luks-kill-slot device keyslot\n"
27499 #: ../fish/guestfish-actions.pod:2624
27505 #: ../fish/guestfish-actions.pod:2626
27508 " luks-open device mapname\n"
27514 #: ../fish/guestfish-actions.pod:2640
27516 "If this block device contains LVM volume groups, then calling L</vgscan> "
27517 "followed by L</vg-activate-all> will make them visible."
27522 #: ../fish/guestfish-actions.pod:2647
27523 msgid "luks-open-ro"
27528 #: ../fish/guestfish-actions.pod:2649
27531 " luks-open-ro device mapname\n"
27537 #: ../fish/guestfish-actions.pod:2651
27539 "This is the same as L</luks-open> except that a read-only mapping is created."
27544 #: ../fish/guestfish-actions.pod:2657
27550 #: ../fish/guestfish-actions.pod:2659
27553 " lvcreate logvol volgroup mbytes\n"
27559 #: ../fish/guestfish-actions.pod:2664
27560 msgid "lvm-canonical-lv-name"
27565 #: ../fish/guestfish-actions.pod:2666
27568 " lvm-canonical-lv-name lvname\n"
27574 #: ../fish/guestfish-actions.pod:2675
27575 msgid "See also L</is-lv>."
27580 #: ../fish/guestfish-actions.pod:2677
27581 msgid "lvm-clear-filter"
27586 #: ../fish/guestfish-actions.pod:2679
27589 " lvm-clear-filter\n"
27595 #: ../fish/guestfish-actions.pod:2681
27597 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27603 #: ../fish/guestfish-actions.pod:2687
27604 msgid "lvm-remove-all"
27609 #: ../fish/guestfish-actions.pod:2689
27612 " lvm-remove-all\n"
27618 #: ../fish/guestfish-actions.pod:2697
27619 msgid "lvm-set-filter"
27624 #: ../fish/guestfish-actions.pod:2699
27627 " lvm-set-filter 'devices ...'\n"
27633 #: ../fish/guestfish-actions.pod:2724
27639 #: ../fish/guestfish-actions.pod:2726
27642 " lvremove device\n"
27648 #: ../fish/guestfish-actions.pod:2734
27654 #: ../fish/guestfish-actions.pod:2736
27657 " lvrename logvol newlogvol\n"
27663 #: ../fish/guestfish-actions.pod:2740
27669 #: ../fish/guestfish-actions.pod:2742
27672 " lvresize device mbytes\n"
27678 #: ../fish/guestfish-actions.pod:2748
27679 msgid "lvresize-free"
27684 #: ../fish/guestfish-actions.pod:2750
27687 " lvresize-free lv percent\n"
27693 #: ../fish/guestfish-actions.pod:2758
27699 #: ../fish/guestfish-actions.pod:2760
27708 #: ../fish/guestfish-actions.pod:2768
27709 msgid "See also L</lvs-full>, L</list-filesystems>."
27714 #: ../fish/guestfish-actions.pod:2770
27720 #: ../fish/guestfish-actions.pod:2772
27729 #: ../fish/guestfish-actions.pod:2777
27735 #: ../fish/guestfish-actions.pod:2779
27744 #: ../fish/guestfish-actions.pod:2783
27750 #: ../fish/guestfish-actions.pod:2785
27753 " lxattrlist path 'names ...'\n"
27759 #: ../fish/guestfish-actions.pod:2801
27761 "This call is intended for programs that want to efficiently list a directory "
27762 "contents without making many round-trips. See also L</lstatlist> for a "
27763 "similarly efficient call for getting standard stats. Very long directory "
27764 "listings might cause the protocol message size to be exceeded, causing this "
27765 "call to fail. The caller must split up such requests into smaller groups of "
27771 #: ../fish/guestfish-actions.pod:2809
27777 #: ../fish/guestfish-actions.pod:2811
27786 #: ../fish/guestfish-actions.pod:2815
27792 #: ../fish/guestfish-actions.pod:2817
27795 " mkdir-mode path mode\n"
27801 #: ../fish/guestfish-actions.pod:2826
27802 msgid "See also L</mkdir>, L</umask>"
27807 #: ../fish/guestfish-actions.pod:2828
27813 #: ../fish/guestfish-actions.pod:2830
27822 #: ../fish/guestfish-actions.pod:2835
27828 #: ../fish/guestfish-actions.pod:2837
27831 " mkdtemp template\n"
27837 #: ../fish/guestfish-actions.pod:2858
27843 #: ../fish/guestfish-actions.pod:2860
27846 " mke2fs-J fstype blocksize device journal\n"
27852 #: ../fish/guestfish-actions.pod:2868
27853 msgid "See also L</mke2journal>."
27858 #: ../fish/guestfish-actions.pod:2870
27864 #: ../fish/guestfish-actions.pod:2872
27867 " mke2fs-JL fstype blocksize device label\n"
27873 #: ../fish/guestfish-actions.pod:2877
27874 msgid "See also L</mke2journal-L>."
27879 #: ../fish/guestfish-actions.pod:2879
27885 #: ../fish/guestfish-actions.pod:2881
27888 " mke2fs-JU fstype blocksize device uuid\n"
27894 #: ../fish/guestfish-actions.pod:2886
27895 msgid "See also L</mke2journal-U>."
27900 #: ../fish/guestfish-actions.pod:2888
27901 msgid "mke2journal"
27906 #: ../fish/guestfish-actions.pod:2890
27909 " mke2journal blocksize device\n"
27915 #: ../fish/guestfish-actions.pod:2897
27916 msgid "mke2journal-L"
27921 #: ../fish/guestfish-actions.pod:2899
27924 " mke2journal-L blocksize label device\n"
27930 #: ../fish/guestfish-actions.pod:2903
27931 msgid "mke2journal-U"
27936 #: ../fish/guestfish-actions.pod:2905
27939 " mke2journal-U blocksize uuid device\n"
27945 #: ../fish/guestfish-actions.pod:2909
27951 #: ../fish/guestfish-actions.pod:2911
27954 " mkfifo mode path\n"
27960 #: ../fish/guestfish-actions.pod:2913
27962 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
27963 "is just a convenient wrapper around L</mknod>."
27968 #: ../fish/guestfish-actions.pod:2919
27974 #: ../fish/guestfish-actions.pod:2921
27977 " mkfs fstype device\n"
27983 #: ../fish/guestfish-actions.pod:2927
27989 #: ../fish/guestfish-actions.pod:2929
27992 " mkfs-b fstype blocksize device\n"
27998 #: ../fish/guestfish-actions.pod:2931
28000 "This call is similar to L</mkfs>, but it allows you to control the block "
28001 "size of the resulting filesystem. Supported block sizes depend on the "
28002 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
28007 #: ../fish/guestfish-actions.pod:2946
28012 #: ../fish/guestfish-actions.pod:2948
28015 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28021 #: ../fish/guestfish-actions.pod:2983
28022 msgid "mkmountpoint"
28027 #: ../fish/guestfish-actions.pod:2985
28030 " mkmountpoint exemptpath\n"
28036 #: ../fish/guestfish-actions.pod:2987
28038 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28039 "to create extra mountpoints before mounting the first filesystem."
28044 #: ../fish/guestfish-actions.pod:3011
28046 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28047 "unexpected errors if you try to mix these calls. It is safest to manually "
28048 "unmount filesystems and remove mountpoints after use."
28053 #: ../fish/guestfish-actions.pod:3015
28055 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28056 "for this to work for manual mountpoints, you must ensure that the innermost "
28057 "mountpoints have the longest pathnames, as in the example code above."
28061 #: ../fish/guestfish-actions.pod:3022
28063 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28064 "L</umount-all> to be called when the handle is closed which can also trigger "
28070 #: ../fish/guestfish-actions.pod:3026
28076 #: ../fish/guestfish-actions.pod:3028
28079 " mknod mode devmajor devminor path\n"
28085 #: ../fish/guestfish-actions.pod:3038
28087 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28088 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28089 "regular file). These constants are available in the standard Linux header "
28090 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28091 "wrappers around this command which bitwise OR in the appropriate constant "
28097 #: ../fish/guestfish-actions.pod:3048
28103 #: ../fish/guestfish-actions.pod:3050
28106 " mknod-b mode devmajor devminor path\n"
28112 #: ../fish/guestfish-actions.pod:3052
28114 "This call creates a block device node called C<path> with mode C<mode> and "
28115 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28116 "wrapper around L</mknod>."
28121 #: ../fish/guestfish-actions.pod:3058
28127 #: ../fish/guestfish-actions.pod:3060
28130 " mknod-c mode devmajor devminor path\n"
28136 #: ../fish/guestfish-actions.pod:3062
28138 "This call creates a char device node called C<path> with mode C<mode> and "
28139 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28140 "wrapper around L</mknod>."
28145 #: ../fish/guestfish-actions.pod:3068
28151 #: ../fish/guestfish-actions.pod:3070
28160 #: ../fish/guestfish-actions.pod:3074
28166 #: ../fish/guestfish-actions.pod:3076
28169 " mkswap-L label device\n"
28175 #: ../fish/guestfish-actions.pod:3084
28181 #: ../fish/guestfish-actions.pod:3086
28184 " mkswap-U uuid device\n"
28190 #: ../fish/guestfish-actions.pod:3090
28191 msgid "mkswap-file"
28196 #: ../fish/guestfish-actions.pod:3092
28199 " mkswap-file path\n"
28205 #: ../fish/guestfish-actions.pod:3096
28207 "This command just writes a swap file signature to an existing file. To "
28208 "create the file itself, use something like L</fallocate>."
28213 #: ../fish/guestfish-actions.pod:3099
28219 #: ../fish/guestfish-actions.pod:3101
28222 " modprobe modulename\n"
28228 #: ../fish/guestfish-actions.pod:3108
28234 #: ../fish/guestfish-actions.pod:3110
28237 " mount device mountpoint\n"
28243 #: ../fish/guestfish-actions.pod:3126
28245 "B<Important note:> When you use this call, the filesystem options C<sync> "
28246 "and C<noatime> are set implicitly. This was originally done because we "
28247 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28248 "very large negative performance impact and negligible effect on "
28249 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28250 "code that needs performance, and instead use L</mount-options> (use an empty "
28251 "string for the first parameter if you don't want any options)."
28256 #: ../fish/guestfish-actions.pod:3136
28262 #: ../fish/guestfish-actions.pod:3138
28265 " mount-loop file mountpoint\n"
28271 #: ../fish/guestfish-actions.pod:3144
28272 msgid "mount-options"
28277 #: ../fish/guestfish-actions.pod:3146
28280 " mount-options options device mountpoint\n"
28286 #: ../fish/guestfish-actions.pod:3148
28288 "This is the same as the L</mount> command, but it allows you to set the "
28289 "mount options as for the L<mount(8)> I<-o> flag."
28294 #: ../fish/guestfish-actions.pod:3156
28300 #: ../fish/guestfish-actions.pod:3158
28303 " mount-ro device mountpoint\n"
28309 #: ../fish/guestfish-actions.pod:3160
28311 "This is the same as the L</mount> command, but it mounts the filesystem with "
28312 "the read-only (I<-o ro>) flag."
28317 #: ../fish/guestfish-actions.pod:3163
28323 #: ../fish/guestfish-actions.pod:3165
28326 " mount-vfs options vfstype device mountpoint\n"
28332 #: ../fish/guestfish-actions.pod:3167
28334 "This is the same as the L</mount> command, but it allows you to set both the "
28335 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28340 #: ../fish/guestfish-actions.pod:3171
28341 msgid "mountpoints"
28346 #: ../fish/guestfish-actions.pod:3173
28355 #: ../fish/guestfish-actions.pod:3175
28357 "This call is similar to L</mounts>. That call returns a list of devices. "
28358 "This one returns a hash table (map) of device name to directory where the "
28359 "device is mounted."
28364 #: ../fish/guestfish-actions.pod:3179
28370 #: ../fish/guestfish-actions.pod:3181
28379 #: ../fish/guestfish-actions.pod:3188
28380 msgid "See also: L</mountpoints>"
28385 #: ../fish/guestfish-actions.pod:3190
28391 #: ../fish/guestfish-actions.pod:3192
28400 #: ../fish/guestfish-actions.pod:3197
28401 msgid "ntfs-3g-probe"
28406 #: ../fish/guestfish-actions.pod:3199
28409 " ntfs-3g-probe true|false device\n"
28415 #: ../fish/guestfish-actions.pod:3213
28421 #: ../fish/guestfish-actions.pod:3215
28424 " ntfsresize device\n"
28430 #: ../fish/guestfish-actions.pod:3221
28431 msgid "ntfsresize-size"
28436 #: ../fish/guestfish-actions.pod:3223
28439 " ntfsresize-size device size\n"
28445 #: ../fish/guestfish-actions.pod:3225
28447 "This command is the same as L</ntfsresize> except that it allows you to "
28448 "specify the new size (in bytes) explicitly."
28453 #: ../fish/guestfish-actions.pod:3228
28459 #: ../fish/guestfish-actions.pod:3230
28462 " part-add device prlogex startsect endsect\n"
28468 #: ../fish/guestfish-actions.pod:3232
28470 "This command adds a partition to C<device>. If there is no partition table "
28471 "on the device, call L</part-init> first."
28476 #: ../fish/guestfish-actions.pod:3244
28478 "Creating a partition which covers the whole disk is not so easy. Use L</"
28479 "part-disk> to do that."
28484 #: ../fish/guestfish-actions.pod:3247
28490 #: ../fish/guestfish-actions.pod:3249
28493 " part-del device partnum\n"
28499 #: ../fish/guestfish-actions.pod:3257
28505 #: ../fish/guestfish-actions.pod:3259
28508 " part-disk device parttype\n"
28514 #: ../fish/guestfish-actions.pod:3261
28516 "This command is simply a combination of L</part-init> followed by L</part-"
28517 "add> to create a single primary partition covering the whole disk."
28522 #: ../fish/guestfish-actions.pod:3265
28524 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28525 "possible values are described in L</part-init>."
28530 #: ../fish/guestfish-actions.pod:3271
28531 msgid "part-get-bootable"
28536 #: ../fish/guestfish-actions.pod:3273
28539 " part-get-bootable device partnum\n"
28545 #: ../fish/guestfish-actions.pod:3278
28546 msgid "See also L</part-set-bootable>."
28551 #: ../fish/guestfish-actions.pod:3280
28552 msgid "part-get-mbr-id"
28557 #: ../fish/guestfish-actions.pod:3282
28560 " part-get-mbr-id device partnum\n"
28566 #: ../fish/guestfish-actions.pod:3287 ../fish/guestfish-actions.pod:3425
28568 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28569 "undefined results for other partition table types (see L</part-get-"
28575 #: ../fish/guestfish-actions.pod:3291
28576 msgid "part-get-parttype"
28581 #: ../fish/guestfish-actions.pod:3293
28584 " part-get-parttype device\n"
28590 #: ../fish/guestfish-actions.pod:3298
28592 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28593 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28594 "possible, although unusual. See L</part-init> for a full list."
28599 #: ../fish/guestfish-actions.pod:3303
28605 #: ../fish/guestfish-actions.pod:3305
28608 " part-init device parttype\n"
28614 #: ../fish/guestfish-actions.pod:3311
28616 "Initially there are no partitions. Following this, you should call L</part-"
28617 "add> for each partition required."
28622 #: ../fish/guestfish-actions.pod:3374
28628 #: ../fish/guestfish-actions.pod:3376
28631 " part-list device\n"
28637 #: ../fish/guestfish-actions.pod:3391
28639 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28640 "the device's sector size, see L</blockdev-getss>."
28645 #: ../fish/guestfish-actions.pod:3404
28646 msgid "part-set-bootable"
28651 #: ../fish/guestfish-actions.pod:3406
28654 " part-set-bootable device partnum true|false\n"
28660 #: ../fish/guestfish-actions.pod:3415
28661 msgid "part-set-mbr-id"
28666 #: ../fish/guestfish-actions.pod:3417
28669 " part-set-mbr-id device partnum idbyte\n"
28675 #: ../fish/guestfish-actions.pod:3429
28676 msgid "part-set-name"
28681 #: ../fish/guestfish-actions.pod:3431
28684 " part-set-name device partnum name\n"
28690 #: ../fish/guestfish-actions.pod:3439
28691 msgid "part-to-dev"
28696 #: ../fish/guestfish-actions.pod:3441
28699 " part-to-dev partition\n"
28705 #: ../fish/guestfish-actions.pod:3447
28707 "The named partition must exist, for example as a string returned from L</"
28708 "list-partitions>."
28713 #: ../fish/guestfish-actions.pod:3450
28714 msgid "ping-daemon"
28719 #: ../fish/guestfish-actions.pod:3452
28728 #: ../fish/guestfish-actions.pod:3459
28734 #: ../fish/guestfish-actions.pod:3461
28737 " pread path count offset\n"
28743 #: ../fish/guestfish-actions.pod:3469
28744 msgid "See also L</pwrite>, L</pread-device>."
28749 #: ../fish/guestfish-actions.pod:3474
28750 msgid "pread-device"
28755 #: ../fish/guestfish-actions.pod:3476
28758 " pread-device device count offset\n"
28764 #: ../fish/guestfish-actions.pod:3484
28765 msgid "See also L</pread>."
28770 #: ../fish/guestfish-actions.pod:3489
28776 #: ../fish/guestfish-actions.pod:3491
28779 " pvcreate device\n"
28785 #: ../fish/guestfish-actions.pod:3497
28791 #: ../fish/guestfish-actions.pod:3499
28794 " pvremove device\n"
28800 #: ../fish/guestfish-actions.pod:3508
28806 #: ../fish/guestfish-actions.pod:3510
28809 " pvresize device\n"
28815 #: ../fish/guestfish-actions.pod:3515
28816 msgid "pvresize-size"
28821 #: ../fish/guestfish-actions.pod:3517
28824 " pvresize-size device size\n"
28830 #: ../fish/guestfish-actions.pod:3519
28832 "This command is the same as L</pvresize> except that it allows you to "
28833 "specify the new size (in bytes) explicitly."
28838 #: ../fish/guestfish-actions.pod:3522
28844 #: ../fish/guestfish-actions.pod:3524
28853 #: ../fish/guestfish-actions.pod:3532
28854 msgid "See also L</pvs-full>."
28859 #: ../fish/guestfish-actions.pod:3534
28865 #: ../fish/guestfish-actions.pod:3536
28874 #: ../fish/guestfish-actions.pod:3541
28880 #: ../fish/guestfish-actions.pod:3543
28889 #: ../fish/guestfish-actions.pod:3547
28895 #: ../fish/guestfish-actions.pod:3549
28898 " pwrite path content offset\n"
28904 #: ../fish/guestfish-actions.pod:3560
28905 msgid "See also L</pread>, L</pwrite-device>."
28910 #: ../fish/guestfish-actions.pod:3565
28911 msgid "pwrite-device"
28916 #: ../fish/guestfish-actions.pod:3567
28919 " pwrite-device device content offset\n"
28925 #: ../fish/guestfish-actions.pod:3577
28926 msgid "See also L</pwrite>."
28931 #: ../fish/guestfish-actions.pod:3582
28937 #: ../fish/guestfish-actions.pod:3584
28940 " read-file path\n"
28946 #: ../fish/guestfish-actions.pod:3589
28948 "Unlike L</cat>, this function can correctly handle files that contain "
28949 "embedded ASCII NUL characters. However unlike L</download>, this function "
28950 "is limited in the total size of file that can be handled."
28955 #: ../fish/guestfish-actions.pod:3597
28961 #: ../fish/guestfish-actions.pod:3599
28964 " read-lines path\n"
28970 #: ../fish/guestfish-actions.pod:3606
28972 "Note that this function cannot correctly handle binary files (specifically, "
28973 "files containing C<\\0> character which is treated as end of line). For "
28974 "those you need to use the L</read-file> function which has a more complex "
28980 #: ../fish/guestfish-actions.pod:3611
28986 #: ../fish/guestfish-actions.pod:3613
28995 #: ../fish/guestfish-actions.pod:3665
28997 "This function is primarily intended for use by programs. To get a simple "
28998 "list of names, use L</ls>. To get a printable directory for human "
28999 "consumption, use L</ll>."
29004 #: ../fish/guestfish-actions.pod:3669
29010 #: ../fish/guestfish-actions.pod:3671
29019 #: ../fish/guestfish-actions.pod:3675
29020 msgid "readlinklist"
29025 #: ../fish/guestfish-actions.pod:3677
29028 " readlinklist path 'names ...'\n"
29034 #: ../fish/guestfish-actions.pod:3701
29040 #: ../fish/guestfish-actions.pod:3703
29049 #: ../fish/guestfish-actions.pod:3708
29050 msgid "removexattr"
29055 #: ../fish/guestfish-actions.pod:3710
29058 " removexattr xattr path\n"
29064 #: ../fish/guestfish-actions.pod:3715
29065 msgid "See also: L</lremovexattr>, L<attr(5)>."
29070 #: ../fish/guestfish-actions.pod:3717
29076 #: ../fish/guestfish-actions.pod:3719
29079 " resize2fs device\n"
29085 #: ../fish/guestfish-actions.pod:3724
29087 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29088 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29089 "gives an error about this and sometimes not. In any case, it is always safe "
29090 "to call L</e2fsck-f> before calling this function."
29094 #: ../fish/guestfish-actions.pod:3730
29095 msgid "resize2fs-M"
29099 #: ../fish/guestfish-actions.pod:3732
29102 " resize2fs-M device\n"
29107 #: ../fish/guestfish-actions.pod:3734
29109 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29110 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
29115 #: ../fish/guestfish-actions.pod:3738
29117 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29118 "and read the C<Block size> and C<Block count> values. These two numbers, "
29119 "multiplied together, give the resulting size of the minimal filesystem in "
29125 #: ../fish/guestfish-actions.pod:3743
29126 msgid "resize2fs-size"
29131 #: ../fish/guestfish-actions.pod:3745
29134 " resize2fs-size device size\n"
29140 #: ../fish/guestfish-actions.pod:3747
29142 "This command is the same as L</resize2fs> except that it allows you to "
29143 "specify the new size (in bytes) explicitly."
29148 #: ../fish/guestfish-actions.pod:3750
29154 #: ../fish/guestfish-actions.pod:3752
29163 #: ../fish/guestfish-actions.pod:3756
29169 #: ../fish/guestfish-actions.pod:3758
29178 #: ../fish/guestfish-actions.pod:3764
29184 #: ../fish/guestfish-actions.pod:3766
29193 #: ../fish/guestfish-actions.pod:3770
29194 msgid "rmmountpoint"
29199 #: ../fish/guestfish-actions.pod:3772
29202 " rmmountpoint exemptpath\n"
29208 #: ../fish/guestfish-actions.pod:3774
29210 "This calls removes a mountpoint that was previously created with L</"
29211 "mkmountpoint>. See L</mkmountpoint> for full details."
29216 #: ../fish/guestfish-actions.pod:3778
29217 msgid "scrub-device"
29222 #: ../fish/guestfish-actions.pod:3780
29225 " scrub-device device\n"
29231 #: ../fish/guestfish-actions.pod:3791
29237 #: ../fish/guestfish-actions.pod:3793
29240 " scrub-file file\n"
29246 #: ../fish/guestfish-actions.pod:3803
29247 msgid "scrub-freespace"
29252 #: ../fish/guestfish-actions.pod:3805
29255 " scrub-freespace dir\n"
29261 #: ../fish/guestfish-actions.pod:3807
29263 "This command creates the directory C<dir> and then fills it with files until "
29264 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29265 "deletes them. The intention is to scrub any free space on the partition "
29266 "containing C<dir>."
29271 #: ../fish/guestfish-actions.pod:3816
29277 #: ../fish/guestfish-actions.pod:3818
29283 #: ../fish/guestfish-actions.pod:3820
29286 " set-append append\n"
29291 #: ../fish/guestfish-actions.pod:3831
29292 msgid "set-attach-method"
29296 #: ../fish/guestfish-actions.pod:3833
29297 msgid "attach-method"
29301 #: ../fish/guestfish-actions.pod:3835
29304 " set-attach-method attachmethod\n"
29310 #: ../fish/guestfish-actions.pod:3857
29311 msgid "set-autosync"
29316 #: ../fish/guestfish-actions.pod:3859
29322 #: ../fish/guestfish-actions.pod:3861
29325 " set-autosync true|false\n"
29331 #: ../fish/guestfish-actions.pod:3871
29337 #: ../fish/guestfish-actions.pod:3873
29343 #: ../fish/guestfish-actions.pod:3875
29346 " set-direct true|false\n"
29352 #: ../fish/guestfish-actions.pod:3881
29354 "One consequence of this is that log messages aren't caught by the library "
29355 "and handled by L</set-log-message-callback>, but go straight to stdout."
29360 #: ../fish/guestfish-actions.pod:3890
29361 msgid "set-e2label"
29366 #: ../fish/guestfish-actions.pod:3892
29369 " set-e2label device label\n"
29375 #: ../fish/guestfish-actions.pod:3898
29377 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29378 "label on a filesystem."
29383 #: ../fish/guestfish-actions.pod:3901
29389 #: ../fish/guestfish-actions.pod:3903
29392 " set-e2uuid device uuid\n"
29398 #: ../fish/guestfish-actions.pod:3910
29400 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29401 "UUID of a filesystem."
29406 #: ../fish/guestfish-actions.pod:3913
29407 msgid "set-memsize"
29412 #: ../fish/guestfish-actions.pod:3915
29418 #: ../fish/guestfish-actions.pod:3917
29421 " set-memsize memsize\n"
29427 #: ../fish/guestfish-actions.pod:3919
29429 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29430 "This only has any effect if called before L</launch>."
29435 #: ../fish/guestfish-actions.pod:3930
29436 msgid "set-network"
29441 #: ../fish/guestfish-actions.pod:3932
29447 #: ../fish/guestfish-actions.pod:3934
29450 " set-network true|false\n"
29456 #: ../fish/guestfish-actions.pod:3942
29458 "You must call this before calling L</launch>, otherwise it has no effect."
29463 #: ../fish/guestfish-actions.pod:3945
29469 #: ../fish/guestfish-actions.pod:3947
29475 #: ../fish/guestfish-actions.pod:3949
29478 " set-path searchpath\n"
29484 #: ../fish/guestfish-actions.pod:3958
29490 #: ../fish/guestfish-actions.pod:3960
29496 #: ../fish/guestfish-actions.pod:3962
29505 #: ../fish/guestfish-actions.pod:3982
29506 msgid "set-recovery-proc"
29511 #: ../fish/guestfish-actions.pod:3984
29512 msgid "recovery-proc"
29517 #: ../fish/guestfish-actions.pod:3986
29520 " set-recovery-proc true|false\n"
29526 #: ../fish/guestfish-actions.pod:3988
29528 "If this is called with the parameter C<false> then L</launch> does not "
29529 "create a recovery process. The purpose of the recovery process is to stop "
29530 "runaway qemu processes in the case where the main program aborts abruptly."
29535 #: ../fish/guestfish-actions.pod:3993
29537 "This only has any effect if called before L</launch>, and the default is "
29543 #: ../fish/guestfish-actions.pod:4002
29544 msgid "set-selinux"
29549 #: ../fish/guestfish-actions.pod:4004
29555 #: ../fish/guestfish-actions.pod:4006
29558 " set-selinux true|false\n"
29564 #: ../fish/guestfish-actions.pod:4017
29570 #: ../fish/guestfish-actions.pod:4019
29576 #: ../fish/guestfish-actions.pod:4021
29579 " set-trace true|false\n"
29584 #: ../fish/guestfish-actions.pod:4033
29586 "Trace messages are normally sent to C<stderr>, unless you register a "
29587 "callback to send them somewhere else (see L</set-event-callback>)."
29592 #: ../fish/guestfish-actions.pod:4037
29593 msgid "set-verbose"
29598 #: ../fish/guestfish-actions.pod:4039
29604 #: ../fish/guestfish-actions.pod:4041
29607 " set-verbose true|false\n"
29612 #: ../fish/guestfish-actions.pod:4048
29614 "Verbose messages are normally sent to C<stderr>, unless you register a "
29615 "callback to send them somewhere else (see L</set-event-callback>)."
29620 #: ../fish/guestfish-actions.pod:4052
29626 #: ../fish/guestfish-actions.pod:4054
29629 " setcon context\n"
29635 #: ../fish/guestfish-actions.pod:4061
29641 #: ../fish/guestfish-actions.pod:4063
29644 " setxattr xattr val vallen path\n"
29650 #: ../fish/guestfish-actions.pod:4069
29651 msgid "See also: L</lsetxattr>, L<attr(5)>."
29656 #: ../fish/guestfish-actions.pod:4071
29662 #: ../fish/guestfish-actions.pod:4073
29665 " sfdisk device cyls heads sectors 'lines ...'\n"
29671 #: ../fish/guestfish-actions.pod:4095
29672 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
29677 #: ../fish/guestfish-actions.pod:4101
29683 #: ../fish/guestfish-actions.pod:4103
29686 " sfdiskM device 'lines ...'\n"
29692 #: ../fish/guestfish-actions.pod:4105
29694 "This is a simplified interface to the L</sfdisk> command, where partition "
29695 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
29696 "you don't need to specify the cyls, heads and sectors parameters which were "
29697 "rarely if ever used anyway."
29702 #: ../fish/guestfish-actions.pod:4111
29703 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
29708 #: ../fish/guestfish-actions.pod:4117
29714 #: ../fish/guestfish-actions.pod:4119
29717 " sfdisk-N device partnum cyls heads sectors line\n"
29723 #: ../fish/guestfish-actions.pod:4124
29725 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
29726 "cyls/heads/sectors parameters."
29731 #: ../fish/guestfish-actions.pod:4127
29732 msgid "See also: L</part-add>"
29737 #: ../fish/guestfish-actions.pod:4132
29738 msgid "sfdisk-disk-geometry"
29743 #: ../fish/guestfish-actions.pod:4134
29746 " sfdisk-disk-geometry device\n"
29752 #: ../fish/guestfish-actions.pod:4136
29754 "This displays the disk geometry of C<device> read from the partition table. "
29755 "Especially in the case where the underlying block device has been resized, "
29756 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
29757 "kernel-geometry>)."
29762 #: ../fish/guestfish-actions.pod:4144
29763 msgid "sfdisk-kernel-geometry"
29768 #: ../fish/guestfish-actions.pod:4146
29771 " sfdisk-kernel-geometry device\n"
29777 #: ../fish/guestfish-actions.pod:4153
29783 #: ../fish/guestfish-actions.pod:4155
29786 " sfdisk-l device\n"
29792 #: ../fish/guestfish-actions.pod:4161
29793 msgid "See also: L</part-list>"
29798 #: ../fish/guestfish-actions.pod:4163
29804 #: ../fish/guestfish-actions.pod:4165
29813 #: ../fish/guestfish-actions.pod:4170
29814 msgid "This is like L</command>, but passes the command to:"
29819 #: ../fish/guestfish-actions.pod:4178
29820 msgid "All the provisos about L</command> apply to this call."
29825 #: ../fish/guestfish-actions.pod:4180
29831 #: ../fish/guestfish-actions.pod:4182
29834 " sh-lines command\n"
29840 #: ../fish/guestfish-actions.pod:4184
29841 msgid "This is the same as L</sh>, but splits the result into a list of lines."
29846 #: ../fish/guestfish-actions.pod:4187
29847 msgid "See also: L</command-lines>"
29852 #: ../fish/guestfish-actions.pod:4189
29858 #: ../fish/guestfish-actions.pod:4191
29867 #: ../fish/guestfish-actions.pod:4195
29873 #: ../fish/guestfish-actions.pod:4197
29882 #: ../fish/guestfish-actions.pod:4203
29888 #: ../fish/guestfish-actions.pod:4205
29897 #: ../fish/guestfish-actions.pod:4213
29903 #: ../fish/guestfish-actions.pod:4215
29912 #: ../fish/guestfish-actions.pod:4223
29918 #: ../fish/guestfish-actions.pod:4225
29921 " strings-e encoding path\n"
29927 #: ../fish/guestfish-actions.pod:4227
29929 "This is like the L</strings> command, but allows you to specify the encoding "
29930 "of strings that are looked for in the source file C<path>."
29935 #: ../fish/guestfish-actions.pod:4237
29937 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29938 "ISO-8859-X (this is what L</strings> uses)."
29943 #: ../fish/guestfish-actions.pod:4269
29944 msgid "swapoff-device"
29949 #: ../fish/guestfish-actions.pod:4271
29952 " swapoff-device device\n"
29958 #: ../fish/guestfish-actions.pod:4273
29960 "This command disables the libguestfs appliance swap device or partition "
29961 "named C<device>. See L</swapon-device>."
29966 #: ../fish/guestfish-actions.pod:4277
29967 msgid "swapoff-file"
29972 #: ../fish/guestfish-actions.pod:4279
29975 " swapoff-file file\n"
29981 #: ../fish/guestfish-actions.pod:4283
29982 msgid "swapoff-label"
29987 #: ../fish/guestfish-actions.pod:4285
29990 " swapoff-label label\n"
29996 #: ../fish/guestfish-actions.pod:4290
29997 msgid "swapoff-uuid"
30002 #: ../fish/guestfish-actions.pod:4292
30005 " swapoff-uuid uuid\n"
30011 #: ../fish/guestfish-actions.pod:4297
30012 msgid "swapon-device"
30017 #: ../fish/guestfish-actions.pod:4299
30020 " swapon-device device\n"
30026 #: ../fish/guestfish-actions.pod:4301
30028 "This command enables the libguestfs appliance to use the swap device or "
30029 "partition named C<device>. The increased memory is made available for all "
30030 "commands, for example those run using L</command> or L</sh>."
30035 #: ../fish/guestfish-actions.pod:4313
30036 msgid "swapon-file"
30041 #: ../fish/guestfish-actions.pod:4315
30044 " swapon-file file\n"
30050 #: ../fish/guestfish-actions.pod:4317
30052 "This command enables swap to a file. See L</swapon-device> for other notes."
30057 #: ../fish/guestfish-actions.pod:4320
30058 msgid "swapon-label"
30063 #: ../fish/guestfish-actions.pod:4322
30066 " swapon-label label\n"
30072 #: ../fish/guestfish-actions.pod:4324
30074 "This command enables swap to a labeled swap partition. See L</swapon-"
30075 "device> for other notes."
30080 #: ../fish/guestfish-actions.pod:4327
30081 msgid "swapon-uuid"
30086 #: ../fish/guestfish-actions.pod:4329
30089 " swapon-uuid uuid\n"
30095 #: ../fish/guestfish-actions.pod:4331
30097 "This command enables swap to a swap partition with the given UUID. See L</"
30098 "swapon-device> for other notes."
30103 #: ../fish/guestfish-actions.pod:4334
30109 #: ../fish/guestfish-actions.pod:4336
30118 #: ../fish/guestfish-actions.pod:4344
30124 #: ../fish/guestfish-actions.pod:4346
30133 #: ../fish/guestfish-actions.pod:4354
30139 #: ../fish/guestfish-actions.pod:4356
30142 " tail-n nrlines path\n"
30148 #: ../fish/guestfish-actions.pod:4369
30154 #: ../fish/guestfish-actions.pod:4371
30157 " tar-in (tarfile|-) directory\n"
30163 #: ../fish/guestfish-actions.pod:4376
30164 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30169 #: ../fish/guestfish-actions.pod:4381
30175 #: ../fish/guestfish-actions.pod:4383
30178 " tar-out directory (tarfile|-)\n"
30184 #: ../fish/guestfish-actions.pod:4388
30185 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30190 #: ../fish/guestfish-actions.pod:4393
30196 #: ../fish/guestfish-actions.pod:4395
30199 " tgz-in (tarball|-) directory\n"
30205 #: ../fish/guestfish-actions.pod:4400
30206 msgid "To upload an uncompressed tarball, use L</tar-in>."
30211 #: ../fish/guestfish-actions.pod:4404
30217 #: ../fish/guestfish-actions.pod:4406
30220 " tgz-out directory (tarball|-)\n"
30226 #: ../fish/guestfish-actions.pod:4411
30227 msgid "To download an uncompressed tarball, use L</tar-out>."
30232 #: ../fish/guestfish-actions.pod:4415
30238 #: ../fish/guestfish-actions.pod:4417
30247 #: ../fish/guestfish-actions.pod:4426
30253 #: ../fish/guestfish-actions.pod:4428
30262 #: ../fish/guestfish-actions.pod:4433
30263 msgid "truncate-size"
30268 #: ../fish/guestfish-actions.pod:4435
30271 " truncate-size path size\n"
30277 #: ../fish/guestfish-actions.pod:4440
30279 "If the current file size is less than C<size> then the file is extended to "
30280 "the required size with zero bytes. This creates a sparse file (ie. disk "
30281 "blocks are not allocated for the file until you write to it). To create a "
30282 "non-sparse file of zeroes, use L</fallocate64> instead."
30287 #: ../fish/guestfish-actions.pod:4446
30293 #: ../fish/guestfish-actions.pod:4448
30296 " tune2fs-l device\n"
30302 #: ../fish/guestfish-actions.pod:4458
30308 #: ../fish/guestfish-actions.pod:4460
30311 " txz-in (tarball|-) directory\n"
30317 #: ../fish/guestfish-actions.pod:4467
30323 #: ../fish/guestfish-actions.pod:4469
30326 " txz-out directory (tarball|-)\n"
30332 #: ../fish/guestfish-actions.pod:4476
30338 #: ../fish/guestfish-actions.pod:4478
30347 #: ../fish/guestfish-actions.pod:4492
30348 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30353 #: ../fish/guestfish-actions.pod:4497
30359 #: ../fish/guestfish-actions.pod:4499
30365 #: ../fish/guestfish-actions.pod:4501
30368 " umount pathordevice\n"
30374 #: ../fish/guestfish-actions.pod:4507
30380 #: ../fish/guestfish-actions.pod:4509
30381 msgid "unmount-all"
30386 #: ../fish/guestfish-actions.pod:4511
30395 #: ../fish/guestfish-actions.pod:4517
30401 #: ../fish/guestfish-actions.pod:4519
30404 " upload (filename|-) remotefilename\n"
30410 #: ../fish/guestfish-actions.pod:4526
30411 msgid "See also L</download>."
30416 #: ../fish/guestfish-actions.pod:4530
30417 msgid "upload-offset"
30422 #: ../fish/guestfish-actions.pod:4532
30425 " upload-offset (filename|-) remotefilename offset\n"
30431 #: ../fish/guestfish-actions.pod:4544
30433 "Note that there is no limit on the amount of data that can be uploaded with "
30434 "this call, unlike with L</pwrite>, and this call always writes the full "
30435 "amount unless an error occurs."
30440 #: ../fish/guestfish-actions.pod:4549
30441 msgid "See also L</upload>, L</pwrite>."
30446 #: ../fish/guestfish-actions.pod:4553
30452 #: ../fish/guestfish-actions.pod:4555
30455 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30461 #: ../fish/guestfish-actions.pod:4574
30467 #: ../fish/guestfish-actions.pod:4576
30476 #: ../fish/guestfish-actions.pod:4603
30478 "I<Note:> Don't use this call to test for availability of features. In "
30479 "enterprise distributions we backport features from later versions into "
30480 "earlier versions, making this an unreliable way to test for features. Use "
30481 "L</available> instead."
30486 #: ../fish/guestfish-actions.pod:4609
30492 #: ../fish/guestfish-actions.pod:4611
30495 " vfs-label device\n"
30501 #: ../fish/guestfish-actions.pod:4618
30502 msgid "To find a filesystem from the label, use L</findfs-label>."
30507 #: ../fish/guestfish-actions.pod:4620
30513 #: ../fish/guestfish-actions.pod:4622
30516 " vfs-type device\n"
30522 #: ../fish/guestfish-actions.pod:4632
30528 #: ../fish/guestfish-actions.pod:4634
30531 " vfs-uuid device\n"
30537 #: ../fish/guestfish-actions.pod:4641
30538 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30543 #: ../fish/guestfish-actions.pod:4643
30544 msgid "vg-activate"
30549 #: ../fish/guestfish-actions.pod:4645
30552 " vg-activate true|false 'volgroups ...'\n"
30558 #: ../fish/guestfish-actions.pod:4658
30559 msgid "vg-activate-all"
30564 #: ../fish/guestfish-actions.pod:4660
30567 " vg-activate-all true|false\n"
30573 #: ../fish/guestfish-actions.pod:4670
30579 #: ../fish/guestfish-actions.pod:4672
30582 " vgcreate volgroup 'physvols ...'\n"
30588 #: ../fish/guestfish-actions.pod:4677
30594 #: ../fish/guestfish-actions.pod:4679
30597 " vglvuuids vgname\n"
30603 #: ../fish/guestfish-actions.pod:4684
30605 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30606 "logical volumes and volume groups."
30611 #: ../fish/guestfish-actions.pod:4687
30612 msgid "See also L</vgpvuuids>."
30617 #: ../fish/guestfish-actions.pod:4689
30623 #: ../fish/guestfish-actions.pod:4691
30626 " vgpvuuids vgname\n"
30632 #: ../fish/guestfish-actions.pod:4696
30634 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30635 "physical volumes and volume groups."
30640 #: ../fish/guestfish-actions.pod:4699
30641 msgid "See also L</vglvuuids>."
30646 #: ../fish/guestfish-actions.pod:4701
30652 #: ../fish/guestfish-actions.pod:4703
30655 " vgremove vgname\n"
30661 #: ../fish/guestfish-actions.pod:4710
30667 #: ../fish/guestfish-actions.pod:4712
30670 " vgrename volgroup newvolgroup\n"
30676 #: ../fish/guestfish-actions.pod:4716
30682 #: ../fish/guestfish-actions.pod:4718
30691 #: ../fish/guestfish-actions.pod:4726
30692 msgid "See also L</vgs-full>."
30697 #: ../fish/guestfish-actions.pod:4728
30703 #: ../fish/guestfish-actions.pod:4730
30712 #: ../fish/guestfish-actions.pod:4735
30718 #: ../fish/guestfish-actions.pod:4737
30727 #: ../fish/guestfish-actions.pod:4742
30733 #: ../fish/guestfish-actions.pod:4744
30742 #: ../fish/guestfish-actions.pod:4748
30748 #: ../fish/guestfish-actions.pod:4750
30757 #: ../fish/guestfish-actions.pod:4755
30763 #: ../fish/guestfish-actions.pod:4757
30772 #: ../fish/guestfish-actions.pod:4762
30778 #: ../fish/guestfish-actions.pod:4764
30787 #: ../fish/guestfish-actions.pod:4769
30793 #: ../fish/guestfish-actions.pod:4771
30796 " write path content\n"
30802 #: ../fish/guestfish-actions.pod:4779
30808 #: ../fish/guestfish-actions.pod:4781
30811 " write-file path content size\n"
30817 #: ../fish/guestfish-actions.pod:4804
30823 #: ../fish/guestfish-actions.pod:4806
30826 " zegrep regex path\n"
30832 #: ../fish/guestfish-actions.pod:4814
30838 #: ../fish/guestfish-actions.pod:4816
30841 " zegrepi regex path\n"
30847 #: ../fish/guestfish-actions.pod:4824
30853 #: ../fish/guestfish-actions.pod:4826
30862 #: ../fish/guestfish-actions.pod:4834
30863 msgid "See also: L</zero-device>, L</scrub-device>."
30868 #: ../fish/guestfish-actions.pod:4836
30869 msgid "zero-device"
30874 #: ../fish/guestfish-actions.pod:4838
30877 " zero-device device\n"
30883 #: ../fish/guestfish-actions.pod:4840
30885 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
30886 "which just zeroes the first few blocks of a device."
30891 #: ../fish/guestfish-actions.pod:4847
30897 #: ../fish/guestfish-actions.pod:4849
30900 " zerofree device\n"
30906 #: ../fish/guestfish-actions.pod:4862
30912 #: ../fish/guestfish-actions.pod:4864
30915 " zfgrep pattern path\n"
30921 #: ../fish/guestfish-actions.pod:4872
30927 #: ../fish/guestfish-actions.pod:4874
30930 " zfgrepi pattern path\n"
30936 #: ../fish/guestfish-actions.pod:4882
30942 #: ../fish/guestfish-actions.pod:4884
30945 " zfile meth path\n"
30951 #: ../fish/guestfish-actions.pod:4891
30953 "Since 1.0.63, use L</file> instead which can now process compressed files."
30958 #: ../fish/guestfish-actions.pod:4901
30964 #: ../fish/guestfish-actions.pod:4903
30967 " zgrep regex path\n"
30973 #: ../fish/guestfish-actions.pod:4911
30979 #: ../fish/guestfish-actions.pod:4913
30982 " zgrepi regex path\n"
30988 #: ../fish/guestfish-commands.pod:1
30994 #: ../fish/guestfish-commands.pod:3
31000 #: ../fish/guestfish-commands.pod:5
31003 " alloc filename size\n"
31009 #: ../fish/guestfish-commands.pod:7
31011 "This creates an empty (zeroed) file of the given size, and then adds so it "
31012 "can be further examined."
31017 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
31018 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31023 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31024 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31029 #: ../fish/guestfish-commands.pod:14
31031 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31032 "image, see L</PREPARED DISK IMAGES>."
31037 #: ../fish/guestfish-commands.pod:17
31043 #: ../fish/guestfish-commands.pod:19
31046 " copy-in local [local ...] /remotedir\n"
31052 #: ../fish/guestfish-commands.pod:21
31054 "C<copy-in> copies local files or directories recursively into the disk "
31055 "image, placing them in the directory called C</remotedir> (which must "
31056 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31057 "other commands as necessary."
31062 #: ../fish/guestfish-commands.pod:26
31064 "Multiple local files and directories can be specified, but the last "
31065 "parameter must always be a remote directory. Wildcards cannot be used."
31070 #: ../fish/guestfish-commands.pod:30
31076 #: ../fish/guestfish-commands.pod:32
31079 " copy-out remote [remote ...] localdir\n"
31085 #: ../fish/guestfish-commands.pod:34
31087 "C<copy-out> copies remote files or directories recursively out of the disk "
31088 "image, placing them on the host disk in a local directory called C<localdir> "
31089 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31090 "download>, L</tar-out> and other commands as necessary."
31095 #: ../fish/guestfish-commands.pod:40
31097 "Multiple remote files and directories can be specified, but the last "
31098 "parameter must always be a local directory. To download to the current "
31099 "directory, use C<.> as in:"
31104 #: ../fish/guestfish-commands.pod:44
31107 " copy-out /home .\n"
31113 #: ../fish/guestfish-commands.pod:46
31115 "Wildcards cannot be used in the ordinary command, but you can use them with "
31116 "the help of L</glob> like this:"
31121 #: ../fish/guestfish-commands.pod:49
31124 " glob copy-out /home/* .\n"
31130 #: ../fish/guestfish-commands.pod:51
31136 #: ../fish/guestfish-commands.pod:53
31139 " echo [params ...]\n"
31145 #: ../fish/guestfish-commands.pod:55
31146 msgid "This echos the parameters to the terminal."
31151 #: ../fish/guestfish-commands.pod:57
31157 #: ../fish/guestfish-commands.pod:59
31163 #: ../fish/guestfish-commands.pod:61
31169 #: ../fish/guestfish-commands.pod:63
31178 #: ../fish/guestfish-commands.pod:65
31180 "This is used to edit a file. It downloads the file, edits it locally using "
31181 "your editor, then uploads the result."
31186 #: ../fish/guestfish-commands.pod:68
31188 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31189 "or C<emacs> you will get those corresponding editors."
31194 #: ../fish/guestfish-commands.pod:72
31200 #: ../fish/guestfish-commands.pod:74
31203 " glob command args...\n"
31209 #: ../fish/guestfish-commands.pod:76
31211 "Expand wildcards in any paths in the args list, and run C<command> "
31212 "repeatedly on each matching path."
31217 #: ../fish/guestfish-commands.pod:79
31218 msgid "See L</WILDCARDS AND GLOBBING>."
31223 #: ../fish/guestfish-commands.pod:81
31229 #: ../fish/guestfish-commands.pod:83
31232 " hexedit <filename|device>\n"
31233 " hexedit <filename|device> <max>\n"
31234 " hexedit <filename|device> <start> <max>\n"
31240 #: ../fish/guestfish-commands.pod:87
31242 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31248 #: ../fish/guestfish-commands.pod:90
31250 "This command works by downloading potentially the whole file or device, "
31251 "editing it locally, then uploading it. If the file or device is large, you "
31252 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31253 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31254 "usual modifiers allowed such as C<1M> (1 megabyte)."
31259 #: ../fish/guestfish-commands.pod:97
31260 msgid "For example to edit the first few sectors of a disk you might do:"
31265 #: ../fish/guestfish-commands.pod:100
31268 " hexedit /dev/sda 1M\n"
31274 #: ../fish/guestfish-commands.pod:102
31276 "which would allow you to edit anywhere within the first megabyte of the disk."
31281 #: ../fish/guestfish-commands.pod:105
31282 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31287 #: ../fish/guestfish-commands.pod:107
31290 " hexedit /dev/sda1 0x400 0x400\n"
31296 #: ../fish/guestfish-commands.pod:109
31297 msgid "(assuming the superblock is in the standard location)."
31302 #: ../fish/guestfish-commands.pod:111
31304 "This command requires the external L<hexedit(1)> program. You can specify "
31305 "another program to use by setting the C<HEXEDITOR> environment variable."
31310 #: ../fish/guestfish-commands.pod:115
31311 msgid "See also L</hexdump>."
31316 #: ../fish/guestfish-commands.pod:117
31322 #: ../fish/guestfish-commands.pod:119
31331 #: ../fish/guestfish-commands.pod:121
31333 "Change the local directory, ie. the current directory of guestfish itself."
31338 #: ../fish/guestfish-commands.pod:124
31339 msgid "Note that C<!cd> won't do what you might expect."
31344 #: ../fish/guestfish-commands.pod:126
31350 #: ../fish/guestfish-commands.pod:128
31356 #: ../fish/guestfish-commands.pod:130
31365 #: ../fish/guestfish-commands.pod:132
31366 msgid "Opens the manual page for guestfish."
31371 #: ../fish/guestfish-commands.pod:134
31377 #: ../fish/guestfish-commands.pod:136
31383 #: ../fish/guestfish-commands.pod:138
31392 #: ../fish/guestfish-commands.pod:140
31401 #: ../fish/guestfish-commands.pod:142
31402 msgid "This is used to view a file."
31407 #: ../fish/guestfish-commands.pod:144
31409 "The default viewer is C<$PAGER>. However if you use the alternate command "
31410 "C<less> you will get the C<less> command specifically."
31415 #: ../fish/guestfish-commands.pod:147
31421 #: ../fish/guestfish-commands.pod:149
31430 #: ../fish/guestfish-commands.pod:151
31432 "Close and reopen the libguestfs handle. It is not necessary to use this "
31433 "normally, because the handle is closed properly when guestfish exits. "
31434 "However this is occasionally useful for testing."
31439 #: ../fish/guestfish-commands.pod:155
31445 #: ../fish/guestfish-commands.pod:157
31448 " sparse filename size\n"
31454 #: ../fish/guestfish-commands.pod:159
31456 "This creates an empty sparse file of the given size, and then adds so it can "
31457 "be further examined."
31462 #: ../fish/guestfish-commands.pod:162
31464 "In all respects it works the same as the L</alloc> command, except that the "
31465 "image file is allocated sparsely, which means that disk blocks are not "
31466 "assigned to the file until they are needed. Sparse disk files only use "
31467 "space when written to, but they are slower and there is a danger you could "
31468 "run out of real disk space during a write operation."
31473 #: ../fish/guestfish-commands.pod:172
31479 #: ../fish/guestfish-commands.pod:174
31488 #: ../fish/guestfish-commands.pod:176
31490 "This command returns a list of the optional groups known to the daemon, and "
31491 "indicates which ones are supported by this build of the libguestfs appliance."
31496 #: ../fish/guestfish-commands.pod:180
31497 msgid "See also L<guestfs(3)/AVAILABILITY>."
31502 #: ../fish/guestfish-commands.pod:182
31508 #: ../fish/guestfish-commands.pod:184
31511 " time command args...\n"
31517 #: ../fish/guestfish-commands.pod:186
31519 "Run the command as usual, but print the elapsed time afterwards. This can "
31520 "be useful for benchmarking operations."
31525 #: ../test-tool/libguestfs-test-tool.pod:5
31526 msgid "libguestfs-test-tool - End user tests for libguestfs"
31531 #: ../test-tool/libguestfs-test-tool.pod:9
31534 " libguestfs-test-tool [--options]\n"
31540 #: ../test-tool/libguestfs-test-tool.pod:13
31542 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31543 "and developers, to allow them to check basic libguestfs functionality is "
31544 "working. This is needed because libguestfs occasionally breaks for reasons "
31545 "beyond our control: usually because of changes in the underlying qemu or "
31546 "kernel packages, or the host environment."
31551 #: ../test-tool/libguestfs-test-tool.pod:20
31552 msgid "If you suspect a problem in libguestfs, then just run:"
31557 #: ../test-tool/libguestfs-test-tool.pod:22
31560 " libguestfs-test-tool\n"
31566 #: ../test-tool/libguestfs-test-tool.pod:24
31567 msgid "It will print lots of diagnostic messages."
31572 #: ../test-tool/libguestfs-test-tool.pod:26
31573 msgid "If it runs to completion successfully, you will see this near the end:"
31578 #: ../test-tool/libguestfs-test-tool.pod:28
31581 " ===== TEST FINISHED OK =====\n"
31587 #: ../test-tool/libguestfs-test-tool.pod:30
31588 msgid "and the test tool will exit with code 0."
31593 #: ../test-tool/libguestfs-test-tool.pod:32
31595 "If it fails (and/or exits with non-zero error code), please paste the "
31596 "B<complete, unedited> output of the test tool into a bug report. More "
31597 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31603 #: ../test-tool/libguestfs-test-tool.pod:41
31609 #: ../test-tool/libguestfs-test-tool.pod:43
31610 msgid "Display short usage information and exit."
31615 #: ../test-tool/libguestfs-test-tool.pod:45
31616 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
31621 #: ../test-tool/libguestfs-test-tool.pod:47
31623 "Pass an alternate name for the helper program. libguestfs-test-tool will "
31624 "normally look in the C<$libexec> directory that was configured when the tool "
31630 #: ../test-tool/libguestfs-test-tool.pod:51
31631 msgid "I<--qemu qemu_binary>"
31636 #: ../test-tool/libguestfs-test-tool.pod:53
31638 "If you have downloaded another qemu binary, point this option at the full "
31639 "path of the binary to try it."
31644 #: ../test-tool/libguestfs-test-tool.pod:56
31645 msgid "I<--qemudir qemu_source_dir>"
31650 #: ../test-tool/libguestfs-test-tool.pod:58
31652 "If you have compiled qemu from source, point this option at the source "
31653 "directory to try it."
31658 #: ../test-tool/libguestfs-test-tool.pod:61
31659 msgid "I<--timeout N>"
31664 #: ../test-tool/libguestfs-test-tool.pod:63
31666 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31667 "does not usually need to be adjusted unless your machine is very slow."
31672 #: ../test-tool/libguestfs-test-tool.pod:69
31673 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31678 #: ../test-tool/libguestfs-test-tool.pod:71
31680 "If you have compiled another version of qemu from source and would like to "
31681 "try that, then you can use the I<--qemudir> option to point to the qemu "
31682 "source directory."
31687 #: ../test-tool/libguestfs-test-tool.pod:75
31689 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
31690 "option to point to the binary."
31695 #: ../test-tool/libguestfs-test-tool.pod:78
31697 "When using an alternate qemu with libguestfs, usually you would need to "
31698 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
31699 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
31700 "use either of the I<--qemudir> or I<--qemu> options."
31705 #: ../test-tool/libguestfs-test-tool.pod:85
31707 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
31708 "I<1> if there was an error."
31713 #: ../test-tool/libguestfs-test-tool.pod:92
31714 msgid "/usr/libexec/libguestfs-test-tool-helper"
31719 #: ../test-tool/libguestfs-test-tool.pod:94
31721 "This helper program is run inside the appliance and provides additional "
31727 #: ../test-tool/libguestfs-test-tool.pod:97
31728 msgid "/usr/bin/mkisofs"
31733 #: ../test-tool/libguestfs-test-tool.pod:99
31735 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
31736 "which is used as part of the tests."
31741 #: ../test-tool/libguestfs-test-tool.pod:106
31743 "For the full list of environment variables which may affect libguestfs, "
31744 "please see the L<guestfs(3)> manual page."
31749 #: ../test-tool/libguestfs-test-tool.pod:111
31750 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
31755 #: ../test-tool/libguestfs-test-tool.pod:121
31756 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
31761 #: ../fuse/guestmount.pod:5
31763 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
31768 #: ../fuse/guestmount.pod:9
31771 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
31777 #: ../fuse/guestmount.pod:11
31780 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
31786 #: ../fuse/guestmount.pod:13
31789 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
31795 #: ../fuse/guestmount.pod:17
31797 "You must I<not> use C<guestmount> in read-write mode on live virtual "
31798 "machines. If you do this, you risk disk corruption in the VM."
31803 #: ../fuse/guestmount.pod:22
31805 "The guestmount program can be used to mount virtual machine filesystems and "
31806 "other disk images on the host. It uses libguestfs for access to the guest "
31807 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
31808 "a mountable device."
31813 #: ../fuse/guestmount.pod:27
31815 "Along with other options, you have to give at least one device (I<-a> "
31816 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
31817 "option) or use the I<-i> inspection option. How this works is better "
31818 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
31824 #: ../fuse/guestmount.pod:33
31826 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
31827 "by you, and the filesystem will not be visible to any other users unless you "
31828 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
31829 "the filesystem, use the C<fusermount -u> command."
31834 #: ../fuse/guestmount.pod:41
31836 "For a typical Windows guest which has its main filesystem on the first "
31842 #: ../fuse/guestmount.pod:44
31845 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
31851 #: ../fuse/guestmount.pod:46
31853 "For a typical Linux guest which has a /boot filesystem on the first "
31854 "partition, and the root filesystem on a logical volume:"
31859 #: ../fuse/guestmount.pod:49
31862 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
31868 #: ../fuse/guestmount.pod:51
31869 msgid "To get libguestfs to detect guest mountpoints for you:"
31874 #: ../fuse/guestmount.pod:53
31877 " guestmount -a guest.img -i --ro /mnt\n"
31883 #: ../fuse/guestmount.pod:55
31884 msgid "For a libvirt guest called \"Guest\" you could do:"
31889 #: ../fuse/guestmount.pod:57
31892 " guestmount -d Guest -i --ro /mnt\n"
31898 #: ../fuse/guestmount.pod:59
31900 "If you don't know what filesystems are contained in a guest or disk image, "
31901 "use L<virt-filesystems(1)> first:"
31906 #: ../fuse/guestmount.pod:62
31909 " virt-filesystems MyGuest\n"
31915 #: ../fuse/guestmount.pod:64
31917 "If you want to trace the libguestfs calls but without excessive debugging "
31918 "information, we recommend:"
31923 #: ../fuse/guestmount.pod:67
31926 " guestmount [...] --trace /mnt\n"
31932 #: ../fuse/guestmount.pod:69
31933 msgid "If you want to debug the program, we recommend:"
31938 #: ../fuse/guestmount.pod:71
31941 " guestmount [...] --trace --verbose /mnt\n"
31947 #: ../fuse/guestmount.pod:77
31948 msgid "B<-a image> | B<--add image>"
31953 #: ../fuse/guestmount.pod:79
31954 msgid "Add a block device or virtual machine image."
31959 #: ../fuse/guestmount.pod:84
31960 msgid "B<-c URI> | B<--connect URI>"
31965 #: ../fuse/guestmount.pod:90
31966 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
31971 #: ../fuse/guestmount.pod:96
31972 msgid "B<--dir-cache-timeout N>"
31977 #: ../fuse/guestmount.pod:98
31979 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
31980 "seconds. The readdir cache [actually, there are several semi-independent "
31981 "caches] is populated after a readdir(2) call with the stat and extended "
31982 "attributes of the files in the directory, in anticipation that they will be "
31983 "requested soon after."
31988 #: ../fuse/guestmount.pod:104
31990 "There is also a different attribute cache implemented by FUSE (see the FUSE "
31991 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
31992 "requests, only cache existing ones."
31997 #: ../fuse/guestmount.pod:115
31998 msgid "B<--format=raw|qcow2|..> | B<--format>"
32003 #: ../fuse/guestmount.pod:122
32005 "If you have untrusted raw-format guest disk images, you should use this "
32006 "option to specify the disk format. This avoids a possible security problem "
32007 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
32008 "guestfs_add_drive_opts>."
32013 #: ../fuse/guestmount.pod:127
32014 msgid "B<--fuse-help>"
32019 #: ../fuse/guestmount.pod:129
32020 msgid "Display help on special FUSE options (see I<-o> below)."
32025 #: ../fuse/guestmount.pod:133
32026 msgid "Display brief help and exit."
32031 #: ../fuse/guestmount.pod:135
32032 msgid "B<-i> | B<--inspector>"
32037 #: ../fuse/guestmount.pod:155
32039 "Mount the named partition or logical volume on the given mountpoint B<in the "
32040 "guest> (this has nothing to do with mountpoints in the host)."
32045 #: ../fuse/guestmount.pod:158
32047 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32048 "something on C</>."
32053 #: ../fuse/guestmount.pod:171
32054 msgid "B<-n> | B<--no-sync>"
32059 #: ../fuse/guestmount.pod:173
32061 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32062 "unmounted. If you specify this option, then we don't attempt to sync the "
32063 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32068 #: ../fuse/guestmount.pod:178
32069 msgid "B<-o option> | B<--option option>"
32074 #: ../fuse/guestmount.pod:180
32075 msgid "Pass extra options to FUSE."
32080 #: ../fuse/guestmount.pod:182
32082 "To get a list of all the extra options supported by FUSE, use the command "
32083 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32084 "of them are a good idea."
32089 #: ../fuse/guestmount.pod:186
32092 " guestmount --fuse-help\n"
32098 #: ../fuse/guestmount.pod:188
32099 msgid "Some potentially useful FUSE options:"
32104 #: ../fuse/guestmount.pod:192
32105 msgid "B<-o allow_other>"
32110 #: ../fuse/guestmount.pod:194
32111 msgid "Allow other users to see the filesystem."
32116 #: ../fuse/guestmount.pod:196
32117 msgid "B<-o attr_timeout=N>"
32122 #: ../fuse/guestmount.pod:198
32123 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32128 #: ../fuse/guestmount.pod:200
32129 msgid "B<-o kernel_cache>"
32134 #: ../fuse/guestmount.pod:202
32136 "Allow the kernel to cache files (reduces the number of reads that have to go "
32137 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32138 "afford the extra memory usage."
32143 #: ../fuse/guestmount.pod:206
32144 msgid "B<-o uid=N> B<-o gid=N>"
32149 #: ../fuse/guestmount.pod:208
32151 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32152 "the chosen values."
32157 #: ../fuse/guestmount.pod:213
32158 msgid "B<-r> | B<--ro>"
32163 #: ../fuse/guestmount.pod:215
32165 "Add devices and mount everything read-only. Also disallow writes and make "
32166 "the disk appear read-only to FUSE."
32171 #: ../fuse/guestmount.pod:218
32173 "This is highly recommended if you are not going to edit the guest disk. If "
32174 "the guest is running and this option is I<not> supplied, then there is a "
32175 "strong risk of disk corruption in the guest. We try to prevent this from "
32176 "happening, but it is not always possible."
32181 #: ../fuse/guestmount.pod:223
32182 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32187 #: ../fuse/guestmount.pod:227
32188 msgid "Enable SELinux support for the guest."
32193 #: ../fuse/guestmount.pod:229
32194 msgid "B<-v> | B<--verbose>"
32199 #: ../fuse/guestmount.pod:231
32200 msgid "Enable verbose messages from underlying libguestfs."
32205 #: ../fuse/guestmount.pod:233
32206 msgid "B<-V> | B<--version>"
32211 #: ../fuse/guestmount.pod:235
32212 msgid "Display the program version and exit."
32217 #: ../fuse/guestmount.pod:237
32218 msgid "B<-w> | B<--rw>"
32222 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
32223 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32228 #: ../fuse/guestmount.pod:244
32229 msgid "B<-x> | B<--trace>"
32234 #: ../fuse/guestmount.pod:246
32235 msgid "Trace libguestfs calls and entry into each FUSE function."
32240 #: ../fuse/guestmount.pod:248
32241 msgid "This also stops the daemon from forking into the background."
32246 #: ../fuse/guestmount.pod:269
32248 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32249 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32255 #: ../fuse/guestmount.pod:284
32256 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
32261 #: ../tools/virt-edit.pl:34
32262 msgid "virt-edit - Edit a file in a virtual machine"
32267 #: ../tools/virt-edit.pl:38
32270 " virt-edit [--options] domname file\n"
32276 #: ../tools/virt-edit.pl:40
32279 " virt-edit [--options] disk.img [disk.img ...] file\n"
32285 #: ../tools/virt-edit.pl:42
32288 " virt-edit [domname|disk.img] file -e 'expr'\n"
32294 #: ../tools/virt-edit.pl:46
32296 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32297 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32298 "doing this, but doesn't catch all cases."
32303 #: ../tools/virt-edit.pl:52
32305 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32306 "the named virtual machine (or disk image)."
32311 #: ../tools/virt-edit.pl:55
32313 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
32314 "you should look at the L<guestfish(1)> tool."
32319 #: ../tools/virt-edit.pl:60
32320 msgid "Edit the named files interactively:"
32325 #: ../tools/virt-edit.pl:62
32328 " virt-edit mydomain /boot/grub/grub.conf\n"
32334 #: ../tools/virt-edit.pl:64
32337 " virt-edit mydomain /etc/passwd\n"
32343 #: ../tools/virt-edit.pl:66
32345 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32346 "below). To change the init default level to 5:"
32351 #: ../tools/virt-edit.pl:70
32354 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32360 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106
32361 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32362 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32363 msgid "Display brief help."
32368 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114
32369 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
32370 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
32371 #: ../tools/virt-list-partitions.pl:72
32372 msgid "Display version number and exit."
32377 #: ../tools/virt-edit.pl:96
32378 msgid "B<--backup extension> | B<-b extension>"
32383 #: ../tools/virt-edit.pl:98
32385 "Create a backup of the original file I<in the guest disk image>. The backup "
32386 "has the original filename with C<extension> added."
32391 #: ../tools/virt-edit.pl:101
32393 "Usually the first character of C<extension> would be a dot C<.> so you would "
32399 #: ../tools/virt-edit.pl:104
32402 " virt-edit -b .orig [etc]\n"
32408 #: ../tools/virt-edit.pl:106
32409 msgid "By default, no backup file is made."
32414 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128
32415 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32416 #: ../tools/virt-list-partitions.pl:78
32417 msgid "B<--connect URI> | B<-c URI>"
32422 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130
32423 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32424 #: ../tools/virt-list-partitions.pl:80
32426 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32427 "to the default libvirt hypervisor."
32432 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133
32433 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32434 #: ../tools/virt-list-partitions.pl:83
32436 "If you specify guest block devices directly, then libvirt is not used at all."
32441 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140
32442 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
32443 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
32444 msgid "B<--format> raw"
32449 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142
32450 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32451 #: ../tools/virt-list-partitions.pl:92
32453 "Specify the format of disk images given on the command line. If this is "
32454 "omitted then the format is autodetected from the content of the disk image."
32459 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146
32460 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32461 #: ../tools/virt-list-partitions.pl:96
32463 "If disk images are requested from libvirt, then this program asks libvirt "
32464 "for this information. In this case, the value of the format parameter is "
32470 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150
32471 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
32472 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32473 #: ../tools/virt-list-partitions.pl:100
32475 "If working with untrusted raw-format guest disk images, you should ensure "
32476 "the format is always specified."
32481 #: ../tools/virt-edit.pl:141
32482 msgid "B<--expr EXPR> | B<-e EXPR>"
32487 #: ../tools/virt-edit.pl:143
32489 "Instead of launching the external editor, non-interactively apply the Perl "
32490 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32496 #: ../tools/virt-edit.pl:147
32498 "Be careful to properly quote the expression to prevent it from being altered "
32504 #: ../tools/virt-edit.pl:268
32505 msgid "NON-INTERACTIVE EDITING"
32510 #: ../tools/virt-edit.pl:270
32512 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32513 "administrator can interactively edit the file."
32518 #: ../tools/virt-edit.pl:273
32520 "There are two ways also to use C<virt-edit> from scripts in order to make "
32521 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32522 "like this, it's less error-prone to write scripts directly using the "
32523 "libguestfs API and Augeas for configuration file editing.)"
32528 #: ../tools/virt-edit.pl:279
32530 "The first method is to temporarily set C<$EDITOR> to any script or program "
32531 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32532 "update C<tmpfile> in place however it likes."
32537 #: ../tools/virt-edit.pl:283
32539 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
32540 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32541 "instances of C<foo> with C<bar> in a file:"
32546 #: ../tools/virt-edit.pl:287
32549 " virt-edit domname filename -e 's/foo/bar/'\n"
32555 #: ../tools/virt-edit.pl:289
32557 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32558 "For example to delete root's password you could do:"
32563 #: ../tools/virt-edit.pl:292
32566 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32572 #: ../tools/virt-edit.pl:294
32574 "What really happens is that the snippet is evaluated as a Perl expression "
32575 "for each line of the file. The line, including the final C<\\n>, is passed "
32576 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32581 #: ../tools/virt-edit.pl:299
32583 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32584 "C<apache> user account from the password file you can do:"
32589 #: ../tools/virt-edit.pl:302
32592 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32598 #: ../tools/virt-edit.pl:304
32600 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32601 "the end of the file is rather difficult this way since there is no concept "
32602 "of \"last line of the file\" - your expression just doesn't get called "
32603 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32609 #: ../tools/virt-edit.pl:310
32611 "The variable C<$lineno> contains the current line number. As is "
32612 "traditional, the first line in the file is number C<1>."
32617 #: ../tools/virt-edit.pl:313
32619 "The return value from the expression is ignored, but the expression may call "
32620 "C<die> in order to abort the whole program, leaving the original file "
32626 #: ../tools/virt-edit.pl:317
32628 "Remember when matching the end of a line that C<$_> may contain the final C<"
32629 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32630 "newline then neither of these. Thus to match or substitute some text at the "
32631 "end of a line, use this regular expression:"
32636 #: ../tools/virt-edit.pl:322
32639 " /some text(\\r?\\n)?$/\n"
32645 #: ../tools/virt-edit.pl:324
32647 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32648 "$_> itself (since that would remove all newlines from the file):"
32653 #: ../tools/virt-edit.pl:328
32656 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32662 #: ../tools/virt-edit.pl:334
32668 #: ../tools/virt-edit.pl:336
32670 "If set, this string is used as the editor. It may contain arguments, eg. C<"
32676 #: ../tools/virt-edit.pl:339
32677 msgid "If not set, C<vi> is used."
32682 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559
32683 #: ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182
32684 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
32685 #: ../tools/virt-list-partitions.pl:250
32686 msgid "SHELL QUOTING"
32691 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567
32692 #: ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184
32693 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
32694 #: ../tools/virt-list-partitions.pl:252
32696 "Libvirt guest names can contain arbitrary characters, some of which have "
32697 "meaning to the shell such as C<#> and space. You may need to quote or "
32698 "escape these characters on the command line. See the shell manual page L<sh"
32699 "(1)> for details."
32703 #: ../tools/virt-edit.pl:352
32705 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
32706 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
32707 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
32712 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598
32713 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202
32714 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
32715 #: ../tools/virt-list-partitions.pl:269
32721 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600
32722 #: ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204
32723 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
32724 #: ../tools/virt-list-partitions.pl:271
32725 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
32730 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
32731 msgid "Copyright (C) 2009-2010 Red Hat Inc."
32736 #: ../tools/virt-win-reg.pl:37
32738 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
32743 #: ../tools/virt-win-reg.pl:41
32746 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
32752 #: ../tools/virt-win-reg.pl:43
32755 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
32761 #: ../tools/virt-win-reg.pl:45
32764 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
32770 #: ../tools/virt-win-reg.pl:47
32773 " virt-win-reg --merge domname [input.reg ...]\n"
32779 #: ../tools/virt-win-reg.pl:49
32782 " virt-win-reg [--options] disk.img ... # instead of domname\n"
32788 #: ../tools/virt-win-reg.pl:53
32790 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
32791 "virtual machines. If you do this, you I<will> get irreversible disk "
32792 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
32793 "but doesn't catch all cases."
32798 #: ../tools/virt-win-reg.pl:58
32800 "Modifying the Windows Registry is an inherently risky operation. The format "
32801 "is deliberately obscure and undocumented, and Registry changes can leave the "
32802 "system unbootable. Therefore when using the C<--merge> option, make sure "
32803 "you have a reliable backup first."
32808 #: ../tools/virt-win-reg.pl:65
32810 "This program can export and merge Windows Registry entries from a Windows "
32816 #: ../tools/virt-win-reg.pl:68
32818 "The first parameter is the libvirt guest name or the raw disk image of a "
32824 #: ../tools/virt-win-reg.pl:71
32826 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
32827 "exported (recursively). For example:"
32832 #: ../tools/virt-win-reg.pl:74
32835 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
32841 #: ../tools/virt-win-reg.pl:76
32843 "You can also display single values from within registry keys, for example:"
32848 #: ../tools/virt-win-reg.pl:79
32851 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
32852 " $ virt-win-reg Windows7 $cvkey ProductName\n"
32853 " Windows 7 Enterprise\n"
32859 #: ../tools/virt-win-reg.pl:83
32861 "With C<--merge>, you can merge a textual regedit file into the Windows "
32867 #: ../tools/virt-win-reg.pl:86
32870 " $ virt-win-reg --merge Windows7 changes.reg\n"
32876 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
32882 #: ../tools/virt-win-reg.pl:90
32884 "This program is only meant for simple access to the registry. If you want "
32885 "to do complicated things with the registry, we suggest you download the "
32886 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
32887 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
32888 "L<hivexregedit(1)>."
32893 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
32899 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
32900 msgid "Enable debugging messages."
32905 #: ../tools/virt-win-reg.pl:157
32911 #: ../tools/virt-win-reg.pl:159
32913 "In merge mode, this merges a textual regedit file into the Windows Registry "
32914 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
32915 "displays or exports Registry entries instead."
32920 #: ../tools/virt-win-reg.pl:163
32922 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
32923 "result in disk corruption. However exporting (without this flag) is always "
32929 #: ../tools/virt-win-reg.pl:171
32930 msgid "B<--encoding> UTF-16LE|ASCII"
32935 #: ../tools/virt-win-reg.pl:173
32937 "When merging (only), you may need to specify the encoding for strings to be "
32938 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
32939 "(3)/ENCODING STRINGS>."
32944 #: ../tools/virt-win-reg.pl:177
32946 "The default is to use UTF-16LE, which should work with recent versions of "
32952 #: ../tools/virt-win-reg.pl:402
32953 msgid "SUPPORTED SYSTEMS"
32958 #: ../tools/virt-win-reg.pl:404
32960 "The program currently supports Windows NT-derived guests starting with "
32961 "Windows XP through to at least Windows 7."
32966 #: ../tools/virt-win-reg.pl:407
32968 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
32969 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
32970 "and C<HKEY_USERS\\.DEFAULT>."
32975 #: ../tools/virt-win-reg.pl:411
32977 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
32983 #: ../tools/virt-win-reg.pl:414
32985 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
32991 #: ../tools/virt-win-reg.pl:417
32997 #: ../tools/virt-win-reg.pl:419
32999 "C<virt-win-reg> expects that regedit files have already been reencoded in "
33000 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
33001 "style line endings. Since Windows regedit files are often in UTF-16LE with "
33002 "Windows-style line endings, you may need to reencode the whole file before "
33003 "or after processing."
33008 #: ../tools/virt-win-reg.pl:425
33010 "To reencode a file from Windows format to Linux (before processing it with "
33011 "the C<--merge> option), you would do something like this:"
33016 #: ../tools/virt-win-reg.pl:428
33019 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33025 #: ../tools/virt-win-reg.pl:430
33027 "To go in the opposite direction, after exporting and before sending the file "
33028 "to a Windows user, do something like this:"
33033 #: ../tools/virt-win-reg.pl:433
33036 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33042 #: ../tools/virt-win-reg.pl:435
33043 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33048 #: ../tools/virt-win-reg.pl:437
33050 "If you are unsure about the current encoding, use the L<file(1)> command. "
33051 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33052 "style (CRLF) line endings, like this:"
33057 #: ../tools/virt-win-reg.pl:441
33060 " $ file software.reg\n"
33061 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33062 " with CRLF line terminators\n"
33068 #: ../tools/virt-win-reg.pl:445
33069 msgid "This file would need conversion before you could C<--merge> it."
33074 #: ../tools/virt-win-reg.pl:447
33075 msgid "CurrentControlSet etc."
33080 #: ../tools/virt-win-reg.pl:449
33082 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33083 "Registry at the level of the hive file, and therefore you cannot modify "
33089 #: ../tools/virt-win-reg.pl:453
33091 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33092 "circumstances it might refer to another control set. The way to find out is "
33093 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33098 #: ../tools/virt-win-reg.pl:457
33101 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33102 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33103 " \"Current\"=dword:00000001\n"
33104 " \"Default\"=dword:00000001\n"
33105 " \"Failed\"=dword:00000000\n"
33106 " \"LastKnownGood\"=dword:00000002\n"
33112 #: ../tools/virt-win-reg.pl:464
33113 msgid "\"Current\" is the one which Windows will choose when it boots."
33118 #: ../tools/virt-win-reg.pl:466
33120 "Similarly, other C<Current...> keys in the path may need to be replaced."
33125 #: ../tools/virt-win-reg.pl:469
33126 msgid "WINDOWS TIPS"
33131 #: ../tools/virt-win-reg.pl:471
33133 "Note that some of these tips modify the guest disk image. The guest I<must> "
33134 "be shut off, else you will get disk corruption."
33139 #: ../tools/virt-win-reg.pl:474
33140 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33145 #: ../tools/virt-win-reg.pl:476
33147 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33148 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33149 "is uploaded into C<C:\\>:"
33154 #: ../tools/virt-win-reg.pl:480
33157 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33163 #: ../tools/virt-win-reg.pl:482
33164 msgid "Prepare a regedit file containing the registry change:"
33169 #: ../tools/virt-win-reg.pl:484
33172 " cat > test.reg <<'EOF'\n"
33173 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33174 " \"Test\"=\"c:\\\\test.bat\"\n"
33181 #: ../tools/virt-win-reg.pl:489
33183 "In this example we use the key C<RunOnce> which means that the script will "
33184 "run precisely once when the first user logs in. If you want it to run every "
33185 "time a user logs in, replace C<RunOnce> with C<Run>."
33190 #: ../tools/virt-win-reg.pl:493
33191 msgid "Now update the registry:"
33196 #: ../tools/virt-win-reg.pl:495
33199 " virt-win-reg --merge WindowsGuest test.reg\n"
33205 #: ../tools/virt-win-reg.pl:497
33206 msgid "INSTALLING A SERVICE"
33211 #: ../tools/virt-win-reg.pl:499
33213 "This section assumes you are familiar with Windows services, and you either "
33214 "have a program which handles the Windows Service Control Protocol directly "
33215 "or you want to run any program using a service wrapper like SrvAny or the "
33221 #: ../tools/virt-win-reg.pl:504
33223 "First upload the program and optionally the service wrapper. In this case "
33224 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33229 #: ../tools/virt-win-reg.pl:508
33232 " guestfish -i -d WindowsGuest <<EOF\n"
33233 " upload rhsrvany.exe /rhsrvany.exe\n"
33234 " upload test.exe /test.exe\n"
33241 #: ../tools/virt-win-reg.pl:513
33243 "Prepare a regedit file containing the registry changes. In this example, "
33244 "the first registry change is needed for the service itself or the service "
33245 "wrapper (if used). The second registry change is only needed because I am "
33246 "using the RHSrvAny service wrapper."
33251 #: ../tools/virt-win-reg.pl:518
33254 " cat > service.reg <<'EOF'\n"
33255 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33256 " \"Type\"=dword:00000010\n"
33257 " \"Start\"=dword:00000002\n"
33258 " \"ErrorControl\"=dword:00000001\n"
33259 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33260 " \"DisplayName\"=\"RHSrvAny\"\n"
33261 " \"ObjectName\"=\"NetworkService\"\n"
33267 #: ../tools/virt-win-reg.pl:527
33270 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33271 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33272 " \"PWD\"=\"c:\\\\Temp\"\n"
33279 #: ../tools/virt-win-reg.pl:538
33281 "For use of C<ControlSet001> see the section above in this manual page. You "
33282 "may need to adjust this according to the control set that is in use by the "
33288 #: ../tools/virt-win-reg.pl:544
33290 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33291 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33292 "privileged account."
33297 #: ../tools/virt-win-reg.pl:550
33299 "For the meaning of the magic numbers, see this Microsoft KB article: "
33300 "L<http://support.microsoft.com/kb/103000>."
33305 #: ../tools/virt-win-reg.pl:555
33306 msgid "Update the registry:"
33311 #: ../tools/virt-win-reg.pl:557
33314 " virt-win-reg --merge WindowsGuest service.reg\n"
33320 #: ../tools/virt-win-reg.pl:561
33322 "Be careful when passing parameters containing C<\\> (backslash) in the "
33323 "shell. Usually you will have to use 'single quotes' or double backslashes "
33324 "(but not both) to protect them from the shell."
33329 #: ../tools/virt-win-reg.pl:565
33330 msgid "Paths and value names are case-insensitive."
33335 #: ../tools/virt-win-reg.pl:574
33337 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33338 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33339 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33344 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33346 "When reporting bugs, please enable debugging and capture the I<complete> "
33352 #: ../tools/virt-win-reg.pl:592
33355 " export LIBGUESTFS_DEBUG=1\n"
33356 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33362 #: ../tools/virt-win-reg.pl:595
33364 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33370 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516
33371 #: ../tools/virt-make-fs.pl:570
33372 msgid "Copyright (C) 2010 Red Hat Inc."
33377 #: ../tools/virt-resize.pl:42
33378 msgid "virt-resize - Resize a virtual machine disk"
33383 #: ../tools/virt-resize.pl:46
33386 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
33387 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
33388 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
33394 #: ../tools/virt-resize.pl:52
33396 "Virt-resize is a tool which can resize a virtual machine disk, making it "
33397 "larger or smaller overall, and resizing or deleting any partitions contained "
33403 #: ../tools/virt-resize.pl:56
33405 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
33406 "not> be used on live virtual machines - for consistent results, shut the "
33407 "virtual machine down before resizing it."
33412 #: ../tools/virt-resize.pl:60
33414 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
33415 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
33420 #: ../tools/virt-resize.pl:66
33422 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
33423 "fill the extra 5GB of space."
33427 #: ../tools/virt-resize.pl:69
33430 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
33431 " virt-filesystems --long -h --all -a olddisk\n"
33432 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
33433 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
33439 #: ../tools/virt-resize.pl:74
33441 "As above, but make the /boot partition 200MB bigger, while giving the "
33442 "remaining space to /dev/sda2:"
33447 #: ../tools/virt-resize.pl:77
33450 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
33456 #: ../tools/virt-resize.pl:79
33457 msgid "As above, but the output format will be uncompressed qcow2:"
33462 #: ../tools/virt-resize.pl:81
33465 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
33466 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
33472 #: ../tools/virt-resize.pl:84
33473 msgid "DETAILED USAGE"
33478 #: ../tools/virt-resize.pl:86
33479 msgid "EXPANDING A VIRTUAL MACHINE DISK"
33484 #: ../tools/virt-resize.pl:90
33485 msgid "1. Shut down the virtual machine"
33490 #: ../tools/virt-resize.pl:92
33491 msgid "2. Locate input disk image"
33496 #: ../tools/virt-resize.pl:94
33498 "Locate the input disk image (ie. the file or device on the host containing "
33499 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
33500 "dumpxml> like this to find the disk image name:"
33505 #: ../tools/virt-resize.pl:98
33508 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
33509 " Found 1 nodes:\n"
33511 " <source dev=\"/dev/vg/lv_guest\" />\n"
33517 #: ../tools/virt-resize.pl:103
33518 msgid "3. Look at current sizing"
33523 #: ../tools/virt-resize.pl:105
33524 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
33529 #: ../tools/virt-resize.pl:108
33532 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
33533 " Name Type Size Parent\n"
33534 " /dev/sda1 partition 101M /dev/sda\n"
33535 " /dev/sda2 partition 7.9G /dev/sda\n"
33536 " /dev/sda device 8.0G -\n"
33542 #: ../tools/virt-resize.pl:114
33544 "(This example is a virtual machine with an 8 GB disk which we would like to "
33545 "expand up to 10 GB)."
33550 #: ../tools/virt-resize.pl:117
33551 msgid "4. Create output disk"
33556 #: ../tools/virt-resize.pl:119
33558 "Virt-resize cannot do in-place disk modifications. You have to have space "
33559 "to store the resized output disk."
33564 #: ../tools/virt-resize.pl:122
33566 "To store the resized disk image in a file, create a file of a suitable size:"
33571 #: ../tools/virt-resize.pl:125
33574 " # rm -f outdisk\n"
33575 " # truncate -s 10G outdisk\n"
33581 #: ../tools/virt-resize.pl:128
33582 msgid "Or use L<lvcreate(1)> to create a logical volume:"
33587 #: ../tools/virt-resize.pl:130
33590 " # lvcreate -L 10G -n lv_name vg_name\n"
33596 #: ../tools/virt-resize.pl:132
33597 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
33602 #: ../tools/virt-resize.pl:134
33605 " # virsh pool-list\n"
33606 " # virsh vol-create-as poolname newvol 10G\n"
33612 #: ../tools/virt-resize.pl:137
33618 #: ../tools/virt-resize.pl:139
33620 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
33621 "file) and the output disk. The output disk is the one created in the "
33627 #: ../tools/virt-resize.pl:143
33630 " # virt-resize indisk outdisk\n"
33636 #: ../tools/virt-resize.pl:145
33638 "This command just copies disk image C<indisk> to disk image C<outdisk> "
33639 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
33640 "larger, then an extra, empty partition is created at the end of the disk "
33641 "covering the extra space. If C<outdisk> is smaller, then it will give an "
33647 #: ../tools/virt-resize.pl:151
33649 "More realistically you'd want to expand existing partitions in the disk "
33650 "image by passing extra options (for the full list see the L</OPTIONS> "
33656 #: ../tools/virt-resize.pl:155
33658 "L</--expand> is the most useful option. It expands the named partition "
33659 "within the disk to fill any extra space:"
33664 #: ../tools/virt-resize.pl:158
33667 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
33673 #: ../tools/virt-resize.pl:160
33675 "(In this case, an extra partition is I<not> created at the end of the disk, "
33676 "because there will be no unused space)."
33681 #: ../tools/virt-resize.pl:163
33683 "L</--resize> is the other commonly used option. The following would "
33684 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
33685 "rest of the available space:"
33690 #: ../tools/virt-resize.pl:167
33693 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
33694 " indisk outdisk\n"
33700 #: ../tools/virt-resize.pl:170
33702 "If the expanded partition in the image contains a filesystem or LVM PV, then "
33703 "if virt-resize knows how, it will resize the contents, the equivalent of "
33704 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
33705 ">. However virt-resize does not know how to resize some filesystems, so you "
33706 "would have to online resize them after booting the guest."
33711 #: ../tools/virt-resize.pl:177
33712 msgid "Other options are covered below."
33717 #: ../tools/virt-resize.pl:179
33723 #: ../tools/virt-resize.pl:181
33724 msgid "Thoroughly test the new disk image I<before> discarding the old one."
33729 #: ../tools/virt-resize.pl:183
33730 msgid "If you are using libvirt, edit the XML to point at the new disk:"
33735 #: ../tools/virt-resize.pl:185
33738 " # virsh edit guestname\n"
33744 #: ../tools/virt-resize.pl:187
33746 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
33747 "html#elementsDisks>"
33752 #: ../tools/virt-resize.pl:190
33753 msgid "Then start up the domain with the new, resized disk:"
33758 #: ../tools/virt-resize.pl:192
33761 " # virsh start guestname\n"
33767 #: ../tools/virt-resize.pl:194
33769 "and check that it still works. See also the L</NOTES> section below for "
33770 "additional information."
33775 #: ../tools/virt-resize.pl:197
33776 msgid "7. Resize LVs etc inside the guest"
33781 #: ../tools/virt-resize.pl:199
33782 msgid "(This can also be done offline using L<guestfish(1)>)"
33787 #: ../tools/virt-resize.pl:201
33789 "Once the guest has booted you should see the new space available, at least "
33790 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
33791 "may need to resize LVs inside PVs, and also resize filesystem types that "
33792 "virt-resize does not know how to expand."
33797 #: ../tools/virt-resize.pl:208
33798 msgid "SHRINKING A VIRTUAL MACHINE DISK"
33803 #: ../tools/virt-resize.pl:210
33805 "Shrinking is somewhat more complex than expanding, and only an overview is "
33811 #: ../tools/virt-resize.pl:213
33813 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
33814 "filesystems). The user has to shrink content before passing the disk image "
33815 "to virt-resize, and virt-resize will check that the content has been shrunk "
33821 #: ../tools/virt-resize.pl:218
33822 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
33827 #: ../tools/virt-resize.pl:220
33829 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
33830 "steps 3 and 4 above to allocate a new disk image."
33835 #: ../tools/virt-resize.pl:223
33837 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
33842 #: ../tools/virt-resize.pl:226
33843 msgid "IGNORING OR DELETING PARTITIONS"
33848 #: ../tools/virt-resize.pl:228
33850 "virt-resize also gives a convenient way to ignore or delete partitions when "
33851 "copying from the input disk to the output disk. Ignoring a partition speeds "
33852 "up the copy where you don't care about the existing contents of a "
33853 "partition. Deleting a partition removes it completely, but note that it "
33854 "also renumbers any partitions after the one which is deleted, which can "
33855 "leave some guests unbootable."
33860 #: ../tools/virt-resize.pl:235
33861 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
33866 #: ../tools/virt-resize.pl:237
33868 "If the input disk is in qcow2 format, then you may prefer that the output is "
33869 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
33870 "the fly. The output format is simply determined by the format of the empty "
33871 "output container that you provide. Thus to create qcow2 output, use:"
33876 #: ../tools/virt-resize.pl:243
33879 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
33885 #: ../tools/virt-resize.pl:245
33886 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
33891 #: ../tools/virt-resize.pl:247
33892 msgid "Similarly, to get non-sparse raw output use:"
33897 #: ../tools/virt-resize.pl:249
33900 " fallocate -l size outdisk\n"
33906 #: ../tools/virt-resize.pl:251
33908 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
33909 "dev/zero of=outdisk bs=1M count=..>)"
33914 #: ../tools/virt-resize.pl:264
33915 msgid "Display help."
33920 #: ../tools/virt-resize.pl:278
33921 msgid "B<--resize part=size>"
33926 #: ../tools/virt-resize.pl:280
33928 "Resize the named partition (expanding or shrinking it) so that it has the "
33934 #: ../tools/virt-resize.pl:283
33936 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
33937 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
33938 "Exabytes; or as a percentage of the current size; or as a relative number or "
33939 "percentage. For example:"
33944 #: ../tools/virt-resize.pl:288
33947 " --resize /dev/sda2=10G\n"
33953 #: ../tools/virt-resize.pl:290
33956 " --resize /dev/sda4=90%\n"
33962 #: ../tools/virt-resize.pl:292
33965 " --resize /dev/sda2=+1G\n"
33971 #: ../tools/virt-resize.pl:294
33974 " --resize /dev/sda2=-200M\n"
33980 #: ../tools/virt-resize.pl:296
33983 " --resize /dev/sda1=+128K\n"
33989 #: ../tools/virt-resize.pl:298
33992 " --resize /dev/sda1=+10%\n"
33998 #: ../tools/virt-resize.pl:300
34001 " --resize /dev/sda1=-10%\n"
34007 #: ../tools/virt-resize.pl:302
34009 "You can increase the size of any partition. Virt-resize will expand the "
34010 "direct content of the partition if it knows how (see C<--expand> below)."
34015 #: ../tools/virt-resize.pl:306
34017 "You can only I<decrease> the size of partitions that contain filesystems or "
34018 "PVs which have already been shrunk. Virt-resize will check this has been "
34019 "done before proceeding, or else will print an error (see also C<--resize-"
34025 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
34026 #: ../tools/virt-resize.pl:420
34027 msgid "You can give this option multiple times."
34032 #: ../tools/virt-resize.pl:317
34033 msgid "B<--resize-force part=size>"
34038 #: ../tools/virt-resize.pl:319
34040 "This is the same as C<--resize> except that it will let you decrease the "
34041 "size of any partition. Generally this means you will lose any data which "
34042 "was at the end of the partition you shrink, but you may not care about that "
34043 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
34044 "as a swap partition)."
34049 #: ../tools/virt-resize.pl:325
34050 msgid "See also the C<--ignore> option."
34055 #: ../tools/virt-resize.pl:331
34056 msgid "B<--expand part>"
34061 #: ../tools/virt-resize.pl:333
34063 "Expand the named partition so it uses up all extra space (space left over "
34064 "after any other resize changes that you request have been done)."
34069 #: ../tools/virt-resize.pl:336
34071 "If virt-resize knows how, it will expand the direct content of the "
34072 "partition. For example, if the partition is an LVM PV, it will expand the "
34073 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
34074 "content it doesn't know about alone."
34079 #: ../tools/virt-resize.pl:341
34080 msgid "Currently virt-resize can resize:"
34085 #: ../tools/virt-resize.pl:347
34087 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
34093 #: ../tools/virt-resize.pl:352
34095 "NTFS filesystems contained directly in a partition, if libguestfs was "
34096 "compiled with support for NTFS."
34101 #: ../tools/virt-resize.pl:355
34103 "The filesystem must have been shut down consistently last time it was used. "
34104 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
34105 "consistency check, so at the first boot after resizing Windows will check "
34111 #: ../tools/virt-resize.pl:362
34113 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
34114 "inside the PV, but see the C<--LV-expand> option. The user could also "
34115 "resize LVs as desired after boot."
34120 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
34121 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
34126 #: ../tools/virt-resize.pl:374
34127 msgid "B<--shrink part>"
34132 #: ../tools/virt-resize.pl:376
34134 "Shrink the named partition until the overall disk image fits in the "
34135 "destination. The named partition B<must> contain a filesystem or PV which "
34136 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
34137 "online tools). Virt-resize will check this and give an error if it has not "
34143 #: ../tools/virt-resize.pl:382
34145 "The amount by which the overall disk must be shrunk (after carrying out all "
34146 "other operations requested by the user) is called the \"deficit\". For "
34147 "example, a straight copy (assume no other operations) from a 5GB disk image "
34148 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
34149 "would give an error unless the user specified a partition to shrink and that "
34150 "partition had more than a gigabyte of free space."
34155 #: ../tools/virt-resize.pl:396
34156 msgid "B<--ignore part>"
34161 #: ../tools/virt-resize.pl:398
34163 "Ignore the named partition. Effectively this means the partition is "
34164 "allocated on the destination disk, but the content is not copied across from "
34165 "the source disk. The content of the partition will be blank (all zero "
34171 #: ../tools/virt-resize.pl:409
34172 msgid "B<--delete part>"
34177 #: ../tools/virt-resize.pl:411
34179 "Delete the named partition. It would be more accurate to describe this as "
34180 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
34181 "the original disk image is left intact."
34186 #: ../tools/virt-resize.pl:415
34188 "Note that when you delete a partition, then anything contained in the "
34189 "partition is also deleted. Furthermore, this causes any partitions that "
34190 "come after to be I<renumbered>, which can easily make your guest unbootable."
34195 #: ../tools/virt-resize.pl:426
34196 msgid "B<--LV-expand logvol>"
34201 #: ../tools/virt-resize.pl:428
34203 "This takes the logical volume and, as a final step, expands it to fill all "
34204 "the space available in its volume group. A typical usage, assuming a Linux "
34205 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
34206 "lv_root> would be:"
34211 #: ../tools/virt-resize.pl:433
34214 " virt-resize indisk outdisk \\\n"
34215 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
34221 #: ../tools/virt-resize.pl:436
34223 "This would first expand the partition (and PV), and then expand the root "
34224 "device to fill the extra space in the PV."
34229 #: ../tools/virt-resize.pl:439
34231 "The contents of the LV are also resized if virt-resize knows how to do "
34232 "that. You can stop virt-resize from trying to expand the content by using "
34233 "the option C<--no-expand-content>."
34238 #: ../tools/virt-resize.pl:443
34239 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
34244 #: ../tools/virt-resize.pl:446
34246 "You can give this option multiple times, I<but> it doesn't make sense to do "
34247 "this unless the logical volumes you specify are all in different volume "
34253 #: ../tools/virt-resize.pl:454
34254 msgid "B<--no-copy-boot-loader>"
34259 #: ../tools/virt-resize.pl:456
34261 "By default, virt-resize copies over some sectors at the start of the disk "
34262 "(up to the beginning of the first partition). Commonly these sectors "
34263 "contain the Master Boot Record (MBR) and the boot loader, and are required "
34264 "in order for the guest to boot correctly."
34269 #: ../tools/virt-resize.pl:461
34271 "If you specify this flag, then this initial copy is not done. You may need "
34272 "to reinstall the boot loader in this case."
34277 #: ../tools/virt-resize.pl:469
34278 msgid "B<--no-extra-partition>"
34283 #: ../tools/virt-resize.pl:471
34285 "By default, virt-resize creates an extra partition if there is any extra, "
34286 "unused space after all resizing has happened. Use this option to prevent "
34287 "the extra partition from being created. If you do this then the extra space "
34288 "will be inaccessible until you run fdisk, parted, or some other partitioning "
34289 "tool in the guest."
34294 #: ../tools/virt-resize.pl:477
34296 "Note that if the surplus space is smaller than 10 MB, no extra partition "
34302 #: ../tools/virt-resize.pl:484
34303 msgid "B<--no-expand-content>"
34308 #: ../tools/virt-resize.pl:486
34310 "By default, virt-resize will try to expand the direct contents of "
34311 "partitions, if it knows how (see C<--expand> option above)."
34316 #: ../tools/virt-resize.pl:489
34318 "If you give the C<--no-expand-content> option then virt-resize will not "
34324 #: ../tools/virt-resize.pl:496
34325 msgid "B<-d> | B<--debug>"
34330 #: ../tools/virt-resize.pl:504
34331 msgid "B<-n> | B<--dryrun>"
34336 #: ../tools/virt-resize.pl:506
34337 msgid "Print a summary of what would be done, but don't do anything."
34342 #: ../tools/virt-resize.pl:512
34343 msgid "B<-q> | B<--quiet>"
34348 #: ../tools/virt-resize.pl:514
34349 msgid "Don't print the summary."
34354 #: ../tools/virt-resize.pl:522
34356 "Specify the format of the input disk image. If this flag is not given then "
34357 "it is auto-detected from the image itself."
34362 #: ../tools/virt-resize.pl:528
34364 "Note that this option I<does not> affect the output format. See L</QCOW2 "
34365 "AND NON-SPARSE RAW FORMATS>."
34370 #: ../tools/virt-resize.pl:535
34371 msgid "B<--output-format> raw"
34376 #: ../tools/virt-resize.pl:537
34378 "Specify the format of the output disk image. If this flag is not given then "
34379 "it is auto-detected from the image itself."
34384 #: ../tools/virt-resize.pl:543
34386 "Note that you still need to create the output disk with the right format. "
34387 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
34392 #: ../tools/virt-resize.pl:1425
34398 #: ../tools/virt-resize.pl:1427
34399 msgid "\"Partition 1 does not end on cylinder boundary.\""
34404 #: ../tools/virt-resize.pl:1429
34406 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
34407 "means the partitions will not be aligned to the ancient CHS geometry. "
34408 "However CHS geometry is meaningless for disks manufactured since the early "
34409 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
34410 "cylinders is not required by any modern operating system."
34415 #: ../tools/virt-resize.pl:1436
34416 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
34421 #: ../tools/virt-resize.pl:1438
34423 "In Windows Vista and later versions, Microsoft switched to using a separate "
34424 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
34425 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
34426 "the boot partition. Doing so seems to break the guest completely. However "
34427 "expanding the second partition (ie. C: drive) should work."
34432 #: ../tools/virt-resize.pl:1445
34434 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
34435 "NTFS partitions have been expanded. This is just a safety check and (unless "
34436 "it find errors) is nothing to worry about."
34441 #: ../tools/virt-resize.pl:1449
34442 msgid "GUEST BOOT STUCK AT \"GRUB\""
34447 #: ../tools/virt-resize.pl:1451
34449 "If a Linux guest does not boot after resizing, and the boot is stuck after "
34450 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
34451 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
34452 "although we think is to do with partition alignment."
34457 #: ../tools/virt-resize.pl:1456
34460 " guestfish -i -a newdisk\n"
34461 " ><fs> cat /boot/grub/device.map\n"
34462 " # check the contents of this file are sensible or\n"
34463 " # edit the file if necessary\n"
34464 " ><fs> grub-install / /dev/vda\n"
34471 #: ../tools/virt-resize.pl:1463
34473 "For more flexible guest reconfiguration, including if you need to specify "
34474 "other parameters to grub-install, use L<virt-rescue(1)>."
34479 #: ../tools/virt-resize.pl:1466
34480 msgid "ALTERNATIVE TOOLS"
34485 #: ../tools/virt-resize.pl:1468
34487 "There are several proprietary tools for resizing partitions. We won't "
34488 "mention any here."
34493 #: ../tools/virt-resize.pl:1471
34495 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
34496 "operations on disk images. They can resize and move partitions, but I don't "
34497 "think they can do anything with the contents, and they certainly don't "
34503 #: ../tools/virt-resize.pl:1476
34505 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
34506 "but at a much lower level. You will probably end up hand-calculating sector "
34507 "offsets, which is something that virt-resize was designed to avoid. If you "
34508 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
34514 #: ../tools/virt-resize.pl:1491
34516 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
34517 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
34518 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
34519 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
34520 "libguestfs.org/>."
34525 #: ../tools/virt-list-filesystems.pl:32
34527 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34532 #: ../tools/virt-list-filesystems.pl:36
34535 " virt-list-filesystems [--options] domname\n"
34541 #: ../tools/virt-list-filesystems.pl:38
34544 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34550 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34552 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34558 #: ../tools/virt-list-filesystems.pl:45
34560 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34561 "are contained in a virtual machine or disk image."
34566 #: ../tools/virt-list-filesystems.pl:49
34568 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34569 "functionality. For more complex cases you should look at the L<guestfish(1)"
34575 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34576 msgid "B<-l> | B<--long>"
34581 #: ../tools/virt-list-filesystems.pl:108
34583 "With this option, C<virt-list-filesystems> displays the type of each "
34584 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34589 #: ../tools/virt-list-filesystems.pl:115
34590 msgid "B<-a> | B<--all>"
34595 #: ../tools/virt-list-filesystems.pl:117
34597 "Normally we only show mountable filesystems. If this option is given then "
34598 "swap devices are shown too."
34603 #: ../tools/virt-list-filesystems.pl:191
34605 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34606 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34607 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34612 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34613 msgid "Copyright (C) 2009 Red Hat Inc."
34618 #: ../tools/virt-tar.pl:33
34619 msgid "virt-tar - Extract or upload files to a virtual machine"
34624 #: ../tools/virt-tar.pl:37
34627 " virt-tar [--options] -x domname directory tarball\n"
34633 #: ../tools/virt-tar.pl:39
34636 " virt-tar [--options] -u domname tarball directory\n"
34642 #: ../tools/virt-tar.pl:41
34645 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34651 #: ../tools/virt-tar.pl:43
34654 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34659 #: ../tools/virt-tar.pl:47
34661 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34662 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34667 #: ../tools/virt-tar.pl:52
34668 msgid "Download C</home> from the VM into a local tarball:"
34673 #: ../tools/virt-tar.pl:54
34676 " virt-tar -x domname /home home.tar\n"
34682 #: ../tools/virt-tar.pl:56
34685 " virt-tar -zx domname /home home.tar.gz\n"
34691 #: ../tools/virt-tar.pl:58
34692 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34697 #: ../tools/virt-tar.pl:60
34700 " virt-tar -u domname uploadstuff.tar /tmp\n"
34706 #: ../tools/virt-tar.pl:62
34709 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34715 #: ../tools/virt-tar.pl:66
34717 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
34718 "virtual machines. If you do this, you risk disk corruption in the VM. "
34719 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34724 #: ../tools/virt-tar.pl:71
34726 "You can use C<-x> (extract) on live virtual machines, but you might get "
34727 "inconsistent results or errors if there is filesystem activity inside the "
34728 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34729 "work, but the only way to guarantee consistent results is if the virtual "
34730 "machine is shut down."
34735 #: ../tools/virt-tar.pl:79
34737 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34738 "parts of a guest filesystem. There are many possibilities: making backups, "
34739 "uploading data files, snooping on guest activity, fixing or customizing "
34745 #: ../tools/virt-tar.pl:84
34747 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34748 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34749 "should look at the L<guestfish(1)> tool."
34754 #: ../tools/virt-tar.pl:88
34756 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
34757 "its contents (recursively) from the virtual machine into a local tarball. "
34758 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
34759 "virtual machine. You cannot use these two options together."
34764 #: ../tools/virt-tar.pl:94
34766 "In addition, you may need to use the C<-z> (gZip) option to enable "
34767 "compression. When uploading, you have to specify C<-z> if the upload file "
34768 "is compressed because virt-tar won't detect this on its own."
34773 #: ../tools/virt-tar.pl:98
34775 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34776 "example it cannot do PKZip files or bzip2 compression. If you want that "
34777 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34778 "the L<libguestfs(3)> API)."
34783 #: ../tools/virt-tar.pl:156
34784 msgid "B<-x> | B<--extract> | B<--download>"
34789 #: ../tools/virt-tar.pl:158
34790 msgid "B<-u> | B<--upload>"
34795 #: ../tools/virt-tar.pl:160
34797 "Use C<-x> to extract (download) a directory from a virtual machine to a "
34803 #: ../tools/virt-tar.pl:163
34805 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
34806 "Please read the L</WARNING> section above before using this option."
34811 #: ../tools/virt-tar.pl:167
34812 msgid "You must specify exactly one of these options."
34817 #: ../tools/virt-tar.pl:173
34818 msgid "B<-z> | B<--gzip>"
34823 #: ../tools/virt-tar.pl:175
34824 msgid "Specify that the input or output tarball is gzip-compressed."
34828 #: ../tools/virt-tar.pl:288
34830 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34831 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34832 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34838 #: ../tools/virt-make-fs.pl:37
34839 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34844 #: ../tools/virt-make-fs.pl:41
34847 " virt-make-fs [--options] input.tar output.img\n"
34853 #: ../tools/virt-make-fs.pl:43
34856 " virt-make-fs [--options] input.tar.gz output.img\n"
34862 #: ../tools/virt-make-fs.pl:45
34865 " virt-make-fs [--options] directory output.img\n"
34871 #: ../tools/virt-make-fs.pl:49
34873 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34874 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34875 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34876 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34877 "you want to attach these filesystems to existing virtual machines (eg. to "
34878 "import large amounts of read-only data to a VM)."
34883 #: ../tools/virt-make-fs.pl:57
34884 msgid "Basic usage is:"
34889 #: ../tools/virt-make-fs.pl:59
34892 " virt-make-fs input output\n"
34898 #: ../tools/virt-make-fs.pl:61
34900 "where C<input> is either a directory containing files that you want to add, "
34901 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34902 "C<output> is a disk image. The input type is detected automatically. The "
34903 "output disk image defaults to a raw ext2 image unless you specify extra "
34904 "flags (see L</OPTIONS> below)."
34909 #: ../tools/virt-make-fs.pl:67
34910 msgid "EXTRA SPACE"
34915 #: ../tools/virt-make-fs.pl:69
34917 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34918 "the files that it contains, but might have extra space. Depending on how "
34919 "you are going to use the output, you might think this extra space is wasted "
34920 "and want to minimize it, or you might want to leave space so that more files "
34921 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34922 "but you can use the C<--size> flag to leave space in the filesystem if you "
34928 #: ../tools/virt-make-fs.pl:77
34930 "An alternative way to leave extra space but not make the output image any "
34931 "bigger is to use an alternative disk image format (instead of the default "
34932 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
34933 "image format (check your hypervisor supports this before using it). This "
34934 "allows you to choose a large C<--size> but the extra space won't actually be "
34935 "allocated in the image until you try to store something in it."
34939 #: ../tools/virt-make-fs.pl:85
34941 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34942 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34943 "to build another image from scratch."
34948 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34949 #: ../tools/virt-make-fs.pl:142
34955 #: ../tools/virt-make-fs.pl:91
34958 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34964 #: ../tools/virt-make-fs.pl:93
34965 msgid "FILESYSTEM TYPE"
34970 #: ../tools/virt-make-fs.pl:95
34972 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34973 "libguestfs supports can be used (but I<not> read-only formats like "
34974 "ISO9660). Here are some of the more common choices:"
34979 #: ../tools/virt-make-fs.pl:101
34985 #: ../tools/virt-make-fs.pl:103
34987 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34988 "you are not going to use the filesystem in a way that requires the journal, "
34989 "then this is just wasted overhead."
34994 #: ../tools/virt-make-fs.pl:107
34995 msgid "I<ntfs> or I<vfat>"
35000 #: ../tools/virt-make-fs.pl:109
35001 msgid "Useful if exporting data to a Windows guest."
35006 #: ../tools/virt-make-fs.pl:111
35008 "I<Note for vfat>: The tar archive or local directory must only contain files "
35009 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
35010 "program running within libguestfs is unable to change the ownership of non-"
35011 "root files, since vfat itself does not support this."
35016 #: ../tools/virt-make-fs.pl:116
35022 #: ../tools/virt-make-fs.pl:118
35024 "Lower overhead than C<ext2>, but certain limitations on filename length and "
35025 "total filesystem size."
35030 #: ../tools/virt-make-fs.pl:125
35033 " virt-make-fs --type=minix input minixfs.img\n"
35039 #: ../tools/virt-make-fs.pl:127
35040 msgid "TO PARTITION OR NOT TO PARTITION"
35045 #: ../tools/virt-make-fs.pl:129
35046 msgid "Optionally virt-make-fs can add a partition table to the output disk."
35051 #: ../tools/virt-make-fs.pl:131
35053 "Adding a partition can make the disk image more compatible with certain "
35054 "virtualized operating systems which don't expect to see a filesystem "
35055 "directly located on a block device (Linux doesn't care and will happily "
35056 "handle both types)."
35061 #: ../tools/virt-make-fs.pl:136
35063 "On the other hand, if you have a partition table then the output image is no "
35064 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
35065 "directly on a partitioned disk image. (However libguestfs tools such as "
35066 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
35071 #: ../tools/virt-make-fs.pl:144
35072 msgid "Add an MBR partition:"
35077 #: ../tools/virt-make-fs.pl:146
35080 " virt-make-fs --partition -- input disk.img\n"
35086 #: ../tools/virt-make-fs.pl:148
35088 "If the output disk image could be terabyte-sized or larger, it's better to "
35089 "use an EFI/GPT-compatible partition table:"
35094 #: ../tools/virt-make-fs.pl:151
35097 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
35103 #: ../tools/virt-make-fs.pl:179
35104 msgid "Enable debugging information."
35109 #: ../tools/virt-make-fs.pl:185
35110 msgid "B<--size=E<lt>NE<gt>>"
35115 #: ../tools/virt-make-fs.pl:187
35116 msgid "B<--size=+E<lt>NE<gt>>"
35121 #: ../tools/virt-make-fs.pl:189
35122 msgid "B<-s E<lt>NE<gt>>"
35127 #: ../tools/virt-make-fs.pl:191
35128 msgid "B<-s +E<lt>NE<gt>>"
35133 #: ../tools/virt-make-fs.pl:193
35135 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
35140 #: ../tools/virt-make-fs.pl:196
35142 "If this option is I<not> given, then the output image will be just large "
35143 "enough to contain all the files, with not much wasted space."
35148 #: ../tools/virt-make-fs.pl:199
35150 "To choose a fixed size output disk, specify an absolute number followed by b/"
35151 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35152 "Petabytes or Exabytes. This must be large enough to contain all the input "
35153 "files, else you will get an error."
35158 #: ../tools/virt-make-fs.pl:204
35160 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
35161 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35162 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
35163 "the input files, and (approximately) an extra 200 MB free space."
35168 #: ../tools/virt-make-fs.pl:210
35170 "Note that virt-make-fs estimates free space, and therefore will not produce "
35171 "filesystems containing precisely the free space requested. (It is much more "
35172 "expensive and time-consuming to produce a filesystem which has precisely the "
35173 "desired free space)."
35178 #: ../tools/virt-make-fs.pl:219
35179 msgid "B<--format=E<lt>fmtE<gt>>"
35184 #: ../tools/virt-make-fs.pl:221
35185 msgid "B<-F E<lt>fmtE<gt>>"
35190 #: ../tools/virt-make-fs.pl:223
35191 msgid "Choose the output disk image format."
35196 #: ../tools/virt-make-fs.pl:225
35197 msgid "The default is C<raw> (raw disk image)."
35202 #: ../tools/virt-make-fs.pl:227
35204 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
35205 "that would really make sense here is C<qcow2>."
35210 #: ../tools/virt-make-fs.pl:234
35211 msgid "B<--type=E<lt>fsE<gt>>"
35216 #: ../tools/virt-make-fs.pl:236
35217 msgid "B<-t E<lt>fsE<gt>>"
35222 #: ../tools/virt-make-fs.pl:238
35223 msgid "Choose the output filesystem type."
35228 #: ../tools/virt-make-fs.pl:240
35229 msgid "The default is C<ext2>."
35234 #: ../tools/virt-make-fs.pl:242
35236 "Any filesystem which is supported read-write by libguestfs can be used here."
35241 #: ../tools/virt-make-fs.pl:249
35242 msgid "B<--partition>"
35247 #: ../tools/virt-make-fs.pl:251
35248 msgid "B<--partition=E<lt>parttypeE<gt>>"
35253 #: ../tools/virt-make-fs.pl:253
35255 "If specified, this flag adds an MBR partition table to the output disk image."
35260 #: ../tools/virt-make-fs.pl:256
35262 "You can change the partition table type, eg. C<--partition=gpt> for large "
35268 #: ../tools/virt-make-fs.pl:259
35270 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
35271 "might consider the next parameter to be the partition type. For example:"
35276 #: ../tools/virt-make-fs.pl:263
35279 " virt-make-fs --partition input.tar ...\n"
35285 #: ../tools/virt-make-fs.pl:265
35287 "would cause virt-make-fs to think you wanted to use a partition type of "
35288 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
35289 "dash) between options and the input file argument:"
35294 #: ../tools/virt-make-fs.pl:269
35297 " virt-make-fs --partition -- input.tar ...\n"
35302 #: ../tools/virt-make-fs.pl:541
35304 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
35305 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
35306 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
35311 #: ../tools/virt-make-fs.pl:558
35314 " export LIBGUESTFS_DEBUG=1\n"
35315 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
35321 #: ../tools/virt-make-fs.pl:561
35323 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
35329 #: ../tools/virt-list-partitions.pl:32
35331 "virt-list-partitions - List partitions in a virtual machine or disk image"
35336 #: ../tools/virt-list-partitions.pl:36
35339 " virt-list-partitions [--options] domname\n"
35345 #: ../tools/virt-list-partitions.pl:38
35348 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35354 #: ../tools/virt-list-partitions.pl:45
35356 "C<virt-list-partitions> is a command line tool to list the partitions that "
35357 "are contained in a virtual machine or disk image. It is mainly useful as a "
35358 "first step to using L<virt-resize(1)>."
35363 #: ../tools/virt-list-partitions.pl:50
35365 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35366 "functionality. For more complex cases you should look at the L<guestfish(1)"
35372 #: ../tools/virt-list-partitions.pl:107
35373 msgid "B<-h> | B<--human-readable>"
35378 #: ../tools/virt-list-partitions.pl:109
35379 msgid "Show sizes in human-readable form (eg. \"1G\")."
35384 #: ../tools/virt-list-partitions.pl:117
35386 "With this option, C<virt-list-partitions> displays the type and size of each "
35387 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35392 #: ../tools/virt-list-partitions.pl:124
35393 msgid "B<-t> | B<--total>"
35398 #: ../tools/virt-list-partitions.pl:126
35400 "Display the total size of each block device (as a separate row or rows)."
35405 #: ../tools/virt-list-partitions.pl:259
35407 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
35408 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
35409 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."