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-03-24 12:04+0000\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:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019
928 #: ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387
929 #: ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2863
930 #: ../src/guestfs.pod:2867 ../src/guestfs.pod:2871 ../src/guestfs.pod:2875
931 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
932 #: ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585
933 #: ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599
934 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
935 #: ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607
936 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1619
937 #: ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1633
938 #: ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1641
939 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1783
940 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
941 #: ../src/guestfs-actions.pod:1854 ../src/guestfs-actions.pod:1858
942 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish.pod:432
943 #: ../fish/guestfish.pod:436 ../fish/guestfish.pod:440
944 #: ../fish/guestfish.pod:444 ../fish/guestfish-actions.pod:13
945 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380
946 #: ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395
947 #: ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072
948 #: ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080
949 #: ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092
950 #: ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100
951 #: ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114
952 #: ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208
953 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217
954 #: ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264
955 #: ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273
956 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
957 #: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345
958 #: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
964 #: ../src/guestfs.pod:390
966 "The kernel version that the command runs under will be different from what "
972 #: ../src/guestfs.pod:395
974 "If the command needs to communicate with daemons, then most likely they "
980 #: ../src/guestfs.pod:400
981 msgid "The command will be running in limited memory."
986 #: ../src/guestfs.pod:404
988 "The network may not be available unless you enable it (see L</"
989 "guestfs_set_network>)."
994 #: ../src/guestfs.pod:409
995 msgid "Only supports Linux guests (not Windows, BSD, etc)."
1000 #: ../src/guestfs.pod:413
1002 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1007 #: ../src/guestfs.pod:418
1009 "For SELinux guests, you may need to enable SELinux and load policy first. "
1010 "See L</SELINUX> in this manpage."
1015 #: ../src/guestfs.pod:423
1017 "I<Security:> It is not safe to run commands from untrusted, possibly "
1018 "malicious guests. These commands may attempt to exploit your program by "
1019 "sending unexpected output. They could also try to exploit the Linux kernel "
1020 "or qemu provided by the libguestfs appliance. They could use the network "
1021 "provided by the libguestfs appliance to bypass ordinary network partitions "
1022 "and firewalls. They could use the elevated privileges or different SELinux "
1023 "context of your program to their advantage."
1028 #: ../src/guestfs.pod:432
1030 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1031 "(a script which runs when the guest next boots normally), and to have this "
1032 "script run the commands you want in the normal context of the running guest, "
1033 "network security and so on. For information about other security issues, "
1039 #: ../src/guestfs.pod:440
1041 "The two main API calls to run commands are L</guestfs_command> and L</"
1042 "guestfs_sh> (there are also variations)."
1047 #: ../src/guestfs.pod:443
1049 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1050 "shell globs, redirections, etc will work."
1055 #: ../src/guestfs.pod:446
1056 msgid "CONFIGURATION FILES"
1061 #: ../src/guestfs.pod:448
1063 "To read and write configuration files in Linux guest filesystems, we "
1064 "strongly recommend using Augeas. For example, Augeas understands how to "
1065 "read and write, say, a Linux shadow password file or X.org configuration "
1066 "file, and so avoids you having to write that code."
1071 #: ../src/guestfs.pod:453
1073 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1074 "document Augeas itself here because there is excellent documentation on the "
1075 "L<http://augeas.net/> website."
1080 #: ../src/guestfs.pod:457
1082 "If you don't want to use Augeas (you fool!) then try calling L</"
1083 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1089 #: ../src/guestfs.pod:461
1095 #: ../src/guestfs.pod:463
1097 "We support SELinux guests. To ensure that labeling happens correctly in "
1098 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1103 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1104 #: ../src/guestfs.pod:2426
1110 #: ../src/guestfs.pod:471
1111 msgid "Before launching, do:"
1116 #: ../src/guestfs.pod:473
1119 " guestfs_set_selinux (g, 1);\n"
1125 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1126 #: ../src/guestfs.pod:2451
1132 #: ../src/guestfs.pod:477
1134 "After mounting the guest's filesystem(s), load the policy. This is best "
1135 "done by running the L<load_policy(8)> command in the guest itself:"
1140 #: ../src/guestfs.pod:481
1143 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1149 #: ../src/guestfs.pod:483
1151 "(Older versions of C<load_policy> require you to specify the name of the "
1157 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1163 #: ../src/guestfs.pod:488
1165 "Optionally, set the security context for the API. The correct security "
1166 "context to use can only be known by inspecting the guest. As an example:"
1171 #: ../src/guestfs.pod:492
1174 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1180 #: ../src/guestfs.pod:496
1181 msgid "This will work for running commands and editing existing files."
1186 #: ../src/guestfs.pod:498
1188 "When new files are created, you may need to label them explicitly, for "
1189 "example by running the external command C<restorecon pathname>."
1194 #: ../src/guestfs.pod:502
1200 #: ../src/guestfs.pod:504
1202 "Certain calls are affected by the current file mode creation mask (the "
1203 "\"umask\"). In particular ones which create files or directories, such as "
1204 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1205 "either the default mode that the file is created with or modifies the mode "
1211 #: ../src/guestfs.pod:510
1213 "The default umask is C<022>, so files are created with modes such as C<0644> "
1214 "and directories with C<0755>."
1219 #: ../src/guestfs.pod:513
1221 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1222 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1223 "guestfs_chmod> after creating each file or directory."
1228 #: ../src/guestfs.pod:517
1229 msgid "For more information about umask, see L<umask(2)>."
1234 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:751
1235 msgid "ENCRYPTED DISKS"
1240 #: ../src/guestfs.pod:521
1242 "Libguestfs allows you to access Linux guests which have been encrypted using "
1243 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1244 "standard. This includes nearly all whole disk encryption systems used by "
1245 "modern Linux guests."
1250 #: ../src/guestfs.pod:527
1252 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1253 "returns the string C<crypto_LUKS>)."
1258 #: ../src/guestfs.pod:530
1260 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1261 "will require the passphrase!"
1266 #: ../src/guestfs.pod:533
1268 "Opening a LUKS device creates a new device mapper device called C</dev/"
1269 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1270 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1271 "from and encrypted to the underlying block device respectively."
1276 #: ../src/guestfs.pod:539
1278 "LVM volume groups on the device can be made visible by calling L</"
1279 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1280 "(s) can now be mounted in the usual way."
1285 #: ../src/guestfs.pod:543
1287 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1288 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1289 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1290 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1291 "underlying encrypted block device)."
1296 #: ../src/guestfs.pod:550
1301 #: ../src/guestfs.pod:552
1303 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1304 "contains operating systems, an install CD or a live CD. (These APIs used to "
1305 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1306 "version 1.5.3 the most frequently used part of this library has been "
1307 "rewritten in C and moved into the core code)."
1312 #: ../src/guestfs.pod:559
1314 "Add all disks belonging to the unknown virtual machine and call L</"
1315 "guestfs_launch> in the usual way."
1320 #: ../src/guestfs.pod:562
1322 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1323 "and certain heuristics, and returns a list of operating systems that were "
1324 "found. An empty list means none were found. A single element is the root "
1325 "filesystem of the operating system. For dual- or multi-boot guests, "
1326 "multiple roots can be returned, each one corresponding to a separate "
1327 "operating system. (Multi-boot virtual machines are extremely rare in the "
1328 "world of virtualization, but since this scenario can happen, we have built "
1329 "libguestfs to deal with it.)"
1334 #: ../src/guestfs.pod:571
1336 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1337 "to get additional details about that operating system. For example, call L</"
1338 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1339 "Windows and Linux-based operating systems respectively."
1344 #: ../src/guestfs.pod:577
1346 "Un*x-like and Linux-based operating systems usually consist of several "
1347 "filesystems which are mounted at boot time (for example, a separate boot "
1348 "partition mounted on C</boot>). The inspection rules are able to detect how "
1349 "filesystems correspond to mount points. Call "
1350 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1351 "hash table like this example:"
1356 #: ../src/guestfs.pod:584
1359 " /boot => /dev/sda1\n"
1360 " / => /dev/vg_guest/lv_root\n"
1361 " /usr => /dev/vg_guest/lv_usr\n"
1367 #: ../src/guestfs.pod:588
1369 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1370 "filesystems as suggested."
1375 #: ../src/guestfs.pod:591
1377 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1378 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1383 #: ../src/guestfs.pod:595
1385 "Inspection currently only works for some common operating systems. "
1386 "Contributors are welcome to send patches for other operating systems that we "
1387 "currently cannot detect."
1392 #: ../src/guestfs.pod:599
1394 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1395 "for more details. The L</guestfs_inspect_os> function just ignores any "
1396 "encrypted devices."
1401 #: ../src/guestfs.pod:603
1403 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1404 "inspection and caches the results in the guest handle. Subsequent calls to "
1405 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1406 "read the disks. If you change the content of the guest disks, you can redo "
1407 "inspection by calling L</guestfs_inspect_os> again. (L</"
1408 "guestfs_inspect_list_applications> works a little differently from the other "
1409 "calls and does read the disks. See documentation for that function for "
1414 #: ../src/guestfs.pod:612
1415 msgid "INSPECTING INSTALL DISKS"
1419 #: ../src/guestfs.pod:614
1421 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1426 #: ../src/guestfs.pod:617
1428 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1429 "system, which currently can be C<installed> (a regular operating system) or "
1430 "C<installer> (some sort of install disk)."
1434 #: ../src/guestfs.pod:621
1436 "Further information is available about the operating system that can be "
1437 "installed using the regular inspection APIs like L</"
1438 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1442 #: ../src/guestfs.pod:626
1444 "Some additional information specific to installer disks is also available "
1445 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1446 "guestfs_inspect_is_multipart> calls."
1451 #: ../src/guestfs.pod:631
1452 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1457 #: ../src/guestfs.pod:633
1459 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1460 "ntfs-3g.org/> driver."
1465 #: ../src/guestfs.pod:636
1466 msgid "DRIVE LETTERS AND PATHS"
1471 #: ../src/guestfs.pod:638
1473 "DOS and Windows still use drive letters, and the filesystems are always "
1474 "treated as case insensitive by Windows itself, and therefore you might find "
1475 "a Windows configuration file referring to a path like C<c:\\windows"
1476 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1477 "might be referred to as C</WINDOWS/System32>."
1482 #: ../src/guestfs.pod:644
1484 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1485 "libguestfs to read the appropriate Windows Registry and configuration files, "
1486 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1492 #: ../src/guestfs.pod:649
1494 "Replacing backslash characters with forward slash characters is also outside "
1495 "the scope of libguestfs, but something that you can easily do."
1500 #: ../src/guestfs.pod:652
1502 "Where we can help is in resolving the case insensitivity of paths. For "
1503 "this, call L</guestfs_case_sensitive_path>."
1508 #: ../src/guestfs.pod:655
1509 msgid "ACCESSING THE WINDOWS REGISTRY"
1514 #: ../src/guestfs.pod:657
1516 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1517 "files, through the library C<hivex> which is part of the libguestfs project "
1518 "although ships as a separate tarball. You have to locate and download the "
1519 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1520 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1521 "reg(1)> for more help on this issue."
1526 #: ../src/guestfs.pod:665
1527 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1532 #: ../src/guestfs.pod:667
1534 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1535 "provide something which looks like a Linux symlink. The way it tries to do "
1536 "the rewriting is described here:"
1541 #: ../src/guestfs.pod:671
1543 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1549 #: ../src/guestfs.pod:673
1551 "The essential problem is that ntfs-3g simply does not have enough "
1552 "information to do a correct job. NTFS links can contain drive letters and "
1553 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1554 "It is almost certainly the case that libguestfs callers should ignore what "
1555 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1560 #: ../src/guestfs.pod:680
1562 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1563 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1564 "attribute, and read the raw reparse data from that (you can find the format "
1565 "documented in various places around the web)."
1570 #: ../src/guestfs.pod:685
1571 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1576 #: ../src/guestfs.pod:687
1578 "There are other useful extended attributes that can be read from ntfs-3g "
1579 "filesystems (using L</guestfs_getxattr>). See:"
1584 #: ../src/guestfs.pod:690
1586 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1591 #: ../src/guestfs.pod:692
1592 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1597 #: ../src/guestfs.pod:694
1599 "Although we don't want to discourage you from using the C API, we will "
1600 "mention here that the same API is also available in other languages."
1604 #: ../src/guestfs.pod:697
1606 "The API is broadly identical in all supported languages. This means that "
1607 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1608 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1609 "OCaml. In other words, a straightforward, predictable isomorphism between "
1615 #: ../src/guestfs.pod:703
1617 "Error messages are automatically transformed into exceptions if the language "
1623 #: ../src/guestfs.pod:706
1625 "We don't try to \"object orientify\" parts of the API in OO languages, "
1626 "although contributors are welcome to write higher level APIs above what we "
1627 "provide in their favourite languages if they wish."
1632 #: ../src/guestfs.pod:712
1638 #: ../src/guestfs.pod:714
1640 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1641 "identical to the C API. C++ classes and exceptions are not used."
1646 #: ../src/guestfs.pod:718
1652 #: ../src/guestfs.pod:720
1654 "The C# bindings are highly experimental. Please read the warnings at the "
1655 "top of C<csharp/Libguestfs.cs>."
1660 #: ../src/guestfs.pod:723
1666 #: ../src/guestfs.pod:725
1668 "This is the only language binding that is working but incomplete. Only "
1669 "calls which return simple integers have been bound in Haskell, and we are "
1670 "looking for help to complete this binding."
1675 #: ../src/guestfs.pod:729
1681 #: ../src/guestfs.pod:731
1683 "Full documentation is contained in the Javadoc which is distributed with "
1689 #: ../src/guestfs.pod:734
1694 #: ../src/guestfs.pod:736
1695 msgid "See L<guestfs-ocaml(3)>."
1700 #: ../src/guestfs.pod:738
1705 #: ../src/guestfs.pod:740
1706 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1711 #: ../src/guestfs.pod:742
1717 #: ../src/guestfs.pod:744
1719 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1720 "the php-libguestfs package for your distribution."
1725 #: ../src/guestfs.pod:747
1726 msgid "The PHP binding only works correctly on 64 bit machines."
1731 #: ../src/guestfs.pod:749
1736 #: ../src/guestfs.pod:751
1737 msgid "See L<guestfs-python(3)>."
1742 #: ../src/guestfs.pod:753
1747 #: ../src/guestfs.pod:755
1748 msgid "See L<guestfs-ruby(3)>."
1753 #: ../src/guestfs.pod:757
1754 msgid "B<shell scripts>"
1758 #: ../src/guestfs.pod:759
1759 msgid "See L<guestfish(1)>."
1764 #: ../src/guestfs.pod:763
1765 msgid "LIBGUESTFS GOTCHAS"
1770 #: ../src/guestfs.pod:765
1772 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1773 "system [...] that works in the way it is documented but is counterintuitive "
1774 "and almost invites mistakes.\""
1779 #: ../src/guestfs.pod:769
1781 "Since we developed libguestfs and the associated tools, there are several "
1782 "things we would have designed differently, but are now stuck with for "
1783 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1784 "release, you can expect these to change. Beware of them."
1789 #: ../src/guestfs.pod:777
1790 msgid "Autosync / forgetting to sync."
1795 #: ../src/guestfs.pod:779
1797 "When modifying a filesystem from C or another language, you B<must> unmount "
1798 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1799 "libguestfs handle. You can also call:"
1804 #: ../src/guestfs.pod:783
1807 " guestfs_set_autosync (g, 1);\n"
1813 #: ../src/guestfs.pod:785
1815 "to have the unmount/sync done automatically for you when the handle 'g' is "
1816 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1821 #: ../src/guestfs.pod:789
1823 "If you forget to do this, then it is entirely possible that your changes "
1824 "won't be written out, or will be partially written, or (very rarely) that "
1825 "you'll get disk corruption."
1830 #: ../src/guestfs.pod:793
1832 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1833 "guestfish scripts that forget to sync will work just fine, which can make "
1834 "this very puzzling if you are trying to debug a problem."
1839 #: ../src/guestfs.pod:797
1841 "Update: Autosync is enabled by default for all API users starting from "
1842 "libguestfs 1.5.24."
1847 #: ../src/guestfs.pod:800
1848 msgid "Mount option C<-o sync> should not be the default."
1853 #: ../src/guestfs.pod:802
1855 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1856 "However C<-o sync> does not add any reliability benefit, but does have a "
1857 "very large performance impact."
1862 #: ../src/guestfs.pod:806
1864 "The work around is to use L</guestfs_mount_options> and set the mount "
1865 "options that you actually want to use."
1870 #: ../src/guestfs.pod:809
1871 msgid "Read-only should be the default."
1876 #: ../src/guestfs.pod:811
1878 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1879 "specify I<--rw> if you want to make changes to the image."
1884 #: ../src/guestfs.pod:814
1885 msgid "This would reduce the potential to corrupt live VM images."
1890 #: ../src/guestfs.pod:816
1892 "Note that many filesystems change the disk when you just mount and unmount, "
1893 "even if you didn't perform any writes. You need to use L</"
1894 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1899 #: ../src/guestfs.pod:820
1900 msgid "guestfish command line is hard to use."
1905 #: ../src/guestfs.pod:822
1907 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1908 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1909 "exist, so it fails. In earlier versions of guestfish the error message was "
1910 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1911 "we should have used C<guestfish -c command> to run commands."
1916 #: ../src/guestfs.pod:829
1917 msgid "guestfish megabyte modifiers don't work right on all commands"
1922 #: ../src/guestfs.pod:831
1924 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1925 "other modifiers). What guestfish actually does is to multiply the number "
1926 "part by the modifier part and pass the result to the C API. However this "
1927 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1928 "expecting some other unit (eg. megabytes)."
1933 #: ../src/guestfs.pod:838
1934 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1939 #: ../src/guestfs.pod:840
1942 " lvcreate LV VG 100M\n"
1948 #: ../src/guestfs.pod:842
1950 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1951 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1952 "megabytes * megabytes) logical volume. The error message you get from this "
1953 "is also a little obscure."
1958 #: ../src/guestfs.pod:847
1960 "This could be fixed in the generator by specially marking parameters and "
1961 "return values which take bytes or other units."
1966 #: ../src/guestfs.pod:850
1967 msgid "Ambiguity between devices and paths"
1972 #: ../src/guestfs.pod:852
1974 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1975 "sdb2>) and a similar pathname. A file might just happen to be called "
1976 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1981 #: ../src/guestfs.pod:857
1983 "In the current API we usually resolve this ambiguity by having two separate "
1984 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1985 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1986 "detecting if the path supplied begins with C</dev/>."
1991 #: ../src/guestfs.pod:863
1993 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1994 "make paths/devices into structured names. One way to do this would be to "
1995 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1996 "aspect of grub. Another way would be to use a structured type, equivalent "
1997 "to this OCaml type:"
2002 #: ../src/guestfs.pod:869
2005 " type path = Path of string | Device of int | Partition of int * int\n"
2011 #: ../src/guestfs.pod:871
2012 msgid "which would allow you to pass arguments like:"
2017 #: ../src/guestfs.pod:873
2020 " Path \"/foo/bar\"\n"
2021 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2022 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2023 " Path \"/dev/sdb2\" (* not a device *)\n"
2029 #: ../src/guestfs.pod:878
2031 "As you can see there are still problems to resolve even with this "
2032 "representation. Also consider how it might work in guestfish."
2037 #: ../src/guestfs.pod:883
2038 msgid "PROTOCOL LIMITS"
2043 #: ../src/guestfs.pod:885
2045 "Internally libguestfs uses a message-based protocol to pass API calls and "
2046 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2047 "plenty more detail about this). The maximum message size used by the "
2048 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2049 "aware of this limit. The API calls which may be affected are individually "
2050 "documented, with a link back to this section of the documentation."
2055 #: ../src/guestfs.pod:893
2057 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2058 "a simple string. Because this string is at some point internally encoded as "
2059 "a message, the maximum size that it can return is slightly under 4 MB. If "
2060 "the requested file is larger than this then you will get an error."
2065 #: ../src/guestfs.pod:899
2067 "In order to transfer large files into and out of the guest filesystem, you "
2068 "need to use particular calls that support this. The sections L</UPLOADING> "
2069 "and L</DOWNLOADING> document how to do this."
2074 #: ../src/guestfs.pod:903
2076 "You might also consider mounting the disk image using our FUSE filesystem "
2077 "support (L<guestmount(1)>)."
2082 #: ../src/guestfs.pod:906
2083 msgid "KEYS AND PASSPHRASES"
2088 #: ../src/guestfs.pod:908
2090 "Certain libguestfs calls take a parameter that contains sensitive key "
2091 "material, passed in as a C string."
2096 #: ../src/guestfs.pod:911
2098 "In the future we would hope to change the libguestfs implementation so that "
2099 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2100 "swap. However this is I<not> done at the moment, because of the complexity "
2101 "of such an implementation."
2106 #: ../src/guestfs.pod:916
2108 "Therefore you should be aware that any key parameter you pass to libguestfs "
2109 "might end up being written out to the swap partition. If this is a concern, "
2110 "scrub the swap partition or don't use libguestfs on encrypted devices."
2115 #: ../src/guestfs.pod:921
2116 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2121 #: ../src/guestfs.pod:923
2123 "All high-level libguestfs actions are synchronous. If you want to use "
2124 "libguestfs asynchronously then you must create a thread."
2129 #: ../src/guestfs.pod:926
2131 "Only use the handle from a single thread. Either use the handle exclusively "
2132 "from one thread, or provide your own mutex so that two threads cannot issue "
2133 "calls on the same handle at the same time."
2138 #: ../src/guestfs.pod:930
2140 "See the graphical program guestfs-browser for one possible architecture for "
2141 "multithreaded programs using libvirt and libguestfs."
2146 #: ../src/guestfs.pod:933
2151 #: ../src/guestfs.pod:935
2153 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2159 #: ../src/guestfs.pod:938
2161 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2162 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2167 #: ../src/guestfs.pod:941
2169 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2170 "to change the directories that libguestfs will search in. The value is a "
2171 "colon-separated list of paths. The current directory is I<not> searched "
2172 "unless the path contains an empty element or C<.>. For example "
2173 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2174 "then C</usr/lib/guestfs>."
2179 #: ../src/guestfs.pod:948
2180 msgid "QEMU WRAPPERS"
2185 #: ../src/guestfs.pod:950
2187 "If you want to compile your own qemu, run qemu from a non-standard location, "
2188 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2194 #: ../src/guestfs.pod:954
2196 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2197 "last command in the shell script (so that qemu replaces the shell and "
2198 "becomes the direct child of the libguestfs-using program). If you don't do "
2199 "this, then the qemu process won't be cleaned up correctly."
2204 #: ../src/guestfs.pod:959
2206 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2212 #: ../src/guestfs.pod:962
2216 " qemudir=/home/rjones/d/qemu\n"
2217 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2223 #: ../src/guestfs.pod:966
2225 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2226 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2232 #: ../src/guestfs.pod:970
2235 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2241 #: ../src/guestfs.pod:972
2243 "Note that libguestfs also calls qemu with the -help and -version options in "
2244 "order to determine features."
2248 #: ../src/guestfs.pod:975
2249 msgid "ATTACHING TO RUNNING DAEMONS"
2253 #: ../src/guestfs.pod:977
2255 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2256 "babies. Use with caution."
2260 #: ../src/guestfs.pod:980
2262 "I<Note (2):> This section explains how to attach to a running daemon from a "
2263 "low level perspective. For most users, simply using virt tools such as "
2264 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2268 #: ../src/guestfs.pod:984
2269 msgid "Using guestfs_set_attach_method"
2273 #: ../src/guestfs.pod:986
2275 "By calling L</guestfs_set_attach_method> you can change how the library "
2276 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2277 "ARCHITECTURE> for some background)."
2281 #: ../src/guestfs.pod:990
2283 "The normal attach method is C<appliance>, where a small appliance is created "
2284 "containing the daemon, and then the library connects to this."
2288 #: ../src/guestfs.pod:993
2290 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2291 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2292 "daemon over the Unix domain socket."
2296 #: ../src/guestfs.pod:997
2298 "The normal use for this is to connect to a running virtual machine that "
2299 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2300 "files inside the live virtual machine."
2304 #: ../src/guestfs.pod:1001
2305 msgid "Using guestfs_add_domain with live flag"
2309 #: ../src/guestfs.pod:1003
2311 "L</guestfs_add_domain> provides some help for getting the correct attach "
2312 "method. If you pass the C<live> option to this function, then (if the "
2313 "virtual machine is running) it will examine the libvirt XML looking for a "
2314 "virtio-serial channel to connect to:"
2318 #: ../src/guestfs.pod:1009
2325 " <channel type='unix'>\n"
2326 " <source mode='bind' path='/path/to/socket'/>\n"
2327 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2336 #: ../src/guestfs.pod:1021
2338 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2339 "method to C<unix:/path/to/socket>."
2343 #: ../src/guestfs.pod:1024
2345 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2346 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2347 "to attach to and modify live virtual machines."
2351 #: ../src/guestfs.pod:1028
2353 "The virtual machine needs to have been set up beforehand so that it has the "
2354 "virtio-serial channel and so that guestfsd is running inside it."
2359 #: ../src/guestfs.pod:1032
2360 msgid "ABI GUARANTEE"
2365 #: ../src/guestfs.pod:1034
2367 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2368 "actions as outlined in this section. Although we will deprecate some "
2369 "actions, for example if they get replaced by newer calls, we will keep the "
2370 "old actions forever. This allows you the developer to program in confidence "
2371 "against the libguestfs API."
2376 #: ../src/guestfs.pod:1040
2377 msgid "BLOCK DEVICE NAMING"
2382 #: ../src/guestfs.pod:1042
2384 "In the kernel there is now quite a profusion of schemata for naming block "
2385 "devices (in this context, by I<block device> I mean a physical or virtual "
2386 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2387 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2388 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2389 "for the old IDE driver (particularly for SATA devices) those devices also "
2390 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2391 "paravirtualized drivers. This has created several different naming systems, "
2392 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2397 #: ../src/guestfs.pod:1054
2399 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2400 "Linux kernel to access block devices. We can run a variety of appliances "
2401 "based on a variety of Linux kernels."
2406 #: ../src/guestfs.pod:1058
2408 "This causes a problem for libguestfs because many API calls use device or "
2409 "partition names. Working scripts and the recipe (example) scripts that we "
2410 "make available over the internet could fail if the naming scheme changes."
2415 #: ../src/guestfs.pod:1063
2417 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2418 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2419 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2420 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2425 #: ../src/guestfs.pod:1069
2427 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2428 "L</guestfs_list_partitions> and similar calls return the true names of the "
2429 "devices and partitions as known to the appliance."
2434 #: ../src/guestfs.pod:1074
2435 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2440 #: ../src/guestfs.pod:1076
2442 "Usually this translation is transparent. However in some (very rare) cases "
2443 "you may need to know the exact algorithm. Such cases include where you use "
2444 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2445 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2450 #: ../src/guestfs.pod:1082
2452 "The algorithm is applied only to I<parameters> which are known to be either "
2453 "device or partition names. Return values from functions such as L</"
2454 "guestfs_list_devices> are never changed."
2459 #: ../src/guestfs.pod:1090
2460 msgid "Is the string a parameter which is a device or partition name?"
2465 #: ../src/guestfs.pod:1094
2466 msgid "Does the string begin with C</dev/sd>?"
2471 #: ../src/guestfs.pod:1098
2473 "Does the named device exist? If so, we use that device. However if I<not> "
2474 "then we continue with this algorithm."
2479 #: ../src/guestfs.pod:1103
2480 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2485 #: ../src/guestfs.pod:1105
2486 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2491 #: ../src/guestfs.pod:1107
2492 msgid "If that named device exists, use it. If not, continue."
2497 #: ../src/guestfs.pod:1111
2498 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2503 #: ../src/guestfs.pod:1113
2504 msgid "If that named device exists, use it. If not, return an error."
2509 #: ../src/guestfs.pod:1117
2510 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2515 #: ../src/guestfs.pod:1119
2517 "Although the standard naming scheme and automatic translation is useful for "
2518 "simple programs and guestfish scripts, for larger programs it is best not to "
2519 "rely on this mechanism."
2524 #: ../src/guestfs.pod:1123
2526 "Where possible for maximum future portability programs using libguestfs "
2527 "should use these future-proof techniques:"
2532 #: ../src/guestfs.pod:1130
2534 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2535 "device names, and then use those names directly."
2540 #: ../src/guestfs.pod:1133
2542 "Since those device names exist by definition, they will never be translated."
2547 #: ../src/guestfs.pod:1138
2549 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2550 "filesystem labels."
2555 #: ../src/guestfs.pod:1143
2561 #: ../src/guestfs.pod:1145
2563 "This section discusses security implications of using libguestfs, "
2564 "particularly with untrusted or malicious guests or disk images."
2569 #: ../src/guestfs.pod:1148
2570 msgid "GENERAL SECURITY CONSIDERATIONS"
2575 #: ../src/guestfs.pod:1150
2577 "Be careful with any files or data that you download from a guest (by "
2578 "\"download\" we mean not just the L</guestfs_download> command but any "
2579 "command that reads files, filenames, directories or anything else from a "
2580 "disk image). An attacker could manipulate the data to fool your program "
2581 "into doing the wrong thing. Consider cases such as:"
2586 #: ../src/guestfs.pod:1160
2587 msgid "the data (file etc) not being present"
2592 #: ../src/guestfs.pod:1164
2593 msgid "being present but empty"
2598 #: ../src/guestfs.pod:1168
2599 msgid "being much larger than normal"
2604 #: ../src/guestfs.pod:1172
2605 msgid "containing arbitrary 8 bit data"
2610 #: ../src/guestfs.pod:1176
2611 msgid "being in an unexpected character encoding"
2616 #: ../src/guestfs.pod:1180
2617 msgid "containing homoglyphs."
2622 #: ../src/guestfs.pod:1184
2623 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2628 #: ../src/guestfs.pod:1186
2630 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2631 "(VFS) module can sometimes be escalated into exploits by deliberately "
2632 "creating a malicious, malformed filesystem. These exploits are very severe "
2633 "for two reasons. Firstly there are very many filesystem drivers in the "
2634 "kernel, and many of them are infrequently used and not much developer "
2635 "attention has been paid to the code. Linux userspace helps potential "
2636 "crackers by detecting the filesystem type and automatically choosing the "
2637 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2638 "the administrator. Secondly, a kernel-level exploit is like a local root "
2639 "exploit (worse in some ways), giving immediate and total access to the "
2640 "system right down to the hardware level."
2645 #: ../src/guestfs.pod:1199
2647 "That explains why you should never mount a filesystem from an untrusted "
2648 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2649 "inside a qemu virtual machine, usually running as a non-root user. The "
2650 "attacker would need to write a filesystem which first exploited the kernel, "
2651 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2652 "the libguestfs protocol, and finally to be as serious as the host kernel "
2653 "exploit it would need to escalate its privileges to root. This multi-step "
2654 "escalation, performed by a static piece of data, is thought to be extremely "
2655 "hard to do, although we never say 'never' about security issues."
2660 #: ../src/guestfs.pod:1210
2662 "In any case callers can reduce the attack surface by forcing the filesystem "
2663 "type when mounting (use L</guestfs_mount_vfs>)."
2668 #: ../src/guestfs.pod:1213
2669 msgid "PROTOCOL SECURITY"
2674 #: ../src/guestfs.pod:1215
2676 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2677 "defined upper message size. However a program that uses libguestfs must "
2678 "also take care - for example you can write a program that downloads a binary "
2679 "from a disk image and executes it locally, and no amount of protocol "
2680 "security will save you from the consequences."
2685 #: ../src/guestfs.pod:1221
2686 msgid "INSPECTION SECURITY"
2691 #: ../src/guestfs.pod:1223
2693 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2694 "directly from the guest, and these could contain any 8 bit data. Callers "
2695 "should be careful to escape these before printing them to a structured file "
2696 "(for example, use HTML escaping if creating a web page)."
2701 #: ../src/guestfs.pod:1229
2703 "Guest configuration may be altered in unusual ways by the administrator of "
2704 "the virtual machine, and may not reflect reality (particularly for untrusted "
2705 "or actively malicious guests). For example we parse the hostname from "
2706 "configuration files like C</etc/sysconfig/network> that we find in the "
2707 "guest, but the guest administrator can easily manipulate these files to "
2708 "provide the wrong hostname."
2713 #: ../src/guestfs.pod:1237
2715 "The inspection API parses guest configuration using two external libraries: "
2716 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2717 "designed to be robust in the face of malicious data, although denial of "
2718 "service attacks are still possible, for example with oversized configuration "
2724 #: ../src/guestfs.pod:1243
2725 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2730 #: ../src/guestfs.pod:1245
2732 "Be very cautious about running commands from the guest. By running a "
2733 "command in the guest, you are giving CPU time to a binary that you do not "
2734 "control, under the same user account as the library, albeit wrapped in qemu "
2735 "virtualization. More information and alternatives can be found in the "
2736 "section L</RUNNING COMMANDS>."
2741 #: ../src/guestfs.pod:1251
2742 msgid "CVE-2010-3851"
2747 #: ../src/guestfs.pod:1253
2748 msgid "https://bugzilla.redhat.com/642934"
2753 #: ../src/guestfs.pod:1255
2755 "This security bug concerns the automatic disk format detection that qemu "
2756 "does on disk images."
2761 #: ../src/guestfs.pod:1258
2763 "A raw disk image is just the raw bytes, there is no header. Other disk "
2764 "images like qcow2 contain a special header. Qemu deals with this by looking "
2765 "for one of the known headers, and if none is found then assuming the disk "
2766 "image must be raw."
2771 #: ../src/guestfs.pod:1263
2773 "This allows a guest which has been given a raw disk image to write some "
2774 "other header. At next boot (or when the disk image is accessed by "
2775 "libguestfs) qemu would do autodetection and think the disk image format was, "
2776 "say, qcow2 based on the header written by the guest."
2781 #: ../src/guestfs.pod:1268
2783 "This in itself would not be a problem, but qcow2 offers many features, one "
2784 "of which is to allow a disk image to refer to another image (called the "
2785 "\"backing disk\"). It does this by placing the path to the backing disk "
2786 "into the qcow2 header. This path is not validated and could point to any "
2787 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2788 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2789 "control of the attacker."
2794 #: ../src/guestfs.pod:1276
2796 "In libguestfs this is rather hard to exploit except under two circumstances:"
2801 #: ../src/guestfs.pod:1283
2802 msgid "You have enabled the network or have opened the disk in write mode."
2807 #: ../src/guestfs.pod:1287
2809 "You are also running untrusted code from the guest (see L</RUNNING "
2815 #: ../src/guestfs.pod:1292
2817 "The way to avoid this is to specify the expected disk format when adding "
2818 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2819 "should always do this if the disk is raw format, and it's a good idea for "
2825 #: ../src/guestfs.pod:1297
2827 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2828 "format is fetched from libvirt and passed through."
2833 #: ../src/guestfs.pod:1300
2835 "For libguestfs tools, use the I<--format> command line parameter as "
2841 #: ../src/guestfs.pod:1303
2842 msgid "CONNECTION MANAGEMENT"
2847 #: ../src/guestfs.pod:1305
2853 #: ../src/guestfs.pod:1307
2855 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2856 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2857 "handle and release all resources used."
2862 #: ../src/guestfs.pod:1311
2864 "For information on using multiple handles and threads, see the section L</"
2865 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2870 #: ../src/guestfs.pod:1314
2871 msgid "guestfs_create"
2876 #: ../src/guestfs.pod:1316
2879 " guestfs_h *guestfs_create (void);\n"
2885 #: ../src/guestfs.pod:1318
2886 msgid "Create a connection handle."
2891 #: ../src/guestfs.pod:1320
2893 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2894 "on the handle at least once."
2899 #: ../src/guestfs.pod:1323
2901 "This function returns a non-NULL pointer to a handle on success or NULL on "
2907 #: ../src/guestfs.pod:1326
2908 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2913 #: ../src/guestfs.pod:1328
2915 "You may also want to configure error handling for the handle. See L</ERROR "
2916 "HANDLING> section below."
2921 #: ../src/guestfs.pod:1331
2922 msgid "guestfs_close"
2927 #: ../src/guestfs.pod:1333
2930 " void guestfs_close (guestfs_h *g);\n"
2936 #: ../src/guestfs.pod:1335
2937 msgid "This closes the connection handle and frees up all resources used."
2942 #: ../src/guestfs.pod:1337
2943 msgid "ERROR HANDLING"
2948 #: ../src/guestfs.pod:1339
2950 "API functions can return errors. For example, almost all functions that "
2951 "return C<int> will return C<-1> to indicate an error."
2956 #: ../src/guestfs.pod:1342
2958 "Additional information is available for errors: an error message string and "
2959 "optionally an error number (errno) if the thing that failed was a system "
2965 #: ../src/guestfs.pod:1346
2967 "You can get at the additional information about the last error on the handle "
2968 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2969 "up an error handler with L</guestfs_set_error_handler>."
2974 #: ../src/guestfs.pod:1351
2976 "When the handle is created, a default error handler is installed which "
2977 "prints the error message string to C<stderr>. For small short-running "
2978 "command line programs it is sufficient to do:"
2983 #: ../src/guestfs.pod:1355
2986 " if (guestfs_launch (g) == -1)\n"
2987 " exit (EXIT_FAILURE);\n"
2993 #: ../src/guestfs.pod:1358
2995 "since the default error handler will ensure that an error message has been "
2996 "printed to C<stderr> before the program exits."
3001 #: ../src/guestfs.pod:1361
3003 "For other programs the caller will almost certainly want to install an "
3004 "alternate error handler or do error handling in-line like this:"
3009 #: ../src/guestfs.pod:1364
3012 " g = guestfs_create ();\n"
3018 #: ../src/guestfs.pod:1366
3021 " /* This disables the default behaviour of printing errors\n"
3023 " guestfs_set_error_handler (g, NULL, NULL);\n"
3029 #: ../src/guestfs.pod:1370
3032 " if (guestfs_launch (g) == -1) {\n"
3033 " /* Examine the error message and print it etc. */\n"
3034 " char *msg = guestfs_last_error (g);\n"
3035 " int errnum = guestfs_last_errno (g);\n"
3036 " fprintf (stderr, \"%s\\n\", msg);\n"
3044 #: ../src/guestfs.pod:1378
3046 "Out of memory errors are handled differently. The default action is to call "
3047 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3048 "guestfs_set_out_of_memory_handler>."
3053 #: ../src/guestfs.pod:1382
3055 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3056 "because there is no handle if this happens there is no way to get additional "
3057 "error information. However L</guestfs_create> is supposed to be a "
3058 "lightweight operation which can only fail because of insufficient memory (it "
3059 "returns NULL in this case)."
3064 #: ../src/guestfs.pod:1388
3065 msgid "guestfs_last_error"
3070 #: ../src/guestfs.pod:1390
3073 " const char *guestfs_last_error (guestfs_h *g);\n"
3079 #: ../src/guestfs.pod:1392
3081 "This returns the last error message that happened on C<g>. If there has not "
3082 "been an error since the handle was created, then this returns C<NULL>."
3087 #: ../src/guestfs.pod:1396
3089 "The lifetime of the returned string is until the next error occurs, or L</"
3090 "guestfs_close> is called."
3095 #: ../src/guestfs.pod:1399
3096 msgid "guestfs_last_errno"
3101 #: ../src/guestfs.pod:1401
3104 " int guestfs_last_errno (guestfs_h *g);\n"
3110 #: ../src/guestfs.pod:1403
3111 msgid "This returns the last error number (errno) that happened on C<g>."
3116 #: ../src/guestfs.pod:1405
3117 msgid "If successful, an errno integer not equal to zero is returned."
3122 #: ../src/guestfs.pod:1407
3124 "If no error, this returns 0. This call can return 0 in three situations:"
3129 #: ../src/guestfs.pod:1414
3130 msgid "There has not been any error on the handle."
3135 #: ../src/guestfs.pod:1418
3137 "There has been an error but the errno was meaningless. This corresponds to "
3138 "the case where the error did not come from a failed system call, but for "
3139 "some other reason."
3144 #: ../src/guestfs.pod:1424
3146 "There was an error from a failed system call, but for some reason the errno "
3147 "was not captured and returned. This usually indicates a bug in libguestfs."
3152 #: ../src/guestfs.pod:1430
3154 "Libguestfs tries to convert the errno from inside the applicance into a "
3155 "corresponding errno for the caller (not entirely trivial: the appliance "
3156 "might be running a completely different operating system from the library "
3157 "and error numbers are not standardized across Un*xen). If this could not be "
3158 "done, then the error is translated to C<EINVAL>. In practice this should "
3159 "only happen in very rare circumstances."
3164 #: ../src/guestfs.pod:1438
3165 msgid "guestfs_set_error_handler"
3170 #: ../src/guestfs.pod:1440
3173 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3175 " const char *msg);\n"
3176 " void guestfs_set_error_handler (guestfs_h *g,\n"
3177 " guestfs_error_handler_cb cb,\n"
3184 #: ../src/guestfs.pod:1447
3186 "The callback C<cb> will be called if there is an error. The parameters "
3187 "passed to the callback are an opaque data pointer and the error message "
3193 #: ../src/guestfs.pod:1451
3195 "C<errno> is not passed to the callback. To get that the callback must call "
3196 "L</guestfs_last_errno>."
3201 #: ../src/guestfs.pod:1454
3203 "Note that the message string C<msg> is freed as soon as the callback "
3204 "function returns, so if you want to stash it somewhere you must make your "
3210 #: ../src/guestfs.pod:1458
3211 msgid "The default handler prints messages on C<stderr>."
3216 #: ../src/guestfs.pod:1460
3217 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3222 #: ../src/guestfs.pod:1462
3223 msgid "guestfs_get_error_handler"
3228 #: ../src/guestfs.pod:1464
3231 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3232 " void **opaque_rtn);\n"
3238 #: ../src/guestfs.pod:1467
3239 msgid "Returns the current error handler callback."
3244 #: ../src/guestfs.pod:1469
3245 msgid "guestfs_set_out_of_memory_handler"
3250 #: ../src/guestfs.pod:1471
3253 " typedef void (*guestfs_abort_cb) (void);\n"
3254 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3255 " guestfs_abort_cb);\n"
3261 #: ../src/guestfs.pod:1475
3263 "The callback C<cb> will be called if there is an out of memory situation. "
3264 "I<Note this callback must not return>."
3269 #: ../src/guestfs.pod:1478
3270 msgid "The default is to call L<abort(3)>."
3275 #: ../src/guestfs.pod:1480
3277 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3282 #: ../src/guestfs.pod:1483
3283 msgid "guestfs_get_out_of_memory_handler"
3288 #: ../src/guestfs.pod:1485
3291 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3297 #: ../src/guestfs.pod:1487
3298 msgid "This returns the current out of memory handler."
3303 #: ../src/guestfs.pod:1489
3309 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:989
3315 #: ../src/guestfs.pod:1493
3321 #: ../src/guestfs.pod:1495
3327 #: ../src/guestfs.pod:1497
3328 msgid "AVAILABILITY"
3333 #: ../src/guestfs.pod:1499
3334 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3339 #: ../src/guestfs.pod:1501
3341 "Using L</guestfs_available> you can test availability of the following "
3342 "groups of functions. This test queries the appliance to see if the "
3343 "appliance you are currently using supports the functionality."
3348 #: ../src/guestfs.pod:1506
3349 msgid "@AVAILABILITY@"
3354 #: ../src/guestfs.pod:1508
3355 msgid "GUESTFISH supported COMMAND"
3360 #: ../src/guestfs.pod:1510
3362 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3363 "prints out the available groups and whether they are supported by this build "
3364 "of libguestfs. Note however that you have to do C<run> first."
3369 #: ../src/guestfs.pod:1515
3370 msgid "SINGLE CALLS AT COMPILE TIME"
3375 #: ../src/guestfs.pod:1517
3377 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3378 "function, such as:"
3383 #: ../src/guestfs.pod:1520
3386 " #define LIBGUESTFS_HAVE_DD 1\n"
3392 #: ../src/guestfs.pod:1522
3393 msgid "if L</guestfs_dd> is available."
3398 #: ../src/guestfs.pod:1524
3400 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3401 "function is available at compile time, we recommended using build tools such "
3402 "as autoconf or cmake. For example in autotools you could use:"
3407 #: ../src/guestfs.pod:1529
3410 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3411 " AC_CHECK_FUNCS([guestfs_dd])\n"
3417 #: ../src/guestfs.pod:1532
3419 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3425 #: ../src/guestfs.pod:1535
3426 msgid "SINGLE CALLS AT RUN TIME"
3431 #: ../src/guestfs.pod:1537
3433 "Testing at compile time doesn't guarantee that a function really exists in "
3434 "the library. The reason is that you might be dynamically linked against a "
3435 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3436 "This situation unfortunately results in a segmentation fault, which is a "
3437 "shortcoming of the C dynamic linking system itself."
3442 #: ../src/guestfs.pod:1544
3444 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3445 "in this example program (note that you still need the compile time check as "
3451 #: ../src/guestfs.pod:1548
3454 " #include <stdio.h>\n"
3455 " #include <stdlib.h>\n"
3456 " #include <unistd.h>\n"
3457 " #include <dlfcn.h>\n"
3458 " #include <guestfs.h>\n"
3464 #: ../src/guestfs.pod:1554
3469 " #ifdef LIBGUESTFS_HAVE_DD\n"
3471 " int has_function;\n"
3477 #: ../src/guestfs.pod:1560
3480 " /* Test if the function guestfs_dd is really available. */\n"
3481 " dl = dlopen (NULL, RTLD_LAZY);\n"
3483 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3484 " exit (EXIT_FAILURE);\n"
3486 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3493 #: ../src/guestfs.pod:1569
3496 " if (!has_function)\n"
3497 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3499 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3500 " /* Now it's safe to call\n"
3501 " guestfs_dd (g, \"foo\", \"bar\");\n"
3505 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3513 #: ../src/guestfs.pod:1582
3515 "You may think the above is an awful lot of hassle, and it is. There are "
3516 "other ways outside of the C linking system to ensure that this kind of "
3517 "incompatibility never arises, such as using package versioning:"
3522 #: ../src/guestfs.pod:1587
3525 " Requires: libguestfs >= 1.0.80\n"
3531 #: ../src/guestfs.pod:1589
3532 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3537 #: ../src/guestfs.pod:1591
3539 "A recent feature of the API is the introduction of calls which take optional "
3540 "arguments. In C these are declared 3 ways. The main way is as a call which "
3541 "takes variable arguments (ie. C<...>), as in this example:"
3546 #: ../src/guestfs.pod:1596
3549 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3555 #: ../src/guestfs.pod:1598
3557 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3558 "call with no optional arguments specified:"
3563 #: ../src/guestfs.pod:1601
3566 " guestfs_add_drive_opts (g, filename, -1);\n"
3572 #: ../src/guestfs.pod:1603
3573 msgid "With a single optional argument:"
3578 #: ../src/guestfs.pod:1605
3581 " guestfs_add_drive_opts (g, filename,\n"
3582 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3589 #: ../src/guestfs.pod:1609
3595 #: ../src/guestfs.pod:1611
3598 " guestfs_add_drive_opts (g, filename,\n"
3599 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3600 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3607 #: ../src/guestfs.pod:1616
3609 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3615 #: ../src/guestfs.pod:1619
3616 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3621 #: ../src/guestfs.pod:1621
3623 "The second variant has the same name with the suffix C<_va>, which works the "
3624 "same way but takes a C<va_list>. See the C manual for details. For the "
3625 "example function, this is declared:"
3630 #: ../src/guestfs.pod:1625
3633 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3640 #: ../src/guestfs.pod:1628
3641 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3646 #: ../src/guestfs.pod:1630
3648 "The third variant is useful where you need to construct these calls. You "
3649 "pass in a structure where you fill in the optional fields. The structure "
3650 "has a bitmask as the first element which you must set to indicate which "
3651 "fields you have filled in. For our example function the structure and call "
3657 #: ../src/guestfs.pod:1636
3660 " struct guestfs_add_drive_opts_argv {\n"
3661 " uint64_t bitmask;\n"
3663 " const char *format;\n"
3666 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3667 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3673 #: ../src/guestfs.pod:1645
3674 msgid "You could call it like this:"
3679 #: ../src/guestfs.pod:1647
3682 " struct guestfs_add_drive_opts_argv optargs = {\n"
3683 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3684 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3686 " .format = \"qcow2\"\n"
3693 #: ../src/guestfs.pod:1654
3696 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3702 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3703 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:9
3704 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3710 #: ../src/guestfs.pod:1662
3711 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3716 #: ../src/guestfs.pod:1667
3717 msgid "You do not need to fill in all fields of the structure."
3722 #: ../src/guestfs.pod:1671
3724 "There must be a one-to-one correspondence between fields of the structure "
3725 "that are filled in, and bits set in the bitmask."
3730 #: ../src/guestfs.pod:1676
3731 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3736 #: ../src/guestfs.pod:1678
3738 "In other languages, optional arguments are expressed in the way that is "
3739 "natural for that language. We refer you to the language-specific "
3740 "documentation for more details on that."
3745 #: ../src/guestfs.pod:1682
3746 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3751 #: ../src/guestfs.pod:1684
3752 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3756 #: ../src/guestfs.pod:1686
3758 "B<Note:> This section documents the generic event mechanism introduced in "
3759 "libguestfs 1.10, which you should use in new code if possible. The old "
3760 "functions C<guestfs_set_log_message_callback>, "
3761 "C<guestfs_set_subprocess_quit_callback>, "
3762 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3763 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3768 #: ../src/guestfs.pod:1694
3770 "Handles generate events when certain things happen, such as log messages "
3771 "being generated, progress messages during long-running operations, or the "
3772 "handle being closed. The API calls described below let you register a "
3773 "callback to be called when events happen. You can register multiple "
3774 "callbacks (for the same, different or overlapping sets of events), and "
3775 "individually remove callbacks. If callbacks are not removed, then they "
3776 "remain in force until the handle is closed."
3780 #: ../src/guestfs.pod:1702
3782 "In the current implementation, events are only generated synchronously: that "
3783 "means that events (and hence callbacks) can only happen while you are in the "
3784 "middle of making another libguestfs call. The callback is called in the "
3789 #: ../src/guestfs.pod:1707
3791 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3792 "unsigned integers, or a message buffer. Payloads are discussed later on."
3796 #: ../src/guestfs.pod:1711
3797 msgid "CLASSES OF EVENTS"
3801 #: ../src/guestfs.pod:1715
3802 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3806 #: ../src/guestfs.pod:1718
3808 "The callback function will be called while the handle is being closed "
3809 "(synchronously from L</guestfs_close>)."
3814 #: ../src/guestfs.pod:1721
3816 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3817 "handles that are open when the program exits. This means that this callback "
3818 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3819 "problems in higher-level languages (eg. if your HLL interpreter has already "
3820 "been cleaned up by the time this is called, and if your callback then jumps "
3821 "into some HLL function)."
3825 #: ../src/guestfs.pod:1728
3827 "If no callback is registered: the handle is closed without any callback "
3832 #: ../src/guestfs.pod:1731
3833 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3837 #: ../src/guestfs.pod:1734
3839 "The callback function will be called when the child process quits, either "
3840 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3841 "corresponds to a transition from any state to the CONFIG state)."
3845 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3846 msgid "If no callback is registered: the event is ignored."
3850 #: ../src/guestfs.pod:1740
3851 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3855 #: ../src/guestfs.pod:1743
3857 "The callback function will be called when the child process becomes ready "
3858 "first time after it has been launched. (This corresponds to a transition "
3859 "from LAUNCHING to the READY state)."
3863 #: ../src/guestfs.pod:1749
3864 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3869 #: ../src/guestfs.pod:1752
3871 "Some long-running operations can generate progress messages. If this "
3872 "callback is registered, then it will be called each time a progress message "
3873 "is generated (usually two seconds after the operation started, and three "
3874 "times per second thereafter until it completes, although the frequency may "
3875 "change in future versions)."
3879 #: ../src/guestfs.pod:1758
3881 "The callback receives in the payload four unsigned 64 bit numbers which are "
3882 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3886 #: ../src/guestfs.pod:1761
3888 "The units of C<total> are not defined, although for some operations C<total> "
3889 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3890 "or megabytes), and C<position> may be the portion which has been transferred."
3895 #: ../src/guestfs.pod:1766
3896 msgid "The only defined and stable parts of the API are:"
3901 #: ../src/guestfs.pod:1772
3903 "The callback can display to the user some type of progress bar or indicator "
3904 "which shows the ratio of C<position>:C<total>."
3909 #: ../src/guestfs.pod:1777
3910 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>."
3923 #: ../src/guestfs.pod:1784
3925 "This is to simplify caller code, so callers can easily set the progress "
3926 "indicator to \"100%\" at the end of the operation, without requiring special "
3927 "code to detect this case."
3931 #: ../src/guestfs.pod:1790
3933 "The callback also receives the procedure number (C<proc_nr>) and serial "
3934 "number (C<serial>) of the call. These are only useful for debugging "
3935 "protocol issues, and the callback can normally ignore them. The callback "
3936 "may want to print these numbers in error messages or debugging messages."
3940 #: ../src/guestfs.pod:1796
3941 msgid "If no callback is registered: progress messages are discarded."
3945 #: ../src/guestfs.pod:1798
3946 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3950 #: ../src/guestfs.pod:1801
3952 "The callback function is called whenever a log message is generated by qemu, "
3953 "the appliance kernel, guestfsd (daemon), or utility programs."
3957 #: ../src/guestfs.pod:1804
3959 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3960 "guestfs_launch>) then additional debug messages are generated."
3964 #: ../src/guestfs.pod:1807 ../src/guestfs.pod:1821
3966 "If no callback is registered: the messages are discarded unless the verbose "
3967 "flag is set in which case they are sent to stderr. You can override the "
3968 "printing of verbose messages to stderr by setting up a callback."
3972 #: ../src/guestfs.pod:1812
3973 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3977 #: ../src/guestfs.pod:1815
3979 "The callback function is called whenever a log message is generated by the "
3980 "library part of libguestfs."
3984 #: ../src/guestfs.pod:1818
3986 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3987 "messages are generated."
3991 #: ../src/guestfs.pod:1826
3992 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3996 #: ../src/guestfs.pod:1829
3998 "The callback function is called whenever a trace message is generated. This "
3999 "only applies if the trace flag (L</guestfs_set_trace>) is set."
4003 #: ../src/guestfs.pod:1832
4005 "If no callback is registered: the messages are sent to stderr. You can "
4006 "override the printing of trace messages to stderr by setting up a callback."
4010 #: ../src/guestfs.pod:1838
4011 msgid "guestfs_set_event_callback"
4015 #: ../src/guestfs.pod:1840
4018 " int guestfs_set_event_callback (guestfs_h *g,\n"
4019 " guestfs_event_callback cb,\n"
4020 " uint64_t event_bitmask,\n"
4027 #: ../src/guestfs.pod:1846
4029 "This function registers a callback (C<cb>) for all event classes in the "
4034 #: ../src/guestfs.pod:1849
4036 "For example, to register for all log message events, you could call this "
4037 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4038 "To register a single callback for all possible classes of events, use "
4039 "C<GUESTFS_EVENT_ALL>."
4043 #: ../src/guestfs.pod:1855
4044 msgid "C<flags> should always be passed as 0."
4048 #: ../src/guestfs.pod:1857
4050 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4051 "it for any purpose."
4055 #: ../src/guestfs.pod:1860
4057 "The return value is the event handle (an integer) which you can use to "
4058 "delete the callback (see below)."
4062 #: ../src/guestfs.pod:1863
4064 "If there is an error, this function returns C<-1>, and sets the error in the "
4065 "handle in the usual way (see L</guestfs_last_error> etc.)"
4069 #: ../src/guestfs.pod:1866
4071 "Callbacks remain in effect until they are deleted, or until the handle is "
4076 #: ../src/guestfs.pod:1869
4078 "In the case where multiple callbacks are registered for a particular event "
4079 "class, all of the callbacks are called. The order in which multiple "
4080 "callbacks are called is not defined."
4084 #: ../src/guestfs.pod:1873
4085 msgid "guestfs_delete_event_callback"
4089 #: ../src/guestfs.pod:1875
4092 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4097 #: ../src/guestfs.pod:1877
4099 "Delete a callback that was previously registered. C<event_handle> should be "
4100 "the integer that was returned by a previous call to "
4101 "C<guestfs_set_event_callback> on the same handle."
4105 #: ../src/guestfs.pod:1881
4106 msgid "guestfs_event_callback"
4110 #: ../src/guestfs.pod:1883
4113 " typedef void (*guestfs_event_callback) (\n"
4116 " uint64_t event,\n"
4117 " int event_handle,\n"
4119 " const char *buf, size_t buf_len,\n"
4120 " const uint64_t *array, size_t array_len);\n"
4125 #: ../src/guestfs.pod:1892
4127 "This is the type of the event callback function that you have to provide."
4131 #: ../src/guestfs.pod:1895
4133 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4134 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4135 "handle, and C<flags> which in the current API you should ignore."
4139 #: ../src/guestfs.pod:1899
4141 "The remaining parameters contain the event payload (if any). Each event may "
4142 "contain a payload, which usually relates to the event class, but for future "
4143 "proofing your code should be written to handle any payload for any event "
4148 #: ../src/guestfs.pod:1904
4150 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4151 "there is no message buffer). Note that this message buffer can contain "
4152 "arbitrary 8 bit data, including NUL bytes."
4156 #: ../src/guestfs.pod:1908
4158 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4159 "moment this is only used for progress messages."
4163 #: ../src/guestfs.pod:1911
4164 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4168 #: ../src/guestfs.pod:1913
4170 "One motivation for the generic event API was to allow GUI programs to "
4171 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4172 "unconditionally to C<stderr>."
4176 #: ../src/guestfs.pod:1917
4178 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4179 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4180 "messages are not events; you must capture error messages separately)."
4184 #: ../src/guestfs.pod:1922
4186 "Programs have to set up a callback to capture the classes of events of "
4191 #: ../src/guestfs.pod:1925
4195 " guestfs_set_event_callback\n"
4196 " (g, message_callback,\n"
4197 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4198 " GUESTFS_EVENT_TRACE,\n"
4199 " 0, NULL) == -1)\n"
4200 " if (eh == -1) {\n"
4201 " // handle error in the usual way\n"
4207 #: ../src/guestfs.pod:1935
4209 "The callback can then direct messages to the appropriate place. In this "
4210 "example, messages are directed to syslog:"
4214 #: ../src/guestfs.pod:1938
4218 " message_callback (\n"
4221 " uint64_t event,\n"
4222 " int event_handle,\n"
4224 " const char *buf, size_t buf_len,\n"
4225 " const uint64_t *array, size_t array_len)\n"
4227 " const int priority = LOG_USER|LOG_INFO;\n"
4228 " if (buf_len > 0)\n"
4229 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4236 #: ../src/guestfs.pod:1953
4237 msgid "PRIVATE DATA AREA"
4241 #: ../src/guestfs.pod:1955
4243 "You can attach named pieces of private data to the libguestfs handle, fetch "
4244 "them by name, and walk over them, for the lifetime of the handle. This is "
4245 "called the private data area and is only available from the C API."
4250 #: ../src/guestfs.pod:1960
4251 msgid "To attach a named piece of data, use the following call:"
4256 #: ../src/guestfs.pod:1962
4259 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4265 #: ../src/guestfs.pod:1964
4267 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4268 "pointer (which can be C<NULL>). Any previous item with the same name is "
4274 #: ../src/guestfs.pod:1968
4276 "You can use any C<key> you want, but names beginning with an underscore "
4277 "character are reserved for internal libguestfs purposes (for implementing "
4278 "language bindings). It is recommended to prefix the name with some unique "
4279 "string to avoid collisions with other users."
4284 #: ../src/guestfs.pod:1973
4285 msgid "To retrieve the pointer, use:"
4290 #: ../src/guestfs.pod:1975
4293 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4299 #: ../src/guestfs.pod:1977
4301 "This function returns C<NULL> if either no data is found associated with "
4302 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4307 #: ../src/guestfs.pod:1981
4309 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4310 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4311 "all. In particular, libguestfs does I<not> try to free the data when the "
4312 "handle is closed. If the data must be freed, then the caller must either "
4313 "free it before calling L</guestfs_close> or must set up a close callback to "
4314 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4318 #: ../src/guestfs.pod:1988
4319 msgid "To walk over all entries, use these two functions:"
4323 #: ../src/guestfs.pod:1990
4326 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4331 #: ../src/guestfs.pod:1992
4334 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4339 #: ../src/guestfs.pod:1994
4341 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4342 "not have any particular meaning -- keys are not returned in any defined "
4343 "order). A pointer to the key is returned in C<*key_rtn> and the "
4344 "corresponding data pointer is returned from the function. C<NULL> is "
4345 "returned if there are no keys stored in the handle."
4349 #: ../src/guestfs.pod:2000
4351 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4352 "value of this function is also C<NULL> is there are no further entries to "
4357 #: ../src/guestfs.pod:2004
4358 msgid "Notes about walking over entries:"
4362 #: ../src/guestfs.pod:2010
4364 "You must not call C<guestfs_set_private> while walking over the entries."
4368 #: ../src/guestfs.pod:2015
4370 "The handle maintains an internal iterator which is reset when you call "
4371 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4372 "call C<guestfs_set_private>."
4376 #: ../src/guestfs.pod:2021
4377 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4381 #: ../src/guestfs.pod:2023
4384 " guestfs_set_private (g, key, NULL);\n"
4389 #: ../src/guestfs.pod:2025
4390 msgid "then that C<key> is not returned when walking."
4394 #: ../src/guestfs.pod:2029
4396 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4397 "C<guestfs_next_private> or C<guestfs_set_private>."
4401 #: ../src/guestfs.pod:2035
4403 "The following example code shows how to print all keys and data pointers "
4404 "that are associated with the handle C<g>:"
4408 #: ../src/guestfs.pod:2038
4411 " const char *key;\n"
4412 " void *data = guestfs_first_private (g, &key);\n"
4413 " while (data != NULL)\n"
4415 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4416 " data = guestfs_next_private (g, &key);\n"
4422 #: ../src/guestfs.pod:2046
4424 "More commonly you are only interested in keys that begin with an application-"
4425 "specific prefix C<foo_>. Modify the loop like so:"
4429 #: ../src/guestfs.pod:2049
4432 " const char *key;\n"
4433 " void *data = guestfs_first_private (g, &key);\n"
4434 " while (data != NULL)\n"
4436 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4437 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4438 " data = guestfs_next_private (g, &key);\n"
4444 #: ../src/guestfs.pod:2058
4446 "If you need to modify keys while walking, then you have to jump back to the "
4447 "beginning of the loop. For example, to delete all keys prefixed with "
4452 #: ../src/guestfs.pod:2062
4455 " const char *key;\n"
4458 " data = guestfs_first_private (g, &key);\n"
4459 " while (data != NULL)\n"
4461 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4463 " guestfs_set_private (g, key, NULL);\n"
4464 " /* note that 'key' pointer is now invalid, and so is\n"
4465 " the internal iterator */\n"
4468 " data = guestfs_next_private (g, &key);\n"
4474 #: ../src/guestfs.pod:2078
4476 "Note that the above loop is guaranteed to terminate because the keys are "
4477 "being deleted, but other manipulations of keys within the loop might not "
4478 "terminate unless you also maintain an indication of which keys have been "
4484 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4490 #: ../src/guestfs.pod:2085
4492 "<!-- old anchor for the next section --> <a name="
4493 "\"state_machine_and_low_level_event_api\"/>"
4498 #: ../src/guestfs.pod:2090
4499 msgid "ARCHITECTURE"
4504 #: ../src/guestfs.pod:2092
4506 "Internally, libguestfs is implemented by running an appliance (a special "
4507 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4508 "process of the main program."
4513 #: ../src/guestfs.pod:2096
4516 " ___________________\n"
4518 " | main program |\n"
4520 " | | child process / appliance\n"
4521 " | | __________________________\n"
4523 " +-------------------+ RPC | +-----------------+ |\n"
4524 " | libguestfs <--------------------> guestfsd | |\n"
4525 " | | | +-----------------+ |\n"
4526 " \\___________________/ | | Linux kernel | |\n"
4527 " | +--^--------------+ |\n"
4528 " \\_________|________________/\n"
4534 " \\______________/\n"
4540 #: ../src/guestfs.pod:2116
4542 "The library, linked to the main program, creates the child process and hence "
4543 "the appliance in the L</guestfs_launch> function."
4548 #: ../src/guestfs.pod:2119
4550 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4551 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4552 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4553 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4554 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4555 "attached to the qemu process which translates device access by the "
4556 "appliance's Linux kernel into accesses to the image."
4561 #: ../src/guestfs.pod:2128
4563 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4564 "Although the disk image you are attached to might also be used by some "
4565 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4566 "care if both libguestfs's qemu process and your virtual machine are trying "
4567 "to update the disk image at the same time, since these usually results in "
4568 "massive disk corruption)."
4573 #: ../src/guestfs.pod:2135
4574 msgid "STATE MACHINE"
4579 #: ../src/guestfs.pod:2137
4580 msgid "libguestfs uses a state machine to model the child process:"
4585 #: ../src/guestfs.pod:2139
4597 " / | \\ \\ guestfs_launch\n"
4598 " / | _\\__V______\n"
4600 " / | | LAUNCHING |\n"
4601 " / | \\___________/\n"
4603 " / | guestfs_launch\n"
4605 " ______ / __|____V\n"
4606 " / \\ ------> / \\\n"
4607 " | BUSY | | READY |\n"
4608 " \\______/ <------ \\________/\n"
4614 #: ../src/guestfs.pod:2161
4616 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4617 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4618 "(3) alternating between READY and BUSY as commands are issued to, and "
4619 "carried out by, the child process."
4624 #: ../src/guestfs.pod:2166
4626 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4627 "asynchronously at any time (eg. due to some internal error), and that causes "
4628 "the state to transition back to CONFIG."
4633 #: ../src/guestfs.pod:2170
4635 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4636 "issued when in the CONFIG state."
4641 #: ../src/guestfs.pod:2173
4643 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4644 "L</guestfs_launch> blocks until the child process is READY to accept "
4645 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4646 "moves the state from CONFIG to LAUNCHING while it is running."
4651 #: ../src/guestfs.pod:2179
4653 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4654 "state. These API calls block waiting for the command to be carried out (ie. "
4655 "the state to transition to BUSY and then back to READY). There are no non-"
4656 "blocking versions, and no way to issue more than one command per handle at "
4662 #: ../src/guestfs.pod:2185
4664 "Finally, the child process sends asynchronous messages back to the main "
4665 "program, such as kernel log messages. You can register a callback to "
4666 "receive these messages."
4671 #: ../src/guestfs.pod:2189
4677 #: ../src/guestfs.pod:2191
4678 msgid "COMMUNICATION PROTOCOL"
4683 #: ../src/guestfs.pod:2193
4685 "Don't rely on using this protocol directly. This section documents how it "
4686 "currently works, but it may change at any time."
4691 #: ../src/guestfs.pod:2196
4693 "The protocol used to talk between the library and the daemon running inside "
4694 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4695 "1014, RFC 1832, RFC 4506)."
4700 #: ../src/guestfs.pod:2200
4702 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4703 "this file is automatically generated)."
4708 #: ../src/guestfs.pod:2203
4710 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4711 "and C<FileOut> parameters, which are handled with very simple request/reply "
4712 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4713 "parameters, which use the same request and reply messages, but they may also "
4714 "be followed by files sent using a chunked encoding."
4719 #: ../src/guestfs.pod:2210
4720 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4725 #: ../src/guestfs.pod:2212
4726 msgid "For ordinary functions, the request message is:"
4731 #: ../src/guestfs.pod:2214
4734 " total length (header + arguments,\n"
4735 " but not including the length word itself)\n"
4736 " struct guestfs_message_header (encoded as XDR)\n"
4737 " struct guestfs_<foo>_args (encoded as XDR)\n"
4743 #: ../src/guestfs.pod:2219
4745 "The total length field allows the daemon to allocate a fixed size buffer "
4746 "into which it slurps the rest of the message. As a result, the total length "
4747 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4748 "effective size of any request is limited to somewhere under this size."
4753 #: ../src/guestfs.pod:2225
4755 "Note also that many functions don't take any arguments, in which case the "
4756 "C<guestfs_I<foo>_args> is completely omitted."
4761 #: ../src/guestfs.pod:2228
4763 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4764 "receiver knows what type of args structure to expect, or none at all."
4769 #: ../src/guestfs.pod:2232
4771 "For functions that take optional arguments, the optional arguments are "
4772 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4773 "arguments. A bitmask in the header indicates which optional arguments are "
4774 "meaningful. The bitmask is also checked to see if it contains bits set "
4775 "which the daemon does not know about (eg. if more optional arguments were "
4776 "added in a later version of the library), and this causes the call to be "
4782 #: ../src/guestfs.pod:2240
4783 msgid "The reply message for ordinary functions is:"
4788 #: ../src/guestfs.pod:2242
4791 " total length (header + ret,\n"
4792 " but not including the length word itself)\n"
4793 " struct guestfs_message_header (encoded as XDR)\n"
4794 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4800 #: ../src/guestfs.pod:2247
4802 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4803 "functions that return no formal return values."
4808 #: ../src/guestfs.pod:2250
4810 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4815 #: ../src/guestfs.pod:2253
4817 "In the case of an error, a flag is set in the header, and the reply message "
4818 "is slightly changed:"
4823 #: ../src/guestfs.pod:2256
4826 " total length (header + error,\n"
4827 " but not including the length word itself)\n"
4828 " struct guestfs_message_header (encoded as XDR)\n"
4829 " struct guestfs_message_error (encoded as XDR)\n"
4835 #: ../src/guestfs.pod:2261
4837 "The C<guestfs_message_error> structure contains the error message as a "
4843 #: ../src/guestfs.pod:2264
4844 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4849 #: ../src/guestfs.pod:2266
4851 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4852 "The normal request message is sent (see above). However this is followed by "
4853 "a sequence of file chunks."
4858 #: ../src/guestfs.pod:2270
4861 " total length (header + arguments,\n"
4862 " but not including the length word itself,\n"
4863 " and not including the chunks)\n"
4864 " struct guestfs_message_header (encoded as XDR)\n"
4865 " struct guestfs_<foo>_args (encoded as XDR)\n"
4866 " sequence of chunks for FileIn param #0\n"
4867 " sequence of chunks for FileIn param #1 etc.\n"
4873 #: ../src/guestfs.pod:2278
4874 msgid "The \"sequence of chunks\" is:"
4879 #: ../src/guestfs.pod:2280
4882 " length of chunk (not including length word itself)\n"
4883 " struct guestfs_chunk (encoded as XDR)\n"
4884 " length of chunk\n"
4885 " struct guestfs_chunk (encoded as XDR)\n"
4887 " length of chunk\n"
4888 " struct guestfs_chunk (with data.data_len == 0)\n"
4894 #: ../src/guestfs.pod:2288
4896 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4897 "is set in the final chunk to indicate either successful completion or early "
4903 #: ../src/guestfs.pod:2292
4905 "At time of writing there are no functions that have more than one FileIn "
4906 "parameter. However this is (theoretically) supported, by sending the "
4907 "sequence of chunks for each FileIn parameter one after another (from left to "
4913 #: ../src/guestfs.pod:2297
4915 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4916 "transfer. The library does this by sending a chunk with a special flag set "
4917 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4918 "RPC, does I<not> send any reply, and goes back to reading the next request."
4923 #: ../src/guestfs.pod:2303
4925 "The daemon may also cancel. It does this by writing a special word "
4926 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4927 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4928 "cancel chunk). The special word is chosen so that even if cancellation "
4929 "happens right at the end of the transfer (after the library has finished "
4930 "writing and has started listening for the reply), the \"spurious\" cancel "
4931 "flag will not be confused with the reply message."
4936 #: ../src/guestfs.pod:2312
4938 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4939 "limit), and also files where the size is not known in advance (eg. from "
4940 "pipes or sockets). However the chunks are rather small "
4941 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4942 "to keep much in memory."
4947 #: ../src/guestfs.pod:2318
4948 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4953 #: ../src/guestfs.pod:2320
4955 "The protocol for FileOut parameters is exactly the same as for FileIn "
4956 "parameters, but with the roles of daemon and library reversed."
4961 #: ../src/guestfs.pod:2323
4964 " total length (header + ret,\n"
4965 " but not including the length word itself,\n"
4966 " and not including the chunks)\n"
4967 " struct guestfs_message_header (encoded as XDR)\n"
4968 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4969 " sequence of chunks for FileOut param #0\n"
4970 " sequence of chunks for FileOut param #1 etc.\n"
4976 #: ../src/guestfs.pod:2331
4977 msgid "INITIAL MESSAGE"
4982 #: ../src/guestfs.pod:2333
4984 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4985 "which indicates that the guest and daemon is alive. This is what L</"
4986 "guestfs_launch> waits for."
4991 #: ../src/guestfs.pod:2337
4992 msgid "PROGRESS NOTIFICATION MESSAGES"
4997 #: ../src/guestfs.pod:2339
4999 "The daemon may send progress notification messages at any time. These are "
5000 "distinguished by the normal length word being replaced by "
5001 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
5005 #: ../src/guestfs.pod:2343
5007 "The library turns them into progress callbacks (see L</"
5008 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5014 #: ../src/guestfs.pod:2347
5016 "The daemon self-limits the frequency of progress messages it sends (see "
5017 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5023 #: ../src/guestfs.pod:2351
5024 msgid "LIBGUESTFS VERSION NUMBERS"
5029 #: ../src/guestfs.pod:2353
5031 "Since April 2010, libguestfs has started to make separate development and "
5032 "stable releases, along with corresponding branches in our git repository. "
5033 "These separate releases can be identified by version number:"
5038 #: ../src/guestfs.pod:2358
5041 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5042 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5048 " | `-------- sub-version\n"
5050 " `------ always '1' because we don't change the ABI\n"
5056 #: ../src/guestfs.pod:2369
5057 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5062 #: ../src/guestfs.pod:2371
5064 "As time passes we cherry pick fixes from the development branch and backport "
5065 "those into the stable branch, the effect being that the stable branch should "
5066 "get more stable and less buggy over time. So the stable releases are ideal "
5067 "for people who don't need new features but would just like the software to "
5073 #: ../src/guestfs.pod:2377
5074 msgid "Our criteria for backporting changes are:"
5079 #: ../src/guestfs.pod:2383
5081 "Documentation changes which don't affect any code are backported unless the "
5082 "documentation refers to a future feature which is not in stable."
5087 #: ../src/guestfs.pod:2389
5089 "Bug fixes which are not controversial, fix obvious problems, and have been "
5090 "well tested are backported."
5095 #: ../src/guestfs.pod:2394
5097 "Simple rearrangements of code which shouldn't affect how it works get "
5098 "backported. This is so that the code in the two branches doesn't get too "
5099 "far out of step, allowing us to backport future fixes more easily."
5104 #: ../src/guestfs.pod:2400
5106 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5107 "exceptional case: the new feature is required in order to implement an "
5108 "important bug fix."
5113 #: ../src/guestfs.pod:2406
5115 "A new stable branch starts when we think the new features in development are "
5116 "substantial and compelling enough over the current stable branch to warrant "
5117 "it. When that happens we create new stable and development versions 1.N.0 "
5118 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5119 "stable at this point, but by backporting fixes from development, that branch "
5120 "will stabilize over time."
5124 #: ../src/guestfs.pod:2414
5125 msgid "EXTENDING LIBGUESTFS"
5129 #: ../src/guestfs.pod:2416
5130 msgid "ADDING A NEW API ACTION"
5134 #: ../src/guestfs.pod:2418
5136 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5137 "documentation) are generated, and this makes it easy to extend the "
5142 #: ../src/guestfs.pod:2422
5143 msgid "To add a new API action there are two changes:"
5147 #: ../src/guestfs.pod:2428
5149 "You need to add a description of the call (name, parameters, return type, "
5150 "tests, documentation) to C<generator/generator_actions.ml>."
5154 #: ../src/guestfs.pod:2431
5156 "There are two sorts of API action, depending on whether the call goes "
5157 "through to the daemon in the appliance, or is serviced entirely by the "
5158 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5159 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5160 "an example of the latter, since a trace flag is maintained in the handle and "
5161 "all tracing is done on the library side."
5165 #: ../src/guestfs.pod:2439
5167 "Most new actions are of the first type, and get added to the "
5168 "C<daemon_functions> list. Each function has a unique procedure number used "
5169 "in the RPC protocol which is assigned to that action when we publish "
5170 "libguestfs and cannot be reused. Take the latest procedure number and "
5175 #: ../src/guestfs.pod:2445
5177 "For library-only actions of the second type, add to the "
5178 "C<non_daemon_functions> list. Since these functions are serviced by the "
5179 "library and do not travel over the RPC mechanism to the daemon, these "
5180 "functions do not need a procedure number, and so the procedure number is set "
5185 #: ../src/guestfs.pod:2453
5186 msgid "Implement the action (in C):"
5190 #: ../src/guestfs.pod:2455
5192 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5193 "C<daemon/> directory."
5197 #: ../src/guestfs.pod:2458
5199 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5200 "(note: double underscore) in the C<src/> directory."
5204 #: ../src/guestfs.pod:2461
5205 msgid "In either case, use another function as an example of what to do."
5209 #: ../src/guestfs.pod:2465
5210 msgid "After making these changes, use C<make> to compile."
5214 #: ../src/guestfs.pod:2467
5216 "Note that you don't need to implement the RPC, language bindings, manual "
5217 "pages or anything else. It's all automatically generated from the OCaml "
5222 #: ../src/guestfs.pod:2471
5223 msgid "ADDING TESTS FOR AN API ACTION"
5227 #: ../src/guestfs.pod:2473
5229 "You can supply zero or as many tests as you want per API call. The tests "
5230 "can either be added as part of the API description (C<generator/"
5231 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5232 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5233 "slower, so if possible use the first method."
5237 #: ../src/guestfs.pod:2479
5239 "The following describes the test environment used when you add an API test "
5240 "in C<generator_actions.ml>."
5244 #: ../src/guestfs.pod:2482
5245 msgid "The test environment has 4 block devices:"
5249 #: ../src/guestfs.pod:2486
5250 msgid "C</dev/sda> 500MB"
5254 #: ../src/guestfs.pod:2488
5255 msgid "General block device for testing."
5259 #: ../src/guestfs.pod:2490
5260 msgid "C</dev/sdb> 50MB"
5264 #: ../src/guestfs.pod:2492
5266 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5271 #: ../src/guestfs.pod:2495
5272 msgid "C</dev/sdc> 10MB"
5276 #: ../src/guestfs.pod:2497
5277 msgid "Used in a few tests where two block devices are needed."
5281 #: ../src/guestfs.pod:2499
5286 #: ../src/guestfs.pod:2501
5287 msgid "ISO with fixed content (see C<images/test.iso>)."
5291 #: ../src/guestfs.pod:2505
5293 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5294 "appliance and block devices are reused between tests. So don't try testing "
5295 "L</guestfs_kill_subprocess> :-x"
5299 #: ../src/guestfs.pod:2509
5301 "Each test starts with an initial scenario, selected using one of the "
5302 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5303 "initialize the disks mentioned above in a particular way as documented in "
5304 "C<generator_types.ml>. You should not assume anything about the previous "
5305 "contents of other disks that are not initialized."
5309 #: ../src/guestfs.pod:2515
5311 "You can add a prerequisite clause to any individual test. This is a run-"
5312 "time check, which, if it fails, causes the test to be skipped. Useful if "
5313 "testing a command which might not work on all variations of libguestfs "
5314 "builds. A test that has prerequisite of C<Always> means to run "
5319 #: ../src/guestfs.pod:2521
5321 "In addition, packagers can skip individual tests by setting environment "
5322 "variables before running C<make check>."
5326 #: ../src/guestfs.pod:2524
5329 " SKIP_TEST_<CMD>_<NUM>=1\n"
5334 #: ../src/guestfs.pod:2526
5335 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5339 #: ../src/guestfs.pod:2528
5344 #: ../src/guestfs.pod:2530
5347 " SKIP_TEST_<CMD>=1\n"
5352 #: ../src/guestfs.pod:2532
5353 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5357 #: ../src/guestfs.pod:2534
5358 msgid "Packagers can run only certain tests by setting for example:"
5362 #: ../src/guestfs.pod:2536
5365 " TEST_ONLY=\"vfs_type zerofree\"\n"
5370 #: ../src/guestfs.pod:2538
5372 "See C<capitests/tests.c> for more details of how these environment variables "
5377 #: ../src/guestfs.pod:2541
5378 msgid "DEBUGGING NEW API ACTIONS"
5382 #: ../src/guestfs.pod:2543
5383 msgid "Test new actions work before submitting them."
5387 #: ../src/guestfs.pod:2545
5388 msgid "You can use guestfish to try out new commands."
5392 #: ../src/guestfs.pod:2547
5394 "Debugging the daemon is a problem because it runs inside a minimal "
5395 "environment. However you can fprintf messages in the daemon to stderr, and "
5396 "they will show up if you use C<guestfish -v>."
5400 #: ../src/guestfs.pod:2551
5401 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5405 #: ../src/guestfs.pod:2553
5407 "Our C source code generally adheres to some basic code-formatting "
5408 "conventions. The existing code base is not totally consistent on this "
5409 "front, but we do prefer that contributed code be formatted similarly. In "
5410 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5411 "indentation level, and other than that, follow the K&R style."
5415 #: ../src/guestfs.pod:2559
5417 "If you use Emacs, add the following to one of one of your start-up files (e."
5418 "g., ~/.emacs), to help ensure that you get indentation right:"
5422 #: ../src/guestfs.pod:2562
5425 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5426 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5427 " (add-hook 'find-file-hook\n"
5428 " '(lambda () (if (and buffer-file-name\n"
5429 " (string-match \"/libguestfs\\\\>\"\n"
5430 " (buffer-file-name))\n"
5431 " (not (string-equal mode-name \"Change Log\"))\n"
5432 " (not (string-equal mode-name \"Makefile\")))\n"
5433 " (setq indent-tabs-mode nil))))\n"
5438 #: ../src/guestfs.pod:2572
5441 " ;;; When editing C sources in libguestfs, use this style.\n"
5442 " (defun libguestfs-c-mode ()\n"
5443 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5445 " (c-set-style \"K&R\")\n"
5446 " (setq c-indent-level 2)\n"
5447 " (setq c-basic-offset 2))\n"
5448 " (add-hook 'c-mode-hook\n"
5449 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5450 " (buffer-file-name))\n"
5451 " (libguestfs-c-mode))))\n"
5456 #: ../src/guestfs.pod:2584
5457 msgid "Enable warnings when compiling (and fix any problems this finds):"
5461 #: ../src/guestfs.pod:2587
5464 " ./configure --enable-gcc-warnings\n"
5469 #: ../src/guestfs.pod:2589
5470 msgid "Useful targets are:"
5474 #: ../src/guestfs.pod:2591
5477 " make syntax-check # checks the syntax of the C code\n"
5478 " make check # runs the test suite\n"
5483 #: ../src/guestfs.pod:2594
5484 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5488 #: ../src/guestfs.pod:2596
5490 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5491 "which are used to do shell quoting."
5495 #: ../src/guestfs.pod:2601
5500 #: ../src/guestfs.pod:2603
5502 "Simple shell quoted string. Any spaces or other shell characters are "
5507 #: ../src/guestfs.pod:2606
5512 #: ../src/guestfs.pod:2608
5514 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5520 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:240 ../fish/guestfish.pod:599
5521 msgid "For example:"
5525 #: ../src/guestfs.pod:2615
5528 " asprintf (&cmd, \"cat %R\", path);\n"
5533 #: ../src/guestfs.pod:2617
5534 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5538 #: ../src/guestfs.pod:2619
5540 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5541 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5542 "they are not passed via the shell (instead, straight to exec). You probably "
5543 "want to use the C<sysroot_path()> function however."
5547 #: ../src/guestfs.pod:2625
5548 msgid "SUBMITTING YOUR NEW API ACTIONS"
5552 #: ../src/guestfs.pod:2627
5554 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5555 "libguestfs> and CC to L<rjones@redhat.com>."
5559 #: ../src/guestfs.pod:2631
5560 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5564 #: ../src/guestfs.pod:2633
5565 msgid "We support i18n (gettext anyhow) in the library."
5569 #: ../src/guestfs.pod:2635
5571 "However many messages come from the daemon, and we don't translate those at "
5572 "the moment. One reason is that the appliance generally has all locale files "
5573 "removed from it, because they take up a lot of space. So we'd have to readd "
5574 "some of those, as well as copying our PO files into the appliance."
5578 #: ../src/guestfs.pod:2641
5580 "Debugging messages are never translated, since they are intended for the "
5585 #: ../src/guestfs.pod:2644
5586 msgid "SOURCE CODE SUBDIRECTORIES"
5590 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5721
5591 #: ../fish/guestfish-actions.pod:3838
5592 msgid "C<appliance>"
5596 #: ../src/guestfs.pod:2650
5597 msgid "The libguestfs appliance, build scripts and so on."
5601 #: ../src/guestfs.pod:2652
5602 msgid "C<capitests>"
5606 #: ../src/guestfs.pod:2654
5607 msgid "Automated tests of the C API."
5611 #: ../src/guestfs.pod:2656
5616 #: ../src/guestfs.pod:2658
5618 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5623 #: ../src/guestfs.pod:2661
5628 #: ../src/guestfs.pod:2663
5629 msgid "Outside contributions, experimental parts."
5633 #: ../src/guestfs.pod:2665
5638 #: ../src/guestfs.pod:2667
5640 "The daemon that runs inside the libguestfs appliance and carries out actions."
5644 #: ../src/guestfs.pod:2670
5649 #: ../src/guestfs.pod:2672
5650 msgid "L<virt-df(1)> command and documentation."
5654 #: ../src/guestfs.pod:2674
5659 #: ../src/guestfs.pod:2676
5660 msgid "C API example code."
5664 #: ../src/guestfs.pod:2678
5669 #: ../src/guestfs.pod:2680
5671 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5672 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5673 "L<virt-tar-out(1)>."
5677 #: ../src/guestfs.pod:2684
5682 #: ../src/guestfs.pod:2686
5684 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5688 #: ../src/guestfs.pod:2688
5689 msgid "C<generator>"
5693 #: ../src/guestfs.pod:2690
5695 "The crucially important generator, used to automatically generate large "
5696 "amounts of boilerplate C code for things like RPC and bindings."
5700 #: ../src/guestfs.pod:2693
5705 #: ../src/guestfs.pod:2695
5706 msgid "Files used by the test suite."
5710 #: ../src/guestfs.pod:2697
5711 msgid "Some \"phony\" guest images which we test against."
5715 #: ../src/guestfs.pod:2699
5716 msgid "C<inspector>"
5720 #: ../src/guestfs.pod:2701
5721 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5725 #: ../src/guestfs.pod:2703
5730 #: ../src/guestfs.pod:2705
5731 msgid "Logo used on the website. The fish is called Arthur by the way."
5735 #: ../src/guestfs.pod:2707
5740 #: ../src/guestfs.pod:2709
5741 msgid "M4 macros used by autoconf."
5745 #: ../src/guestfs.pod:2711
5750 #: ../src/guestfs.pod:2713
5751 msgid "Translations of simple gettext strings."
5755 #: ../src/guestfs.pod:2715
5760 #: ../src/guestfs.pod:2717
5762 "The build infrastructure and PO files for translations of manpages and POD "
5763 "files. Eventually this will be combined with the C<po> directory, but that "
5764 "is rather complicated."
5768 #: ../src/guestfs.pod:2721
5769 msgid "C<regressions>"
5773 #: ../src/guestfs.pod:2723
5774 msgid "Regression tests."
5778 #: ../src/guestfs.pod:2725
5783 #: ../src/guestfs.pod:2727
5784 msgid "L<virt-rescue(1)> command and documentation."
5788 #: ../src/guestfs.pod:2729
5793 #: ../src/guestfs.pod:2731
5794 msgid "Source code to the C library."
5798 #: ../src/guestfs.pod:2733
5803 #: ../src/guestfs.pod:2735
5804 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5808 #: ../src/guestfs.pod:2737
5809 msgid "C<test-tool>"
5813 #: ../src/guestfs.pod:2739
5815 "Test tool for end users to test if their qemu/kernel combination will work "
5820 #: ../src/guestfs.pod:2742
5825 #: ../src/guestfs.pod:2744
5830 #: ../src/guestfs.pod:2746
5835 #: ../src/guestfs.pod:2748
5840 #: ../src/guestfs.pod:2750
5845 #: ../src/guestfs.pod:2752
5850 #: ../src/guestfs.pod:2754
5855 #: ../src/guestfs.pod:2756
5860 #: ../src/guestfs.pod:2758
5861 msgid "Language bindings."
5866 #: ../src/guestfs.pod:2762 ../fish/guestfish.pod:996
5867 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5868 msgid "ENVIRONMENT VARIABLES"
5873 #: ../src/guestfs.pod:2766 ../fish/guestfish.pod:1022
5874 msgid "LIBGUESTFS_APPEND"
5879 #: ../src/guestfs.pod:2768 ../fish/guestfish.pod:1024
5880 msgid "Pass additional options to the guest kernel."
5885 #: ../src/guestfs.pod:2770 ../fish/guestfish.pod:1026
5886 msgid "LIBGUESTFS_DEBUG"
5891 #: ../src/guestfs.pod:2772
5893 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5894 "effect as calling C<guestfs_set_verbose (g, 1)>."
5899 #: ../src/guestfs.pod:2775 ../fish/guestfish.pod:1031
5900 msgid "LIBGUESTFS_MEMSIZE"
5905 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1033
5907 "Set the memory allocated to the qemu process, in megabytes. For example:"
5912 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1036
5915 " LIBGUESTFS_MEMSIZE=700\n"
5921 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1038
5922 msgid "LIBGUESTFS_PATH"
5926 #: ../src/guestfs.pod:2784
5928 "Set the path that libguestfs uses to search for a supermin appliance. See "
5929 "the discussion of paths in section L</PATH> above."
5934 #: ../src/guestfs.pod:2787 ../fish/guestfish.pod:1043
5935 msgid "LIBGUESTFS_QEMU"
5940 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1045
5942 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5943 "which was found at compile time by the configure script is used."
5948 #: ../src/guestfs.pod:2793
5949 msgid "See also L</QEMU WRAPPERS> above."
5954 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1049
5955 msgid "LIBGUESTFS_TRACE"
5960 #: ../src/guestfs.pod:2797
5962 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5963 "effect as calling C<guestfs_set_trace (g, 1)>."
5968 #: ../src/guestfs.pod:2800 ../fish/guestfish.pod:1058
5973 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1060
5975 "Location of temporary directory, defaults to C</tmp> except for the cached "
5976 "supermin appliance which defaults to C</var/tmp>."
5980 #: ../src/guestfs.pod:2805 ../fish/guestfish.pod:1063
5982 "If libguestfs was compiled to use the supermin appliance then the real "
5983 "appliance is cached in this directory, shared between all handles belonging "
5984 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5985 "use in case C</var/tmp> is not large enough."
5990 #: ../src/guestfs.pod:2813 ../fish/guestfish.pod:1121
5991 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:238
5992 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572
5993 #: ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189
5994 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5995 #: ../tools/virt-list-partitions.pl:257
6000 #: ../src/guestfs.pod:2815
6002 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6003 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6004 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6005 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6006 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6007 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6008 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6013 #: ../src/guestfs.pod:2842
6015 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6016 "(8)>, L<disktype(1)>."
6021 #: ../src/guestfs.pod:2849 ../tools/virt-win-reg.pl:587
6022 #: ../tools/virt-make-fs.pl:553
6028 #: ../src/guestfs.pod:2851
6029 msgid "To get a list of bugs against libguestfs use this link:"
6034 #: ../src/guestfs.pod:2853
6036 "L<https://bugzilla.redhat.com/buglist.cgi?"
6037 "component=libguestfs&product=Virtualization+Tools>"
6042 #: ../src/guestfs.pod:2855
6043 msgid "To report a new bug against libguestfs use this link:"
6048 #: ../src/guestfs.pod:2857
6050 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6051 "component=libguestfs&product=Virtualization+Tools>"
6056 #: ../src/guestfs.pod:2859
6057 msgid "When reporting a bug, please check:"
6062 #: ../src/guestfs.pod:2865
6063 msgid "That the bug hasn't been reported already."
6068 #: ../src/guestfs.pod:2869
6069 msgid "That you are testing a recent version."
6074 #: ../src/guestfs.pod:2873
6075 msgid "Describe the bug accurately, and give a way to reproduce it."
6080 #: ../src/guestfs.pod:2877
6082 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6088 #: ../src/guestfs.pod:2882 ../fish/guestfish.pod:1144
6089 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:249
6095 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1146
6096 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:251
6097 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6102 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1148
6103 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:253
6104 #: ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602
6105 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206
6106 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6107 #: ../tools/virt-list-partitions.pl:273
6113 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1150
6114 #: ../fuse/guestmount.pod:255
6115 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
6120 #: ../src/guestfs.pod:2891
6122 "This library is free software; you can redistribute it and/or modify it "
6123 "under the terms of the GNU Lesser General Public License as published by the "
6124 "Free Software Foundation; either version 2 of the License, or (at your "
6125 "option) any later version."
6130 #: ../src/guestfs.pod:2896
6132 "This library is distributed in the hope that it will be useful, but WITHOUT "
6133 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6134 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6140 #: ../src/guestfs.pod:2901
6142 "You should have received a copy of the GNU Lesser General Public License "
6143 "along with this library; if not, write to the Free Software Foundation, "
6144 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6149 #: ../src/guestfs-actions.pod:1
6150 msgid "guestfs_add_cdrom"
6155 #: ../src/guestfs-actions.pod:3
6159 " guestfs_add_cdrom (guestfs_h *g,\n"
6160 " const char *filename);\n"
6166 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6167 msgid "This function adds a virtual CD-ROM disk image to the guest."
6172 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6173 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
6178 #: ../src/guestfs-actions.pod:17
6180 "This call checks for the existence of C<filename>. This stops you from "
6181 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6182 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6188 #: ../src/guestfs-actions.pod:24
6190 "If you just want to add an ISO file (often you use this as an efficient way "
6191 "to transfer large files into the guest), then you should probably use "
6192 "C<guestfs_add_drive_ro> instead."
6197 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6198 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6199 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6200 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6201 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6202 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6203 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6204 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6205 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6206 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6207 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6208 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6209 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6210 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6211 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6212 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6213 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1332
6214 #: ../src/guestfs-actions.pod:1438 ../src/guestfs-actions.pod:1472
6215 #: ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1712
6216 #: ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2261
6217 #: ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2466
6218 #: ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:3371
6219 #: ../src/guestfs-actions.pod:3386 ../src/guestfs-actions.pod:3406
6220 #: ../src/guestfs-actions.pod:3561 ../src/guestfs-actions.pod:3575
6221 #: ../src/guestfs-actions.pod:3588 ../src/guestfs-actions.pod:3602
6222 #: ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3653
6223 #: ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3745
6224 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3785
6225 #: ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:3840
6226 #: ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:3878
6227 #: ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3925
6228 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3977
6229 #: ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4005
6230 #: ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4115
6231 #: ../src/guestfs-actions.pod:4135 ../src/guestfs-actions.pod:4148
6232 #: ../src/guestfs-actions.pod:4199 ../src/guestfs-actions.pod:4217
6233 #: ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4251
6234 #: ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4279
6235 #: ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4311
6236 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4389
6237 #: ../src/guestfs-actions.pod:4462 ../src/guestfs-actions.pod:4493
6238 #: ../src/guestfs-actions.pod:4512 ../src/guestfs-actions.pod:4531
6239 #: ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4560
6240 #: ../src/guestfs-actions.pod:4573 ../src/guestfs-actions.pod:4588
6241 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4638
6242 #: ../src/guestfs-actions.pod:4653 ../src/guestfs-actions.pod:4673
6243 #: ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4704
6244 #: ../src/guestfs-actions.pod:4753 ../src/guestfs-actions.pod:4790
6245 #: ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:4832
6246 #: ../src/guestfs-actions.pod:4849 ../src/guestfs-actions.pod:4867
6247 #: ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5058
6248 #: ../src/guestfs-actions.pod:5080 ../src/guestfs-actions.pod:5098
6249 #: ../src/guestfs-actions.pod:5130 ../src/guestfs-actions.pod:5196
6250 #: ../src/guestfs-actions.pod:5213 ../src/guestfs-actions.pod:5226
6251 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5529
6252 #: ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5567
6253 #: ../src/guestfs-actions.pod:5579 ../src/guestfs-actions.pod:5591
6254 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:5617
6255 #: ../src/guestfs-actions.pod:5631 ../src/guestfs-actions.pod:5647
6256 #: ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:5687
6257 #: ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5736
6258 #: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5775
6259 #: ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:5812
6260 #: ../src/guestfs-actions.pod:5833 ../src/guestfs-actions.pod:5852
6261 #: ../src/guestfs-actions.pod:5869 ../src/guestfs-actions.pod:5897
6262 #: ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5940
6263 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:5983
6264 #: ../src/guestfs-actions.pod:5998 ../src/guestfs-actions.pod:6017
6265 #: ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6077
6266 #: ../src/guestfs-actions.pod:6103 ../src/guestfs-actions.pod:6211
6267 #: ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6344
6268 #: ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6370
6269 #: ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6405
6270 #: ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:6431
6271 #: ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6505
6272 #: ../src/guestfs-actions.pod:6522 ../src/guestfs-actions.pod:6538
6273 #: ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6571
6274 #: ../src/guestfs-actions.pod:6584 ../src/guestfs-actions.pod:6604
6275 #: ../src/guestfs-actions.pod:6640 ../src/guestfs-actions.pod:6654
6276 #: ../src/guestfs-actions.pod:6695 ../src/guestfs-actions.pod:6708
6277 #: ../src/guestfs-actions.pod:6726 ../src/guestfs-actions.pod:6760
6278 #: ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6915
6279 #: ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6947
6280 #: ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7015
6281 #: ../src/guestfs-actions.pod:7060 ../src/guestfs-actions.pod:7093
6282 #: ../src/guestfs-actions.pod:7147 ../src/guestfs-actions.pod:7173
6283 #: ../src/guestfs-actions.pod:7239 ../src/guestfs-actions.pod:7258
6284 #: ../src/guestfs-actions.pod:7287
6285 msgid "This function returns 0 on success or -1 on error."
6290 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6291 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6292 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6294 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6300 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6301 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1443
6302 #: ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:1960
6303 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:7181
6304 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:31
6305 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6306 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6307 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:2938
6308 #: ../fish/guestfish-actions.pod:4796 ../fish/guestfish-actions.pod:4893
6310 "Deprecated functions will not be removed from the API, but the fact that "
6311 "they are deprecated indicates that there are problems with correct use of "
6317 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6318 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1911
6319 #: ../src/guestfs-actions.pod:2009 ../src/guestfs-actions.pod:2112
6320 #: ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3388
6321 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:5754
6322 #: ../src/guestfs-actions.pod:5871 ../src/guestfs-actions.pod:5985
6323 #: ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:6573
6324 #: ../src/guestfs-actions.pod:7095
6325 msgid "(Added in 0.3)"
6330 #: ../src/guestfs-actions.pod:41
6331 msgid "guestfs_add_domain"
6336 #: ../src/guestfs-actions.pod:43
6340 " guestfs_add_domain (guestfs_h *g,\n"
6341 " const char *dom,\n"
6348 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6349 #: ../src/guestfs-actions.pod:4350
6351 "You may supply a list of optional arguments to this call. Use zero or more "
6352 "of the following pairs of parameters, and terminate the list with C<-1> on "
6353 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6357 #: ../src/guestfs-actions.pod:53
6360 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6361 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6362 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6363 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6369 #: ../src/guestfs-actions.pod:58
6371 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6372 "It works by connecting to libvirt, requesting the domain and domain XML from "
6373 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6379 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6381 "The number of disks added is returned. This operation is atomic: if an "
6382 "error is returned, then no disks are added."
6387 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6389 "This function does some minimal checks to make sure the libvirt domain is "
6390 "not running (unless C<readonly> is true). In a future version we will try "
6391 "to acquire the libvirt lock on each disk."
6396 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6398 "Disks must be accessible locally. This often means that adding disks from a "
6399 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6400 "unless those disks are accessible via the same device path locally too."
6404 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6406 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6407 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6408 "libvirt URI (or one set through an environment variable, see the libvirt "
6409 "documentation for full details)."
6413 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6415 "The optional C<live> flag controls whether this call will try to connect to "
6416 "a running virtual machine C<guestfsd> process if it sees a suitable "
6417 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6418 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6419 "DAEMONS> for more information."
6424 #: ../src/guestfs-actions.pod:88
6426 "The other optional parameters are passed directly through to "
6427 "C<guestfs_add_drive_opts>."
6432 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6433 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6434 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6435 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6436 #: ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1872
6437 #: ../src/guestfs-actions.pod:1981 ../src/guestfs-actions.pod:2021
6438 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2099
6439 #: ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2719
6440 #: ../src/guestfs-actions.pod:2740 ../src/guestfs-actions.pod:4776
6441 #: ../src/guestfs-actions.pod:4904 ../src/guestfs-actions.pod:5310
6442 #: ../src/guestfs-actions.pod:5336 ../src/guestfs-actions.pod:6681
6443 #: ../src/guestfs-actions.pod:7106 ../src/guestfs-actions.pod:7119
6444 #: ../src/guestfs-actions.pod:7132
6445 msgid "On error this function returns -1."
6450 #: ../src/guestfs-actions.pod:93
6451 msgid "(Added in 1.7.4)"
6456 #: ../src/guestfs-actions.pod:95
6457 msgid "guestfs_add_domain_va"
6462 #: ../src/guestfs-actions.pod:97
6466 " guestfs_add_domain_va (guestfs_h *g,\n"
6467 " const char *dom,\n"
6474 #: ../src/guestfs-actions.pod:102
6475 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6480 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6481 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6482 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4415
6483 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6488 #: ../src/guestfs-actions.pod:106
6489 msgid "guestfs_add_domain_argv"
6494 #: ../src/guestfs-actions.pod:108
6498 " guestfs_add_domain_argv (guestfs_h *g,\n"
6499 " const char *dom,\n"
6500 " const struct guestfs_add_domain_argv *optargs);\n"
6506 #: ../src/guestfs-actions.pod:113
6507 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6512 #: ../src/guestfs-actions.pod:117
6513 msgid "guestfs_add_drive"
6518 #: ../src/guestfs-actions.pod:119
6522 " guestfs_add_drive (guestfs_h *g,\n"
6523 " const char *filename);\n"
6529 #: ../src/guestfs-actions.pod:123
6531 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6532 "optional parameters, so the disk is added writable, with the format being "
6533 "detected automatically."
6538 #: ../src/guestfs-actions.pod:127
6540 "Automatic detection of the format opens you up to a potential security hole "
6541 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6542 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6543 "you should think about replacing calls to this function with calls to "
6544 "C<guestfs_add_drive_opts>, and specifying the format."
6549 #: ../src/guestfs-actions.pod:138
6550 msgid "guestfs_add_drive_opts"
6555 #: ../src/guestfs-actions.pod:140
6559 " guestfs_add_drive_opts (guestfs_h *g,\n"
6560 " const char *filename,\n"
6567 #: ../src/guestfs-actions.pod:150
6570 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6571 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6572 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6578 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6580 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6581 "The first time you call this function, the disk appears as C</dev/sda>, the "
6582 "second time as C</dev/sdb>, and so on."
6587 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6589 "You don't necessarily need to be root when using libguestfs. However you "
6590 "obviously do need sufficient permissions to access the filename for whatever "
6591 "operations you want to perform (ie. read access if you just want to read the "
6592 "image or write access if you want to modify the image)."
6597 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6598 msgid "This call checks that C<filename> exists."
6603 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4361
6604 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2949
6605 msgid "The optional arguments are:"
6610 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6616 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6618 "If true then the image is treated as read-only. Writes are still allowed, "
6619 "but they are stored in a temporary snapshot overlay which is discarded at "
6620 "the end. The disk that you add is not modified."
6625 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6631 #: ../src/guestfs-actions.pod:179
6633 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6634 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6635 "Possible formats include C<raw> and C<qcow2>."
6640 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6642 "Automatic detection of the format opens you up to a potential security hole "
6643 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6644 "RHBZ#642934. Specifying the format closes this security hole."
6649 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6655 #: ../src/guestfs-actions.pod:190
6657 "This rarely-used option lets you emulate the behaviour of the deprecated "
6658 "C<guestfs_add_drive_with_if> call (q.v.)"
6663 #: ../src/guestfs-actions.pod:197
6664 msgid "(Added in 1.5.23)"
6669 #: ../src/guestfs-actions.pod:199
6670 msgid "guestfs_add_drive_opts_va"
6675 #: ../src/guestfs-actions.pod:201
6679 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6680 " const char *filename,\n"
6687 #: ../src/guestfs-actions.pod:206
6688 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6693 #: ../src/guestfs-actions.pod:210
6694 msgid "guestfs_add_drive_opts_argv"
6699 #: ../src/guestfs-actions.pod:212
6703 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6704 " const char *filename,\n"
6705 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6711 #: ../src/guestfs-actions.pod:217
6712 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6717 #: ../src/guestfs-actions.pod:221
6718 msgid "guestfs_add_drive_ro"
6723 #: ../src/guestfs-actions.pod:223
6727 " guestfs_add_drive_ro (guestfs_h *g,\n"
6728 " const char *filename);\n"
6734 #: ../src/guestfs-actions.pod:227
6736 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6737 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6738 "disk is added read-only, with the format being detected automatically."
6743 #: ../src/guestfs-actions.pod:234
6744 msgid "(Added in 1.0.38)"
6749 #: ../src/guestfs-actions.pod:236
6750 msgid "guestfs_add_drive_ro_with_if"
6755 #: ../src/guestfs-actions.pod:238
6759 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6760 " const char *filename,\n"
6761 " const char *iface);\n"
6767 #: ../src/guestfs-actions.pod:243
6769 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6770 "QEMU interface emulation to use at run time."
6775 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6776 #: ../src/guestfs-actions.pod:2351
6777 msgid "(Added in 1.0.84)"
6782 #: ../src/guestfs-actions.pod:257
6783 msgid "guestfs_add_drive_with_if"
6788 #: ../src/guestfs-actions.pod:259
6792 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6793 " const char *filename,\n"
6794 " const char *iface);\n"
6800 #: ../src/guestfs-actions.pod:264
6802 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6803 "QEMU interface emulation to use at run time."
6808 #: ../src/guestfs-actions.pod:278
6809 msgid "guestfs_aug_clear"
6814 #: ../src/guestfs-actions.pod:280
6818 " guestfs_aug_clear (guestfs_h *g,\n"
6819 " const char *augpath);\n"
6825 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6827 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6828 "L<augtool(1)> C<clear> command."
6833 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2101
6834 msgid "(Added in 1.3.4)"
6839 #: ../src/guestfs-actions.pod:291
6840 msgid "guestfs_aug_close"
6845 #: ../src/guestfs-actions.pod:293
6849 " guestfs_aug_close (guestfs_h *g);\n"
6855 #: ../src/guestfs-actions.pod:296
6857 "Close the current Augeas handle and free up any resources used by it. After "
6858 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6859 "any other Augeas functions."
6864 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6865 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6866 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6867 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6868 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6869 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6870 #: ../src/guestfs-actions.pod:5387
6871 msgid "(Added in 0.7)"
6876 #: ../src/guestfs-actions.pod:305
6877 msgid "guestfs_aug_defnode"
6882 #: ../src/guestfs-actions.pod:307
6885 " struct guestfs_int_bool *\n"
6886 " guestfs_aug_defnode (guestfs_h *g,\n"
6887 " const char *name,\n"
6888 " const char *expr,\n"
6889 " const char *val);\n"
6895 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6897 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6902 #: ../src/guestfs-actions.pod:316
6904 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6905 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6906 "containing that single node."
6911 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6913 "On success this returns a pair containing the number of nodes in the "
6914 "nodeset, and a boolean flag if a node was created."
6919 #: ../src/guestfs-actions.pod:324
6921 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6922 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6927 #: ../src/guestfs-actions.pod:330
6928 msgid "guestfs_aug_defvar"
6933 #: ../src/guestfs-actions.pod:332
6937 " guestfs_aug_defvar (guestfs_h *g,\n"
6938 " const char *name,\n"
6939 " const char *expr);\n"
6945 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6947 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6948 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6953 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6955 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6956 "evaluates to something which is not a nodeset."
6961 #: ../src/guestfs-actions.pod:348
6962 msgid "guestfs_aug_get"
6967 #: ../src/guestfs-actions.pod:350
6971 " guestfs_aug_get (guestfs_h *g,\n"
6972 " const char *augpath);\n"
6978 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6980 "Look up the value associated with C<path>. If C<path> matches exactly one "
6981 "node, the C<value> is returned."
6986 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6987 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6988 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6989 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6990 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1349
6991 #: ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1652
6992 #: ../src/guestfs-actions.pod:1815 ../src/guestfs-actions.pod:1832
6993 #: ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1933
6994 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:2124
6995 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2523
6996 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2671
6997 #: ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2805
6998 #: ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:2860
6999 #: ../src/guestfs-actions.pod:2897 ../src/guestfs-actions.pod:2957
7000 #: ../src/guestfs-actions.pod:2980 ../src/guestfs-actions.pod:3547
7001 #: ../src/guestfs-actions.pod:3897 ../src/guestfs-actions.pod:4067
7002 #: ../src/guestfs-actions.pod:4177 ../src/guestfs-actions.pod:4922
7003 #: ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:5285
7004 #: ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5512
7005 #: ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6140
7006 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6181
7007 #: ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:6874
7008 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:7072
7009 #: ../src/guestfs-actions.pod:7344
7011 "This function returns a string, or NULL on error. I<The caller must free "
7012 "the returned string after use>."
7017 #: ../src/guestfs-actions.pod:362
7018 msgid "guestfs_aug_init"
7023 #: ../src/guestfs-actions.pod:364
7027 " guestfs_aug_init (guestfs_h *g,\n"
7028 " const char *root,\n"
7035 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7037 "Create a new Augeas handle for editing configuration files. If there was "
7038 "any previous Augeas handle associated with this guestfs session, then it is "
7044 #: ../src/guestfs-actions.pod:373
7045 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7050 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7052 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7057 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7059 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7060 "logical I<or> of the following integers:"
7065 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7066 msgid "C<AUG_SAVE_BACKUP> = 1"
7071 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7072 msgid "Keep the original file with a C<.augsave> extension."
7077 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7078 msgid "C<AUG_SAVE_NEWFILE> = 2"
7083 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7085 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7086 "original. Overrides C<AUG_SAVE_BACKUP>."
7091 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7092 msgid "C<AUG_TYPE_CHECK> = 4"
7097 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7098 msgid "Typecheck lenses (can be expensive)."
7103 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7104 msgid "C<AUG_NO_STDINC> = 8"
7109 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7110 msgid "Do not use standard load path for modules."
7115 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7116 msgid "C<AUG_SAVE_NOOP> = 16"
7121 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7122 msgid "Make save a no-op, just record what would have been changed."
7127 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7128 msgid "C<AUG_NO_LOAD> = 32"
7133 #: ../src/guestfs-actions.pod:408
7134 msgid "Do not load the tree in C<guestfs_aug_init>."
7139 #: ../src/guestfs-actions.pod:412
7140 msgid "To close the handle, you can call C<guestfs_aug_close>."
7145 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7146 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7151 #: ../src/guestfs-actions.pod:420
7152 msgid "guestfs_aug_insert"
7157 #: ../src/guestfs-actions.pod:422
7161 " guestfs_aug_insert (guestfs_h *g,\n"
7162 " const char *augpath,\n"
7163 " const char *label,\n"
7170 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7172 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7173 "or after C<path> (depending on the boolean flag C<before>)."
7178 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7180 "C<path> must match exactly one existing node in the tree, and C<label> must "
7181 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7186 #: ../src/guestfs-actions.pod:440
7187 msgid "guestfs_aug_load"
7192 #: ../src/guestfs-actions.pod:442
7196 " guestfs_aug_load (guestfs_h *g);\n"
7202 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7203 msgid "Load files into the tree."
7208 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7209 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7214 #: ../src/guestfs-actions.pod:454
7215 msgid "guestfs_aug_ls"
7220 #: ../src/guestfs-actions.pod:456
7224 " guestfs_aug_ls (guestfs_h *g,\n"
7225 " const char *augpath);\n"
7231 #: ../src/guestfs-actions.pod:460
7233 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7234 "sorting the resulting nodes into alphabetical order."
7239 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7240 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7241 #: ../src/guestfs-actions.pod:1364 ../src/guestfs-actions.pod:1383
7242 #: ../src/guestfs-actions.pod:1486 ../src/guestfs-actions.pod:1505
7243 #: ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:2196
7244 #: ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:2231
7245 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:2298
7246 #: ../src/guestfs-actions.pod:2369 ../src/guestfs-actions.pod:2418
7247 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2914
7248 #: ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3467
7249 #: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3634
7250 #: ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4737
7251 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5383
7252 #: ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:6197
7253 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6313
7254 #: ../src/guestfs-actions.pod:6459 ../src/guestfs-actions.pod:6483
7255 #: ../src/guestfs-actions.pod:6965 ../src/guestfs-actions.pod:6985
7256 #: ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7197
7257 #: ../src/guestfs-actions.pod:7216 ../src/guestfs-actions.pod:7301
7258 #: ../src/guestfs-actions.pod:7320 ../src/guestfs-actions.pod:7366
7259 #: ../src/guestfs-actions.pod:7385
7261 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7262 ">), or NULL if there was an error. I<The caller must free the strings and "
7263 "the array after use>."
7268 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7269 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1421
7270 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3291
7271 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3930
7272 #: ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4150
7273 #: ../src/guestfs-actions.pod:4313 ../src/guestfs-actions.pod:4741
7274 #: ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5593
7275 #: ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:5619
7276 #: ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6697
7277 #: ../src/guestfs-actions.pod:6710 ../src/guestfs-actions.pod:6949
7278 #: ../src/guestfs-actions.pod:7185
7279 msgid "(Added in 0.8)"
7284 #: ../src/guestfs-actions.pod:469
7285 msgid "guestfs_aug_match"
7290 #: ../src/guestfs-actions.pod:471
7294 " guestfs_aug_match (guestfs_h *g,\n"
7295 " const char *augpath);\n"
7301 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7303 "Returns a list of paths which match the path expression C<path>. The "
7304 "returned paths are sufficiently qualified so that they match exactly one "
7305 "node in the current tree."
7310 #: ../src/guestfs-actions.pod:485
7311 msgid "guestfs_aug_mv"
7316 #: ../src/guestfs-actions.pod:487
7320 " guestfs_aug_mv (guestfs_h *g,\n"
7321 " const char *src,\n"
7322 " const char *dest);\n"
7328 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7330 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7331 "C<dest> is overwritten if it exists."
7336 #: ../src/guestfs-actions.pod:499
7337 msgid "guestfs_aug_rm"
7342 #: ../src/guestfs-actions.pod:501
7346 " guestfs_aug_rm (guestfs_h *g,\n"
7347 " const char *augpath);\n"
7353 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7354 msgid "Remove C<path> and all of its children."
7359 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7360 msgid "On success this returns the number of entries which were removed."
7365 #: ../src/guestfs-actions.pod:513
7366 msgid "guestfs_aug_save"
7371 #: ../src/guestfs-actions.pod:515
7375 " guestfs_aug_save (guestfs_h *g);\n"
7381 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7382 msgid "This writes all pending changes to disk."
7387 #: ../src/guestfs-actions.pod:520
7389 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7395 #: ../src/guestfs-actions.pod:527
7396 msgid "guestfs_aug_set"
7401 #: ../src/guestfs-actions.pod:529
7405 " guestfs_aug_set (guestfs_h *g,\n"
7406 " const char *augpath,\n"
7407 " const char *val);\n"
7413 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7414 msgid "Set the value associated with C<path> to C<val>."
7419 #: ../src/guestfs-actions.pod:536
7421 "In the Augeas API, it is possible to clear a node by setting the value to "
7422 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7423 "this call. Instead you must use the C<guestfs_aug_clear> call."
7428 #: ../src/guestfs-actions.pod:545
7429 msgid "guestfs_available"
7434 #: ../src/guestfs-actions.pod:547
7438 " guestfs_available (guestfs_h *g,\n"
7439 " char *const *groups);\n"
7445 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7447 "This command is used to check the availability of some groups of "
7448 "functionality in the appliance, which not all builds of the libguestfs "
7449 "appliance will be able to provide."
7454 #: ../src/guestfs-actions.pod:555
7456 "The libguestfs groups, and the functions that those groups correspond to, "
7457 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7458 "runtime by calling C<guestfs_available_all_groups>."
7463 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7465 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7466 "\"]> would check for the availability of the Linux inotify functions and "
7467 "Augeas (configuration file editing) functions."
7472 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7473 msgid "The command returns no error if I<all> requested groups are available."
7478 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7480 "It fails with an error if one or more of the requested groups is unavailable "
7486 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7488 "If an unknown group name is included in the list of groups then an error is "
7494 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7500 #: ../src/guestfs-actions.pod:579
7501 msgid "You must call C<guestfs_launch> before calling this function."
7506 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7508 "The reason is because we don't know what groups are supported by the "
7509 "appliance/daemon until it is running and can be queried."
7514 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7516 "If a group of functions is available, this does not necessarily mean that "
7517 "they will work. You still have to check for errors when calling individual "
7518 "API functions even if they are available."
7523 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7525 "It is usually the job of distro packagers to build complete functionality "
7526 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7527 "with all requirements satisfied, will support everything."
7532 #: ../src/guestfs-actions.pod:601
7534 "This call was added in version C<1.0.80>. In previous versions of "
7535 "libguestfs all you could do would be to speculatively execute a command to "
7536 "find out if the daemon implemented it. See also C<guestfs_version>."
7541 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7542 msgid "(Added in 1.0.80)"
7547 #: ../src/guestfs-actions.pod:612
7548 msgid "guestfs_available_all_groups"
7553 #: ../src/guestfs-actions.pod:614
7557 " guestfs_available_all_groups (guestfs_h *g);\n"
7563 #: ../src/guestfs-actions.pod:617
7565 "This command returns a list of all optional groups that this daemon knows "
7566 "about. Note this returns both supported and unsupported groups. To find "
7567 "out which ones the daemon can actually support you have to call "
7568 "C<guestfs_available> on each member of the returned list."
7573 #: ../src/guestfs-actions.pod:623
7574 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7579 #: ../src/guestfs-actions.pod:629
7580 msgid "(Added in 1.3.15)"
7585 #: ../src/guestfs-actions.pod:631
7586 msgid "guestfs_base64_in"
7591 #: ../src/guestfs-actions.pod:633
7595 " guestfs_base64_in (guestfs_h *g,\n"
7596 " const char *base64file,\n"
7597 " const char *filename);\n"
7603 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7605 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7610 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7611 msgid "(Added in 1.3.5)"
7616 #: ../src/guestfs-actions.pod:645
7617 msgid "guestfs_base64_out"
7622 #: ../src/guestfs-actions.pod:647
7626 " guestfs_base64_out (guestfs_h *g,\n"
7627 " const char *filename,\n"
7628 " const char *base64file);\n"
7634 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7636 "This command downloads the contents of C<filename>, writing it out to local "
7637 "file C<base64file> encoded as base64."
7642 #: ../src/guestfs-actions.pod:659
7643 msgid "guestfs_blockdev_flushbufs"
7648 #: ../src/guestfs-actions.pod:661
7652 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7653 " const char *device);\n"
7659 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7661 "This tells the kernel to flush internal buffers associated with C<device>."
7666 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7667 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7668 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7669 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7670 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7671 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7672 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7673 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7674 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7675 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7676 msgid "This uses the L<blockdev(8)> command."
7681 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7682 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7683 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7684 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7685 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7686 msgid "(Added in 0.9.3)"
7691 #: ../src/guestfs-actions.pod:674
7692 msgid "guestfs_blockdev_getbsz"
7697 #: ../src/guestfs-actions.pod:676
7701 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7702 " const char *device);\n"
7708 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7709 msgid "This returns the block size of a device."
7714 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7715 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7717 "(Note this is different from both I<size in blocks> and I<filesystem block "
7723 #: ../src/guestfs-actions.pod:691
7724 msgid "guestfs_blockdev_getro"
7729 #: ../src/guestfs-actions.pod:693
7733 " guestfs_blockdev_getro (guestfs_h *g,\n"
7734 " const char *device);\n"
7740 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7742 "Returns a boolean indicating if the block device is read-only (true if read-"
7743 "only, false if not)."
7748 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1404
7749 #: ../src/guestfs-actions.pod:1419 ../src/guestfs-actions.pod:1909
7750 #: ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:1992
7751 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2062
7752 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110
7753 #: ../src/guestfs-actions.pod:3000 ../src/guestfs-actions.pod:3017
7754 #: ../src/guestfs-actions.pod:3036 ../src/guestfs-actions.pod:3199
7755 #: ../src/guestfs-actions.pod:3213 ../src/guestfs-actions.pod:3228
7756 #: ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3258
7757 #: ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3289
7758 #: ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:3316
7759 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3345
7760 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:4886
7761 msgid "This function returns a C truth value on success or -1 on error."
7766 #: ../src/guestfs-actions.pod:706
7767 msgid "guestfs_blockdev_getsize64"
7772 #: ../src/guestfs-actions.pod:708
7776 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7777 " const char *device);\n"
7783 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7784 msgid "This returns the size of the device in bytes."
7789 #: ../src/guestfs-actions.pod:714
7790 msgid "See also C<guestfs_blockdev_getsz>."
7795 #: ../src/guestfs-actions.pod:722
7796 msgid "guestfs_blockdev_getss"
7801 #: ../src/guestfs-actions.pod:724
7805 " guestfs_blockdev_getss (guestfs_h *g,\n"
7806 " const char *device);\n"
7812 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7814 "This returns the size of sectors on a block device. Usually 512, but can be "
7815 "larger for modern devices."
7820 #: ../src/guestfs-actions.pod:731
7822 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7828 #: ../src/guestfs-actions.pod:740
7829 msgid "guestfs_blockdev_getsz"
7834 #: ../src/guestfs-actions.pod:742
7838 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7839 " const char *device);\n"
7845 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7847 "This returns the size of the device in units of 512-byte sectors (even if "
7848 "the sectorsize isn't 512 bytes ... weird)."
7853 #: ../src/guestfs-actions.pod:749
7855 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7856 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7861 #: ../src/guestfs-actions.pod:759
7862 msgid "guestfs_blockdev_rereadpt"
7867 #: ../src/guestfs-actions.pod:761
7871 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7872 " const char *device);\n"
7878 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7879 msgid "Reread the partition table on C<device>."
7884 #: ../src/guestfs-actions.pod:773
7885 msgid "guestfs_blockdev_setbsz"
7890 #: ../src/guestfs-actions.pod:775
7894 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7895 " const char *device,\n"
7896 " int blocksize);\n"
7902 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7903 msgid "This sets the block size of a device."
7908 #: ../src/guestfs-actions.pod:791
7909 msgid "guestfs_blockdev_setro"
7914 #: ../src/guestfs-actions.pod:793
7918 " guestfs_blockdev_setro (guestfs_h *g,\n"
7919 " const char *device);\n"
7925 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7926 msgid "Sets the block device named C<device> to read-only."
7931 #: ../src/guestfs-actions.pod:805
7932 msgid "guestfs_blockdev_setrw"
7937 #: ../src/guestfs-actions.pod:807
7941 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7942 " const char *device);\n"
7948 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7949 msgid "Sets the block device named C<device> to read-write."
7954 #: ../src/guestfs-actions.pod:819
7955 msgid "guestfs_case_sensitive_path"
7960 #: ../src/guestfs-actions.pod:821
7964 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7965 " const char *path);\n"
7971 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7973 "This can be used to resolve case insensitive paths on a filesystem which is "
7974 "case sensitive. The use case is to resolve paths which you have read from "
7975 "Windows configuration files or the Windows Registry, to the true path."
7980 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7982 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7983 "(and probably others), which is that although the underlying filesystem is "
7984 "case-insensitive, the driver exports the filesystem to Linux as case-"
7990 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7992 "One consequence of this is that special directories such as C<c:\\windows> "
7993 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7994 "precise details of how they were created. In Windows itself this would not "
8000 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8002 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8008 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8010 "This function resolves the true case of each element in the path and returns "
8011 "the case-sensitive path."
8016 #: ../src/guestfs-actions.pod:847
8018 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8019 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8020 "how the directories were originally created under Windows)."
8025 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8026 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8031 #: ../src/guestfs-actions.pod:855
8032 msgid "See also C<guestfs_realpath>."
8037 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6877
8038 msgid "(Added in 1.0.75)"
8043 #: ../src/guestfs-actions.pod:862
8049 #: ../src/guestfs-actions.pod:864
8053 " guestfs_cat (guestfs_h *g,\n"
8054 " const char *path);\n"
8060 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5373
8061 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3597
8062 msgid "Return the contents of the file named C<path>."
8067 #: ../src/guestfs-actions.pod:870
8069 "Note that this function cannot correctly handle binary files (specifically, "
8070 "files containing C<\\0> character which is treated as end of string). For "
8071 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8072 "functions which have a more complex interface."
8077 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8078 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1368
8079 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1490
8080 #: ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:1758
8081 #: ../src/guestfs-actions.pod:2216 ../src/guestfs-actions.pod:2235
8082 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:2302
8083 #: ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:2348
8084 #: ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5181
8085 #: ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5338
8086 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:6262
8087 #: ../src/guestfs-actions.pod:6317 ../src/guestfs-actions.pod:6463
8088 #: ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:7149
8089 #: ../src/guestfs-actions.pod:7175 ../src/guestfs-actions.pod:7201
8090 #: ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7305
8091 #: ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7370
8092 #: ../src/guestfs-actions.pod:7389 ../fish/guestfish-actions.pod:587
8093 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8094 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8095 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8096 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8097 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8098 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8099 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3467
8100 #: ../fish/guestfish-actions.pod:3482 ../fish/guestfish-actions.pod:3558
8101 #: ../fish/guestfish-actions.pod:3575 ../fish/guestfish-actions.pod:3590
8102 #: ../fish/guestfish-actions.pod:4216 ../fish/guestfish-actions.pod:4262
8103 #: ../fish/guestfish-actions.pod:4347 ../fish/guestfish-actions.pod:4362
8104 #: ../fish/guestfish-actions.pod:4772 ../fish/guestfish-actions.pod:4790
8105 #: ../fish/guestfish-actions.pod:4807 ../fish/guestfish-actions.pod:4817
8106 #: ../fish/guestfish-actions.pod:4865 ../fish/guestfish-actions.pod:4875
8107 #: ../fish/guestfish-actions.pod:4904 ../fish/guestfish-actions.pod:4914
8109 "Because of the message protocol, there is a transfer limit of somewhere "
8110 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8115 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3471
8116 #: ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:3550
8117 #: ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:4043
8118 #: ../src/guestfs-actions.pod:4057 ../src/guestfs-actions.pod:5261
8119 #: ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:7036
8120 #: ../src/guestfs-actions.pod:7050
8121 msgid "(Added in 0.4)"
8126 #: ../src/guestfs-actions.pod:883
8127 msgid "guestfs_checksum"
8132 #: ../src/guestfs-actions.pod:885
8136 " guestfs_checksum (guestfs_h *g,\n"
8137 " const char *csumtype,\n"
8138 " const char *path);\n"
8144 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8146 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8151 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8153 "The type of checksum to compute is given by the C<csumtype> parameter which "
8154 "must have one of the following values:"
8159 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8165 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8167 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8173 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8179 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8180 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8185 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8191 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8192 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8197 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8203 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8204 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8209 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8215 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8216 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8221 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8227 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8228 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8233 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8239 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8240 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8245 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8246 msgid "The checksum is returned as a printable string."
8251 #: ../src/guestfs-actions.pod:931
8252 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8257 #: ../src/guestfs-actions.pod:933
8258 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8263 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8264 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:3215
8265 #: ../src/guestfs-actions.pod:3244 ../src/guestfs-actions.pod:3305
8266 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:6733
8267 msgid "(Added in 1.0.2)"
8272 #: ../src/guestfs-actions.pod:940
8273 msgid "guestfs_checksum_device"
8278 #: ../src/guestfs-actions.pod:942
8282 " guestfs_checksum_device (guestfs_h *g,\n"
8283 " const char *csumtype,\n"
8284 " const char *device);\n"
8290 #: ../src/guestfs-actions.pod:947
8292 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8293 "device named C<device>. For the types of checksums supported see the "
8294 "C<guestfs_checksum> command."
8299 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4792
8300 #: ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:4888
8301 #: ../src/guestfs-actions.pod:4906 ../src/guestfs-actions.pod:5082
8302 #: ../src/guestfs-actions.pod:6642 ../src/guestfs-actions.pod:6656
8303 #: ../src/guestfs-actions.pod:7062
8304 msgid "(Added in 1.3.2)"
8309 #: ../src/guestfs-actions.pod:956
8310 msgid "guestfs_checksums_out"
8315 #: ../src/guestfs-actions.pod:958
8319 " guestfs_checksums_out (guestfs_h *g,\n"
8320 " const char *csumtype,\n"
8321 " const char *directory,\n"
8322 " const char *sumsfile);\n"
8328 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8330 "This command computes the checksums of all regular files in C<directory> and "
8331 "then emits a list of those checksums to the local output file C<sumsfile>."
8336 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8338 "This can be used for verifying the integrity of a virtual machine. However "
8339 "to be properly secure you should pay attention to the output of the checksum "
8340 "command (it uses the ones from GNU coreutils). In particular when the "
8341 "filename is not printable, coreutils uses a special backslash syntax. For "
8342 "more information, see the GNU coreutils info file."
8347 #: ../src/guestfs-actions.pod:978
8348 msgid "(Added in 1.3.7)"
8353 #: ../src/guestfs-actions.pod:980
8354 msgid "guestfs_chmod"
8359 #: ../src/guestfs-actions.pod:982
8363 " guestfs_chmod (guestfs_h *g,\n"
8365 " const char *path);\n"
8371 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8373 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8379 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8381 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8382 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8388 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4294
8389 #: ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4510
8390 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:676
8391 #: ../fish/guestfish-actions.pod:2913 ../fish/guestfish-actions.pod:3042
8392 #: ../fish/guestfish-actions.pod:3052 ../fish/guestfish-actions.pod:3062
8393 msgid "The mode actually set is affected by the umask."
8398 #: ../src/guestfs-actions.pod:1000
8399 msgid "guestfs_chown"
8404 #: ../src/guestfs-actions.pod:1002
8408 " guestfs_chown (guestfs_h *g,\n"
8411 " const char *path);\n"
8417 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8418 msgid "Change the file owner to C<owner> and group to C<group>."
8423 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3402
8424 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2371
8426 "Only numeric uid and gid are supported. If you want to use names, you will "
8427 "need to locate and parse the password file yourself (Augeas support makes "
8428 "this relatively easy)."
8433 #: ../src/guestfs-actions.pod:1018
8434 msgid "guestfs_command"
8439 #: ../src/guestfs-actions.pod:1020
8443 " guestfs_command (guestfs_h *g,\n"
8444 " char *const *arguments);\n"
8450 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8452 "This call runs a command from the guest filesystem. The filesystem must be "
8453 "mounted, and must contain a compatible operating system (ie. something "
8454 "Linux, with the same or compatible processor architecture)."
8459 #: ../src/guestfs-actions.pod:1029
8461 "The single parameter is an argv-style list of arguments. The first element "
8462 "is the name of the program to run. Subsequent elements are parameters. The "
8463 "list must be non-empty (ie. must contain a program name). Note that the "
8464 "command runs directly, and is I<not> invoked via the shell (see "
8470 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8471 msgid "The return value is anything printed to I<stdout> by the command."
8476 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8478 "If the command returns a non-zero exit status, then this function returns an "
8479 "error message. The error message string is the content of I<stderr> from "
8485 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8487 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8488 "bin>. If you require a program from another location, you should provide "
8489 "the full path in the first parameter."
8494 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8496 "Shared libraries and data files required by the program must be available on "
8497 "filesystems which are mounted in the correct places. It is the caller's "
8498 "responsibility to ensure all filesystems that are needed are mounted at the "
8504 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8505 #: ../src/guestfs-actions.pod:1543
8506 msgid "(Added in 0.9.1)"
8511 #: ../src/guestfs-actions.pod:1062
8512 msgid "guestfs_command_lines"
8517 #: ../src/guestfs-actions.pod:1064
8521 " guestfs_command_lines (guestfs_h *g,\n"
8522 " char *const *arguments);\n"
8528 #: ../src/guestfs-actions.pod:1068
8530 "This is the same as C<guestfs_command>, but splits the result into a list of "
8536 #: ../src/guestfs-actions.pod:1071
8537 msgid "See also: C<guestfs_sh_lines>"
8542 #: ../src/guestfs-actions.pod:1082
8543 msgid "guestfs_config"
8548 #: ../src/guestfs-actions.pod:1084
8552 " guestfs_config (guestfs_h *g,\n"
8553 " const char *qemuparam,\n"
8554 " const char *qemuvalue);\n"
8560 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8562 "This can be used to add arbitrary qemu command line parameters of the form "
8563 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8564 "setting some parameters which would interfere with parameters that we use."
8569 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8570 msgid "The first character of C<param> string must be a C<-> (dash)."
8575 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8576 msgid "C<value> can be NULL."
8581 #: ../src/guestfs-actions.pod:1102
8582 msgid "guestfs_copy_size"
8587 #: ../src/guestfs-actions.pod:1104
8591 " guestfs_copy_size (guestfs_h *g,\n"
8592 " const char *src,\n"
8593 " const char *dest,\n"
8600 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8602 "This command copies exactly C<size> bytes from one source device or file "
8603 "C<src> to another destination device or file C<dest>."
8608 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8610 "Note this will fail if the source is too short or if the destination is not "
8616 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8617 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1692
8618 #: ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:6728
8619 #: ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7241
8620 #: ../src/guestfs-actions.pod:7260
8622 "This long-running command can generate progress notification messages so "
8623 "that the caller can display a progress bar or indicator. To receive these "
8624 "messages, the caller must register a progress callback. See L<guestfs(3)/"
8625 "guestfs_set_progress_callback>."
8630 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4070
8631 #: ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:6969
8632 #: ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7075
8633 msgid "(Added in 1.0.87)"
8638 #: ../src/guestfs-actions.pod:1125
8644 #: ../src/guestfs-actions.pod:1127
8648 " guestfs_cp (guestfs_h *g,\n"
8649 " const char *src,\n"
8650 " const char *dest);\n"
8656 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8658 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8659 "destination filename or destination directory."
8664 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8665 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8666 #: ../src/guestfs-actions.pod:1406 ../src/guestfs-actions.pod:4755
8667 #: ../src/guestfs-actions.pod:5132
8668 msgid "(Added in 1.0.18)"
8673 #: ../src/guestfs-actions.pod:1139
8674 msgid "guestfs_cp_a"
8679 #: ../src/guestfs-actions.pod:1141
8683 " guestfs_cp_a (guestfs_h *g,\n"
8684 " const char *src,\n"
8685 " const char *dest);\n"
8691 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8693 "This copies a file or directory from C<src> to C<dest> recursively using the "
8699 #: ../src/guestfs-actions.pod:1153
8705 #: ../src/guestfs-actions.pod:1155
8709 " guestfs_dd (guestfs_h *g,\n"
8710 " const char *src,\n"
8711 " const char *dest);\n"
8717 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8719 "This command copies from one source device or file C<src> to another "
8720 "destination device or file C<dest>. Normally you would use this to copy to "
8721 "or from a device or partition, for example to duplicate a filesystem."
8726 #: ../src/guestfs-actions.pod:1165
8728 "If the destination is a device, it must be as large or larger than the "
8729 "source file or device, otherwise the copy will fail. This command cannot do "
8730 "partial copies (see C<guestfs_copy_size>)."
8735 #: ../src/guestfs-actions.pod:1173
8741 #: ../src/guestfs-actions.pod:1175
8745 " guestfs_df (guestfs_h *g);\n"
8751 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8752 msgid "This command runs the C<df> command to report disk space used."
8757 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8759 "This command is mostly useful for interactive sessions. It is I<not> "
8760 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8766 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8767 #: ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:2281
8768 #: ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2373
8769 #: ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4655
8770 #: ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6490
8771 #: ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7121
8772 #: ../src/guestfs-actions.pod:7134
8773 msgid "(Added in 1.0.54)"
8778 #: ../src/guestfs-actions.pod:1189
8779 msgid "guestfs_df_h"
8784 #: ../src/guestfs-actions.pod:1191
8788 " guestfs_df_h (guestfs_h *g);\n"
8794 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8796 "This command runs the C<df -h> command to report disk space used in human-"
8802 #: ../src/guestfs-actions.pod:1206
8803 msgid "guestfs_dmesg"
8808 #: ../src/guestfs-actions.pod:1208
8812 " guestfs_dmesg (guestfs_h *g);\n"
8818 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8820 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8821 "This is sometimes useful for extended debugging of problems."
8826 #: ../src/guestfs-actions.pod:1215
8828 "Another way to get the same information is to enable verbose messages with "
8829 "C<guestfs_set_verbose> or by setting the environment variable "
8830 "C<LIBGUESTFS_DEBUG=1> before running the program."
8835 #: ../src/guestfs-actions.pod:1225
8836 msgid "guestfs_download"
8841 #: ../src/guestfs-actions.pod:1227
8845 " guestfs_download (guestfs_h *g,\n"
8846 " const char *remotefilename,\n"
8847 " const char *filename);\n"
8853 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8854 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8856 "Download file C<remotefilename> and save it as C<filename> on the local "
8862 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6722
8863 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4520
8864 msgid "C<filename> can also be a named pipe."
8869 #: ../src/guestfs-actions.pod:1237
8870 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8875 #: ../src/guestfs-actions.pod:1248
8876 msgid "guestfs_download_offset"
8881 #: ../src/guestfs-actions.pod:1250
8885 " guestfs_download_offset (guestfs_h *g,\n"
8886 " const char *remotefilename,\n"
8887 " const char *filename,\n"
8888 " int64_t offset,\n"
8895 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8897 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8898 "region must be within the file or device)."
8903 #: ../src/guestfs-actions.pod:1263
8905 "Note that there is no limit on the amount of data that can be downloaded "
8906 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8907 "full amount unless an error occurs."
8912 #: ../src/guestfs-actions.pod:1268
8913 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8918 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6767
8919 msgid "(Added in 1.5.17)"
8924 #: ../src/guestfs-actions.pod:1279
8925 msgid "guestfs_drop_caches"
8930 #: ../src/guestfs-actions.pod:1281
8934 " guestfs_drop_caches (guestfs_h *g,\n"
8935 " int whattodrop);\n"
8941 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8943 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8944 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8945 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8950 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8951 msgid "Setting C<whattodrop> to 3 should drop everything."
8956 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8958 "This automatically calls L<sync(2)> before the operation, so that the "
8959 "maximum guest memory is freed."
8964 #: ../src/guestfs-actions.pod:1299
8970 #: ../src/guestfs-actions.pod:1301
8974 " guestfs_du (guestfs_h *g,\n"
8975 " const char *path);\n"
8981 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8983 "This command runs the C<du -s> command to estimate file space usage for "
8989 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8991 "C<path> can be a file or a directory. If C<path> is a directory then the "
8992 "estimate includes the contents of the directory and all subdirectories "
8998 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9000 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9005 #: ../src/guestfs-actions.pod:1319
9006 msgid "guestfs_e2fsck_f"
9011 #: ../src/guestfs-actions.pod:1321
9015 " guestfs_e2fsck_f (guestfs_h *g,\n"
9016 " const char *device);\n"
9022 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:885
9024 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9025 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
9031 #: ../src/guestfs-actions.pod:1329
9033 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9034 "Normally you should use C<guestfs_fsck>."
9039 #: ../src/guestfs-actions.pod:1334
9040 msgid "(Added in 1.0.29)"
9045 #: ../src/guestfs-actions.pod:1336
9046 msgid "guestfs_echo_daemon"
9051 #: ../src/guestfs-actions.pod:1338
9055 " guestfs_echo_daemon (guestfs_h *g,\n"
9056 " char *const *words);\n"
9062 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:896
9064 "This command concatenates the list of C<words> passed with single spaces "
9065 "between them and returns the resulting string."
9070 #: ../src/guestfs-actions.pod:1345 ../fish/guestfish-actions.pod:899
9071 msgid "You can use this command to test the connection through to the daemon."
9076 #: ../src/guestfs-actions.pod:1347
9077 msgid "See also C<guestfs_ping_daemon>."
9082 #: ../src/guestfs-actions.pod:1352 ../src/guestfs-actions.pod:2089
9083 #: ../src/guestfs-actions.pod:5966
9084 msgid "(Added in 1.0.69)"
9089 #: ../src/guestfs-actions.pod:1354
9090 msgid "guestfs_egrep"
9095 #: ../src/guestfs-actions.pod:1356
9099 " guestfs_egrep (guestfs_h *g,\n"
9100 " const char *regex,\n"
9101 " const char *path);\n"
9107 #: ../src/guestfs-actions.pod:1361 ../fish/guestfish-actions.pod:907
9109 "This calls the external C<egrep> program and returns the matching lines."
9114 #: ../src/guestfs-actions.pod:1371 ../src/guestfs-actions.pod:1390
9115 #: ../src/guestfs-actions.pod:1447 ../src/guestfs-actions.pod:1493
9116 #: ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:2219
9117 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2394
9118 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2422
9119 #: ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2490
9120 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3563
9121 #: ../src/guestfs-actions.pod:3577 ../src/guestfs-actions.pod:3590
9122 #: ../src/guestfs-actions.pod:3604 ../src/guestfs-actions.pod:4590
9123 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5515
9124 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6346
9125 #: ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6372
9126 #: ../src/guestfs-actions.pod:6394 ../src/guestfs-actions.pod:6407
9127 #: ../src/guestfs-actions.pod:6420 ../src/guestfs-actions.pod:6433
9128 #: ../src/guestfs-actions.pod:7204 ../src/guestfs-actions.pod:7223
9129 #: ../src/guestfs-actions.pod:7308 ../src/guestfs-actions.pod:7327
9130 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7392
9131 msgid "(Added in 1.0.66)"
9136 #: ../src/guestfs-actions.pod:1373
9137 msgid "guestfs_egrepi"
9142 #: ../src/guestfs-actions.pod:1375
9146 " guestfs_egrepi (guestfs_h *g,\n"
9147 " const char *regex,\n"
9148 " const char *path);\n"
9154 #: ../src/guestfs-actions.pod:1380 ../fish/guestfish-actions.pod:917
9156 "This calls the external C<egrep -i> program and returns the matching lines."
9161 #: ../src/guestfs-actions.pod:1392
9162 msgid "guestfs_equal"
9167 #: ../src/guestfs-actions.pod:1394
9171 " guestfs_equal (guestfs_h *g,\n"
9172 " const char *file1,\n"
9173 " const char *file2);\n"
9179 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:927
9181 "This compares the two files C<file1> and C<file2> and returns true if their "
9182 "content is exactly equal, or false otherwise."
9187 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:930
9188 msgid "The external L<cmp(1)> program is used for the comparison."
9193 #: ../src/guestfs-actions.pod:1408
9194 msgid "guestfs_exists"
9199 #: ../src/guestfs-actions.pod:1410
9203 " guestfs_exists (guestfs_h *g,\n"
9204 " const char *path);\n"
9210 #: ../src/guestfs-actions.pod:1414 ../fish/guestfish-actions.pod:936
9212 "This returns C<true> if and only if there is a file, directory (or anything) "
9213 "with the given C<path> name."
9218 #: ../src/guestfs-actions.pod:1417
9219 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9224 #: ../src/guestfs-actions.pod:1423
9225 msgid "guestfs_fallocate"
9230 #: ../src/guestfs-actions.pod:1425
9234 " guestfs_fallocate (guestfs_h *g,\n"
9235 " const char *path,\n"
9242 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1456
9243 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9245 "This command preallocates a file (containing zero bytes) named C<path> of "
9246 "size C<len> bytes. If the file exists already, it is overwritten."
9251 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:949
9253 "Do not confuse this with the guestfish-specific C<alloc> command which "
9254 "allocates a file in the host and attaches it as a device."
9259 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:953
9261 "This function is deprecated. In new code, use the C<fallocate64> call "
9267 #: ../src/guestfs-actions.pod:1449
9268 msgid "guestfs_fallocate64"
9273 #: ../src/guestfs-actions.pod:1451
9277 " guestfs_fallocate64 (guestfs_h *g,\n"
9278 " const char *path,\n"
9285 #: ../src/guestfs-actions.pod:1460
9287 "Note that this call allocates disk blocks for the file. To create a sparse "
9288 "file use C<guestfs_truncate_size> instead."
9293 #: ../src/guestfs-actions.pod:1463
9295 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9296 "oversight it only allowed 30 bit lengths to be specified, effectively "
9297 "limiting the maximum size of files created through that call to 1GB."
9302 #: ../src/guestfs-actions.pod:1468 ../fish/guestfish-actions.pod:976
9304 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9305 "commands which create a file in the host and attach it as a device."
9310 #: ../src/guestfs-actions.pod:1474
9311 msgid "(Added in 1.3.17)"
9316 #: ../src/guestfs-actions.pod:1476
9317 msgid "guestfs_fgrep"
9322 #: ../src/guestfs-actions.pod:1478
9326 " guestfs_fgrep (guestfs_h *g,\n"
9327 " const char *pattern,\n"
9328 " const char *path);\n"
9334 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:984
9336 "This calls the external C<fgrep> program and returns the matching lines."
9341 #: ../src/guestfs-actions.pod:1495
9342 msgid "guestfs_fgrepi"
9347 #: ../src/guestfs-actions.pod:1497
9351 " guestfs_fgrepi (guestfs_h *g,\n"
9352 " const char *pattern,\n"
9353 " const char *path);\n"
9359 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:994
9361 "This calls the external C<fgrep -i> program and returns the matching lines."
9366 #: ../src/guestfs-actions.pod:1514
9367 msgid "guestfs_file"
9372 #: ../src/guestfs-actions.pod:1516
9376 " guestfs_file (guestfs_h *g,\n"
9377 " const char *path);\n"
9383 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1004
9385 "This call uses the standard L<file(1)> command to determine the type or "
9386 "contents of the file."
9391 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1007
9393 "This call will also transparently look inside various types of compressed "
9399 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1010
9401 "The exact command which runs is C<file -zb path>. Note in particular that "
9402 "the filename is not prepended to the output (the C<-b> option)."
9407 #: ../src/guestfs-actions.pod:1530
9409 "This command can also be used on C</dev/> devices (and partitions, LV "
9410 "names). You can for example use this to determine if a device contains a "
9411 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9416 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1019
9418 "If the C<path> does not begin with C</dev/> then this command only works for "
9419 "the content of regular files. For other file types (directory, symbolic "
9420 "link etc) it will just return the string C<directory> etc."
9425 #: ../src/guestfs-actions.pod:1545
9426 msgid "guestfs_file_architecture"
9431 #: ../src/guestfs-actions.pod:1547
9435 " guestfs_file_architecture (guestfs_h *g,\n"
9436 " const char *filename);\n"
9442 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1028
9444 "This detects the architecture of the binary C<filename>, and returns it if "
9450 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1031
9451 msgid "Currently defined architectures are:"
9456 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1035
9462 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1037
9464 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9465 "irrespective of the precise processor requirements of the binary."
9470 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1040
9476 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1042
9477 msgid "64 bit x86-64."
9482 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1044
9488 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1046
9489 msgid "32 bit SPARC."
9494 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1048
9500 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1050
9501 msgid "64 bit SPARC V9 and above."
9506 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1052
9512 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1054
9513 msgid "Intel Itanium."
9518 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1056
9524 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1058
9525 msgid "32 bit Power PC."
9530 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1060
9536 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1062
9537 msgid "64 bit Power PC."
9542 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1066
9543 msgid "Libguestfs may return other architecture strings in future."
9548 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1068
9549 msgid "The function works on at least the following types of files:"
9554 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1074
9555 msgid "many types of Un*x and Linux binary"
9560 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1078
9561 msgid "many types of Un*x and Linux shared library"
9566 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1082
9567 msgid "Windows Win32 and Win64 binaries"
9572 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1086
9573 msgid "Windows Win32 and Win64 DLLs"
9578 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1088
9579 msgid "Win32 binaries and DLLs return C<i386>."
9584 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1090
9585 msgid "Win64 binaries and DLLs return C<x86_64>."
9590 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1094
9591 msgid "Linux kernel modules"
9596 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1098
9597 msgid "Linux new-style initrd images"
9602 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1102
9603 msgid "some non-x86 Linux vmlinuz kernels"
9608 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1106
9609 msgid "What it can't do currently:"
9614 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1112
9615 msgid "static libraries (libfoo.a)"
9620 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1116
9621 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9626 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1120
9627 msgid "x86 Linux vmlinuz kernels"
9632 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1122
9634 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9635 "compressed code, and are horribly hard to unpack. If you want to find the "
9636 "architecture of a kernel, use the architecture of the associated initrd or "
9637 "kernel module(s) instead."
9642 #: ../src/guestfs-actions.pod:1655 ../src/guestfs-actions.pod:1818
9643 #: ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:2526
9644 #: ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2633
9645 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2742
9646 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2863
9647 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:3186
9648 #: ../src/guestfs-actions.pod:3318
9649 msgid "(Added in 1.5.3)"
9654 #: ../src/guestfs-actions.pod:1657
9655 msgid "guestfs_filesize"
9660 #: ../src/guestfs-actions.pod:1659
9664 " guestfs_filesize (guestfs_h *g,\n"
9665 " const char *file);\n"
9671 #: ../src/guestfs-actions.pod:1663 ../fish/guestfish-actions.pod:1133
9672 msgid "This command returns the size of C<file> in bytes."
9677 #: ../src/guestfs-actions.pod:1665
9679 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9680 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9681 "devices, use C<guestfs_blockdev_getsize64>."
9686 #: ../src/guestfs-actions.pod:1671
9687 msgid "(Added in 1.0.82)"
9692 #: ../src/guestfs-actions.pod:1673
9693 msgid "guestfs_fill"
9698 #: ../src/guestfs-actions.pod:1675
9702 " guestfs_fill (guestfs_h *g,\n"
9705 " const char *path);\n"
9711 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1143
9713 "This command creates a new file called C<path>. The initial content of the "
9714 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9720 #: ../src/guestfs-actions.pod:1685
9722 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9723 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9724 "bytes use C<guestfs_fill_pattern>."
9729 #: ../src/guestfs-actions.pod:1697
9730 msgid "(Added in 1.0.79)"
9735 #: ../src/guestfs-actions.pod:1699
9736 msgid "guestfs_fill_pattern"
9741 #: ../src/guestfs-actions.pod:1701
9745 " guestfs_fill_pattern (guestfs_h *g,\n"
9746 " const char *pattern,\n"
9748 " const char *path);\n"
9754 #: ../src/guestfs-actions.pod:1707
9756 "This function is like C<guestfs_fill> except that it creates a new file of "
9757 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9758 "pattern is truncated if necessary to ensure the length of the file is "
9759 "exactly C<len> bytes."
9764 #: ../src/guestfs-actions.pod:1719
9765 msgid "(Added in 1.3.12)"
9770 #: ../src/guestfs-actions.pod:1721
9771 msgid "guestfs_find"
9776 #: ../src/guestfs-actions.pod:1723
9780 " guestfs_find (guestfs_h *g,\n"
9781 " const char *directory);\n"
9787 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1165
9789 "This command lists out all files and directories, recursively, starting at "
9790 "C<directory>. It is essentially equivalent to running the shell command "
9791 "C<find directory -print> but some post-processing happens on the output, "
9797 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1170
9799 "This returns a list of strings I<without any prefix>. Thus if the directory "
9805 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1173
9816 #: ../src/guestfs-actions.pod:1739
9818 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9823 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1180
9835 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1185
9836 msgid "If C<directory> is not a directory, then this command returns an error."
9841 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1188
9842 msgid "The returned list is sorted."
9847 #: ../src/guestfs-actions.pod:1752
9848 msgid "See also C<guestfs_find0>."
9853 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:4007
9854 #: ../src/guestfs-actions.pod:5550
9855 msgid "(Added in 1.0.27)"
9860 #: ../src/guestfs-actions.pod:1763
9861 msgid "guestfs_find0"
9866 #: ../src/guestfs-actions.pod:1765
9870 " guestfs_find0 (guestfs_h *g,\n"
9871 " const char *directory,\n"
9872 " const char *files);\n"
9878 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1199
9880 "This command lists out all files and directories, recursively, starting at "
9881 "C<directory>, placing the resulting list in the external file called "
9887 #: ../src/guestfs-actions.pod:1774
9889 "This command works the same way as C<guestfs_find> with the following "
9895 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1210
9896 msgid "The resulting list is written to an external file."
9901 #: ../src/guestfs-actions.pod:1785 ../fish/guestfish-actions.pod:1214
9903 "Items (filenames) in the result are separated by C<\\0> characters. See "
9904 "L<find(1)> option I<-print0>."
9909 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1219
9910 msgid "This command is not limited in the number of names that it can return."
9915 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1224
9916 msgid "The result list is not sorted."
9921 #: ../src/guestfs-actions.pod:1801
9922 msgid "(Added in 1.0.74)"
9927 #: ../src/guestfs-actions.pod:1803
9928 msgid "guestfs_findfs_label"
9933 #: ../src/guestfs-actions.pod:1805
9937 " guestfs_findfs_label (guestfs_h *g,\n"
9938 " const char *label);\n"
9944 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1234
9946 "This command searches the filesystems and returns the one which has the "
9947 "given label. An error is returned if no such filesystem can be found."
9952 #: ../src/guestfs-actions.pod:1813
9953 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9958 #: ../src/guestfs-actions.pod:1820
9959 msgid "guestfs_findfs_uuid"
9964 #: ../src/guestfs-actions.pod:1822
9968 " guestfs_findfs_uuid (guestfs_h *g,\n"
9969 " const char *uuid);\n"
9975 #: ../src/guestfs-actions.pod:1826 ../fish/guestfish-actions.pod:1244
9977 "This command searches the filesystems and returns the one which has the "
9978 "given UUID. An error is returned if no such filesystem can be found."
9983 #: ../src/guestfs-actions.pod:1830
9984 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9989 #: ../src/guestfs-actions.pod:1837
9990 msgid "guestfs_fsck"
9995 #: ../src/guestfs-actions.pod:1839
9999 " guestfs_fsck (guestfs_h *g,\n"
10000 " const char *fstype,\n"
10001 " const char *device);\n"
10007 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1254
10009 "This runs the filesystem checker (fsck) on C<device> which should have "
10010 "filesystem type C<fstype>."
10015 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1257
10017 "The returned integer is the status. See L<fsck(8)> for the list of status "
10018 "codes from C<fsck>."
10023 #: ../src/guestfs-actions.pod:1856 ../fish/guestfish-actions.pod:1266
10024 msgid "Multiple status codes can be summed together."
10029 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1270
10031 "A non-zero return code can mean \"success\", for example if errors have been "
10032 "corrected on the filesystem."
10037 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1275
10038 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10043 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1280
10045 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10050 #: ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:7246
10051 msgid "(Added in 1.0.16)"
10056 #: ../src/guestfs-actions.pod:1876
10057 msgid "guestfs_get_append"
10062 #: ../src/guestfs-actions.pod:1878
10066 " guestfs_get_append (guestfs_h *g);\n"
10072 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1286
10074 "Return the additional kernel options which are added to the guest kernel "
10080 #: ../src/guestfs-actions.pod:1884 ../fish/guestfish-actions.pod:1289
10081 msgid "If C<NULL> then no options are added."
10086 #: ../src/guestfs-actions.pod:1886
10088 "This function returns a string which may be NULL. There is no way to return "
10089 "an error from this function. The string is owned by the guest handle and "
10090 "must I<not> be freed."
10095 #: ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:5228
10096 #: ../src/guestfs-actions.pod:5708 ../src/guestfs-actions.pod:6108
10097 #: ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6143
10098 #: ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6917
10099 #: ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:7289
10100 msgid "(Added in 1.0.26)"
10104 #: ../src/guestfs-actions.pod:1892
10105 msgid "guestfs_get_attach_method"
10109 #: ../src/guestfs-actions.pod:1894
10113 " guestfs_get_attach_method (guestfs_h *g);\n"
10118 #: ../src/guestfs-actions.pod:1897
10119 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10124 #: ../src/guestfs-actions.pod:1902
10125 msgid "guestfs_get_autosync"
10130 #: ../src/guestfs-actions.pod:1904
10134 " guestfs_get_autosync (guestfs_h *g);\n"
10140 #: ../src/guestfs-actions.pod:1907 ../fish/guestfish-actions.pod:1301
10141 msgid "Get the autosync flag."
10146 #: ../src/guestfs-actions.pod:1913
10147 msgid "guestfs_get_direct"
10152 #: ../src/guestfs-actions.pod:1915
10156 " guestfs_get_direct (guestfs_h *g);\n"
10162 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1307
10163 msgid "Return the direct appliance mode flag."
10168 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:5777
10169 msgid "(Added in 1.0.72)"
10174 #: ../src/guestfs-actions.pod:1924
10175 msgid "guestfs_get_e2label"
10180 #: ../src/guestfs-actions.pod:1926
10184 " guestfs_get_e2label (guestfs_h *g,\n"
10185 " const char *device);\n"
10191 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1313
10193 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10198 #: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1316
10200 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10205 #: ../src/guestfs-actions.pod:1943 ../src/guestfs-actions.pod:1964
10206 #: ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:5814
10207 msgid "(Added in 1.0.15)"
10212 #: ../src/guestfs-actions.pod:1945
10213 msgid "guestfs_get_e2uuid"
10218 #: ../src/guestfs-actions.pod:1947
10222 " guestfs_get_e2uuid (guestfs_h *g,\n"
10223 " const char *device);\n"
10229 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1327
10231 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10236 #: ../src/guestfs-actions.pod:1957 ../fish/guestfish-actions.pod:1330
10238 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10243 #: ../src/guestfs-actions.pod:1966
10244 msgid "guestfs_get_memsize"
10249 #: ../src/guestfs-actions.pod:1968
10253 " guestfs_get_memsize (guestfs_h *g);\n"
10259 #: ../src/guestfs-actions.pod:1971 ../fish/guestfish-actions.pod:1341
10261 "This gets the memory size in megabytes allocated to the qemu subprocess."
10266 #: ../src/guestfs-actions.pod:1974
10268 "If C<guestfs_set_memsize> was not called on this handle, and if "
10269 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10270 "value for memsize."
10275 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2059
10276 #: ../src/guestfs-actions.pod:5830 ../src/guestfs-actions.pod:5937
10277 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10278 #: ../fish/guestfish-actions.pod:3923 ../fish/guestfish-actions.pod:4010
10280 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10285 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:4298
10286 #: ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:4514
10287 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4545
10288 #: ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4575
10289 #: ../src/guestfs-actions.pod:5453 ../src/guestfs-actions.pod:5835
10290 #: ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6683
10291 msgid "(Added in 1.0.55)"
10296 #: ../src/guestfs-actions.pod:1985
10297 msgid "guestfs_get_network"
10302 #: ../src/guestfs-actions.pod:1987
10306 " guestfs_get_network (guestfs_h *g);\n"
10312 #: ../src/guestfs-actions.pod:1990 ../fish/guestfish-actions.pod:1355
10313 msgid "This returns the enable network flag."
10318 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:5854
10319 msgid "(Added in 1.5.4)"
10324 #: ../src/guestfs-actions.pod:1996
10325 msgid "guestfs_get_path"
10330 #: ../src/guestfs-actions.pod:1998
10334 " guestfs_get_path (guestfs_h *g);\n"
10340 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1361
10341 msgid "Return the current search path."
10346 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1363
10348 "This is always non-NULL. If it wasn't set already, then this will return "
10349 "the default path."
10354 #: ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2035
10356 "This function returns a string, or NULL on error. The string is owned by "
10357 "the guest handle and must I<not> be freed."
10362 #: ../src/guestfs-actions.pod:2011
10363 msgid "guestfs_get_pid"
10368 #: ../src/guestfs-actions.pod:2013
10372 " guestfs_get_pid (guestfs_h *g);\n"
10378 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
10380 "Return the process ID of the qemu subprocess. If there is no qemu "
10381 "subprocess, then this will return an error."
10386 #: ../src/guestfs-actions.pod:2019 ../fish/guestfish-actions.pod:1375
10387 msgid "This is an internal call used for debugging and testing."
10392 #: ../src/guestfs-actions.pod:2023
10393 msgid "(Added in 1.0.56)"
10398 #: ../src/guestfs-actions.pod:2025
10399 msgid "guestfs_get_qemu"
10404 #: ../src/guestfs-actions.pod:2027
10408 " guestfs_get_qemu (guestfs_h *g);\n"
10414 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1381
10415 msgid "Return the current qemu binary."
10420 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1383
10422 "This is always non-NULL. If it wasn't set already, then this will return "
10423 "the default qemu binary name."
10428 #: ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:5899
10429 msgid "(Added in 1.0.6)"
10434 #: ../src/guestfs-actions.pod:2040
10435 msgid "guestfs_get_recovery_proc"
10440 #: ../src/guestfs-actions.pod:2042
10444 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10450 #: ../src/guestfs-actions.pod:2045 ../fish/guestfish-actions.pod:1390
10451 msgid "Return the recovery process enabled flag."
10456 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:3408
10457 #: ../src/guestfs-actions.pod:3705 ../src/guestfs-actions.pod:4105
10458 #: ../src/guestfs-actions.pod:4137 ../src/guestfs-actions.pod:5158
10459 #: ../src/guestfs-actions.pod:5501 ../src/guestfs-actions.pod:5923
10460 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:6606
10461 #: ../src/guestfs-actions.pod:6798
10462 msgid "(Added in 1.0.77)"
10467 #: ../src/guestfs-actions.pod:2051
10468 msgid "guestfs_get_selinux"
10473 #: ../src/guestfs-actions.pod:2053
10477 " guestfs_get_selinux (guestfs_h *g);\n"
10483 #: ../src/guestfs-actions.pod:2056
10485 "This returns the current setting of the selinux flag which is passed to the "
10486 "appliance at boot time. See C<guestfs_set_selinux>."
10491 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:2127
10492 #: ../src/guestfs-actions.pod:5942 ../src/guestfs-actions.pod:6000
10493 msgid "(Added in 1.0.67)"
10498 #: ../src/guestfs-actions.pod:2066
10499 msgid "guestfs_get_state"
10504 #: ../src/guestfs-actions.pod:2068
10508 " guestfs_get_state (guestfs_h *g);\n"
10514 #: ../src/guestfs-actions.pod:2071 ../fish/guestfish-actions.pod:1406
10516 "This returns the current state as an opaque integer. This is only useful "
10517 "for printing debug and internal error messages."
10522 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:3211
10523 #: ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3301
10524 #: ../src/guestfs-actions.pod:3328 ../fish/guestfish-actions.pod:1409
10525 #: ../fish/guestfish-actions.pod:2253 ../fish/guestfish-actions.pod:2271
10526 #: ../fish/guestfish-actions.pod:2309 ../fish/guestfish-actions.pod:2325
10527 msgid "For more information on states, see L<guestfs(3)>."
10532 #: ../src/guestfs-actions.pod:2080
10533 msgid "guestfs_get_trace"
10538 #: ../src/guestfs-actions.pod:2082
10542 " guestfs_get_trace (guestfs_h *g);\n"
10548 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1415
10549 msgid "Return the command trace flag."
10554 #: ../src/guestfs-actions.pod:2091
10555 msgid "guestfs_get_umask"
10560 #: ../src/guestfs-actions.pod:2093
10564 " guestfs_get_umask (guestfs_h *g);\n"
10570 #: ../src/guestfs-actions.pod:2096
10572 "Return the current umask. By default the umask is C<022> unless it has been "
10573 "set by calling C<guestfs_umask>."
10578 #: ../src/guestfs-actions.pod:2103
10579 msgid "guestfs_get_verbose"
10584 #: ../src/guestfs-actions.pod:2105
10588 " guestfs_get_verbose (guestfs_h *g);\n"
10594 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1428
10595 msgid "This returns the verbose messages flag."
10600 #: ../src/guestfs-actions.pod:2114
10601 msgid "guestfs_getcon"
10606 #: ../src/guestfs-actions.pod:2116
10610 " guestfs_getcon (guestfs_h *g);\n"
10616 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1434
10617 msgid "This gets the SELinux security context of the daemon."
10622 #: ../src/guestfs-actions.pod:2121
10624 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10629 #: ../src/guestfs-actions.pod:2129
10630 msgid "guestfs_getxattr"
10635 #: ../src/guestfs-actions.pod:2131
10639 " guestfs_getxattr (guestfs_h *g,\n"
10640 " const char *path,\n"
10641 " const char *name,\n"
10642 " size_t *size_r);\n"
10648 #: ../src/guestfs-actions.pod:2137
10650 "Get a single extended attribute from file C<path> named C<name>. This call "
10651 "follows symlinks. If you want to lookup an extended attribute for the "
10652 "symlink itself, use C<guestfs_lgetxattr>."
10657 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3422
10659 "Normally it is better to get all extended attributes from a file in one go "
10660 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10661 "implementations are buggy and do not provide a way to list out attributes. "
10662 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10663 "extended attributes you want in advance and call this function."
10668 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3429
10669 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2390
10671 "Extended attribute values are blobs of binary data. If there is no extended "
10672 "attribute named C<name>, this returns an error."
10677 #: ../src/guestfs-actions.pod:2151
10678 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10683 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2344
10684 #: ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:5151
10685 #: ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5358
10687 "This function returns a buffer, or NULL on error. The size of the returned "
10688 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10693 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3438
10694 msgid "(Added in 1.7.24)"
10699 #: ../src/guestfs-actions.pod:2159
10700 msgid "guestfs_getxattrs"
10705 #: ../src/guestfs-actions.pod:2161
10708 " struct guestfs_xattr_list *\n"
10709 " guestfs_getxattrs (guestfs_h *g,\n"
10710 " const char *path);\n"
10716 #: ../src/guestfs-actions.pod:2165 ../fish/guestfish-actions.pod:1463
10718 "This call lists the extended attributes of the file or directory C<path>."
10723 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1466
10725 "At the system call level, this is a combination of the L<listxattr(2)> and "
10726 "L<getxattr(2)> calls."
10731 #: ../src/guestfs-actions.pod:2171
10732 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10737 #: ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:3450
10738 #: ../src/guestfs-actions.pod:4101
10740 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10741 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10746 #: ../src/guestfs-actions.pod:2177 ../src/guestfs-actions.pod:3454
10747 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3655
10748 #: ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:6019
10749 #: ../src/guestfs-actions.pod:7354
10750 msgid "(Added in 1.0.59)"
10755 #: ../src/guestfs-actions.pod:2179
10756 msgid "guestfs_glob_expand"
10761 #: ../src/guestfs-actions.pod:2181
10765 " guestfs_glob_expand (guestfs_h *g,\n"
10766 " const char *pattern);\n"
10772 #: ../src/guestfs-actions.pod:2185 ../fish/guestfish-actions.pod:1475
10774 "This command searches for all the pathnames matching C<pattern> according to "
10775 "the wildcard expansion rules used by the shell."
10780 #: ../src/guestfs-actions.pod:2189 ../fish/guestfish-actions.pod:1479
10782 "If no paths match, then this returns an empty list (note: not an error)."
10787 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1482
10789 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10790 "GLOB_BRACE>. See that manual page for more details."
10795 #: ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:6184
10796 #: ../src/guestfs-actions.pod:6201
10797 msgid "(Added in 1.0.50)"
10802 #: ../src/guestfs-actions.pod:2202
10803 msgid "guestfs_grep"
10808 #: ../src/guestfs-actions.pod:2204
10812 " guestfs_grep (guestfs_h *g,\n"
10813 " const char *regex,\n"
10814 " const char *path);\n"
10820 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1490
10821 msgid "This calls the external C<grep> program and returns the matching lines."
10826 #: ../src/guestfs-actions.pod:2221
10827 msgid "guestfs_grepi"
10832 #: ../src/guestfs-actions.pod:2223
10836 " guestfs_grepi (guestfs_h *g,\n"
10837 " const char *regex,\n"
10838 " const char *path);\n"
10844 #: ../src/guestfs-actions.pod:2228 ../fish/guestfish-actions.pod:1500
10846 "This calls the external C<grep -i> program and returns the matching lines."
10851 #: ../src/guestfs-actions.pod:2240
10852 msgid "guestfs_grub_install"
10857 #: ../src/guestfs-actions.pod:2242
10861 " guestfs_grub_install (guestfs_h *g,\n"
10862 " const char *root,\n"
10863 " const char *device);\n"
10869 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
10871 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10872 "the root directory being C<root>."
10877 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1513
10879 "Note: If grub-install reports the error \"No suitable drive was found in the "
10880 "generated device map.\" it may be that you need to create a C</boot/grub/"
10881 "device.map> file first that contains the mapping between grub device names "
10882 "and Linux device names. It is usually sufficient to create a file "
10888 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1520
10891 " (hd0) /dev/vda\n"
10897 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1522
10898 msgid "replacing C</dev/vda> with the name of the installation device."
10903 #: ../src/guestfs-actions.pod:2263
10904 msgid "(Added in 1.0.17)"
10909 #: ../src/guestfs-actions.pod:2265
10910 msgid "guestfs_head"
10915 #: ../src/guestfs-actions.pod:2267
10919 " guestfs_head (guestfs_h *g,\n"
10920 " const char *path);\n"
10926 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1528
10928 "This command returns up to the first 10 lines of a file as a list of strings."
10933 #: ../src/guestfs-actions.pod:2283
10934 msgid "guestfs_head_n"
10939 #: ../src/guestfs-actions.pod:2285
10943 " guestfs_head_n (guestfs_h *g,\n"
10945 " const char *path);\n"
10951 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1538
10953 "If the parameter C<nrlines> is a positive number, this returns the first "
10954 "C<nrlines> lines of the file C<path>."
10959 #: ../src/guestfs-actions.pod:2293 ../fish/guestfish-actions.pod:1541
10961 "If the parameter C<nrlines> is a negative number, this returns lines from "
10962 "the file C<path>, excluding the last C<nrlines> lines."
10967 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:6481
10968 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4360
10969 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10974 #: ../src/guestfs-actions.pod:2307
10975 msgid "guestfs_hexdump"
10980 #: ../src/guestfs-actions.pod:2309
10984 " guestfs_hexdump (guestfs_h *g,\n"
10985 " const char *path);\n"
10991 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
10993 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10994 "readable, canonical hex dump of the file."
10999 #: ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:6265
11000 #: ../src/guestfs-actions.pod:6320
11001 msgid "(Added in 1.0.22)"
11006 #: ../src/guestfs-actions.pod:2324
11007 msgid "guestfs_initrd_cat"
11012 #: ../src/guestfs-actions.pod:2326
11016 " guestfs_initrd_cat (guestfs_h *g,\n"
11017 " const char *initrdpath,\n"
11018 " const char *filename,\n"
11019 " size_t *size_r);\n"
11025 #: ../src/guestfs-actions.pod:2332 ../fish/guestfish-actions.pod:1563
11027 "This command unpacks the file C<filename> from the initrd file called "
11028 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11034 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
11036 "For example, in guestfish you could use the following command to examine the "
11037 "boot script (usually called C</init>) contained in a Linux initrd or "
11043 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
11046 " initrd-cat /boot/initrd-<version>.img init\n"
11052 #: ../src/guestfs-actions.pod:2342
11053 msgid "See also C<guestfs_initrd_list>."
11058 #: ../src/guestfs-actions.pod:2353
11059 msgid "guestfs_initrd_list"
11064 #: ../src/guestfs-actions.pod:2355
11068 " guestfs_initrd_list (guestfs_h *g,\n"
11069 " const char *path);\n"
11075 #: ../src/guestfs-actions.pod:2359 ../fish/guestfish-actions.pod:1582
11076 msgid "This command lists out files contained in an initrd."
11081 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1584
11083 "The files are listed without any initial C</> character. The files are "
11084 "listed in the order they appear (not necessarily alphabetical). Directory "
11085 "names are listed as separate items."
11090 #: ../src/guestfs-actions.pod:2365 ../fish/guestfish-actions.pod:1588
11092 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11093 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11099 #: ../src/guestfs-actions.pod:2375
11100 msgid "guestfs_inotify_add_watch"
11105 #: ../src/guestfs-actions.pod:2377
11109 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11110 " const char *path,\n"
11117 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1596
11118 msgid "Watch C<path> for the events listed in C<mask>."
11123 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1598
11125 "Note that if C<path> is a directory then events within that directory are "
11126 "watched, but this does I<not> happen recursively (in subdirectories)."
11131 #: ../src/guestfs-actions.pod:2388 ../fish/guestfish-actions.pod:1602
11133 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11134 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11139 #: ../src/guestfs-actions.pod:2396
11140 msgid "guestfs_inotify_close"
11145 #: ../src/guestfs-actions.pod:2398
11149 " guestfs_inotify_close (guestfs_h *g);\n"
11155 #: ../src/guestfs-actions.pod:2401 ../fish/guestfish-actions.pod:1610
11157 "This closes the inotify handle which was previously opened by inotify_init. "
11158 "It removes all watches, throws away any pending events, and deallocates all "
11164 #: ../src/guestfs-actions.pod:2409
11165 msgid "guestfs_inotify_files"
11170 #: ../src/guestfs-actions.pod:2411
11174 " guestfs_inotify_files (guestfs_h *g);\n"
11180 #: ../src/guestfs-actions.pod:2414
11182 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11183 "returns a list of pathnames of objects that were touched. The returned "
11184 "pathnames are sorted and deduplicated."
11189 #: ../src/guestfs-actions.pod:2424
11190 msgid "guestfs_inotify_init"
11195 #: ../src/guestfs-actions.pod:2426
11199 " guestfs_inotify_init (guestfs_h *g,\n"
11200 " int maxevents);\n"
11206 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1626
11208 "This command creates a new inotify handle. The inotify subsystem can be "
11209 "used to notify events which happen to objects in the guest filesystem."
11214 #: ../src/guestfs-actions.pod:2434
11216 "C<maxevents> is the maximum number of events which will be queued up between "
11217 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11218 "passed as C<0>, then the kernel (or previously set) default is used. For "
11219 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11220 "throws away events, but records the fact that it threw them away by setting "
11221 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11222 "C<guestfs_inotify_read>)."
11227 #: ../src/guestfs-actions.pod:2444
11229 "Before any events are generated, you have to add some watches to the "
11230 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11231 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11236 #: ../src/guestfs-actions.pod:2450
11238 "Queued up events should be read periodically by calling "
11239 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11240 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11241 "often enough then you risk the internal queue overflowing."
11246 #: ../src/guestfs-actions.pod:2457
11248 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11249 "This also removes any watches automatically."
11254 #: ../src/guestfs-actions.pod:2461 ../fish/guestfish-actions.pod:1657
11256 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11257 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11258 "that there is one global inotify handle per libguestfs instance."
11263 #: ../src/guestfs-actions.pod:2470
11264 msgid "guestfs_inotify_read"
11269 #: ../src/guestfs-actions.pod:2472
11272 " struct guestfs_inotify_event_list *\n"
11273 " guestfs_inotify_read (guestfs_h *g);\n"
11279 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1666
11281 "Return the complete queue of events that have happened since the previous "
11287 #: ../src/guestfs-actions.pod:2478 ../fish/guestfish-actions.pod:1669
11288 msgid "If no events have happened, this returns an empty list."
11293 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1671
11295 "I<Note>: In order to make sure that all events have been read, you must call "
11296 "this function repeatedly until it returns an empty list. The reason is that "
11297 "the call will read events up to the maximum appliance-to-host message size "
11298 "and leave remaining events in the queue."
11303 #: ../src/guestfs-actions.pod:2486
11305 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11306 "there was an error. I<The caller must call "
11307 "C<guestfs_free_inotify_event_list> after use>."
11312 #: ../src/guestfs-actions.pod:2492
11313 msgid "guestfs_inotify_rm_watch"
11318 #: ../src/guestfs-actions.pod:2494
11322 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11329 #: ../src/guestfs-actions.pod:2498
11331 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11336 #: ../src/guestfs-actions.pod:2505
11337 msgid "guestfs_inspect_get_arch"
11342 #: ../src/guestfs-actions.pod:2507
11346 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11347 " const char *root);\n"
11353 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:2534
11354 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2641
11355 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2702
11356 #: ../src/guestfs-actions.pod:2729 ../src/guestfs-actions.pod:2750
11357 #: ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2816
11358 #: ../src/guestfs-actions.pod:2847 ../src/guestfs-actions.pod:2871
11359 #: ../src/guestfs-actions.pod:2926 ../src/guestfs-actions.pod:2968
11360 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3008
11361 #: ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3044
11363 "This function should only be called with a root device string as returned by "
11364 "C<guestfs_inspect_os>."
11369 #: ../src/guestfs-actions.pod:2514
11371 "This returns the architecture of the inspected operating system. The "
11372 "possible return values are listed under C<guestfs_file_architecture>."
11377 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1695
11379 "If the architecture could not be determined, then the string C<unknown> is "
11385 #: ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2602
11386 #: ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2689
11387 #: ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2803
11388 #: ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2858
11389 #: ../src/guestfs-actions.pod:2912 ../src/guestfs-actions.pod:2955
11390 #: ../src/guestfs-actions.pod:2978 ../src/guestfs-actions.pod:2998
11391 #: ../src/guestfs-actions.pod:3015 ../src/guestfs-actions.pod:3034
11392 #: ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3178
11393 #: ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1772
11394 #: ../fish/guestfish-actions.pod:1824 ../fish/guestfish-actions.pod:1839
11395 #: ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:1924
11396 #: ../fish/guestfish-actions.pod:1948 ../fish/guestfish-actions.pod:1965
11397 #: ../fish/guestfish-actions.pod:2008 ../fish/guestfish-actions.pod:2043
11398 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2072
11399 #: ../fish/guestfish-actions.pod:2085 ../fish/guestfish-actions.pod:2100
11400 #: ../fish/guestfish-actions.pod:2199 ../fish/guestfish-actions.pod:2233
11401 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11406 #: ../src/guestfs-actions.pod:2528
11407 msgid "guestfs_inspect_get_distro"
11412 #: ../src/guestfs-actions.pod:2530
11416 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11417 " const char *root);\n"
11423 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1707
11425 "This returns the distro (distribution) of the inspected operating system."
11430 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1710
11431 msgid "Currently defined distros are:"
11436 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1714
11437 msgid "\"archlinux\""
11442 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1716
11443 msgid "Arch Linux."
11448 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1718
11454 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1720
11460 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1722
11466 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1724
11472 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1726
11478 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1728
11484 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1730
11485 msgid "\"linuxmint\""
11490 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1732
11491 msgid "Linux Mint."
11496 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1734
11497 msgid "\"mandriva\""
11502 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1736
11508 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1738
11514 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1740
11520 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1742
11526 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1744
11532 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1746
11533 msgid "\"redhat-based\""
11538 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1748
11539 msgid "Some Red Hat-derived distro."
11544 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1750
11550 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1752
11551 msgid "Red Hat Enterprise Linux and some derivatives."
11556 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1754
11562 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1756
11568 #: ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:2660
11569 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:1758
11570 #: ../fish/guestfish-actions.pod:1815 ../fish/guestfish-actions.pod:2034
11571 msgid "\"unknown\""
11576 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1760
11577 msgid "The distro could not be determined."
11582 #: ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:2938
11583 #: ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:2026
11584 msgid "\"windows\""
11589 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1764
11591 "Windows does not have distributions. This string is returned if the OS type "
11597 #: ../src/guestfs-actions.pod:2599 ../src/guestfs-actions.pod:2666
11598 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:1769
11599 #: ../fish/guestfish-actions.pod:1821 ../fish/guestfish-actions.pod:2040
11601 "Future versions of libguestfs may return other strings here. The caller "
11602 "should be prepared to handle any string."
11607 #: ../src/guestfs-actions.pod:2609
11608 msgid "guestfs_inspect_get_filesystems"
11613 #: ../src/guestfs-actions.pod:2611
11617 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11618 " const char *root);\n"
11624 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1781
11626 "This returns a list of all the filesystems that we think are associated with "
11627 "this operating system. This includes the root filesystem, other ordinary "
11628 "filesystems, and non-mounted devices like swap partitions."
11633 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
11635 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11636 "to be shared between operating systems."
11641 #: ../src/guestfs-actions.pod:2626
11643 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11644 "C<guestfs_inspect_get_mountpoints>."
11648 #: ../src/guestfs-actions.pod:2635
11649 msgid "guestfs_inspect_get_format"
11653 #: ../src/guestfs-actions.pod:2637
11657 " guestfs_inspect_get_format (guestfs_h *g,\n"
11658 " const char *root);\n"
11663 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1799
11665 "This returns the format of the inspected operating system. You can use it "
11666 "to detect install images, live CDs and similar."
11670 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1802
11671 msgid "Currently defined formats are:"
11675 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1806
11676 msgid "\"installed\""
11680 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
11681 msgid "This is an installed operating system."
11685 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1810
11686 msgid "\"installer\""
11690 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1812
11692 "The disk image being inspected is not an installed operating system, but a "
11693 "I<bootable> install disk, live CD, or similar."
11697 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1817
11698 msgid "The format of this disk image is not known."
11703 #: ../src/guestfs-actions.pod:2674
11704 msgid "guestfs_inspect_get_hostname"
11709 #: ../src/guestfs-actions.pod:2676
11713 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11714 " const char *root);\n"
11720 #: ../src/guestfs-actions.pod:2683 ../fish/guestfish-actions.pod:1833
11722 "This function returns the hostname of the operating system as found by "
11723 "inspection of the guest's configuration files."
11728 #: ../src/guestfs-actions.pod:2686 ../fish/guestfish-actions.pod:1836
11730 "If the hostname could not be determined, then the string C<unknown> is "
11736 #: ../src/guestfs-actions.pod:2694
11737 msgid "(Added in 1.7.9)"
11742 #: ../src/guestfs-actions.pod:2696
11743 msgid "guestfs_inspect_get_major_version"
11748 #: ../src/guestfs-actions.pod:2698
11752 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11753 " const char *root);\n"
11759 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1848
11761 "This returns the major version number of the inspected operating system."
11766 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1851
11768 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11769 "popular public names used by the operating system. Notably the operating "
11770 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11771 "1). You can find out the real versions corresponding to releases of Windows "
11772 "by consulting Wikipedia or MSDN."
11777 #: ../src/guestfs-actions.pod:2715 ../src/guestfs-actions.pod:2735
11778 #: ../fish/guestfish-actions.pod:1858 ../fish/guestfish-actions.pod:1872
11779 msgid "If the version could not be determined, then C<0> is returned."
11784 #: ../src/guestfs-actions.pod:2723
11785 msgid "guestfs_inspect_get_minor_version"
11790 #: ../src/guestfs-actions.pod:2725
11794 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11795 " const char *root);\n"
11801 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1869
11803 "This returns the minor version number of the inspected operating system."
11808 #: ../src/guestfs-actions.pod:2737
11810 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11811 "C<guestfs_inspect_get_major_version>."
11816 #: ../src/guestfs-actions.pod:2744
11817 msgid "guestfs_inspect_get_mountpoints"
11822 #: ../src/guestfs-actions.pod:2746
11826 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11827 " const char *root);\n"
11832 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1884
11834 "This returns a hash of where we think the filesystems associated with this "
11835 "operating system should be mounted. Callers should note that this is at "
11836 "best an educated guess made by reading configuration files such as C</etc/"
11837 "fstab>. I<In particular note> that this may return filesystems which are "
11838 "non-existent or not mountable and callers should be prepared to handle or "
11839 "ignore failures if they try to mount them."
11844 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1893
11846 "Each element in the returned hashtable has a key which is the path of the "
11847 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11848 "mounted there (eg. C</dev/sda1>)."
11853 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1898
11855 "Non-mounted devices such as swap devices are I<not> returned in this list."
11860 #: ../src/guestfs-actions.pod:2770
11862 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11863 "C<guestfs_inspect_get_filesystems>."
11868 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:3507
11869 #: ../src/guestfs-actions.pod:4717 ../src/guestfs-actions.pod:6622
11871 "This function returns a NULL-terminated array of strings, or NULL if there "
11872 "was an error. The array of strings will always have length C<2n+1>, where "
11873 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11874 "caller must free the strings and the array after use>."
11879 #: ../src/guestfs-actions.pod:2781
11880 msgid "guestfs_inspect_get_package_format"
11885 #: ../src/guestfs-actions.pod:2783
11889 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11890 " const char *root);\n"
11896 #: ../src/guestfs-actions.pod:2790
11898 "This function and C<guestfs_inspect_get_package_management> return the "
11899 "package format and package management tool used by the inspected operating "
11900 "system. For example for Fedora these functions would return C<rpm> (package "
11901 "format) and C<yum> (package management)."
11906 #: ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1917
11908 "This returns the string C<unknown> if we could not determine the package "
11909 "format I<or> if the operating system does not have a real packaging system "
11915 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1921
11917 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11918 "Future versions of libguestfs may return other strings."
11923 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2839
11924 msgid "(Added in 1.7.5)"
11929 #: ../src/guestfs-actions.pod:2810
11930 msgid "guestfs_inspect_get_package_management"
11935 #: ../src/guestfs-actions.pod:2812
11939 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11940 " const char *root);\n"
11946 #: ../src/guestfs-actions.pod:2819
11948 "C<guestfs_inspect_get_package_format> and this function return the package "
11949 "format and package management tool used by the inspected operating system. "
11950 "For example for Fedora these functions would return C<rpm> (package format) "
11951 "and C<yum> (package management)."
11956 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1939
11958 "This returns the string C<unknown> if we could not determine the package "
11959 "management tool I<or> if the operating system does not have a real packaging "
11960 "system (eg. Windows)."
11965 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1943
11967 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11968 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11969 "libguestfs may return other strings."
11974 #: ../src/guestfs-actions.pod:2841
11975 msgid "guestfs_inspect_get_product_name"
11980 #: ../src/guestfs-actions.pod:2843
11984 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11985 " const char *root);\n"
11991 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1957
11993 "This returns the product name of the inspected operating system. The "
11994 "product name is generally some freeform string which can be displayed to the "
11995 "user, but should not be parsed by programs."
12000 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1962
12002 "If the product name could not be determined, then the string C<unknown> is "
12007 #: ../src/guestfs-actions.pod:2865
12008 msgid "guestfs_inspect_get_product_variant"
12012 #: ../src/guestfs-actions.pod:2867
12016 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12017 " const char *root);\n"
12022 #: ../src/guestfs-actions.pod:2874 ../fish/guestfish-actions.pod:1974
12023 msgid "This returns the product variant of the inspected operating system."
12027 #: ../src/guestfs-actions.pod:2877 ../fish/guestfish-actions.pod:1977
12029 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12030 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12031 "is usually a string such as C<Client> or C<Server> (other values are "
12032 "possible). This can be used to distinguish consumer and enterprise versions "
12033 "of Windows that have the same version number (for example, Windows 7 and "
12034 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12035 "the latter is C<Server>)."
12039 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1986
12041 "For enterprise Linux guests, in future we intend this to return the product "
12042 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12043 "implemented at present."
12047 #: ../src/guestfs-actions.pod:2890 ../fish/guestfish-actions.pod:1990
12049 "If the product variant could not be determined, then the string C<unknown> "
12054 #: ../src/guestfs-actions.pod:2893
12056 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12057 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12062 #: ../src/guestfs-actions.pod:2900
12063 msgid "guestfs_inspect_get_roots"
12068 #: ../src/guestfs-actions.pod:2902
12072 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12078 #: ../src/guestfs-actions.pod:2905
12080 "This function is a convenient way to get the list of root devices, as "
12081 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12082 "the whole inspection process."
12087 #: ../src/guestfs-actions.pod:2909
12089 "This returns an empty list if either no root devices were found or the "
12090 "caller has not called C<guestfs_inspect_os>."
12095 #: ../src/guestfs-actions.pod:2918
12096 msgid "(Added in 1.7.3)"
12101 #: ../src/guestfs-actions.pod:2920
12102 msgid "guestfs_inspect_get_type"
12107 #: ../src/guestfs-actions.pod:2922
12111 " guestfs_inspect_get_type (guestfs_h *g,\n"
12112 " const char *root);\n"
12118 #: ../src/guestfs-actions.pod:2929 ../fish/guestfish-actions.pod:2017
12120 "This returns the type of the inspected operating system. Currently defined "
12126 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2022
12132 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2024
12133 msgid "Any Linux-based operating system."
12138 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2028
12139 msgid "Any Microsoft Windows operating system."
12144 #: ../src/guestfs-actions.pod:2942 ../fish/guestfish-actions.pod:2030
12145 msgid "\"freebsd\""
12150 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2032
12156 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2036
12157 msgid "The operating system type could not be determined."
12162 #: ../src/guestfs-actions.pod:2962
12163 msgid "guestfs_inspect_get_windows_systemroot"
12168 #: ../src/guestfs-actions.pod:2964
12172 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12173 " const char *root);\n"
12179 #: ../src/guestfs-actions.pod:2971 ../fish/guestfish-actions.pod:2052
12181 "This returns the Windows systemroot of the inspected guest. The systemroot "
12182 "is a directory path such as C</WINDOWS>."
12187 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2055
12189 "This call assumes that the guest is Windows and that the systemroot could be "
12190 "determined by inspection. If this is not the case then an error is returned."
12195 #: ../src/guestfs-actions.pod:2983
12196 msgid "(Added in 1.5.25)"
12200 #: ../src/guestfs-actions.pod:2985
12201 msgid "guestfs_inspect_is_live"
12205 #: ../src/guestfs-actions.pod:2987
12209 " guestfs_inspect_is_live (guestfs_h *g,\n"
12210 " const char *root);\n"
12215 #: ../src/guestfs-actions.pod:2994
12217 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12218 "disk), then this returns true if a live image was detected on the disk."
12222 #: ../src/guestfs-actions.pod:3002
12223 msgid "guestfs_inspect_is_multipart"
12227 #: ../src/guestfs-actions.pod:3004
12231 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12232 " const char *root);\n"
12237 #: ../src/guestfs-actions.pod:3011
12239 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12240 "disk), then this returns true if the disk is part of a set."
12244 #: ../src/guestfs-actions.pod:3019
12245 msgid "guestfs_inspect_is_netinst"
12249 #: ../src/guestfs-actions.pod:3021
12253 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12254 " const char *root);\n"
12259 #: ../src/guestfs-actions.pod:3028
12261 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12262 "disk), then this returns true if the disk is a network installer, ie. not a "
12263 "self-contained install CD but one which is likely to require network access "
12264 "to complete the install."
12269 #: ../src/guestfs-actions.pod:3038
12270 msgid "guestfs_inspect_list_applications"
12275 #: ../src/guestfs-actions.pod:3040
12278 " struct guestfs_application_list *\n"
12279 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12280 " const char *root);\n"
12286 #: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2109
12287 msgid "Return the list of applications installed in the operating system."
12292 #: ../src/guestfs-actions.pod:3049
12294 "I<Note:> This call works differently from other parts of the inspection "
12295 "API. You have to call C<guestfs_inspect_os>, then "
12296 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12297 "this. Listing applications is a significantly more difficult operation "
12298 "which requires access to the full filesystem. Also note that unlike the "
12299 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12300 "the libguestfs handle, this call actually reads parts of the mounted "
12301 "filesystems during the call."
12306 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2121
12308 "This returns an empty list if the inspection code was not able to determine "
12309 "the list of applications."
12314 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2124
12315 msgid "The application structure contains the following fields:"
12320 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2128
12321 msgid "C<app_name>"
12326 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2130
12328 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12329 "guests, this is the package name."
12334 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2133
12335 msgid "C<app_display_name>"
12340 #: ../src/guestfs-actions.pod:3073 ../fish/guestfish-actions.pod:2135
12342 "The display name of the application, sometimes localized to the install "
12343 "language of the guest operating system."
12348 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2138
12350 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12351 "to display something can use C<app_name> instead."
12356 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2141
12357 msgid "C<app_epoch>"
12362 #: ../src/guestfs-actions.pod:3081 ../fish/guestfish-actions.pod:2143
12364 "For package managers which use epochs, this contains the epoch of the "
12365 "package (an integer). If unavailable, this is returned as C<0>."
12370 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2146
12371 msgid "C<app_version>"
12376 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2148
12378 "The version string of the application or package. If unavailable this is "
12379 "returned as an empty string C<\"\">."
12384 #: ../src/guestfs-actions.pod:3089 ../fish/guestfish-actions.pod:2151
12385 msgid "C<app_release>"
12390 #: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2153
12392 "The release string of the application or package, for package managers that "
12393 "use this. If unavailable this is returned as an empty string C<\"\">."
12398 #: ../src/guestfs-actions.pod:3095 ../fish/guestfish-actions.pod:2157
12399 msgid "C<app_install_path>"
12404 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2159
12406 "The installation path of the application (on operating systems such as "
12407 "Windows which use installation paths). This path is in the format used by "
12408 "the guest operating system, it is not a libguestfs path."
12413 #: ../src/guestfs-actions.pod:3102 ../fish/guestfish-actions.pod:2164
12414 msgid "If unavailable this is returned as an empty string C<\"\">."
12419 #: ../src/guestfs-actions.pod:3104 ../fish/guestfish-actions.pod:2166
12420 msgid "C<app_trans_path>"
12425 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2168
12427 "The install path translated into a libguestfs path. If unavailable this is "
12428 "returned as an empty string C<\"\">."
12433 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2171
12434 msgid "C<app_publisher>"
12439 #: ../src/guestfs-actions.pod:3111 ../fish/guestfish-actions.pod:2173
12441 "The name of the publisher of the application, for package managers that use "
12442 "this. If unavailable this is returned as an empty string C<\"\">."
12447 #: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2177
12453 #: ../src/guestfs-actions.pod:3117 ../fish/guestfish-actions.pod:2179
12455 "The URL (eg. upstream URL) of the application. If unavailable this is "
12456 "returned as an empty string C<\"\">."
12461 #: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2182
12462 msgid "C<app_source_package>"
12467 #: ../src/guestfs-actions.pod:3122 ../fish/guestfish-actions.pod:2184
12469 "For packaging systems which support this, the name of the source package. "
12470 "If unavailable this is returned as an empty string C<\"\">."
12475 #: ../src/guestfs-actions.pod:3125 ../fish/guestfish-actions.pod:2187
12476 msgid "C<app_summary>"
12481 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2189
12483 "A short (usually one line) description of the application or package. If "
12484 "unavailable this is returned as an empty string C<\"\">."
12489 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2192
12490 msgid "C<app_description>"
12495 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2194
12497 "A longer description of the application or package. If unavailable this is "
12498 "returned as an empty string C<\"\">."
12503 #: ../src/guestfs-actions.pod:3139
12505 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12506 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12512 #: ../src/guestfs-actions.pod:3143
12513 msgid "(Added in 1.7.8)"
12518 #: ../src/guestfs-actions.pod:3145
12519 msgid "guestfs_inspect_os"
12524 #: ../src/guestfs-actions.pod:3147
12528 " guestfs_inspect_os (guestfs_h *g);\n"
12534 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2205
12536 "This function uses other libguestfs functions and certain heuristics to "
12537 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12538 "for operating systems."
12543 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2209
12544 msgid "The list returned is empty if no operating systems were found."
12549 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2211
12551 "If one operating system was found, then this returns a list with a single "
12552 "element, which is the name of the root filesystem of this operating system. "
12553 "It is also possible for this function to return a list containing more than "
12554 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12555 "element being the root filesystem of one of the operating systems."
12560 #: ../src/guestfs-actions.pod:3163
12562 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12563 "functions in order to query further information about each operating system, "
12564 "such as the name and version."
12569 #: ../src/guestfs-actions.pod:3168
12571 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12572 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12573 "the contents. This should be called with no disks currently mounted. The "
12574 "function may also use Augeas, so any existing Augeas handle will be closed."
12579 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2229
12581 "This function cannot decrypt encrypted disks. The caller must do that first "
12582 "(supplying the necessary keys) if the disk is encrypted."
12587 #: ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3465
12588 #: ../src/guestfs-actions.pod:3527
12589 msgid "See also C<guestfs_list_filesystems>."
12594 #: ../src/guestfs-actions.pod:3188
12595 msgid "guestfs_is_blockdev"
12600 #: ../src/guestfs-actions.pod:3190
12604 " guestfs_is_blockdev (guestfs_h *g,\n"
12605 " const char *path);\n"
12611 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2241
12613 "This returns C<true> if and only if there is a block device with the given "
12619 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3226
12620 #: ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3271
12621 #: ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3343
12622 #: ../src/guestfs-actions.pod:3358
12623 msgid "See also C<guestfs_stat>."
12628 #: ../src/guestfs-actions.pod:3201 ../src/guestfs-actions.pod:3230
12629 #: ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3347
12630 #: ../src/guestfs-actions.pod:3362
12631 msgid "(Added in 1.5.10)"
12636 #: ../src/guestfs-actions.pod:3203
12637 msgid "guestfs_is_busy"
12642 #: ../src/guestfs-actions.pod:3205
12646 " guestfs_is_busy (guestfs_h *g);\n"
12652 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2250
12654 "This returns true iff this handle is busy processing a command (in the "
12660 #: ../src/guestfs-actions.pod:3217
12661 msgid "guestfs_is_chardev"
12666 #: ../src/guestfs-actions.pod:3219
12670 " guestfs_is_chardev (guestfs_h *g,\n"
12671 " const char *path);\n"
12677 #: ../src/guestfs-actions.pod:3223 ../fish/guestfish-actions.pod:2259
12679 "This returns C<true> if and only if there is a character device with the "
12680 "given C<path> name."
12685 #: ../src/guestfs-actions.pod:3232
12686 msgid "guestfs_is_config"
12691 #: ../src/guestfs-actions.pod:3234
12695 " guestfs_is_config (guestfs_h *g);\n"
12701 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2268
12703 "This returns true iff this handle is being configured (in the C<CONFIG> "
12709 #: ../src/guestfs-actions.pod:3246
12710 msgid "guestfs_is_dir"
12715 #: ../src/guestfs-actions.pod:3248
12719 " guestfs_is_dir (guestfs_h *g,\n"
12720 " const char *path);\n"
12726 #: ../src/guestfs-actions.pod:3252 ../fish/guestfish-actions.pod:2277
12728 "This returns C<true> if and only if there is a directory with the given "
12729 "C<path> name. Note that it returns false for other objects like files."
12734 #: ../src/guestfs-actions.pod:3262
12735 msgid "guestfs_is_fifo"
12740 #: ../src/guestfs-actions.pod:3264
12744 " guestfs_is_fifo (guestfs_h *g,\n"
12745 " const char *path);\n"
12751 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2287
12753 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12754 "given C<path> name."
12759 #: ../src/guestfs-actions.pod:3277
12760 msgid "guestfs_is_file"
12765 #: ../src/guestfs-actions.pod:3279
12769 " guestfs_is_file (guestfs_h *g,\n"
12770 " const char *path);\n"
12776 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2296
12778 "This returns C<true> if and only if there is a regular file with the given "
12779 "C<path> name. Note that it returns false for other objects like directories."
12784 #: ../src/guestfs-actions.pod:3293
12785 msgid "guestfs_is_launching"
12790 #: ../src/guestfs-actions.pod:3295
12794 " guestfs_is_launching (guestfs_h *g);\n"
12800 #: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:2306
12802 "This returns true iff this handle is launching the subprocess (in the "
12803 "C<LAUNCHING> state)."
12808 #: ../src/guestfs-actions.pod:3307
12809 msgid "guestfs_is_lv"
12814 #: ../src/guestfs-actions.pod:3309
12818 " guestfs_is_lv (guestfs_h *g,\n"
12819 " const char *device);\n"
12825 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2315
12827 "This command tests whether C<device> is a logical volume, and returns true "
12828 "iff this is the case."
12833 #: ../src/guestfs-actions.pod:3320
12834 msgid "guestfs_is_ready"
12839 #: ../src/guestfs-actions.pod:3322
12843 " guestfs_is_ready (guestfs_h *g);\n"
12849 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2322
12851 "This returns true iff this handle is ready to accept commands (in the "
12857 #: ../src/guestfs-actions.pod:3334
12858 msgid "guestfs_is_socket"
12863 #: ../src/guestfs-actions.pod:3336
12867 " guestfs_is_socket (guestfs_h *g,\n"
12868 " const char *path);\n"
12874 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2331
12876 "This returns C<true> if and only if there is a Unix domain socket with the "
12877 "given C<path> name."
12882 #: ../src/guestfs-actions.pod:3349
12883 msgid "guestfs_is_symlink"
12888 #: ../src/guestfs-actions.pod:3351
12892 " guestfs_is_symlink (guestfs_h *g,\n"
12893 " const char *path);\n"
12899 #: ../src/guestfs-actions.pod:3355 ../fish/guestfish-actions.pod:2340
12901 "This returns C<true> if and only if there is a symbolic link with the given "
12907 #: ../src/guestfs-actions.pod:3364
12908 msgid "guestfs_kill_subprocess"
12913 #: ../src/guestfs-actions.pod:3366
12917 " guestfs_kill_subprocess (guestfs_h *g);\n"
12923 #: ../src/guestfs-actions.pod:3369 ../fish/guestfish-actions.pod:2349
12924 msgid "This kills the qemu subprocess. You should never need to call this."
12929 #: ../src/guestfs-actions.pod:3375
12930 msgid "guestfs_launch"
12935 #: ../src/guestfs-actions.pod:3377
12939 " guestfs_launch (guestfs_h *g);\n"
12945 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2357
12947 "Internally libguestfs is implemented by running a virtual machine using "
12953 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2360
12955 "You should call this after configuring the handle (eg. adding drives) but "
12956 "before performing any actions."
12961 #: ../src/guestfs-actions.pod:3390
12962 msgid "guestfs_lchown"
12967 #: ../src/guestfs-actions.pod:3392
12971 " guestfs_lchown (guestfs_h *g,\n"
12974 " const char *path);\n"
12980 #: ../src/guestfs-actions.pod:3398
12982 "Change the file owner to C<owner> and group to C<group>. This is like "
12983 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12984 "changed, not the target."
12989 #: ../src/guestfs-actions.pod:3410
12990 msgid "guestfs_lgetxattr"
12995 #: ../src/guestfs-actions.pod:3412
12999 " guestfs_lgetxattr (guestfs_h *g,\n"
13000 " const char *path,\n"
13001 " const char *name,\n"
13002 " size_t *size_r);\n"
13008 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2379
13010 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13011 "is a symlink, then this call returns an extended attribute from the symlink."
13016 #: ../src/guestfs-actions.pod:3432
13017 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13022 #: ../src/guestfs-actions.pod:3440
13023 msgid "guestfs_lgetxattrs"
13028 #: ../src/guestfs-actions.pod:3442
13031 " struct guestfs_xattr_list *\n"
13032 " guestfs_lgetxattrs (guestfs_h *g,\n"
13033 " const char *path);\n"
13039 #: ../src/guestfs-actions.pod:3446
13041 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13042 "then it returns the extended attributes of the link itself."
13047 #: ../src/guestfs-actions.pod:3456
13048 msgid "guestfs_list_devices"
13053 #: ../src/guestfs-actions.pod:3458
13057 " guestfs_list_devices (guestfs_h *g);\n"
13063 #: ../src/guestfs-actions.pod:3461 ../fish/guestfish-actions.pod:2407
13064 msgid "List all the block devices."
13069 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2409
13070 msgid "The full block device names are returned, eg. C</dev/sda>."
13075 #: ../src/guestfs-actions.pod:3473
13076 msgid "guestfs_list_filesystems"
13081 #: ../src/guestfs-actions.pod:3475
13085 " guestfs_list_filesystems (guestfs_h *g);\n"
13091 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2417
13093 "This inspection command looks for filesystems on partitions, block devices "
13094 "and logical volumes, returning a list of devices containing filesystems and "
13100 #: ../src/guestfs-actions.pod:3482 ../fish/guestfish-actions.pod:2421
13102 "The return value is a hash, where the keys are the devices containing "
13103 "filesystems, and the values are the filesystem types. For example:"
13108 #: ../src/guestfs-actions.pod:3486 ../fish/guestfish-actions.pod:2425
13111 " \"/dev/sda1\" => \"ntfs\"\n"
13112 " \"/dev/sda2\" => \"ext2\"\n"
13113 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13114 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13120 #: ../src/guestfs-actions.pod:3491 ../fish/guestfish-actions.pod:2430
13122 "The value can have the special value \"unknown\", meaning the content of the "
13123 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13128 #: ../src/guestfs-actions.pod:3495
13130 "This command runs other libguestfs commands, which might include "
13131 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13132 "soon after launch and only when nothing is mounted."
13137 #: ../src/guestfs-actions.pod:3499
13139 "Not all of the filesystems returned will be mountable. In particular, swap "
13140 "partitions are returned in the list. Also this command does not check that "
13141 "each filesystem found is valid and mountable, and some filesystems might be "
13142 "mountable but require special options. Filesystems may not all belong to a "
13143 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13148 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:5118
13149 msgid "(Added in 1.5.15)"
13154 #: ../src/guestfs-actions.pod:3515
13155 msgid "guestfs_list_partitions"
13160 #: ../src/guestfs-actions.pod:3517
13164 " guestfs_list_partitions (guestfs_h *g);\n"
13170 #: ../src/guestfs-actions.pod:3520 ../fish/guestfish-actions.pod:2450
13171 msgid "List all the partitions detected on all block devices."
13176 #: ../src/guestfs-actions.pod:3522 ../fish/guestfish-actions.pod:2452
13177 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13182 #: ../src/guestfs-actions.pod:3524
13184 "This does not return logical volumes. For that you will need to call "
13190 #: ../src/guestfs-actions.pod:3535
13196 #: ../src/guestfs-actions.pod:3537
13200 " guestfs_ll (guestfs_h *g,\n"
13201 " const char *directory);\n"
13207 #: ../src/guestfs-actions.pod:3541 ../fish/guestfish-actions.pod:2463
13209 "List the files in C<directory> (relative to the root directory, there is no "
13210 "cwd) in the format of 'ls -la'."
13215 #: ../src/guestfs-actions.pod:3544 ../fish/guestfish-actions.pod:2466
13217 "This command is mostly useful for interactive sessions. It is I<not> "
13218 "intended that you try to parse the output string."
13223 #: ../src/guestfs-actions.pod:3552
13229 #: ../src/guestfs-actions.pod:3554
13233 " guestfs_ln (guestfs_h *g,\n"
13234 " const char *target,\n"
13235 " const char *linkname);\n"
13241 #: ../src/guestfs-actions.pod:3559 ../fish/guestfish-actions.pod:2473
13242 msgid "This command creates a hard link using the C<ln> command."
13247 #: ../src/guestfs-actions.pod:3565
13248 msgid "guestfs_ln_f"
13253 #: ../src/guestfs-actions.pod:3567
13257 " guestfs_ln_f (guestfs_h *g,\n"
13258 " const char *target,\n"
13259 " const char *linkname);\n"
13265 #: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2479
13267 "This command creates a hard link using the C<ln -f> command. The C<-f> "
13268 "option removes the link (C<linkname>) if it exists already."
13273 #: ../src/guestfs-actions.pod:3579
13274 msgid "guestfs_ln_s"
13279 #: ../src/guestfs-actions.pod:3581
13283 " guestfs_ln_s (guestfs_h *g,\n"
13284 " const char *target,\n"
13285 " const char *linkname);\n"
13291 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2486
13292 msgid "This command creates a symbolic link using the C<ln -s> command."
13297 #: ../src/guestfs-actions.pod:3592
13298 msgid "guestfs_ln_sf"
13303 #: ../src/guestfs-actions.pod:3594
13307 " guestfs_ln_sf (guestfs_h *g,\n"
13308 " const char *target,\n"
13309 " const char *linkname);\n"
13315 #: ../src/guestfs-actions.pod:3599 ../fish/guestfish-actions.pod:2492
13317 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
13318 "option removes the link (C<linkname>) if it exists already."
13323 #: ../src/guestfs-actions.pod:3606
13324 msgid "guestfs_lremovexattr"
13329 #: ../src/guestfs-actions.pod:3608
13333 " guestfs_lremovexattr (guestfs_h *g,\n"
13334 " const char *xattr,\n"
13335 " const char *path);\n"
13341 #: ../src/guestfs-actions.pod:3613
13343 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13344 "link, then it removes an extended attribute of the link itself."
13349 #: ../src/guestfs-actions.pod:3621
13355 #: ../src/guestfs-actions.pod:3623
13359 " guestfs_ls (guestfs_h *g,\n"
13360 " const char *directory);\n"
13366 #: ../src/guestfs-actions.pod:3627 ../fish/guestfish-actions.pod:2507
13368 "List the files in C<directory> (relative to the root directory, there is no "
13369 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13374 #: ../src/guestfs-actions.pod:3631
13376 "This command is mostly useful for interactive sessions. Programs should "
13377 "probably use C<guestfs_readdir> instead."
13382 #: ../src/guestfs-actions.pod:3640
13383 msgid "guestfs_lsetxattr"
13388 #: ../src/guestfs-actions.pod:3642
13392 " guestfs_lsetxattr (guestfs_h *g,\n"
13393 " const char *xattr,\n"
13394 " const char *val,\n"
13396 " const char *path);\n"
13402 #: ../src/guestfs-actions.pod:3649
13404 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13405 "then it sets an extended attribute of the link itself."
13410 #: ../src/guestfs-actions.pod:3657
13411 msgid "guestfs_lstat"
13416 #: ../src/guestfs-actions.pod:3659
13419 " struct guestfs_stat *\n"
13420 " guestfs_lstat (guestfs_h *g,\n"
13421 " const char *path);\n"
13427 #: ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:6221
13428 #: ../fish/guestfish-actions.pod:2526 ../fish/guestfish-actions.pod:4195
13429 msgid "Returns file information for the given C<path>."
13434 #: ../src/guestfs-actions.pod:3665
13436 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13437 "link, then the link is stat-ed, not the file it refers to."
13442 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2532
13443 msgid "This is the same as the C<lstat(2)> system call."
13448 #: ../src/guestfs-actions.pod:3671 ../src/guestfs-actions.pod:6225
13450 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13451 "error. I<The caller must call C<guestfs_free_stat> after use>."
13456 #: ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:6229
13457 #: ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6628
13458 msgid "(Added in 0.9.2)"
13463 #: ../src/guestfs-actions.pod:3677
13464 msgid "guestfs_lstatlist"
13469 #: ../src/guestfs-actions.pod:3679
13472 " struct guestfs_stat_list *\n"
13473 " guestfs_lstatlist (guestfs_h *g,\n"
13474 " const char *path,\n"
13475 " char *const *names);\n"
13481 #: ../src/guestfs-actions.pod:3684
13483 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13484 "files, where all files are in the directory C<path>. C<names> is the list "
13485 "of files from this directory."
13490 #: ../src/guestfs-actions.pod:3688 ../fish/guestfish-actions.pod:2542
13492 "On return you get a list of stat structs, with a one-to-one correspondence "
13493 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13494 "then the C<ino> field of that structure is set to C<-1>."
13499 #: ../src/guestfs-actions.pod:3693
13501 "This call is intended for programs that want to efficiently list a directory "
13502 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13503 "for a similarly efficient call for getting extended attributes. Very long "
13504 "directory listings might cause the protocol message size to be exceeded, "
13505 "causing this call to fail. The caller must split up such requests into "
13506 "smaller groups of names."
13511 #: ../src/guestfs-actions.pod:3701
13513 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13514 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13519 #: ../src/guestfs-actions.pod:3707
13520 msgid "guestfs_luks_add_key"
13525 #: ../src/guestfs-actions.pod:3709
13529 " guestfs_luks_add_key (guestfs_h *g,\n"
13530 " const char *device,\n"
13531 " const char *key,\n"
13532 " const char *newkey,\n"
13539 #: ../src/guestfs-actions.pod:3716 ../fish/guestfish-actions.pod:2559
13541 "This command adds a new key on LUKS device C<device>. C<key> is any "
13542 "existing key, and is used to access the device. C<newkey> is the new key to "
13543 "add. C<keyslot> is the key slot that will be replaced."
13548 #: ../src/guestfs-actions.pod:3721
13550 "Note that if C<keyslot> already contains a key, then this command will "
13551 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13556 #: ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3767
13557 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:3810
13558 #: ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3861
13560 "This function takes a key or passphrase parameter which could contain "
13561 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13567 #: ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:3771
13568 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3814
13569 msgid "(Added in 1.5.2)"
13574 #: ../src/guestfs-actions.pod:3733
13575 msgid "guestfs_luks_close"
13580 #: ../src/guestfs-actions.pod:3735
13584 " guestfs_luks_close (guestfs_h *g,\n"
13585 " const char *device);\n"
13591 #: ../src/guestfs-actions.pod:3739
13593 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13594 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13595 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13596 "underlying block device."
13601 #: ../src/guestfs-actions.pod:3747 ../src/guestfs-actions.pod:3846
13602 #: ../src/guestfs-actions.pod:3865 ../src/guestfs-actions.pod:3915
13603 #: ../src/guestfs-actions.pod:3963
13604 msgid "(Added in 1.5.1)"
13609 #: ../src/guestfs-actions.pod:3749
13610 msgid "guestfs_luks_format"
13615 #: ../src/guestfs-actions.pod:3751
13619 " guestfs_luks_format (guestfs_h *g,\n"
13620 " const char *device,\n"
13621 " const char *key,\n"
13628 #: ../src/guestfs-actions.pod:3757 ../fish/guestfish-actions.pod:2585
13630 "This command erases existing data on C<device> and formats the device as a "
13631 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13632 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13637 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3787
13638 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:4869
13639 #: ../src/guestfs-actions.pod:5649 ../src/guestfs-actions.pod:6056
13640 #: ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6105
13641 #: ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:2593
13642 #: ../fish/guestfish-actions.pod:2606 ../fish/guestfish-actions.pod:2690
13643 #: ../fish/guestfish-actions.pod:3264 ../fish/guestfish-actions.pod:3784
13644 #: ../fish/guestfish-actions.pod:4094 ../fish/guestfish-actions.pod:4110
13645 #: ../fish/guestfish-actions.pod:4125 ../fish/guestfish-actions.pod:4840
13647 "B<This command is dangerous. Without careful use you can easily destroy all "
13653 #: ../src/guestfs-actions.pod:3773
13654 msgid "guestfs_luks_format_cipher"
13659 #: ../src/guestfs-actions.pod:3775
13663 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13664 " const char *device,\n"
13665 " const char *key,\n"
13667 " const char *cipher);\n"
13673 #: ../src/guestfs-actions.pod:3782
13675 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13676 "set the C<cipher> used."
13681 #: ../src/guestfs-actions.pod:3796
13682 msgid "guestfs_luks_kill_slot"
13687 #: ../src/guestfs-actions.pod:3798
13691 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13692 " const char *device,\n"
13693 " const char *key,\n"
13700 #: ../src/guestfs-actions.pod:3804 ../fish/guestfish-actions.pod:2613
13702 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13703 "device C<device>. C<key> must be one of the I<other> keys."
13708 #: ../src/guestfs-actions.pod:3816
13709 msgid "guestfs_luks_open"
13714 #: ../src/guestfs-actions.pod:3818
13718 " guestfs_luks_open (guestfs_h *g,\n"
13719 " const char *device,\n"
13720 " const char *key,\n"
13721 " const char *mapname);\n"
13727 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2624
13729 "This command opens a block device which has been encrypted according to the "
13730 "Linux Unified Key Setup (LUKS) standard."
13735 #: ../src/guestfs-actions.pod:3827 ../fish/guestfish-actions.pod:2627
13736 msgid "C<device> is the encrypted block device or partition."
13741 #: ../src/guestfs-actions.pod:3829 ../fish/guestfish-actions.pod:2629
13743 "The caller must supply one of the keys associated with the LUKS block "
13744 "device, in the C<key> parameter."
13749 #: ../src/guestfs-actions.pod:3832 ../fish/guestfish-actions.pod:2632
13751 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13752 "writes to this block device are decrypted from and encrypted to the "
13753 "underlying C<device> respectively."
13758 #: ../src/guestfs-actions.pod:3836
13760 "If this block device contains LVM volume groups, then calling "
13761 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13767 #: ../src/guestfs-actions.pod:3848
13768 msgid "guestfs_luks_open_ro"
13773 #: ../src/guestfs-actions.pod:3850
13777 " guestfs_luks_open_ro (guestfs_h *g,\n"
13778 " const char *device,\n"
13779 " const char *key,\n"
13780 " const char *mapname);\n"
13786 #: ../src/guestfs-actions.pod:3856
13788 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13794 #: ../src/guestfs-actions.pod:3867
13795 msgid "guestfs_lvcreate"
13800 #: ../src/guestfs-actions.pod:3869
13804 " guestfs_lvcreate (guestfs_h *g,\n"
13805 " const char *logvol,\n"
13806 " const char *volgroup,\n"
13813 #: ../src/guestfs-actions.pod:3875 ../fish/guestfish-actions.pod:2657
13815 "This creates an LVM logical volume called C<logvol> on the volume group "
13816 "C<volgroup>, with C<size> megabytes."
13821 #: ../src/guestfs-actions.pod:3882
13822 msgid "guestfs_lvm_canonical_lv_name"
13827 #: ../src/guestfs-actions.pod:3884
13831 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13832 " const char *lvname);\n"
13838 #: ../src/guestfs-actions.pod:3888 ../fish/guestfish-actions.pod:2664
13840 "This converts alternative naming schemes for LVs that you might find to the "
13841 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13847 #: ../src/guestfs-actions.pod:3892 ../fish/guestfish-actions.pod:2668
13849 "This command returns an error if the C<lvname> parameter does not refer to a "
13855 #: ../src/guestfs-actions.pod:3895
13856 msgid "See also C<guestfs_is_lv>."
13861 #: ../src/guestfs-actions.pod:3900
13862 msgid "(Added in 1.5.24)"
13867 #: ../src/guestfs-actions.pod:3902
13868 msgid "guestfs_lvm_clear_filter"
13873 #: ../src/guestfs-actions.pod:3904
13877 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13883 #: ../src/guestfs-actions.pod:3907
13885 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13886 "see every block device."
13891 #: ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3952
13892 #: ../fish/guestfish-actions.pod:2680 ../fish/guestfish-actions.pod:2711
13894 "This command also clears the LVM cache and performs a volume group scan."
13899 #: ../src/guestfs-actions.pod:3917
13900 msgid "guestfs_lvm_remove_all"
13905 #: ../src/guestfs-actions.pod:3919
13909 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13915 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2687
13917 "This command removes all LVM logical volumes, volume groups and physical "
13923 #: ../src/guestfs-actions.pod:3932
13924 msgid "guestfs_lvm_set_filter"
13929 #: ../src/guestfs-actions.pod:3934
13933 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13934 " char *const *devices);\n"
13940 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2697
13942 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13943 "block devices in the list C<devices>, and will ignore all other attached "
13949 #: ../src/guestfs-actions.pod:3942 ../fish/guestfish-actions.pod:2701
13951 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13952 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13953 "there are two types of duplication possible: either cloned PVs/VGs which "
13954 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13955 "same name. In normal operation you cannot create this situation, but you "
13956 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13957 "inside the LVM metadata."
13962 #: ../src/guestfs-actions.pod:3955 ../fish/guestfish-actions.pod:2714
13963 msgid "You can filter whole block devices or individual partitions."
13968 #: ../src/guestfs-actions.pod:3957 ../fish/guestfish-actions.pod:2716
13970 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13971 "filesystem), even if you are not filtering out that VG."
13976 #: ../src/guestfs-actions.pod:3965
13977 msgid "guestfs_lvremove"
13982 #: ../src/guestfs-actions.pod:3967
13986 " guestfs_lvremove (guestfs_h *g,\n"
13987 " const char *device);\n"
13993 #: ../src/guestfs-actions.pod:3971 ../fish/guestfish-actions.pod:2724
13995 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13996 "LV, such as C</dev/VG/LV>."
14001 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:2727
14003 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14009 #: ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:5215
14010 #: ../src/guestfs-actions.pod:7004
14011 msgid "(Added in 1.0.13)"
14016 #: ../src/guestfs-actions.pod:3981
14017 msgid "guestfs_lvrename"
14022 #: ../src/guestfs-actions.pod:3983
14026 " guestfs_lvrename (guestfs_h *g,\n"
14027 " const char *logvol,\n"
14028 " const char *newlogvol);\n"
14034 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2734
14035 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14040 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:7017
14041 msgid "(Added in 1.0.83)"
14046 #: ../src/guestfs-actions.pod:3994
14047 msgid "guestfs_lvresize"
14052 #: ../src/guestfs-actions.pod:3996
14056 " guestfs_lvresize (guestfs_h *g,\n"
14057 " const char *device,\n"
14064 #: ../src/guestfs-actions.pod:4001 ../fish/guestfish-actions.pod:2740
14066 "This resizes (expands or shrinks) an existing LVM logical volume to "
14067 "C<mbytes>. When reducing, data in the reduced part is lost."
14072 #: ../src/guestfs-actions.pod:4009
14073 msgid "guestfs_lvresize_free"
14078 #: ../src/guestfs-actions.pod:4011
14082 " guestfs_lvresize_free (guestfs_h *g,\n"
14083 " const char *lv,\n"
14090 #: ../src/guestfs-actions.pod:4016 ../fish/guestfish-actions.pod:2748
14092 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14093 "remaining free space in the volume group. Commonly you would call this with "
14094 "pc = 100 which expands the logical volume as much as possible, using all "
14095 "remaining free space in the volume group."
14100 #: ../src/guestfs-actions.pod:4024
14101 msgid "(Added in 1.3.3)"
14106 #: ../src/guestfs-actions.pod:4026
14107 msgid "guestfs_lvs"
14112 #: ../src/guestfs-actions.pod:4028
14116 " guestfs_lvs (guestfs_h *g);\n"
14122 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2758
14124 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14130 #: ../src/guestfs-actions.pod:4034 ../fish/guestfish-actions.pod:2761
14132 "This returns a list of the logical volume device names (eg. C</dev/"
14133 "VolGroup00/LogVol00>)."
14138 #: ../src/guestfs-actions.pod:4037
14139 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14144 #: ../src/guestfs-actions.pod:4045
14145 msgid "guestfs_lvs_full"
14150 #: ../src/guestfs-actions.pod:4047
14153 " struct guestfs_lvm_lv_list *\n"
14154 " guestfs_lvs_full (guestfs_h *g);\n"
14160 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2770
14162 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14163 "(8)> command. The \"full\" version includes all fields."
14168 #: ../src/guestfs-actions.pod:4053
14170 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14171 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14176 #: ../src/guestfs-actions.pod:4059
14177 msgid "guestfs_lvuuid"
14182 #: ../src/guestfs-actions.pod:4061
14186 " guestfs_lvuuid (guestfs_h *g,\n"
14187 " const char *device);\n"
14193 #: ../src/guestfs-actions.pod:4065 ../fish/guestfish-actions.pod:2777
14194 msgid "This command returns the UUID of the LVM LV C<device>."
14199 #: ../src/guestfs-actions.pod:4072
14200 msgid "guestfs_lxattrlist"
14205 #: ../src/guestfs-actions.pod:4074
14208 " struct guestfs_xattr_list *\n"
14209 " guestfs_lxattrlist (guestfs_h *g,\n"
14210 " const char *path,\n"
14211 " char *const *names);\n"
14217 #: ../src/guestfs-actions.pod:4079 ../fish/guestfish-actions.pod:2783
14219 "This call allows you to get the extended attributes of multiple files, where "
14220 "all files are in the directory C<path>. C<names> is the list of files from "
14226 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2787
14228 "On return you get a flat list of xattr structs which must be interpreted "
14229 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14230 "C<attrval> in this struct is zero-length to indicate there was an error "
14231 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14232 "number (the number of following attributes for this file, which could be C<"
14233 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14234 "for the first named file. This repeats for the second and subsequent files."
14239 #: ../src/guestfs-actions.pod:4093
14241 "This call is intended for programs that want to efficiently list a directory "
14242 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14243 "a similarly efficient call for getting standard stats. Very long directory "
14244 "listings might cause the protocol message size to be exceeded, causing this "
14245 "call to fail. The caller must split up such requests into smaller groups of "
14251 #: ../src/guestfs-actions.pod:4107
14252 msgid "guestfs_mkdir"
14257 #: ../src/guestfs-actions.pod:4109
14261 " guestfs_mkdir (guestfs_h *g,\n"
14262 " const char *path);\n"
14268 #: ../src/guestfs-actions.pod:4113 ../fish/guestfish-actions.pod:2809
14269 msgid "Create a directory named C<path>."
14274 #: ../src/guestfs-actions.pod:4119
14275 msgid "guestfs_mkdir_mode"
14280 #: ../src/guestfs-actions.pod:4121
14284 " guestfs_mkdir_mode (guestfs_h *g,\n"
14285 " const char *path,\n"
14292 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2815
14294 "This command creates a directory, setting the initial permissions of the "
14295 "directory to C<mode>."
14300 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2818
14302 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14303 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14309 #: ../src/guestfs-actions.pod:4133
14310 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14315 #: ../src/guestfs-actions.pod:4139
14316 msgid "guestfs_mkdir_p"
14321 #: ../src/guestfs-actions.pod:4141
14325 " guestfs_mkdir_p (guestfs_h *g,\n"
14326 " const char *path);\n"
14332 #: ../src/guestfs-actions.pod:4145 ../fish/guestfish-actions.pod:2828
14334 "Create a directory named C<path>, creating any parent directories as "
14335 "necessary. This is like the C<mkdir -p> shell command."
14340 #: ../src/guestfs-actions.pod:4152
14341 msgid "guestfs_mkdtemp"
14346 #: ../src/guestfs-actions.pod:4154
14350 " guestfs_mkdtemp (guestfs_h *g,\n"
14351 " const char *template);\n"
14357 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2835
14359 "This command creates a temporary directory. The C<template> parameter "
14360 "should be a full pathname for the temporary directory name with the final "
14361 "six characters being \"XXXXXX\"."
14366 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:2840
14368 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14369 "being suitable for Windows filesystems."
14374 #: ../src/guestfs-actions.pod:4166 ../fish/guestfish-actions.pod:2843
14375 msgid "The name of the temporary directory that was created is returned."
14380 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2846
14381 msgid "The temporary directory is created with mode 0700 and is owned by root."
14386 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2849
14388 "The caller is responsible for deleting the temporary directory and its "
14389 "contents after use."
14394 #: ../src/guestfs-actions.pod:4175 ../fish/guestfish-actions.pod:2852
14395 msgid "See also: L<mkdtemp(3)>"
14400 #: ../src/guestfs-actions.pod:4182
14401 msgid "guestfs_mke2fs_J"
14406 #: ../src/guestfs-actions.pod:4184
14410 " guestfs_mke2fs_J (guestfs_h *g,\n"
14411 " const char *fstype,\n"
14412 " int blocksize,\n"
14413 " const char *device,\n"
14414 " const char *journal);\n"
14420 #: ../src/guestfs-actions.pod:4191 ../fish/guestfish-actions.pod:2858
14422 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14423 "C<journal>. It is equivalent to the command:"
14428 #: ../src/guestfs-actions.pod:4195 ../fish/guestfish-actions.pod:2862
14431 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14437 #: ../src/guestfs-actions.pod:4197
14438 msgid "See also C<guestfs_mke2journal>."
14443 #: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4219
14444 #: ../src/guestfs-actions.pod:4237 ../src/guestfs-actions.pod:4253
14445 #: ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4281
14446 #: ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4605
14447 msgid "(Added in 1.0.68)"
14452 #: ../src/guestfs-actions.pod:4203
14453 msgid "guestfs_mke2fs_JL"
14458 #: ../src/guestfs-actions.pod:4205
14462 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14463 " const char *fstype,\n"
14464 " int blocksize,\n"
14465 " const char *device,\n"
14466 " const char *label);\n"
14472 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2870
14474 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14475 "the journal labeled C<label>."
14480 #: ../src/guestfs-actions.pod:4215
14481 msgid "See also C<guestfs_mke2journal_L>."
14486 #: ../src/guestfs-actions.pod:4221
14487 msgid "guestfs_mke2fs_JU"
14492 #: ../src/guestfs-actions.pod:4223
14496 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14497 " const char *fstype,\n"
14498 " int blocksize,\n"
14499 " const char *device,\n"
14500 " const char *uuid);\n"
14506 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2879
14508 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14509 "the journal with UUID C<uuid>."
14514 #: ../src/guestfs-actions.pod:4233
14515 msgid "See also C<guestfs_mke2journal_U>."
14520 #: ../src/guestfs-actions.pod:4239
14521 msgid "guestfs_mke2journal"
14526 #: ../src/guestfs-actions.pod:4241
14530 " guestfs_mke2journal (guestfs_h *g,\n"
14531 " int blocksize,\n"
14532 " const char *device);\n"
14538 #: ../src/guestfs-actions.pod:4246 ../fish/guestfish-actions.pod:2888
14540 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14546 #: ../src/guestfs-actions.pod:4249 ../fish/guestfish-actions.pod:2891
14549 " mke2fs -O journal_dev -b blocksize device\n"
14555 #: ../src/guestfs-actions.pod:4255
14556 msgid "guestfs_mke2journal_L"
14561 #: ../src/guestfs-actions.pod:4257
14565 " guestfs_mke2journal_L (guestfs_h *g,\n"
14566 " int blocksize,\n"
14567 " const char *label,\n"
14568 " const char *device);\n"
14574 #: ../src/guestfs-actions.pod:4263 ../fish/guestfish-actions.pod:2897
14575 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14580 #: ../src/guestfs-actions.pod:4269
14581 msgid "guestfs_mke2journal_U"
14586 #: ../src/guestfs-actions.pod:4271
14590 " guestfs_mke2journal_U (guestfs_h *g,\n"
14591 " int blocksize,\n"
14592 " const char *uuid,\n"
14593 " const char *device);\n"
14599 #: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:2903
14600 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14605 #: ../src/guestfs-actions.pod:4283
14606 msgid "guestfs_mkfifo"
14611 #: ../src/guestfs-actions.pod:4285
14615 " guestfs_mkfifo (guestfs_h *g,\n"
14617 " const char *path);\n"
14623 #: ../src/guestfs-actions.pod:4290
14625 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14626 "is just a convenient wrapper around C<guestfs_mknod>."
14631 #: ../src/guestfs-actions.pod:4300
14632 msgid "guestfs_mkfs"
14637 #: ../src/guestfs-actions.pod:4302
14641 " guestfs_mkfs (guestfs_h *g,\n"
14642 " const char *fstype,\n"
14643 " const char *device);\n"
14649 #: ../src/guestfs-actions.pod:4307 ../fish/guestfish-actions.pod:2919
14651 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14652 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14657 #: ../src/guestfs-actions.pod:4315
14658 msgid "guestfs_mkfs_b"
14663 #: ../src/guestfs-actions.pod:4317
14667 " guestfs_mkfs_b (guestfs_h *g,\n"
14668 " const char *fstype,\n"
14669 " int blocksize,\n"
14670 " const char *device);\n"
14676 #: ../src/guestfs-actions.pod:4323
14678 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14679 "block size of the resulting filesystem. Supported block sizes depend on the "
14680 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14685 #: ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4371
14686 #: ../fish/guestfish-actions.pod:2932 ../fish/guestfish-actions.pod:2959
14688 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14694 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:2935
14696 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14701 #: ../src/guestfs-actions.pod:4342
14702 msgid "guestfs_mkfs_opts"
14707 #: ../src/guestfs-actions.pod:4344
14711 " guestfs_mkfs_opts (guestfs_h *g,\n"
14712 " const char *fstype,\n"
14713 " const char *device,\n"
14719 #: ../src/guestfs-actions.pod:4355
14722 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14723 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14729 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2946
14731 "This function creates a filesystem on C<device>. The filesystem type is "
14732 "C<fstype>, for example C<ext3>."
14737 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:2953
14738 msgid "C<blocksize>"
14743 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2955
14745 "The filesystem block size. Supported block sizes depend on the filesystem "
14746 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14751 #: ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:2962
14752 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14756 #: ../src/guestfs-actions.pod:4376 ../fish/guestfish-actions.pod:2964
14757 msgid "C<features>"
14761 #: ../src/guestfs-actions.pod:4378 ../fish/guestfish-actions.pod:2966
14762 msgid "This passes the C<-O> parameter to the external mkfs program."
14766 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2968
14768 "For certain filesystem types, this allows extra filesystem features to be "
14769 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14773 #: ../src/guestfs-actions.pod:4384 ../fish/guestfish-actions.pod:2972
14775 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14780 #: ../src/guestfs-actions.pod:4391
14781 msgid "(Added in 1.7.19)"
14786 #: ../src/guestfs-actions.pod:4393
14787 msgid "guestfs_mkfs_opts_va"
14792 #: ../src/guestfs-actions.pod:4395
14796 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14797 " const char *fstype,\n"
14798 " const char *device,\n"
14799 " va_list args);\n"
14805 #: ../src/guestfs-actions.pod:4401
14806 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14811 #: ../src/guestfs-actions.pod:4405
14812 msgid "guestfs_mkfs_opts_argv"
14817 #: ../src/guestfs-actions.pod:4407
14821 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14822 " const char *fstype,\n"
14823 " const char *device,\n"
14824 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14830 #: ../src/guestfs-actions.pod:4413
14831 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14836 #: ../src/guestfs-actions.pod:4417
14837 msgid "guestfs_mkmountpoint"
14842 #: ../src/guestfs-actions.pod:4419
14846 " guestfs_mkmountpoint (guestfs_h *g,\n"
14847 " const char *exemptpath);\n"
14853 #: ../src/guestfs-actions.pod:4423
14855 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14856 "that can be used to create extra mountpoints before mounting the first "
14862 #: ../src/guestfs-actions.pod:4427 ../fish/guestfish-actions.pod:2987
14864 "These calls are I<only> necessary in some very limited circumstances, mainly "
14865 "the case where you want to mount a mix of unrelated and/or read-only "
14866 "filesystems together."
14871 #: ../src/guestfs-actions.pod:4431 ../fish/guestfish-actions.pod:2991
14873 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14874 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14875 "inside that. You can unpack this as follows in guestfish:"
14880 #: ../src/guestfs-actions.pod:4436 ../fish/guestfish-actions.pod:2996
14883 " add-ro Fedora-11-i686-Live.iso\n"
14885 " mkmountpoint /cd\n"
14886 " mkmountpoint /sqsh\n"
14887 " mkmountpoint /ext3fs\n"
14888 " mount /dev/sda /cd\n"
14889 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14890 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14896 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:3005
14897 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14902 #: ../src/guestfs-actions.pod:4447
14904 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14905 "may get unexpected errors if you try to mix these calls. It is safest to "
14906 "manually unmount filesystems and remove mountpoints after use."
14911 #: ../src/guestfs-actions.pod:4451
14913 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14914 "first, so for this to work for manual mountpoints, you must ensure that the "
14915 "innermost mountpoints have the longest pathnames, as in the example code "
14921 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:3016
14923 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14927 #: ../src/guestfs-actions.pod:4458
14929 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14930 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14931 "can also trigger these issues."
14936 #: ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4723
14937 #: ../src/guestfs-actions.pod:5633
14938 msgid "(Added in 1.0.62)"
14943 #: ../src/guestfs-actions.pod:4466
14944 msgid "guestfs_mknod"
14949 #: ../src/guestfs-actions.pod:4468
14953 " guestfs_mknod (guestfs_h *g,\n"
14957 " const char *path);\n"
14963 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3026
14965 "This call creates block or character special devices, or named pipes (FIFOs)."
14970 #: ../src/guestfs-actions.pod:4478 ../fish/guestfish-actions.pod:3029
14972 "The C<mode> parameter should be the mode, using the standard constants. "
14973 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14974 "used when creating block and character special devices."
14979 #: ../src/guestfs-actions.pod:4483
14981 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14982 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14983 "regular file). These constants are available in the standard Linux header "
14984 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14985 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14986 "the appropriate constant for you."
14991 #: ../src/guestfs-actions.pod:4497
14992 msgid "guestfs_mknod_b"
14997 #: ../src/guestfs-actions.pod:4499
15001 " guestfs_mknod_b (guestfs_h *g,\n"
15005 " const char *path);\n"
15011 #: ../src/guestfs-actions.pod:4506
15013 "This call creates a block device node called C<path> with mode C<mode> and "
15014 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15015 "wrapper around C<guestfs_mknod>."
15020 #: ../src/guestfs-actions.pod:4516
15021 msgid "guestfs_mknod_c"
15026 #: ../src/guestfs-actions.pod:4518
15030 " guestfs_mknod_c (guestfs_h *g,\n"
15034 " const char *path);\n"
15040 #: ../src/guestfs-actions.pod:4525
15042 "This call creates a char device node called C<path> with mode C<mode> and "
15043 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15044 "wrapper around C<guestfs_mknod>."
15049 #: ../src/guestfs-actions.pod:4535
15050 msgid "guestfs_mkswap"
15055 #: ../src/guestfs-actions.pod:4537
15059 " guestfs_mkswap (guestfs_h *g,\n"
15060 " const char *device);\n"
15066 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3068
15067 msgid "Create a swap partition on C<device>."
15072 #: ../src/guestfs-actions.pod:4547
15073 msgid "guestfs_mkswap_L"
15078 #: ../src/guestfs-actions.pod:4549
15082 " guestfs_mkswap_L (guestfs_h *g,\n"
15083 " const char *label,\n"
15084 " const char *device);\n"
15090 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3074
15091 msgid "Create a swap partition on C<device> with label C<label>."
15096 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3076
15098 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15099 "sda>), just to a partition. This appears to be a limitation of the kernel "
15105 #: ../src/guestfs-actions.pod:4564
15106 msgid "guestfs_mkswap_U"
15111 #: ../src/guestfs-actions.pod:4566
15115 " guestfs_mkswap_U (guestfs_h *g,\n"
15116 " const char *uuid,\n"
15117 " const char *device);\n"
15123 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3084
15124 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15129 #: ../src/guestfs-actions.pod:4577
15130 msgid "guestfs_mkswap_file"
15135 #: ../src/guestfs-actions.pod:4579
15139 " guestfs_mkswap_file (guestfs_h *g,\n"
15140 " const char *path);\n"
15146 #: ../src/guestfs-actions.pod:4583 ../fish/guestfish-actions.pod:3090
15147 msgid "Create a swap file."
15152 #: ../src/guestfs-actions.pod:4585
15154 "This command just writes a swap file signature to an existing file. To "
15155 "create the file itself, use something like C<guestfs_fallocate>."
15160 #: ../src/guestfs-actions.pod:4592
15161 msgid "guestfs_modprobe"
15166 #: ../src/guestfs-actions.pod:4594
15170 " guestfs_modprobe (guestfs_h *g,\n"
15171 " const char *modulename);\n"
15177 #: ../src/guestfs-actions.pod:4598 ../fish/guestfish-actions.pod:3099
15178 msgid "This loads a kernel module in the appliance."
15183 #: ../src/guestfs-actions.pod:4600 ../fish/guestfish-actions.pod:3101
15185 "The kernel module must have been whitelisted when libguestfs was built (see "
15186 "C<appliance/kmod.whitelist.in> in the source)."
15191 #: ../src/guestfs-actions.pod:4607
15192 msgid "guestfs_mount"
15197 #: ../src/guestfs-actions.pod:4609
15201 " guestfs_mount (guestfs_h *g,\n"
15202 " const char *device,\n"
15203 " const char *mountpoint);\n"
15209 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3108
15211 "Mount a guest disk at a position in the filesystem. Block devices are named "
15212 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15213 "those block devices contain partitions, they will have the usual names (eg. "
15214 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15219 #: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3114
15221 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15222 "mounted on C</> before others can be mounted. Other filesystems can only be "
15223 "mounted on directories which already exist."
15228 #: ../src/guestfs-actions.pod:4625 ../fish/guestfish-actions.pod:3119
15230 "The mounted filesystem is writable, if we have sufficient permissions on the "
15231 "underlying device."
15236 #: ../src/guestfs-actions.pod:4628
15238 "B<Important note:> When you use this call, the filesystem options C<sync> "
15239 "and C<noatime> are set implicitly. This was originally done because we "
15240 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15241 "very large negative performance impact and negligible effect on "
15242 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15243 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15244 "(use an empty string for the first parameter if you don't want any options)."
15249 #: ../src/guestfs-actions.pod:4642
15250 msgid "guestfs_mount_loop"
15255 #: ../src/guestfs-actions.pod:4644
15259 " guestfs_mount_loop (guestfs_h *g,\n"
15260 " const char *file,\n"
15261 " const char *mountpoint);\n"
15267 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3136
15269 "This command lets you mount C<file> (a filesystem image in a file) on a "
15270 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15276 #: ../src/guestfs-actions.pod:4657
15277 msgid "guestfs_mount_options"
15282 #: ../src/guestfs-actions.pod:4659
15286 " guestfs_mount_options (guestfs_h *g,\n"
15287 " const char *options,\n"
15288 " const char *device,\n"
15289 " const char *mountpoint);\n"
15295 #: ../src/guestfs-actions.pod:4665
15297 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15298 "the mount options as for the L<mount(8)> I<-o> flag."
15303 #: ../src/guestfs-actions.pod:4669 ../fish/guestfish-actions.pod:3148
15305 "If the C<options> parameter is an empty string, then no options are passed "
15306 "(all options default to whatever the filesystem uses)."
15311 #: ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:4689
15312 #: ../src/guestfs-actions.pod:4706
15313 msgid "(Added in 1.0.10)"
15318 #: ../src/guestfs-actions.pod:4677
15319 msgid "guestfs_mount_ro"
15324 #: ../src/guestfs-actions.pod:4679
15328 " guestfs_mount_ro (guestfs_h *g,\n"
15329 " const char *device,\n"
15330 " const char *mountpoint);\n"
15336 #: ../src/guestfs-actions.pod:4684
15338 "This is the same as the C<guestfs_mount> command, but it mounts the "
15339 "filesystem with the read-only (I<-o ro>) flag."
15344 #: ../src/guestfs-actions.pod:4691
15345 msgid "guestfs_mount_vfs"
15350 #: ../src/guestfs-actions.pod:4693
15354 " guestfs_mount_vfs (guestfs_h *g,\n"
15355 " const char *options,\n"
15356 " const char *vfstype,\n"
15357 " const char *device,\n"
15358 " const char *mountpoint);\n"
15364 #: ../src/guestfs-actions.pod:4700
15366 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15367 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15373 #: ../src/guestfs-actions.pod:4708
15374 msgid "guestfs_mountpoints"
15379 #: ../src/guestfs-actions.pod:4710
15383 " guestfs_mountpoints (guestfs_h *g);\n"
15389 #: ../src/guestfs-actions.pod:4713
15391 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15392 "devices. This one returns a hash table (map) of device name to directory "
15393 "where the device is mounted."
15398 #: ../src/guestfs-actions.pod:4725
15399 msgid "guestfs_mounts"
15404 #: ../src/guestfs-actions.pod:4727
15408 " guestfs_mounts (guestfs_h *g);\n"
15414 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3179
15416 "This returns the list of currently mounted filesystems. It returns the list "
15417 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15422 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3182
15423 msgid "Some internal mounts are not shown."
15428 #: ../src/guestfs-actions.pod:4735
15429 msgid "See also: C<guestfs_mountpoints>"
15434 #: ../src/guestfs-actions.pod:4743
15440 #: ../src/guestfs-actions.pod:4745
15444 " guestfs_mv (guestfs_h *g,\n"
15445 " const char *src,\n"
15446 " const char *dest);\n"
15452 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3190
15454 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15455 "destination filename or destination directory."
15460 #: ../src/guestfs-actions.pod:4757
15461 msgid "guestfs_ntfs_3g_probe"
15466 #: ../src/guestfs-actions.pod:4759
15470 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15472 " const char *device);\n"
15478 #: ../src/guestfs-actions.pod:4764 ../fish/guestfish-actions.pod:3197
15480 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15481 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15482 "write, and some cannot be mounted at all)."
15487 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3201
15489 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15490 "can be mounted read-write. Set it to false if you want to test if the "
15491 "volume can be mounted read-only."
15496 #: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3205
15498 "The return value is an integer which C<0> if the operation would succeed, or "
15499 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15504 #: ../src/guestfs-actions.pod:4778
15505 msgid "(Added in 1.0.43)"
15510 #: ../src/guestfs-actions.pod:4780
15511 msgid "guestfs_ntfsresize"
15516 #: ../src/guestfs-actions.pod:4782
15520 " guestfs_ntfsresize (guestfs_h *g,\n"
15521 " const char *device);\n"
15527 #: ../src/guestfs-actions.pod:4786 ../fish/guestfish-actions.pod:3213
15529 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15530 "size of the underlying device. See also L<ntfsresize(8)>."
15535 #: ../src/guestfs-actions.pod:4794
15536 msgid "guestfs_ntfsresize_size"
15541 #: ../src/guestfs-actions.pod:4796
15545 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15546 " const char *device,\n"
15547 " int64_t size);\n"
15553 #: ../src/guestfs-actions.pod:4801
15555 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15556 "to specify the new size (in bytes) explicitly."
15561 #: ../src/guestfs-actions.pod:4806 ../src/guestfs-actions.pod:5242
15562 #: ../src/guestfs-actions.pod:5315 ../src/guestfs-actions.pod:5581
15563 #: ../src/guestfs-actions.pod:7152
15564 msgid "(Added in 1.3.14)"
15569 #: ../src/guestfs-actions.pod:4808
15570 msgid "guestfs_part_add"
15575 #: ../src/guestfs-actions.pod:4810
15579 " guestfs_part_add (guestfs_h *g,\n"
15580 " const char *device,\n"
15581 " const char *prlogex,\n"
15582 " int64_t startsect,\n"
15583 " int64_t endsect);\n"
15589 #: ../src/guestfs-actions.pod:4817
15591 "This command adds a partition to C<device>. If there is no partition table "
15592 "on the device, call C<guestfs_part_init> first."
15597 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3231
15599 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15600 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15601 "C<logical>) and C<e> (or C<extended>) partition types."
15606 #: ../src/guestfs-actions.pod:4825 ../fish/guestfish-actions.pod:3236
15608 "C<startsect> and C<endsect> are the start and end of the partition in "
15609 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15610 "from the end of the disk (C<-1> is the last sector)."
15615 #: ../src/guestfs-actions.pod:4829
15617 "Creating a partition which covers the whole disk is not so easy. Use "
15618 "C<guestfs_part_disk> to do that."
15623 #: ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:4872
15624 #: ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:5003
15625 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5060
15626 #: ../src/guestfs-actions.pod:5100
15627 msgid "(Added in 1.0.78)"
15632 #: ../src/guestfs-actions.pod:4836
15633 msgid "guestfs_part_del"
15638 #: ../src/guestfs-actions.pod:4838
15642 " guestfs_part_del (guestfs_h *g,\n"
15643 " const char *device,\n"
15650 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3247
15651 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15656 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3249
15658 "Note that in the case of MBR partitioning, deleting an extended partition "
15659 "also deletes any logical partitions it contains."
15664 #: ../src/guestfs-actions.pod:4853
15665 msgid "guestfs_part_disk"
15670 #: ../src/guestfs-actions.pod:4855
15674 " guestfs_part_disk (guestfs_h *g,\n"
15675 " const char *device,\n"
15676 " const char *parttype);\n"
15682 #: ../src/guestfs-actions.pod:4860
15684 "This command is simply a combination of C<guestfs_part_init> followed by "
15685 "C<guestfs_part_add> to create a single primary partition covering the whole "
15691 #: ../src/guestfs-actions.pod:4864
15693 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15694 "possible values are described in C<guestfs_part_init>."
15699 #: ../src/guestfs-actions.pod:4874
15700 msgid "guestfs_part_get_bootable"
15705 #: ../src/guestfs-actions.pod:4876
15709 " guestfs_part_get_bootable (guestfs_h *g,\n"
15710 " const char *device,\n"
15717 #: ../src/guestfs-actions.pod:4881 ../fish/guestfish-actions.pod:3271
15719 "This command returns true if the partition C<partnum> on C<device> has the "
15720 "bootable flag set."
15725 #: ../src/guestfs-actions.pod:4884
15726 msgid "See also C<guestfs_part_set_bootable>."
15731 #: ../src/guestfs-actions.pod:4890
15732 msgid "guestfs_part_get_mbr_id"
15737 #: ../src/guestfs-actions.pod:4892
15741 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15742 " const char *device,\n"
15749 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3280
15751 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15752 "partition C<partnum>."
15757 #: ../src/guestfs-actions.pod:4900 ../src/guestfs-actions.pod:5076
15759 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15760 "undefined results for other partition table types (see "
15761 "C<guestfs_part_get_parttype>)."
15766 #: ../src/guestfs-actions.pod:4908
15767 msgid "guestfs_part_get_parttype"
15772 #: ../src/guestfs-actions.pod:4910
15776 " guestfs_part_get_parttype (guestfs_h *g,\n"
15777 " const char *device);\n"
15783 #: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3291
15785 "This command examines the partition table on C<device> and returns the "
15786 "partition table type (format) being used."
15791 #: ../src/guestfs-actions.pod:4917
15793 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15794 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15795 "possible, although unusual. See C<guestfs_part_init> for a full list."
15800 #: ../src/guestfs-actions.pod:4927
15801 msgid "guestfs_part_init"
15806 #: ../src/guestfs-actions.pod:4929
15810 " guestfs_part_init (guestfs_h *g,\n"
15811 " const char *device,\n"
15812 " const char *parttype);\n"
15818 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3303
15820 "This creates an empty partition table on C<device> of one of the partition "
15821 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15822 "(for large disks)."
15827 #: ../src/guestfs-actions.pod:4938
15829 "Initially there are no partitions. Following this, you should call "
15830 "C<guestfs_part_add> for each partition required."
15835 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3310
15836 msgid "Possible values for C<parttype> are:"
15841 #: ../src/guestfs-actions.pod:4945 ../fish/guestfish-actions.pod:3314
15842 msgid "B<efi> | B<gpt>"
15847 #: ../src/guestfs-actions.pod:4947 ../fish/guestfish-actions.pod:3316
15848 msgid "Intel EFI / GPT partition table."
15853 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3318
15855 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15856 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15857 "the C<mbr> format."
15862 #: ../src/guestfs-actions.pod:4953 ../fish/guestfish-actions.pod:3322
15863 msgid "B<mbr> | B<msdos>"
15868 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3324
15870 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15871 "Windows. This partition type will B<only> work for device sizes up to 2 "
15872 "TB. For large disks we recommend using C<gpt>."
15877 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3331
15879 "Other partition table types that may work but are not supported include:"
15884 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3336
15890 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3338
15891 msgid "AIX disk labels."
15896 #: ../src/guestfs-actions.pod:4971 ../fish/guestfish-actions.pod:3340
15897 msgid "B<amiga> | B<rdb>"
15902 #: ../src/guestfs-actions.pod:4973 ../fish/guestfish-actions.pod:3342
15903 msgid "Amiga \"Rigid Disk Block\" format."
15908 #: ../src/guestfs-actions.pod:4975 ../fish/guestfish-actions.pod:3344
15914 #: ../src/guestfs-actions.pod:4977 ../fish/guestfish-actions.pod:3346
15915 msgid "BSD disk labels."
15920 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3348
15926 #: ../src/guestfs-actions.pod:4981 ../fish/guestfish-actions.pod:3350
15927 msgid "DASD, used on IBM mainframes."
15932 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3352
15938 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3354
15939 msgid "MIPS/SGI volumes."
15944 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3356
15950 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3358
15951 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15956 #: ../src/guestfs-actions.pod:4991 ../fish/guestfish-actions.pod:3360
15962 #: ../src/guestfs-actions.pod:4993 ../fish/guestfish-actions.pod:3362
15963 msgid "NEC PC-98 format, common in Japan apparently."
15968 #: ../src/guestfs-actions.pod:4995 ../fish/guestfish-actions.pod:3364
15974 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3366
15975 msgid "Sun disk labels."
15980 #: ../src/guestfs-actions.pod:5005
15981 msgid "guestfs_part_list"
15986 #: ../src/guestfs-actions.pod:5007
15989 " struct guestfs_partition_list *\n"
15990 " guestfs_part_list (guestfs_h *g,\n"
15991 " const char *device);\n"
15997 #: ../src/guestfs-actions.pod:5011 ../fish/guestfish-actions.pod:3374
15999 "This command parses the partition table on C<device> and returns the list of "
16000 "partitions found."
16005 #: ../src/guestfs-actions.pod:5014 ../fish/guestfish-actions.pod:3377
16006 msgid "The fields in the returned structure are:"
16011 #: ../src/guestfs-actions.pod:5018 ../fish/guestfish-actions.pod:3381
16012 msgid "B<part_num>"
16017 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3383
16018 msgid "Partition number, counting from 1."
16023 #: ../src/guestfs-actions.pod:5022 ../fish/guestfish-actions.pod:3385
16024 msgid "B<part_start>"
16029 #: ../src/guestfs-actions.pod:5024
16031 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16032 "the device's sector size, see C<guestfs_blockdev_getss>."
16037 #: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3390
16038 msgid "B<part_end>"
16043 #: ../src/guestfs-actions.pod:5029 ../fish/guestfish-actions.pod:3392
16044 msgid "End of the partition in bytes."
16049 #: ../src/guestfs-actions.pod:5031 ../fish/guestfish-actions.pod:3394
16050 msgid "B<part_size>"
16055 #: ../src/guestfs-actions.pod:5033 ../fish/guestfish-actions.pod:3396
16056 msgid "Size of the partition in bytes."
16061 #: ../src/guestfs-actions.pod:5037
16063 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16064 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16070 #: ../src/guestfs-actions.pod:5043
16071 msgid "guestfs_part_set_bootable"
16076 #: ../src/guestfs-actions.pod:5045
16080 " guestfs_part_set_bootable (guestfs_h *g,\n"
16081 " const char *device,\n"
16083 " int bootable);\n"
16089 #: ../src/guestfs-actions.pod:5051 ../fish/guestfish-actions.pod:3404
16091 "This sets the bootable flag on partition numbered C<partnum> on device "
16092 "C<device>. Note that partitions are numbered from 1."
16097 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3407
16099 "The bootable flag is used by some operating systems (notably Windows) to "
16100 "determine which partition to boot from. It is by no means universally "
16106 #: ../src/guestfs-actions.pod:5062
16107 msgid "guestfs_part_set_mbr_id"
16112 #: ../src/guestfs-actions.pod:5064
16116 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16117 " const char *device,\n"
16125 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3415
16127 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16128 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16129 "documentation are in fact hexadecimal numbers, but usually documented "
16130 "without any leading \"0x\" which might be confusing."
16135 #: ../src/guestfs-actions.pod:5084
16136 msgid "guestfs_part_set_name"
16141 #: ../src/guestfs-actions.pod:5086
16145 " guestfs_part_set_name (guestfs_h *g,\n"
16146 " const char *device,\n"
16148 " const char *name);\n"
16154 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3429
16156 "This sets the partition name on partition numbered C<partnum> on device "
16157 "C<device>. Note that partitions are numbered from 1."
16162 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3432
16164 "The partition name can only be set on certain types of partition table. "
16165 "This works on C<gpt> but not on C<mbr> partitions."
16170 #: ../src/guestfs-actions.pod:5102
16171 msgid "guestfs_part_to_dev"
16176 #: ../src/guestfs-actions.pod:5104
16180 " guestfs_part_to_dev (guestfs_h *g,\n"
16181 " const char *partition);\n"
16187 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3439
16189 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16190 "partition number, returning the device name (eg. \"/dev/sdb\")."
16195 #: ../src/guestfs-actions.pod:5112
16197 "The named partition must exist, for example as a string returned from "
16198 "C<guestfs_list_partitions>."
16203 #: ../src/guestfs-actions.pod:5120
16204 msgid "guestfs_ping_daemon"
16209 #: ../src/guestfs-actions.pod:5122
16213 " guestfs_ping_daemon (guestfs_h *g);\n"
16219 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3450
16221 "This is a test probe into the guestfs daemon running inside the qemu "
16222 "subprocess. Calling this function checks that the daemon responds to the "
16223 "ping message, without affecting the daemon or attached block device(s) in "
16229 #: ../src/guestfs-actions.pod:5134
16230 msgid "guestfs_pread"
16235 #: ../src/guestfs-actions.pod:5136
16239 " guestfs_pread (guestfs_h *g,\n"
16240 " const char *path,\n"
16242 " int64_t offset,\n"
16243 " size_t *size_r);\n"
16249 #: ../src/guestfs-actions.pod:5143 ../fish/guestfish-actions.pod:3459
16251 "This command lets you read part of a file. It reads C<count> bytes of the "
16252 "file, starting at C<offset>, from file C<path>."
16257 #: ../src/guestfs-actions.pod:5146 ../src/guestfs-actions.pod:5172
16258 #: ../fish/guestfish-actions.pod:3462 ../fish/guestfish-actions.pod:3477
16260 "This may read fewer bytes than requested. For further details see the "
16261 "L<pread(2)> system call."
16266 #: ../src/guestfs-actions.pod:5149
16267 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16272 #: ../src/guestfs-actions.pod:5160
16273 msgid "guestfs_pread_device"
16278 #: ../src/guestfs-actions.pod:5162
16282 " guestfs_pread_device (guestfs_h *g,\n"
16283 " const char *device,\n"
16285 " int64_t offset,\n"
16286 " size_t *size_r);\n"
16292 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3474
16294 "This command lets you read part of a file. It reads C<count> bytes of "
16295 "C<device>, starting at C<offset>."
16300 #: ../src/guestfs-actions.pod:5175
16301 msgid "See also C<guestfs_pread>."
16306 #: ../src/guestfs-actions.pod:5184
16307 msgid "(Added in 1.5.21)"
16312 #: ../src/guestfs-actions.pod:5186
16313 msgid "guestfs_pvcreate"
16318 #: ../src/guestfs-actions.pod:5188
16322 " guestfs_pvcreate (guestfs_h *g,\n"
16323 " const char *device);\n"
16329 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3489
16331 "This creates an LVM physical volume on the named C<device>, where C<device> "
16332 "should usually be a partition name such as C</dev/sda1>."
16337 #: ../src/guestfs-actions.pod:5200
16338 msgid "guestfs_pvremove"
16343 #: ../src/guestfs-actions.pod:5202
16347 " guestfs_pvremove (guestfs_h *g,\n"
16348 " const char *device);\n"
16354 #: ../src/guestfs-actions.pod:5206 ../fish/guestfish-actions.pod:3497
16356 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16362 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3500
16364 "The implementation uses the C<pvremove> command which refuses to wipe "
16365 "physical volumes that contain any volume groups, so you have to remove those "
16371 #: ../src/guestfs-actions.pod:5217
16372 msgid "guestfs_pvresize"
16377 #: ../src/guestfs-actions.pod:5219
16381 " guestfs_pvresize (guestfs_h *g,\n"
16382 " const char *device);\n"
16388 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3508
16390 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16391 "the new size of the underlying device."
16396 #: ../src/guestfs-actions.pod:5230
16397 msgid "guestfs_pvresize_size"
16402 #: ../src/guestfs-actions.pod:5232
16406 " guestfs_pvresize_size (guestfs_h *g,\n"
16407 " const char *device,\n"
16408 " int64_t size);\n"
16414 #: ../src/guestfs-actions.pod:5237
16416 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16417 "specify the new size (in bytes) explicitly."
16422 #: ../src/guestfs-actions.pod:5244
16423 msgid "guestfs_pvs"
16428 #: ../src/guestfs-actions.pod:5246
16432 " guestfs_pvs (guestfs_h *g);\n"
16438 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3522
16440 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16446 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3525
16448 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16454 #: ../src/guestfs-actions.pod:5255
16455 msgid "See also C<guestfs_pvs_full>."
16460 #: ../src/guestfs-actions.pod:5263
16461 msgid "guestfs_pvs_full"
16466 #: ../src/guestfs-actions.pod:5265
16469 " struct guestfs_lvm_pv_list *\n"
16470 " guestfs_pvs_full (guestfs_h *g);\n"
16476 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3534
16478 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16479 "(8)> command. The \"full\" version includes all fields."
16484 #: ../src/guestfs-actions.pod:5271
16486 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16487 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16492 #: ../src/guestfs-actions.pod:5277
16493 msgid "guestfs_pvuuid"
16498 #: ../src/guestfs-actions.pod:5279
16502 " guestfs_pvuuid (guestfs_h *g,\n"
16503 " const char *device);\n"
16509 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3541
16510 msgid "This command returns the UUID of the LVM PV C<device>."
16515 #: ../src/guestfs-actions.pod:5290
16516 msgid "guestfs_pwrite"
16521 #: ../src/guestfs-actions.pod:5292
16525 " guestfs_pwrite (guestfs_h *g,\n"
16526 " const char *path,\n"
16527 " const char *content,\n"
16528 " size_t content_size,\n"
16529 " int64_t offset);\n"
16535 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3547
16537 "This command writes to part of a file. It writes the data buffer C<content> "
16538 "to the file C<path> starting at offset C<offset>."
16543 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3550
16545 "This command implements the L<pwrite(2)> system call, and like that system "
16546 "call it may not write the full data requested. The return value is the "
16547 "number of bytes that were actually written to the file. This could even be "
16548 "0, although short writes are unlikely for regular files in ordinary "
16554 #: ../src/guestfs-actions.pod:5308
16555 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16560 #: ../src/guestfs-actions.pod:5317
16561 msgid "guestfs_pwrite_device"
16566 #: ../src/guestfs-actions.pod:5319
16570 " guestfs_pwrite_device (guestfs_h *g,\n"
16571 " const char *device,\n"
16572 " const char *content,\n"
16573 " size_t content_size,\n"
16574 " int64_t offset);\n"
16580 #: ../src/guestfs-actions.pod:5326 ../fish/guestfish-actions.pod:3565
16582 "This command writes to part of a device. It writes the data buffer "
16583 "C<content> to C<device> starting at offset C<offset>."
16588 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3568
16590 "This command implements the L<pwrite(2)> system call, and like that system "
16591 "call it may not write the full data requested (although short writes to disk "
16592 "devices and partitions are probably impossible with standard Linux kernels)."
16597 #: ../src/guestfs-actions.pod:5334
16598 msgid "See also C<guestfs_pwrite>."
16603 #: ../src/guestfs-actions.pod:5341
16604 msgid "(Added in 1.5.20)"
16609 #: ../src/guestfs-actions.pod:5343
16610 msgid "guestfs_read_file"
16615 #: ../src/guestfs-actions.pod:5345
16619 " guestfs_read_file (guestfs_h *g,\n"
16620 " const char *path,\n"
16621 " size_t *size_r);\n"
16627 #: ../src/guestfs-actions.pod:5350 ../fish/guestfish-actions.pod:3582
16628 msgid "This calls returns the contents of the file C<path> as a buffer."
16633 #: ../src/guestfs-actions.pod:5353
16635 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16636 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16637 "function is limited in the total size of file that can be handled."
16642 #: ../src/guestfs-actions.pod:5365
16643 msgid "(Added in 1.0.63)"
16648 #: ../src/guestfs-actions.pod:5367
16649 msgid "guestfs_read_lines"
16654 #: ../src/guestfs-actions.pod:5369
16658 " guestfs_read_lines (guestfs_h *g,\n"
16659 " const char *path);\n"
16665 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3599
16667 "The file contents are returned as a list of lines. Trailing C<LF> and "
16668 "C<CRLF> character sequences are I<not> returned."
16673 #: ../src/guestfs-actions.pod:5378
16675 "Note that this function cannot correctly handle binary files (specifically, "
16676 "files containing C<\\0> character which is treated as end of line). For "
16677 "those you need to use the C<guestfs_read_file> function which has a more "
16678 "complex interface."
16683 #: ../src/guestfs-actions.pod:5389
16684 msgid "guestfs_readdir"
16689 #: ../src/guestfs-actions.pod:5391
16692 " struct guestfs_dirent_list *\n"
16693 " guestfs_readdir (guestfs_h *g,\n"
16694 " const char *dir);\n"
16700 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3611
16701 msgid "This returns the list of directory entries in directory C<dir>."
16706 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3613
16708 "All entries in the directory are returned, including C<.> and C<..>. The "
16709 "entries are I<not> sorted, but returned in the same order as the underlying "
16715 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3617
16717 "Also this call returns basic file type information about each file. The "
16718 "C<ftyp> field will contain one of the following characters:"
16723 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3622
16729 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3624
16730 msgid "Block special"
16735 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3626
16741 #: ../src/guestfs-actions.pod:5412 ../fish/guestfish-actions.pod:3628
16742 msgid "Char special"
16747 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
16753 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3632
16759 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3634
16765 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3636
16766 msgid "FIFO (named pipe)"
16771 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
16777 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3640
16778 msgid "Symbolic link"
16783 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3642
16789 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3644
16790 msgid "Regular file"
16795 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3646
16801 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3648
16807 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3650
16813 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3652
16814 msgid "Unknown file type"
16819 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3654
16825 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3656
16827 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16832 #: ../src/guestfs-actions.pod:5445
16834 "This function is primarily intended for use by programs. To get a simple "
16835 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16836 "consumption, use C<guestfs_ll>."
16841 #: ../src/guestfs-actions.pod:5449
16843 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16844 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16849 #: ../src/guestfs-actions.pod:5455
16850 msgid "guestfs_readlink"
16855 #: ../src/guestfs-actions.pod:5457
16859 " guestfs_readlink (guestfs_h *g,\n"
16860 " const char *path);\n"
16866 #: ../src/guestfs-actions.pod:5461 ../fish/guestfish-actions.pod:3669
16867 msgid "This command reads the target of a symbolic link."
16872 #: ../src/guestfs-actions.pod:5468
16873 msgid "guestfs_readlinklist"
16878 #: ../src/guestfs-actions.pod:5470
16882 " guestfs_readlinklist (guestfs_h *g,\n"
16883 " const char *path,\n"
16884 " char *const *names);\n"
16890 #: ../src/guestfs-actions.pod:5475 ../fish/guestfish-actions.pod:3675
16892 "This call allows you to do a C<readlink> operation on multiple files, where "
16893 "all files are in the directory C<path>. C<names> is the list of files from "
16899 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3679
16901 "On return you get a list of strings, with a one-to-one correspondence to the "
16902 "C<names> list. Each string is the value of the symbolic link."
16907 #: ../src/guestfs-actions.pod:5483 ../fish/guestfish-actions.pod:3683
16909 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16910 "result string is the empty string C<\"\">. However the whole operation is "
16911 "completed even if there were C<readlink(2)> errors, and so you can call this "
16912 "function with names where you don't know if they are symbolic links already "
16913 "(albeit slightly less efficient)."
16918 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:3690
16920 "This call is intended for programs that want to efficiently list a directory "
16921 "contents without making many round-trips. Very long directory listings "
16922 "might cause the protocol message size to be exceeded, causing this call to "
16923 "fail. The caller must split up such requests into smaller groups of names."
16928 #: ../src/guestfs-actions.pod:5503
16929 msgid "guestfs_realpath"
16934 #: ../src/guestfs-actions.pod:5505
16938 " guestfs_realpath (guestfs_h *g,\n"
16939 " const char *path);\n"
16945 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3701
16947 "Return the canonicalized absolute pathname of C<path>. The returned path "
16948 "has no C<.>, C<..> or symbolic link path elements."
16953 #: ../src/guestfs-actions.pod:5517
16954 msgid "guestfs_removexattr"
16959 #: ../src/guestfs-actions.pod:5519
16963 " guestfs_removexattr (guestfs_h *g,\n"
16964 " const char *xattr,\n"
16965 " const char *path);\n"
16971 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3708
16973 "This call removes the extended attribute named C<xattr> of the file C<path>."
16978 #: ../src/guestfs-actions.pod:5527
16979 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16984 #: ../src/guestfs-actions.pod:5533
16985 msgid "guestfs_resize2fs"
16990 #: ../src/guestfs-actions.pod:5535
16994 " guestfs_resize2fs (guestfs_h *g,\n"
16995 " const char *device);\n"
17001 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3717
17003 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17004 "underlying device."
17009 #: ../src/guestfs-actions.pod:5542
17011 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17012 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17013 "sometimes gives an error about this and sometimes not. In any case, it is "
17014 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17018 #: ../src/guestfs-actions.pod:5552
17019 msgid "guestfs_resize2fs_M"
17023 #: ../src/guestfs-actions.pod:5554
17027 " guestfs_resize2fs_M (guestfs_h *g,\n"
17028 " const char *device);\n"
17033 #: ../src/guestfs-actions.pod:5558
17035 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17036 "resized to its minimum size. This works like the C<-M> option to the "
17037 "C<resize2fs> command."
17041 #: ../src/guestfs-actions.pod:5562
17043 "To get the resulting size of the filesystem you should call "
17044 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17045 "These two numbers, multiplied together, give the resulting size of the "
17046 "minimal filesystem in bytes."
17051 #: ../src/guestfs-actions.pod:5569
17052 msgid "guestfs_resize2fs_size"
17057 #: ../src/guestfs-actions.pod:5571
17061 " guestfs_resize2fs_size (guestfs_h *g,\n"
17062 " const char *device,\n"
17063 " int64_t size);\n"
17069 #: ../src/guestfs-actions.pod:5576
17071 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17072 "to specify the new size (in bytes) explicitly."
17077 #: ../src/guestfs-actions.pod:5583
17083 #: ../src/guestfs-actions.pod:5585
17087 " guestfs_rm (guestfs_h *g,\n"
17088 " const char *path);\n"
17094 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3750
17095 msgid "Remove the single file C<path>."
17100 #: ../src/guestfs-actions.pod:5595
17101 msgid "guestfs_rm_rf"
17106 #: ../src/guestfs-actions.pod:5597
17110 " guestfs_rm_rf (guestfs_h *g,\n"
17111 " const char *path);\n"
17117 #: ../src/guestfs-actions.pod:5601 ../fish/guestfish-actions.pod:3756
17119 "Remove the file or directory C<path>, recursively removing the contents if "
17120 "its a directory. This is like the C<rm -rf> shell command."
17125 #: ../src/guestfs-actions.pod:5609
17126 msgid "guestfs_rmdir"
17131 #: ../src/guestfs-actions.pod:5611
17135 " guestfs_rmdir (guestfs_h *g,\n"
17136 " const char *path);\n"
17142 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3764
17143 msgid "Remove the single directory C<path>."
17148 #: ../src/guestfs-actions.pod:5621
17149 msgid "guestfs_rmmountpoint"
17154 #: ../src/guestfs-actions.pod:5623
17158 " guestfs_rmmountpoint (guestfs_h *g,\n"
17159 " const char *exemptpath);\n"
17165 #: ../src/guestfs-actions.pod:5627
17167 "This calls removes a mountpoint that was previously created with "
17168 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17173 #: ../src/guestfs-actions.pod:5635
17174 msgid "guestfs_scrub_device"
17179 #: ../src/guestfs-actions.pod:5637
17183 " guestfs_scrub_device (guestfs_h *g,\n"
17184 " const char *device);\n"
17190 #: ../src/guestfs-actions.pod:5641 ../fish/guestfish-actions.pod:3778
17192 "This command writes patterns over C<device> to make data retrieval more "
17198 #: ../src/guestfs-actions.pod:5644 ../src/guestfs-actions.pod:5665
17199 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3781
17200 #: ../fish/guestfish-actions.pod:3796 ../fish/guestfish-actions.pod:3809
17202 "It is an interface to the L<scrub(1)> program. See that manual page for "
17208 #: ../src/guestfs-actions.pod:5652 ../src/guestfs-actions.pod:5670
17209 #: ../src/guestfs-actions.pod:5689
17210 msgid "(Added in 1.0.52)"
17215 #: ../src/guestfs-actions.pod:5654
17216 msgid "guestfs_scrub_file"
17221 #: ../src/guestfs-actions.pod:5656
17225 " guestfs_scrub_file (guestfs_h *g,\n"
17226 " const char *file);\n"
17232 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3791
17234 "This command writes patterns over a file to make data retrieval more "
17240 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3794
17241 msgid "The file is I<removed> after scrubbing."
17246 #: ../src/guestfs-actions.pod:5672
17247 msgid "guestfs_scrub_freespace"
17252 #: ../src/guestfs-actions.pod:5674
17256 " guestfs_scrub_freespace (guestfs_h *g,\n"
17257 " const char *dir);\n"
17263 #: ../src/guestfs-actions.pod:5678
17265 "This command creates the directory C<dir> and then fills it with files until "
17266 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17267 "and deletes them. The intention is to scrub any free space on the partition "
17268 "containing C<dir>."
17273 #: ../src/guestfs-actions.pod:5691
17274 msgid "guestfs_set_append"
17279 #: ../src/guestfs-actions.pod:5693
17283 " guestfs_set_append (guestfs_h *g,\n"
17284 " const char *append);\n"
17290 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3818
17292 "This function is used to add additional options to the guest kernel command "
17298 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3821
17300 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17301 "environment variable."
17306 #: ../src/guestfs-actions.pod:5703 ../fish/guestfish-actions.pod:3824
17308 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17309 "(libguestfs always adds a few of its own)."
17313 #: ../src/guestfs-actions.pod:5710
17314 msgid "guestfs_set_attach_method"
17318 #: ../src/guestfs-actions.pod:5712
17322 " guestfs_set_attach_method (guestfs_h *g,\n"
17323 " const char *attachmethod);\n"
17328 #: ../src/guestfs-actions.pod:5716 ../fish/guestfish-actions.pod:3833
17330 "Set the method that libguestfs uses to connect to the back end guestfsd "
17331 "daemon. Possible methods are:"
17335 #: ../src/guestfs-actions.pod:5723 ../fish/guestfish-actions.pod:3840
17337 "Launch an appliance and connect to it. This is the ordinary method and the "
17342 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3843
17343 msgid "C<unix:I<path>>"
17347 #: ../src/guestfs-actions.pod:5728 ../fish/guestfish-actions.pod:3845
17348 msgid "Connect to the Unix domain socket I<path>."
17352 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3847
17354 "This method lets you connect to an existing daemon or (using virtio-serial) "
17355 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17356 "RUNNING DAEMONS>."
17361 #: ../src/guestfs-actions.pod:5738
17362 msgid "guestfs_set_autosync"
17367 #: ../src/guestfs-actions.pod:5740
17371 " guestfs_set_autosync (guestfs_h *g,\n"
17372 " int autosync);\n"
17377 #: ../src/guestfs-actions.pod:5744 ../fish/guestfish-actions.pod:3859
17379 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17380 "effort attempt to make filesystems consistent and synchronized when the "
17381 "handle is closed (also if the program exits without closing handles)."
17386 #: ../src/guestfs-actions.pod:5749 ../fish/guestfish-actions.pod:3864
17388 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17389 "disabled by default)."
17394 #: ../src/guestfs-actions.pod:5756
17395 msgid "guestfs_set_direct"
17400 #: ../src/guestfs-actions.pod:5758
17404 " guestfs_set_direct (guestfs_h *g,\n"
17411 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3873
17413 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17414 "passed directly through to the appliance once it is launched."
17419 #: ../src/guestfs-actions.pod:5766
17421 "One consequence of this is that log messages aren't caught by the library "
17422 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17428 #: ../src/guestfs-actions.pod:5770 ../fish/guestfish-actions.pod:3881
17429 msgid "You probably don't want to use this unless you know what you are doing."
17434 #: ../src/guestfs-actions.pod:5773 ../fish/guestfish-actions.pod:3884
17435 msgid "The default is disabled."
17440 #: ../src/guestfs-actions.pod:5779
17441 msgid "guestfs_set_e2label"
17446 #: ../src/guestfs-actions.pod:5781
17450 " guestfs_set_e2label (guestfs_h *g,\n"
17451 " const char *device,\n"
17452 " const char *label);\n"
17458 #: ../src/guestfs-actions.pod:5786 ../fish/guestfish-actions.pod:3890
17460 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17461 "C<label>. Filesystem labels are limited to 16 characters."
17466 #: ../src/guestfs-actions.pod:5790
17468 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17469 "the existing label on a filesystem."
17474 #: ../src/guestfs-actions.pod:5797
17475 msgid "guestfs_set_e2uuid"
17480 #: ../src/guestfs-actions.pod:5799
17484 " guestfs_set_e2uuid (guestfs_h *g,\n"
17485 " const char *device,\n"
17486 " const char *uuid);\n"
17492 #: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3901
17494 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17495 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17496 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17501 #: ../src/guestfs-actions.pod:5809
17503 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17504 "the existing UUID of a filesystem."
17509 #: ../src/guestfs-actions.pod:5816
17510 msgid "guestfs_set_memsize"
17515 #: ../src/guestfs-actions.pod:5818
17519 " guestfs_set_memsize (guestfs_h *g,\n"
17526 #: ../src/guestfs-actions.pod:5822
17528 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17529 "This only has any effect if called before C<guestfs_launch>."
17534 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3919
17536 "You can also change this by setting the environment variable "
17537 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17542 #: ../src/guestfs-actions.pod:5837
17543 msgid "guestfs_set_network"
17548 #: ../src/guestfs-actions.pod:5839
17552 " guestfs_set_network (guestfs_h *g,\n"
17559 #: ../src/guestfs-actions.pod:5843 ../fish/guestfish-actions.pod:3932
17561 "If C<network> is true, then the network is enabled in the libguestfs "
17562 "appliance. The default is false."
17567 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3935
17569 "This affects whether commands are able to access the network (see L<guestfs"
17570 "(3)/RUNNING COMMANDS>)."
17575 #: ../src/guestfs-actions.pod:5849
17577 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17583 #: ../src/guestfs-actions.pod:5856
17584 msgid "guestfs_set_path"
17589 #: ../src/guestfs-actions.pod:5858
17593 " guestfs_set_path (guestfs_h *g,\n"
17594 " const char *searchpath);\n"
17600 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3947
17601 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17606 #: ../src/guestfs-actions.pod:5864 ../fish/guestfish-actions.pod:3949
17608 "The default is C<$libdir/guestfs> unless overridden by setting "
17609 "C<LIBGUESTFS_PATH> environment variable."
17614 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3952
17615 msgid "Setting C<path> to C<NULL> restores the default path."
17620 #: ../src/guestfs-actions.pod:5873
17621 msgid "guestfs_set_qemu"
17626 #: ../src/guestfs-actions.pod:5875
17630 " guestfs_set_qemu (guestfs_h *g,\n"
17631 " const char *qemu);\n"
17637 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3960
17638 msgid "Set the qemu binary that we will use."
17643 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3962
17645 "The default is chosen when the library was compiled by the configure script."
17650 #: ../src/guestfs-actions.pod:5884 ../fish/guestfish-actions.pod:3965
17652 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17658 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3968
17659 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17664 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3970
17666 "Note that you should call this function as early as possible after creating "
17667 "the handle. This is because some pre-launch operations depend on testing "
17668 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17669 "don't retest features, and so you might see inconsistent results. Using the "
17670 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17671 "the qemu binary at the same time as the handle is created."
17676 #: ../src/guestfs-actions.pod:5901
17677 msgid "guestfs_set_recovery_proc"
17682 #: ../src/guestfs-actions.pod:5903
17686 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17687 " int recoveryproc);\n"
17693 #: ../src/guestfs-actions.pod:5907
17695 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17696 "not create a recovery process. The purpose of the recovery process is to "
17697 "stop runaway qemu processes in the case where the main program aborts "
17703 #: ../src/guestfs-actions.pod:5912
17705 "This only has any effect if called before C<guestfs_launch>, and the default "
17711 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3992
17713 "About the only time when you would want to disable this is if the main "
17714 "process will fork itself into the background (\"daemonize\" itself). In "
17715 "this case the recovery process thinks that the main program has disappeared "
17716 "and so kills qemu, which is not very helpful."
17721 #: ../src/guestfs-actions.pod:5925
17722 msgid "guestfs_set_selinux"
17727 #: ../src/guestfs-actions.pod:5927
17731 " guestfs_set_selinux (guestfs_h *g,\n"
17738 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:4004
17740 "This sets the selinux flag that is passed to the appliance at boot time. "
17741 "The default is C<selinux=0> (disabled)."
17746 #: ../src/guestfs-actions.pod:5934 ../fish/guestfish-actions.pod:4007
17748 "Note that if SELinux is enabled, it is always in Permissive mode "
17749 "(C<enforcing=0>)."
17754 #: ../src/guestfs-actions.pod:5944
17755 msgid "guestfs_set_trace"
17760 #: ../src/guestfs-actions.pod:5946
17764 " guestfs_set_trace (guestfs_h *g,\n"
17770 #: ../src/guestfs-actions.pod:5950 ../fish/guestfish-actions.pod:4019
17772 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17773 "return values are traced."
17778 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4022
17780 "If you want to trace C API calls into libguestfs (and other libraries) then "
17781 "possibly a better way is to use the external ltrace(1) command."
17786 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4026
17788 "Command traces are disabled unless the environment variable "
17789 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17793 #: ../src/guestfs-actions.pod:5960
17795 "Trace messages are normally sent to C<stderr>, unless you register a "
17796 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17801 #: ../src/guestfs-actions.pod:5968
17802 msgid "guestfs_set_verbose"
17807 #: ../src/guestfs-actions.pod:5970
17811 " guestfs_set_verbose (guestfs_h *g,\n"
17817 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4039
17818 msgid "If C<verbose> is true, this turns on verbose messages."
17823 #: ../src/guestfs-actions.pod:5976 ../fish/guestfish-actions.pod:4041
17825 "Verbose messages are disabled unless the environment variable "
17826 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17830 #: ../src/guestfs-actions.pod:5979
17832 "Verbose messages are normally sent to C<stderr>, unless you register a "
17833 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17838 #: ../src/guestfs-actions.pod:5987
17839 msgid "guestfs_setcon"
17844 #: ../src/guestfs-actions.pod:5989
17848 " guestfs_setcon (guestfs_h *g,\n"
17849 " const char *context);\n"
17855 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4052
17857 "This sets the SELinux security context of the daemon to the string "
17863 #: ../src/guestfs-actions.pod:5996 ../fish/guestfish-actions.pod:4055
17864 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17869 #: ../src/guestfs-actions.pod:6002
17870 msgid "guestfs_setxattr"
17875 #: ../src/guestfs-actions.pod:6004
17879 " guestfs_setxattr (guestfs_h *g,\n"
17880 " const char *xattr,\n"
17881 " const char *val,\n"
17883 " const char *path);\n"
17889 #: ../src/guestfs-actions.pod:6011 ../fish/guestfish-actions.pod:4061
17891 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17892 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17897 #: ../src/guestfs-actions.pod:6015
17898 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17903 #: ../src/guestfs-actions.pod:6021
17904 msgid "guestfs_sfdisk"
17909 #: ../src/guestfs-actions.pod:6023
17913 " guestfs_sfdisk (guestfs_h *g,\n"
17914 " const char *device,\n"
17918 " char *const *lines);\n"
17924 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4071
17926 "This is a direct interface to the L<sfdisk(8)> program for creating "
17927 "partitions on block devices."
17932 #: ../src/guestfs-actions.pod:6034 ../fish/guestfish-actions.pod:4074
17933 msgid "C<device> should be a block device, for example C</dev/sda>."
17938 #: ../src/guestfs-actions.pod:6036 ../fish/guestfish-actions.pod:4076
17940 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17941 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17942 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17943 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17944 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17945 "the kernel) cannot work out the right geometry and you will need to tell it."
17950 #: ../src/guestfs-actions.pod:6044 ../fish/guestfish-actions.pod:4084
17952 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17953 "refer to the L<sfdisk(8)> manpage."
17958 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4087
17960 "To create a single partition occupying the whole disk, you would pass "
17961 "C<lines> as a single element list, when the single element being the string "
17967 #: ../src/guestfs-actions.pod:6051
17969 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17974 #: ../src/guestfs-actions.pod:6061
17975 msgid "guestfs_sfdiskM"
17980 #: ../src/guestfs-actions.pod:6063
17984 " guestfs_sfdiskM (guestfs_h *g,\n"
17985 " const char *device,\n"
17986 " char *const *lines);\n"
17992 #: ../src/guestfs-actions.pod:6068
17994 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17995 "partition sizes are specified in megabytes only (rounded to the nearest "
17996 "cylinder) and you don't need to specify the cyls, heads and sectors "
17997 "parameters which were rarely if ever used anyway."
18002 #: ../src/guestfs-actions.pod:6074
18004 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18005 "C<guestfs_part_disk>"
18010 #: ../src/guestfs-actions.pod:6084
18011 msgid "guestfs_sfdisk_N"
18016 #: ../src/guestfs-actions.pod:6086
18020 " guestfs_sfdisk_N (guestfs_h *g,\n"
18021 " const char *device,\n"
18026 " const char *line);\n"
18032 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4117
18034 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18035 "(note: C<n> counts from 1)."
18040 #: ../src/guestfs-actions.pod:6098
18042 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18043 "for the cyls/heads/sectors parameters."
18048 #: ../src/guestfs-actions.pod:6101
18049 msgid "See also: C<guestfs_part_add>"
18054 #: ../src/guestfs-actions.pod:6110
18055 msgid "guestfs_sfdisk_disk_geometry"
18060 #: ../src/guestfs-actions.pod:6112
18064 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18065 " const char *device);\n"
18071 #: ../src/guestfs-actions.pod:6116
18073 "This displays the disk geometry of C<device> read from the partition table. "
18074 "Especially in the case where the underlying block device has been resized, "
18075 "this can be different from the kernel's idea of the geometry (see "
18076 "C<guestfs_sfdisk_kernel_geometry>)."
18081 #: ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6137
18082 #: ../fish/guestfish-actions.pod:4137 ../fish/guestfish-actions.pod:4146
18083 msgid "The result is in human-readable format, and not designed to be parsed."
18088 #: ../src/guestfs-actions.pod:6129
18089 msgid "guestfs_sfdisk_kernel_geometry"
18094 #: ../src/guestfs-actions.pod:6131
18098 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18099 " const char *device);\n"
18105 #: ../src/guestfs-actions.pod:6135 ../fish/guestfish-actions.pod:4144
18106 msgid "This displays the kernel's idea of the geometry of C<device>."
18111 #: ../src/guestfs-actions.pod:6145
18112 msgid "guestfs_sfdisk_l"
18117 #: ../src/guestfs-actions.pod:6147
18121 " guestfs_sfdisk_l (guestfs_h *g,\n"
18122 " const char *device);\n"
18128 #: ../src/guestfs-actions.pod:6151 ../fish/guestfish-actions.pod:4153
18130 "This displays the partition table on C<device>, in the human-readable output "
18131 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18136 #: ../src/guestfs-actions.pod:6155
18137 msgid "See also: C<guestfs_part_list>"
18142 #: ../src/guestfs-actions.pod:6162
18148 #: ../src/guestfs-actions.pod:6164
18152 " guestfs_sh (guestfs_h *g,\n"
18153 " const char *command);\n"
18159 #: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4163
18161 "This call runs a command from the guest filesystem via the guest's C</bin/"
18167 #: ../src/guestfs-actions.pod:6171
18168 msgid "This is like C<guestfs_command>, but passes the command to:"
18173 #: ../src/guestfs-actions.pod:6173 ../fish/guestfish-actions.pod:4168
18176 " /bin/sh -c \"command\"\n"
18182 #: ../src/guestfs-actions.pod:6175 ../fish/guestfish-actions.pod:4170
18184 "Depending on the guest's shell, this usually results in wildcards being "
18185 "expanded, shell expressions being interpolated and so on."
18190 #: ../src/guestfs-actions.pod:6179
18191 msgid "All the provisos about C<guestfs_command> apply to this call."
18196 #: ../src/guestfs-actions.pod:6186
18197 msgid "guestfs_sh_lines"
18202 #: ../src/guestfs-actions.pod:6188
18206 " guestfs_sh_lines (guestfs_h *g,\n"
18207 " const char *command);\n"
18213 #: ../src/guestfs-actions.pod:6192
18215 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18221 #: ../src/guestfs-actions.pod:6195
18222 msgid "See also: C<guestfs_command_lines>"
18227 #: ../src/guestfs-actions.pod:6203
18228 msgid "guestfs_sleep"
18233 #: ../src/guestfs-actions.pod:6205
18237 " guestfs_sleep (guestfs_h *g,\n"
18244 #: ../src/guestfs-actions.pod:6209 ../fish/guestfish-actions.pod:4189
18245 msgid "Sleep for C<secs> seconds."
18250 #: ../src/guestfs-actions.pod:6213
18251 msgid "(Added in 1.0.41)"
18256 #: ../src/guestfs-actions.pod:6215 ../src/guestfs-structs.pod:109
18257 msgid "guestfs_stat"
18262 #: ../src/guestfs-actions.pod:6217
18265 " struct guestfs_stat *\n"
18266 " guestfs_stat (guestfs_h *g,\n"
18267 " const char *path);\n"
18273 #: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4197
18274 msgid "This is the same as the C<stat(2)> system call."
18279 #: ../src/guestfs-actions.pod:6231 ../src/guestfs-structs.pod:135
18280 msgid "guestfs_statvfs"
18285 #: ../src/guestfs-actions.pod:6233
18288 " struct guestfs_statvfs *\n"
18289 " guestfs_statvfs (guestfs_h *g,\n"
18290 " const char *path);\n"
18296 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4203
18298 "Returns file system statistics for any mounted file system. C<path> should "
18299 "be a file or directory in the mounted file system (typically it is the mount "
18300 "point itself, but it doesn't need to be)."
18305 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4207
18306 msgid "This is the same as the C<statvfs(2)> system call."
18311 #: ../src/guestfs-actions.pod:6243
18313 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18314 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18319 #: ../src/guestfs-actions.pod:6249
18320 msgid "guestfs_strings"
18325 #: ../src/guestfs-actions.pod:6251
18329 " guestfs_strings (guestfs_h *g,\n"
18330 " const char *path);\n"
18336 #: ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4213
18338 "This runs the L<strings(1)> command on a file and returns the list of "
18339 "printable strings found."
18344 #: ../src/guestfs-actions.pod:6267
18345 msgid "guestfs_strings_e"
18350 #: ../src/guestfs-actions.pod:6269
18354 " guestfs_strings_e (guestfs_h *g,\n"
18355 " const char *encoding,\n"
18356 " const char *path);\n"
18362 #: ../src/guestfs-actions.pod:6274
18364 "This is like the C<guestfs_strings> command, but allows you to specify the "
18365 "encoding of strings that are looked for in the source file C<path>."
18370 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4227
18371 msgid "Allowed encodings are:"
18376 #: ../src/guestfs-actions.pod:6282 ../fish/guestfish-actions.pod:4231
18382 #: ../src/guestfs-actions.pod:6284
18384 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18385 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18390 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4236
18396 #: ../src/guestfs-actions.pod:6289 ../fish/guestfish-actions.pod:4238
18397 msgid "Single 8-bit-byte characters."
18402 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4240
18408 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4242
18409 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18414 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4245
18415 msgid "l (lower case letter L)"
18420 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4247
18422 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18423 "examining binaries in Windows guests."
18428 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4250
18434 #: ../src/guestfs-actions.pod:6303 ../fish/guestfish-actions.pod:4252
18435 msgid "32-bit big endian such as UCS-4BE."
18440 #: ../src/guestfs-actions.pod:6305 ../fish/guestfish-actions.pod:4254
18446 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4256
18447 msgid "32-bit little endian such as UCS-4LE."
18452 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4260
18453 msgid "The returned strings are transcoded to UTF-8."
18458 #: ../src/guestfs-actions.pod:6322
18459 msgid "guestfs_swapoff_device"
18464 #: ../src/guestfs-actions.pod:6324
18468 " guestfs_swapoff_device (guestfs_h *g,\n"
18469 " const char *device);\n"
18475 #: ../src/guestfs-actions.pod:6328
18477 "This command disables the libguestfs appliance swap device or partition "
18478 "named C<device>. See C<guestfs_swapon_device>."
18483 #: ../src/guestfs-actions.pod:6336
18484 msgid "guestfs_swapoff_file"
18489 #: ../src/guestfs-actions.pod:6338
18493 " guestfs_swapoff_file (guestfs_h *g,\n"
18494 " const char *file);\n"
18500 #: ../src/guestfs-actions.pod:6342 ../fish/guestfish-actions.pod:4277
18501 msgid "This command disables the libguestfs appliance swap on file."
18506 #: ../src/guestfs-actions.pod:6348
18507 msgid "guestfs_swapoff_label"
18512 #: ../src/guestfs-actions.pod:6350
18516 " guestfs_swapoff_label (guestfs_h *g,\n"
18517 " const char *label);\n"
18523 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4283
18525 "This command disables the libguestfs appliance swap on labeled swap "
18531 #: ../src/guestfs-actions.pod:6361
18532 msgid "guestfs_swapoff_uuid"
18537 #: ../src/guestfs-actions.pod:6363
18541 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18542 " const char *uuid);\n"
18548 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4290
18550 "This command disables the libguestfs appliance swap partition with the given "
18556 #: ../src/guestfs-actions.pod:6374
18557 msgid "guestfs_swapon_device"
18562 #: ../src/guestfs-actions.pod:6376
18566 " guestfs_swapon_device (guestfs_h *g,\n"
18567 " const char *device);\n"
18573 #: ../src/guestfs-actions.pod:6380
18575 "This command enables the libguestfs appliance to use the swap device or "
18576 "partition named C<device>. The increased memory is made available for all "
18577 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18582 #: ../src/guestfs-actions.pod:6385 ../fish/guestfish-actions.pod:4302
18584 "Note that you should not swap to existing guest swap partitions unless you "
18585 "know what you are doing. They may contain hibernation information, or other "
18586 "information that the guest doesn't want you to trash. You also risk leaking "
18587 "information about the host to the guest this way. Instead, attach a new "
18588 "host device to the guest and swap on that."
18593 #: ../src/guestfs-actions.pod:6396
18594 msgid "guestfs_swapon_file"
18599 #: ../src/guestfs-actions.pod:6398
18603 " guestfs_swapon_file (guestfs_h *g,\n"
18604 " const char *file);\n"
18610 #: ../src/guestfs-actions.pod:6402
18612 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18618 #: ../src/guestfs-actions.pod:6409
18619 msgid "guestfs_swapon_label"
18624 #: ../src/guestfs-actions.pod:6411
18628 " guestfs_swapon_label (guestfs_h *g,\n"
18629 " const char *label);\n"
18635 #: ../src/guestfs-actions.pod:6415
18637 "This command enables swap to a labeled swap partition. See "
18638 "C<guestfs_swapon_device> for other notes."
18643 #: ../src/guestfs-actions.pod:6422
18644 msgid "guestfs_swapon_uuid"
18649 #: ../src/guestfs-actions.pod:6424
18653 " guestfs_swapon_uuid (guestfs_h *g,\n"
18654 " const char *uuid);\n"
18660 #: ../src/guestfs-actions.pod:6428
18662 "This command enables swap to a swap partition with the given UUID. See "
18663 "C<guestfs_swapon_device> for other notes."
18668 #: ../src/guestfs-actions.pod:6435
18669 msgid "guestfs_sync"
18674 #: ../src/guestfs-actions.pod:6437
18678 " guestfs_sync (guestfs_h *g);\n"
18684 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4334
18686 "This syncs the disk, so that any writes are flushed through to the "
18687 "underlying disk image."
18692 #: ../src/guestfs-actions.pod:6443 ../fish/guestfish-actions.pod:4337
18694 "You should always call this if you have modified a disk image, before "
18695 "closing the handle."
18700 #: ../src/guestfs-actions.pod:6450
18701 msgid "guestfs_tail"
18706 #: ../src/guestfs-actions.pod:6452
18710 " guestfs_tail (guestfs_h *g,\n"
18711 " const char *path);\n"
18717 #: ../src/guestfs-actions.pod:6456 ../fish/guestfish-actions.pod:4344
18719 "This command returns up to the last 10 lines of a file as a list of strings."
18724 #: ../src/guestfs-actions.pod:6468
18725 msgid "guestfs_tail_n"
18730 #: ../src/guestfs-actions.pod:6470
18734 " guestfs_tail_n (guestfs_h *g,\n"
18736 " const char *path);\n"
18742 #: ../src/guestfs-actions.pod:6475 ../fish/guestfish-actions.pod:4354
18744 "If the parameter C<nrlines> is a positive number, this returns the last "
18745 "C<nrlines> lines of the file C<path>."
18750 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4357
18752 "If the parameter C<nrlines> is a negative number, this returns lines from "
18753 "the file C<path>, starting with the C<-nrlines>th line."
18758 #: ../src/guestfs-actions.pod:6492
18759 msgid "guestfs_tar_in"
18764 #: ../src/guestfs-actions.pod:6494
18768 " guestfs_tar_in (guestfs_h *g,\n"
18769 " const char *tarfile,\n"
18770 " const char *directory);\n"
18776 #: ../src/guestfs-actions.pod:6499 ../fish/guestfish-actions.pod:4369
18778 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18779 "tar file) into C<directory>."
18784 #: ../src/guestfs-actions.pod:6502
18786 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18791 #: ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:6524
18792 #: ../src/guestfs-actions.pod:6540 ../src/guestfs-actions.pod:6556
18793 msgid "(Added in 1.0.3)"
18798 #: ../src/guestfs-actions.pod:6509
18799 msgid "guestfs_tar_out"
18804 #: ../src/guestfs-actions.pod:6511
18808 " guestfs_tar_out (guestfs_h *g,\n"
18809 " const char *directory,\n"
18810 " const char *tarfile);\n"
18816 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4381
18818 "This command packs the contents of C<directory> and downloads it to local "
18824 #: ../src/guestfs-actions.pod:6519
18826 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18827 "C<guestfs_txz_out>."
18832 #: ../src/guestfs-actions.pod:6526
18833 msgid "guestfs_tgz_in"
18838 #: ../src/guestfs-actions.pod:6528
18842 " guestfs_tgz_in (guestfs_h *g,\n"
18843 " const char *tarball,\n"
18844 " const char *directory);\n"
18850 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4393
18852 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18853 "tar file) into C<directory>."
18858 #: ../src/guestfs-actions.pod:6536
18859 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18864 #: ../src/guestfs-actions.pod:6542
18865 msgid "guestfs_tgz_out"
18870 #: ../src/guestfs-actions.pod:6544
18874 " guestfs_tgz_out (guestfs_h *g,\n"
18875 " const char *directory,\n"
18876 " const char *tarball);\n"
18882 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4404
18884 "This command packs the contents of C<directory> and downloads it to local "
18890 #: ../src/guestfs-actions.pod:6552
18891 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18896 #: ../src/guestfs-actions.pod:6558
18897 msgid "guestfs_touch"
18902 #: ../src/guestfs-actions.pod:6560
18906 " guestfs_touch (guestfs_h *g,\n"
18907 " const char *path);\n"
18913 #: ../src/guestfs-actions.pod:6564 ../fish/guestfish-actions.pod:4415
18915 "Touch acts like the L<touch(1)> command. It can be used to update the "
18916 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18922 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4419
18924 "This command only works on regular files, and will fail on other file types "
18925 "such as directories, symbolic links, block special etc."
18930 #: ../src/guestfs-actions.pod:6575
18931 msgid "guestfs_truncate"
18936 #: ../src/guestfs-actions.pod:6577
18940 " guestfs_truncate (guestfs_h *g,\n"
18941 " const char *path);\n"
18947 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4426
18949 "This command truncates C<path> to a zero-length file. The file must exist "
18955 #: ../src/guestfs-actions.pod:6588
18956 msgid "guestfs_truncate_size"
18961 #: ../src/guestfs-actions.pod:6590
18965 " guestfs_truncate_size (guestfs_h *g,\n"
18966 " const char *path,\n"
18967 " int64_t size);\n"
18973 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4433
18975 "This command truncates C<path> to size C<size> bytes. The file must exist "
18981 #: ../src/guestfs-actions.pod:6598
18983 "If the current file size is less than C<size> then the file is extended to "
18984 "the required size with zero bytes. This creates a sparse file (ie. disk "
18985 "blocks are not allocated for the file until you write to it). To create a "
18986 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18991 #: ../src/guestfs-actions.pod:6608
18992 msgid "guestfs_tune2fs_l"
18997 #: ../src/guestfs-actions.pod:6610
19001 " guestfs_tune2fs_l (guestfs_h *g,\n"
19002 " const char *device);\n"
19008 #: ../src/guestfs-actions.pod:6614 ../fish/guestfish-actions.pod:4446
19010 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19016 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4449
19018 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19019 "for more details. The list of fields returned isn't clearly defined, and "
19020 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19021 "and the filesystem itself."
19026 #: ../src/guestfs-actions.pod:6630
19027 msgid "guestfs_txz_in"
19032 #: ../src/guestfs-actions.pod:6632
19036 " guestfs_txz_in (guestfs_h *g,\n"
19037 " const char *tarball,\n"
19038 " const char *directory);\n"
19044 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4458
19046 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19047 "tar file) into C<directory>."
19052 #: ../src/guestfs-actions.pod:6644
19053 msgid "guestfs_txz_out"
19058 #: ../src/guestfs-actions.pod:6646
19062 " guestfs_txz_out (guestfs_h *g,\n"
19063 " const char *directory,\n"
19064 " const char *tarball);\n"
19070 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4467
19072 "This command packs the contents of C<directory> and downloads it to local "
19073 "file C<tarball> (as an xz compressed tar archive)."
19078 #: ../src/guestfs-actions.pod:6658
19079 msgid "guestfs_umask"
19084 #: ../src/guestfs-actions.pod:6660
19088 " guestfs_umask (guestfs_h *g,\n"
19095 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4476
19097 "This function sets the mask used for creating new files and device nodes to "
19103 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4479
19105 "Typical umask values would be C<022> which creates new files with "
19106 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19107 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19112 #: ../src/guestfs-actions.pod:6672 ../fish/guestfish-actions.pod:4484
19114 "The default umask is C<022>. This is important because it means that "
19115 "directories and device nodes will be created with C<0644> or C<0755> mode "
19116 "even if you specify C<0777>."
19121 #: ../src/guestfs-actions.pod:6676
19123 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19124 "C<guestfs_mkdir>."
19129 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4491
19130 msgid "This call returns the previous umask."
19135 #: ../src/guestfs-actions.pod:6685
19136 msgid "guestfs_umount"
19141 #: ../src/guestfs-actions.pod:6687
19145 " guestfs_umount (guestfs_h *g,\n"
19146 " const char *pathordevice);\n"
19152 #: ../src/guestfs-actions.pod:6691 ../fish/guestfish-actions.pod:4499
19154 "This unmounts the given filesystem. The filesystem may be specified either "
19155 "by its mountpoint (path) or the device which contains the filesystem."
19160 #: ../src/guestfs-actions.pod:6699
19161 msgid "guestfs_umount_all"
19166 #: ../src/guestfs-actions.pod:6701
19170 " guestfs_umount_all (guestfs_h *g);\n"
19176 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4509
19177 msgid "This unmounts all mounted filesystems."
19182 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4511
19183 msgid "Some internal mounts are not unmounted by this call."
19188 #: ../src/guestfs-actions.pod:6712
19189 msgid "guestfs_upload"
19194 #: ../src/guestfs-actions.pod:6714
19198 " guestfs_upload (guestfs_h *g,\n"
19199 " const char *filename,\n"
19200 " const char *remotefilename);\n"
19206 #: ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:6743
19207 #: ../fish/guestfish-actions.pod:4517 ../fish/guestfish-actions.pod:4530
19208 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19213 #: ../src/guestfs-actions.pod:6724
19214 msgid "See also C<guestfs_download>."
19219 #: ../src/guestfs-actions.pod:6735
19220 msgid "guestfs_upload_offset"
19225 #: ../src/guestfs-actions.pod:6737
19229 " guestfs_upload_offset (guestfs_h *g,\n"
19230 " const char *filename,\n"
19231 " const char *remotefilename,\n"
19232 " int64_t offset);\n"
19238 #: ../src/guestfs-actions.pod:6746 ../fish/guestfish-actions.pod:4533
19240 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19241 "The intention is to overwrite parts of existing files or devices, although "
19242 "if a non-existant file is specified then it is created with a \"hole\" "
19243 "before C<offset>. The size of the data written is implicit in the size of "
19244 "the source C<filename>."
19249 #: ../src/guestfs-actions.pod:6753
19251 "Note that there is no limit on the amount of data that can be uploaded with "
19252 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19253 "full amount unless an error occurs."
19258 #: ../src/guestfs-actions.pod:6758
19259 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19264 #: ../src/guestfs-actions.pod:6769
19265 msgid "guestfs_utimens"
19270 #: ../src/guestfs-actions.pod:6771
19274 " guestfs_utimens (guestfs_h *g,\n"
19275 " const char *path,\n"
19276 " int64_t atsecs,\n"
19277 " int64_t atnsecs,\n"
19278 " int64_t mtsecs,\n"
19279 " int64_t mtnsecs);\n"
19285 #: ../src/guestfs-actions.pod:6779 ../fish/guestfish-actions.pod:4553
19286 msgid "This command sets the timestamps of a file with nanosecond precision."
19291 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4556
19293 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19299 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4559
19301 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19302 "nanoseconds from the epoch."
19307 #: ../src/guestfs-actions.pod:6788 ../fish/guestfish-actions.pod:4562
19309 "If the C<*nsecs> field contains the special value C<-1> then the "
19310 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19311 "ignored in this case)."
19316 #: ../src/guestfs-actions.pod:6792 ../fish/guestfish-actions.pod:4566
19318 "If the C<*nsecs> field contains the special value C<-2> then the "
19319 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19325 #: ../src/guestfs-actions.pod:6800 ../src/guestfs-structs.pod:175
19326 msgid "guestfs_version"
19331 #: ../src/guestfs-actions.pod:6802
19334 " struct guestfs_version *\n"
19335 " guestfs_version (guestfs_h *g);\n"
19341 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4574
19343 "Return the libguestfs version number that the program is linked against."
19348 #: ../src/guestfs-actions.pod:6808 ../fish/guestfish-actions.pod:4577
19350 "Note that because of dynamic linking this is not necessarily the version of "
19351 "libguestfs that you compiled against. You can compile the program, and then "
19352 "at runtime dynamically link against a completely different C<libguestfs.so> "
19358 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4582
19360 "This call was added in version C<1.0.58>. In previous versions of "
19361 "libguestfs there was no way to get the version number. From C code you can "
19362 "use dynamic linker functions to find out if this symbol exists (if it "
19363 "doesn't, then it's an earlier version)."
19368 #: ../src/guestfs-actions.pod:6819 ../fish/guestfish-actions.pod:4588
19370 "The call returns a structure with four elements. The first three (C<major>, "
19371 "C<minor> and C<release>) are numbers and correspond to the usual version "
19372 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19373 "but may be used for distro-specific information."
19378 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4594
19380 "To construct the original version string: C<$major.$minor.$release$extra>"
19385 #: ../src/guestfs-actions.pod:6828 ../fish/guestfish-actions.pod:4597
19386 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19391 #: ../src/guestfs-actions.pod:6830
19393 "I<Note:> Don't use this call to test for availability of features. In "
19394 "enterprise distributions we backport features from later versions into "
19395 "earlier versions, making this an unreliable way to test for features. Use "
19396 "C<guestfs_available> instead."
19401 #: ../src/guestfs-actions.pod:6836
19403 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19404 "error. I<The caller must call C<guestfs_free_version> after use>."
19409 #: ../src/guestfs-actions.pod:6840
19410 msgid "(Added in 1.0.58)"
19415 #: ../src/guestfs-actions.pod:6842
19416 msgid "guestfs_vfs_label"
19421 #: ../src/guestfs-actions.pod:6844
19425 " guestfs_vfs_label (guestfs_h *g,\n"
19426 " const char *device);\n"
19432 #: ../src/guestfs-actions.pod:6848 ../fish/guestfish-actions.pod:4609
19433 msgid "This returns the filesystem label of the filesystem on C<device>."
19438 #: ../src/guestfs-actions.pod:6851 ../fish/guestfish-actions.pod:4612
19439 msgid "If the filesystem is unlabeled, this returns the empty string."
19444 #: ../src/guestfs-actions.pod:6853
19445 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19450 #: ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:6895
19451 msgid "(Added in 1.3.18)"
19456 #: ../src/guestfs-actions.pod:6860
19457 msgid "guestfs_vfs_type"
19462 #: ../src/guestfs-actions.pod:6862
19466 " guestfs_vfs_type (guestfs_h *g,\n"
19467 " const char *device);\n"
19473 #: ../src/guestfs-actions.pod:6866 ../fish/guestfish-actions.pod:4620
19475 "This command gets the filesystem type corresponding to the filesystem on "
19481 #: ../src/guestfs-actions.pod:6869 ../fish/guestfish-actions.pod:4623
19483 "For most filesystems, the result is the name of the Linux VFS module which "
19484 "would be used to mount this filesystem if you mounted it without specifying "
19485 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19490 #: ../src/guestfs-actions.pod:6879
19491 msgid "guestfs_vfs_uuid"
19496 #: ../src/guestfs-actions.pod:6881
19500 " guestfs_vfs_uuid (guestfs_h *g,\n"
19501 " const char *device);\n"
19507 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4632
19508 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19513 #: ../src/guestfs-actions.pod:6888 ../fish/guestfish-actions.pod:4635
19514 msgid "If the filesystem does not have a UUID, this returns the empty string."
19519 #: ../src/guestfs-actions.pod:6890
19520 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19525 #: ../src/guestfs-actions.pod:6897
19526 msgid "guestfs_vg_activate"
19531 #: ../src/guestfs-actions.pod:6899
19535 " guestfs_vg_activate (guestfs_h *g,\n"
19537 " char *const *volgroups);\n"
19543 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4643
19545 "This command activates or (if C<activate> is false) deactivates all logical "
19546 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19547 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19548 "deactivated, then those devices disappear."
19553 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4649
19554 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19559 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4651
19561 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19562 "activated or deactivated."
19567 #: ../src/guestfs-actions.pod:6919
19568 msgid "guestfs_vg_activate_all"
19573 #: ../src/guestfs-actions.pod:6921
19577 " guestfs_vg_activate_all (guestfs_h *g,\n"
19578 " int activate);\n"
19584 #: ../src/guestfs-actions.pod:6925 ../fish/guestfish-actions.pod:4658
19586 "This command activates or (if C<activate> is false) deactivates all logical "
19587 "volumes in all volume groups. If activated, then they are made known to the "
19588 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19589 "those devices disappear."
19594 #: ../src/guestfs-actions.pod:6931 ../fish/guestfish-actions.pod:4664
19595 msgid "This command is the same as running C<vgchange -a y|n>"
19600 #: ../src/guestfs-actions.pod:6937
19601 msgid "guestfs_vgcreate"
19606 #: ../src/guestfs-actions.pod:6939
19610 " guestfs_vgcreate (guestfs_h *g,\n"
19611 " const char *volgroup,\n"
19612 " char *const *physvols);\n"
19618 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4670
19620 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19621 "of physical volumes C<physvols>."
19626 #: ../src/guestfs-actions.pod:6951
19627 msgid "guestfs_vglvuuids"
19632 #: ../src/guestfs-actions.pod:6953
19636 " guestfs_vglvuuids (guestfs_h *g,\n"
19637 " const char *vgname);\n"
19643 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4677
19645 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19646 "volumes created in this volume group."
19651 #: ../src/guestfs-actions.pod:6960
19653 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19654 "associate logical volumes and volume groups."
19659 #: ../src/guestfs-actions.pod:6963
19660 msgid "See also C<guestfs_vgpvuuids>."
19665 #: ../src/guestfs-actions.pod:6971
19666 msgid "guestfs_vgpvuuids"
19671 #: ../src/guestfs-actions.pod:6973
19675 " guestfs_vgpvuuids (guestfs_h *g,\n"
19676 " const char *vgname);\n"
19682 #: ../src/guestfs-actions.pod:6977 ../fish/guestfish-actions.pod:4689
19684 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19685 "volumes that this volume group resides on."
19690 #: ../src/guestfs-actions.pod:6980
19692 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
19693 "associate physical volumes and volume groups."
19698 #: ../src/guestfs-actions.pod:6983
19699 msgid "See also C<guestfs_vglvuuids>."
19704 #: ../src/guestfs-actions.pod:6991
19705 msgid "guestfs_vgremove"
19710 #: ../src/guestfs-actions.pod:6993
19714 " guestfs_vgremove (guestfs_h *g,\n"
19715 " const char *vgname);\n"
19721 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4701
19722 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19727 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4703
19729 "This also forcibly removes all logical volumes in the volume group (if any)."
19734 #: ../src/guestfs-actions.pod:7006
19735 msgid "guestfs_vgrename"
19740 #: ../src/guestfs-actions.pod:7008
19744 " guestfs_vgrename (guestfs_h *g,\n"
19745 " const char *volgroup,\n"
19746 " const char *newvolgroup);\n"
19752 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4710
19753 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19758 #: ../src/guestfs-actions.pod:7019
19759 msgid "guestfs_vgs"
19764 #: ../src/guestfs-actions.pod:7021
19768 " guestfs_vgs (guestfs_h *g);\n"
19774 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4716
19776 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19782 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4719
19784 "This returns a list of just the volume group names that were detected (eg. "
19790 #: ../src/guestfs-actions.pod:7030
19791 msgid "See also C<guestfs_vgs_full>."
19796 #: ../src/guestfs-actions.pod:7038
19797 msgid "guestfs_vgs_full"
19802 #: ../src/guestfs-actions.pod:7040
19805 " struct guestfs_lvm_vg_list *\n"
19806 " guestfs_vgs_full (guestfs_h *g);\n"
19812 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4728
19814 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19815 "> command. The \"full\" version includes all fields."
19820 #: ../src/guestfs-actions.pod:7046
19822 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
19823 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
19828 #: ../src/guestfs-actions.pod:7052
19829 msgid "guestfs_vgscan"
19834 #: ../src/guestfs-actions.pod:7054
19838 " guestfs_vgscan (guestfs_h *g);\n"
19844 #: ../src/guestfs-actions.pod:7057 ../fish/guestfish-actions.pod:4735
19846 "This rescans all block devices and rebuilds the list of LVM physical "
19847 "volumes, volume groups and logical volumes."
19852 #: ../src/guestfs-actions.pod:7064
19853 msgid "guestfs_vguuid"
19858 #: ../src/guestfs-actions.pod:7066
19862 " guestfs_vguuid (guestfs_h *g,\n"
19863 " const char *vgname);\n"
19869 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4742
19870 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19875 #: ../src/guestfs-actions.pod:7077
19876 msgid "guestfs_wait_ready"
19881 #: ../src/guestfs-actions.pod:7079
19885 " guestfs_wait_ready (guestfs_h *g);\n"
19891 #: ../src/guestfs-actions.pod:7082
19892 msgid "This function is a no op."
19897 #: ../src/guestfs-actions.pod:7084
19899 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19900 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19901 "is no longer necessary because C<guestfs_launch> now does the waiting."
19906 #: ../src/guestfs-actions.pod:7089
19908 "If you see any calls to this function in code then you can just remove them, "
19909 "unless you want to retain compatibility with older versions of the API."
19914 #: ../src/guestfs-actions.pod:7097
19915 msgid "guestfs_wc_c"
19920 #: ../src/guestfs-actions.pod:7099
19924 " guestfs_wc_c (guestfs_h *g,\n"
19925 " const char *path);\n"
19931 #: ../src/guestfs-actions.pod:7103 ../fish/guestfish-actions.pod:4748
19933 "This command counts the characters in a file, using the C<wc -c> external "
19939 #: ../src/guestfs-actions.pod:7110
19940 msgid "guestfs_wc_l"
19945 #: ../src/guestfs-actions.pod:7112
19949 " guestfs_wc_l (guestfs_h *g,\n"
19950 " const char *path);\n"
19956 #: ../src/guestfs-actions.pod:7116 ../fish/guestfish-actions.pod:4755
19958 "This command counts the lines in a file, using the C<wc -l> external command."
19963 #: ../src/guestfs-actions.pod:7123
19964 msgid "guestfs_wc_w"
19969 #: ../src/guestfs-actions.pod:7125
19973 " guestfs_wc_w (guestfs_h *g,\n"
19974 " const char *path);\n"
19980 #: ../src/guestfs-actions.pod:7129 ../fish/guestfish-actions.pod:4762
19982 "This command counts the words in a file, using the C<wc -w> external command."
19987 #: ../src/guestfs-actions.pod:7136
19988 msgid "guestfs_write"
19993 #: ../src/guestfs-actions.pod:7138
19997 " guestfs_write (guestfs_h *g,\n"
19998 " const char *path,\n"
19999 " const char *content,\n"
20000 " size_t content_size);\n"
20006 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4769
20008 "This call creates a file called C<path>. The content of the file is the "
20009 "string C<content> (which can contain any 8 bit data)."
20014 #: ../src/guestfs-actions.pod:7154
20015 msgid "guestfs_write_file"
20020 #: ../src/guestfs-actions.pod:7156
20024 " guestfs_write_file (guestfs_h *g,\n"
20025 " const char *path,\n"
20026 " const char *content,\n"
20033 #: ../src/guestfs-actions.pod:7162 ../fish/guestfish-actions.pod:4779
20035 "This call creates a file called C<path>. The contents of the file is the "
20036 "string C<content> (which can contain any 8 bit data), with length C<size>."
20041 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4783
20043 "As a special case, if C<size> is C<0> then the length is calculated using "
20044 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20049 #: ../src/guestfs-actions.pod:7170 ../fish/guestfish-actions.pod:4787
20051 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20052 "I<not> work, even if the length is specified."
20057 #: ../src/guestfs-actions.pod:7178 ../fish/guestfish-actions.pod:4793
20059 "This function is deprecated. In new code, use the C<write> call instead."
20064 #: ../src/guestfs-actions.pod:7187
20065 msgid "guestfs_zegrep"
20070 #: ../src/guestfs-actions.pod:7189
20074 " guestfs_zegrep (guestfs_h *g,\n"
20075 " const char *regex,\n"
20076 " const char *path);\n"
20082 #: ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:4804
20084 "This calls the external C<zegrep> program and returns the matching lines."
20089 #: ../src/guestfs-actions.pod:7206
20090 msgid "guestfs_zegrepi"
20095 #: ../src/guestfs-actions.pod:7208
20099 " guestfs_zegrepi (guestfs_h *g,\n"
20100 " const char *regex,\n"
20101 " const char *path);\n"
20107 #: ../src/guestfs-actions.pod:7213 ../fish/guestfish-actions.pod:4814
20109 "This calls the external C<zegrep -i> program and returns the matching lines."
20114 #: ../src/guestfs-actions.pod:7225
20115 msgid "guestfs_zero"
20120 #: ../src/guestfs-actions.pod:7227
20124 " guestfs_zero (guestfs_h *g,\n"
20125 " const char *device);\n"
20131 #: ../src/guestfs-actions.pod:7231 ../fish/guestfish-actions.pod:4824
20132 msgid "This command writes zeroes over the first few blocks of C<device>."
20137 #: ../src/guestfs-actions.pod:7233 ../fish/guestfish-actions.pod:4826
20139 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20140 "securely wipe the device). It should be sufficient to remove any partition "
20141 "tables, filesystem superblocks and so on."
20146 #: ../src/guestfs-actions.pod:7237
20147 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20152 #: ../src/guestfs-actions.pod:7248
20153 msgid "guestfs_zero_device"
20158 #: ../src/guestfs-actions.pod:7250
20162 " guestfs_zero_device (guestfs_h *g,\n"
20163 " const char *device);\n"
20169 #: ../src/guestfs-actions.pod:7254
20171 "This command writes zeroes over the entire C<device>. Compare with "
20172 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20177 #: ../src/guestfs-actions.pod:7268
20178 msgid "(Added in 1.3.1)"
20183 #: ../src/guestfs-actions.pod:7270
20184 msgid "guestfs_zerofree"
20189 #: ../src/guestfs-actions.pod:7272
20193 " guestfs_zerofree (guestfs_h *g,\n"
20194 " const char *device);\n"
20200 #: ../src/guestfs-actions.pod:7276 ../fish/guestfish-actions.pod:4847
20202 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20203 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20204 "possible to compress the filesystem more effectively."
20209 #: ../src/guestfs-actions.pod:7281 ../fish/guestfish-actions.pod:4852
20210 msgid "You should B<not> run this program if the filesystem is mounted."
20215 #: ../src/guestfs-actions.pod:7284 ../fish/guestfish-actions.pod:4855
20217 "It is possible that using this program can damage the filesystem or data on "
20223 #: ../src/guestfs-actions.pod:7291
20224 msgid "guestfs_zfgrep"
20229 #: ../src/guestfs-actions.pod:7293
20233 " guestfs_zfgrep (guestfs_h *g,\n"
20234 " const char *pattern,\n"
20235 " const char *path);\n"
20241 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4862
20243 "This calls the external C<zfgrep> program and returns the matching lines."
20248 #: ../src/guestfs-actions.pod:7310
20249 msgid "guestfs_zfgrepi"
20254 #: ../src/guestfs-actions.pod:7312
20258 " guestfs_zfgrepi (guestfs_h *g,\n"
20259 " const char *pattern,\n"
20260 " const char *path);\n"
20266 #: ../src/guestfs-actions.pod:7317 ../fish/guestfish-actions.pod:4872
20268 "This calls the external C<zfgrep -i> program and returns the matching lines."
20273 #: ../src/guestfs-actions.pod:7329
20274 msgid "guestfs_zfile"
20279 #: ../src/guestfs-actions.pod:7331
20283 " guestfs_zfile (guestfs_h *g,\n"
20284 " const char *meth,\n"
20285 " const char *path);\n"
20291 #: ../src/guestfs-actions.pod:7336 ../fish/guestfish-actions.pod:4882
20293 "This command runs C<file> after first decompressing C<path> using C<method>."
20298 #: ../src/guestfs-actions.pod:7339 ../fish/guestfish-actions.pod:4885
20299 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20304 #: ../src/guestfs-actions.pod:7341
20306 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20312 #: ../src/guestfs-actions.pod:7347 ../fish/guestfish-actions.pod:4890
20314 "This function is deprecated. In new code, use the C<file> call instead."
20319 #: ../src/guestfs-actions.pod:7356
20320 msgid "guestfs_zgrep"
20325 #: ../src/guestfs-actions.pod:7358
20329 " guestfs_zgrep (guestfs_h *g,\n"
20330 " const char *regex,\n"
20331 " const char *path);\n"
20337 #: ../src/guestfs-actions.pod:7363 ../fish/guestfish-actions.pod:4901
20339 "This calls the external C<zgrep> program and returns the matching lines."
20344 #: ../src/guestfs-actions.pod:7375
20345 msgid "guestfs_zgrepi"
20350 #: ../src/guestfs-actions.pod:7377
20354 " guestfs_zgrepi (guestfs_h *g,\n"
20355 " const char *regex,\n"
20356 " const char *path);\n"
20362 #: ../src/guestfs-actions.pod:7382 ../fish/guestfish-actions.pod:4911
20364 "This calls the external C<zgrep -i> program and returns the matching lines."
20369 #: ../src/guestfs-availability.pod:3
20375 #: ../src/guestfs-availability.pod:5
20377 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20378 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20379 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20380 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20381 "L</guestfs_aug_save> L</guestfs_aug_set>"
20386 #: ../src/guestfs-availability.pod:21
20392 #: ../src/guestfs-availability.pod:23
20394 "The following functions: L</guestfs_inotify_add_watch> L</"
20395 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20396 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20401 #: ../src/guestfs-availability.pod:31
20402 msgid "B<linuxfsuuid>"
20407 #: ../src/guestfs-availability.pod:33
20409 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20410 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20415 #: ../src/guestfs-availability.pod:40
20416 msgid "B<linuxmodules>"
20421 #: ../src/guestfs-availability.pod:42
20422 msgid "The following functions: L</guestfs_modprobe>"
20427 #: ../src/guestfs-availability.pod:45
20428 msgid "B<linuxxattrs>"
20433 #: ../src/guestfs-availability.pod:47
20435 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20436 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20437 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20438 "guestfs_setxattr>"
20443 #: ../src/guestfs-availability.pod:58
20449 #: ../src/guestfs-availability.pod:60
20451 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20452 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20453 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20458 #: ../src/guestfs-availability.pod:69
20464 #: ../src/guestfs-availability.pod:71
20466 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20467 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20468 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20469 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20470 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20471 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20472 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20477 #: ../src/guestfs-availability.pod:94
20483 #: ../src/guestfs-availability.pod:96
20485 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20486 "guestfs_mknod_b> L</guestfs_mknod_c>"
20491 #: ../src/guestfs-availability.pod:102
20497 #: ../src/guestfs-availability.pod:104
20498 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20503 #: ../src/guestfs-availability.pod:107
20504 msgid "B<ntfsprogs>"
20509 #: ../src/guestfs-availability.pod:109
20511 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20516 #: ../src/guestfs-availability.pod:113
20517 msgid "B<realpath>"
20522 #: ../src/guestfs-availability.pod:115
20523 msgid "The following functions: L</guestfs_realpath>"
20528 #: ../src/guestfs-availability.pod:118
20534 #: ../src/guestfs-availability.pod:120
20536 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20537 "guestfs_scrub_freespace>"
20542 #: ../src/guestfs-availability.pod:125
20548 #: ../src/guestfs-availability.pod:127
20549 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20554 #: ../src/guestfs-availability.pod:131
20560 #: ../src/guestfs-availability.pod:133
20561 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20566 #: ../src/guestfs-availability.pod:137
20567 msgid "B<zerofree>"
20572 #: ../src/guestfs-availability.pod:139
20573 msgid "The following functions: L</guestfs_zerofree>"
20578 #: ../src/guestfs-structs.pod:1
20579 msgid "guestfs_int_bool"
20584 #: ../src/guestfs-structs.pod:3
20587 " struct guestfs_int_bool {\n"
20596 #: ../src/guestfs-structs.pod:8
20599 " struct guestfs_int_bool_list {\n"
20600 " uint32_t len; /* Number of elements in list. */\n"
20601 " struct guestfs_int_bool *val; /* Elements. */\n"
20608 #: ../src/guestfs-structs.pod:13
20611 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20612 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20618 #: ../src/guestfs-structs.pod:16
20619 msgid "guestfs_lvm_pv"
20624 #: ../src/guestfs-structs.pod:18
20627 " struct guestfs_lvm_pv {\n"
20628 " char *pv_name;\n"
20629 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20630 " char pv_uuid[32];\n"
20632 " uint64_t pv_size;\n"
20633 " uint64_t dev_size;\n"
20634 " uint64_t pv_free;\n"
20635 " uint64_t pv_used;\n"
20636 " char *pv_attr;\n"
20637 " int64_t pv_pe_count;\n"
20638 " int64_t pv_pe_alloc_count;\n"
20639 " char *pv_tags;\n"
20640 " uint64_t pe_start;\n"
20641 " int64_t pv_mda_count;\n"
20642 " uint64_t pv_mda_free;\n"
20649 #: ../src/guestfs-structs.pod:36
20652 " struct guestfs_lvm_pv_list {\n"
20653 " uint32_t len; /* Number of elements in list. */\n"
20654 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20661 #: ../src/guestfs-structs.pod:41
20664 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20665 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20671 #: ../src/guestfs-structs.pod:44
20672 msgid "guestfs_lvm_vg"
20677 #: ../src/guestfs-structs.pod:46
20680 " struct guestfs_lvm_vg {\n"
20681 " char *vg_name;\n"
20682 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20683 " char vg_uuid[32];\n"
20685 " char *vg_attr;\n"
20686 " uint64_t vg_size;\n"
20687 " uint64_t vg_free;\n"
20688 " char *vg_sysid;\n"
20689 " uint64_t vg_extent_size;\n"
20690 " int64_t vg_extent_count;\n"
20691 " int64_t vg_free_count;\n"
20692 " int64_t max_lv;\n"
20693 " int64_t max_pv;\n"
20694 " int64_t pv_count;\n"
20695 " int64_t lv_count;\n"
20696 " int64_t snap_count;\n"
20697 " int64_t vg_seqno;\n"
20698 " char *vg_tags;\n"
20699 " int64_t vg_mda_count;\n"
20700 " uint64_t vg_mda_free;\n"
20707 #: ../src/guestfs-structs.pod:69
20710 " struct guestfs_lvm_vg_list {\n"
20711 " uint32_t len; /* Number of elements in list. */\n"
20712 " struct guestfs_lvm_vg *val; /* Elements. */\n"
20719 #: ../src/guestfs-structs.pod:74
20722 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
20723 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
20729 #: ../src/guestfs-structs.pod:77
20730 msgid "guestfs_lvm_lv"
20735 #: ../src/guestfs-structs.pod:79
20738 " struct guestfs_lvm_lv {\n"
20739 " char *lv_name;\n"
20740 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20741 " char lv_uuid[32];\n"
20742 " char *lv_attr;\n"
20743 " int64_t lv_major;\n"
20744 " int64_t lv_minor;\n"
20745 " int64_t lv_kernel_major;\n"
20746 " int64_t lv_kernel_minor;\n"
20747 " uint64_t lv_size;\n"
20748 " int64_t seg_count;\n"
20750 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20751 " float snap_percent;\n"
20752 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20753 " float copy_percent;\n"
20754 " char *move_pv;\n"
20755 " char *lv_tags;\n"
20756 " char *mirror_log;\n"
20757 " char *modules;\n"
20764 #: ../src/guestfs-structs.pod:101
20767 " struct guestfs_lvm_lv_list {\n"
20768 " uint32_t len; /* Number of elements in list. */\n"
20769 " struct guestfs_lvm_lv *val; /* Elements. */\n"
20776 #: ../src/guestfs-structs.pod:106
20779 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
20780 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
20786 #: ../src/guestfs-structs.pod:111
20789 " struct guestfs_stat {\n"
20793 " int64_t nlink;\n"
20798 " int64_t blksize;\n"
20799 " int64_t blocks;\n"
20800 " int64_t atime;\n"
20801 " int64_t mtime;\n"
20802 " int64_t ctime;\n"
20809 #: ../src/guestfs-structs.pod:127
20812 " struct guestfs_stat_list {\n"
20813 " uint32_t len; /* Number of elements in list. */\n"
20814 " struct guestfs_stat *val; /* Elements. */\n"
20821 #: ../src/guestfs-structs.pod:132
20824 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
20825 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
20831 #: ../src/guestfs-structs.pod:137
20834 " struct guestfs_statvfs {\n"
20835 " int64_t bsize;\n"
20836 " int64_t frsize;\n"
20837 " int64_t blocks;\n"
20838 " int64_t bfree;\n"
20839 " int64_t bavail;\n"
20840 " int64_t files;\n"
20841 " int64_t ffree;\n"
20842 " int64_t favail;\n"
20845 " int64_t namemax;\n"
20852 #: ../src/guestfs-structs.pod:151
20855 " struct guestfs_statvfs_list {\n"
20856 " uint32_t len; /* Number of elements in list. */\n"
20857 " struct guestfs_statvfs *val; /* Elements. */\n"
20864 #: ../src/guestfs-structs.pod:156
20867 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
20868 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20874 #: ../src/guestfs-structs.pod:159
20875 msgid "guestfs_dirent"
20880 #: ../src/guestfs-structs.pod:161
20883 " struct guestfs_dirent {\n"
20893 #: ../src/guestfs-structs.pod:167
20896 " struct guestfs_dirent_list {\n"
20897 " uint32_t len; /* Number of elements in list. */\n"
20898 " struct guestfs_dirent *val; /* Elements. */\n"
20905 #: ../src/guestfs-structs.pod:172
20908 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20909 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20915 #: ../src/guestfs-structs.pod:177
20918 " struct guestfs_version {\n"
20919 " int64_t major;\n"
20920 " int64_t minor;\n"
20921 " int64_t release;\n"
20929 #: ../src/guestfs-structs.pod:184
20932 " struct guestfs_version_list {\n"
20933 " uint32_t len; /* Number of elements in list. */\n"
20934 " struct guestfs_version *val; /* Elements. */\n"
20941 #: ../src/guestfs-structs.pod:189
20944 " void guestfs_free_version (struct guestfs_free_version *);\n"
20945 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20951 #: ../src/guestfs-structs.pod:192
20952 msgid "guestfs_xattr"
20957 #: ../src/guestfs-structs.pod:194
20960 " struct guestfs_xattr {\n"
20961 " char *attrname;\n"
20962 " /* The next two fields describe a byte array. */\n"
20963 " uint32_t attrval_len;\n"
20964 " char *attrval;\n"
20971 #: ../src/guestfs-structs.pod:201
20974 " struct guestfs_xattr_list {\n"
20975 " uint32_t len; /* Number of elements in list. */\n"
20976 " struct guestfs_xattr *val; /* Elements. */\n"
20983 #: ../src/guestfs-structs.pod:206
20986 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20987 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
20993 #: ../src/guestfs-structs.pod:209
20994 msgid "guestfs_inotify_event"
20999 #: ../src/guestfs-structs.pod:211
21002 " struct guestfs_inotify_event {\n"
21003 " int64_t in_wd;\n"
21004 " uint32_t in_mask;\n"
21005 " uint32_t in_cookie;\n"
21006 " char *in_name;\n"
21013 #: ../src/guestfs-structs.pod:218
21016 " struct guestfs_inotify_event_list {\n"
21017 " uint32_t len; /* Number of elements in list. */\n"
21018 " struct guestfs_inotify_event *val; /* Elements. */\n"
21025 #: ../src/guestfs-structs.pod:223
21028 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21029 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21035 #: ../src/guestfs-structs.pod:226
21036 msgid "guestfs_partition"
21041 #: ../src/guestfs-structs.pod:228
21044 " struct guestfs_partition {\n"
21045 " int32_t part_num;\n"
21046 " uint64_t part_start;\n"
21047 " uint64_t part_end;\n"
21048 " uint64_t part_size;\n"
21055 #: ../src/guestfs-structs.pod:235
21058 " struct guestfs_partition_list {\n"
21059 " uint32_t len; /* Number of elements in list. */\n"
21060 " struct guestfs_partition *val; /* Elements. */\n"
21067 #: ../src/guestfs-structs.pod:240
21070 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21071 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21077 #: ../src/guestfs-structs.pod:243
21078 msgid "guestfs_application"
21083 #: ../src/guestfs-structs.pod:245
21086 " struct guestfs_application {\n"
21087 " char *app_name;\n"
21088 " char *app_display_name;\n"
21089 " int32_t app_epoch;\n"
21090 " char *app_version;\n"
21091 " char *app_release;\n"
21092 " char *app_install_path;\n"
21093 " char *app_trans_path;\n"
21094 " char *app_publisher;\n"
21095 " char *app_url;\n"
21096 " char *app_source_package;\n"
21097 " char *app_summary;\n"
21098 " char *app_description;\n"
21105 #: ../src/guestfs-structs.pod:260
21108 " struct guestfs_application_list {\n"
21109 " uint32_t len; /* Number of elements in list. */\n"
21110 " struct guestfs_application *val; /* Elements. */\n"
21117 #: ../src/guestfs-structs.pod:265
21120 " void guestfs_free_application (struct guestfs_free_application *);\n"
21121 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21127 #: ../fish/guestfish.pod:5
21128 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21133 #: ../fish/guestfish.pod:9
21136 " guestfish [--options] [commands]\n"
21142 #: ../fish/guestfish.pod:11
21151 #: ../fish/guestfish.pod:13
21154 " guestfish [--ro|--rw] -a disk.img\n"
21160 #: ../fish/guestfish.pod:15
21163 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21169 #: ../fish/guestfish.pod:17
21172 " guestfish -d libvirt-domain\n"
21178 #: ../fish/guestfish.pod:19
21181 " guestfish [--ro|--rw] -a disk.img -i\n"
21187 #: ../fish/guestfish.pod:21
21190 " guestfish -d libvirt-domain -i\n"
21196 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21197 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21203 #: ../fish/guestfish.pod:25
21205 "Using guestfish in read/write mode on live virtual machines can be "
21206 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21207 "option to use guestfish safely if the disk image or virtual machine might be "
21213 #: ../fish/guestfish.pod:32
21215 "Guestfish is a shell and command-line tool for examining and modifying "
21216 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21217 "functionality of the guestfs API, see L<guestfs(3)>."
21222 #: ../fish/guestfish.pod:36
21224 "Guestfish gives you structured access to the libguestfs API, from shell "
21225 "scripts or the command line or interactively. If you want to rescue a "
21226 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21232 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:928
21233 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
21234 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
21240 #: ../fish/guestfish.pod:43
21241 msgid "As an interactive shell"
21246 #: ../fish/guestfish.pod:45
21255 #: ../fish/guestfish.pod:47
21258 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21259 " editing virtual machine filesystems.\n"
21265 #: ../fish/guestfish.pod:50
21268 " Type: 'help' for a list of commands\n"
21269 " 'man' to read the manual\n"
21270 " 'quit' to quit the shell\n"
21276 #: ../fish/guestfish.pod:54
21279 " ><fs> add-ro disk.img\n"
21281 " ><fs> list-filesystems\n"
21282 " /dev/sda1: ext4\n"
21283 " /dev/vg_guest/lv_root: ext4\n"
21284 " /dev/vg_guest/lv_swap: swap\n"
21285 " ><fs> mount /dev/vg_guest/lv_root /\n"
21286 " ><fs> cat /etc/fstab\n"
21288 " # Created by anaconda\n"
21296 #: ../fish/guestfish.pod:67
21297 msgid "From shell scripts"
21302 #: ../fish/guestfish.pod:69
21303 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21308 #: ../fish/guestfish.pod:71
21311 " guestfish <<_EOF_\n"
21314 " mount /dev/vg_guest/lv_root /\n"
21315 " write /etc/motd \"Welcome, new users\"\n"
21322 #: ../fish/guestfish.pod:78
21323 msgid "List the LVM logical volumes in a disk image:"
21328 #: ../fish/guestfish.pod:80
21331 " guestfish -a disk.img --ro <<_EOF_\n"
21340 #: ../fish/guestfish.pod:85
21341 msgid "List all the filesystems in a disk image:"
21346 #: ../fish/guestfish.pod:87
21349 " guestfish -a disk.img --ro <<_EOF_\n"
21351 " list-filesystems\n"
21358 #: ../fish/guestfish.pod:92
21359 msgid "On one command line"
21364 #: ../fish/guestfish.pod:94
21365 msgid "Update C</etc/resolv.conf> in a guest:"
21370 #: ../fish/guestfish.pod:96
21374 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21375 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21381 #: ../fish/guestfish.pod:100
21382 msgid "Edit C</boot/grub/grub.conf> interactively:"
21387 #: ../fish/guestfish.pod:102
21390 " guestfish --rw --add disk.img \\\n"
21391 " --mount /dev/vg_guest/lv_root \\\n"
21392 " --mount /dev/sda1:/boot \\\n"
21393 " edit /boot/grub/grub.conf\n"
21399 #: ../fish/guestfish.pod:107
21400 msgid "Mount disks automatically"
21405 #: ../fish/guestfish.pod:109
21407 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21412 #: ../fish/guestfish.pod:112
21415 " guestfish --ro -a disk.img -i cat /etc/group\n"
21421 #: ../fish/guestfish.pod:114
21424 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21430 #: ../fish/guestfish.pod:116
21431 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21436 #: ../fish/guestfish.pod:118
21439 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21445 #: ../fish/guestfish.pod:120
21446 msgid "As a script interpreter"
21451 #: ../fish/guestfish.pod:122
21452 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21457 #: ../fish/guestfish.pod:124
21460 " #!/usr/bin/guestfish -f\n"
21461 " sparse test1.img 100M\n"
21463 " part-disk /dev/sda mbr\n"
21464 " mkfs ext2 /dev/sda1\n"
21470 #: ../fish/guestfish.pod:130
21471 msgid "Start with a prepared disk"
21476 #: ../fish/guestfish.pod:132
21478 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21479 "single ext2-formatted partition:"
21484 #: ../fish/guestfish.pod:135
21487 " guestfish -N fs\n"
21493 #: ../fish/guestfish.pod:137
21494 msgid "To list what is available do:"
21499 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:919
21502 " guestfish -N help | less\n"
21508 #: ../fish/guestfish.pod:141
21509 msgid "Remote control"
21514 #: ../fish/guestfish.pod:143
21517 " eval \"`guestfish --listen`\"\n"
21518 " guestfish --remote add-ro disk.img\n"
21519 " guestfish --remote run\n"
21520 " guestfish --remote lvs\n"
21526 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21527 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
21528 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
21529 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
21530 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
21536 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21537 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104
21538 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
21539 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
21540 #: ../tools/virt-list-partitions.pl:62
21546 #: ../fish/guestfish.pod:154
21547 msgid "Displays general help on options."
21552 #: ../fish/guestfish.pod:156
21558 #: ../fish/guestfish.pod:158
21559 msgid "B<--cmd-help>"
21564 #: ../fish/guestfish.pod:160
21565 msgid "Lists all available guestfish commands."
21570 #: ../fish/guestfish.pod:162
21576 #: ../fish/guestfish.pod:164
21577 msgid "B<--cmd-help cmd>"
21582 #: ../fish/guestfish.pod:166
21583 msgid "Displays detailed help on a single command C<cmd>."
21588 #: ../fish/guestfish.pod:168
21589 msgid "B<-a image>"
21594 #: ../fish/guestfish.pod:170
21595 msgid "B<--add image>"
21600 #: ../fish/guestfish.pod:172
21601 msgid "Add a block device or virtual machine image to the shell."
21606 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21608 "The format of the disk image is auto-detected. To override this and force a "
21609 "particular format use the I<--format=..> option."
21614 #: ../fish/guestfish.pod:177
21616 "Using this flag is mostly equivalent to using the C<add> command, with "
21617 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21618 "the I<--format:...> flag was given."
21623 #: ../fish/guestfish.pod:181
21629 #: ../fish/guestfish.pod:183
21630 msgid "B<--connect URI>"
21635 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21637 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21638 "URI to use. The default is to use the default libvirt connection."
21643 #: ../fish/guestfish.pod:189
21649 #: ../fish/guestfish.pod:191
21651 "If using the I<--listen> option and a csh-like shell, use this option. See "
21652 "section L</REMOTE CONTROL AND CSH> below."
21657 #: ../fish/guestfish.pod:194
21658 msgid "B<-d libvirt-domain>"
21663 #: ../fish/guestfish.pod:196
21664 msgid "B<--domain libvirt-domain>"
21669 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21671 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21672 "used, then any libvirt domain can be used. However in write mode, only "
21673 "libvirt domains which are shut down can be named here."
21678 #: ../fish/guestfish.pod:202
21680 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21681 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21682 "if the I<--format:...> flag was given."
21687 #: ../fish/guestfish.pod:206
21693 #: ../fish/guestfish.pod:208
21694 msgid "B<--no-dest-paths>"
21699 #: ../fish/guestfish.pod:210
21701 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21702 "to hit the tab key to complete paths on the guest filesystem, but this "
21703 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21704 "allow this feature to be disabled."
21709 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
21710 msgid "B<--echo-keys>"
21715 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
21717 "When prompting for keys and passphrases, guestfish normally turns echoing "
21718 "off so you cannot see what you are typing. If you are not worried about "
21719 "Tempest attacks and there is no one else in the room you can specify this "
21720 "flag to see what you are typing."
21725 #: ../fish/guestfish.pod:222
21731 #: ../fish/guestfish.pod:224
21732 msgid "B<--file file>"
21737 #: ../fish/guestfish.pod:226
21738 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21743 #: ../fish/guestfish.pod:229
21746 " #!/usr/bin/guestfish -f\n"
21752 #: ../fish/guestfish.pod:231
21753 msgid "B<--format=raw|qcow2|..>"
21758 #: ../fish/guestfish.pod:233
21759 msgid "B<--format>"
21764 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
21766 "The default for the I<-a> option is to auto-detect the format of the disk "
21767 "image. Using this forces the disk format for I<-a> options which follow on "
21768 "the command line. Using I<--format> with no argument switches back to auto-"
21769 "detection for subsequent I<-a> options."
21774 #: ../fish/guestfish.pod:242
21777 " guestfish --format=raw -a disk.img\n"
21783 #: ../fish/guestfish.pod:244
21784 msgid "forces raw format (no auto-detection) for C<disk.img>."
21789 #: ../fish/guestfish.pod:246
21792 " guestfish --format=raw -a disk.img --format -a another.img\n"
21798 #: ../fish/guestfish.pod:248
21800 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
21801 "detection for C<another.img>."
21806 #: ../fish/guestfish.pod:251
21808 "If you have untrusted raw-format guest disk images, you should use this "
21809 "option to specify the disk format. This avoids a possible security problem "
21810 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21815 #: ../fish/guestfish.pod:256
21821 #: ../fish/guestfish.pod:258
21822 msgid "B<--inspector>"
21827 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
21829 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21830 "system and mount filesystems as they would be mounted on the real virtual "
21836 #: ../fish/guestfish.pod:264
21837 msgid "Typical usage is either:"
21842 #: ../fish/guestfish.pod:266
21845 " guestfish -d myguest -i\n"
21851 #: ../fish/guestfish.pod:268
21852 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21857 #: ../fish/guestfish.pod:270
21860 " guestfish --ro -d myguest -i\n"
21866 #: ../fish/guestfish.pod:272
21867 msgid "(for active domains, readonly), or specify the block device directly:"
21872 #: ../fish/guestfish.pod:274
21875 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21881 #: ../fish/guestfish.pod:276
21883 "Note that the command line syntax changed slightly over older versions of "
21884 "guestfish. You can still use the old syntax:"
21889 #: ../fish/guestfish.pod:279
21892 " guestfish [--ro] -i disk.img\n"
21898 #: ../fish/guestfish.pod:281
21901 " guestfish [--ro] -i libvirt-domain\n"
21907 #: ../fish/guestfish.pod:283
21909 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21910 "then using other commands to mount the filesystems that were found."
21915 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21916 msgid "B<--keys-from-stdin>"
21921 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21923 "Read key or passphrase parameters from stdin. The default is to try to read "
21924 "passphrases from the user by opening C</dev/tty>."
21929 #: ../fish/guestfish.pod:292
21930 msgid "B<--listen>"
21935 #: ../fish/guestfish.pod:294
21937 "Fork into the background and listen for remote commands. See section L</"
21938 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21942 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
21947 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
21949 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
21950 "ATTACHING TO RUNNING DAEMONS>)."
21955 #: ../fish/guestfish.pod:302
21956 msgid "B<-m dev[:mountpoint]>"
21961 #: ../fish/guestfish.pod:304
21962 msgid "B<--mount dev[:mountpoint]>"
21967 #: ../fish/guestfish.pod:306
21968 msgid "Mount the named partition or logical volume on the given mountpoint."
21973 #: ../fish/guestfish.pod:308
21974 msgid "If the mountpoint is omitted, it defaults to C</>."
21979 #: ../fish/guestfish.pod:310
21980 msgid "You have to mount something on C</> before most commands will work."
21985 #: ../fish/guestfish.pod:312
21987 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21993 #: ../fish/guestfish.pod:315
21995 "If you don't know what filesystems a disk image contains, you can either run "
21996 "guestfish without this option, then list the partitions, filesystems and LVs "
21997 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21998 "commands), or you can use the L<virt-filesystems(1)> program."
22003 #: ../fish/guestfish.pod:321
22005 "Using this flag is mostly equivalent to using the C<mount-options> command "
22006 "or the C<mount-ro> command if the I<--ro> flag was given."
22011 #: ../fish/guestfish.pod:324
22017 #: ../fish/guestfish.pod:326
22018 msgid "B<--no-sync>"
22023 #: ../fish/guestfish.pod:328
22025 "Disable autosync. This is enabled by default. See the discussion of "
22026 "autosync in the L<guestfs(3)> manpage."
22031 #: ../fish/guestfish.pod:331
22037 #: ../fish/guestfish.pod:333
22038 msgid "B<--new type>"
22043 #: ../fish/guestfish.pod:335
22049 #: ../fish/guestfish.pod:337
22051 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22052 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22053 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22059 #: ../fish/guestfish.pod:342
22060 msgid "B<--progress-bars>"
22065 #: ../fish/guestfish.pod:344
22066 msgid "Enable progress bars, even when guestfish is used non-interactively."
22071 #: ../fish/guestfish.pod:346
22073 "Progress bars are enabled by default when guestfish is used as an "
22074 "interactive shell."
22079 #: ../fish/guestfish.pod:349
22080 msgid "B<--no-progress-bars>"
22085 #: ../fish/guestfish.pod:351
22086 msgid "Disable progress bars."
22091 #: ../fish/guestfish.pod:353
22092 msgid "B<--remote[=pid]>"
22097 #: ../fish/guestfish.pod:355
22099 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22100 "CONTROL GUESTFISH OVER A SOCKET> below."
22105 #: ../fish/guestfish.pod:358
22111 #: ../fish/guestfish.pod:360
22117 #: ../fish/guestfish.pod:362
22119 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22120 "mounts are done read-only."
22125 #: ../fish/guestfish.pod:365
22127 "The option must always be used if the disk image or virtual machine might be "
22128 "running, and is generally recommended in cases where you don't need write "
22129 "access to the disk."
22134 #: ../fish/guestfish.pod:369
22136 "Note that prepared disk images created with I<-N> are not affected by this "
22137 "option. Also commands like C<add> are not affected - you have to specify "
22138 "the C<readonly:true> option explicitly if you need it."
22143 #: ../fish/guestfish.pod:373
22144 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22149 #: ../fish/guestfish.pod:375 ../fuse/guestmount.pod:213
22150 msgid "B<--selinux>"
22155 #: ../fish/guestfish.pod:377
22156 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22161 #: ../fish/guestfish.pod:379
22167 #: ../fish/guestfish.pod:381
22168 msgid "B<--verbose>"
22173 #: ../fish/guestfish.pod:383
22175 "Enable very verbose messages. This is particularly useful if you find a bug."
22180 #: ../fish/guestfish.pod:386
22186 #: ../fish/guestfish.pod:388 ../tools/virt-edit.pl:88
22187 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
22188 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22189 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22190 msgid "B<--version>"
22195 #: ../fish/guestfish.pod:390
22196 msgid "Display the guestfish / libguestfs version number and exit."
22201 #: ../fish/guestfish.pod:392
22207 #: ../fish/guestfish.pod:394
22213 #: ../fish/guestfish.pod:396
22215 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
22221 #: ../fish/guestfish.pod:399
22227 #: ../fish/guestfish.pod:401
22228 msgid "Echo each command before executing it."
22233 #: ../fish/guestfish.pod:405
22234 msgid "COMMANDS ON COMMAND LINE"
22239 #: ../fish/guestfish.pod:407
22241 "Any additional (non-option) arguments are treated as commands to execute."
22246 #: ../fish/guestfish.pod:410
22248 "Commands to execute should be separated by a colon (C<:>), where the colon "
22249 "is a separate parameter. Thus:"
22254 #: ../fish/guestfish.pod:413
22257 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22263 #: ../fish/guestfish.pod:415
22265 "If there are no additional arguments, then we enter a shell, either an "
22266 "interactive shell with a prompt (if the input is a terminal) or a non-"
22267 "interactive shell."
22272 #: ../fish/guestfish.pod:419
22274 "In either command line mode or non-interactive shell, the first command that "
22275 "gives an error causes the whole shell to exit. In interactive mode (with a "
22276 "prompt) if a command fails, you can continue to enter commands."
22281 #: ../fish/guestfish.pod:424
22282 msgid "USING launch (OR run)"
22287 #: ../fish/guestfish.pod:426
22289 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22290 "then launch it, then mount any disks you need, and finally issue actions/"
22291 "commands. So the general order of the day is:"
22296 #: ../fish/guestfish.pod:434
22297 msgid "add or -a/--add"
22302 #: ../fish/guestfish.pod:438
22303 msgid "launch (aka run)"
22308 #: ../fish/guestfish.pod:442
22309 msgid "mount or -m/--mount"
22314 #: ../fish/guestfish.pod:446
22315 msgid "any other commands"
22320 #: ../fish/guestfish.pod:450
22322 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22323 "guest before mounting or performing any other commands."
22328 #: ../fish/guestfish.pod:453
22330 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22331 "I<--new> options were given then C<run> is done automatically, simply "
22332 "because guestfish can't perform the action you asked for without doing this."
22337 #: ../fish/guestfish.pod:458
22338 msgid "OPENING DISKS FOR READ AND WRITE"
22343 #: ../fish/guestfish.pod:460
22345 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
22346 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
22347 "open disk images read-only or for writing."
22352 #: ../fish/guestfish.pod:464
22354 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
22355 "disk images supplied on the command line for write. To open a disk image "
22356 "read-only you have to do I<-a image --ro>."
22361 #: ../fish/guestfish.pod:468
22363 "This matters: If you accidentally open a live VM disk image writable then "
22364 "you will cause irreversible disk corruption."
22368 #: ../fish/guestfish.pod:471
22370 "By libguestfs 1.10 we intend to change the default the other way. Disk "
22371 "images will be opened read-only. You will have to either specify "
22372 "I<guestfish --rw> or change a configuration file in order to get write "
22373 "access for disk images specified by those other command line options."
22378 #: ../fish/guestfish.pod:476
22380 "This version of guestfish has a I<--rw> option which does nothing (it is "
22381 "already the default). However it is highly recommended that you use this "
22382 "option to indicate that guestfish needs write access, and to prepare your "
22383 "scripts for the day when this option will be required for write access."
22388 #: ../fish/guestfish.pod:482
22390 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22391 "other libguestfs program apart from guestfish and guestmount."
22396 #: ../fish/guestfish.pod:485
22402 #: ../fish/guestfish.pod:487
22404 "You can quote ordinary parameters using either single or double quotes. For "
22410 #: ../fish/guestfish.pod:490
22413 " add \"file with a space.img\"\n"
22419 #: ../fish/guestfish.pod:492
22422 " rm '/file name'\n"
22428 #: ../fish/guestfish.pod:494
22437 #: ../fish/guestfish.pod:496
22439 "A few commands require a list of strings to be passed. For these, use a "
22440 "whitespace-separated list, enclosed in quotes. Strings containing "
22441 "whitespace to be passed through must be enclosed in single quotes. A "
22442 "literal single quote must be escaped with a backslash."
22447 #: ../fish/guestfish.pod:501
22450 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22451 " command \"/bin/echo 'foo bar'\"\n"
22452 " command \"/bin/echo \\'foo\\'\"\n"
22458 #: ../fish/guestfish.pod:505
22459 msgid "OPTIONAL ARGUMENTS"
22464 #: ../fish/guestfish.pod:507
22466 "Some commands take optional arguments. These arguments appear in this "
22467 "documentation as C<[argname:..]>. You can use them as in these examples:"
22472 #: ../fish/guestfish.pod:511
22475 " add-drive-opts filename\n"
22481 #: ../fish/guestfish.pod:513
22484 " add-drive-opts filename readonly:true\n"
22490 #: ../fish/guestfish.pod:515
22493 " add-drive-opts filename format:qcow2 readonly:false\n"
22499 #: ../fish/guestfish.pod:517
22501 "Each optional argument can appear at most once. All optional arguments must "
22502 "appear after the required ones."
22507 #: ../fish/guestfish.pod:520
22513 #: ../fish/guestfish.pod:522
22515 "This section applies to all commands which can take integers as parameters."
22520 #: ../fish/guestfish.pod:525
22521 msgid "SIZE SUFFIX"
22526 #: ../fish/guestfish.pod:527
22528 "When the command takes a parameter measured in bytes, you can use one of the "
22529 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22534 #: ../fish/guestfish.pod:533
22535 msgid "B<k> or B<K> or B<KiB>"
22540 #: ../fish/guestfish.pod:535
22541 msgid "The size in kilobytes (multiplied by 1024)."
22546 #: ../fish/guestfish.pod:537
22552 #: ../fish/guestfish.pod:539
22553 msgid "The size in SI 1000 byte units."
22558 #: ../fish/guestfish.pod:541
22559 msgid "B<M> or B<MiB>"
22564 #: ../fish/guestfish.pod:543
22565 msgid "The size in megabytes (multiplied by 1048576)."
22570 #: ../fish/guestfish.pod:545
22576 #: ../fish/guestfish.pod:547
22577 msgid "The size in SI 1000000 byte units."
22582 #: ../fish/guestfish.pod:549
22583 msgid "B<G> or B<GiB>"
22588 #: ../fish/guestfish.pod:551
22589 msgid "The size in gigabytes (multiplied by 2**30)."
22594 #: ../fish/guestfish.pod:553
22600 #: ../fish/guestfish.pod:555
22601 msgid "The size in SI 10**9 byte units."
22606 #: ../fish/guestfish.pod:557
22607 msgid "B<T> or B<TiB>"
22612 #: ../fish/guestfish.pod:559
22613 msgid "The size in terabytes (multiplied by 2**40)."
22618 #: ../fish/guestfish.pod:561
22624 #: ../fish/guestfish.pod:563
22625 msgid "The size in SI 10**12 byte units."
22630 #: ../fish/guestfish.pod:565
22631 msgid "B<P> or B<PiB>"
22636 #: ../fish/guestfish.pod:567
22637 msgid "The size in petabytes (multiplied by 2**50)."
22642 #: ../fish/guestfish.pod:569
22648 #: ../fish/guestfish.pod:571
22649 msgid "The size in SI 10**15 byte units."
22654 #: ../fish/guestfish.pod:573
22655 msgid "B<E> or B<EiB>"
22660 #: ../fish/guestfish.pod:575
22661 msgid "The size in exabytes (multiplied by 2**60)."
22666 #: ../fish/guestfish.pod:577
22672 #: ../fish/guestfish.pod:579
22673 msgid "The size in SI 10**18 byte units."
22678 #: ../fish/guestfish.pod:581
22679 msgid "B<Z> or B<ZiB>"
22684 #: ../fish/guestfish.pod:583
22685 msgid "The size in zettabytes (multiplied by 2**70)."
22690 #: ../fish/guestfish.pod:585
22696 #: ../fish/guestfish.pod:587
22697 msgid "The size in SI 10**21 byte units."
22702 #: ../fish/guestfish.pod:589
22703 msgid "B<Y> or B<YiB>"
22708 #: ../fish/guestfish.pod:591
22709 msgid "The size in yottabytes (multiplied by 2**80)."
22714 #: ../fish/guestfish.pod:593
22720 #: ../fish/guestfish.pod:595
22721 msgid "The size in SI 10**24 byte units."
22726 #: ../fish/guestfish.pod:601
22729 " truncate-size /file 1G\n"
22735 #: ../fish/guestfish.pod:603
22736 msgid "would truncate the file to 1 gigabyte."
22741 #: ../fish/guestfish.pod:605
22743 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22744 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22745 "suffix will probably not do what you expect."
22750 #: ../fish/guestfish.pod:609
22751 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22756 #: ../fish/guestfish.pod:611
22758 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22759 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22764 #: ../fish/guestfish.pod:614
22767 " 1234 decimal number 1234\n"
22768 " 02322 octal number, equivalent to decimal 1234\n"
22769 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22775 #: ../fish/guestfish.pod:618
22777 "When using the C<chmod> command, you almost always want to specify an octal "
22778 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22779 "L<chmod(1)> program):"
22784 #: ../fish/guestfish.pod:622
22787 " chmod 0777 /public # OK\n"
22788 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22794 #: ../fish/guestfish.pod:625
22796 "Commands that return numbers usually print them in decimal, but some "
22797 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22798 "octal, preceeded by C<0>)."
22803 #: ../fish/guestfish.pod:629
22804 msgid "WILDCARDS AND GLOBBING"
22809 #: ../fish/guestfish.pod:631
22811 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22812 "(globbing) by default. So for example the following will not do what you "
22818 #: ../fish/guestfish.pod:635
22827 #: ../fish/guestfish.pod:637
22829 "Assuming you don't have a directory called literally C</home/*> then the "
22830 "above command will return an error."
22835 #: ../fish/guestfish.pod:640
22836 msgid "To perform wildcard expansion, use the C<glob> command."
22841 #: ../fish/guestfish.pod:642
22844 " glob rm-rf /home/*\n"
22850 #: ../fish/guestfish.pod:644
22852 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
22853 "many times), equivalent to:"
22858 #: ../fish/guestfish.pod:647
22861 " rm-rf /home/jim\n"
22862 " rm-rf /home/joe\n"
22863 " rm-rf /home/mary\n"
22869 #: ../fish/guestfish.pod:651
22870 msgid "C<glob> only works on simple guest paths and not on device names."
22875 #: ../fish/guestfish.pod:653
22877 "If you have several parameters, each containing a wildcard, then glob will "
22878 "perform a Cartesian product."
22883 #: ../fish/guestfish.pod:656
22889 #: ../fish/guestfish.pod:658
22891 "Any line which starts with a I<#> character is treated as a comment and "
22892 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22893 "a command. For example:"
22898 #: ../fish/guestfish.pod:662
22901 " # this is a comment\n"
22902 " # this is a comment\n"
22903 " foo # NOT a comment\n"
22909 #: ../fish/guestfish.pod:666
22910 msgid "Blank lines are also ignored."
22915 #: ../fish/guestfish.pod:668
22916 msgid "RUNNING COMMANDS LOCALLY"
22921 #: ../fish/guestfish.pod:670
22923 "Any line which starts with a I<!> character is treated as a command sent to "
22924 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22929 #: ../fish/guestfish.pod:674
22933 " tgz-out /remote local/remote-data.tar.gz\n"
22939 #: ../fish/guestfish.pod:677
22941 "will create a directory C<local> on the host, and then export the contents "
22942 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22943 "(See C<tgz-out>)."
22948 #: ../fish/guestfish.pod:681
22950 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22951 "effect, due to the way that subprocesses work in Unix."
22955 #: ../fish/guestfish.pod:684
22956 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
22960 #: ../fish/guestfish.pod:686
22962 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
22963 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
22964 "and executed as guestfish commands."
22968 #: ../fish/guestfish.pod:690
22970 "Thus you can use shell script to construct arbitrary guestfish commands "
22971 "which are then parsed by guestfish."
22975 #: ../fish/guestfish.pod:693
22977 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
22978 "through C</foo.100>) using guestfish commands alone. However this is simple "
22979 "if we use a shell script to create the guestfish commands for us:"
22983 #: ../fish/guestfish.pod:698
22986 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
22991 #: ../fish/guestfish.pod:700
22992 msgid "or with names like C</foo.001>:"
22996 #: ../fish/guestfish.pod:702
22999 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23004 #: ../fish/guestfish.pod:704
23006 "When using guestfish interactively it can be helpful to just run the shell "
23007 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23008 "ordinary I<!> local command), see what guestfish commands it would run, and "
23009 "when you are happy with those prepend the C<E<lt>> character to run the "
23010 "guestfish commands for real."
23015 #: ../fish/guestfish.pod:710
23021 #: ../fish/guestfish.pod:712
23023 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23024 "command (a guestfish command) to the second command (any host command). For "
23030 #: ../fish/guestfish.pod:716
23033 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23039 #: ../fish/guestfish.pod:718
23041 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23042 "program). The above command would list all accounts in the guest filesystem "
23043 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23048 #: ../fish/guestfish.pod:723
23051 " hexdump /bin/ls | head\n"
23052 " list-devices | tail -1\n"
23053 " tgz-out / - | tar ztf -\n"
23059 #: ../fish/guestfish.pod:727
23061 "The space before the pipe symbol is required, any space after the pipe "
23062 "symbol is optional. Everything after the pipe symbol is just passed "
23063 "straight to the host shell, so it can contain redirections, globs and "
23064 "anything else that makes sense on the host side."
23069 #: ../fish/guestfish.pod:732
23071 "To use a literal argument which begins with a pipe symbol, you have to quote "
23077 #: ../fish/guestfish.pod:735
23086 #: ../fish/guestfish.pod:737
23087 msgid "HOME DIRECTORIES"
23092 #: ../fish/guestfish.pod:739
23094 "If a parameter starts with the character C<~> then the tilde may be expanded "
23095 "as a home directory path (either C<~> for the current user's home directory, "
23096 "or C<~user> for another user)."
23101 #: ../fish/guestfish.pod:743
23103 "Note that home directory expansion happens for users known I<on the host>, "
23104 "not in the guest filesystem."
23109 #: ../fish/guestfish.pod:746
23111 "To use a literal argument which begins with a tilde, you have to quote it, "
23117 #: ../fish/guestfish.pod:749
23126 #: ../fish/guestfish.pod:753
23128 "Libguestfs has some support for Linux guests encrypted according to the "
23129 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23130 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23131 "LUKS is supported."
23136 #: ../fish/guestfish.pod:758
23137 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23142 #: ../fish/guestfish.pod:760
23145 " ><fs> vfs-type /dev/sda2\n"
23152 #: ../fish/guestfish.pod:763
23154 "Then open those devices using L</luks-open>. This creates a device-mapper "
23155 "device called C</dev/mapper/luksdev>."
23160 #: ../fish/guestfish.pod:766
23163 " ><fs> luks-open /dev/sda2 luksdev\n"
23164 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23170 #: ../fish/guestfish.pod:769
23172 "Finally you have to tell LVM to scan for volume groups on the newly created "
23178 #: ../fish/guestfish.pod:772
23182 " vg-activate-all true\n"
23188 #: ../fish/guestfish.pod:775
23189 msgid "The logical volume(s) can now be mounted in the usual way."
23194 #: ../fish/guestfish.pod:777
23196 "Before closing a LUKS device you must unmount any logical volumes on it and "
23197 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23198 "one. Then you can close the mapper device:"
23203 #: ../fish/guestfish.pod:781
23206 " vg-activate false /dev/VG\n"
23207 " luks-close /dev/mapper/luksdev\n"
23213 #: ../fish/guestfish.pod:784
23214 msgid "WINDOWS PATHS"
23219 #: ../fish/guestfish.pod:786
23221 "If a path is prefixed with C<win:> then you can use Windows-style paths "
23222 "(with some limitations). The following commands are equivalent:"
23227 #: ../fish/guestfish.pod:789
23230 " file /WINDOWS/system32/config/system.LOG\n"
23236 #: ../fish/guestfish.pod:791
23239 " file win:/windows/system32/config/system.log\n"
23245 #: ../fish/guestfish.pod:793
23248 " file win:\\windows\\system32\\config\\system.log\n"
23254 #: ../fish/guestfish.pod:795
23257 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
23263 #: ../fish/guestfish.pod:797
23265 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
23266 "handles case insensitivity like Windows would. This only works in argument "
23267 "positions that expect a path."
23272 #: ../fish/guestfish.pod:801
23273 msgid "UPLOADING AND DOWNLOADING FILES"
23278 #: ../fish/guestfish.pod:803
23280 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23281 "others which upload from or download to a local file, you can use the "
23282 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23287 #: ../fish/guestfish.pod:807
23296 #: ../fish/guestfish.pod:809
23298 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23303 #: ../fish/guestfish.pod:812
23306 " tar-out /etc - | tar tf -\n"
23312 #: ../fish/guestfish.pod:814
23314 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23315 "command (see L</PIPES>)."
23320 #: ../fish/guestfish.pod:817
23322 "When using C<-> to read from stdin, the input is read up to the end of "
23323 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23324 "some arbitrary end marker:"
23329 #: ../fish/guestfish.pod:821
23332 " upload -<<END /foo\n"
23342 #: ../fish/guestfish.pod:827
23344 "Any string of characters can be used instead of C<END>. The end marker must "
23345 "appear on a line of its own, without any preceeding or following characters "
23346 "(not even spaces)."
23351 #: ../fish/guestfish.pod:831
23353 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23354 "upload local files (so-called \"FileIn\" parameters in the generator)."
23359 #: ../fish/guestfish.pod:834
23360 msgid "EXIT ON ERROR BEHAVIOUR"
23365 #: ../fish/guestfish.pod:836
23367 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23368 "taking commands from a human over a tty), and will exit on the first error "
23369 "in non-interactive mode (scripts, commands given on the command line)."
23374 #: ../fish/guestfish.pod:841
23376 "If you prefix a command with a I<-> character, then that command will not "
23377 "cause guestfish to exit, even if that (one) command returns an error."
23382 #: ../fish/guestfish.pod:845
23383 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23388 #: ../fish/guestfish.pod:847
23390 "Guestfish can be remote-controlled over a socket. This is useful "
23391 "particularly in shell scripts where you want to make several different "
23392 "changes to a filesystem, but you don't want the overhead of starting up a "
23393 "guestfish process each time."
23398 #: ../fish/guestfish.pod:852
23399 msgid "Start a guestfish server process using:"
23404 #: ../fish/guestfish.pod:854
23407 " eval \"`guestfish --listen`\"\n"
23413 #: ../fish/guestfish.pod:856
23414 msgid "and then send it commands by doing:"
23419 #: ../fish/guestfish.pod:858
23422 " guestfish --remote cmd [...]\n"
23428 #: ../fish/guestfish.pod:860
23429 msgid "To cause the server to exit, send it the exit command:"
23434 #: ../fish/guestfish.pod:862
23437 " guestfish --remote exit\n"
23443 #: ../fish/guestfish.pod:864
23445 "Note that the server will normally exit if there is an error in a command. "
23446 "You can change this in the usual way. See section L</EXIT ON ERROR "
23452 #: ../fish/guestfish.pod:868
23453 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23458 #: ../fish/guestfish.pod:870
23460 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23461 "is how the I<--remote> option knows where to send the commands. You can "
23462 "have several guestfish listener processes running using:"
23467 #: ../fish/guestfish.pod:874
23470 " eval \"`guestfish --listen`\"\n"
23471 " pid1=$GUESTFISH_PID\n"
23472 " eval \"`guestfish --listen`\"\n"
23473 " pid2=$GUESTFISH_PID\n"
23475 " guestfish --remote=$pid1 cmd\n"
23476 " guestfish --remote=$pid2 cmd\n"
23482 #: ../fish/guestfish.pod:882
23483 msgid "REMOTE CONTROL AND CSH"
23488 #: ../fish/guestfish.pod:884
23490 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23496 #: ../fish/guestfish.pod:887
23499 " eval \"`guestfish --listen --csh`\"\n"
23505 #: ../fish/guestfish.pod:889
23506 msgid "REMOTE CONTROL DETAILS"
23511 #: ../fish/guestfish.pod:891
23513 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23514 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23515 "and C<$PID> is the process ID of the server."
23520 #: ../fish/guestfish.pod:895
23521 msgid "Guestfish client and server versions must match exactly."
23526 #: ../fish/guestfish.pod:897
23527 msgid "PREPARED DISK IMAGES"
23532 #: ../fish/guestfish.pod:899
23534 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23535 "preformatted disk images that guestfish can make for you to save typing. "
23536 "This is particularly useful for testing purposes. This option is used "
23537 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23538 "can be mixed with I<-a>)."
23543 #: ../fish/guestfish.pod:905
23545 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23546 "the second and so on. Existing files in the current directory are "
23552 #: ../fish/guestfish.pod:909
23554 "The type briefly describes how the disk should be sized, partitioned, how "
23555 "filesystem(s) should be created, and how content should be added. "
23556 "Optionally the type can be followed by extra parameters, separated by C<:> "
23557 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23558 "allocated disk, containing a single partition, with the partition formatted "
23559 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23565 #: ../fish/guestfish.pod:917
23566 msgid "To list the available types and any extra parameters they take, run:"
23571 #: ../fish/guestfish.pod:921
23573 "Note that the prepared filesystem is not mounted. You would usually have to "
23574 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23579 #: ../fish/guestfish.pod:925
23581 "If any I<-N> or I<--new> options are given, the guest is automatically "
23587 #: ../fish/guestfish.pod:930
23588 msgid "Create a 100MB disk with an ext4-formatted partition:"
23593 #: ../fish/guestfish.pod:932
23596 " guestfish -N fs:ext4\n"
23602 #: ../fish/guestfish.pod:934
23603 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23608 #: ../fish/guestfish.pod:936
23611 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23617 #: ../fish/guestfish.pod:938
23618 msgid "Create a blank 200MB disk:"
23623 #: ../fish/guestfish.pod:940
23626 " guestfish -N disk:200M\n"
23632 #: ../fish/guestfish.pod:942
23633 msgid "PROGRESS BARS"
23638 #: ../fish/guestfish.pod:944
23640 "Some (not all) long-running commands send progress notification messages as "
23641 "they are running. Guestfish turns these messages into progress bars."
23646 #: ../fish/guestfish.pod:948
23648 "When a command that supports progress bars takes longer than two seconds to "
23649 "run, and if progress bars are enabled, then you will see one appearing below "
23655 #: ../fish/guestfish.pod:952
23658 " ><fs> copy-size /large-file /another-file 2048M\n"
23659 " / 10% [#####-----------------------------------------] 00:30\n"
23665 #: ../fish/guestfish.pod:955
23667 "The spinner on the left hand side moves round once for every progress "
23668 "notification received from the backend. This is a (reasonably) golden "
23669 "assurance that the command is \"doing something\" even if the progress bar "
23670 "is not moving, because the command is able to send the progress "
23671 "notifications. When the bar reaches 100% and the command finishes, the "
23672 "spinner disappears."
23677 #: ../fish/guestfish.pod:962
23679 "Progress bars are enabled by default when guestfish is used interactively. "
23680 "You can enable them even for non-interactive modes using I<--progress-bars>, "
23681 "and you can disable them completely using I<--no-progress-bars>."
23686 #: ../fish/guestfish.pod:967
23687 msgid "GUESTFISH COMMANDS"
23692 #: ../fish/guestfish.pod:969
23694 "The commands in this section are guestfish convenience commands, in other "
23695 "words, they are not part of the L<guestfs(3)> API."
23700 #: ../fish/guestfish.pod:972
23706 #: ../fish/guestfish.pod:974
23716 #: ../fish/guestfish.pod:977
23717 msgid "Without any parameter, this provides general help."
23722 #: ../fish/guestfish.pod:979
23723 msgid "With a C<cmd> parameter, this displays detailed help for that command."
23728 #: ../fish/guestfish.pod:981
23729 msgid "quit | exit"
23734 #: ../fish/guestfish.pod:983
23735 msgid "This exits guestfish. You can also use C<^D> key."
23740 #: ../fish/guestfish.pod:985
23741 msgid "@FISH_COMMANDS@"
23746 #: ../fish/guestfish.pod:987
23752 #: ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:83
23758 #: ../fish/guestfish.pod:993
23760 "guestfish returns 0 if the commands completed without error, or 1 if there "
23766 #: ../fish/guestfish.pod:1000
23772 #: ../fish/guestfish.pod:1002
23774 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23780 #: ../fish/guestfish.pod:1005
23781 msgid "GUESTFISH_PID"
23786 #: ../fish/guestfish.pod:1007
23788 "Used with the I<--remote> option to specify the remote guestfish process to "
23789 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23794 #: ../fish/guestfish.pod:1011
23800 #: ../fish/guestfish.pod:1013
23802 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23803 "not specified, the external L<hexedit(1)> program is used."
23808 #: ../fish/guestfish.pod:1017
23814 #: ../fish/guestfish.pod:1019
23816 "If compiled with GNU readline support, various files in the home directory "
23817 "can be used. See L</FILES>."
23822 #: ../fish/guestfish.pod:1028
23824 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23825 "effect as using the B<-v> option."
23830 #: ../fish/guestfish.pod:1040
23832 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23833 "the discussion of paths in L<guestfs(3)>."
23838 #: ../fish/guestfish.pod:1051
23839 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
23844 #: ../fish/guestfish.pod:1053
23850 #: ../fish/guestfish.pod:1055
23852 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
23858 #: ../fish/guestfish.pod:1071 ../test-tool/libguestfs-test-tool.pod:88
23864 #: ../fish/guestfish.pod:1075
23865 msgid "$HOME/.guestfish"
23870 #: ../fish/guestfish.pod:1077
23872 "If compiled with GNU readline support, then the command history is saved in "
23878 #: ../fish/guestfish.pod:1080
23879 msgid "$HOME/.inputrc"
23884 #: ../fish/guestfish.pod:1082
23885 msgid "/etc/inputrc"
23890 #: ../fish/guestfish.pod:1084
23892 "If compiled with GNU readline support, then these files can be used to "
23893 "configure readline. For further information, please see L<readline(3)/"
23894 "INITIALIZATION FILE>."
23899 #: ../fish/guestfish.pod:1088
23900 msgid "To write rules which only apply to guestfish, use:"
23905 #: ../fish/guestfish.pod:1090
23916 #: ../fish/guestfish.pod:1094
23918 "Variables that you can set in inputrc that change the behaviour of guestfish "
23919 "in useful ways include:"
23924 #: ../fish/guestfish.pod:1099
23925 msgid "completion-ignore-case (default: on)"
23930 #: ../fish/guestfish.pod:1101
23932 "By default, guestfish will ignore case when tab-completing paths on the "
23938 #: ../fish/guestfish.pod:1104
23941 " set completion-ignore-case off\n"
23947 #: ../fish/guestfish.pod:1106
23948 msgid "to make guestfish case sensitive."
23953 #: ../fish/guestfish.pod:1110
23959 #: ../fish/guestfish.pod:1112
23960 msgid "test2.img (etc)"
23965 #: ../fish/guestfish.pod:1114
23967 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
23968 "will be created in the file C<test1.img> in the current directory. The "
23969 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
23970 "the same name will be overwritten."
23974 #: ../fish/guestfish.pod:1123
23976 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
23977 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
23978 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
23979 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
23980 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
23981 ">, L<hexedit(1)>."
23986 #: ../fish/guestfish.pod:1153 ../test-tool/libguestfs-test-tool.pod:124
23987 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:372
23988 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518
23989 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
23990 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
23992 "This program is free software; you can redistribute it and/or modify it "
23993 "under the terms of the GNU General Public License as published by the Free "
23994 "Software Foundation; either version 2 of the License, or (at your option) "
23995 "any later version."
24000 #: ../fish/guestfish.pod:1158 ../test-tool/libguestfs-test-tool.pod:129
24001 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:377
24002 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523
24003 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24004 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24006 "This program is distributed in the hope that it will be useful, but WITHOUT "
24007 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24008 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24014 #: ../fish/guestfish.pod:1163 ../test-tool/libguestfs-test-tool.pod:134
24015 #: ../fuse/guestmount.pod:268 ../tools/virt-edit.pl:382
24016 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528
24017 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24018 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24020 "You should have received a copy of the GNU General Public License along with "
24021 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24022 "Ave, Cambridge, MA 02139, USA."
24027 #: ../fish/guestfish-actions.pod:1
24033 #: ../fish/guestfish-actions.pod:3
24036 " add-cdrom filename\n"
24042 #: ../fish/guestfish-actions.pod:15
24044 "This call checks for the existence of C<filename>. This stops you from "
24045 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24046 "and C<http:> URLs. To specify those, use the general L</config> call "
24052 #: ../fish/guestfish-actions.pod:22
24054 "If you just want to add an ISO file (often you use this as an efficient way "
24055 "to transfer large files into the guest), then you should probably use L</add-"
24056 "drive-ro> instead."
24061 #: ../fish/guestfish-actions.pod:35
24067 #: ../fish/guestfish-actions.pod:37
24072 #: ../fish/guestfish-actions.pod:39
24075 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24081 #: ../fish/guestfish-actions.pod:41
24083 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24084 "It works by connecting to libvirt, requesting the domain and domain XML from "
24085 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24090 #: ../fish/guestfish-actions.pod:71
24092 "The other optional parameters are passed directly through to L</add-drive-"
24098 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24099 #: ../fish/guestfish-actions.pod:2977
24101 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24106 #: ../fish/guestfish-actions.pod:76
24112 #: ../fish/guestfish-actions.pod:78
24115 " add-drive filename\n"
24121 #: ../fish/guestfish-actions.pod:80
24123 "This function is the equivalent of calling L</add-drive-opts> with no "
24124 "optional parameters, so the disk is added writable, with the format being "
24125 "detected automatically."
24130 #: ../fish/guestfish-actions.pod:84
24132 "Automatic detection of the format opens you up to a potential security hole "
24133 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24134 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24135 "you should think about replacing calls to this function with calls to L</add-"
24136 "drive-opts>, and specifying the format."
24141 #: ../fish/guestfish-actions.pod:91
24142 msgid "add-drive-opts"
24147 #: ../fish/guestfish-actions.pod:93
24153 #: ../fish/guestfish-actions.pod:95
24156 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24162 #: ../fish/guestfish-actions.pod:122
24164 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24165 "add-drive-ro>) then the format is automatically detected. Possible formats "
24166 "include C<raw> and C<qcow2>."
24171 #: ../fish/guestfish-actions.pod:133
24173 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24174 "add-drive-with-if> call (q.v.)"
24179 #: ../fish/guestfish-actions.pod:140
24180 msgid "add-drive-ro"
24185 #: ../fish/guestfish-actions.pod:142
24191 #: ../fish/guestfish-actions.pod:144
24194 " add-drive-ro filename\n"
24200 #: ../fish/guestfish-actions.pod:146
24202 "This function is the equivalent of calling L</add-drive-opts> with the "
24203 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24204 "is added read-only, with the format being detected automatically."
24209 #: ../fish/guestfish-actions.pod:151
24210 msgid "add-drive-ro-with-if"
24215 #: ../fish/guestfish-actions.pod:153
24218 " add-drive-ro-with-if filename iface\n"
24224 #: ../fish/guestfish-actions.pod:155
24226 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24227 "interface emulation to use at run time."
24232 #: ../fish/guestfish-actions.pod:165
24233 msgid "add-drive-with-if"
24238 #: ../fish/guestfish-actions.pod:167
24241 " add-drive-with-if filename iface\n"
24247 #: ../fish/guestfish-actions.pod:169
24249 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24250 "interface emulation to use at run time."
24255 #: ../fish/guestfish-actions.pod:179
24261 #: ../fish/guestfish-actions.pod:181
24264 " aug-clear augpath\n"
24270 #: ../fish/guestfish-actions.pod:186
24276 #: ../fish/guestfish-actions.pod:188
24285 #: ../fish/guestfish-actions.pod:190
24287 "Close the current Augeas handle and free up any resources used by it. After "
24288 "calling this, you have to call L</aug-init> again before you can use any "
24289 "other Augeas functions."
24294 #: ../fish/guestfish-actions.pod:195
24295 msgid "aug-defnode"
24300 #: ../fish/guestfish-actions.pod:197
24303 " aug-defnode name expr val\n"
24309 #: ../fish/guestfish-actions.pod:202
24311 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24312 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24313 "containing that single node."
24318 #: ../fish/guestfish-actions.pod:210
24324 #: ../fish/guestfish-actions.pod:212
24327 " aug-defvar name expr\n"
24333 #: ../fish/guestfish-actions.pod:221
24339 #: ../fish/guestfish-actions.pod:223
24342 " aug-get augpath\n"
24348 #: ../fish/guestfish-actions.pod:228
24354 #: ../fish/guestfish-actions.pod:230
24357 " aug-init root flags\n"
24363 #: ../fish/guestfish-actions.pod:236
24364 msgid "You must call this before using any other L</aug-*> commands."
24369 #: ../fish/guestfish-actions.pod:271
24370 msgid "Do not load the tree in L</aug-init>."
24375 #: ../fish/guestfish-actions.pod:275
24376 msgid "To close the handle, you can call L</aug-close>."
24381 #: ../fish/guestfish-actions.pod:279
24387 #: ../fish/guestfish-actions.pod:281
24390 " aug-insert augpath label true|false\n"
24396 #: ../fish/guestfish-actions.pod:291
24402 #: ../fish/guestfish-actions.pod:293
24411 #: ../fish/guestfish-actions.pod:300
24417 #: ../fish/guestfish-actions.pod:302
24420 " aug-ls augpath\n"
24426 #: ../fish/guestfish-actions.pod:304
24428 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24429 "resulting nodes into alphabetical order."
24434 #: ../fish/guestfish-actions.pod:307
24440 #: ../fish/guestfish-actions.pod:309
24443 " aug-match augpath\n"
24449 #: ../fish/guestfish-actions.pod:315
24455 #: ../fish/guestfish-actions.pod:317
24458 " aug-mv src dest\n"
24464 #: ../fish/guestfish-actions.pod:322
24470 #: ../fish/guestfish-actions.pod:324
24473 " aug-rm augpath\n"
24479 #: ../fish/guestfish-actions.pod:330
24485 #: ../fish/guestfish-actions.pod:332
24494 #: ../fish/guestfish-actions.pod:336
24496 "The flags which were passed to L</aug-init> affect exactly how files are "
24502 #: ../fish/guestfish-actions.pod:339
24508 #: ../fish/guestfish-actions.pod:341
24511 " aug-set augpath val\n"
24517 #: ../fish/guestfish-actions.pod:345
24519 "In the Augeas API, it is possible to clear a node by setting the value to "
24520 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24521 "this call. Instead you must use the L</aug-clear> call."
24526 #: ../fish/guestfish-actions.pod:350
24532 #: ../fish/guestfish-actions.pod:352
24535 " available 'groups ...'\n"
24541 #: ../fish/guestfish-actions.pod:358
24543 "The libguestfs groups, and the functions that those groups correspond to, "
24544 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24545 "runtime by calling L</available-all-groups>."
24550 #: ../fish/guestfish-actions.pod:382
24551 msgid "You must call L</launch> before calling this function."
24556 #: ../fish/guestfish-actions.pod:404
24558 "This call was added in version C<1.0.80>. In previous versions of "
24559 "libguestfs all you could do would be to speculatively execute a command to "
24560 "find out if the daemon implemented it. See also L</version>."
24565 #: ../fish/guestfish-actions.pod:411
24566 msgid "available-all-groups"
24571 #: ../fish/guestfish-actions.pod:413
24574 " available-all-groups\n"
24580 #: ../fish/guestfish-actions.pod:415
24582 "This command returns a list of all optional groups that this daemon knows "
24583 "about. Note this returns both supported and unsupported groups. To find "
24584 "out which ones the daemon can actually support you have to call L</"
24585 "available> on each member of the returned list."
24590 #: ../fish/guestfish-actions.pod:421
24591 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24596 #: ../fish/guestfish-actions.pod:423
24602 #: ../fish/guestfish-actions.pod:425
24605 " base64-in (base64file|-) filename\n"
24611 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24612 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24613 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24614 #: ../fish/guestfish-actions.pod:4375 ../fish/guestfish-actions.pod:4387
24615 #: ../fish/guestfish-actions.pod:4398 ../fish/guestfish-actions.pod:4409
24616 #: ../fish/guestfish-actions.pod:4461 ../fish/guestfish-actions.pod:4470
24617 #: ../fish/guestfish-actions.pod:4524 ../fish/guestfish-actions.pod:4547
24618 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24623 #: ../fish/guestfish-actions.pod:432
24629 #: ../fish/guestfish-actions.pod:434
24632 " base64-out filename (base64file|-)\n"
24638 #: ../fish/guestfish-actions.pod:441
24639 msgid "blockdev-flushbufs"
24644 #: ../fish/guestfish-actions.pod:443
24647 " blockdev-flushbufs device\n"
24653 #: ../fish/guestfish-actions.pod:450
24654 msgid "blockdev-getbsz"
24659 #: ../fish/guestfish-actions.pod:452
24662 " blockdev-getbsz device\n"
24668 #: ../fish/guestfish-actions.pod:461
24669 msgid "blockdev-getro"
24674 #: ../fish/guestfish-actions.pod:463
24677 " blockdev-getro device\n"
24683 #: ../fish/guestfish-actions.pod:470
24684 msgid "blockdev-getsize64"
24689 #: ../fish/guestfish-actions.pod:472
24692 " blockdev-getsize64 device\n"
24698 #: ../fish/guestfish-actions.pod:476
24699 msgid "See also L</blockdev-getsz>."
24704 #: ../fish/guestfish-actions.pod:480
24705 msgid "blockdev-getss"
24710 #: ../fish/guestfish-actions.pod:482
24713 " blockdev-getss device\n"
24719 #: ../fish/guestfish-actions.pod:487
24721 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
24726 #: ../fish/guestfish-actions.pod:492
24727 msgid "blockdev-getsz"
24732 #: ../fish/guestfish-actions.pod:494
24735 " blockdev-getsz device\n"
24741 #: ../fish/guestfish-actions.pod:499
24743 "See also L</blockdev-getss> for the real sector size of the device, and L</"
24744 "blockdev-getsize64> for the more useful I<size in bytes>."
24749 #: ../fish/guestfish-actions.pod:505
24750 msgid "blockdev-rereadpt"
24755 #: ../fish/guestfish-actions.pod:507
24758 " blockdev-rereadpt device\n"
24764 #: ../fish/guestfish-actions.pod:513
24765 msgid "blockdev-setbsz"
24770 #: ../fish/guestfish-actions.pod:515
24773 " blockdev-setbsz device blocksize\n"
24779 #: ../fish/guestfish-actions.pod:524
24780 msgid "blockdev-setro"
24785 #: ../fish/guestfish-actions.pod:526
24788 " blockdev-setro device\n"
24794 #: ../fish/guestfish-actions.pod:532
24795 msgid "blockdev-setrw"
24800 #: ../fish/guestfish-actions.pod:534
24803 " blockdev-setrw device\n"
24809 #: ../fish/guestfish-actions.pod:540
24810 msgid "case-sensitive-path"
24815 #: ../fish/guestfish-actions.pod:542
24818 " case-sensitive-path path\n"
24824 #: ../fish/guestfish-actions.pod:566
24826 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
24827 "WINDOWS/system32\"> (the exact return value would depend on details of how "
24828 "the directories were originally created under Windows)."
24833 #: ../fish/guestfish-actions.pod:574
24834 msgid "See also L</realpath>."
24839 #: ../fish/guestfish-actions.pod:576
24845 #: ../fish/guestfish-actions.pod:578
24854 #: ../fish/guestfish-actions.pod:582
24856 "Note that this function cannot correctly handle binary files (specifically, "
24857 "files containing C<\\0> character which is treated as end of string). For "
24858 "those you need to use the L</read-file> or L</download> functions which have "
24859 "a more complex interface."
24864 #: ../fish/guestfish-actions.pod:590
24870 #: ../fish/guestfish-actions.pod:592
24873 " checksum csumtype path\n"
24879 #: ../fish/guestfish-actions.pod:635
24880 msgid "To get the checksum for a device, use L</checksum-device>."
24885 #: ../fish/guestfish-actions.pod:637
24886 msgid "To get the checksums for many files, use L</checksums-out>."
24891 #: ../fish/guestfish-actions.pod:639
24892 msgid "checksum-device"
24897 #: ../fish/guestfish-actions.pod:641
24900 " checksum-device csumtype device\n"
24906 #: ../fish/guestfish-actions.pod:643
24908 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
24909 "device named C<device>. For the types of checksums supported see the L</"
24910 "checksum> command."
24915 #: ../fish/guestfish-actions.pod:647
24916 msgid "checksums-out"
24921 #: ../fish/guestfish-actions.pod:649
24924 " checksums-out csumtype directory (sumsfile|-)\n"
24930 #: ../fish/guestfish-actions.pod:665
24936 #: ../fish/guestfish-actions.pod:667
24939 " chmod mode path\n"
24945 #: ../fish/guestfish-actions.pod:678
24951 #: ../fish/guestfish-actions.pod:680
24954 " chown owner group path\n"
24960 #: ../fish/guestfish-actions.pod:688
24966 #: ../fish/guestfish-actions.pod:690
24969 " command 'arguments ...'\n"
24975 #: ../fish/guestfish-actions.pod:697
24977 "The single parameter is an argv-style list of arguments. The first element "
24978 "is the name of the program to run. Subsequent elements are parameters. The "
24979 "list must be non-empty (ie. must contain a program name). Note that the "
24980 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
24985 #: ../fish/guestfish-actions.pod:725
24986 msgid "command-lines"
24991 #: ../fish/guestfish-actions.pod:727
24994 " command-lines 'arguments ...'\n"
25000 #: ../fish/guestfish-actions.pod:729
25002 "This is the same as L</command>, but splits the result into a list of lines."
25007 #: ../fish/guestfish-actions.pod:732
25008 msgid "See also: L</sh-lines>"
25013 #: ../fish/guestfish-actions.pod:737
25019 #: ../fish/guestfish-actions.pod:739
25022 " config qemuparam qemuvalue\n"
25028 #: ../fish/guestfish-actions.pod:750
25034 #: ../fish/guestfish-actions.pod:752
25037 " copy-size src dest size\n"
25043 #: ../fish/guestfish-actions.pod:760
25049 #: ../fish/guestfish-actions.pod:762
25058 #: ../fish/guestfish-actions.pod:767
25064 #: ../fish/guestfish-actions.pod:769
25073 #: ../fish/guestfish-actions.pod:774
25079 #: ../fish/guestfish-actions.pod:776
25088 #: ../fish/guestfish-actions.pod:783
25090 "If the destination is a device, it must be as large or larger than the "
25091 "source file or device, otherwise the copy will fail. This command cannot do "
25092 "partial copies (see L</copy-size>)."
25097 #: ../fish/guestfish-actions.pod:787
25103 #: ../fish/guestfish-actions.pod:789
25112 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25114 "This command is mostly useful for interactive sessions. It is I<not> "
25115 "intended that you try to parse the output string. Use L</statvfs> from "
25121 #: ../fish/guestfish-actions.pod:797
25127 #: ../fish/guestfish-actions.pod:799
25136 #: ../fish/guestfish-actions.pod:808
25142 #: ../fish/guestfish-actions.pod:810
25151 #: ../fish/guestfish-actions.pod:816
25153 "Another way to get the same information is to enable verbose messages with "
25154 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25155 "before running the program."
25160 #: ../fish/guestfish-actions.pod:821
25166 #: ../fish/guestfish-actions.pod:823
25169 " download remotefilename (filename|-)\n"
25175 #: ../fish/guestfish-actions.pod:830
25176 msgid "See also L</upload>, L</cat>."
25181 #: ../fish/guestfish-actions.pod:834
25182 msgid "download-offset"
25187 #: ../fish/guestfish-actions.pod:836
25190 " download-offset remotefilename (filename|-) offset size\n"
25196 #: ../fish/guestfish-actions.pod:844
25198 "Note that there is no limit on the amount of data that can be downloaded "
25199 "with this call, unlike with L</pread>, and this call always reads the full "
25200 "amount unless an error occurs."
25205 #: ../fish/guestfish-actions.pod:849
25206 msgid "See also L</download>, L</pread>."
25211 #: ../fish/guestfish-actions.pod:853
25212 msgid "drop-caches"
25217 #: ../fish/guestfish-actions.pod:855
25220 " drop-caches whattodrop\n"
25226 #: ../fish/guestfish-actions.pod:867
25232 #: ../fish/guestfish-actions.pod:869
25241 #: ../fish/guestfish-actions.pod:881
25247 #: ../fish/guestfish-actions.pod:883
25250 " e2fsck-f device\n"
25256 #: ../fish/guestfish-actions.pod:889
25258 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25259 "should use L</fsck>."
25264 #: ../fish/guestfish-actions.pod:892
25265 msgid "echo-daemon"
25270 #: ../fish/guestfish-actions.pod:894
25273 " echo-daemon 'words ...'\n"
25279 #: ../fish/guestfish-actions.pod:901
25280 msgid "See also L</ping-daemon>."
25285 #: ../fish/guestfish-actions.pod:903
25291 #: ../fish/guestfish-actions.pod:905
25294 " egrep regex path\n"
25300 #: ../fish/guestfish-actions.pod:913
25306 #: ../fish/guestfish-actions.pod:915
25309 " egrepi regex path\n"
25315 #: ../fish/guestfish-actions.pod:923
25321 #: ../fish/guestfish-actions.pod:925
25324 " equal file1 file2\n"
25330 #: ../fish/guestfish-actions.pod:932
25336 #: ../fish/guestfish-actions.pod:934
25345 #: ../fish/guestfish-actions.pod:939
25346 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25351 #: ../fish/guestfish-actions.pod:941
25357 #: ../fish/guestfish-actions.pod:943
25360 " fallocate path len\n"
25366 #: ../fish/guestfish-actions.pod:960
25367 msgid "fallocate64"
25372 #: ../fish/guestfish-actions.pod:962
25375 " fallocate64 path len\n"
25381 #: ../fish/guestfish-actions.pod:968
25383 "Note that this call allocates disk blocks for the file. To create a sparse "
25384 "file use L</truncate-size> instead."
25389 #: ../fish/guestfish-actions.pod:971
25391 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25392 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25393 "maximum size of files created through that call to 1GB."
25398 #: ../fish/guestfish-actions.pod:980
25404 #: ../fish/guestfish-actions.pod:982
25407 " fgrep pattern path\n"
25413 #: ../fish/guestfish-actions.pod:990
25419 #: ../fish/guestfish-actions.pod:992
25422 " fgrepi pattern path\n"
25428 #: ../fish/guestfish-actions.pod:1000
25434 #: ../fish/guestfish-actions.pod:1002
25443 #: ../fish/guestfish-actions.pod:1014
25445 "This command can also be used on C</dev/> devices (and partitions, LV "
25446 "names). You can for example use this to determine if a device contains a "
25447 "filesystem, although it's usually better to use L</vfs-type>."
25452 #: ../fish/guestfish-actions.pod:1024
25453 msgid "file-architecture"
25458 #: ../fish/guestfish-actions.pod:1026
25461 " file-architecture filename\n"
25467 #: ../fish/guestfish-actions.pod:1129
25473 #: ../fish/guestfish-actions.pod:1131
25482 #: ../fish/guestfish-actions.pod:1135
25484 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25485 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25490 #: ../fish/guestfish-actions.pod:1139
25496 #: ../fish/guestfish-actions.pod:1141
25499 " fill c len path\n"
25505 #: ../fish/guestfish-actions.pod:1147
25507 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25508 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25509 "L</fill-pattern>."
25514 #: ../fish/guestfish-actions.pod:1152
25515 msgid "fill-pattern"
25520 #: ../fish/guestfish-actions.pod:1154
25523 " fill-pattern pattern len path\n"
25529 #: ../fish/guestfish-actions.pod:1156
25531 "This function is like L</fill> except that it creates a new file of length "
25532 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25533 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25539 #: ../fish/guestfish-actions.pod:1161
25545 #: ../fish/guestfish-actions.pod:1163
25548 " find directory\n"
25554 #: ../fish/guestfish-actions.pod:1177
25555 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25560 #: ../fish/guestfish-actions.pod:1190
25561 msgid "See also L</find0>."
25566 #: ../fish/guestfish-actions.pod:1195
25572 #: ../fish/guestfish-actions.pod:1197
25575 " find0 directory (files|-)\n"
25581 #: ../fish/guestfish-actions.pod:1203
25583 "This command works the same way as L</find> with the following exceptions:"
25588 #: ../fish/guestfish-actions.pod:1230
25589 msgid "findfs-label"
25594 #: ../fish/guestfish-actions.pod:1232
25597 " findfs-label label\n"
25603 #: ../fish/guestfish-actions.pod:1238
25604 msgid "To find the label of a filesystem, use L</vfs-label>."
25609 #: ../fish/guestfish-actions.pod:1240
25610 msgid "findfs-uuid"
25615 #: ../fish/guestfish-actions.pod:1242
25618 " findfs-uuid uuid\n"
25624 #: ../fish/guestfish-actions.pod:1248
25625 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25630 #: ../fish/guestfish-actions.pod:1250
25636 #: ../fish/guestfish-actions.pod:1252
25639 " fsck fstype device\n"
25645 #: ../fish/guestfish-actions.pod:1282
25651 #: ../fish/guestfish-actions.pod:1284
25659 #: ../fish/guestfish-actions.pod:1291
25660 msgid "get-attach-method"
25664 #: ../fish/guestfish-actions.pod:1293
25667 " get-attach-method\n"
25672 #: ../fish/guestfish-actions.pod:1295
25673 msgid "Return the current attach method. See L</set-attach-method>."
25678 #: ../fish/guestfish-actions.pod:1297
25679 msgid "get-autosync"
25684 #: ../fish/guestfish-actions.pod:1299
25693 #: ../fish/guestfish-actions.pod:1303
25699 #: ../fish/guestfish-actions.pod:1305
25708 #: ../fish/guestfish-actions.pod:1309
25709 msgid "get-e2label"
25714 #: ../fish/guestfish-actions.pod:1311
25717 " get-e2label device\n"
25723 #: ../fish/guestfish-actions.pod:1323
25729 #: ../fish/guestfish-actions.pod:1325
25732 " get-e2uuid device\n"
25738 #: ../fish/guestfish-actions.pod:1337
25739 msgid "get-memsize"
25744 #: ../fish/guestfish-actions.pod:1339
25753 #: ../fish/guestfish-actions.pod:1344
25755 "If L</set-memsize> was not called on this handle, and if "
25756 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
25757 "value for memsize."
25762 #: ../fish/guestfish-actions.pod:1351
25763 msgid "get-network"
25768 #: ../fish/guestfish-actions.pod:1353
25777 #: ../fish/guestfish-actions.pod:1357
25783 #: ../fish/guestfish-actions.pod:1359
25792 #: ../fish/guestfish-actions.pod:1366
25798 #: ../fish/guestfish-actions.pod:1368
25804 #: ../fish/guestfish-actions.pod:1370
25813 #: ../fish/guestfish-actions.pod:1377
25819 #: ../fish/guestfish-actions.pod:1379
25828 #: ../fish/guestfish-actions.pod:1386
25829 msgid "get-recovery-proc"
25834 #: ../fish/guestfish-actions.pod:1388
25837 " get-recovery-proc\n"
25843 #: ../fish/guestfish-actions.pod:1392
25844 msgid "get-selinux"
25849 #: ../fish/guestfish-actions.pod:1394
25858 #: ../fish/guestfish-actions.pod:1396
25860 "This returns the current setting of the selinux flag which is passed to the "
25861 "appliance at boot time. See L</set-selinux>."
25866 #: ../fish/guestfish-actions.pod:1402
25872 #: ../fish/guestfish-actions.pod:1404
25881 #: ../fish/guestfish-actions.pod:1411
25887 #: ../fish/guestfish-actions.pod:1413
25896 #: ../fish/guestfish-actions.pod:1417
25902 #: ../fish/guestfish-actions.pod:1419
25911 #: ../fish/guestfish-actions.pod:1421
25913 "Return the current umask. By default the umask is C<022> unless it has been "
25914 "set by calling L</umask>."
25919 #: ../fish/guestfish-actions.pod:1424
25920 msgid "get-verbose"
25925 #: ../fish/guestfish-actions.pod:1426
25934 #: ../fish/guestfish-actions.pod:1430
25940 #: ../fish/guestfish-actions.pod:1432
25949 #: ../fish/guestfish-actions.pod:1436
25950 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
25955 #: ../fish/guestfish-actions.pod:1439
25961 #: ../fish/guestfish-actions.pod:1441
25964 " getxattr path name\n"
25970 #: ../fish/guestfish-actions.pod:1443
25972 "Get a single extended attribute from file C<path> named C<name>. This call "
25973 "follows symlinks. If you want to lookup an extended attribute for the "
25974 "symlink itself, use L</lgetxattr>."
25979 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2383
25981 "Normally it is better to get all extended attributes from a file in one go "
25982 "by calling L</getxattrs>. However some Linux filesystem implementations are "
25983 "buggy and do not provide a way to list out attributes. For these "
25984 "filesystems (notably ntfs-3g) you have to know the names of the extended "
25985 "attributes you want in advance and call this function."
25990 #: ../fish/guestfish-actions.pod:1457
25991 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
25996 #: ../fish/guestfish-actions.pod:1459
26002 #: ../fish/guestfish-actions.pod:1461
26005 " getxattrs path\n"
26011 #: ../fish/guestfish-actions.pod:1469
26012 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26017 #: ../fish/guestfish-actions.pod:1471
26018 msgid "glob-expand"
26023 #: ../fish/guestfish-actions.pod:1473
26026 " glob-expand pattern\n"
26032 #: ../fish/guestfish-actions.pod:1486
26038 #: ../fish/guestfish-actions.pod:1488
26041 " grep regex path\n"
26047 #: ../fish/guestfish-actions.pod:1496
26053 #: ../fish/guestfish-actions.pod:1498
26056 " grepi regex path\n"
26062 #: ../fish/guestfish-actions.pod:1506
26063 msgid "grub-install"
26068 #: ../fish/guestfish-actions.pod:1508
26071 " grub-install root device\n"
26077 #: ../fish/guestfish-actions.pod:1524
26083 #: ../fish/guestfish-actions.pod:1526
26092 #: ../fish/guestfish-actions.pod:1534
26098 #: ../fish/guestfish-actions.pod:1536
26101 " head-n nrlines path\n"
26107 #: ../fish/guestfish-actions.pod:1549
26113 #: ../fish/guestfish-actions.pod:1551
26122 #: ../fish/guestfish-actions.pod:1559
26128 #: ../fish/guestfish-actions.pod:1561
26131 " initrd-cat initrdpath filename\n"
26137 #: ../fish/guestfish-actions.pod:1573
26138 msgid "See also L</initrd-list>."
26143 #: ../fish/guestfish-actions.pod:1578
26144 msgid "initrd-list"
26149 #: ../fish/guestfish-actions.pod:1580
26152 " initrd-list path\n"
26158 #: ../fish/guestfish-actions.pod:1592
26159 msgid "inotify-add-watch"
26164 #: ../fish/guestfish-actions.pod:1594
26167 " inotify-add-watch path mask\n"
26173 #: ../fish/guestfish-actions.pod:1606
26174 msgid "inotify-close"
26179 #: ../fish/guestfish-actions.pod:1608
26188 #: ../fish/guestfish-actions.pod:1614
26189 msgid "inotify-files"
26194 #: ../fish/guestfish-actions.pod:1616
26203 #: ../fish/guestfish-actions.pod:1618
26205 "This function is a helpful wrapper around L</inotify-read> which just "
26206 "returns a list of pathnames of objects that were touched. The returned "
26207 "pathnames are sorted and deduplicated."
26212 #: ../fish/guestfish-actions.pod:1622
26213 msgid "inotify-init"
26218 #: ../fish/guestfish-actions.pod:1624
26221 " inotify-init maxevents\n"
26227 #: ../fish/guestfish-actions.pod:1630
26229 "C<maxevents> is the maximum number of events which will be queued up between "
26230 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26231 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26232 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26233 "but records the fact that it threw them away by setting a flag "
26234 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26239 #: ../fish/guestfish-actions.pod:1640
26241 "Before any events are generated, you have to add some watches to the "
26242 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26243 "L</inotify-watch-all>."
26248 #: ../fish/guestfish-actions.pod:1646
26250 "Queued up events should be read periodically by calling L</inotify-read> (or "
26251 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26252 "If you don't read the events out often enough then you risk the internal "
26253 "queue overflowing."
26258 #: ../fish/guestfish-actions.pod:1653
26260 "The handle should be closed after use by calling L</inotify-close>. This "
26261 "also removes any watches automatically."
26266 #: ../fish/guestfish-actions.pod:1662
26267 msgid "inotify-read"
26272 #: ../fish/guestfish-actions.pod:1664
26281 #: ../fish/guestfish-actions.pod:1677
26282 msgid "inotify-rm-watch"
26287 #: ../fish/guestfish-actions.pod:1679
26290 " inotify-rm-watch wd\n"
26296 #: ../fish/guestfish-actions.pod:1681
26297 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26302 #: ../fish/guestfish-actions.pod:1684
26303 msgid "inspect-get-arch"
26308 #: ../fish/guestfish-actions.pod:1686
26311 " inspect-get-arch root\n"
26317 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26318 #: ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1796
26319 #: ../fish/guestfish-actions.pod:1830 ../fish/guestfish-actions.pod:1845
26320 #: ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:1881
26321 #: ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1930
26322 #: ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1971
26323 #: ../fish/guestfish-actions.pod:2014 ../fish/guestfish-actions.pod:2049
26324 #: ../fish/guestfish-actions.pod:2065 ../fish/guestfish-actions.pod:2078
26325 #: ../fish/guestfish-actions.pod:2091 ../fish/guestfish-actions.pod:2106
26327 "This function should only be called with a root device string as returned by "
26333 #: ../fish/guestfish-actions.pod:1691
26335 "This returns the architecture of the inspected operating system. The "
26336 "possible return values are listed under L</file-architecture>."
26341 #: ../fish/guestfish-actions.pod:1700
26342 msgid "inspect-get-distro"
26347 #: ../fish/guestfish-actions.pod:1702
26350 " inspect-get-distro root\n"
26356 #: ../fish/guestfish-actions.pod:1774
26357 msgid "inspect-get-filesystems"
26362 #: ../fish/guestfish-actions.pod:1776
26365 " inspect-get-filesystems root\n"
26371 #: ../fish/guestfish-actions.pod:1789
26373 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26374 "get-mountpoints>."
26378 #: ../fish/guestfish-actions.pod:1792
26379 msgid "inspect-get-format"
26383 #: ../fish/guestfish-actions.pod:1794
26386 " inspect-get-format root\n"
26392 #: ../fish/guestfish-actions.pod:1826
26393 msgid "inspect-get-hostname"
26398 #: ../fish/guestfish-actions.pod:1828
26401 " inspect-get-hostname root\n"
26407 #: ../fish/guestfish-actions.pod:1841
26408 msgid "inspect-get-major-version"
26413 #: ../fish/guestfish-actions.pod:1843
26416 " inspect-get-major-version root\n"
26422 #: ../fish/guestfish-actions.pod:1862
26423 msgid "inspect-get-minor-version"
26428 #: ../fish/guestfish-actions.pod:1864
26431 " inspect-get-minor-version root\n"
26437 #: ../fish/guestfish-actions.pod:1874
26439 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26440 "get-major-version>."
26445 #: ../fish/guestfish-actions.pod:1877
26446 msgid "inspect-get-mountpoints"
26451 #: ../fish/guestfish-actions.pod:1879
26454 " inspect-get-mountpoints root\n"
26460 #: ../fish/guestfish-actions.pod:1901
26462 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26463 "get-filesystems>."
26468 #: ../fish/guestfish-actions.pod:1904
26469 msgid "inspect-get-package-format"
26474 #: ../fish/guestfish-actions.pod:1906
26477 " inspect-get-package-format root\n"
26483 #: ../fish/guestfish-actions.pod:1911
26485 "This function and L</inspect-get-package-management> return the package "
26486 "format and package management tool used by the inspected operating system. "
26487 "For example for Fedora these functions would return C<rpm> (package format) "
26488 "and C<yum> (package management)."
26493 #: ../fish/guestfish-actions.pod:1926
26494 msgid "inspect-get-package-management"
26499 #: ../fish/guestfish-actions.pod:1928
26502 " inspect-get-package-management root\n"
26508 #: ../fish/guestfish-actions.pod:1933
26510 "L</inspect-get-package-format> and this function return the package format "
26511 "and package management tool used by the inspected operating system. For "
26512 "example for Fedora these functions would return C<rpm> (package format) and "
26513 "C<yum> (package management)."
26518 #: ../fish/guestfish-actions.pod:1950
26519 msgid "inspect-get-product-name"
26524 #: ../fish/guestfish-actions.pod:1952
26527 " inspect-get-product-name root\n"
26532 #: ../fish/guestfish-actions.pod:1967
26533 msgid "inspect-get-product-variant"
26537 #: ../fish/guestfish-actions.pod:1969
26540 " inspect-get-product-variant root\n"
26545 #: ../fish/guestfish-actions.pod:1993
26547 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26548 "get-product-name>, L</inspect-get-major-version>."
26553 #: ../fish/guestfish-actions.pod:1997
26554 msgid "inspect-get-roots"
26559 #: ../fish/guestfish-actions.pod:1999
26562 " inspect-get-roots\n"
26568 #: ../fish/guestfish-actions.pod:2001
26570 "This function is a convenient way to get the list of root devices, as "
26571 "returned from a previous call to L</inspect-os>, but without redoing the "
26572 "whole inspection process."
26577 #: ../fish/guestfish-actions.pod:2005
26579 "This returns an empty list if either no root devices were found or the "
26580 "caller has not called L</inspect-os>."
26585 #: ../fish/guestfish-actions.pod:2010
26586 msgid "inspect-get-type"
26591 #: ../fish/guestfish-actions.pod:2012
26594 " inspect-get-type root\n"
26600 #: ../fish/guestfish-actions.pod:2045
26601 msgid "inspect-get-windows-systemroot"
26606 #: ../fish/guestfish-actions.pod:2047
26609 " inspect-get-windows-systemroot root\n"
26614 #: ../fish/guestfish-actions.pod:2061
26615 msgid "inspect-is-live"
26619 #: ../fish/guestfish-actions.pod:2063
26622 " inspect-is-live root\n"
26627 #: ../fish/guestfish-actions.pod:2068
26629 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26630 "then this returns true if a live image was detected on the disk."
26634 #: ../fish/guestfish-actions.pod:2074
26635 msgid "inspect-is-multipart"
26639 #: ../fish/guestfish-actions.pod:2076
26642 " inspect-is-multipart root\n"
26647 #: ../fish/guestfish-actions.pod:2081
26649 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26650 "then this returns true if the disk is part of a set."
26654 #: ../fish/guestfish-actions.pod:2087
26655 msgid "inspect-is-netinst"
26659 #: ../fish/guestfish-actions.pod:2089
26662 " inspect-is-netinst root\n"
26667 #: ../fish/guestfish-actions.pod:2094
26669 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26670 "then this returns true if the disk is a network installer, ie. not a self-"
26671 "contained install CD but one which is likely to require network access to "
26672 "complete the install."
26677 #: ../fish/guestfish-actions.pod:2102
26678 msgid "inspect-list-applications"
26683 #: ../fish/guestfish-actions.pod:2104
26686 " inspect-list-applications root\n"
26692 #: ../fish/guestfish-actions.pod:2111
26694 "I<Note:> This call works differently from other parts of the inspection "
26695 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
26696 "then mount up the disks, before calling this. Listing applications is a "
26697 "significantly more difficult operation which requires access to the full "
26698 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
26699 "are just returning data cached in the libguestfs handle, this call actually "
26700 "reads parts of the mounted filesystems during the call."
26705 #: ../fish/guestfish-actions.pod:2201
26711 #: ../fish/guestfish-actions.pod:2203
26720 #: ../fish/guestfish-actions.pod:2218
26722 "You can pass the root string(s) returned to other L</inspect-get-*> "
26723 "functions in order to query further information about each operating system, "
26724 "such as the name and version."
26729 #: ../fish/guestfish-actions.pod:2223
26731 "This function uses other libguestfs features such as L</mount-ro> and L</"
26732 "umount-all> in order to mount and unmount filesystems and look at the "
26733 "contents. This should be called with no disks currently mounted. The "
26734 "function may also use Augeas, so any existing Augeas handle will be closed."
26739 #: ../fish/guestfish-actions.pod:2235 ../fish/guestfish-actions.pod:2411
26740 #: ../fish/guestfish-actions.pod:2457
26741 msgid "See also L</list-filesystems>."
26746 #: ../fish/guestfish-actions.pod:2237
26747 msgid "is-blockdev"
26752 #: ../fish/guestfish-actions.pod:2239
26755 " is-blockdev path\n"
26761 #: ../fish/guestfish-actions.pod:2244 ../fish/guestfish-actions.pod:2262
26762 #: ../fish/guestfish-actions.pod:2281 ../fish/guestfish-actions.pod:2290
26763 #: ../fish/guestfish-actions.pod:2300 ../fish/guestfish-actions.pod:2334
26764 #: ../fish/guestfish-actions.pod:2343
26765 msgid "See also L</stat>."
26770 #: ../fish/guestfish-actions.pod:2246
26776 #: ../fish/guestfish-actions.pod:2248
26785 #: ../fish/guestfish-actions.pod:2255
26791 #: ../fish/guestfish-actions.pod:2257
26794 " is-chardev path\n"
26800 #: ../fish/guestfish-actions.pod:2264
26806 #: ../fish/guestfish-actions.pod:2266
26815 #: ../fish/guestfish-actions.pod:2273
26821 #: ../fish/guestfish-actions.pod:2275
26830 #: ../fish/guestfish-actions.pod:2283
26836 #: ../fish/guestfish-actions.pod:2285
26845 #: ../fish/guestfish-actions.pod:2292
26851 #: ../fish/guestfish-actions.pod:2294
26860 #: ../fish/guestfish-actions.pod:2302
26861 msgid "is-launching"
26866 #: ../fish/guestfish-actions.pod:2304
26875 #: ../fish/guestfish-actions.pod:2311
26881 #: ../fish/guestfish-actions.pod:2313
26890 #: ../fish/guestfish-actions.pod:2318
26896 #: ../fish/guestfish-actions.pod:2320
26905 #: ../fish/guestfish-actions.pod:2327
26911 #: ../fish/guestfish-actions.pod:2329
26914 " is-socket path\n"
26920 #: ../fish/guestfish-actions.pod:2336
26926 #: ../fish/guestfish-actions.pod:2338
26929 " is-symlink path\n"
26935 #: ../fish/guestfish-actions.pod:2345
26936 msgid "kill-subprocess"
26941 #: ../fish/guestfish-actions.pod:2347
26944 " kill-subprocess\n"
26950 #: ../fish/guestfish-actions.pod:2351
26956 #: ../fish/guestfish-actions.pod:2353
26962 #: ../fish/guestfish-actions.pod:2355
26971 #: ../fish/guestfish-actions.pod:2363
26977 #: ../fish/guestfish-actions.pod:2365
26980 " lchown owner group path\n"
26986 #: ../fish/guestfish-actions.pod:2367
26988 "Change the file owner to C<owner> and group to C<group>. This is like L</"
26989 "chown> but if C<path> is a symlink then the link itself is changed, not the "
26995 #: ../fish/guestfish-actions.pod:2375
27001 #: ../fish/guestfish-actions.pod:2377
27004 " lgetxattr path name\n"
27010 #: ../fish/guestfish-actions.pod:2393
27011 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27016 #: ../fish/guestfish-actions.pod:2395
27022 #: ../fish/guestfish-actions.pod:2397
27025 " lgetxattrs path\n"
27031 #: ../fish/guestfish-actions.pod:2399
27033 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27034 "it returns the extended attributes of the link itself."
27039 #: ../fish/guestfish-actions.pod:2403
27040 msgid "list-devices"
27045 #: ../fish/guestfish-actions.pod:2405
27054 #: ../fish/guestfish-actions.pod:2413
27055 msgid "list-filesystems"
27060 #: ../fish/guestfish-actions.pod:2415
27063 " list-filesystems\n"
27069 #: ../fish/guestfish-actions.pod:2434
27071 "This command runs other libguestfs commands, which might include L</mount> "
27072 "and L</umount>, and therefore you should use this soon after launch and only "
27073 "when nothing is mounted."
27078 #: ../fish/guestfish-actions.pod:2438
27080 "Not all of the filesystems returned will be mountable. In particular, swap "
27081 "partitions are returned in the list. Also this command does not check that "
27082 "each filesystem found is valid and mountable, and some filesystems might be "
27083 "mountable but require special options. Filesystems may not all belong to a "
27084 "single logical operating system (use L</inspect-os> to look for OSes)."
27089 #: ../fish/guestfish-actions.pod:2446
27090 msgid "list-partitions"
27095 #: ../fish/guestfish-actions.pod:2448
27098 " list-partitions\n"
27104 #: ../fish/guestfish-actions.pod:2454
27106 "This does not return logical volumes. For that you will need to call L</"
27112 #: ../fish/guestfish-actions.pod:2459
27118 #: ../fish/guestfish-actions.pod:2461
27127 #: ../fish/guestfish-actions.pod:2469
27133 #: ../fish/guestfish-actions.pod:2471
27136 " ln target linkname\n"
27142 #: ../fish/guestfish-actions.pod:2475
27148 #: ../fish/guestfish-actions.pod:2477
27151 " ln-f target linkname\n"
27157 #: ../fish/guestfish-actions.pod:2482
27163 #: ../fish/guestfish-actions.pod:2484
27166 " ln-s target linkname\n"
27172 #: ../fish/guestfish-actions.pod:2488
27178 #: ../fish/guestfish-actions.pod:2490
27181 " ln-sf target linkname\n"
27187 #: ../fish/guestfish-actions.pod:2495
27188 msgid "lremovexattr"
27193 #: ../fish/guestfish-actions.pod:2497
27196 " lremovexattr xattr path\n"
27202 #: ../fish/guestfish-actions.pod:2499
27204 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27205 "it removes an extended attribute of the link itself."
27210 #: ../fish/guestfish-actions.pod:2503
27216 #: ../fish/guestfish-actions.pod:2505
27225 #: ../fish/guestfish-actions.pod:2511
27227 "This command is mostly useful for interactive sessions. Programs should "
27228 "probably use L</readdir> instead."
27233 #: ../fish/guestfish-actions.pod:2514
27239 #: ../fish/guestfish-actions.pod:2516
27242 " lsetxattr xattr val vallen path\n"
27248 #: ../fish/guestfish-actions.pod:2518
27250 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27251 "sets an extended attribute of the link itself."
27256 #: ../fish/guestfish-actions.pod:2522
27262 #: ../fish/guestfish-actions.pod:2524
27271 #: ../fish/guestfish-actions.pod:2528
27273 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27274 "the link is stat-ed, not the file it refers to."
27279 #: ../fish/guestfish-actions.pod:2534
27285 #: ../fish/guestfish-actions.pod:2536
27288 " lstatlist path 'names ...'\n"
27294 #: ../fish/guestfish-actions.pod:2538
27296 "This call allows you to perform the L</lstat> operation on multiple files, "
27297 "where all files are in the directory C<path>. C<names> is the list of files "
27298 "from this directory."
27303 #: ../fish/guestfish-actions.pod:2547
27305 "This call is intended for programs that want to efficiently list a directory "
27306 "contents without making many round-trips. See also L</lxattrlist> for a "
27307 "similarly efficient call for getting extended attributes. Very long "
27308 "directory listings might cause the protocol message size to be exceeded, "
27309 "causing this call to fail. The caller must split up such requests into "
27310 "smaller groups of names."
27315 #: ../fish/guestfish-actions.pod:2555
27316 msgid "luks-add-key"
27321 #: ../fish/guestfish-actions.pod:2557
27324 " luks-add-key device keyslot\n"
27330 #: ../fish/guestfish-actions.pod:2564
27332 "Note that if C<keyslot> already contains a key, then this command will "
27333 "fail. You have to use L</luks-kill-slot> first to remove that key."
27338 #: ../fish/guestfish-actions.pod:2568 ../fish/guestfish-actions.pod:2590
27339 #: ../fish/guestfish-actions.pod:2603 ../fish/guestfish-actions.pod:2617
27340 #: ../fish/guestfish-actions.pod:2640 ../fish/guestfish-actions.pod:2650
27342 "This command has one or more key or passphrase parameters. Guestfish will "
27343 "prompt for these separately."
27348 #: ../fish/guestfish-actions.pod:2571
27354 #: ../fish/guestfish-actions.pod:2573
27357 " luks-close device\n"
27363 #: ../fish/guestfish-actions.pod:2575
27365 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27366 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27367 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27373 #: ../fish/guestfish-actions.pod:2581
27374 msgid "luks-format"
27379 #: ../fish/guestfish-actions.pod:2583
27382 " luks-format device keyslot\n"
27388 #: ../fish/guestfish-actions.pod:2596
27389 msgid "luks-format-cipher"
27394 #: ../fish/guestfish-actions.pod:2598
27397 " luks-format-cipher device keyslot cipher\n"
27403 #: ../fish/guestfish-actions.pod:2600
27405 "This command is the same as L</luks-format> but it also allows you to set "
27406 "the C<cipher> used."
27411 #: ../fish/guestfish-actions.pod:2609
27412 msgid "luks-kill-slot"
27417 #: ../fish/guestfish-actions.pod:2611
27420 " luks-kill-slot device keyslot\n"
27426 #: ../fish/guestfish-actions.pod:2620
27432 #: ../fish/guestfish-actions.pod:2622
27435 " luks-open device mapname\n"
27441 #: ../fish/guestfish-actions.pod:2636
27443 "If this block device contains LVM volume groups, then calling L</vgscan> "
27444 "followed by L</vg-activate-all> will make them visible."
27449 #: ../fish/guestfish-actions.pod:2643
27450 msgid "luks-open-ro"
27455 #: ../fish/guestfish-actions.pod:2645
27458 " luks-open-ro device mapname\n"
27464 #: ../fish/guestfish-actions.pod:2647
27466 "This is the same as L</luks-open> except that a read-only mapping is created."
27471 #: ../fish/guestfish-actions.pod:2653
27477 #: ../fish/guestfish-actions.pod:2655
27480 " lvcreate logvol volgroup mbytes\n"
27486 #: ../fish/guestfish-actions.pod:2660
27487 msgid "lvm-canonical-lv-name"
27492 #: ../fish/guestfish-actions.pod:2662
27495 " lvm-canonical-lv-name lvname\n"
27501 #: ../fish/guestfish-actions.pod:2671
27502 msgid "See also L</is-lv>."
27507 #: ../fish/guestfish-actions.pod:2673
27508 msgid "lvm-clear-filter"
27513 #: ../fish/guestfish-actions.pod:2675
27516 " lvm-clear-filter\n"
27522 #: ../fish/guestfish-actions.pod:2677
27524 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27530 #: ../fish/guestfish-actions.pod:2683
27531 msgid "lvm-remove-all"
27536 #: ../fish/guestfish-actions.pod:2685
27539 " lvm-remove-all\n"
27545 #: ../fish/guestfish-actions.pod:2693
27546 msgid "lvm-set-filter"
27551 #: ../fish/guestfish-actions.pod:2695
27554 " lvm-set-filter 'devices ...'\n"
27560 #: ../fish/guestfish-actions.pod:2720
27566 #: ../fish/guestfish-actions.pod:2722
27569 " lvremove device\n"
27575 #: ../fish/guestfish-actions.pod:2730
27581 #: ../fish/guestfish-actions.pod:2732
27584 " lvrename logvol newlogvol\n"
27590 #: ../fish/guestfish-actions.pod:2736
27596 #: ../fish/guestfish-actions.pod:2738
27599 " lvresize device mbytes\n"
27605 #: ../fish/guestfish-actions.pod:2744
27606 msgid "lvresize-free"
27611 #: ../fish/guestfish-actions.pod:2746
27614 " lvresize-free lv percent\n"
27620 #: ../fish/guestfish-actions.pod:2754
27626 #: ../fish/guestfish-actions.pod:2756
27635 #: ../fish/guestfish-actions.pod:2764
27636 msgid "See also L</lvs-full>, L</list-filesystems>."
27641 #: ../fish/guestfish-actions.pod:2766
27647 #: ../fish/guestfish-actions.pod:2768
27656 #: ../fish/guestfish-actions.pod:2773
27662 #: ../fish/guestfish-actions.pod:2775
27671 #: ../fish/guestfish-actions.pod:2779
27677 #: ../fish/guestfish-actions.pod:2781
27680 " lxattrlist path 'names ...'\n"
27686 #: ../fish/guestfish-actions.pod:2797
27688 "This call is intended for programs that want to efficiently list a directory "
27689 "contents without making many round-trips. See also L</lstatlist> for a "
27690 "similarly efficient call for getting standard stats. Very long directory "
27691 "listings might cause the protocol message size to be exceeded, causing this "
27692 "call to fail. The caller must split up such requests into smaller groups of "
27698 #: ../fish/guestfish-actions.pod:2805
27704 #: ../fish/guestfish-actions.pod:2807
27713 #: ../fish/guestfish-actions.pod:2811
27719 #: ../fish/guestfish-actions.pod:2813
27722 " mkdir-mode path mode\n"
27728 #: ../fish/guestfish-actions.pod:2822
27729 msgid "See also L</mkdir>, L</umask>"
27734 #: ../fish/guestfish-actions.pod:2824
27740 #: ../fish/guestfish-actions.pod:2826
27749 #: ../fish/guestfish-actions.pod:2831
27755 #: ../fish/guestfish-actions.pod:2833
27758 " mkdtemp template\n"
27764 #: ../fish/guestfish-actions.pod:2854
27770 #: ../fish/guestfish-actions.pod:2856
27773 " mke2fs-J fstype blocksize device journal\n"
27779 #: ../fish/guestfish-actions.pod:2864
27780 msgid "See also L</mke2journal>."
27785 #: ../fish/guestfish-actions.pod:2866
27791 #: ../fish/guestfish-actions.pod:2868
27794 " mke2fs-JL fstype blocksize device label\n"
27800 #: ../fish/guestfish-actions.pod:2873
27801 msgid "See also L</mke2journal-L>."
27806 #: ../fish/guestfish-actions.pod:2875
27812 #: ../fish/guestfish-actions.pod:2877
27815 " mke2fs-JU fstype blocksize device uuid\n"
27821 #: ../fish/guestfish-actions.pod:2882
27822 msgid "See also L</mke2journal-U>."
27827 #: ../fish/guestfish-actions.pod:2884
27828 msgid "mke2journal"
27833 #: ../fish/guestfish-actions.pod:2886
27836 " mke2journal blocksize device\n"
27842 #: ../fish/guestfish-actions.pod:2893
27843 msgid "mke2journal-L"
27848 #: ../fish/guestfish-actions.pod:2895
27851 " mke2journal-L blocksize label device\n"
27857 #: ../fish/guestfish-actions.pod:2899
27858 msgid "mke2journal-U"
27863 #: ../fish/guestfish-actions.pod:2901
27866 " mke2journal-U blocksize uuid device\n"
27872 #: ../fish/guestfish-actions.pod:2905
27878 #: ../fish/guestfish-actions.pod:2907
27881 " mkfifo mode path\n"
27887 #: ../fish/guestfish-actions.pod:2909
27889 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
27890 "is just a convenient wrapper around L</mknod>."
27895 #: ../fish/guestfish-actions.pod:2915
27901 #: ../fish/guestfish-actions.pod:2917
27904 " mkfs fstype device\n"
27910 #: ../fish/guestfish-actions.pod:2923
27916 #: ../fish/guestfish-actions.pod:2925
27919 " mkfs-b fstype blocksize device\n"
27925 #: ../fish/guestfish-actions.pod:2927
27927 "This call is similar to L</mkfs>, but it allows you to control the block "
27928 "size of the resulting filesystem. Supported block sizes depend on the "
27929 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
27934 #: ../fish/guestfish-actions.pod:2942
27939 #: ../fish/guestfish-actions.pod:2944
27942 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
27948 #: ../fish/guestfish-actions.pod:2979
27949 msgid "mkmountpoint"
27954 #: ../fish/guestfish-actions.pod:2981
27957 " mkmountpoint exemptpath\n"
27963 #: ../fish/guestfish-actions.pod:2983
27965 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
27966 "to create extra mountpoints before mounting the first filesystem."
27971 #: ../fish/guestfish-actions.pod:3007
27973 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
27974 "unexpected errors if you try to mix these calls. It is safest to manually "
27975 "unmount filesystems and remove mountpoints after use."
27980 #: ../fish/guestfish-actions.pod:3011
27982 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
27983 "for this to work for manual mountpoints, you must ensure that the innermost "
27984 "mountpoints have the longest pathnames, as in the example code above."
27988 #: ../fish/guestfish-actions.pod:3018
27990 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
27991 "L</umount-all> to be called when the handle is closed which can also trigger "
27997 #: ../fish/guestfish-actions.pod:3022
28003 #: ../fish/guestfish-actions.pod:3024
28006 " mknod mode devmajor devminor path\n"
28012 #: ../fish/guestfish-actions.pod:3034
28014 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28015 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28016 "regular file). These constants are available in the standard Linux header "
28017 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28018 "wrappers around this command which bitwise OR in the appropriate constant "
28024 #: ../fish/guestfish-actions.pod:3044
28030 #: ../fish/guestfish-actions.pod:3046
28033 " mknod-b mode devmajor devminor path\n"
28039 #: ../fish/guestfish-actions.pod:3048
28041 "This call creates a block device node called C<path> with mode C<mode> and "
28042 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28043 "wrapper around L</mknod>."
28048 #: ../fish/guestfish-actions.pod:3054
28054 #: ../fish/guestfish-actions.pod:3056
28057 " mknod-c mode devmajor devminor path\n"
28063 #: ../fish/guestfish-actions.pod:3058
28065 "This call creates a char device node called C<path> with mode C<mode> and "
28066 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28067 "wrapper around L</mknod>."
28072 #: ../fish/guestfish-actions.pod:3064
28078 #: ../fish/guestfish-actions.pod:3066
28087 #: ../fish/guestfish-actions.pod:3070
28093 #: ../fish/guestfish-actions.pod:3072
28096 " mkswap-L label device\n"
28102 #: ../fish/guestfish-actions.pod:3080
28108 #: ../fish/guestfish-actions.pod:3082
28111 " mkswap-U uuid device\n"
28117 #: ../fish/guestfish-actions.pod:3086
28118 msgid "mkswap-file"
28123 #: ../fish/guestfish-actions.pod:3088
28126 " mkswap-file path\n"
28132 #: ../fish/guestfish-actions.pod:3092
28134 "This command just writes a swap file signature to an existing file. To "
28135 "create the file itself, use something like L</fallocate>."
28140 #: ../fish/guestfish-actions.pod:3095
28146 #: ../fish/guestfish-actions.pod:3097
28149 " modprobe modulename\n"
28155 #: ../fish/guestfish-actions.pod:3104
28161 #: ../fish/guestfish-actions.pod:3106
28164 " mount device mountpoint\n"
28170 #: ../fish/guestfish-actions.pod:3122
28172 "B<Important note:> When you use this call, the filesystem options C<sync> "
28173 "and C<noatime> are set implicitly. This was originally done because we "
28174 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28175 "very large negative performance impact and negligible effect on "
28176 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28177 "code that needs performance, and instead use L</mount-options> (use an empty "
28178 "string for the first parameter if you don't want any options)."
28183 #: ../fish/guestfish-actions.pod:3132
28189 #: ../fish/guestfish-actions.pod:3134
28192 " mount-loop file mountpoint\n"
28198 #: ../fish/guestfish-actions.pod:3140
28199 msgid "mount-options"
28204 #: ../fish/guestfish-actions.pod:3142
28207 " mount-options options device mountpoint\n"
28213 #: ../fish/guestfish-actions.pod:3144
28215 "This is the same as the L</mount> command, but it allows you to set the "
28216 "mount options as for the L<mount(8)> I<-o> flag."
28221 #: ../fish/guestfish-actions.pod:3152
28227 #: ../fish/guestfish-actions.pod:3154
28230 " mount-ro device mountpoint\n"
28236 #: ../fish/guestfish-actions.pod:3156
28238 "This is the same as the L</mount> command, but it mounts the filesystem with "
28239 "the read-only (I<-o ro>) flag."
28244 #: ../fish/guestfish-actions.pod:3159
28250 #: ../fish/guestfish-actions.pod:3161
28253 " mount-vfs options vfstype device mountpoint\n"
28259 #: ../fish/guestfish-actions.pod:3163
28261 "This is the same as the L</mount> command, but it allows you to set both the "
28262 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28267 #: ../fish/guestfish-actions.pod:3167
28268 msgid "mountpoints"
28273 #: ../fish/guestfish-actions.pod:3169
28282 #: ../fish/guestfish-actions.pod:3171
28284 "This call is similar to L</mounts>. That call returns a list of devices. "
28285 "This one returns a hash table (map) of device name to directory where the "
28286 "device is mounted."
28291 #: ../fish/guestfish-actions.pod:3175
28297 #: ../fish/guestfish-actions.pod:3177
28306 #: ../fish/guestfish-actions.pod:3184
28307 msgid "See also: L</mountpoints>"
28312 #: ../fish/guestfish-actions.pod:3186
28318 #: ../fish/guestfish-actions.pod:3188
28327 #: ../fish/guestfish-actions.pod:3193
28328 msgid "ntfs-3g-probe"
28333 #: ../fish/guestfish-actions.pod:3195
28336 " ntfs-3g-probe true|false device\n"
28342 #: ../fish/guestfish-actions.pod:3209
28348 #: ../fish/guestfish-actions.pod:3211
28351 " ntfsresize device\n"
28357 #: ../fish/guestfish-actions.pod:3217
28358 msgid "ntfsresize-size"
28363 #: ../fish/guestfish-actions.pod:3219
28366 " ntfsresize-size device size\n"
28372 #: ../fish/guestfish-actions.pod:3221
28374 "This command is the same as L</ntfsresize> except that it allows you to "
28375 "specify the new size (in bytes) explicitly."
28380 #: ../fish/guestfish-actions.pod:3224
28386 #: ../fish/guestfish-actions.pod:3226
28389 " part-add device prlogex startsect endsect\n"
28395 #: ../fish/guestfish-actions.pod:3228
28397 "This command adds a partition to C<device>. If there is no partition table "
28398 "on the device, call L</part-init> first."
28403 #: ../fish/guestfish-actions.pod:3240
28405 "Creating a partition which covers the whole disk is not so easy. Use L</"
28406 "part-disk> to do that."
28411 #: ../fish/guestfish-actions.pod:3243
28417 #: ../fish/guestfish-actions.pod:3245
28420 " part-del device partnum\n"
28426 #: ../fish/guestfish-actions.pod:3253
28432 #: ../fish/guestfish-actions.pod:3255
28435 " part-disk device parttype\n"
28441 #: ../fish/guestfish-actions.pod:3257
28443 "This command is simply a combination of L</part-init> followed by L</part-"
28444 "add> to create a single primary partition covering the whole disk."
28449 #: ../fish/guestfish-actions.pod:3261
28451 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28452 "possible values are described in L</part-init>."
28457 #: ../fish/guestfish-actions.pod:3267
28458 msgid "part-get-bootable"
28463 #: ../fish/guestfish-actions.pod:3269
28466 " part-get-bootable device partnum\n"
28472 #: ../fish/guestfish-actions.pod:3274
28473 msgid "See also L</part-set-bootable>."
28478 #: ../fish/guestfish-actions.pod:3276
28479 msgid "part-get-mbr-id"
28484 #: ../fish/guestfish-actions.pod:3278
28487 " part-get-mbr-id device partnum\n"
28493 #: ../fish/guestfish-actions.pod:3283 ../fish/guestfish-actions.pod:3421
28495 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28496 "undefined results for other partition table types (see L</part-get-"
28502 #: ../fish/guestfish-actions.pod:3287
28503 msgid "part-get-parttype"
28508 #: ../fish/guestfish-actions.pod:3289
28511 " part-get-parttype device\n"
28517 #: ../fish/guestfish-actions.pod:3294
28519 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28520 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28521 "possible, although unusual. See L</part-init> for a full list."
28526 #: ../fish/guestfish-actions.pod:3299
28532 #: ../fish/guestfish-actions.pod:3301
28535 " part-init device parttype\n"
28541 #: ../fish/guestfish-actions.pod:3307
28543 "Initially there are no partitions. Following this, you should call L</part-"
28544 "add> for each partition required."
28549 #: ../fish/guestfish-actions.pod:3370
28555 #: ../fish/guestfish-actions.pod:3372
28558 " part-list device\n"
28564 #: ../fish/guestfish-actions.pod:3387
28566 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28567 "the device's sector size, see L</blockdev-getss>."
28572 #: ../fish/guestfish-actions.pod:3400
28573 msgid "part-set-bootable"
28578 #: ../fish/guestfish-actions.pod:3402
28581 " part-set-bootable device partnum true|false\n"
28587 #: ../fish/guestfish-actions.pod:3411
28588 msgid "part-set-mbr-id"
28593 #: ../fish/guestfish-actions.pod:3413
28596 " part-set-mbr-id device partnum idbyte\n"
28602 #: ../fish/guestfish-actions.pod:3425
28603 msgid "part-set-name"
28608 #: ../fish/guestfish-actions.pod:3427
28611 " part-set-name device partnum name\n"
28617 #: ../fish/guestfish-actions.pod:3435
28618 msgid "part-to-dev"
28623 #: ../fish/guestfish-actions.pod:3437
28626 " part-to-dev partition\n"
28632 #: ../fish/guestfish-actions.pod:3443
28634 "The named partition must exist, for example as a string returned from L</"
28635 "list-partitions>."
28640 #: ../fish/guestfish-actions.pod:3446
28641 msgid "ping-daemon"
28646 #: ../fish/guestfish-actions.pod:3448
28655 #: ../fish/guestfish-actions.pod:3455
28661 #: ../fish/guestfish-actions.pod:3457
28664 " pread path count offset\n"
28670 #: ../fish/guestfish-actions.pod:3465
28671 msgid "See also L</pwrite>, L</pread-device>."
28676 #: ../fish/guestfish-actions.pod:3470
28677 msgid "pread-device"
28682 #: ../fish/guestfish-actions.pod:3472
28685 " pread-device device count offset\n"
28691 #: ../fish/guestfish-actions.pod:3480
28692 msgid "See also L</pread>."
28697 #: ../fish/guestfish-actions.pod:3485
28703 #: ../fish/guestfish-actions.pod:3487
28706 " pvcreate device\n"
28712 #: ../fish/guestfish-actions.pod:3493
28718 #: ../fish/guestfish-actions.pod:3495
28721 " pvremove device\n"
28727 #: ../fish/guestfish-actions.pod:3504
28733 #: ../fish/guestfish-actions.pod:3506
28736 " pvresize device\n"
28742 #: ../fish/guestfish-actions.pod:3511
28743 msgid "pvresize-size"
28748 #: ../fish/guestfish-actions.pod:3513
28751 " pvresize-size device size\n"
28757 #: ../fish/guestfish-actions.pod:3515
28759 "This command is the same as L</pvresize> except that it allows you to "
28760 "specify the new size (in bytes) explicitly."
28765 #: ../fish/guestfish-actions.pod:3518
28771 #: ../fish/guestfish-actions.pod:3520
28780 #: ../fish/guestfish-actions.pod:3528
28781 msgid "See also L</pvs-full>."
28786 #: ../fish/guestfish-actions.pod:3530
28792 #: ../fish/guestfish-actions.pod:3532
28801 #: ../fish/guestfish-actions.pod:3537
28807 #: ../fish/guestfish-actions.pod:3539
28816 #: ../fish/guestfish-actions.pod:3543
28822 #: ../fish/guestfish-actions.pod:3545
28825 " pwrite path content offset\n"
28831 #: ../fish/guestfish-actions.pod:3556
28832 msgid "See also L</pread>, L</pwrite-device>."
28837 #: ../fish/guestfish-actions.pod:3561
28838 msgid "pwrite-device"
28843 #: ../fish/guestfish-actions.pod:3563
28846 " pwrite-device device content offset\n"
28852 #: ../fish/guestfish-actions.pod:3573
28853 msgid "See also L</pwrite>."
28858 #: ../fish/guestfish-actions.pod:3578
28864 #: ../fish/guestfish-actions.pod:3580
28867 " read-file path\n"
28873 #: ../fish/guestfish-actions.pod:3585
28875 "Unlike L</cat>, this function can correctly handle files that contain "
28876 "embedded ASCII NUL characters. However unlike L</download>, this function "
28877 "is limited in the total size of file that can be handled."
28882 #: ../fish/guestfish-actions.pod:3593
28888 #: ../fish/guestfish-actions.pod:3595
28891 " read-lines path\n"
28897 #: ../fish/guestfish-actions.pod:3602
28899 "Note that this function cannot correctly handle binary files (specifically, "
28900 "files containing C<\\0> character which is treated as end of line). For "
28901 "those you need to use the L</read-file> function which has a more complex "
28907 #: ../fish/guestfish-actions.pod:3607
28913 #: ../fish/guestfish-actions.pod:3609
28922 #: ../fish/guestfish-actions.pod:3661
28924 "This function is primarily intended for use by programs. To get a simple "
28925 "list of names, use L</ls>. To get a printable directory for human "
28926 "consumption, use L</ll>."
28931 #: ../fish/guestfish-actions.pod:3665
28937 #: ../fish/guestfish-actions.pod:3667
28946 #: ../fish/guestfish-actions.pod:3671
28947 msgid "readlinklist"
28952 #: ../fish/guestfish-actions.pod:3673
28955 " readlinklist path 'names ...'\n"
28961 #: ../fish/guestfish-actions.pod:3697
28967 #: ../fish/guestfish-actions.pod:3699
28976 #: ../fish/guestfish-actions.pod:3704
28977 msgid "removexattr"
28982 #: ../fish/guestfish-actions.pod:3706
28985 " removexattr xattr path\n"
28991 #: ../fish/guestfish-actions.pod:3711
28992 msgid "See also: L</lremovexattr>, L<attr(5)>."
28997 #: ../fish/guestfish-actions.pod:3713
29003 #: ../fish/guestfish-actions.pod:3715
29006 " resize2fs device\n"
29012 #: ../fish/guestfish-actions.pod:3720
29014 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29015 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29016 "gives an error about this and sometimes not. In any case, it is always safe "
29017 "to call L</e2fsck-f> before calling this function."
29021 #: ../fish/guestfish-actions.pod:3726
29022 msgid "resize2fs-M"
29026 #: ../fish/guestfish-actions.pod:3728
29029 " resize2fs-M device\n"
29034 #: ../fish/guestfish-actions.pod:3730
29036 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29037 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
29042 #: ../fish/guestfish-actions.pod:3734
29044 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29045 "and read the C<Block size> and C<Block count> values. These two numbers, "
29046 "multiplied together, give the resulting size of the minimal filesystem in "
29052 #: ../fish/guestfish-actions.pod:3739
29053 msgid "resize2fs-size"
29058 #: ../fish/guestfish-actions.pod:3741
29061 " resize2fs-size device size\n"
29067 #: ../fish/guestfish-actions.pod:3743
29069 "This command is the same as L</resize2fs> except that it allows you to "
29070 "specify the new size (in bytes) explicitly."
29075 #: ../fish/guestfish-actions.pod:3746
29081 #: ../fish/guestfish-actions.pod:3748
29090 #: ../fish/guestfish-actions.pod:3752
29096 #: ../fish/guestfish-actions.pod:3754
29105 #: ../fish/guestfish-actions.pod:3760
29111 #: ../fish/guestfish-actions.pod:3762
29120 #: ../fish/guestfish-actions.pod:3766
29121 msgid "rmmountpoint"
29126 #: ../fish/guestfish-actions.pod:3768
29129 " rmmountpoint exemptpath\n"
29135 #: ../fish/guestfish-actions.pod:3770
29137 "This calls removes a mountpoint that was previously created with L</"
29138 "mkmountpoint>. See L</mkmountpoint> for full details."
29143 #: ../fish/guestfish-actions.pod:3774
29144 msgid "scrub-device"
29149 #: ../fish/guestfish-actions.pod:3776
29152 " scrub-device device\n"
29158 #: ../fish/guestfish-actions.pod:3787
29164 #: ../fish/guestfish-actions.pod:3789
29167 " scrub-file file\n"
29173 #: ../fish/guestfish-actions.pod:3799
29174 msgid "scrub-freespace"
29179 #: ../fish/guestfish-actions.pod:3801
29182 " scrub-freespace dir\n"
29188 #: ../fish/guestfish-actions.pod:3803
29190 "This command creates the directory C<dir> and then fills it with files until "
29191 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29192 "deletes them. The intention is to scrub any free space on the partition "
29193 "containing C<dir>."
29198 #: ../fish/guestfish-actions.pod:3812
29204 #: ../fish/guestfish-actions.pod:3814
29210 #: ../fish/guestfish-actions.pod:3816
29213 " set-append append\n"
29218 #: ../fish/guestfish-actions.pod:3827
29219 msgid "set-attach-method"
29223 #: ../fish/guestfish-actions.pod:3829
29224 msgid "attach-method"
29228 #: ../fish/guestfish-actions.pod:3831
29231 " set-attach-method attachmethod\n"
29237 #: ../fish/guestfish-actions.pod:3853
29238 msgid "set-autosync"
29243 #: ../fish/guestfish-actions.pod:3855
29249 #: ../fish/guestfish-actions.pod:3857
29252 " set-autosync true|false\n"
29258 #: ../fish/guestfish-actions.pod:3867
29264 #: ../fish/guestfish-actions.pod:3869
29270 #: ../fish/guestfish-actions.pod:3871
29273 " set-direct true|false\n"
29279 #: ../fish/guestfish-actions.pod:3877
29281 "One consequence of this is that log messages aren't caught by the library "
29282 "and handled by L</set-log-message-callback>, but go straight to stdout."
29287 #: ../fish/guestfish-actions.pod:3886
29288 msgid "set-e2label"
29293 #: ../fish/guestfish-actions.pod:3888
29296 " set-e2label device label\n"
29302 #: ../fish/guestfish-actions.pod:3894
29304 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29305 "label on a filesystem."
29310 #: ../fish/guestfish-actions.pod:3897
29316 #: ../fish/guestfish-actions.pod:3899
29319 " set-e2uuid device uuid\n"
29325 #: ../fish/guestfish-actions.pod:3906
29327 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29328 "UUID of a filesystem."
29333 #: ../fish/guestfish-actions.pod:3909
29334 msgid "set-memsize"
29339 #: ../fish/guestfish-actions.pod:3911
29345 #: ../fish/guestfish-actions.pod:3913
29348 " set-memsize memsize\n"
29354 #: ../fish/guestfish-actions.pod:3915
29356 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29357 "This only has any effect if called before L</launch>."
29362 #: ../fish/guestfish-actions.pod:3926
29363 msgid "set-network"
29368 #: ../fish/guestfish-actions.pod:3928
29374 #: ../fish/guestfish-actions.pod:3930
29377 " set-network true|false\n"
29383 #: ../fish/guestfish-actions.pod:3938
29385 "You must call this before calling L</launch>, otherwise it has no effect."
29390 #: ../fish/guestfish-actions.pod:3941
29396 #: ../fish/guestfish-actions.pod:3943
29402 #: ../fish/guestfish-actions.pod:3945
29405 " set-path searchpath\n"
29411 #: ../fish/guestfish-actions.pod:3954
29417 #: ../fish/guestfish-actions.pod:3956
29423 #: ../fish/guestfish-actions.pod:3958
29432 #: ../fish/guestfish-actions.pod:3978
29433 msgid "set-recovery-proc"
29438 #: ../fish/guestfish-actions.pod:3980
29439 msgid "recovery-proc"
29444 #: ../fish/guestfish-actions.pod:3982
29447 " set-recovery-proc true|false\n"
29453 #: ../fish/guestfish-actions.pod:3984
29455 "If this is called with the parameter C<false> then L</launch> does not "
29456 "create a recovery process. The purpose of the recovery process is to stop "
29457 "runaway qemu processes in the case where the main program aborts abruptly."
29462 #: ../fish/guestfish-actions.pod:3989
29464 "This only has any effect if called before L</launch>, and the default is "
29470 #: ../fish/guestfish-actions.pod:3998
29471 msgid "set-selinux"
29476 #: ../fish/guestfish-actions.pod:4000
29482 #: ../fish/guestfish-actions.pod:4002
29485 " set-selinux true|false\n"
29491 #: ../fish/guestfish-actions.pod:4013
29497 #: ../fish/guestfish-actions.pod:4015
29503 #: ../fish/guestfish-actions.pod:4017
29506 " set-trace true|false\n"
29511 #: ../fish/guestfish-actions.pod:4029
29513 "Trace messages are normally sent to C<stderr>, unless you register a "
29514 "callback to send them somewhere else (see L</set-event-callback>)."
29519 #: ../fish/guestfish-actions.pod:4033
29520 msgid "set-verbose"
29525 #: ../fish/guestfish-actions.pod:4035
29531 #: ../fish/guestfish-actions.pod:4037
29534 " set-verbose true|false\n"
29539 #: ../fish/guestfish-actions.pod:4044
29541 "Verbose messages are normally sent to C<stderr>, unless you register a "
29542 "callback to send them somewhere else (see L</set-event-callback>)."
29547 #: ../fish/guestfish-actions.pod:4048
29553 #: ../fish/guestfish-actions.pod:4050
29556 " setcon context\n"
29562 #: ../fish/guestfish-actions.pod:4057
29568 #: ../fish/guestfish-actions.pod:4059
29571 " setxattr xattr val vallen path\n"
29577 #: ../fish/guestfish-actions.pod:4065
29578 msgid "See also: L</lsetxattr>, L<attr(5)>."
29583 #: ../fish/guestfish-actions.pod:4067
29589 #: ../fish/guestfish-actions.pod:4069
29592 " sfdisk device cyls heads sectors 'lines ...'\n"
29598 #: ../fish/guestfish-actions.pod:4091
29599 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
29604 #: ../fish/guestfish-actions.pod:4097
29610 #: ../fish/guestfish-actions.pod:4099
29613 " sfdiskM device 'lines ...'\n"
29619 #: ../fish/guestfish-actions.pod:4101
29621 "This is a simplified interface to the L</sfdisk> command, where partition "
29622 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
29623 "you don't need to specify the cyls, heads and sectors parameters which were "
29624 "rarely if ever used anyway."
29629 #: ../fish/guestfish-actions.pod:4107
29630 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
29635 #: ../fish/guestfish-actions.pod:4113
29641 #: ../fish/guestfish-actions.pod:4115
29644 " sfdisk-N device partnum cyls heads sectors line\n"
29650 #: ../fish/guestfish-actions.pod:4120
29652 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
29653 "cyls/heads/sectors parameters."
29658 #: ../fish/guestfish-actions.pod:4123
29659 msgid "See also: L</part-add>"
29664 #: ../fish/guestfish-actions.pod:4128
29665 msgid "sfdisk-disk-geometry"
29670 #: ../fish/guestfish-actions.pod:4130
29673 " sfdisk-disk-geometry device\n"
29679 #: ../fish/guestfish-actions.pod:4132
29681 "This displays the disk geometry of C<device> read from the partition table. "
29682 "Especially in the case where the underlying block device has been resized, "
29683 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
29684 "kernel-geometry>)."
29689 #: ../fish/guestfish-actions.pod:4140
29690 msgid "sfdisk-kernel-geometry"
29695 #: ../fish/guestfish-actions.pod:4142
29698 " sfdisk-kernel-geometry device\n"
29704 #: ../fish/guestfish-actions.pod:4149
29710 #: ../fish/guestfish-actions.pod:4151
29713 " sfdisk-l device\n"
29719 #: ../fish/guestfish-actions.pod:4157
29720 msgid "See also: L</part-list>"
29725 #: ../fish/guestfish-actions.pod:4159
29731 #: ../fish/guestfish-actions.pod:4161
29740 #: ../fish/guestfish-actions.pod:4166
29741 msgid "This is like L</command>, but passes the command to:"
29746 #: ../fish/guestfish-actions.pod:4174
29747 msgid "All the provisos about L</command> apply to this call."
29752 #: ../fish/guestfish-actions.pod:4176
29758 #: ../fish/guestfish-actions.pod:4178
29761 " sh-lines command\n"
29767 #: ../fish/guestfish-actions.pod:4180
29768 msgid "This is the same as L</sh>, but splits the result into a list of lines."
29773 #: ../fish/guestfish-actions.pod:4183
29774 msgid "See also: L</command-lines>"
29779 #: ../fish/guestfish-actions.pod:4185
29785 #: ../fish/guestfish-actions.pod:4187
29794 #: ../fish/guestfish-actions.pod:4191
29800 #: ../fish/guestfish-actions.pod:4193
29809 #: ../fish/guestfish-actions.pod:4199
29815 #: ../fish/guestfish-actions.pod:4201
29824 #: ../fish/guestfish-actions.pod:4209
29830 #: ../fish/guestfish-actions.pod:4211
29839 #: ../fish/guestfish-actions.pod:4219
29845 #: ../fish/guestfish-actions.pod:4221
29848 " strings-e encoding path\n"
29854 #: ../fish/guestfish-actions.pod:4223
29856 "This is like the L</strings> command, but allows you to specify the encoding "
29857 "of strings that are looked for in the source file C<path>."
29862 #: ../fish/guestfish-actions.pod:4233
29864 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29865 "ISO-8859-X (this is what L</strings> uses)."
29870 #: ../fish/guestfish-actions.pod:4265
29871 msgid "swapoff-device"
29876 #: ../fish/guestfish-actions.pod:4267
29879 " swapoff-device device\n"
29885 #: ../fish/guestfish-actions.pod:4269
29887 "This command disables the libguestfs appliance swap device or partition "
29888 "named C<device>. See L</swapon-device>."
29893 #: ../fish/guestfish-actions.pod:4273
29894 msgid "swapoff-file"
29899 #: ../fish/guestfish-actions.pod:4275
29902 " swapoff-file file\n"
29908 #: ../fish/guestfish-actions.pod:4279
29909 msgid "swapoff-label"
29914 #: ../fish/guestfish-actions.pod:4281
29917 " swapoff-label label\n"
29923 #: ../fish/guestfish-actions.pod:4286
29924 msgid "swapoff-uuid"
29929 #: ../fish/guestfish-actions.pod:4288
29932 " swapoff-uuid uuid\n"
29938 #: ../fish/guestfish-actions.pod:4293
29939 msgid "swapon-device"
29944 #: ../fish/guestfish-actions.pod:4295
29947 " swapon-device device\n"
29953 #: ../fish/guestfish-actions.pod:4297
29955 "This command enables the libguestfs appliance to use the swap device or "
29956 "partition named C<device>. The increased memory is made available for all "
29957 "commands, for example those run using L</command> or L</sh>."
29962 #: ../fish/guestfish-actions.pod:4309
29963 msgid "swapon-file"
29968 #: ../fish/guestfish-actions.pod:4311
29971 " swapon-file file\n"
29977 #: ../fish/guestfish-actions.pod:4313
29979 "This command enables swap to a file. See L</swapon-device> for other notes."
29984 #: ../fish/guestfish-actions.pod:4316
29985 msgid "swapon-label"
29990 #: ../fish/guestfish-actions.pod:4318
29993 " swapon-label label\n"
29999 #: ../fish/guestfish-actions.pod:4320
30001 "This command enables swap to a labeled swap partition. See L</swapon-"
30002 "device> for other notes."
30007 #: ../fish/guestfish-actions.pod:4323
30008 msgid "swapon-uuid"
30013 #: ../fish/guestfish-actions.pod:4325
30016 " swapon-uuid uuid\n"
30022 #: ../fish/guestfish-actions.pod:4327
30024 "This command enables swap to a swap partition with the given UUID. See L</"
30025 "swapon-device> for other notes."
30030 #: ../fish/guestfish-actions.pod:4330
30036 #: ../fish/guestfish-actions.pod:4332
30045 #: ../fish/guestfish-actions.pod:4340
30051 #: ../fish/guestfish-actions.pod:4342
30060 #: ../fish/guestfish-actions.pod:4350
30066 #: ../fish/guestfish-actions.pod:4352
30069 " tail-n nrlines path\n"
30075 #: ../fish/guestfish-actions.pod:4365
30081 #: ../fish/guestfish-actions.pod:4367
30084 " tar-in (tarfile|-) directory\n"
30090 #: ../fish/guestfish-actions.pod:4372
30091 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30096 #: ../fish/guestfish-actions.pod:4377
30102 #: ../fish/guestfish-actions.pod:4379
30105 " tar-out directory (tarfile|-)\n"
30111 #: ../fish/guestfish-actions.pod:4384
30112 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30117 #: ../fish/guestfish-actions.pod:4389
30123 #: ../fish/guestfish-actions.pod:4391
30126 " tgz-in (tarball|-) directory\n"
30132 #: ../fish/guestfish-actions.pod:4396
30133 msgid "To upload an uncompressed tarball, use L</tar-in>."
30138 #: ../fish/guestfish-actions.pod:4400
30144 #: ../fish/guestfish-actions.pod:4402
30147 " tgz-out directory (tarball|-)\n"
30153 #: ../fish/guestfish-actions.pod:4407
30154 msgid "To download an uncompressed tarball, use L</tar-out>."
30159 #: ../fish/guestfish-actions.pod:4411
30165 #: ../fish/guestfish-actions.pod:4413
30174 #: ../fish/guestfish-actions.pod:4422
30180 #: ../fish/guestfish-actions.pod:4424
30189 #: ../fish/guestfish-actions.pod:4429
30190 msgid "truncate-size"
30195 #: ../fish/guestfish-actions.pod:4431
30198 " truncate-size path size\n"
30204 #: ../fish/guestfish-actions.pod:4436
30206 "If the current file size is less than C<size> then the file is extended to "
30207 "the required size with zero bytes. This creates a sparse file (ie. disk "
30208 "blocks are not allocated for the file until you write to it). To create a "
30209 "non-sparse file of zeroes, use L</fallocate64> instead."
30214 #: ../fish/guestfish-actions.pod:4442
30220 #: ../fish/guestfish-actions.pod:4444
30223 " tune2fs-l device\n"
30229 #: ../fish/guestfish-actions.pod:4454
30235 #: ../fish/guestfish-actions.pod:4456
30238 " txz-in (tarball|-) directory\n"
30244 #: ../fish/guestfish-actions.pod:4463
30250 #: ../fish/guestfish-actions.pod:4465
30253 " txz-out directory (tarball|-)\n"
30259 #: ../fish/guestfish-actions.pod:4472
30265 #: ../fish/guestfish-actions.pod:4474
30274 #: ../fish/guestfish-actions.pod:4488
30275 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30280 #: ../fish/guestfish-actions.pod:4493
30286 #: ../fish/guestfish-actions.pod:4495
30292 #: ../fish/guestfish-actions.pod:4497
30295 " umount pathordevice\n"
30301 #: ../fish/guestfish-actions.pod:4503
30307 #: ../fish/guestfish-actions.pod:4505
30308 msgid "unmount-all"
30313 #: ../fish/guestfish-actions.pod:4507
30322 #: ../fish/guestfish-actions.pod:4513
30328 #: ../fish/guestfish-actions.pod:4515
30331 " upload (filename|-) remotefilename\n"
30337 #: ../fish/guestfish-actions.pod:4522
30338 msgid "See also L</download>."
30343 #: ../fish/guestfish-actions.pod:4526
30344 msgid "upload-offset"
30349 #: ../fish/guestfish-actions.pod:4528
30352 " upload-offset (filename|-) remotefilename offset\n"
30358 #: ../fish/guestfish-actions.pod:4540
30360 "Note that there is no limit on the amount of data that can be uploaded with "
30361 "this call, unlike with L</pwrite>, and this call always writes the full "
30362 "amount unless an error occurs."
30367 #: ../fish/guestfish-actions.pod:4545
30368 msgid "See also L</upload>, L</pwrite>."
30373 #: ../fish/guestfish-actions.pod:4549
30379 #: ../fish/guestfish-actions.pod:4551
30382 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30388 #: ../fish/guestfish-actions.pod:4570
30394 #: ../fish/guestfish-actions.pod:4572
30403 #: ../fish/guestfish-actions.pod:4599
30405 "I<Note:> Don't use this call to test for availability of features. In "
30406 "enterprise distributions we backport features from later versions into "
30407 "earlier versions, making this an unreliable way to test for features. Use "
30408 "L</available> instead."
30413 #: ../fish/guestfish-actions.pod:4605
30419 #: ../fish/guestfish-actions.pod:4607
30422 " vfs-label device\n"
30428 #: ../fish/guestfish-actions.pod:4614
30429 msgid "To find a filesystem from the label, use L</findfs-label>."
30434 #: ../fish/guestfish-actions.pod:4616
30440 #: ../fish/guestfish-actions.pod:4618
30443 " vfs-type device\n"
30449 #: ../fish/guestfish-actions.pod:4628
30455 #: ../fish/guestfish-actions.pod:4630
30458 " vfs-uuid device\n"
30464 #: ../fish/guestfish-actions.pod:4637
30465 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30470 #: ../fish/guestfish-actions.pod:4639
30471 msgid "vg-activate"
30476 #: ../fish/guestfish-actions.pod:4641
30479 " vg-activate true|false 'volgroups ...'\n"
30485 #: ../fish/guestfish-actions.pod:4654
30486 msgid "vg-activate-all"
30491 #: ../fish/guestfish-actions.pod:4656
30494 " vg-activate-all true|false\n"
30500 #: ../fish/guestfish-actions.pod:4666
30506 #: ../fish/guestfish-actions.pod:4668
30509 " vgcreate volgroup 'physvols ...'\n"
30515 #: ../fish/guestfish-actions.pod:4673
30521 #: ../fish/guestfish-actions.pod:4675
30524 " vglvuuids vgname\n"
30530 #: ../fish/guestfish-actions.pod:4680
30532 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30533 "logical volumes and volume groups."
30538 #: ../fish/guestfish-actions.pod:4683
30539 msgid "See also L</vgpvuuids>."
30544 #: ../fish/guestfish-actions.pod:4685
30550 #: ../fish/guestfish-actions.pod:4687
30553 " vgpvuuids vgname\n"
30559 #: ../fish/guestfish-actions.pod:4692
30561 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30562 "physical volumes and volume groups."
30567 #: ../fish/guestfish-actions.pod:4695
30568 msgid "See also L</vglvuuids>."
30573 #: ../fish/guestfish-actions.pod:4697
30579 #: ../fish/guestfish-actions.pod:4699
30582 " vgremove vgname\n"
30588 #: ../fish/guestfish-actions.pod:4706
30594 #: ../fish/guestfish-actions.pod:4708
30597 " vgrename volgroup newvolgroup\n"
30603 #: ../fish/guestfish-actions.pod:4712
30609 #: ../fish/guestfish-actions.pod:4714
30618 #: ../fish/guestfish-actions.pod:4722
30619 msgid "See also L</vgs-full>."
30624 #: ../fish/guestfish-actions.pod:4724
30630 #: ../fish/guestfish-actions.pod:4726
30639 #: ../fish/guestfish-actions.pod:4731
30645 #: ../fish/guestfish-actions.pod:4733
30654 #: ../fish/guestfish-actions.pod:4738
30660 #: ../fish/guestfish-actions.pod:4740
30669 #: ../fish/guestfish-actions.pod:4744
30675 #: ../fish/guestfish-actions.pod:4746
30684 #: ../fish/guestfish-actions.pod:4751
30690 #: ../fish/guestfish-actions.pod:4753
30699 #: ../fish/guestfish-actions.pod:4758
30705 #: ../fish/guestfish-actions.pod:4760
30714 #: ../fish/guestfish-actions.pod:4765
30720 #: ../fish/guestfish-actions.pod:4767
30723 " write path content\n"
30729 #: ../fish/guestfish-actions.pod:4775
30735 #: ../fish/guestfish-actions.pod:4777
30738 " write-file path content size\n"
30744 #: ../fish/guestfish-actions.pod:4800
30750 #: ../fish/guestfish-actions.pod:4802
30753 " zegrep regex path\n"
30759 #: ../fish/guestfish-actions.pod:4810
30765 #: ../fish/guestfish-actions.pod:4812
30768 " zegrepi regex path\n"
30774 #: ../fish/guestfish-actions.pod:4820
30780 #: ../fish/guestfish-actions.pod:4822
30789 #: ../fish/guestfish-actions.pod:4830
30790 msgid "See also: L</zero-device>, L</scrub-device>."
30795 #: ../fish/guestfish-actions.pod:4832
30796 msgid "zero-device"
30801 #: ../fish/guestfish-actions.pod:4834
30804 " zero-device device\n"
30810 #: ../fish/guestfish-actions.pod:4836
30812 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
30813 "which just zeroes the first few blocks of a device."
30818 #: ../fish/guestfish-actions.pod:4843
30824 #: ../fish/guestfish-actions.pod:4845
30827 " zerofree device\n"
30833 #: ../fish/guestfish-actions.pod:4858
30839 #: ../fish/guestfish-actions.pod:4860
30842 " zfgrep pattern path\n"
30848 #: ../fish/guestfish-actions.pod:4868
30854 #: ../fish/guestfish-actions.pod:4870
30857 " zfgrepi pattern path\n"
30863 #: ../fish/guestfish-actions.pod:4878
30869 #: ../fish/guestfish-actions.pod:4880
30872 " zfile meth path\n"
30878 #: ../fish/guestfish-actions.pod:4887
30880 "Since 1.0.63, use L</file> instead which can now process compressed files."
30885 #: ../fish/guestfish-actions.pod:4897
30891 #: ../fish/guestfish-actions.pod:4899
30894 " zgrep regex path\n"
30900 #: ../fish/guestfish-actions.pod:4907
30906 #: ../fish/guestfish-actions.pod:4909
30909 " zgrepi regex path\n"
30915 #: ../fish/guestfish-commands.pod:1
30921 #: ../fish/guestfish-commands.pod:3
30927 #: ../fish/guestfish-commands.pod:5
30930 " alloc filename size\n"
30936 #: ../fish/guestfish-commands.pod:7
30938 "This creates an empty (zeroed) file of the given size, and then adds so it "
30939 "can be further examined."
30944 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
30945 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
30950 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
30951 msgid "Size can be specified using standard suffixes, eg. C<1M>."
30956 #: ../fish/guestfish-commands.pod:14
30958 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
30959 "image, see L</PREPARED DISK IMAGES>."
30964 #: ../fish/guestfish-commands.pod:17
30970 #: ../fish/guestfish-commands.pod:19
30973 " copy-in local [local ...] /remotedir\n"
30979 #: ../fish/guestfish-commands.pod:21
30981 "C<copy-in> copies local files or directories recursively into the disk "
30982 "image, placing them in the directory called C</remotedir> (which must "
30983 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
30984 "other commands as necessary."
30989 #: ../fish/guestfish-commands.pod:26
30991 "Multiple local files and directories can be specified, but the last "
30992 "parameter must always be a remote directory. Wildcards cannot be used."
30997 #: ../fish/guestfish-commands.pod:30
31003 #: ../fish/guestfish-commands.pod:32
31006 " copy-out remote [remote ...] localdir\n"
31012 #: ../fish/guestfish-commands.pod:34
31014 "C<copy-out> copies remote files or directories recursively out of the disk "
31015 "image, placing them on the host disk in a local directory called C<localdir> "
31016 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31017 "download>, L</tar-out> and other commands as necessary."
31022 #: ../fish/guestfish-commands.pod:40
31024 "Multiple remote files and directories can be specified, but the last "
31025 "parameter must always be a local directory. To download to the current "
31026 "directory, use C<.> as in:"
31031 #: ../fish/guestfish-commands.pod:44
31034 " copy-out /home .\n"
31040 #: ../fish/guestfish-commands.pod:46
31042 "Wildcards cannot be used in the ordinary command, but you can use them with "
31043 "the help of L</glob> like this:"
31048 #: ../fish/guestfish-commands.pod:49
31051 " glob copy-out /home/* .\n"
31057 #: ../fish/guestfish-commands.pod:51
31063 #: ../fish/guestfish-commands.pod:53
31066 " echo [params ...]\n"
31072 #: ../fish/guestfish-commands.pod:55
31073 msgid "This echos the parameters to the terminal."
31078 #: ../fish/guestfish-commands.pod:57
31084 #: ../fish/guestfish-commands.pod:59
31090 #: ../fish/guestfish-commands.pod:61
31096 #: ../fish/guestfish-commands.pod:63
31105 #: ../fish/guestfish-commands.pod:65
31107 "This is used to edit a file. It downloads the file, edits it locally using "
31108 "your editor, then uploads the result."
31113 #: ../fish/guestfish-commands.pod:68
31115 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31116 "or C<emacs> you will get those corresponding editors."
31121 #: ../fish/guestfish-commands.pod:72
31127 #: ../fish/guestfish-commands.pod:74
31130 " glob command args...\n"
31136 #: ../fish/guestfish-commands.pod:76
31138 "Expand wildcards in any paths in the args list, and run C<command> "
31139 "repeatedly on each matching path."
31144 #: ../fish/guestfish-commands.pod:79
31145 msgid "See L</WILDCARDS AND GLOBBING>."
31150 #: ../fish/guestfish-commands.pod:81
31156 #: ../fish/guestfish-commands.pod:83
31159 " hexedit <filename|device>\n"
31160 " hexedit <filename|device> <max>\n"
31161 " hexedit <filename|device> <start> <max>\n"
31167 #: ../fish/guestfish-commands.pod:87
31169 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31175 #: ../fish/guestfish-commands.pod:90
31177 "This command works by downloading potentially the whole file or device, "
31178 "editing it locally, then uploading it. If the file or device is large, you "
31179 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31180 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31181 "usual modifiers allowed such as C<1M> (1 megabyte)."
31186 #: ../fish/guestfish-commands.pod:97
31187 msgid "For example to edit the first few sectors of a disk you might do:"
31192 #: ../fish/guestfish-commands.pod:100
31195 " hexedit /dev/sda 1M\n"
31201 #: ../fish/guestfish-commands.pod:102
31203 "which would allow you to edit anywhere within the first megabyte of the disk."
31208 #: ../fish/guestfish-commands.pod:105
31209 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31214 #: ../fish/guestfish-commands.pod:107
31217 " hexedit /dev/sda1 0x400 0x400\n"
31223 #: ../fish/guestfish-commands.pod:109
31224 msgid "(assuming the superblock is in the standard location)."
31229 #: ../fish/guestfish-commands.pod:111
31231 "This command requires the external L<hexedit(1)> program. You can specify "
31232 "another program to use by setting the C<HEXEDITOR> environment variable."
31237 #: ../fish/guestfish-commands.pod:115
31238 msgid "See also L</hexdump>."
31243 #: ../fish/guestfish-commands.pod:117
31249 #: ../fish/guestfish-commands.pod:119
31258 #: ../fish/guestfish-commands.pod:121
31260 "Change the local directory, ie. the current directory of guestfish itself."
31265 #: ../fish/guestfish-commands.pod:124
31266 msgid "Note that C<!cd> won't do what you might expect."
31271 #: ../fish/guestfish-commands.pod:126
31277 #: ../fish/guestfish-commands.pod:128
31283 #: ../fish/guestfish-commands.pod:130
31292 #: ../fish/guestfish-commands.pod:132
31293 msgid "Opens the manual page for guestfish."
31298 #: ../fish/guestfish-commands.pod:134
31304 #: ../fish/guestfish-commands.pod:136
31310 #: ../fish/guestfish-commands.pod:138
31319 #: ../fish/guestfish-commands.pod:140
31328 #: ../fish/guestfish-commands.pod:142
31329 msgid "This is used to view a file."
31334 #: ../fish/guestfish-commands.pod:144
31336 "The default viewer is C<$PAGER>. However if you use the alternate command "
31337 "C<less> you will get the C<less> command specifically."
31342 #: ../fish/guestfish-commands.pod:147
31348 #: ../fish/guestfish-commands.pod:149
31357 #: ../fish/guestfish-commands.pod:151
31359 "Close and reopen the libguestfs handle. It is not necessary to use this "
31360 "normally, because the handle is closed properly when guestfish exits. "
31361 "However this is occasionally useful for testing."
31366 #: ../fish/guestfish-commands.pod:155
31372 #: ../fish/guestfish-commands.pod:157
31375 " sparse filename size\n"
31381 #: ../fish/guestfish-commands.pod:159
31383 "This creates an empty sparse file of the given size, and then adds so it can "
31384 "be further examined."
31389 #: ../fish/guestfish-commands.pod:162
31391 "In all respects it works the same as the L</alloc> command, except that the "
31392 "image file is allocated sparsely, which means that disk blocks are not "
31393 "assigned to the file until they are needed. Sparse disk files only use "
31394 "space when written to, but they are slower and there is a danger you could "
31395 "run out of real disk space during a write operation."
31400 #: ../fish/guestfish-commands.pod:172
31406 #: ../fish/guestfish-commands.pod:174
31415 #: ../fish/guestfish-commands.pod:176
31417 "This command returns a list of the optional groups known to the daemon, and "
31418 "indicates which ones are supported by this build of the libguestfs appliance."
31423 #: ../fish/guestfish-commands.pod:180
31424 msgid "See also L<guestfs(3)/AVAILABILITY>."
31429 #: ../fish/guestfish-commands.pod:182
31435 #: ../fish/guestfish-commands.pod:184
31438 " time command args...\n"
31444 #: ../fish/guestfish-commands.pod:186
31446 "Run the command as usual, but print the elapsed time afterwards. This can "
31447 "be useful for benchmarking operations."
31452 #: ../test-tool/libguestfs-test-tool.pod:5
31453 msgid "libguestfs-test-tool - End user tests for libguestfs"
31458 #: ../test-tool/libguestfs-test-tool.pod:9
31461 " libguestfs-test-tool [--options]\n"
31467 #: ../test-tool/libguestfs-test-tool.pod:13
31469 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31470 "and developers, to allow them to check basic libguestfs functionality is "
31471 "working. This is needed because libguestfs occasionally breaks for reasons "
31472 "beyond our control: usually because of changes in the underlying qemu or "
31473 "kernel packages, or the host environment."
31478 #: ../test-tool/libguestfs-test-tool.pod:20
31479 msgid "If you suspect a problem in libguestfs, then just run:"
31484 #: ../test-tool/libguestfs-test-tool.pod:22
31487 " libguestfs-test-tool\n"
31493 #: ../test-tool/libguestfs-test-tool.pod:24
31494 msgid "It will print lots of diagnostic messages."
31499 #: ../test-tool/libguestfs-test-tool.pod:26
31500 msgid "If it runs to completion successfully, you will see this near the end:"
31505 #: ../test-tool/libguestfs-test-tool.pod:28
31508 " ===== TEST FINISHED OK =====\n"
31514 #: ../test-tool/libguestfs-test-tool.pod:30
31515 msgid "and the test tool will exit with code 0."
31520 #: ../test-tool/libguestfs-test-tool.pod:32
31522 "If it fails (and/or exits with non-zero error code), please paste the "
31523 "B<complete, unedited> output of the test tool into a bug report. More "
31524 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31530 #: ../test-tool/libguestfs-test-tool.pod:41
31536 #: ../test-tool/libguestfs-test-tool.pod:43
31537 msgid "Display short usage information and exit."
31542 #: ../test-tool/libguestfs-test-tool.pod:45
31543 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
31548 #: ../test-tool/libguestfs-test-tool.pod:47
31550 "Pass an alternate name for the helper program. libguestfs-test-tool will "
31551 "normally look in the C<$libexec> directory that was configured when the tool "
31557 #: ../test-tool/libguestfs-test-tool.pod:51
31558 msgid "I<--qemu qemu_binary>"
31563 #: ../test-tool/libguestfs-test-tool.pod:53
31565 "If you have downloaded another qemu binary, point this option at the full "
31566 "path of the binary to try it."
31571 #: ../test-tool/libguestfs-test-tool.pod:56
31572 msgid "I<--qemudir qemu_source_dir>"
31577 #: ../test-tool/libguestfs-test-tool.pod:58
31579 "If you have compiled qemu from source, point this option at the source "
31580 "directory to try it."
31585 #: ../test-tool/libguestfs-test-tool.pod:61
31586 msgid "I<--timeout N>"
31591 #: ../test-tool/libguestfs-test-tool.pod:63
31593 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31594 "does not usually need to be adjusted unless your machine is very slow."
31599 #: ../test-tool/libguestfs-test-tool.pod:69
31600 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31605 #: ../test-tool/libguestfs-test-tool.pod:71
31607 "If you have compiled another version of qemu from source and would like to "
31608 "try that, then you can use the I<--qemudir> option to point to the qemu "
31609 "source directory."
31614 #: ../test-tool/libguestfs-test-tool.pod:75
31616 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
31617 "option to point to the binary."
31622 #: ../test-tool/libguestfs-test-tool.pod:78
31624 "When using an alternate qemu with libguestfs, usually you would need to "
31625 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
31626 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
31627 "use either of the I<--qemudir> or I<--qemu> options."
31632 #: ../test-tool/libguestfs-test-tool.pod:85
31634 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
31635 "I<1> if there was an error."
31640 #: ../test-tool/libguestfs-test-tool.pod:92
31641 msgid "/usr/libexec/libguestfs-test-tool-helper"
31646 #: ../test-tool/libguestfs-test-tool.pod:94
31648 "This helper program is run inside the appliance and provides additional "
31654 #: ../test-tool/libguestfs-test-tool.pod:97
31655 msgid "/usr/bin/mkisofs"
31660 #: ../test-tool/libguestfs-test-tool.pod:99
31662 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
31663 "which is used as part of the tests."
31668 #: ../test-tool/libguestfs-test-tool.pod:106
31670 "For the full list of environment variables which may affect libguestfs, "
31671 "please see the L<guestfs(3)> manual page."
31676 #: ../test-tool/libguestfs-test-tool.pod:111
31677 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
31682 #: ../test-tool/libguestfs-test-tool.pod:121
31683 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
31688 #: ../fuse/guestmount.pod:5
31690 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
31695 #: ../fuse/guestmount.pod:9
31698 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
31704 #: ../fuse/guestmount.pod:11
31707 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
31713 #: ../fuse/guestmount.pod:13
31716 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
31722 #: ../fuse/guestmount.pod:17
31724 "You must I<not> use C<guestmount> in read-write mode on live virtual "
31725 "machines. If you do this, you risk disk corruption in the VM."
31730 #: ../fuse/guestmount.pod:22
31732 "The guestmount program can be used to mount virtual machine filesystems and "
31733 "other disk images on the host. It uses libguestfs for access to the guest "
31734 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
31735 "a mountable device."
31740 #: ../fuse/guestmount.pod:27
31742 "Along with other options, you have to give at least one device (I<-a> "
31743 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
31744 "option) or use the I<-i> inspection option. How this works is better "
31745 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
31751 #: ../fuse/guestmount.pod:33
31753 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
31754 "by you, and the filesystem will not be visible to any other users unless you "
31755 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
31756 "the filesystem, use the C<fusermount -u> command."
31761 #: ../fuse/guestmount.pod:41
31763 "For a typical Windows guest which has its main filesystem on the first "
31769 #: ../fuse/guestmount.pod:44
31772 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
31778 #: ../fuse/guestmount.pod:46
31780 "For a typical Linux guest which has a /boot filesystem on the first "
31781 "partition, and the root filesystem on a logical volume:"
31786 #: ../fuse/guestmount.pod:49
31789 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
31795 #: ../fuse/guestmount.pod:51
31796 msgid "To get libguestfs to detect guest mountpoints for you:"
31801 #: ../fuse/guestmount.pod:53
31804 " guestmount -a guest.img -i --ro /mnt\n"
31810 #: ../fuse/guestmount.pod:55
31811 msgid "For a libvirt guest called \"Guest\" you could do:"
31816 #: ../fuse/guestmount.pod:57
31819 " guestmount -d Guest -i --ro /mnt\n"
31825 #: ../fuse/guestmount.pod:59
31827 "If you don't know what filesystems are contained in a guest or disk image, "
31828 "use L<virt-filesystems(1)> first:"
31833 #: ../fuse/guestmount.pod:62
31836 " virt-filesystems MyGuest\n"
31842 #: ../fuse/guestmount.pod:64
31844 "If you want to trace the libguestfs calls but without excessive debugging "
31845 "information, we recommend:"
31850 #: ../fuse/guestmount.pod:67
31853 " guestmount [...] --trace /mnt\n"
31859 #: ../fuse/guestmount.pod:69
31860 msgid "If you want to debug the program, we recommend:"
31865 #: ../fuse/guestmount.pod:71
31868 " guestmount [...] --trace --verbose /mnt\n"
31874 #: ../fuse/guestmount.pod:77
31875 msgid "B<-a image> | B<--add image>"
31880 #: ../fuse/guestmount.pod:79
31881 msgid "Add a block device or virtual machine image."
31886 #: ../fuse/guestmount.pod:84
31887 msgid "B<-c URI> | B<--connect URI>"
31892 #: ../fuse/guestmount.pod:90
31893 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
31898 #: ../fuse/guestmount.pod:96
31899 msgid "B<--dir-cache-timeout N>"
31904 #: ../fuse/guestmount.pod:98
31906 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
31907 "seconds. The readdir cache [actually, there are several semi-independent "
31908 "caches] is populated after a readdir(2) call with the stat and extended "
31909 "attributes of the files in the directory, in anticipation that they will be "
31910 "requested soon after."
31915 #: ../fuse/guestmount.pod:104
31917 "There is also a different attribute cache implemented by FUSE (see the FUSE "
31918 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
31919 "requests, only cache existing ones."
31924 #: ../fuse/guestmount.pod:115
31925 msgid "B<--format=raw|qcow2|..> | B<--format>"
31930 #: ../fuse/guestmount.pod:122
31932 "If you have untrusted raw-format guest disk images, you should use this "
31933 "option to specify the disk format. This avoids a possible security problem "
31934 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
31935 "guestfs_add_drive_opts>."
31940 #: ../fuse/guestmount.pod:127
31941 msgid "B<--fuse-help>"
31946 #: ../fuse/guestmount.pod:129
31947 msgid "Display help on special FUSE options (see I<-o> below)."
31952 #: ../fuse/guestmount.pod:133
31953 msgid "Display brief help and exit."
31958 #: ../fuse/guestmount.pod:135
31959 msgid "B<-i> | B<--inspector>"
31964 #: ../fuse/guestmount.pod:151
31965 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
31970 #: ../fuse/guestmount.pod:153
31972 "Mount the named partition or logical volume on the given mountpoint B<in the "
31973 "guest> (this has nothing to do with mountpoints in the host)."
31978 #: ../fuse/guestmount.pod:156
31980 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
31981 "something on C</>."
31986 #: ../fuse/guestmount.pod:159
31987 msgid "B<-n> | B<--no-sync>"
31992 #: ../fuse/guestmount.pod:161
31994 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
31995 "unmounted. If you specify this option, then we don't attempt to sync the "
31996 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32001 #: ../fuse/guestmount.pod:166
32002 msgid "B<-o option> | B<--option option>"
32007 #: ../fuse/guestmount.pod:168
32008 msgid "Pass extra options to FUSE."
32013 #: ../fuse/guestmount.pod:170
32015 "To get a list of all the extra options supported by FUSE, use the command "
32016 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32017 "of them are a good idea."
32022 #: ../fuse/guestmount.pod:174
32025 " guestmount --fuse-help\n"
32031 #: ../fuse/guestmount.pod:176
32032 msgid "Some potentially useful FUSE options:"
32037 #: ../fuse/guestmount.pod:180
32038 msgid "B<-o allow_other>"
32043 #: ../fuse/guestmount.pod:182
32044 msgid "Allow other users to see the filesystem."
32049 #: ../fuse/guestmount.pod:184
32050 msgid "B<-o attr_timeout=N>"
32055 #: ../fuse/guestmount.pod:186
32056 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32061 #: ../fuse/guestmount.pod:188
32062 msgid "B<-o kernel_cache>"
32067 #: ../fuse/guestmount.pod:190
32069 "Allow the kernel to cache files (reduces the number of reads that have to go "
32070 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32071 "afford the extra memory usage."
32076 #: ../fuse/guestmount.pod:194
32077 msgid "B<-o uid=N> B<-o gid=N>"
32082 #: ../fuse/guestmount.pod:196
32084 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32085 "the chosen values."
32090 #: ../fuse/guestmount.pod:201
32091 msgid "B<-r> | B<--ro>"
32096 #: ../fuse/guestmount.pod:203
32098 "Add devices and mount everything read-only. Also disallow writes and make "
32099 "the disk appear read-only to FUSE."
32104 #: ../fuse/guestmount.pod:206
32106 "This is highly recommended if you are not going to edit the guest disk. If "
32107 "the guest is running and this option is I<not> supplied, then there is a "
32108 "strong risk of disk corruption in the guest. We try to prevent this from "
32109 "happening, but it is not always possible."
32114 #: ../fuse/guestmount.pod:211
32115 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32120 #: ../fuse/guestmount.pod:215
32121 msgid "Enable SELinux support for the guest."
32126 #: ../fuse/guestmount.pod:217
32127 msgid "B<-v> | B<--verbose>"
32132 #: ../fuse/guestmount.pod:219
32133 msgid "Enable verbose messages from underlying libguestfs."
32138 #: ../fuse/guestmount.pod:221
32139 msgid "B<-V> | B<--version>"
32144 #: ../fuse/guestmount.pod:223
32145 msgid "Display the program version and exit."
32150 #: ../fuse/guestmount.pod:225
32151 msgid "B<-w> | B<--rw>"
32156 #: ../fuse/guestmount.pod:227
32158 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
32159 "FOR READ AND WRITE>."
32164 #: ../fuse/guestmount.pod:230
32165 msgid "B<-x> | B<--trace>"
32170 #: ../fuse/guestmount.pod:232
32171 msgid "Trace libguestfs calls and entry into each FUSE function."
32176 #: ../fuse/guestmount.pod:234
32177 msgid "This also stops the daemon from forking into the background."
32182 #: ../fuse/guestmount.pod:240
32184 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32185 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32191 #: ../tools/virt-edit.pl:34
32192 msgid "virt-edit - Edit a file in a virtual machine"
32197 #: ../tools/virt-edit.pl:38
32200 " virt-edit [--options] domname file\n"
32206 #: ../tools/virt-edit.pl:40
32209 " virt-edit [--options] disk.img [disk.img ...] file\n"
32215 #: ../tools/virt-edit.pl:42
32218 " virt-edit [domname|disk.img] file -e 'expr'\n"
32224 #: ../tools/virt-edit.pl:46
32226 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32227 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32228 "doing this, but doesn't catch all cases."
32233 #: ../tools/virt-edit.pl:52
32235 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32236 "the named virtual machine (or disk image)."
32241 #: ../tools/virt-edit.pl:55
32243 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
32244 "you should look at the L<guestfish(1)> tool."
32249 #: ../tools/virt-edit.pl:60
32250 msgid "Edit the named files interactively:"
32255 #: ../tools/virt-edit.pl:62
32258 " virt-edit mydomain /boot/grub/grub.conf\n"
32264 #: ../tools/virt-edit.pl:64
32267 " virt-edit mydomain /etc/passwd\n"
32273 #: ../tools/virt-edit.pl:66
32275 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32276 "below). To change the init default level to 5:"
32281 #: ../tools/virt-edit.pl:70
32284 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32290 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106
32291 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32292 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32293 msgid "Display brief help."
32298 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114
32299 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
32300 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
32301 #: ../tools/virt-list-partitions.pl:72
32302 msgid "Display version number and exit."
32307 #: ../tools/virt-edit.pl:96
32308 msgid "B<--backup extension> | B<-b extension>"
32313 #: ../tools/virt-edit.pl:98
32315 "Create a backup of the original file I<in the guest disk image>. The backup "
32316 "has the original filename with C<extension> added."
32321 #: ../tools/virt-edit.pl:101
32323 "Usually the first character of C<extension> would be a dot C<.> so you would "
32329 #: ../tools/virt-edit.pl:104
32332 " virt-edit -b .orig [etc]\n"
32338 #: ../tools/virt-edit.pl:106
32339 msgid "By default, no backup file is made."
32344 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128
32345 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32346 #: ../tools/virt-list-partitions.pl:78
32347 msgid "B<--connect URI> | B<-c URI>"
32352 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130
32353 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32354 #: ../tools/virt-list-partitions.pl:80
32356 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32357 "to the default libvirt hypervisor."
32362 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133
32363 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32364 #: ../tools/virt-list-partitions.pl:83
32366 "If you specify guest block devices directly, then libvirt is not used at all."
32371 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140
32372 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
32373 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
32374 msgid "B<--format> raw"
32379 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142
32380 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32381 #: ../tools/virt-list-partitions.pl:92
32383 "Specify the format of disk images given on the command line. If this is "
32384 "omitted then the format is autodetected from the content of the disk image."
32389 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146
32390 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32391 #: ../tools/virt-list-partitions.pl:96
32393 "If disk images are requested from libvirt, then this program asks libvirt "
32394 "for this information. In this case, the value of the format parameter is "
32400 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150
32401 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
32402 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32403 #: ../tools/virt-list-partitions.pl:100
32405 "If working with untrusted raw-format guest disk images, you should ensure "
32406 "the format is always specified."
32411 #: ../tools/virt-edit.pl:141
32412 msgid "B<--expr EXPR> | B<-e EXPR>"
32417 #: ../tools/virt-edit.pl:143
32419 "Instead of launching the external editor, non-interactively apply the Perl "
32420 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32426 #: ../tools/virt-edit.pl:147
32428 "Be careful to properly quote the expression to prevent it from being altered "
32434 #: ../tools/virt-edit.pl:268
32435 msgid "NON-INTERACTIVE EDITING"
32440 #: ../tools/virt-edit.pl:270
32442 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32443 "administrator can interactively edit the file."
32448 #: ../tools/virt-edit.pl:273
32450 "There are two ways also to use C<virt-edit> from scripts in order to make "
32451 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32452 "like this, it's less error-prone to write scripts directly using the "
32453 "libguestfs API and Augeas for configuration file editing.)"
32458 #: ../tools/virt-edit.pl:279
32460 "The first method is to temporarily set C<$EDITOR> to any script or program "
32461 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32462 "update C<tmpfile> in place however it likes."
32467 #: ../tools/virt-edit.pl:283
32469 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
32470 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32471 "instances of C<foo> with C<bar> in a file:"
32476 #: ../tools/virt-edit.pl:287
32479 " virt-edit domname filename -e 's/foo/bar/'\n"
32485 #: ../tools/virt-edit.pl:289
32487 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32488 "For example to delete root's password you could do:"
32493 #: ../tools/virt-edit.pl:292
32496 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32502 #: ../tools/virt-edit.pl:294
32504 "What really happens is that the snippet is evaluated as a Perl expression "
32505 "for each line of the file. The line, including the final C<\\n>, is passed "
32506 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32511 #: ../tools/virt-edit.pl:299
32513 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32514 "C<apache> user account from the password file you can do:"
32519 #: ../tools/virt-edit.pl:302
32522 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32528 #: ../tools/virt-edit.pl:304
32530 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32531 "the end of the file is rather difficult this way since there is no concept "
32532 "of \"last line of the file\" - your expression just doesn't get called "
32533 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32539 #: ../tools/virt-edit.pl:310
32541 "The variable C<$lineno> contains the current line number. As is "
32542 "traditional, the first line in the file is number C<1>."
32547 #: ../tools/virt-edit.pl:313
32549 "The return value from the expression is ignored, but the expression may call "
32550 "C<die> in order to abort the whole program, leaving the original file "
32556 #: ../tools/virt-edit.pl:317
32558 "Remember when matching the end of a line that C<$_> may contain the final C<"
32559 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32560 "newline then neither of these. Thus to match or substitute some text at the "
32561 "end of a line, use this regular expression:"
32566 #: ../tools/virt-edit.pl:322
32569 " /some text(\\r?\\n)?$/\n"
32575 #: ../tools/virt-edit.pl:324
32577 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32578 "$_> itself (since that would remove all newlines from the file):"
32583 #: ../tools/virt-edit.pl:328
32586 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32592 #: ../tools/virt-edit.pl:334
32598 #: ../tools/virt-edit.pl:336
32600 "If set, this string is used as the editor. It may contain arguments, eg. C<"
32606 #: ../tools/virt-edit.pl:339
32607 msgid "If not set, C<vi> is used."
32612 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559
32613 #: ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182
32614 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
32615 #: ../tools/virt-list-partitions.pl:250
32616 msgid "SHELL QUOTING"
32621 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567
32622 #: ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184
32623 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
32624 #: ../tools/virt-list-partitions.pl:252
32626 "Libvirt guest names can contain arbitrary characters, some of which have "
32627 "meaning to the shell such as C<#> and space. You may need to quote or "
32628 "escape these characters on the command line. See the shell manual page L<sh"
32629 "(1)> for details."
32633 #: ../tools/virt-edit.pl:352
32635 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
32636 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
32637 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
32642 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598
32643 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202
32644 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
32645 #: ../tools/virt-list-partitions.pl:269
32651 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600
32652 #: ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204
32653 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
32654 #: ../tools/virt-list-partitions.pl:271
32655 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
32660 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
32661 msgid "Copyright (C) 2009-2010 Red Hat Inc."
32666 #: ../tools/virt-win-reg.pl:37
32668 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
32673 #: ../tools/virt-win-reg.pl:41
32676 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
32682 #: ../tools/virt-win-reg.pl:43
32685 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
32691 #: ../tools/virt-win-reg.pl:45
32694 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
32700 #: ../tools/virt-win-reg.pl:47
32703 " virt-win-reg --merge domname [input.reg ...]\n"
32709 #: ../tools/virt-win-reg.pl:49
32712 " virt-win-reg [--options] disk.img ... # instead of domname\n"
32718 #: ../tools/virt-win-reg.pl:53
32720 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
32721 "virtual machines. If you do this, you I<will> get irreversible disk "
32722 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
32723 "but doesn't catch all cases."
32728 #: ../tools/virt-win-reg.pl:58
32730 "Modifying the Windows Registry is an inherently risky operation. The format "
32731 "is deliberately obscure and undocumented, and Registry changes can leave the "
32732 "system unbootable. Therefore when using the C<--merge> option, make sure "
32733 "you have a reliable backup first."
32738 #: ../tools/virt-win-reg.pl:65
32740 "This program can export and merge Windows Registry entries from a Windows "
32746 #: ../tools/virt-win-reg.pl:68
32748 "The first parameter is the libvirt guest name or the raw disk image of a "
32754 #: ../tools/virt-win-reg.pl:71
32756 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
32757 "exported (recursively). For example:"
32762 #: ../tools/virt-win-reg.pl:74
32765 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
32771 #: ../tools/virt-win-reg.pl:76
32773 "You can also display single values from within registry keys, for example:"
32778 #: ../tools/virt-win-reg.pl:79
32781 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
32782 " $ virt-win-reg Windows7 $cvkey ProductName\n"
32783 " Windows 7 Enterprise\n"
32789 #: ../tools/virt-win-reg.pl:83
32791 "With C<--merge>, you can merge a textual regedit file into the Windows "
32797 #: ../tools/virt-win-reg.pl:86
32800 " $ virt-win-reg --merge Windows7 changes.reg\n"
32806 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
32812 #: ../tools/virt-win-reg.pl:90
32814 "This program is only meant for simple access to the registry. If you want "
32815 "to do complicated things with the registry, we suggest you download the "
32816 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
32817 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
32818 "L<hivexregedit(1)>."
32823 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
32829 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
32830 msgid "Enable debugging messages."
32835 #: ../tools/virt-win-reg.pl:157
32841 #: ../tools/virt-win-reg.pl:159
32843 "In merge mode, this merges a textual regedit file into the Windows Registry "
32844 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
32845 "displays or exports Registry entries instead."
32850 #: ../tools/virt-win-reg.pl:163
32852 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
32853 "result in disk corruption. However exporting (without this flag) is always "
32859 #: ../tools/virt-win-reg.pl:171
32860 msgid "B<--encoding> UTF-16LE|ASCII"
32865 #: ../tools/virt-win-reg.pl:173
32867 "When merging (only), you may need to specify the encoding for strings to be "
32868 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
32869 "(3)/ENCODING STRINGS>."
32874 #: ../tools/virt-win-reg.pl:177
32876 "The default is to use UTF-16LE, which should work with recent versions of "
32882 #: ../tools/virt-win-reg.pl:402
32883 msgid "SUPPORTED SYSTEMS"
32888 #: ../tools/virt-win-reg.pl:404
32890 "The program currently supports Windows NT-derived guests starting with "
32891 "Windows XP through to at least Windows 7."
32896 #: ../tools/virt-win-reg.pl:407
32898 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
32899 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
32900 "and C<HKEY_USERS\\.DEFAULT>."
32905 #: ../tools/virt-win-reg.pl:411
32907 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
32913 #: ../tools/virt-win-reg.pl:414
32915 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
32921 #: ../tools/virt-win-reg.pl:417
32927 #: ../tools/virt-win-reg.pl:419
32929 "C<virt-win-reg> expects that regedit files have already been reencoded in "
32930 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
32931 "style line endings. Since Windows regedit files are often in UTF-16LE with "
32932 "Windows-style line endings, you may need to reencode the whole file before "
32933 "or after processing."
32938 #: ../tools/virt-win-reg.pl:425
32940 "To reencode a file from Windows format to Linux (before processing it with "
32941 "the C<--merge> option), you would do something like this:"
32946 #: ../tools/virt-win-reg.pl:428
32949 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
32955 #: ../tools/virt-win-reg.pl:430
32957 "To go in the opposite direction, after exporting and before sending the file "
32958 "to a Windows user, do something like this:"
32963 #: ../tools/virt-win-reg.pl:433
32966 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
32972 #: ../tools/virt-win-reg.pl:435
32973 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
32978 #: ../tools/virt-win-reg.pl:437
32980 "If you are unsure about the current encoding, use the L<file(1)> command. "
32981 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
32982 "style (CRLF) line endings, like this:"
32987 #: ../tools/virt-win-reg.pl:441
32990 " $ file software.reg\n"
32991 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
32992 " with CRLF line terminators\n"
32998 #: ../tools/virt-win-reg.pl:445
32999 msgid "This file would need conversion before you could C<--merge> it."
33004 #: ../tools/virt-win-reg.pl:447
33005 msgid "CurrentControlSet etc."
33010 #: ../tools/virt-win-reg.pl:449
33012 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33013 "Registry at the level of the hive file, and therefore you cannot modify "
33019 #: ../tools/virt-win-reg.pl:453
33021 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33022 "circumstances it might refer to another control set. The way to find out is "
33023 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33028 #: ../tools/virt-win-reg.pl:457
33031 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33032 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33033 " \"Current\"=dword:00000001\n"
33034 " \"Default\"=dword:00000001\n"
33035 " \"Failed\"=dword:00000000\n"
33036 " \"LastKnownGood\"=dword:00000002\n"
33042 #: ../tools/virt-win-reg.pl:464
33043 msgid "\"Current\" is the one which Windows will choose when it boots."
33048 #: ../tools/virt-win-reg.pl:466
33050 "Similarly, other C<Current...> keys in the path may need to be replaced."
33055 #: ../tools/virt-win-reg.pl:469
33056 msgid "WINDOWS TIPS"
33061 #: ../tools/virt-win-reg.pl:471
33063 "Note that some of these tips modify the guest disk image. The guest I<must> "
33064 "be shut off, else you will get disk corruption."
33069 #: ../tools/virt-win-reg.pl:474
33070 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33075 #: ../tools/virt-win-reg.pl:476
33077 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33078 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33079 "is uploaded into C<C:\\>:"
33084 #: ../tools/virt-win-reg.pl:480
33087 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33093 #: ../tools/virt-win-reg.pl:482
33094 msgid "Prepare a regedit file containing the registry change:"
33099 #: ../tools/virt-win-reg.pl:484
33102 " cat > test.reg <<'EOF'\n"
33103 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33104 " \"Test\"=\"c:\\\\test.bat\"\n"
33111 #: ../tools/virt-win-reg.pl:489
33113 "In this example we use the key C<RunOnce> which means that the script will "
33114 "run precisely once when the first user logs in. If you want it to run every "
33115 "time a user logs in, replace C<RunOnce> with C<Run>."
33120 #: ../tools/virt-win-reg.pl:493
33121 msgid "Now update the registry:"
33126 #: ../tools/virt-win-reg.pl:495
33129 " virt-win-reg --merge WindowsGuest test.reg\n"
33135 #: ../tools/virt-win-reg.pl:497
33136 msgid "INSTALLING A SERVICE"
33141 #: ../tools/virt-win-reg.pl:499
33143 "This section assumes you are familiar with Windows services, and you either "
33144 "have a program which handles the Windows Service Control Protocol directly "
33145 "or you want to run any program using a service wrapper like SrvAny or the "
33151 #: ../tools/virt-win-reg.pl:504
33153 "First upload the program and optionally the service wrapper. In this case "
33154 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33159 #: ../tools/virt-win-reg.pl:508
33162 " guestfish -i -d WindowsGuest <<EOF\n"
33163 " upload rhsrvany.exe /rhsrvany.exe\n"
33164 " upload test.exe /test.exe\n"
33171 #: ../tools/virt-win-reg.pl:513
33173 "Prepare a regedit file containing the registry changes. In this example, "
33174 "the first registry change is needed for the service itself or the service "
33175 "wrapper (if used). The second registry change is only needed because I am "
33176 "using the RHSrvAny service wrapper."
33181 #: ../tools/virt-win-reg.pl:518
33184 " cat > service.reg <<'EOF'\n"
33185 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33186 " \"Type\"=dword:00000010\n"
33187 " \"Start\"=dword:00000002\n"
33188 " \"ErrorControl\"=dword:00000001\n"
33189 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33190 " \"DisplayName\"=\"RHSrvAny\"\n"
33191 " \"ObjectName\"=\"NetworkService\"\n"
33197 #: ../tools/virt-win-reg.pl:527
33200 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33201 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33202 " \"PWD\"=\"c:\\\\Temp\"\n"
33209 #: ../tools/virt-win-reg.pl:538
33211 "For use of C<ControlSet001> see the section above in this manual page. You "
33212 "may need to adjust this according to the control set that is in use by the "
33218 #: ../tools/virt-win-reg.pl:544
33220 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33221 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33222 "privileged account."
33227 #: ../tools/virt-win-reg.pl:550
33229 "For the meaning of the magic numbers, see this Microsoft KB article: "
33230 "L<http://support.microsoft.com/kb/103000>."
33235 #: ../tools/virt-win-reg.pl:555
33236 msgid "Update the registry:"
33241 #: ../tools/virt-win-reg.pl:557
33244 " virt-win-reg --merge WindowsGuest service.reg\n"
33250 #: ../tools/virt-win-reg.pl:561
33252 "Be careful when passing parameters containing C<\\> (backslash) in the "
33253 "shell. Usually you will have to use 'single quotes' or double backslashes "
33254 "(but not both) to protect them from the shell."
33259 #: ../tools/virt-win-reg.pl:565
33260 msgid "Paths and value names are case-insensitive."
33265 #: ../tools/virt-win-reg.pl:574
33267 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33268 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33269 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33274 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33276 "When reporting bugs, please enable debugging and capture the I<complete> "
33282 #: ../tools/virt-win-reg.pl:592
33285 " export LIBGUESTFS_DEBUG=1\n"
33286 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33292 #: ../tools/virt-win-reg.pl:595
33294 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33300 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516
33301 #: ../tools/virt-make-fs.pl:570
33302 msgid "Copyright (C) 2010 Red Hat Inc."
33307 #: ../tools/virt-resize.pl:42
33308 msgid "virt-resize - Resize a virtual machine disk"
33313 #: ../tools/virt-resize.pl:46
33316 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
33317 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
33318 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
33324 #: ../tools/virt-resize.pl:52
33326 "Virt-resize is a tool which can resize a virtual machine disk, making it "
33327 "larger or smaller overall, and resizing or deleting any partitions contained "
33333 #: ../tools/virt-resize.pl:56
33335 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
33336 "not> be used on live virtual machines - for consistent results, shut the "
33337 "virtual machine down before resizing it."
33342 #: ../tools/virt-resize.pl:60
33344 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
33345 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
33350 #: ../tools/virt-resize.pl:66
33352 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
33353 "fill the extra 5GB of space."
33357 #: ../tools/virt-resize.pl:69
33360 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
33361 " virt-filesystems --long -h --all -a olddisk\n"
33362 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
33363 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
33369 #: ../tools/virt-resize.pl:74
33371 "As above, but make the /boot partition 200MB bigger, while giving the "
33372 "remaining space to /dev/sda2:"
33377 #: ../tools/virt-resize.pl:77
33380 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
33386 #: ../tools/virt-resize.pl:79
33387 msgid "As above, but the output format will be uncompressed qcow2:"
33392 #: ../tools/virt-resize.pl:81
33395 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
33396 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
33402 #: ../tools/virt-resize.pl:84
33403 msgid "DETAILED USAGE"
33408 #: ../tools/virt-resize.pl:86
33409 msgid "EXPANDING A VIRTUAL MACHINE DISK"
33414 #: ../tools/virt-resize.pl:90
33415 msgid "1. Shut down the virtual machine"
33420 #: ../tools/virt-resize.pl:92
33421 msgid "2. Locate input disk image"
33426 #: ../tools/virt-resize.pl:94
33428 "Locate the input disk image (ie. the file or device on the host containing "
33429 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
33430 "dumpxml> like this to find the disk image name:"
33435 #: ../tools/virt-resize.pl:98
33438 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
33439 " Found 1 nodes:\n"
33441 " <source dev=\"/dev/vg/lv_guest\" />\n"
33447 #: ../tools/virt-resize.pl:103
33448 msgid "3. Look at current sizing"
33453 #: ../tools/virt-resize.pl:105
33454 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
33459 #: ../tools/virt-resize.pl:108
33462 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
33463 " Name Type Size Parent\n"
33464 " /dev/sda1 partition 101M /dev/sda\n"
33465 " /dev/sda2 partition 7.9G /dev/sda\n"
33466 " /dev/sda device 8.0G -\n"
33472 #: ../tools/virt-resize.pl:114
33474 "(This example is a virtual machine with an 8 GB disk which we would like to "
33475 "expand up to 10 GB)."
33480 #: ../tools/virt-resize.pl:117
33481 msgid "4. Create output disk"
33486 #: ../tools/virt-resize.pl:119
33488 "Virt-resize cannot do in-place disk modifications. You have to have space "
33489 "to store the resized output disk."
33494 #: ../tools/virt-resize.pl:122
33496 "To store the resized disk image in a file, create a file of a suitable size:"
33501 #: ../tools/virt-resize.pl:125
33504 " # rm -f outdisk\n"
33505 " # truncate -s 10G outdisk\n"
33511 #: ../tools/virt-resize.pl:128
33512 msgid "Or use L<lvcreate(1)> to create a logical volume:"
33517 #: ../tools/virt-resize.pl:130
33520 " # lvcreate -L 10G -n lv_name vg_name\n"
33526 #: ../tools/virt-resize.pl:132
33527 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
33532 #: ../tools/virt-resize.pl:134
33535 " # virsh pool-list\n"
33536 " # virsh vol-create-as poolname newvol 10G\n"
33542 #: ../tools/virt-resize.pl:137
33548 #: ../tools/virt-resize.pl:139
33550 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
33551 "file) and the output disk. The output disk is the one created in the "
33557 #: ../tools/virt-resize.pl:143
33560 " # virt-resize indisk outdisk\n"
33566 #: ../tools/virt-resize.pl:145
33568 "This command just copies disk image C<indisk> to disk image C<outdisk> "
33569 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
33570 "larger, then an extra, empty partition is created at the end of the disk "
33571 "covering the extra space. If C<outdisk> is smaller, then it will give an "
33577 #: ../tools/virt-resize.pl:151
33579 "More realistically you'd want to expand existing partitions in the disk "
33580 "image by passing extra options (for the full list see the L</OPTIONS> "
33586 #: ../tools/virt-resize.pl:155
33588 "L</--expand> is the most useful option. It expands the named partition "
33589 "within the disk to fill any extra space:"
33594 #: ../tools/virt-resize.pl:158
33597 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
33603 #: ../tools/virt-resize.pl:160
33605 "(In this case, an extra partition is I<not> created at the end of the disk, "
33606 "because there will be no unused space)."
33611 #: ../tools/virt-resize.pl:163
33613 "L</--resize> is the other commonly used option. The following would "
33614 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
33615 "rest of the available space:"
33620 #: ../tools/virt-resize.pl:167
33623 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
33624 " indisk outdisk\n"
33630 #: ../tools/virt-resize.pl:170
33632 "If the expanded partition in the image contains a filesystem or LVM PV, then "
33633 "if virt-resize knows how, it will resize the contents, the equivalent of "
33634 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
33635 ">. However virt-resize does not know how to resize some filesystems, so you "
33636 "would have to online resize them after booting the guest."
33641 #: ../tools/virt-resize.pl:177
33642 msgid "Other options are covered below."
33647 #: ../tools/virt-resize.pl:179
33653 #: ../tools/virt-resize.pl:181
33654 msgid "Thoroughly test the new disk image I<before> discarding the old one."
33659 #: ../tools/virt-resize.pl:183
33660 msgid "If you are using libvirt, edit the XML to point at the new disk:"
33665 #: ../tools/virt-resize.pl:185
33668 " # virsh edit guestname\n"
33674 #: ../tools/virt-resize.pl:187
33676 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
33677 "html#elementsDisks>"
33682 #: ../tools/virt-resize.pl:190
33683 msgid "Then start up the domain with the new, resized disk:"
33688 #: ../tools/virt-resize.pl:192
33691 " # virsh start guestname\n"
33697 #: ../tools/virt-resize.pl:194
33699 "and check that it still works. See also the L</NOTES> section below for "
33700 "additional information."
33705 #: ../tools/virt-resize.pl:197
33706 msgid "7. Resize LVs etc inside the guest"
33711 #: ../tools/virt-resize.pl:199
33712 msgid "(This can also be done offline using L<guestfish(1)>)"
33717 #: ../tools/virt-resize.pl:201
33719 "Once the guest has booted you should see the new space available, at least "
33720 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
33721 "may need to resize LVs inside PVs, and also resize filesystem types that "
33722 "virt-resize does not know how to expand."
33727 #: ../tools/virt-resize.pl:208
33728 msgid "SHRINKING A VIRTUAL MACHINE DISK"
33733 #: ../tools/virt-resize.pl:210
33735 "Shrinking is somewhat more complex than expanding, and only an overview is "
33741 #: ../tools/virt-resize.pl:213
33743 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
33744 "filesystems). The user has to shrink content before passing the disk image "
33745 "to virt-resize, and virt-resize will check that the content has been shrunk "
33751 #: ../tools/virt-resize.pl:218
33752 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
33757 #: ../tools/virt-resize.pl:220
33759 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
33760 "steps 3 and 4 above to allocate a new disk image."
33765 #: ../tools/virt-resize.pl:223
33767 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
33772 #: ../tools/virt-resize.pl:226
33773 msgid "IGNORING OR DELETING PARTITIONS"
33778 #: ../tools/virt-resize.pl:228
33780 "virt-resize also gives a convenient way to ignore or delete partitions when "
33781 "copying from the input disk to the output disk. Ignoring a partition speeds "
33782 "up the copy where you don't care about the existing contents of a "
33783 "partition. Deleting a partition removes it completely, but note that it "
33784 "also renumbers any partitions after the one which is deleted, which can "
33785 "leave some guests unbootable."
33790 #: ../tools/virt-resize.pl:235
33791 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
33796 #: ../tools/virt-resize.pl:237
33798 "If the input disk is in qcow2 format, then you may prefer that the output is "
33799 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
33800 "the fly. The output format is simply determined by the format of the empty "
33801 "output container that you provide. Thus to create qcow2 output, use:"
33806 #: ../tools/virt-resize.pl:243
33809 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
33815 #: ../tools/virt-resize.pl:245
33816 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
33821 #: ../tools/virt-resize.pl:247
33822 msgid "Similarly, to get non-sparse raw output use:"
33827 #: ../tools/virt-resize.pl:249
33830 " fallocate -l size outdisk\n"
33836 #: ../tools/virt-resize.pl:251
33838 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
33839 "dev/zero of=outdisk bs=1M count=..>)"
33844 #: ../tools/virt-resize.pl:264
33845 msgid "Display help."
33850 #: ../tools/virt-resize.pl:278
33851 msgid "B<--resize part=size>"
33856 #: ../tools/virt-resize.pl:280
33858 "Resize the named partition (expanding or shrinking it) so that it has the "
33864 #: ../tools/virt-resize.pl:283
33866 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
33867 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
33868 "Exabytes; or as a percentage of the current size; or as a relative number or "
33869 "percentage. For example:"
33874 #: ../tools/virt-resize.pl:288
33877 " --resize /dev/sda2=10G\n"
33883 #: ../tools/virt-resize.pl:290
33886 " --resize /dev/sda4=90%\n"
33892 #: ../tools/virt-resize.pl:292
33895 " --resize /dev/sda2=+1G\n"
33901 #: ../tools/virt-resize.pl:294
33904 " --resize /dev/sda2=-200M\n"
33910 #: ../tools/virt-resize.pl:296
33913 " --resize /dev/sda1=+128K\n"
33919 #: ../tools/virt-resize.pl:298
33922 " --resize /dev/sda1=+10%\n"
33928 #: ../tools/virt-resize.pl:300
33931 " --resize /dev/sda1=-10%\n"
33937 #: ../tools/virt-resize.pl:302
33939 "You can increase the size of any partition. Virt-resize will expand the "
33940 "direct content of the partition if it knows how (see C<--expand> below)."
33945 #: ../tools/virt-resize.pl:306
33947 "You can only I<decrease> the size of partitions that contain filesystems or "
33948 "PVs which have already been shrunk. Virt-resize will check this has been "
33949 "done before proceeding, or else will print an error (see also C<--resize-"
33955 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
33956 #: ../tools/virt-resize.pl:420
33957 msgid "You can give this option multiple times."
33962 #: ../tools/virt-resize.pl:317
33963 msgid "B<--resize-force part=size>"
33968 #: ../tools/virt-resize.pl:319
33970 "This is the same as C<--resize> except that it will let you decrease the "
33971 "size of any partition. Generally this means you will lose any data which "
33972 "was at the end of the partition you shrink, but you may not care about that "
33973 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
33974 "as a swap partition)."
33979 #: ../tools/virt-resize.pl:325
33980 msgid "See also the C<--ignore> option."
33985 #: ../tools/virt-resize.pl:331
33986 msgid "B<--expand part>"
33991 #: ../tools/virt-resize.pl:333
33993 "Expand the named partition so it uses up all extra space (space left over "
33994 "after any other resize changes that you request have been done)."
33999 #: ../tools/virt-resize.pl:336
34001 "If virt-resize knows how, it will expand the direct content of the "
34002 "partition. For example, if the partition is an LVM PV, it will expand the "
34003 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
34004 "content it doesn't know about alone."
34009 #: ../tools/virt-resize.pl:341
34010 msgid "Currently virt-resize can resize:"
34015 #: ../tools/virt-resize.pl:347
34017 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
34023 #: ../tools/virt-resize.pl:352
34025 "NTFS filesystems contained directly in a partition, if libguestfs was "
34026 "compiled with support for NTFS."
34031 #: ../tools/virt-resize.pl:355
34033 "The filesystem must have been shut down consistently last time it was used. "
34034 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
34035 "consistency check, so at the first boot after resizing Windows will check "
34041 #: ../tools/virt-resize.pl:362
34043 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
34044 "inside the PV, but see the C<--LV-expand> option. The user could also "
34045 "resize LVs as desired after boot."
34050 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
34051 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
34056 #: ../tools/virt-resize.pl:374
34057 msgid "B<--shrink part>"
34062 #: ../tools/virt-resize.pl:376
34064 "Shrink the named partition until the overall disk image fits in the "
34065 "destination. The named partition B<must> contain a filesystem or PV which "
34066 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
34067 "online tools). Virt-resize will check this and give an error if it has not "
34073 #: ../tools/virt-resize.pl:382
34075 "The amount by which the overall disk must be shrunk (after carrying out all "
34076 "other operations requested by the user) is called the \"deficit\". For "
34077 "example, a straight copy (assume no other operations) from a 5GB disk image "
34078 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
34079 "would give an error unless the user specified a partition to shrink and that "
34080 "partition had more than a gigabyte of free space."
34085 #: ../tools/virt-resize.pl:396
34086 msgid "B<--ignore part>"
34091 #: ../tools/virt-resize.pl:398
34093 "Ignore the named partition. Effectively this means the partition is "
34094 "allocated on the destination disk, but the content is not copied across from "
34095 "the source disk. The content of the partition will be blank (all zero "
34101 #: ../tools/virt-resize.pl:409
34102 msgid "B<--delete part>"
34107 #: ../tools/virt-resize.pl:411
34109 "Delete the named partition. It would be more accurate to describe this as "
34110 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
34111 "the original disk image is left intact."
34116 #: ../tools/virt-resize.pl:415
34118 "Note that when you delete a partition, then anything contained in the "
34119 "partition is also deleted. Furthermore, this causes any partitions that "
34120 "come after to be I<renumbered>, which can easily make your guest unbootable."
34125 #: ../tools/virt-resize.pl:426
34126 msgid "B<--LV-expand logvol>"
34131 #: ../tools/virt-resize.pl:428
34133 "This takes the logical volume and, as a final step, expands it to fill all "
34134 "the space available in its volume group. A typical usage, assuming a Linux "
34135 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
34136 "lv_root> would be:"
34141 #: ../tools/virt-resize.pl:433
34144 " virt-resize indisk outdisk \\\n"
34145 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
34151 #: ../tools/virt-resize.pl:436
34153 "This would first expand the partition (and PV), and then expand the root "
34154 "device to fill the extra space in the PV."
34159 #: ../tools/virt-resize.pl:439
34161 "The contents of the LV are also resized if virt-resize knows how to do "
34162 "that. You can stop virt-resize from trying to expand the content by using "
34163 "the option C<--no-expand-content>."
34168 #: ../tools/virt-resize.pl:443
34169 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
34174 #: ../tools/virt-resize.pl:446
34176 "You can give this option multiple times, I<but> it doesn't make sense to do "
34177 "this unless the logical volumes you specify are all in different volume "
34183 #: ../tools/virt-resize.pl:454
34184 msgid "B<--no-copy-boot-loader>"
34189 #: ../tools/virt-resize.pl:456
34191 "By default, virt-resize copies over some sectors at the start of the disk "
34192 "(up to the beginning of the first partition). Commonly these sectors "
34193 "contain the Master Boot Record (MBR) and the boot loader, and are required "
34194 "in order for the guest to boot correctly."
34199 #: ../tools/virt-resize.pl:461
34201 "If you specify this flag, then this initial copy is not done. You may need "
34202 "to reinstall the boot loader in this case."
34207 #: ../tools/virt-resize.pl:469
34208 msgid "B<--no-extra-partition>"
34213 #: ../tools/virt-resize.pl:471
34215 "By default, virt-resize creates an extra partition if there is any extra, "
34216 "unused space after all resizing has happened. Use this option to prevent "
34217 "the extra partition from being created. If you do this then the extra space "
34218 "will be inaccessible until you run fdisk, parted, or some other partitioning "
34219 "tool in the guest."
34224 #: ../tools/virt-resize.pl:477
34226 "Note that if the surplus space is smaller than 10 MB, no extra partition "
34232 #: ../tools/virt-resize.pl:484
34233 msgid "B<--no-expand-content>"
34238 #: ../tools/virt-resize.pl:486
34240 "By default, virt-resize will try to expand the direct contents of "
34241 "partitions, if it knows how (see C<--expand> option above)."
34246 #: ../tools/virt-resize.pl:489
34248 "If you give the C<--no-expand-content> option then virt-resize will not "
34254 #: ../tools/virt-resize.pl:496
34255 msgid "B<-d> | B<--debug>"
34260 #: ../tools/virt-resize.pl:504
34261 msgid "B<-n> | B<--dryrun>"
34266 #: ../tools/virt-resize.pl:506
34267 msgid "Print a summary of what would be done, but don't do anything."
34272 #: ../tools/virt-resize.pl:512
34273 msgid "B<-q> | B<--quiet>"
34278 #: ../tools/virt-resize.pl:514
34279 msgid "Don't print the summary."
34284 #: ../tools/virt-resize.pl:522
34286 "Specify the format of the input disk image. If this flag is not given then "
34287 "it is auto-detected from the image itself."
34292 #: ../tools/virt-resize.pl:528
34294 "Note that this option I<does not> affect the output format. See L</QCOW2 "
34295 "AND NON-SPARSE RAW FORMATS>."
34300 #: ../tools/virt-resize.pl:535
34301 msgid "B<--output-format> raw"
34306 #: ../tools/virt-resize.pl:537
34308 "Specify the format of the output disk image. If this flag is not given then "
34309 "it is auto-detected from the image itself."
34314 #: ../tools/virt-resize.pl:543
34316 "Note that you still need to create the output disk with the right format. "
34317 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
34322 #: ../tools/virt-resize.pl:1425
34328 #: ../tools/virt-resize.pl:1427
34329 msgid "\"Partition 1 does not end on cylinder boundary.\""
34334 #: ../tools/virt-resize.pl:1429
34336 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
34337 "means the partitions will not be aligned to the ancient CHS geometry. "
34338 "However CHS geometry is meaningless for disks manufactured since the early "
34339 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
34340 "cylinders is not required by any modern operating system."
34345 #: ../tools/virt-resize.pl:1436
34346 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
34351 #: ../tools/virt-resize.pl:1438
34353 "In Windows Vista and later versions, Microsoft switched to using a separate "
34354 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
34355 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
34356 "the boot partition. Doing so seems to break the guest completely. However "
34357 "expanding the second partition (ie. C: drive) should work."
34362 #: ../tools/virt-resize.pl:1445
34364 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
34365 "NTFS partitions have been expanded. This is just a safety check and (unless "
34366 "it find errors) is nothing to worry about."
34371 #: ../tools/virt-resize.pl:1449
34372 msgid "GUEST BOOT STUCK AT \"GRUB\""
34377 #: ../tools/virt-resize.pl:1451
34379 "If a Linux guest does not boot after resizing, and the boot is stuck after "
34380 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
34381 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
34382 "although we think is to do with partition alignment."
34387 #: ../tools/virt-resize.pl:1456
34390 " guestfish -i -a newdisk\n"
34391 " ><fs> cat /boot/grub/device.map\n"
34392 " # check the contents of this file are sensible or\n"
34393 " # edit the file if necessary\n"
34394 " ><fs> grub-install / /dev/vda\n"
34401 #: ../tools/virt-resize.pl:1463
34403 "For more flexible guest reconfiguration, including if you need to specify "
34404 "other parameters to grub-install, use L<virt-rescue(1)>."
34409 #: ../tools/virt-resize.pl:1466
34410 msgid "ALTERNATIVE TOOLS"
34415 #: ../tools/virt-resize.pl:1468
34417 "There are several proprietary tools for resizing partitions. We won't "
34418 "mention any here."
34423 #: ../tools/virt-resize.pl:1471
34425 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
34426 "operations on disk images. They can resize and move partitions, but I don't "
34427 "think they can do anything with the contents, and they certainly don't "
34433 #: ../tools/virt-resize.pl:1476
34435 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
34436 "but at a much lower level. You will probably end up hand-calculating sector "
34437 "offsets, which is something that virt-resize was designed to avoid. If you "
34438 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
34444 #: ../tools/virt-resize.pl:1491
34446 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
34447 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
34448 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
34449 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
34450 "libguestfs.org/>."
34455 #: ../tools/virt-list-filesystems.pl:32
34457 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34462 #: ../tools/virt-list-filesystems.pl:36
34465 " virt-list-filesystems [--options] domname\n"
34471 #: ../tools/virt-list-filesystems.pl:38
34474 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34480 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34482 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34488 #: ../tools/virt-list-filesystems.pl:45
34490 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34491 "are contained in a virtual machine or disk image."
34496 #: ../tools/virt-list-filesystems.pl:49
34498 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34499 "functionality. For more complex cases you should look at the L<guestfish(1)"
34505 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34506 msgid "B<-l> | B<--long>"
34511 #: ../tools/virt-list-filesystems.pl:108
34513 "With this option, C<virt-list-filesystems> displays the type of each "
34514 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34519 #: ../tools/virt-list-filesystems.pl:115
34520 msgid "B<-a> | B<--all>"
34525 #: ../tools/virt-list-filesystems.pl:117
34527 "Normally we only show mountable filesystems. If this option is given then "
34528 "swap devices are shown too."
34533 #: ../tools/virt-list-filesystems.pl:191
34535 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34536 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34537 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34542 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34543 msgid "Copyright (C) 2009 Red Hat Inc."
34548 #: ../tools/virt-tar.pl:33
34549 msgid "virt-tar - Extract or upload files to a virtual machine"
34554 #: ../tools/virt-tar.pl:37
34557 " virt-tar [--options] -x domname directory tarball\n"
34563 #: ../tools/virt-tar.pl:39
34566 " virt-tar [--options] -u domname tarball directory\n"
34572 #: ../tools/virt-tar.pl:41
34575 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34581 #: ../tools/virt-tar.pl:43
34584 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34589 #: ../tools/virt-tar.pl:47
34591 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34592 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34597 #: ../tools/virt-tar.pl:52
34598 msgid "Download C</home> from the VM into a local tarball:"
34603 #: ../tools/virt-tar.pl:54
34606 " virt-tar -x domname /home home.tar\n"
34612 #: ../tools/virt-tar.pl:56
34615 " virt-tar -zx domname /home home.tar.gz\n"
34621 #: ../tools/virt-tar.pl:58
34622 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34627 #: ../tools/virt-tar.pl:60
34630 " virt-tar -u domname uploadstuff.tar /tmp\n"
34636 #: ../tools/virt-tar.pl:62
34639 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34645 #: ../tools/virt-tar.pl:66
34647 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
34648 "virtual machines. If you do this, you risk disk corruption in the VM. "
34649 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34654 #: ../tools/virt-tar.pl:71
34656 "You can use C<-x> (extract) on live virtual machines, but you might get "
34657 "inconsistent results or errors if there is filesystem activity inside the "
34658 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34659 "work, but the only way to guarantee consistent results is if the virtual "
34660 "machine is shut down."
34665 #: ../tools/virt-tar.pl:79
34667 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34668 "parts of a guest filesystem. There are many possibilities: making backups, "
34669 "uploading data files, snooping on guest activity, fixing or customizing "
34675 #: ../tools/virt-tar.pl:84
34677 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34678 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34679 "should look at the L<guestfish(1)> tool."
34684 #: ../tools/virt-tar.pl:88
34686 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
34687 "its contents (recursively) from the virtual machine into a local tarball. "
34688 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
34689 "virtual machine. You cannot use these two options together."
34694 #: ../tools/virt-tar.pl:94
34696 "In addition, you may need to use the C<-z> (gZip) option to enable "
34697 "compression. When uploading, you have to specify C<-z> if the upload file "
34698 "is compressed because virt-tar won't detect this on its own."
34703 #: ../tools/virt-tar.pl:98
34705 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34706 "example it cannot do PKZip files or bzip2 compression. If you want that "
34707 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34708 "the L<libguestfs(3)> API)."
34713 #: ../tools/virt-tar.pl:156
34714 msgid "B<-x> | B<--extract> | B<--download>"
34719 #: ../tools/virt-tar.pl:158
34720 msgid "B<-u> | B<--upload>"
34725 #: ../tools/virt-tar.pl:160
34727 "Use C<-x> to extract (download) a directory from a virtual machine to a "
34733 #: ../tools/virt-tar.pl:163
34735 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
34736 "Please read the L</WARNING> section above before using this option."
34741 #: ../tools/virt-tar.pl:167
34742 msgid "You must specify exactly one of these options."
34747 #: ../tools/virt-tar.pl:173
34748 msgid "B<-z> | B<--gzip>"
34753 #: ../tools/virt-tar.pl:175
34754 msgid "Specify that the input or output tarball is gzip-compressed."
34758 #: ../tools/virt-tar.pl:288
34760 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34761 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34762 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34768 #: ../tools/virt-make-fs.pl:37
34769 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34774 #: ../tools/virt-make-fs.pl:41
34777 " virt-make-fs [--options] input.tar output.img\n"
34783 #: ../tools/virt-make-fs.pl:43
34786 " virt-make-fs [--options] input.tar.gz output.img\n"
34792 #: ../tools/virt-make-fs.pl:45
34795 " virt-make-fs [--options] directory output.img\n"
34801 #: ../tools/virt-make-fs.pl:49
34803 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34804 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34805 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34806 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34807 "you want to attach these filesystems to existing virtual machines (eg. to "
34808 "import large amounts of read-only data to a VM)."
34813 #: ../tools/virt-make-fs.pl:57
34814 msgid "Basic usage is:"
34819 #: ../tools/virt-make-fs.pl:59
34822 " virt-make-fs input output\n"
34828 #: ../tools/virt-make-fs.pl:61
34830 "where C<input> is either a directory containing files that you want to add, "
34831 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34832 "C<output> is a disk image. The input type is detected automatically. The "
34833 "output disk image defaults to a raw ext2 image unless you specify extra "
34834 "flags (see L</OPTIONS> below)."
34839 #: ../tools/virt-make-fs.pl:67
34840 msgid "EXTRA SPACE"
34845 #: ../tools/virt-make-fs.pl:69
34847 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34848 "the files that it contains, but might have extra space. Depending on how "
34849 "you are going to use the output, you might think this extra space is wasted "
34850 "and want to minimize it, or you might want to leave space so that more files "
34851 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34852 "but you can use the C<--size> flag to leave space in the filesystem if you "
34858 #: ../tools/virt-make-fs.pl:77
34860 "An alternative way to leave extra space but not make the output image any "
34861 "bigger is to use an alternative disk image format (instead of the default "
34862 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
34863 "image format (check your hypervisor supports this before using it). This "
34864 "allows you to choose a large C<--size> but the extra space won't actually be "
34865 "allocated in the image until you try to store something in it."
34869 #: ../tools/virt-make-fs.pl:85
34871 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34872 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34873 "to build another image from scratch."
34878 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34879 #: ../tools/virt-make-fs.pl:142
34885 #: ../tools/virt-make-fs.pl:91
34888 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34894 #: ../tools/virt-make-fs.pl:93
34895 msgid "FILESYSTEM TYPE"
34900 #: ../tools/virt-make-fs.pl:95
34902 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34903 "libguestfs supports can be used (but I<not> read-only formats like "
34904 "ISO9660). Here are some of the more common choices:"
34909 #: ../tools/virt-make-fs.pl:101
34915 #: ../tools/virt-make-fs.pl:103
34917 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34918 "you are not going to use the filesystem in a way that requires the journal, "
34919 "then this is just wasted overhead."
34924 #: ../tools/virt-make-fs.pl:107
34925 msgid "I<ntfs> or I<vfat>"
34930 #: ../tools/virt-make-fs.pl:109
34931 msgid "Useful if exporting data to a Windows guest."
34936 #: ../tools/virt-make-fs.pl:111
34938 "I<Note for vfat>: The tar archive or local directory must only contain files "
34939 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34940 "program running within libguestfs is unable to change the ownership of non-"
34941 "root files, since vfat itself does not support this."
34946 #: ../tools/virt-make-fs.pl:116
34952 #: ../tools/virt-make-fs.pl:118
34954 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34955 "total filesystem size."
34960 #: ../tools/virt-make-fs.pl:125
34963 " virt-make-fs --type=minix input minixfs.img\n"
34969 #: ../tools/virt-make-fs.pl:127
34970 msgid "TO PARTITION OR NOT TO PARTITION"
34975 #: ../tools/virt-make-fs.pl:129
34976 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34981 #: ../tools/virt-make-fs.pl:131
34983 "Adding a partition can make the disk image more compatible with certain "
34984 "virtualized operating systems which don't expect to see a filesystem "
34985 "directly located on a block device (Linux doesn't care and will happily "
34986 "handle both types)."
34991 #: ../tools/virt-make-fs.pl:136
34993 "On the other hand, if you have a partition table then the output image is no "
34994 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34995 "directly on a partitioned disk image. (However libguestfs tools such as "
34996 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
35001 #: ../tools/virt-make-fs.pl:144
35002 msgid "Add an MBR partition:"
35007 #: ../tools/virt-make-fs.pl:146
35010 " virt-make-fs --partition -- input disk.img\n"
35016 #: ../tools/virt-make-fs.pl:148
35018 "If the output disk image could be terabyte-sized or larger, it's better to "
35019 "use an EFI/GPT-compatible partition table:"
35024 #: ../tools/virt-make-fs.pl:151
35027 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
35033 #: ../tools/virt-make-fs.pl:179
35034 msgid "Enable debugging information."
35039 #: ../tools/virt-make-fs.pl:185
35040 msgid "B<--size=E<lt>NE<gt>>"
35045 #: ../tools/virt-make-fs.pl:187
35046 msgid "B<--size=+E<lt>NE<gt>>"
35051 #: ../tools/virt-make-fs.pl:189
35052 msgid "B<-s E<lt>NE<gt>>"
35057 #: ../tools/virt-make-fs.pl:191
35058 msgid "B<-s +E<lt>NE<gt>>"
35063 #: ../tools/virt-make-fs.pl:193
35065 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
35070 #: ../tools/virt-make-fs.pl:196
35072 "If this option is I<not> given, then the output image will be just large "
35073 "enough to contain all the files, with not much wasted space."
35078 #: ../tools/virt-make-fs.pl:199
35080 "To choose a fixed size output disk, specify an absolute number followed by b/"
35081 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35082 "Petabytes or Exabytes. This must be large enough to contain all the input "
35083 "files, else you will get an error."
35088 #: ../tools/virt-make-fs.pl:204
35090 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
35091 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35092 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
35093 "the input files, and (approximately) an extra 200 MB free space."
35098 #: ../tools/virt-make-fs.pl:210
35100 "Note that virt-make-fs estimates free space, and therefore will not produce "
35101 "filesystems containing precisely the free space requested. (It is much more "
35102 "expensive and time-consuming to produce a filesystem which has precisely the "
35103 "desired free space)."
35108 #: ../tools/virt-make-fs.pl:219
35109 msgid "B<--format=E<lt>fmtE<gt>>"
35114 #: ../tools/virt-make-fs.pl:221
35115 msgid "B<-F E<lt>fmtE<gt>>"
35120 #: ../tools/virt-make-fs.pl:223
35121 msgid "Choose the output disk image format."
35126 #: ../tools/virt-make-fs.pl:225
35127 msgid "The default is C<raw> (raw disk image)."
35132 #: ../tools/virt-make-fs.pl:227
35134 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
35135 "that would really make sense here is C<qcow2>."
35140 #: ../tools/virt-make-fs.pl:234
35141 msgid "B<--type=E<lt>fsE<gt>>"
35146 #: ../tools/virt-make-fs.pl:236
35147 msgid "B<-t E<lt>fsE<gt>>"
35152 #: ../tools/virt-make-fs.pl:238
35153 msgid "Choose the output filesystem type."
35158 #: ../tools/virt-make-fs.pl:240
35159 msgid "The default is C<ext2>."
35164 #: ../tools/virt-make-fs.pl:242
35166 "Any filesystem which is supported read-write by libguestfs can be used here."
35171 #: ../tools/virt-make-fs.pl:249
35172 msgid "B<--partition>"
35177 #: ../tools/virt-make-fs.pl:251
35178 msgid "B<--partition=E<lt>parttypeE<gt>>"
35183 #: ../tools/virt-make-fs.pl:253
35185 "If specified, this flag adds an MBR partition table to the output disk image."
35190 #: ../tools/virt-make-fs.pl:256
35192 "You can change the partition table type, eg. C<--partition=gpt> for large "
35198 #: ../tools/virt-make-fs.pl:259
35200 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
35201 "might consider the next parameter to be the partition type. For example:"
35206 #: ../tools/virt-make-fs.pl:263
35209 " virt-make-fs --partition input.tar ...\n"
35215 #: ../tools/virt-make-fs.pl:265
35217 "would cause virt-make-fs to think you wanted to use a partition type of "
35218 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
35219 "dash) between options and the input file argument:"
35224 #: ../tools/virt-make-fs.pl:269
35227 " virt-make-fs --partition -- input.tar ...\n"
35232 #: ../tools/virt-make-fs.pl:541
35234 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
35235 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
35236 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
35241 #: ../tools/virt-make-fs.pl:558
35244 " export LIBGUESTFS_DEBUG=1\n"
35245 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
35251 #: ../tools/virt-make-fs.pl:561
35253 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
35259 #: ../tools/virt-list-partitions.pl:32
35261 "virt-list-partitions - List partitions in a virtual machine or disk image"
35266 #: ../tools/virt-list-partitions.pl:36
35269 " virt-list-partitions [--options] domname\n"
35275 #: ../tools/virt-list-partitions.pl:38
35278 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35284 #: ../tools/virt-list-partitions.pl:45
35286 "C<virt-list-partitions> is a command line tool to list the partitions that "
35287 "are contained in a virtual machine or disk image. It is mainly useful as a "
35288 "first step to using L<virt-resize(1)>."
35293 #: ../tools/virt-list-partitions.pl:50
35295 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35296 "functionality. For more complex cases you should look at the L<guestfish(1)"
35302 #: ../tools/virt-list-partitions.pl:107
35303 msgid "B<-h> | B<--human-readable>"
35308 #: ../tools/virt-list-partitions.pl:109
35309 msgid "Show sizes in human-readable form (eg. \"1G\")."
35314 #: ../tools/virt-list-partitions.pl:117
35316 "With this option, C<virt-list-partitions> displays the type and size of each "
35317 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35322 #: ../tools/virt-list-partitions.pl:124
35323 msgid "B<-t> | B<--total>"
35328 #: ../tools/virt-list-partitions.pl:126
35330 "Display the total size of each block device (as a separate row or rows)."
35335 #: ../tools/virt-list-partitions.pl:259
35337 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
35338 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
35339 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."