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-15 21:45+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"
255 #: ../src/guestfs.pod:98
258 " /* Now you can perform filesystem actions on the guest\n"
261 " guestfs_touch (g, \"/hello\");\n"
267 #: ../src/guestfs.pod:103
270 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
271 " * it is done automatically when you close the handle. See\n"
272 " * discussion of autosync in this page.\n"
274 " guestfs_sync (g);\n"
280 #: ../src/guestfs.pod:109
283 " /* Close the handle 'g'. */\n"
284 " guestfs_close (g);\n"
290 #: ../src/guestfs.pod:112
292 "The code above doesn't include any error checking. In real code you should "
293 "check return values carefully for errors. In general all functions that "
294 "return integers return C<-1> on error, and all functions that return "
295 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
296 "how to handle errors, and consult the documentation for each function call "
297 "below to see precisely how they return error indications. See L<guestfs-"
298 "examples(3)> for fully worked examples."
303 #: ../src/guestfs.pod:121
309 #: ../src/guestfs.pod:123
311 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
312 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
313 "actual block device, or simply an empty file of zeroes that you have created "
314 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
320 #: ../src/guestfs.pod:129
322 "The call you should use in modern code for adding drives is L</"
323 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
324 "specifying that the format is raw, do:"
329 #: ../src/guestfs.pod:133
332 " guestfs_add_drive_opts (g, filename,\n"
333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
340 #: ../src/guestfs.pod:137
341 msgid "You can add a disk read-only using:"
346 #: ../src/guestfs.pod:139
349 " guestfs_add_drive_opts (g, filename,\n"
350 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
351 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
358 #: ../src/guestfs.pod:144
360 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
361 "libguestfs won't modify the file."
366 #: ../src/guestfs.pod:147
368 "Be extremely cautious if the disk image is in use, eg. if it is being used "
369 "by a virtual machine. Adding it read-write will almost certainly cause disk "
370 "corruption, but adding it read-only is safe."
375 #: ../src/guestfs.pod:151
377 "You must add at least one disk image, and you may add multiple disk images. "
378 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
379 "first one you added), C</dev/sdb> (for the second one you added), etc."
384 #: ../src/guestfs.pod:156
386 "Once L</guestfs_launch> has been called you cannot add any more images. You "
387 "can call L</guestfs_list_devices> to get a list of the device names, in the "
388 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
393 #: ../src/guestfs.pod:161
398 #: ../src/guestfs.pod:163
400 "Before you can read or write files, create directories and so on in a disk "
401 "image that contains filesystems, you have to mount those filesystems using "
402 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
403 "a disk image contains (for example) one partition with a filesystem on that "
404 "partition, then you can mount it directly:"
408 #: ../src/guestfs.pod:170
411 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
416 #: ../src/guestfs.pod:172
418 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
419 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
420 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
421 "that these are libguestfs virtual devices, and are nothing to do with host "
426 #: ../src/guestfs.pod:178
428 "If you are given a disk image and you don't know what it contains then you "
429 "have to find out. Libguestfs can do that too: use L</"
430 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
431 "LVs, and either try mounting each to see what is mountable, or else examine "
432 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
433 "filesystems, use L</guestfs_list_filesystems>."
437 #: ../src/guestfs.pod:186
439 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
440 "L</INSPECTION> below). But you might find it easier to look at higher level "
441 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
445 #: ../src/guestfs.pod:191
447 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
448 "several other variations of the C<guestfs_mount_*> call."
453 #: ../src/guestfs.pod:194
454 msgid "FILESYSTEM ACCESS AND MODIFICATION"
459 #: ../src/guestfs.pod:196
461 "The majority of the libguestfs API consists of fairly low-level calls for "
462 "accessing and modifying the files, directories, symlinks etc on mounted "
463 "filesystems. There are over a hundred such calls which you can find listed "
464 "in detail below in this man page, and we don't even pretend to cover them "
465 "all in this overview."
470 #: ../src/guestfs.pod:202
472 "Specify filenames as full paths, starting with C<\"/\"> and including the "
478 #: ../src/guestfs.pod:205
480 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
481 "the file called C<\"etc/passwd\"> then you could do:"
486 #: ../src/guestfs.pod:208
489 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
495 #: ../src/guestfs.pod:210
497 "This would return C<data> as a newly allocated buffer containing the full "
498 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
499 "or C<NULL> if there was an error."
504 #: ../src/guestfs.pod:214
506 "As another example, to create a top-level directory on that filesystem "
507 "called C<\"var\"> you would do:"
512 #: ../src/guestfs.pod:217
515 " guestfs_mkdir (g, \"/var\");\n"
521 #: ../src/guestfs.pod:219
522 msgid "To create a symlink you could do:"
527 #: ../src/guestfs.pod:221
530 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
531 " \"/etc/rc3.d/S30portmap\");\n"
537 #: ../src/guestfs.pod:224
539 "Libguestfs will reject attempts to use relative paths and there is no "
540 "concept of a current working directory."
545 #: ../src/guestfs.pod:227
547 "Libguestfs can return errors in many situations: for example if the "
548 "filesystem isn't writable, or if a file or directory that you requested "
549 "doesn't exist. If you are using the C API (documented here) you have to "
550 "check for those error conditions after each call. (Other language bindings "
551 "turn these errors into exceptions)."
556 #: ../src/guestfs.pod:233
558 "File writes are affected by the per-handle umask, set by calling L</"
559 "guestfs_umask> and defaulting to 022. See L</UMASK>."
564 #: ../src/guestfs.pod:236
570 #: ../src/guestfs.pod:238
572 "Libguestfs contains API calls to read, create and modify partition tables on "
578 #: ../src/guestfs.pod:241
580 "In the common case where you want to create a single partition covering the "
581 "whole disk, you should use the L</guestfs_part_disk> call:"
586 #: ../src/guestfs.pod:245
589 " const char *parttype = \"mbr\";\n"
590 " if (disk_is_larger_than_2TB)\n"
591 " parttype = \"gpt\";\n"
592 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
598 #: ../src/guestfs.pod:250
600 "Obviously this effectively wipes anything that was on that disk image before."
605 #: ../src/guestfs.pod:253
611 #: ../src/guestfs.pod:255
613 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
614 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
615 "you familiarize yourself with the concepts of physical volumes, volume "
616 "groups and logical volumes."
621 #: ../src/guestfs.pod:260
623 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
624 "tldp.org/HOWTO/LVM-HOWTO/>."
629 #: ../src/guestfs.pod:263
634 #: ../src/guestfs.pod:265
636 "Use L</guestfs_cat> to download small, text only files. This call is "
637 "limited to files which are less than 2 MB and which cannot contain any ASCII "
638 "NUL (C<\\0>) characters. However the API is very simple to use."
643 #: ../src/guestfs.pod:269
645 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
646 "bit data, since it returns a (pointer, size) pair. However it is still "
647 "limited to \"small\" files, less than 2 MB."
652 #: ../src/guestfs.pod:273
654 "L</guestfs_download> can be used to download any file, with no limits on "
655 "content or size (even files larger than 4 GB)."
660 #: ../src/guestfs.pod:276
662 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
667 #: ../src/guestfs.pod:279
673 #: ../src/guestfs.pod:281
675 "It's often the case that you want to write a file or files to the disk image."
680 #: ../src/guestfs.pod:284
682 "To write a small file with fixed content, use L</guestfs_write>. To create "
683 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
684 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
685 "of other functions for creating test files, for example L</guestfs_fill> and "
686 "L</guestfs_fill_pattern>."
691 #: ../src/guestfs.pod:290
693 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
694 "file content or size (even files larger than 4 GB)."
699 #: ../src/guestfs.pod:293
701 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
706 #: ../src/guestfs.pod:295
708 "However the fastest way to upload I<large numbers of arbitrary files> is to "
709 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
710 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
711 "in a predictable way (eg. adding it last after all other drives) then you "
712 "can get the device name from L</guestfs_list_devices> and mount it directly "
713 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
714 "portable between kernel versions, and they don't support labels or UUIDs. "
715 "If you want to pre-build an image or you need to mount it using a label or "
716 "UUID, use an ISO image instead."
721 #: ../src/guestfs.pod:306
727 #: ../src/guestfs.pod:308
729 "There are various different commands for copying between files and devices "
730 "and in and out of the guest filesystem. These are summarised in the table "
736 #: ../src/guestfs.pod:314
737 msgid "B<file> to B<file>"
742 #: ../src/guestfs.pod:316
744 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
745 "directories recursively."
750 #: ../src/guestfs.pod:319
751 msgid "B<file or device> to B<file or device>"
756 #: ../src/guestfs.pod:321
758 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
759 "devices in the guest."
764 #: ../src/guestfs.pod:324
765 msgid "Example: duplicate the contents of an LV:"
770 #: ../src/guestfs.pod:326
773 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
779 #: ../src/guestfs.pod:328
781 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
782 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
783 "guestfs_copy_size>."
788 #: ../src/guestfs.pod:332
789 msgid "B<file on the host> to B<file or device>"
794 #: ../src/guestfs.pod:334
795 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
800 #: ../src/guestfs.pod:336
801 msgid "B<file or device> to B<file on the host>"
806 #: ../src/guestfs.pod:338
807 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
812 #: ../src/guestfs.pod:342
813 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
818 #: ../src/guestfs.pod:344
820 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
821 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
822 "appears you can only upload and download to files. However many Un*x-like "
823 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
824 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
825 "and arbitrary file descriptor N."
830 #: ../src/guestfs.pod:352
831 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
835 #: ../src/guestfs.pod:355
838 " guestfs_download (g, filename, \"/dev/stdout\");\n"
844 #: ../src/guestfs.pod:357
845 msgid "and you can write tar output to a pipe C<fd> by doing:"
849 #: ../src/guestfs.pod:359
853 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
854 " guestfs_tar_out (g, \"/\", devfd);\n"
860 #: ../src/guestfs.pod:363
861 msgid "LISTING FILES"
866 #: ../src/guestfs.pod:365
868 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
869 "L<guestfish(1)>-equivalent command C<ll>)."
874 #: ../src/guestfs.pod:368
876 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
877 "programs, as a flat list of strings."
882 #: ../src/guestfs.pod:371
884 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
885 "directory, plus additional information about each one. It is more "
886 "equivalent to using the L<readdir(3)> call on a local filesystem."
891 #: ../src/guestfs.pod:375
893 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
898 #: ../src/guestfs.pod:378
899 msgid "RUNNING COMMANDS"
904 #: ../src/guestfs.pod:380
906 "Although libguestfs is primarily an API for manipulating files inside guest "
907 "images, we also provide some limited facilities for running commands inside "
913 #: ../src/guestfs.pod:384
914 msgid "There are many limitations to this:"
919 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
920 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
921 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1088
922 #: ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101
923 #: ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136
924 #: ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166
925 #: ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178
926 #: ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669
927 #: ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779
928 #: ../src/guestfs.pod:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019
929 #: ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387
930 #: ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2863
931 #: ../src/guestfs.pod:2867 ../src/guestfs.pod:2871 ../src/guestfs.pod:2875
932 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
933 #: ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585
934 #: ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599
935 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
936 #: ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607
937 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1619
938 #: ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1633
939 #: ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1641
940 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1783
941 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
942 #: ../src/guestfs-actions.pod:1854 ../src/guestfs-actions.pod:1858
943 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish.pod:432
944 #: ../fish/guestfish.pod:436 ../fish/guestfish.pod:440
945 #: ../fish/guestfish.pod:444 ../fish/guestfish-actions.pod:13
946 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380
947 #: ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395
948 #: ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072
949 #: ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080
950 #: ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092
951 #: ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100
952 #: ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114
953 #: ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208
954 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217
955 #: ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264
956 #: ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273
957 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
958 #: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345
959 #: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
965 #: ../src/guestfs.pod:390
967 "The kernel version that the command runs under will be different from what "
973 #: ../src/guestfs.pod:395
975 "If the command needs to communicate with daemons, then most likely they "
981 #: ../src/guestfs.pod:400
982 msgid "The command will be running in limited memory."
987 #: ../src/guestfs.pod:404
989 "The network may not be available unless you enable it (see L</"
990 "guestfs_set_network>)."
995 #: ../src/guestfs.pod:409
996 msgid "Only supports Linux guests (not Windows, BSD, etc)."
1001 #: ../src/guestfs.pod:413
1003 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1008 #: ../src/guestfs.pod:418
1010 "For SELinux guests, you may need to enable SELinux and load policy first. "
1011 "See L</SELINUX> in this manpage."
1016 #: ../src/guestfs.pod:423
1018 "I<Security:> It is not safe to run commands from untrusted, possibly "
1019 "malicious guests. These commands may attempt to exploit your program by "
1020 "sending unexpected output. They could also try to exploit the Linux kernel "
1021 "or qemu provided by the libguestfs appliance. They could use the network "
1022 "provided by the libguestfs appliance to bypass ordinary network partitions "
1023 "and firewalls. They could use the elevated privileges or different SELinux "
1024 "context of your program to their advantage."
1029 #: ../src/guestfs.pod:432
1031 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1032 "(a script which runs when the guest next boots normally), and to have this "
1033 "script run the commands you want in the normal context of the running guest, "
1034 "network security and so on. For information about other security issues, "
1040 #: ../src/guestfs.pod:440
1042 "The two main API calls to run commands are L</guestfs_command> and L</"
1043 "guestfs_sh> (there are also variations)."
1048 #: ../src/guestfs.pod:443
1050 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1051 "shell globs, redirections, etc will work."
1056 #: ../src/guestfs.pod:446
1057 msgid "CONFIGURATION FILES"
1062 #: ../src/guestfs.pod:448
1064 "To read and write configuration files in Linux guest filesystems, we "
1065 "strongly recommend using Augeas. For example, Augeas understands how to "
1066 "read and write, say, a Linux shadow password file or X.org configuration "
1067 "file, and so avoids you having to write that code."
1072 #: ../src/guestfs.pod:453
1074 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1075 "document Augeas itself here because there is excellent documentation on the "
1076 "L<http://augeas.net/> website."
1081 #: ../src/guestfs.pod:457
1083 "If you don't want to use Augeas (you fool!) then try calling L</"
1084 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1090 #: ../src/guestfs.pod:461
1096 #: ../src/guestfs.pod:463
1098 "We support SELinux guests. To ensure that labeling happens correctly in "
1099 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1104 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1105 #: ../src/guestfs.pod:2426
1111 #: ../src/guestfs.pod:471
1112 msgid "Before launching, do:"
1117 #: ../src/guestfs.pod:473
1120 " guestfs_set_selinux (g, 1);\n"
1126 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1127 #: ../src/guestfs.pod:2451
1133 #: ../src/guestfs.pod:477
1135 "After mounting the guest's filesystem(s), load the policy. This is best "
1136 "done by running the L<load_policy(8)> command in the guest itself:"
1141 #: ../src/guestfs.pod:481
1144 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1150 #: ../src/guestfs.pod:483
1152 "(Older versions of C<load_policy> require you to specify the name of the "
1158 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1164 #: ../src/guestfs.pod:488
1166 "Optionally, set the security context for the API. The correct security "
1167 "context to use can only be known by inspecting the guest. As an example:"
1172 #: ../src/guestfs.pod:492
1175 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1181 #: ../src/guestfs.pod:496
1182 msgid "This will work for running commands and editing existing files."
1187 #: ../src/guestfs.pod:498
1189 "When new files are created, you may need to label them explicitly, for "
1190 "example by running the external command C<restorecon pathname>."
1195 #: ../src/guestfs.pod:502
1201 #: ../src/guestfs.pod:504
1203 "Certain calls are affected by the current file mode creation mask (the "
1204 "\"umask\"). In particular ones which create files or directories, such as "
1205 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1206 "either the default mode that the file is created with or modifies the mode "
1212 #: ../src/guestfs.pod:510
1214 "The default umask is C<022>, so files are created with modes such as C<0644> "
1215 "and directories with C<0755>."
1220 #: ../src/guestfs.pod:513
1222 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1223 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1224 "guestfs_chmod> after creating each file or directory."
1229 #: ../src/guestfs.pod:517
1230 msgid "For more information about umask, see L<umask(2)>."
1235 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:751
1236 msgid "ENCRYPTED DISKS"
1241 #: ../src/guestfs.pod:521
1243 "Libguestfs allows you to access Linux guests which have been encrypted using "
1244 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1245 "standard. This includes nearly all whole disk encryption systems used by "
1246 "modern Linux guests."
1251 #: ../src/guestfs.pod:527
1253 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1254 "returns the string C<crypto_LUKS>)."
1259 #: ../src/guestfs.pod:530
1261 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1262 "will require the passphrase!"
1267 #: ../src/guestfs.pod:533
1269 "Opening a LUKS device creates a new device mapper device called C</dev/"
1270 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1271 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1272 "from and encrypted to the underlying block device respectively."
1277 #: ../src/guestfs.pod:539
1279 "LVM volume groups on the device can be made visible by calling L</"
1280 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1281 "(s) can now be mounted in the usual way."
1286 #: ../src/guestfs.pod:543
1288 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1289 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1290 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1291 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1292 "underlying encrypted block device)."
1297 #: ../src/guestfs.pod:550
1302 #: ../src/guestfs.pod:552
1304 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1305 "contains operating systems, an install CD or a live CD. (These APIs used to "
1306 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1307 "version 1.5.3 the most frequently used part of this library has been "
1308 "rewritten in C and moved into the core code)."
1313 #: ../src/guestfs.pod:559
1315 "Add all disks belonging to the unknown virtual machine and call L</"
1316 "guestfs_launch> in the usual way."
1321 #: ../src/guestfs.pod:562
1323 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1324 "and certain heuristics, and returns a list of operating systems that were "
1325 "found. An empty list means none were found. A single element is the root "
1326 "filesystem of the operating system. For dual- or multi-boot guests, "
1327 "multiple roots can be returned, each one corresponding to a separate "
1328 "operating system. (Multi-boot virtual machines are extremely rare in the "
1329 "world of virtualization, but since this scenario can happen, we have built "
1330 "libguestfs to deal with it.)"
1335 #: ../src/guestfs.pod:571
1337 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1338 "to get additional details about that operating system. For example, call L</"
1339 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1340 "Windows and Linux-based operating systems respectively."
1345 #: ../src/guestfs.pod:577
1347 "Un*x-like and Linux-based operating systems usually consist of several "
1348 "filesystems which are mounted at boot time (for example, a separate boot "
1349 "partition mounted on C</boot>). The inspection rules are able to detect how "
1350 "filesystems correspond to mount points. Call "
1351 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1352 "hash table like this example:"
1357 #: ../src/guestfs.pod:584
1360 " /boot => /dev/sda1\n"
1361 " / => /dev/vg_guest/lv_root\n"
1362 " /usr => /dev/vg_guest/lv_usr\n"
1368 #: ../src/guestfs.pod:588
1370 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1371 "filesystems as suggested."
1376 #: ../src/guestfs.pod:591
1378 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1379 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1384 #: ../src/guestfs.pod:595
1386 "Inspection currently only works for some common operating systems. "
1387 "Contributors are welcome to send patches for other operating systems that we "
1388 "currently cannot detect."
1393 #: ../src/guestfs.pod:599
1395 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1396 "for more details. The L</guestfs_inspect_os> function just ignores any "
1397 "encrypted devices."
1402 #: ../src/guestfs.pod:603
1404 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1405 "inspection and caches the results in the guest handle. Subsequent calls to "
1406 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1407 "read the disks. If you change the content of the guest disks, you can redo "
1408 "inspection by calling L</guestfs_inspect_os> again. (L</"
1409 "guestfs_inspect_list_applications> works a little differently from the other "
1410 "calls and does read the disks. See documentation for that function for "
1415 #: ../src/guestfs.pod:612
1416 msgid "INSPECTING INSTALL DISKS"
1420 #: ../src/guestfs.pod:614
1422 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1427 #: ../src/guestfs.pod:617
1429 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1430 "system, which currently can be C<installed> (a regular operating system) or "
1431 "C<installer> (some sort of install disk)."
1435 #: ../src/guestfs.pod:621
1437 "Further information is available about the operating system that can be "
1438 "installed using the regular inspection APIs like L</"
1439 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1443 #: ../src/guestfs.pod:626
1445 "Some additional information specific to installer disks is also available "
1446 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1447 "guestfs_inspect_is_multipart> calls."
1452 #: ../src/guestfs.pod:631
1453 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1458 #: ../src/guestfs.pod:633
1460 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1461 "ntfs-3g.org/> driver."
1466 #: ../src/guestfs.pod:636
1467 msgid "DRIVE LETTERS AND PATHS"
1472 #: ../src/guestfs.pod:638
1474 "DOS and Windows still use drive letters, and the filesystems are always "
1475 "treated as case insensitive by Windows itself, and therefore you might find "
1476 "a Windows configuration file referring to a path like C<c:\\windows"
1477 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1478 "might be referred to as C</WINDOWS/System32>."
1483 #: ../src/guestfs.pod:644
1485 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1486 "libguestfs to read the appropriate Windows Registry and configuration files, "
1487 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1493 #: ../src/guestfs.pod:649
1495 "Replacing backslash characters with forward slash characters is also outside "
1496 "the scope of libguestfs, but something that you can easily do."
1501 #: ../src/guestfs.pod:652
1503 "Where we can help is in resolving the case insensitivity of paths. For "
1504 "this, call L</guestfs_case_sensitive_path>."
1509 #: ../src/guestfs.pod:655
1510 msgid "ACCESSING THE WINDOWS REGISTRY"
1515 #: ../src/guestfs.pod:657
1517 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1518 "files, through the library C<hivex> which is part of the libguestfs project "
1519 "although ships as a separate tarball. You have to locate and download the "
1520 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1521 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1522 "reg(1)> for more help on this issue."
1527 #: ../src/guestfs.pod:665
1528 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1533 #: ../src/guestfs.pod:667
1535 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1536 "provide something which looks like a Linux symlink. The way it tries to do "
1537 "the rewriting is described here:"
1542 #: ../src/guestfs.pod:671
1544 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1550 #: ../src/guestfs.pod:673
1552 "The essential problem is that ntfs-3g simply does not have enough "
1553 "information to do a correct job. NTFS links can contain drive letters and "
1554 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1555 "It is almost certainly the case that libguestfs callers should ignore what "
1556 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1561 #: ../src/guestfs.pod:680
1563 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1564 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1565 "attribute, and read the raw reparse data from that (you can find the format "
1566 "documented in various places around the web)."
1571 #: ../src/guestfs.pod:685
1572 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1577 #: ../src/guestfs.pod:687
1579 "There are other useful extended attributes that can be read from ntfs-3g "
1580 "filesystems (using L</guestfs_getxattr>). See:"
1585 #: ../src/guestfs.pod:690
1587 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1592 #: ../src/guestfs.pod:692
1593 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1598 #: ../src/guestfs.pod:694
1600 "Although we don't want to discourage you from using the C API, we will "
1601 "mention here that the same API is also available in other languages."
1605 #: ../src/guestfs.pod:697
1607 "The API is broadly identical in all supported languages. This means that "
1608 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1609 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1610 "OCaml. In other words, a straightforward, predictable isomorphism between "
1616 #: ../src/guestfs.pod:703
1618 "Error messages are automatically transformed into exceptions if the language "
1624 #: ../src/guestfs.pod:706
1626 "We don't try to \"object orientify\" parts of the API in OO languages, "
1627 "although contributors are welcome to write higher level APIs above what we "
1628 "provide in their favourite languages if they wish."
1633 #: ../src/guestfs.pod:712
1639 #: ../src/guestfs.pod:714
1641 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1642 "identical to the C API. C++ classes and exceptions are not used."
1647 #: ../src/guestfs.pod:718
1653 #: ../src/guestfs.pod:720
1655 "The C# bindings are highly experimental. Please read the warnings at the "
1656 "top of C<csharp/Libguestfs.cs>."
1661 #: ../src/guestfs.pod:723
1667 #: ../src/guestfs.pod:725
1669 "This is the only language binding that is working but incomplete. Only "
1670 "calls which return simple integers have been bound in Haskell, and we are "
1671 "looking for help to complete this binding."
1676 #: ../src/guestfs.pod:729
1682 #: ../src/guestfs.pod:731
1684 "Full documentation is contained in the Javadoc which is distributed with "
1690 #: ../src/guestfs.pod:734
1695 #: ../src/guestfs.pod:736
1696 msgid "See L<guestfs-ocaml(3)>."
1701 #: ../src/guestfs.pod:738
1706 #: ../src/guestfs.pod:740
1707 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1712 #: ../src/guestfs.pod:742
1718 #: ../src/guestfs.pod:744
1720 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1721 "the php-libguestfs package for your distribution."
1726 #: ../src/guestfs.pod:747
1727 msgid "The PHP binding only works correctly on 64 bit machines."
1732 #: ../src/guestfs.pod:749
1737 #: ../src/guestfs.pod:751
1738 msgid "See L<guestfs-python(3)>."
1743 #: ../src/guestfs.pod:753
1748 #: ../src/guestfs.pod:755
1749 msgid "See L<guestfs-ruby(3)>."
1754 #: ../src/guestfs.pod:757
1755 msgid "B<shell scripts>"
1759 #: ../src/guestfs.pod:759
1760 msgid "See L<guestfish(1)>."
1765 #: ../src/guestfs.pod:763
1766 msgid "LIBGUESTFS GOTCHAS"
1771 #: ../src/guestfs.pod:765
1773 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1774 "system [...] that works in the way it is documented but is counterintuitive "
1775 "and almost invites mistakes.\""
1780 #: ../src/guestfs.pod:769
1782 "Since we developed libguestfs and the associated tools, there are several "
1783 "things we would have designed differently, but are now stuck with for "
1784 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1785 "release, you can expect these to change. Beware of them."
1790 #: ../src/guestfs.pod:777
1791 msgid "Autosync / forgetting to sync."
1796 #: ../src/guestfs.pod:779
1798 "When modifying a filesystem from C or another language, you B<must> unmount "
1799 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1800 "libguestfs handle. You can also call:"
1805 #: ../src/guestfs.pod:783
1808 " guestfs_set_autosync (g, 1);\n"
1814 #: ../src/guestfs.pod:785
1816 "to have the unmount/sync done automatically for you when the handle 'g' is "
1817 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1822 #: ../src/guestfs.pod:789
1824 "If you forget to do this, then it is entirely possible that your changes "
1825 "won't be written out, or will be partially written, or (very rarely) that "
1826 "you'll get disk corruption."
1831 #: ../src/guestfs.pod:793
1833 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1834 "guestfish scripts that forget to sync will work just fine, which can make "
1835 "this very puzzling if you are trying to debug a problem."
1840 #: ../src/guestfs.pod:797
1842 "Update: Autosync is enabled by default for all API users starting from "
1843 "libguestfs 1.5.24."
1848 #: ../src/guestfs.pod:800
1849 msgid "Mount option C<-o sync> should not be the default."
1854 #: ../src/guestfs.pod:802
1856 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1857 "However C<-o sync> does not add any reliability benefit, but does have a "
1858 "very large performance impact."
1863 #: ../src/guestfs.pod:806
1865 "The work around is to use L</guestfs_mount_options> and set the mount "
1866 "options that you actually want to use."
1871 #: ../src/guestfs.pod:809
1872 msgid "Read-only should be the default."
1877 #: ../src/guestfs.pod:811
1879 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1880 "specify I<--rw> if you want to make changes to the image."
1885 #: ../src/guestfs.pod:814
1886 msgid "This would reduce the potential to corrupt live VM images."
1891 #: ../src/guestfs.pod:816
1893 "Note that many filesystems change the disk when you just mount and unmount, "
1894 "even if you didn't perform any writes. You need to use L</"
1895 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1900 #: ../src/guestfs.pod:820
1901 msgid "guestfish command line is hard to use."
1906 #: ../src/guestfs.pod:822
1908 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1909 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1910 "exist, so it fails. In earlier versions of guestfish the error message was "
1911 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1912 "we should have used C<guestfish -c command> to run commands."
1917 #: ../src/guestfs.pod:829
1918 msgid "guestfish megabyte modifiers don't work right on all commands"
1923 #: ../src/guestfs.pod:831
1925 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1926 "other modifiers). What guestfish actually does is to multiply the number "
1927 "part by the modifier part and pass the result to the C API. However this "
1928 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1929 "expecting some other unit (eg. megabytes)."
1934 #: ../src/guestfs.pod:838
1935 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1940 #: ../src/guestfs.pod:840
1943 " lvcreate LV VG 100M\n"
1949 #: ../src/guestfs.pod:842
1951 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1952 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1953 "megabytes * megabytes) logical volume. The error message you get from this "
1954 "is also a little obscure."
1959 #: ../src/guestfs.pod:847
1961 "This could be fixed in the generator by specially marking parameters and "
1962 "return values which take bytes or other units."
1967 #: ../src/guestfs.pod:850
1968 msgid "Ambiguity between devices and paths"
1973 #: ../src/guestfs.pod:852
1975 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1976 "sdb2>) and a similar pathname. A file might just happen to be called "
1977 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1982 #: ../src/guestfs.pod:857
1984 "In the current API we usually resolve this ambiguity by having two separate "
1985 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1986 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1987 "detecting if the path supplied begins with C</dev/>."
1992 #: ../src/guestfs.pod:863
1994 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1995 "make paths/devices into structured names. One way to do this would be to "
1996 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1997 "aspect of grub. Another way would be to use a structured type, equivalent "
1998 "to this OCaml type:"
2003 #: ../src/guestfs.pod:869
2006 " type path = Path of string | Device of int | Partition of int * int\n"
2012 #: ../src/guestfs.pod:871
2013 msgid "which would allow you to pass arguments like:"
2018 #: ../src/guestfs.pod:873
2021 " Path \"/foo/bar\"\n"
2022 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2023 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2024 " Path \"/dev/sdb2\" (* not a device *)\n"
2030 #: ../src/guestfs.pod:878
2032 "As you can see there are still problems to resolve even with this "
2033 "representation. Also consider how it might work in guestfish."
2038 #: ../src/guestfs.pod:883
2039 msgid "PROTOCOL LIMITS"
2044 #: ../src/guestfs.pod:885
2046 "Internally libguestfs uses a message-based protocol to pass API calls and "
2047 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2048 "plenty more detail about this). The maximum message size used by the "
2049 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2050 "aware of this limit. The API calls which may be affected are individually "
2051 "documented, with a link back to this section of the documentation."
2056 #: ../src/guestfs.pod:893
2058 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2059 "a simple string. Because this string is at some point internally encoded as "
2060 "a message, the maximum size that it can return is slightly under 4 MB. If "
2061 "the requested file is larger than this then you will get an error."
2066 #: ../src/guestfs.pod:899
2068 "In order to transfer large files into and out of the guest filesystem, you "
2069 "need to use particular calls that support this. The sections L</UPLOADING> "
2070 "and L</DOWNLOADING> document how to do this."
2075 #: ../src/guestfs.pod:903
2077 "You might also consider mounting the disk image using our FUSE filesystem "
2078 "support (L<guestmount(1)>)."
2083 #: ../src/guestfs.pod:906
2084 msgid "KEYS AND PASSPHRASES"
2089 #: ../src/guestfs.pod:908
2091 "Certain libguestfs calls take a parameter that contains sensitive key "
2092 "material, passed in as a C string."
2097 #: ../src/guestfs.pod:911
2099 "In the future we would hope to change the libguestfs implementation so that "
2100 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2101 "swap. However this is I<not> done at the moment, because of the complexity "
2102 "of such an implementation."
2107 #: ../src/guestfs.pod:916
2109 "Therefore you should be aware that any key parameter you pass to libguestfs "
2110 "might end up being written out to the swap partition. If this is a concern, "
2111 "scrub the swap partition or don't use libguestfs on encrypted devices."
2116 #: ../src/guestfs.pod:921
2117 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2122 #: ../src/guestfs.pod:923
2124 "All high-level libguestfs actions are synchronous. If you want to use "
2125 "libguestfs asynchronously then you must create a thread."
2130 #: ../src/guestfs.pod:926
2132 "Only use the handle from a single thread. Either use the handle exclusively "
2133 "from one thread, or provide your own mutex so that two threads cannot issue "
2134 "calls on the same handle at the same time."
2139 #: ../src/guestfs.pod:930
2141 "See the graphical program guestfs-browser for one possible architecture for "
2142 "multithreaded programs using libvirt and libguestfs."
2147 #: ../src/guestfs.pod:933
2153 #: ../src/guestfs.pod:935
2155 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2161 #: ../src/guestfs.pod:938
2163 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2164 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2169 #: ../src/guestfs.pod:941
2171 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2172 "to change the directories that libguestfs will search in. The value is a "
2173 "colon-separated list of paths. The current directory is I<not> searched "
2174 "unless the path contains an empty element or C<.>. For example "
2175 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2176 "then C</usr/lib/guestfs>."
2181 #: ../src/guestfs.pod:948
2182 msgid "QEMU WRAPPERS"
2187 #: ../src/guestfs.pod:950
2189 "If you want to compile your own qemu, run qemu from a non-standard location, "
2190 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2196 #: ../src/guestfs.pod:954
2198 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2199 "last command in the shell script (so that qemu replaces the shell and "
2200 "becomes the direct child of the libguestfs-using program). If you don't do "
2201 "this, then the qemu process won't be cleaned up correctly."
2206 #: ../src/guestfs.pod:959
2208 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2214 #: ../src/guestfs.pod:962
2218 " qemudir=/home/rjones/d/qemu\n"
2219 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2225 #: ../src/guestfs.pod:966
2227 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2228 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2234 #: ../src/guestfs.pod:970
2237 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2243 #: ../src/guestfs.pod:972
2245 "Note that libguestfs also calls qemu with the -help and -version options in "
2246 "order to determine features."
2250 #: ../src/guestfs.pod:975
2251 msgid "ATTACHING TO RUNNING DAEMONS"
2255 #: ../src/guestfs.pod:977
2257 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2258 "babies. Use with caution."
2262 #: ../src/guestfs.pod:980
2264 "I<Note (2):> This section explains how to attach to a running daemon from a "
2265 "low level perspective. For most users, simply using virt tools such as "
2266 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2270 #: ../src/guestfs.pod:984
2271 msgid "Using guestfs_set_attach_method"
2275 #: ../src/guestfs.pod:986
2277 "By calling L</guestfs_set_attach_method> you can change how the library "
2278 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2279 "ARCHITECTURE> for some background)."
2283 #: ../src/guestfs.pod:990
2285 "The normal attach method is C<appliance>, where a small appliance is created "
2286 "containing the daemon, and then the library connects to this."
2290 #: ../src/guestfs.pod:993
2292 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2293 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2294 "daemon over the Unix domain socket."
2298 #: ../src/guestfs.pod:997
2300 "The normal use for this is to connect to a running virtual machine that "
2301 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2302 "files inside the live virtual machine."
2306 #: ../src/guestfs.pod:1001
2307 msgid "Using guestfs_add_domain with live flag"
2311 #: ../src/guestfs.pod:1003
2313 "L</guestfs_add_domain> provides some help for getting the correct attach "
2314 "method. If you pass the C<live> option to this function, then (if the "
2315 "virtual machine is running) it will examine the libvirt XML looking for a "
2316 "virtio-serial channel to connect to:"
2320 #: ../src/guestfs.pod:1009
2327 " <channel type='unix'>\n"
2328 " <source mode='bind' path='/path/to/socket'/>\n"
2329 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2338 #: ../src/guestfs.pod:1021
2340 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2341 "method to C<unix:/path/to/socket>."
2345 #: ../src/guestfs.pod:1024
2347 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2348 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2349 "to attach to and modify live virtual machines."
2353 #: ../src/guestfs.pod:1028
2355 "The virtual machine needs to have been set up beforehand so that it has the "
2356 "virtio-serial channel and so that guestfsd is running inside it."
2361 #: ../src/guestfs.pod:1032
2362 msgid "ABI GUARANTEE"
2367 #: ../src/guestfs.pod:1034
2369 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2370 "actions as outlined in this section. Although we will deprecate some "
2371 "actions, for example if they get replaced by newer calls, we will keep the "
2372 "old actions forever. This allows you the developer to program in confidence "
2373 "against the libguestfs API."
2378 #: ../src/guestfs.pod:1040
2379 msgid "BLOCK DEVICE NAMING"
2384 #: ../src/guestfs.pod:1042
2386 "In the kernel there is now quite a profusion of schemata for naming block "
2387 "devices (in this context, by I<block device> I mean a physical or virtual "
2388 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2389 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2390 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2391 "for the old IDE driver (particularly for SATA devices) those devices also "
2392 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2393 "paravirtualized drivers. This has created several different naming systems, "
2394 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2399 #: ../src/guestfs.pod:1054
2401 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2402 "Linux kernel to access block devices. We can run a variety of appliances "
2403 "based on a variety of Linux kernels."
2408 #: ../src/guestfs.pod:1058
2410 "This causes a problem for libguestfs because many API calls use device or "
2411 "partition names. Working scripts and the recipe (example) scripts that we "
2412 "make available over the internet could fail if the naming scheme changes."
2417 #: ../src/guestfs.pod:1063
2419 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2420 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2421 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2422 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2427 #: ../src/guestfs.pod:1069
2429 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2430 "L</guestfs_list_partitions> and similar calls return the true names of the "
2431 "devices and partitions as known to the appliance."
2436 #: ../src/guestfs.pod:1074
2437 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2442 #: ../src/guestfs.pod:1076
2444 "Usually this translation is transparent. However in some (very rare) cases "
2445 "you may need to know the exact algorithm. Such cases include where you use "
2446 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2447 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2452 #: ../src/guestfs.pod:1082
2454 "The algorithm is applied only to I<parameters> which are known to be either "
2455 "device or partition names. Return values from functions such as L</"
2456 "guestfs_list_devices> are never changed."
2461 #: ../src/guestfs.pod:1090
2462 msgid "Is the string a parameter which is a device or partition name?"
2467 #: ../src/guestfs.pod:1094
2468 msgid "Does the string begin with C</dev/sd>?"
2473 #: ../src/guestfs.pod:1098
2475 "Does the named device exist? If so, we use that device. However if I<not> "
2476 "then we continue with this algorithm."
2481 #: ../src/guestfs.pod:1103
2482 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2487 #: ../src/guestfs.pod:1105
2488 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2493 #: ../src/guestfs.pod:1107
2494 msgid "If that named device exists, use it. If not, continue."
2499 #: ../src/guestfs.pod:1111
2500 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2505 #: ../src/guestfs.pod:1113
2506 msgid "If that named device exists, use it. If not, return an error."
2511 #: ../src/guestfs.pod:1117
2512 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2517 #: ../src/guestfs.pod:1119
2519 "Although the standard naming scheme and automatic translation is useful for "
2520 "simple programs and guestfish scripts, for larger programs it is best not to "
2521 "rely on this mechanism."
2526 #: ../src/guestfs.pod:1123
2528 "Where possible for maximum future portability programs using libguestfs "
2529 "should use these future-proof techniques:"
2534 #: ../src/guestfs.pod:1130
2536 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2537 "device names, and then use those names directly."
2542 #: ../src/guestfs.pod:1133
2544 "Since those device names exist by definition, they will never be translated."
2549 #: ../src/guestfs.pod:1138
2551 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2552 "filesystem labels."
2557 #: ../src/guestfs.pod:1143
2563 #: ../src/guestfs.pod:1145
2565 "This section discusses security implications of using libguestfs, "
2566 "particularly with untrusted or malicious guests or disk images."
2571 #: ../src/guestfs.pod:1148
2572 msgid "GENERAL SECURITY CONSIDERATIONS"
2577 #: ../src/guestfs.pod:1150
2579 "Be careful with any files or data that you download from a guest (by "
2580 "\"download\" we mean not just the L</guestfs_download> command but any "
2581 "command that reads files, filenames, directories or anything else from a "
2582 "disk image). An attacker could manipulate the data to fool your program "
2583 "into doing the wrong thing. Consider cases such as:"
2588 #: ../src/guestfs.pod:1160
2589 msgid "the data (file etc) not being present"
2594 #: ../src/guestfs.pod:1164
2595 msgid "being present but empty"
2600 #: ../src/guestfs.pod:1168
2601 msgid "being much larger than normal"
2606 #: ../src/guestfs.pod:1172
2607 msgid "containing arbitrary 8 bit data"
2612 #: ../src/guestfs.pod:1176
2613 msgid "being in an unexpected character encoding"
2618 #: ../src/guestfs.pod:1180
2619 msgid "containing homoglyphs."
2624 #: ../src/guestfs.pod:1184
2625 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2630 #: ../src/guestfs.pod:1186
2632 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2633 "(VFS) module can sometimes be escalated into exploits by deliberately "
2634 "creating a malicious, malformed filesystem. These exploits are very severe "
2635 "for two reasons. Firstly there are very many filesystem drivers in the "
2636 "kernel, and many of them are infrequently used and not much developer "
2637 "attention has been paid to the code. Linux userspace helps potential "
2638 "crackers by detecting the filesystem type and automatically choosing the "
2639 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2640 "the administrator. Secondly, a kernel-level exploit is like a local root "
2641 "exploit (worse in some ways), giving immediate and total access to the "
2642 "system right down to the hardware level."
2647 #: ../src/guestfs.pod:1199
2649 "That explains why you should never mount a filesystem from an untrusted "
2650 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2651 "inside a qemu virtual machine, usually running as a non-root user. The "
2652 "attacker would need to write a filesystem which first exploited the kernel, "
2653 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2654 "the libguestfs protocol, and finally to be as serious as the host kernel "
2655 "exploit it would need to escalate its privileges to root. This multi-step "
2656 "escalation, performed by a static piece of data, is thought to be extremely "
2657 "hard to do, although we never say 'never' about security issues."
2662 #: ../src/guestfs.pod:1210
2664 "In any case callers can reduce the attack surface by forcing the filesystem "
2665 "type when mounting (use L</guestfs_mount_vfs>)."
2670 #: ../src/guestfs.pod:1213
2671 msgid "PROTOCOL SECURITY"
2676 #: ../src/guestfs.pod:1215
2678 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2679 "defined upper message size. However a program that uses libguestfs must "
2680 "also take care - for example you can write a program that downloads a binary "
2681 "from a disk image and executes it locally, and no amount of protocol "
2682 "security will save you from the consequences."
2687 #: ../src/guestfs.pod:1221
2688 msgid "INSPECTION SECURITY"
2693 #: ../src/guestfs.pod:1223
2695 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2696 "directly from the guest, and these could contain any 8 bit data. Callers "
2697 "should be careful to escape these before printing them to a structured file "
2698 "(for example, use HTML escaping if creating a web page)."
2703 #: ../src/guestfs.pod:1229
2705 "Guest configuration may be altered in unusual ways by the administrator of "
2706 "the virtual machine, and may not reflect reality (particularly for untrusted "
2707 "or actively malicious guests). For example we parse the hostname from "
2708 "configuration files like C</etc/sysconfig/network> that we find in the "
2709 "guest, but the guest administrator can easily manipulate these files to "
2710 "provide the wrong hostname."
2715 #: ../src/guestfs.pod:1237
2717 "The inspection API parses guest configuration using two external libraries: "
2718 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2719 "designed to be robust in the face of malicious data, although denial of "
2720 "service attacks are still possible, for example with oversized configuration "
2726 #: ../src/guestfs.pod:1243
2727 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2732 #: ../src/guestfs.pod:1245
2734 "Be very cautious about running commands from the guest. By running a "
2735 "command in the guest, you are giving CPU time to a binary that you do not "
2736 "control, under the same user account as the library, albeit wrapped in qemu "
2737 "virtualization. More information and alternatives can be found in the "
2738 "section L</RUNNING COMMANDS>."
2743 #: ../src/guestfs.pod:1251
2744 msgid "CVE-2010-3851"
2749 #: ../src/guestfs.pod:1253
2750 msgid "https://bugzilla.redhat.com/642934"
2755 #: ../src/guestfs.pod:1255
2757 "This security bug concerns the automatic disk format detection that qemu "
2758 "does on disk images."
2763 #: ../src/guestfs.pod:1258
2765 "A raw disk image is just the raw bytes, there is no header. Other disk "
2766 "images like qcow2 contain a special header. Qemu deals with this by looking "
2767 "for one of the known headers, and if none is found then assuming the disk "
2768 "image must be raw."
2773 #: ../src/guestfs.pod:1263
2775 "This allows a guest which has been given a raw disk image to write some "
2776 "other header. At next boot (or when the disk image is accessed by "
2777 "libguestfs) qemu would do autodetection and think the disk image format was, "
2778 "say, qcow2 based on the header written by the guest."
2783 #: ../src/guestfs.pod:1268
2785 "This in itself would not be a problem, but qcow2 offers many features, one "
2786 "of which is to allow a disk image to refer to another image (called the "
2787 "\"backing disk\"). It does this by placing the path to the backing disk "
2788 "into the qcow2 header. This path is not validated and could point to any "
2789 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2790 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2791 "control of the attacker."
2796 #: ../src/guestfs.pod:1276
2798 "In libguestfs this is rather hard to exploit except under two circumstances:"
2803 #: ../src/guestfs.pod:1283
2804 msgid "You have enabled the network or have opened the disk in write mode."
2809 #: ../src/guestfs.pod:1287
2811 "You are also running untrusted code from the guest (see L</RUNNING "
2817 #: ../src/guestfs.pod:1292
2819 "The way to avoid this is to specify the expected disk format when adding "
2820 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2821 "should always do this if the disk is raw format, and it's a good idea for "
2827 #: ../src/guestfs.pod:1297
2829 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2830 "format is fetched from libvirt and passed through."
2835 #: ../src/guestfs.pod:1300
2837 "For libguestfs tools, use the I<--format> command line parameter as "
2843 #: ../src/guestfs.pod:1303
2844 msgid "CONNECTION MANAGEMENT"
2849 #: ../src/guestfs.pod:1305
2855 #: ../src/guestfs.pod:1307
2857 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2858 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2859 "handle and release all resources used."
2864 #: ../src/guestfs.pod:1311
2866 "For information on using multiple handles and threads, see the section L</"
2867 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2872 #: ../src/guestfs.pod:1314
2873 msgid "guestfs_create"
2878 #: ../src/guestfs.pod:1316
2881 " guestfs_h *guestfs_create (void);\n"
2887 #: ../src/guestfs.pod:1318
2888 msgid "Create a connection handle."
2893 #: ../src/guestfs.pod:1320
2895 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2896 "on the handle at least once."
2901 #: ../src/guestfs.pod:1323
2903 "This function returns a non-NULL pointer to a handle on success or NULL on "
2909 #: ../src/guestfs.pod:1326
2910 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2915 #: ../src/guestfs.pod:1328
2917 "You may also want to configure error handling for the handle. See L</ERROR "
2918 "HANDLING> section below."
2923 #: ../src/guestfs.pod:1331
2924 msgid "guestfs_close"
2929 #: ../src/guestfs.pod:1333
2932 " void guestfs_close (guestfs_h *g);\n"
2938 #: ../src/guestfs.pod:1335
2939 msgid "This closes the connection handle and frees up all resources used."
2944 #: ../src/guestfs.pod:1337
2945 msgid "ERROR HANDLING"
2950 #: ../src/guestfs.pod:1339
2952 "API functions can return errors. For example, almost all functions that "
2953 "return C<int> will return C<-1> to indicate an error."
2958 #: ../src/guestfs.pod:1342
2960 "Additional information is available for errors: an error message string and "
2961 "optionally an error number (errno) if the thing that failed was a system "
2967 #: ../src/guestfs.pod:1346
2969 "You can get at the additional information about the last error on the handle "
2970 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2971 "up an error handler with L</guestfs_set_error_handler>."
2976 #: ../src/guestfs.pod:1351
2978 "When the handle is created, a default error handler is installed which "
2979 "prints the error message string to C<stderr>. For small short-running "
2980 "command line programs it is sufficient to do:"
2985 #: ../src/guestfs.pod:1355
2988 " if (guestfs_launch (g) == -1)\n"
2989 " exit (EXIT_FAILURE);\n"
2995 #: ../src/guestfs.pod:1358
2997 "since the default error handler will ensure that an error message has been "
2998 "printed to C<stderr> before the program exits."
3003 #: ../src/guestfs.pod:1361
3005 "For other programs the caller will almost certainly want to install an "
3006 "alternate error handler or do error handling in-line like this:"
3011 #: ../src/guestfs.pod:1364
3014 " g = guestfs_create ();\n"
3020 #: ../src/guestfs.pod:1366
3023 " /* This disables the default behaviour of printing errors\n"
3025 " guestfs_set_error_handler (g, NULL, NULL);\n"
3031 #: ../src/guestfs.pod:1370
3034 " if (guestfs_launch (g) == -1) {\n"
3035 " /* Examine the error message and print it etc. */\n"
3036 " char *msg = guestfs_last_error (g);\n"
3037 " int errnum = guestfs_last_errno (g);\n"
3038 " fprintf (stderr, \"%s\\n\", msg);\n"
3046 #: ../src/guestfs.pod:1378
3048 "Out of memory errors are handled differently. The default action is to call "
3049 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3050 "guestfs_set_out_of_memory_handler>."
3055 #: ../src/guestfs.pod:1382
3057 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3058 "because there is no handle if this happens there is no way to get additional "
3059 "error information. However L</guestfs_create> is supposed to be a "
3060 "lightweight operation which can only fail because of insufficient memory (it "
3061 "returns NULL in this case)."
3066 #: ../src/guestfs.pod:1388
3067 msgid "guestfs_last_error"
3072 #: ../src/guestfs.pod:1390
3075 " const char *guestfs_last_error (guestfs_h *g);\n"
3081 #: ../src/guestfs.pod:1392
3083 "This returns the last error message that happened on C<g>. If there has not "
3084 "been an error since the handle was created, then this returns C<NULL>."
3089 #: ../src/guestfs.pod:1396
3091 "The lifetime of the returned string is until the next error occurs, or L</"
3092 "guestfs_close> is called."
3097 #: ../src/guestfs.pod:1399
3098 msgid "guestfs_last_errno"
3103 #: ../src/guestfs.pod:1401
3106 " int guestfs_last_errno (guestfs_h *g);\n"
3112 #: ../src/guestfs.pod:1403
3113 msgid "This returns the last error number (errno) that happened on C<g>."
3118 #: ../src/guestfs.pod:1405
3119 msgid "If successful, an errno integer not equal to zero is returned."
3124 #: ../src/guestfs.pod:1407
3126 "If no error, this returns 0. This call can return 0 in three situations:"
3131 #: ../src/guestfs.pod:1414
3132 msgid "There has not been any error on the handle."
3137 #: ../src/guestfs.pod:1418
3139 "There has been an error but the errno was meaningless. This corresponds to "
3140 "the case where the error did not come from a failed system call, but for "
3141 "some other reason."
3146 #: ../src/guestfs.pod:1424
3148 "There was an error from a failed system call, but for some reason the errno "
3149 "was not captured and returned. This usually indicates a bug in libguestfs."
3154 #: ../src/guestfs.pod:1430
3156 "Libguestfs tries to convert the errno from inside the applicance into a "
3157 "corresponding errno for the caller (not entirely trivial: the appliance "
3158 "might be running a completely different operating system from the library "
3159 "and error numbers are not standardized across Un*xen). If this could not be "
3160 "done, then the error is translated to C<EINVAL>. In practice this should "
3161 "only happen in very rare circumstances."
3166 #: ../src/guestfs.pod:1438
3167 msgid "guestfs_set_error_handler"
3172 #: ../src/guestfs.pod:1440
3175 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3177 " const char *msg);\n"
3178 " void guestfs_set_error_handler (guestfs_h *g,\n"
3179 " guestfs_error_handler_cb cb,\n"
3186 #: ../src/guestfs.pod:1447
3188 "The callback C<cb> will be called if there is an error. The parameters "
3189 "passed to the callback are an opaque data pointer and the error message "
3195 #: ../src/guestfs.pod:1451
3197 "C<errno> is not passed to the callback. To get that the callback must call "
3198 "L</guestfs_last_errno>."
3203 #: ../src/guestfs.pod:1454
3205 "Note that the message string C<msg> is freed as soon as the callback "
3206 "function returns, so if you want to stash it somewhere you must make your "
3212 #: ../src/guestfs.pod:1458
3213 msgid "The default handler prints messages on C<stderr>."
3218 #: ../src/guestfs.pod:1460
3219 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3224 #: ../src/guestfs.pod:1462
3225 msgid "guestfs_get_error_handler"
3230 #: ../src/guestfs.pod:1464
3233 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3234 " void **opaque_rtn);\n"
3240 #: ../src/guestfs.pod:1467
3241 msgid "Returns the current error handler callback."
3246 #: ../src/guestfs.pod:1469
3247 msgid "guestfs_set_out_of_memory_handler"
3252 #: ../src/guestfs.pod:1471
3255 " typedef void (*guestfs_abort_cb) (void);\n"
3256 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3257 " guestfs_abort_cb);\n"
3263 #: ../src/guestfs.pod:1475
3265 "The callback C<cb> will be called if there is an out of memory situation. "
3266 "I<Note this callback must not return>."
3271 #: ../src/guestfs.pod:1478
3272 msgid "The default is to call L<abort(3)>."
3277 #: ../src/guestfs.pod:1480
3279 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3284 #: ../src/guestfs.pod:1483
3285 msgid "guestfs_get_out_of_memory_handler"
3290 #: ../src/guestfs.pod:1485
3293 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3299 #: ../src/guestfs.pod:1487
3300 msgid "This returns the current out of memory handler."
3305 #: ../src/guestfs.pod:1489
3311 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:989
3317 #: ../src/guestfs.pod:1493
3323 #: ../src/guestfs.pod:1495
3329 #: ../src/guestfs.pod:1497
3330 msgid "AVAILABILITY"
3335 #: ../src/guestfs.pod:1499
3336 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3341 #: ../src/guestfs.pod:1501
3343 "Using L</guestfs_available> you can test availability of the following "
3344 "groups of functions. This test queries the appliance to see if the "
3345 "appliance you are currently using supports the functionality."
3350 #: ../src/guestfs.pod:1506
3351 msgid "@AVAILABILITY@"
3356 #: ../src/guestfs.pod:1508
3357 msgid "GUESTFISH supported COMMAND"
3362 #: ../src/guestfs.pod:1510
3364 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3365 "prints out the available groups and whether they are supported by this build "
3366 "of libguestfs. Note however that you have to do C<run> first."
3371 #: ../src/guestfs.pod:1515
3372 msgid "SINGLE CALLS AT COMPILE TIME"
3377 #: ../src/guestfs.pod:1517
3379 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3380 "function, such as:"
3385 #: ../src/guestfs.pod:1520
3388 " #define LIBGUESTFS_HAVE_DD 1\n"
3394 #: ../src/guestfs.pod:1522
3395 msgid "if L</guestfs_dd> is available."
3400 #: ../src/guestfs.pod:1524
3402 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3403 "function is available at compile time, we recommended using build tools such "
3404 "as autoconf or cmake. For example in autotools you could use:"
3409 #: ../src/guestfs.pod:1529
3412 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3413 " AC_CHECK_FUNCS([guestfs_dd])\n"
3419 #: ../src/guestfs.pod:1532
3421 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3427 #: ../src/guestfs.pod:1535
3428 msgid "SINGLE CALLS AT RUN TIME"
3433 #: ../src/guestfs.pod:1537
3435 "Testing at compile time doesn't guarantee that a function really exists in "
3436 "the library. The reason is that you might be dynamically linked against a "
3437 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3438 "This situation unfortunately results in a segmentation fault, which is a "
3439 "shortcoming of the C dynamic linking system itself."
3444 #: ../src/guestfs.pod:1544
3446 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3447 "in this example program (note that you still need the compile time check as "
3453 #: ../src/guestfs.pod:1548
3456 " #include <stdio.h>\n"
3457 " #include <stdlib.h>\n"
3458 " #include <unistd.h>\n"
3459 " #include <dlfcn.h>\n"
3460 " #include <guestfs.h>\n"
3466 #: ../src/guestfs.pod:1554
3471 " #ifdef LIBGUESTFS_HAVE_DD\n"
3473 " int has_function;\n"
3479 #: ../src/guestfs.pod:1560
3482 " /* Test if the function guestfs_dd is really available. */\n"
3483 " dl = dlopen (NULL, RTLD_LAZY);\n"
3485 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3486 " exit (EXIT_FAILURE);\n"
3488 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3495 #: ../src/guestfs.pod:1569
3498 " if (!has_function)\n"
3499 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3501 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3502 " /* Now it's safe to call\n"
3503 " guestfs_dd (g, \"foo\", \"bar\");\n"
3507 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3515 #: ../src/guestfs.pod:1582
3517 "You may think the above is an awful lot of hassle, and it is. There are "
3518 "other ways outside of the C linking system to ensure that this kind of "
3519 "incompatibility never arises, such as using package versioning:"
3524 #: ../src/guestfs.pod:1587
3527 " Requires: libguestfs >= 1.0.80\n"
3533 #: ../src/guestfs.pod:1589
3534 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3539 #: ../src/guestfs.pod:1591
3541 "A recent feature of the API is the introduction of calls which take optional "
3542 "arguments. In C these are declared 3 ways. The main way is as a call which "
3543 "takes variable arguments (ie. C<...>), as in this example:"
3548 #: ../src/guestfs.pod:1596
3551 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3557 #: ../src/guestfs.pod:1598
3559 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3560 "call with no optional arguments specified:"
3565 #: ../src/guestfs.pod:1601
3568 " guestfs_add_drive_opts (g, filename, -1);\n"
3574 #: ../src/guestfs.pod:1603
3575 msgid "With a single optional argument:"
3580 #: ../src/guestfs.pod:1605
3583 " guestfs_add_drive_opts (g, filename,\n"
3584 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3591 #: ../src/guestfs.pod:1609
3597 #: ../src/guestfs.pod:1611
3600 " guestfs_add_drive_opts (g, filename,\n"
3601 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3602 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3609 #: ../src/guestfs.pod:1616
3611 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3617 #: ../src/guestfs.pod:1619
3618 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3623 #: ../src/guestfs.pod:1621
3625 "The second variant has the same name with the suffix C<_va>, which works the "
3626 "same way but takes a C<va_list>. See the C manual for details. For the "
3627 "example function, this is declared:"
3632 #: ../src/guestfs.pod:1625
3635 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3642 #: ../src/guestfs.pod:1628
3643 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3648 #: ../src/guestfs.pod:1630
3650 "The third variant is useful where you need to construct these calls. You "
3651 "pass in a structure where you fill in the optional fields. The structure "
3652 "has a bitmask as the first element which you must set to indicate which "
3653 "fields you have filled in. For our example function the structure and call "
3659 #: ../src/guestfs.pod:1636
3662 " struct guestfs_add_drive_opts_argv {\n"
3663 " uint64_t bitmask;\n"
3665 " const char *format;\n"
3668 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3669 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3675 #: ../src/guestfs.pod:1645
3676 msgid "You could call it like this:"
3681 #: ../src/guestfs.pod:1647
3684 " struct guestfs_add_drive_opts_argv optargs = {\n"
3685 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3686 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3688 " .format = \"qcow2\"\n"
3695 #: ../src/guestfs.pod:1654
3698 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3704 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3705 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:9
3706 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3712 #: ../src/guestfs.pod:1662
3713 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3718 #: ../src/guestfs.pod:1667
3719 msgid "You do not need to fill in all fields of the structure."
3724 #: ../src/guestfs.pod:1671
3726 "There must be a one-to-one correspondence between fields of the structure "
3727 "that are filled in, and bits set in the bitmask."
3732 #: ../src/guestfs.pod:1676
3733 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3738 #: ../src/guestfs.pod:1678
3740 "In other languages, optional arguments are expressed in the way that is "
3741 "natural for that language. We refer you to the language-specific "
3742 "documentation for more details on that."
3747 #: ../src/guestfs.pod:1682
3748 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3753 #: ../src/guestfs.pod:1684
3754 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3758 #: ../src/guestfs.pod:1686
3760 "B<Note:> This section documents the generic event mechanism introduced in "
3761 "libguestfs 1.10, which you should use in new code if possible. The old "
3762 "functions C<guestfs_set_log_message_callback>, "
3763 "C<guestfs_set_subprocess_quit_callback>, "
3764 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3765 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3770 #: ../src/guestfs.pod:1694
3772 "Handles generate events when certain things happen, such as log messages "
3773 "being generated, progress messages during long-running operations, or the "
3774 "handle being closed. The API calls described below let you register a "
3775 "callback to be called when events happen. You can register multiple "
3776 "callbacks (for the same, different or overlapping sets of events), and "
3777 "individually remove callbacks. If callbacks are not removed, then they "
3778 "remain in force until the handle is closed."
3782 #: ../src/guestfs.pod:1702
3784 "In the current implementation, events are only generated synchronously: that "
3785 "means that events (and hence callbacks) can only happen while you are in the "
3786 "middle of making another libguestfs call. The callback is called in the "
3791 #: ../src/guestfs.pod:1707
3793 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3794 "unsigned integers, or a message buffer. Payloads are discussed later on."
3798 #: ../src/guestfs.pod:1711
3799 msgid "CLASSES OF EVENTS"
3803 #: ../src/guestfs.pod:1715
3804 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3808 #: ../src/guestfs.pod:1718
3810 "The callback function will be called while the handle is being closed "
3811 "(synchronously from L</guestfs_close>)."
3816 #: ../src/guestfs.pod:1721
3818 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3819 "handles that are open when the program exits. This means that this callback "
3820 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3821 "problems in higher-level languages (eg. if your HLL interpreter has already "
3822 "been cleaned up by the time this is called, and if your callback then jumps "
3823 "into some HLL function)."
3827 #: ../src/guestfs.pod:1728
3829 "If no callback is registered: the handle is closed without any callback "
3834 #: ../src/guestfs.pod:1731
3835 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3839 #: ../src/guestfs.pod:1734
3841 "The callback function will be called when the child process quits, either "
3842 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3843 "corresponds to a transition from any state to the CONFIG state)."
3847 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3848 msgid "If no callback is registered: the event is ignored."
3852 #: ../src/guestfs.pod:1740
3853 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3857 #: ../src/guestfs.pod:1743
3859 "The callback function will be called when the child process becomes ready "
3860 "first time after it has been launched. (This corresponds to a transition "
3861 "from LAUNCHING to the READY state)."
3865 #: ../src/guestfs.pod:1749
3866 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3871 #: ../src/guestfs.pod:1752
3873 "Some long-running operations can generate progress messages. If this "
3874 "callback is registered, then it will be called each time a progress message "
3875 "is generated (usually two seconds after the operation started, and three "
3876 "times per second thereafter until it completes, although the frequency may "
3877 "change in future versions)."
3881 #: ../src/guestfs.pod:1758
3883 "The callback receives in the payload four unsigned 64 bit numbers which are "
3884 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3888 #: ../src/guestfs.pod:1761
3890 "The units of C<total> are not defined, although for some operations C<total> "
3891 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3892 "or megabytes), and C<position> may be the portion which has been transferred."
3897 #: ../src/guestfs.pod:1766
3898 msgid "The only defined and stable parts of the API are:"
3903 #: ../src/guestfs.pod:1772
3905 "The callback can display to the user some type of progress bar or indicator "
3906 "which shows the ratio of C<position>:C<total>."
3911 #: ../src/guestfs.pod:1777
3912 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3917 #: ../src/guestfs.pod:1781
3919 "If any progress notification is sent during a call, then a final progress "
3920 "notification is always sent when C<position> = C<total>."
3925 #: ../src/guestfs.pod:1784
3927 "This is to simplify caller code, so callers can easily set the progress "
3928 "indicator to \"100%\" at the end of the operation, without requiring special "
3929 "code to detect this case."
3933 #: ../src/guestfs.pod:1790
3935 "The callback also receives the procedure number (C<proc_nr>) and serial "
3936 "number (C<serial>) of the call. These are only useful for debugging "
3937 "protocol issues, and the callback can normally ignore them. The callback "
3938 "may want to print these numbers in error messages or debugging messages."
3942 #: ../src/guestfs.pod:1796
3943 msgid "If no callback is registered: progress messages are discarded."
3947 #: ../src/guestfs.pod:1798
3948 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3952 #: ../src/guestfs.pod:1801
3954 "The callback function is called whenever a log message is generated by qemu, "
3955 "the appliance kernel, guestfsd (daemon), or utility programs."
3959 #: ../src/guestfs.pod:1804
3961 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3962 "guestfs_launch>) then additional debug messages are generated."
3966 #: ../src/guestfs.pod:1807 ../src/guestfs.pod:1821
3968 "If no callback is registered: the messages are discarded unless the verbose "
3969 "flag is set in which case they are sent to stderr. You can override the "
3970 "printing of verbose messages to stderr by setting up a callback."
3974 #: ../src/guestfs.pod:1812
3975 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3979 #: ../src/guestfs.pod:1815
3981 "The callback function is called whenever a log message is generated by the "
3982 "library part of libguestfs."
3986 #: ../src/guestfs.pod:1818
3988 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3989 "messages are generated."
3993 #: ../src/guestfs.pod:1826
3994 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3998 #: ../src/guestfs.pod:1829
4000 "The callback function is called whenever a trace message is generated. This "
4001 "only applies if the trace flag (L</guestfs_set_trace>) is set."
4005 #: ../src/guestfs.pod:1832
4007 "If no callback is registered: the messages are sent to stderr. You can "
4008 "override the printing of trace messages to stderr by setting up a callback."
4012 #: ../src/guestfs.pod:1838
4013 msgid "guestfs_set_event_callback"
4017 #: ../src/guestfs.pod:1840
4020 " int guestfs_set_event_callback (guestfs_h *g,\n"
4021 " guestfs_event_callback cb,\n"
4022 " uint64_t event_bitmask,\n"
4029 #: ../src/guestfs.pod:1846
4031 "This function registers a callback (C<cb>) for all event classes in the "
4036 #: ../src/guestfs.pod:1849
4038 "For example, to register for all log message events, you could call this "
4039 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4040 "To register a single callback for all possible classes of events, use "
4041 "C<GUESTFS_EVENT_ALL>."
4045 #: ../src/guestfs.pod:1855
4046 msgid "C<flags> should always be passed as 0."
4050 #: ../src/guestfs.pod:1857
4052 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4053 "it for any purpose."
4057 #: ../src/guestfs.pod:1860
4059 "The return value is the event handle (an integer) which you can use to "
4060 "delete the callback (see below)."
4064 #: ../src/guestfs.pod:1863
4066 "If there is an error, this function returns C<-1>, and sets the error in the "
4067 "handle in the usual way (see L</guestfs_last_error> etc.)"
4071 #: ../src/guestfs.pod:1866
4073 "Callbacks remain in effect until they are deleted, or until the handle is "
4078 #: ../src/guestfs.pod:1869
4080 "In the case where multiple callbacks are registered for a particular event "
4081 "class, all of the callbacks are called. The order in which multiple "
4082 "callbacks are called is not defined."
4086 #: ../src/guestfs.pod:1873
4087 msgid "guestfs_delete_event_callback"
4091 #: ../src/guestfs.pod:1875
4094 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4099 #: ../src/guestfs.pod:1877
4101 "Delete a callback that was previously registered. C<event_handle> should be "
4102 "the integer that was returned by a previous call to "
4103 "C<guestfs_set_event_callback> on the same handle."
4107 #: ../src/guestfs.pod:1881
4108 msgid "guestfs_event_callback"
4112 #: ../src/guestfs.pod:1883
4115 " typedef void (*guestfs_event_callback) (\n"
4118 " uint64_t event,\n"
4119 " int event_handle,\n"
4121 " const char *buf, size_t buf_len,\n"
4122 " const uint64_t *array, size_t array_len);\n"
4127 #: ../src/guestfs.pod:1892
4129 "This is the type of the event callback function that you have to provide."
4133 #: ../src/guestfs.pod:1895
4135 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4136 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4137 "handle, and C<flags> which in the current API you should ignore."
4141 #: ../src/guestfs.pod:1899
4143 "The remaining parameters contain the event payload (if any). Each event may "
4144 "contain a payload, which usually relates to the event class, but for future "
4145 "proofing your code should be written to handle any payload for any event "
4150 #: ../src/guestfs.pod:1904
4152 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4153 "there is no message buffer). Note that this message buffer can contain "
4154 "arbitrary 8 bit data, including NUL bytes."
4158 #: ../src/guestfs.pod:1908
4160 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4161 "moment this is only used for progress messages."
4165 #: ../src/guestfs.pod:1911
4166 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4170 #: ../src/guestfs.pod:1913
4172 "One motivation for the generic event API was to allow GUI programs to "
4173 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4174 "unconditionally to C<stderr>."
4178 #: ../src/guestfs.pod:1917
4180 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4181 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4182 "messages are not events; you must capture error messages separately)."
4186 #: ../src/guestfs.pod:1922
4188 "Programs have to set up a callback to capture the classes of events of "
4193 #: ../src/guestfs.pod:1925
4197 " guestfs_set_event_callback\n"
4198 " (g, message_callback,\n"
4199 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4200 " GUESTFS_EVENT_TRACE,\n"
4201 " 0, NULL) == -1)\n"
4202 " if (eh == -1) {\n"
4203 " // handle error in the usual way\n"
4209 #: ../src/guestfs.pod:1935
4211 "The callback can then direct messages to the appropriate place. In this "
4212 "example, messages are directed to syslog:"
4216 #: ../src/guestfs.pod:1938
4220 " message_callback (\n"
4223 " uint64_t event,\n"
4224 " int event_handle,\n"
4226 " const char *buf, size_t buf_len,\n"
4227 " const uint64_t *array, size_t array_len)\n"
4229 " const int priority = LOG_USER|LOG_INFO;\n"
4230 " if (buf_len > 0)\n"
4231 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4238 #: ../src/guestfs.pod:1953
4239 msgid "PRIVATE DATA AREA"
4243 #: ../src/guestfs.pod:1955
4245 "You can attach named pieces of private data to the libguestfs handle, fetch "
4246 "them by name, and walk over them, for the lifetime of the handle. This is "
4247 "called the private data area and is only available from the C API."
4252 #: ../src/guestfs.pod:1960
4253 msgid "To attach a named piece of data, use the following call:"
4258 #: ../src/guestfs.pod:1962
4261 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4267 #: ../src/guestfs.pod:1964
4269 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4270 "pointer (which can be C<NULL>). Any previous item with the same name is "
4276 #: ../src/guestfs.pod:1968
4278 "You can use any C<key> you want, but names beginning with an underscore "
4279 "character are reserved for internal libguestfs purposes (for implementing "
4280 "language bindings). It is recommended to prefix the name with some unique "
4281 "string to avoid collisions with other users."
4286 #: ../src/guestfs.pod:1973
4287 msgid "To retrieve the pointer, use:"
4292 #: ../src/guestfs.pod:1975
4295 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4301 #: ../src/guestfs.pod:1977
4303 "This function returns C<NULL> if either no data is found associated with "
4304 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4309 #: ../src/guestfs.pod:1981
4311 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4312 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4313 "all. In particular, libguestfs does I<not> try to free the data when the "
4314 "handle is closed. If the data must be freed, then the caller must either "
4315 "free it before calling L</guestfs_close> or must set up a close callback to "
4316 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4320 #: ../src/guestfs.pod:1988
4321 msgid "To walk over all entries, use these two functions:"
4325 #: ../src/guestfs.pod:1990
4328 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4333 #: ../src/guestfs.pod:1992
4336 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4341 #: ../src/guestfs.pod:1994
4343 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4344 "not have any particular meaning -- keys are not returned in any defined "
4345 "order). A pointer to the key is returned in C<*key_rtn> and the "
4346 "corresponding data pointer is returned from the function. C<NULL> is "
4347 "returned if there are no keys stored in the handle."
4351 #: ../src/guestfs.pod:2000
4353 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4354 "value of this function is also C<NULL> is there are no further entries to "
4359 #: ../src/guestfs.pod:2004
4360 msgid "Notes about walking over entries:"
4364 #: ../src/guestfs.pod:2010
4366 "You must not call C<guestfs_set_private> while walking over the entries."
4370 #: ../src/guestfs.pod:2015
4372 "The handle maintains an internal iterator which is reset when you call "
4373 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4374 "call C<guestfs_set_private>."
4378 #: ../src/guestfs.pod:2021
4379 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4383 #: ../src/guestfs.pod:2023
4386 " guestfs_set_private (g, key, NULL);\n"
4391 #: ../src/guestfs.pod:2025
4392 msgid "then that C<key> is not returned when walking."
4396 #: ../src/guestfs.pod:2029
4398 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4399 "C<guestfs_next_private> or C<guestfs_set_private>."
4403 #: ../src/guestfs.pod:2035
4405 "The following example code shows how to print all keys and data pointers "
4406 "that are associated with the handle C<g>:"
4410 #: ../src/guestfs.pod:2038
4413 " const char *key;\n"
4414 " void *data = guestfs_first_private (g, &key);\n"
4415 " while (data != NULL)\n"
4417 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4418 " data = guestfs_next_private (g, &key);\n"
4424 #: ../src/guestfs.pod:2046
4426 "More commonly you are only interested in keys that begin with an application-"
4427 "specific prefix C<foo_>. Modify the loop like so:"
4431 #: ../src/guestfs.pod:2049
4434 " const char *key;\n"
4435 " void *data = guestfs_first_private (g, &key);\n"
4436 " while (data != NULL)\n"
4438 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4439 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4440 " data = guestfs_next_private (g, &key);\n"
4446 #: ../src/guestfs.pod:2058
4448 "If you need to modify keys while walking, then you have to jump back to the "
4449 "beginning of the loop. For example, to delete all keys prefixed with "
4454 #: ../src/guestfs.pod:2062
4457 " const char *key;\n"
4460 " data = guestfs_first_private (g, &key);\n"
4461 " while (data != NULL)\n"
4463 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4465 " guestfs_set_private (g, key, NULL);\n"
4466 " /* note that 'key' pointer is now invalid, and so is\n"
4467 " the internal iterator */\n"
4470 " data = guestfs_next_private (g, &key);\n"
4476 #: ../src/guestfs.pod:2078
4478 "Note that the above loop is guaranteed to terminate because the keys are "
4479 "being deleted, but other manipulations of keys within the loop might not "
4480 "terminate unless you also maintain an indication of which keys have been "
4486 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4492 #: ../src/guestfs.pod:2085
4494 "<!-- old anchor for the next section --> <a name="
4495 "\"state_machine_and_low_level_event_api\"/>"
4500 #: ../src/guestfs.pod:2090
4501 msgid "ARCHITECTURE"
4506 #: ../src/guestfs.pod:2092
4508 "Internally, libguestfs is implemented by running an appliance (a special "
4509 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4510 "process of the main program."
4515 #: ../src/guestfs.pod:2096
4518 " ___________________\n"
4520 " | main program |\n"
4522 " | | child process / appliance\n"
4523 " | | __________________________\n"
4525 " +-------------------+ RPC | +-----------------+ |\n"
4526 " | libguestfs <--------------------> guestfsd | |\n"
4527 " | | | +-----------------+ |\n"
4528 " \\___________________/ | | Linux kernel | |\n"
4529 " | +--^--------------+ |\n"
4530 " \\_________|________________/\n"
4536 " \\______________/\n"
4542 #: ../src/guestfs.pod:2116
4544 "The library, linked to the main program, creates the child process and hence "
4545 "the appliance in the L</guestfs_launch> function."
4550 #: ../src/guestfs.pod:2119
4552 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4553 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4554 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4555 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4556 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4557 "attached to the qemu process which translates device access by the "
4558 "appliance's Linux kernel into accesses to the image."
4563 #: ../src/guestfs.pod:2128
4565 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4566 "Although the disk image you are attached to might also be used by some "
4567 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4568 "care if both libguestfs's qemu process and your virtual machine are trying "
4569 "to update the disk image at the same time, since these usually results in "
4570 "massive disk corruption)."
4575 #: ../src/guestfs.pod:2135
4576 msgid "STATE MACHINE"
4581 #: ../src/guestfs.pod:2137
4582 msgid "libguestfs uses a state machine to model the child process:"
4587 #: ../src/guestfs.pod:2139
4599 " / | \\ \\ guestfs_launch\n"
4600 " / | _\\__V______\n"
4602 " / | | LAUNCHING |\n"
4603 " / | \\___________/\n"
4605 " / | guestfs_launch\n"
4607 " ______ / __|____V\n"
4608 " / \\ ------> / \\\n"
4609 " | BUSY | | READY |\n"
4610 " \\______/ <------ \\________/\n"
4616 #: ../src/guestfs.pod:2161
4618 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4619 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4620 "(3) alternating between READY and BUSY as commands are issued to, and "
4621 "carried out by, the child process."
4626 #: ../src/guestfs.pod:2166
4628 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4629 "asynchronously at any time (eg. due to some internal error), and that causes "
4630 "the state to transition back to CONFIG."
4635 #: ../src/guestfs.pod:2170
4637 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4638 "issued when in the CONFIG state."
4643 #: ../src/guestfs.pod:2173
4645 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4646 "L</guestfs_launch> blocks until the child process is READY to accept "
4647 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4648 "moves the state from CONFIG to LAUNCHING while it is running."
4653 #: ../src/guestfs.pod:2179
4655 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4656 "state. These API calls block waiting for the command to be carried out (ie. "
4657 "the state to transition to BUSY and then back to READY). There are no non-"
4658 "blocking versions, and no way to issue more than one command per handle at "
4664 #: ../src/guestfs.pod:2185
4666 "Finally, the child process sends asynchronous messages back to the main "
4667 "program, such as kernel log messages. You can register a callback to "
4668 "receive these messages."
4673 #: ../src/guestfs.pod:2189
4679 #: ../src/guestfs.pod:2191
4680 msgid "COMMUNICATION PROTOCOL"
4685 #: ../src/guestfs.pod:2193
4687 "Don't rely on using this protocol directly. This section documents how it "
4688 "currently works, but it may change at any time."
4693 #: ../src/guestfs.pod:2196
4695 "The protocol used to talk between the library and the daemon running inside "
4696 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4697 "1014, RFC 1832, RFC 4506)."
4702 #: ../src/guestfs.pod:2200
4704 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4705 "this file is automatically generated)."
4710 #: ../src/guestfs.pod:2203
4712 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4713 "and C<FileOut> parameters, which are handled with very simple request/reply "
4714 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4715 "parameters, which use the same request and reply messages, but they may also "
4716 "be followed by files sent using a chunked encoding."
4721 #: ../src/guestfs.pod:2210
4722 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4727 #: ../src/guestfs.pod:2212
4728 msgid "For ordinary functions, the request message is:"
4733 #: ../src/guestfs.pod:2214
4736 " total length (header + arguments,\n"
4737 " but not including the length word itself)\n"
4738 " struct guestfs_message_header (encoded as XDR)\n"
4739 " struct guestfs_<foo>_args (encoded as XDR)\n"
4745 #: ../src/guestfs.pod:2219
4747 "The total length field allows the daemon to allocate a fixed size buffer "
4748 "into which it slurps the rest of the message. As a result, the total length "
4749 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4750 "effective size of any request is limited to somewhere under this size."
4755 #: ../src/guestfs.pod:2225
4757 "Note also that many functions don't take any arguments, in which case the "
4758 "C<guestfs_I<foo>_args> is completely omitted."
4763 #: ../src/guestfs.pod:2228
4765 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4766 "receiver knows what type of args structure to expect, or none at all."
4771 #: ../src/guestfs.pod:2232
4773 "For functions that take optional arguments, the optional arguments are "
4774 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4775 "arguments. A bitmask in the header indicates which optional arguments are "
4776 "meaningful. The bitmask is also checked to see if it contains bits set "
4777 "which the daemon does not know about (eg. if more optional arguments were "
4778 "added in a later version of the library), and this causes the call to be "
4784 #: ../src/guestfs.pod:2240
4785 msgid "The reply message for ordinary functions is:"
4790 #: ../src/guestfs.pod:2242
4793 " total length (header + ret,\n"
4794 " but not including the length word itself)\n"
4795 " struct guestfs_message_header (encoded as XDR)\n"
4796 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4802 #: ../src/guestfs.pod:2247
4804 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4805 "functions that return no formal return values."
4810 #: ../src/guestfs.pod:2250
4812 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4817 #: ../src/guestfs.pod:2253
4819 "In the case of an error, a flag is set in the header, and the reply message "
4820 "is slightly changed:"
4825 #: ../src/guestfs.pod:2256
4828 " total length (header + error,\n"
4829 " but not including the length word itself)\n"
4830 " struct guestfs_message_header (encoded as XDR)\n"
4831 " struct guestfs_message_error (encoded as XDR)\n"
4837 #: ../src/guestfs.pod:2261
4839 "The C<guestfs_message_error> structure contains the error message as a "
4845 #: ../src/guestfs.pod:2264
4846 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4851 #: ../src/guestfs.pod:2266
4853 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4854 "The normal request message is sent (see above). However this is followed by "
4855 "a sequence of file chunks."
4860 #: ../src/guestfs.pod:2270
4863 " total length (header + arguments,\n"
4864 " but not including the length word itself,\n"
4865 " and not including the chunks)\n"
4866 " struct guestfs_message_header (encoded as XDR)\n"
4867 " struct guestfs_<foo>_args (encoded as XDR)\n"
4868 " sequence of chunks for FileIn param #0\n"
4869 " sequence of chunks for FileIn param #1 etc.\n"
4875 #: ../src/guestfs.pod:2278
4876 msgid "The \"sequence of chunks\" is:"
4881 #: ../src/guestfs.pod:2280
4884 " length of chunk (not including length word itself)\n"
4885 " struct guestfs_chunk (encoded as XDR)\n"
4886 " length of chunk\n"
4887 " struct guestfs_chunk (encoded as XDR)\n"
4889 " length of chunk\n"
4890 " struct guestfs_chunk (with data.data_len == 0)\n"
4896 #: ../src/guestfs.pod:2288
4898 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4899 "is set in the final chunk to indicate either successful completion or early "
4905 #: ../src/guestfs.pod:2292
4907 "At time of writing there are no functions that have more than one FileIn "
4908 "parameter. However this is (theoretically) supported, by sending the "
4909 "sequence of chunks for each FileIn parameter one after another (from left to "
4915 #: ../src/guestfs.pod:2297
4917 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4918 "transfer. The library does this by sending a chunk with a special flag set "
4919 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4920 "RPC, does I<not> send any reply, and goes back to reading the next request."
4925 #: ../src/guestfs.pod:2303
4927 "The daemon may also cancel. It does this by writing a special word "
4928 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4929 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4930 "cancel chunk). The special word is chosen so that even if cancellation "
4931 "happens right at the end of the transfer (after the library has finished "
4932 "writing and has started listening for the reply), the \"spurious\" cancel "
4933 "flag will not be confused with the reply message."
4938 #: ../src/guestfs.pod:2312
4940 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4941 "limit), and also files where the size is not known in advance (eg. from "
4942 "pipes or sockets). However the chunks are rather small "
4943 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4944 "to keep much in memory."
4949 #: ../src/guestfs.pod:2318
4950 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4955 #: ../src/guestfs.pod:2320
4957 "The protocol for FileOut parameters is exactly the same as for FileIn "
4958 "parameters, but with the roles of daemon and library reversed."
4963 #: ../src/guestfs.pod:2323
4966 " total length (header + ret,\n"
4967 " but not including the length word itself,\n"
4968 " and not including the chunks)\n"
4969 " struct guestfs_message_header (encoded as XDR)\n"
4970 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4971 " sequence of chunks for FileOut param #0\n"
4972 " sequence of chunks for FileOut param #1 etc.\n"
4978 #: ../src/guestfs.pod:2331
4979 msgid "INITIAL MESSAGE"
4984 #: ../src/guestfs.pod:2333
4986 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4987 "which indicates that the guest and daemon is alive. This is what L</"
4988 "guestfs_launch> waits for."
4993 #: ../src/guestfs.pod:2337
4994 msgid "PROGRESS NOTIFICATION MESSAGES"
4999 #: ../src/guestfs.pod:2339
5001 "The daemon may send progress notification messages at any time. These are "
5002 "distinguished by the normal length word being replaced by "
5003 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
5007 #: ../src/guestfs.pod:2343
5009 "The library turns them into progress callbacks (see L</"
5010 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5016 #: ../src/guestfs.pod:2347
5018 "The daemon self-limits the frequency of progress messages it sends (see "
5019 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5025 #: ../src/guestfs.pod:2351
5026 msgid "LIBGUESTFS VERSION NUMBERS"
5031 #: ../src/guestfs.pod:2353
5033 "Since April 2010, libguestfs has started to make separate development and "
5034 "stable releases, along with corresponding branches in our git repository. "
5035 "These separate releases can be identified by version number:"
5040 #: ../src/guestfs.pod:2358
5043 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5044 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5050 " | `-------- sub-version\n"
5052 " `------ always '1' because we don't change the ABI\n"
5058 #: ../src/guestfs.pod:2369
5059 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5064 #: ../src/guestfs.pod:2371
5066 "As time passes we cherry pick fixes from the development branch and backport "
5067 "those into the stable branch, the effect being that the stable branch should "
5068 "get more stable and less buggy over time. So the stable releases are ideal "
5069 "for people who don't need new features but would just like the software to "
5075 #: ../src/guestfs.pod:2377
5076 msgid "Our criteria for backporting changes are:"
5081 #: ../src/guestfs.pod:2383
5083 "Documentation changes which don't affect any code are backported unless the "
5084 "documentation refers to a future feature which is not in stable."
5089 #: ../src/guestfs.pod:2389
5091 "Bug fixes which are not controversial, fix obvious problems, and have been "
5092 "well tested are backported."
5097 #: ../src/guestfs.pod:2394
5099 "Simple rearrangements of code which shouldn't affect how it works get "
5100 "backported. This is so that the code in the two branches doesn't get too "
5101 "far out of step, allowing us to backport future fixes more easily."
5106 #: ../src/guestfs.pod:2400
5108 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5109 "exceptional case: the new feature is required in order to implement an "
5110 "important bug fix."
5115 #: ../src/guestfs.pod:2406
5117 "A new stable branch starts when we think the new features in development are "
5118 "substantial and compelling enough over the current stable branch to warrant "
5119 "it. When that happens we create new stable and development versions 1.N.0 "
5120 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5121 "stable at this point, but by backporting fixes from development, that branch "
5122 "will stabilize over time."
5126 #: ../src/guestfs.pod:2414
5127 msgid "EXTENDING LIBGUESTFS"
5131 #: ../src/guestfs.pod:2416
5132 msgid "ADDING A NEW API ACTION"
5136 #: ../src/guestfs.pod:2418
5138 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5139 "documentation) are generated, and this makes it easy to extend the "
5144 #: ../src/guestfs.pod:2422
5145 msgid "To add a new API action there are two changes:"
5149 #: ../src/guestfs.pod:2428
5151 "You need to add a description of the call (name, parameters, return type, "
5152 "tests, documentation) to C<generator/generator_actions.ml>."
5156 #: ../src/guestfs.pod:2431
5158 "There are two sorts of API action, depending on whether the call goes "
5159 "through to the daemon in the appliance, or is serviced entirely by the "
5160 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5161 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5162 "an example of the latter, since a trace flag is maintained in the handle and "
5163 "all tracing is done on the library side."
5167 #: ../src/guestfs.pod:2439
5169 "Most new actions are of the first type, and get added to the "
5170 "C<daemon_functions> list. Each function has a unique procedure number used "
5171 "in the RPC protocol which is assigned to that action when we publish "
5172 "libguestfs and cannot be reused. Take the latest procedure number and "
5177 #: ../src/guestfs.pod:2445
5179 "For library-only actions of the second type, add to the "
5180 "C<non_daemon_functions> list. Since these functions are serviced by the "
5181 "library and do not travel over the RPC mechanism to the daemon, these "
5182 "functions do not need a procedure number, and so the procedure number is set "
5187 #: ../src/guestfs.pod:2453
5188 msgid "Implement the action (in C):"
5192 #: ../src/guestfs.pod:2455
5194 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5195 "C<daemon/> directory."
5199 #: ../src/guestfs.pod:2458
5201 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5202 "(note: double underscore) in the C<src/> directory."
5206 #: ../src/guestfs.pod:2461
5207 msgid "In either case, use another function as an example of what to do."
5211 #: ../src/guestfs.pod:2465
5212 msgid "After making these changes, use C<make> to compile."
5216 #: ../src/guestfs.pod:2467
5218 "Note that you don't need to implement the RPC, language bindings, manual "
5219 "pages or anything else. It's all automatically generated from the OCaml "
5224 #: ../src/guestfs.pod:2471
5225 msgid "ADDING TESTS FOR AN API ACTION"
5229 #: ../src/guestfs.pod:2473
5231 "You can supply zero or as many tests as you want per API call. The tests "
5232 "can either be added as part of the API description (C<generator/"
5233 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5234 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5235 "slower, so if possible use the first method."
5239 #: ../src/guestfs.pod:2479
5241 "The following describes the test environment used when you add an API test "
5242 "in C<generator_actions.ml>."
5246 #: ../src/guestfs.pod:2482
5247 msgid "The test environment has 4 block devices:"
5251 #: ../src/guestfs.pod:2486
5252 msgid "C</dev/sda> 500MB"
5256 #: ../src/guestfs.pod:2488
5257 msgid "General block device for testing."
5261 #: ../src/guestfs.pod:2490
5262 msgid "C</dev/sdb> 50MB"
5266 #: ../src/guestfs.pod:2492
5268 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5273 #: ../src/guestfs.pod:2495
5274 msgid "C</dev/sdc> 10MB"
5278 #: ../src/guestfs.pod:2497
5279 msgid "Used in a few tests where two block devices are needed."
5283 #: ../src/guestfs.pod:2499
5288 #: ../src/guestfs.pod:2501
5289 msgid "ISO with fixed content (see C<images/test.iso>)."
5293 #: ../src/guestfs.pod:2505
5295 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5296 "appliance and block devices are reused between tests. So don't try testing "
5297 "L</guestfs_kill_subprocess> :-x"
5301 #: ../src/guestfs.pod:2509
5303 "Each test starts with an initial scenario, selected using one of the "
5304 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5305 "initialize the disks mentioned above in a particular way as documented in "
5306 "C<generator_types.ml>. You should not assume anything about the previous "
5307 "contents of other disks that are not initialized."
5311 #: ../src/guestfs.pod:2515
5313 "You can add a prerequisite clause to any individual test. This is a run-"
5314 "time check, which, if it fails, causes the test to be skipped. Useful if "
5315 "testing a command which might not work on all variations of libguestfs "
5316 "builds. A test that has prerequisite of C<Always> means to run "
5321 #: ../src/guestfs.pod:2521
5323 "In addition, packagers can skip individual tests by setting environment "
5324 "variables before running C<make check>."
5328 #: ../src/guestfs.pod:2524
5331 " SKIP_TEST_<CMD>_<NUM>=1\n"
5336 #: ../src/guestfs.pod:2526
5337 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5341 #: ../src/guestfs.pod:2528
5346 #: ../src/guestfs.pod:2530
5349 " SKIP_TEST_<CMD>=1\n"
5354 #: ../src/guestfs.pod:2532
5355 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5359 #: ../src/guestfs.pod:2534
5360 msgid "Packagers can run only certain tests by setting for example:"
5364 #: ../src/guestfs.pod:2536
5367 " TEST_ONLY=\"vfs_type zerofree\"\n"
5372 #: ../src/guestfs.pod:2538
5374 "See C<capitests/tests.c> for more details of how these environment variables "
5379 #: ../src/guestfs.pod:2541
5380 msgid "DEBUGGING NEW API ACTIONS"
5384 #: ../src/guestfs.pod:2543
5385 msgid "Test new actions work before submitting them."
5389 #: ../src/guestfs.pod:2545
5390 msgid "You can use guestfish to try out new commands."
5394 #: ../src/guestfs.pod:2547
5396 "Debugging the daemon is a problem because it runs inside a minimal "
5397 "environment. However you can fprintf messages in the daemon to stderr, and "
5398 "they will show up if you use C<guestfish -v>."
5402 #: ../src/guestfs.pod:2551
5403 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5407 #: ../src/guestfs.pod:2553
5409 "Our C source code generally adheres to some basic code-formatting "
5410 "conventions. The existing code base is not totally consistent on this "
5411 "front, but we do prefer that contributed code be formatted similarly. In "
5412 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5413 "indentation level, and other than that, follow the K&R style."
5417 #: ../src/guestfs.pod:2559
5419 "If you use Emacs, add the following to one of one of your start-up files (e."
5420 "g., ~/.emacs), to help ensure that you get indentation right:"
5424 #: ../src/guestfs.pod:2562
5427 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5428 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5429 " (add-hook 'find-file-hook\n"
5430 " '(lambda () (if (and buffer-file-name\n"
5431 " (string-match \"/libguestfs\\\\>\"\n"
5432 " (buffer-file-name))\n"
5433 " (not (string-equal mode-name \"Change Log\"))\n"
5434 " (not (string-equal mode-name \"Makefile\")))\n"
5435 " (setq indent-tabs-mode nil))))\n"
5440 #: ../src/guestfs.pod:2572
5443 " ;;; When editing C sources in libguestfs, use this style.\n"
5444 " (defun libguestfs-c-mode ()\n"
5445 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5447 " (c-set-style \"K&R\")\n"
5448 " (setq c-indent-level 2)\n"
5449 " (setq c-basic-offset 2))\n"
5450 " (add-hook 'c-mode-hook\n"
5451 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5452 " (buffer-file-name))\n"
5453 " (libguestfs-c-mode))))\n"
5458 #: ../src/guestfs.pod:2584
5459 msgid "Enable warnings when compiling (and fix any problems this finds):"
5463 #: ../src/guestfs.pod:2587
5466 " ./configure --enable-gcc-warnings\n"
5471 #: ../src/guestfs.pod:2589
5472 msgid "Useful targets are:"
5476 #: ../src/guestfs.pod:2591
5479 " make syntax-check # checks the syntax of the C code\n"
5480 " make check # runs the test suite\n"
5485 #: ../src/guestfs.pod:2594
5486 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5490 #: ../src/guestfs.pod:2596
5492 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5493 "which are used to do shell quoting."
5497 #: ../src/guestfs.pod:2601
5502 #: ../src/guestfs.pod:2603
5504 "Simple shell quoted string. Any spaces or other shell characters are "
5509 #: ../src/guestfs.pod:2606
5514 #: ../src/guestfs.pod:2608
5516 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5522 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:240 ../fish/guestfish.pod:599
5523 msgid "For example:"
5527 #: ../src/guestfs.pod:2615
5530 " asprintf (&cmd, \"cat %R\", path);\n"
5535 #: ../src/guestfs.pod:2617
5536 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5540 #: ../src/guestfs.pod:2619
5542 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5543 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5544 "they are not passed via the shell (instead, straight to exec). You probably "
5545 "want to use the C<sysroot_path()> function however."
5549 #: ../src/guestfs.pod:2625
5550 msgid "SUBMITTING YOUR NEW API ACTIONS"
5554 #: ../src/guestfs.pod:2627
5556 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5557 "libguestfs> and CC to L<rjones@redhat.com>."
5561 #: ../src/guestfs.pod:2631
5562 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5566 #: ../src/guestfs.pod:2633
5567 msgid "We support i18n (gettext anyhow) in the library."
5571 #: ../src/guestfs.pod:2635
5573 "However many messages come from the daemon, and we don't translate those at "
5574 "the moment. One reason is that the appliance generally has all locale files "
5575 "removed from it, because they take up a lot of space. So we'd have to readd "
5576 "some of those, as well as copying our PO files into the appliance."
5580 #: ../src/guestfs.pod:2641
5582 "Debugging messages are never translated, since they are intended for the "
5587 #: ../src/guestfs.pod:2644
5588 msgid "SOURCE CODE SUBDIRECTORIES"
5592 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5686
5593 #: ../fish/guestfish-actions.pod:3808
5594 msgid "C<appliance>"
5598 #: ../src/guestfs.pod:2650
5599 msgid "The libguestfs appliance, build scripts and so on."
5603 #: ../src/guestfs.pod:2652
5604 msgid "C<capitests>"
5608 #: ../src/guestfs.pod:2654
5609 msgid "Automated tests of the C API."
5613 #: ../src/guestfs.pod:2656
5618 #: ../src/guestfs.pod:2658
5620 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5625 #: ../src/guestfs.pod:2661
5630 #: ../src/guestfs.pod:2663
5631 msgid "Outside contributions, experimental parts."
5635 #: ../src/guestfs.pod:2665
5640 #: ../src/guestfs.pod:2667
5642 "The daemon that runs inside the libguestfs appliance and carries out actions."
5646 #: ../src/guestfs.pod:2670
5651 #: ../src/guestfs.pod:2672
5652 msgid "L<virt-df(1)> command and documentation."
5656 #: ../src/guestfs.pod:2674
5661 #: ../src/guestfs.pod:2676
5662 msgid "C API example code."
5666 #: ../src/guestfs.pod:2678
5671 #: ../src/guestfs.pod:2680
5673 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5674 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5675 "L<virt-tar-out(1)>."
5679 #: ../src/guestfs.pod:2684
5684 #: ../src/guestfs.pod:2686
5686 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5690 #: ../src/guestfs.pod:2688
5691 msgid "C<generator>"
5695 #: ../src/guestfs.pod:2690
5697 "The crucially important generator, used to automatically generate large "
5698 "amounts of boilerplate C code for things like RPC and bindings."
5702 #: ../src/guestfs.pod:2693
5707 #: ../src/guestfs.pod:2695
5708 msgid "Files used by the test suite."
5712 #: ../src/guestfs.pod:2697
5713 msgid "Some \"phony\" guest images which we test against."
5717 #: ../src/guestfs.pod:2699
5718 msgid "C<inspector>"
5722 #: ../src/guestfs.pod:2701
5723 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5727 #: ../src/guestfs.pod:2703
5732 #: ../src/guestfs.pod:2705
5733 msgid "Logo used on the website. The fish is called Arthur by the way."
5737 #: ../src/guestfs.pod:2707
5742 #: ../src/guestfs.pod:2709
5743 msgid "M4 macros used by autoconf."
5747 #: ../src/guestfs.pod:2711
5752 #: ../src/guestfs.pod:2713
5753 msgid "Translations of simple gettext strings."
5757 #: ../src/guestfs.pod:2715
5762 #: ../src/guestfs.pod:2717
5764 "The build infrastructure and PO files for translations of manpages and POD "
5765 "files. Eventually this will be combined with the C<po> directory, but that "
5766 "is rather complicated."
5770 #: ../src/guestfs.pod:2721
5771 msgid "C<regressions>"
5775 #: ../src/guestfs.pod:2723
5776 msgid "Regression tests."
5780 #: ../src/guestfs.pod:2725
5785 #: ../src/guestfs.pod:2727
5786 msgid "L<virt-rescue(1)> command and documentation."
5790 #: ../src/guestfs.pod:2729
5795 #: ../src/guestfs.pod:2731
5796 msgid "Source code to the C library."
5800 #: ../src/guestfs.pod:2733
5805 #: ../src/guestfs.pod:2735
5806 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5810 #: ../src/guestfs.pod:2737
5811 msgid "C<test-tool>"
5815 #: ../src/guestfs.pod:2739
5817 "Test tool for end users to test if their qemu/kernel combination will work "
5822 #: ../src/guestfs.pod:2742
5827 #: ../src/guestfs.pod:2744
5832 #: ../src/guestfs.pod:2746
5837 #: ../src/guestfs.pod:2748
5842 #: ../src/guestfs.pod:2750
5847 #: ../src/guestfs.pod:2752
5852 #: ../src/guestfs.pod:2754
5857 #: ../src/guestfs.pod:2756
5862 #: ../src/guestfs.pod:2758
5863 msgid "Language bindings."
5868 #: ../src/guestfs.pod:2762 ../fish/guestfish.pod:996
5869 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5870 msgid "ENVIRONMENT VARIABLES"
5875 #: ../src/guestfs.pod:2766 ../fish/guestfish.pod:1022
5876 msgid "LIBGUESTFS_APPEND"
5881 #: ../src/guestfs.pod:2768 ../fish/guestfish.pod:1024
5882 msgid "Pass additional options to the guest kernel."
5887 #: ../src/guestfs.pod:2770 ../fish/guestfish.pod:1026
5888 msgid "LIBGUESTFS_DEBUG"
5893 #: ../src/guestfs.pod:2772
5895 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5896 "effect as calling C<guestfs_set_verbose (g, 1)>."
5901 #: ../src/guestfs.pod:2775 ../fish/guestfish.pod:1031
5902 msgid "LIBGUESTFS_MEMSIZE"
5907 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1033
5909 "Set the memory allocated to the qemu process, in megabytes. For example:"
5914 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1036
5917 " LIBGUESTFS_MEMSIZE=700\n"
5923 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1038
5924 msgid "LIBGUESTFS_PATH"
5929 #: ../src/guestfs.pod:2784
5931 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
5932 "the discussion of paths in section PATH above."
5937 #: ../src/guestfs.pod:2787 ../fish/guestfish.pod:1043
5938 msgid "LIBGUESTFS_QEMU"
5943 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1045
5945 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5946 "which was found at compile time by the configure script is used."
5951 #: ../src/guestfs.pod:2793
5952 msgid "See also L</QEMU WRAPPERS> above."
5957 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1049
5958 msgid "LIBGUESTFS_TRACE"
5963 #: ../src/guestfs.pod:2797
5965 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5966 "effect as calling C<guestfs_set_trace (g, 1)>."
5971 #: ../src/guestfs.pod:2800 ../fish/guestfish.pod:1058
5976 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1060
5978 "Location of temporary directory, defaults to C</tmp> except for the cached "
5979 "supermin appliance which defaults to C</var/tmp>."
5983 #: ../src/guestfs.pod:2805 ../fish/guestfish.pod:1063
5985 "If libguestfs was compiled to use the supermin appliance then the real "
5986 "appliance is cached in this directory, shared between all handles belonging "
5987 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5988 "use in case C</var/tmp> is not large enough."
5993 #: ../src/guestfs.pod:2813 ../fish/guestfish.pod:1121
5994 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:238
5995 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572
5996 #: ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189
5997 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5998 #: ../tools/virt-list-partitions.pl:257
6003 #: ../src/guestfs.pod:2815
6005 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6006 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6007 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6008 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6009 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6010 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6011 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6016 #: ../src/guestfs.pod:2842
6018 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6019 "(8)>, L<disktype(1)>."
6024 #: ../src/guestfs.pod:2849 ../tools/virt-win-reg.pl:587
6025 #: ../tools/virt-make-fs.pl:553
6031 #: ../src/guestfs.pod:2851
6032 msgid "To get a list of bugs against libguestfs use this link:"
6037 #: ../src/guestfs.pod:2853
6039 "L<https://bugzilla.redhat.com/buglist.cgi?"
6040 "component=libguestfs&product=Virtualization+Tools>"
6045 #: ../src/guestfs.pod:2855
6046 msgid "To report a new bug against libguestfs use this link:"
6051 #: ../src/guestfs.pod:2857
6053 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6054 "component=libguestfs&product=Virtualization+Tools>"
6059 #: ../src/guestfs.pod:2859
6060 msgid "When reporting a bug, please check:"
6065 #: ../src/guestfs.pod:2865
6066 msgid "That the bug hasn't been reported already."
6071 #: ../src/guestfs.pod:2869
6072 msgid "That you are testing a recent version."
6077 #: ../src/guestfs.pod:2873
6078 msgid "Describe the bug accurately, and give a way to reproduce it."
6083 #: ../src/guestfs.pod:2877
6085 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6091 #: ../src/guestfs.pod:2882 ../fish/guestfish.pod:1144
6092 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:249
6098 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1146
6099 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:251
6100 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6105 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1148
6106 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:253
6107 #: ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602
6108 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206
6109 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6110 #: ../tools/virt-list-partitions.pl:273
6116 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1150
6117 #: ../fuse/guestmount.pod:255
6118 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
6123 #: ../src/guestfs.pod:2891
6125 "This library is free software; you can redistribute it and/or modify it "
6126 "under the terms of the GNU Lesser General Public License as published by the "
6127 "Free Software Foundation; either version 2 of the License, or (at your "
6128 "option) any later version."
6133 #: ../src/guestfs.pod:2896
6135 "This library is distributed in the hope that it will be useful, but WITHOUT "
6136 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6137 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6143 #: ../src/guestfs.pod:2901
6145 "You should have received a copy of the GNU Lesser General Public License "
6146 "along with this library; if not, write to the Free Software Foundation, "
6147 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6152 #: ../src/guestfs-actions.pod:1
6153 msgid "guestfs_add_cdrom"
6158 #: ../src/guestfs-actions.pod:3
6162 " guestfs_add_cdrom (guestfs_h *g,\n"
6163 " const char *filename);\n"
6169 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6170 msgid "This function adds a virtual CD-ROM disk image to the guest."
6175 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6176 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
6181 #: ../src/guestfs-actions.pod:17
6183 "This call checks for the existence of C<filename>. This stops you from "
6184 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6185 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6191 #: ../src/guestfs-actions.pod:24
6193 "If you just want to add an ISO file (often you use this as an efficient way "
6194 "to transfer large files into the guest), then you should probably use "
6195 "C<guestfs_add_drive_ro> instead."
6200 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6201 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6202 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6203 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6204 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6205 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6206 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6207 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6208 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6209 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6210 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6211 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6212 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6213 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6214 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6215 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6216 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1332
6217 #: ../src/guestfs-actions.pod:1438 ../src/guestfs-actions.pod:1472
6218 #: ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1712
6219 #: ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2261
6220 #: ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2466
6221 #: ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:3336
6222 #: ../src/guestfs-actions.pod:3351 ../src/guestfs-actions.pod:3371
6223 #: ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3540
6224 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3567
6225 #: ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3618
6226 #: ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:3710
6227 #: ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3750
6228 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:3805
6229 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3843
6230 #: ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3890
6231 #: ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:3942
6232 #: ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:3970
6233 #: ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:4080
6234 #: ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4113
6235 #: ../src/guestfs-actions.pod:4164 ../src/guestfs-actions.pod:4182
6236 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4216
6237 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4244
6238 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4276
6239 #: ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4354
6240 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4458
6241 #: ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:4496
6242 #: ../src/guestfs-actions.pod:4508 ../src/guestfs-actions.pod:4525
6243 #: ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4553
6244 #: ../src/guestfs-actions.pod:4568 ../src/guestfs-actions.pod:4603
6245 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4638
6246 #: ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4669
6247 #: ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4755
6248 #: ../src/guestfs-actions.pod:4769 ../src/guestfs-actions.pod:4797
6249 #: ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4832
6250 #: ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:5023
6251 #: ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5063
6252 #: ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5161
6253 #: ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5191
6254 #: ../src/guestfs-actions.pod:5205 ../src/guestfs-actions.pod:5494
6255 #: ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5532
6256 #: ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5556
6257 #: ../src/guestfs-actions.pod:5570 ../src/guestfs-actions.pod:5582
6258 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5612
6259 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652
6260 #: ../src/guestfs-actions.pod:5671 ../src/guestfs-actions.pod:5701
6261 #: ../src/guestfs-actions.pod:5717 ../src/guestfs-actions.pod:5740
6262 #: ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5777
6263 #: ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5817
6264 #: ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5862
6265 #: ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905
6266 #: ../src/guestfs-actions.pod:5929 ../src/guestfs-actions.pod:5948
6267 #: ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:5982
6268 #: ../src/guestfs-actions.pod:6019 ../src/guestfs-actions.pod:6042
6269 #: ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6176
6270 #: ../src/guestfs-actions.pod:6297 ../src/guestfs-actions.pod:6309
6271 #: ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6335
6272 #: ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6370
6273 #: ../src/guestfs-actions.pod:6383 ../src/guestfs-actions.pod:6396
6274 #: ../src/guestfs-actions.pod:6411 ../src/guestfs-actions.pod:6470
6275 #: ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6503
6276 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6536
6277 #: ../src/guestfs-actions.pod:6549 ../src/guestfs-actions.pod:6569
6278 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6619
6279 #: ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:6673
6280 #: ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:6725
6281 #: ../src/guestfs-actions.pod:6761 ../src/guestfs-actions.pod:6880
6282 #: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6912
6283 #: ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6980
6284 #: ../src/guestfs-actions.pod:7025 ../src/guestfs-actions.pod:7058
6285 #: ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7138
6286 #: ../src/guestfs-actions.pod:7204 ../src/guestfs-actions.pod:7223
6287 #: ../src/guestfs-actions.pod:7252
6288 msgid "This function returns 0 on success or -1 on error."
6293 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6294 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6295 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6297 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6303 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6304 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1443
6305 #: ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:1960
6306 #: ../src/guestfs-actions.pod:4301 ../src/guestfs-actions.pod:7146
6307 #: ../src/guestfs-actions.pod:7315 ../fish/guestfish-actions.pod:31
6308 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6309 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6310 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:2908
6311 #: ../fish/guestfish-actions.pod:4766 ../fish/guestfish-actions.pod:4863
6313 "Deprecated functions will not be removed from the API, but the fact that "
6314 "they are deprecated indicates that there are problems with correct use of "
6320 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6321 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1911
6322 #: ../src/guestfs-actions.pod:2009 ../src/guestfs-actions.pod:2112
6323 #: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3353
6324 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:5719
6325 #: ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:5950
6326 #: ../src/guestfs-actions.pod:6413 ../src/guestfs-actions.pod:6538
6327 #: ../src/guestfs-actions.pod:7060
6328 msgid "(Added in 0.3)"
6333 #: ../src/guestfs-actions.pod:41
6334 msgid "guestfs_add_domain"
6339 #: ../src/guestfs-actions.pod:43
6343 " guestfs_add_domain (guestfs_h *g,\n"
6344 " const char *dom,\n"
6351 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6352 #: ../src/guestfs-actions.pod:4315
6354 "You may supply a list of optional arguments to this call. Use zero or more "
6355 "of the following pairs of parameters, and terminate the list with C<-1> on "
6356 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6360 #: ../src/guestfs-actions.pod:53
6363 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6364 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6365 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6366 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6372 #: ../src/guestfs-actions.pod:58
6374 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6375 "It works by connecting to libvirt, requesting the domain and domain XML from "
6376 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6382 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6384 "The number of disks added is returned. This operation is atomic: if an "
6385 "error is returned, then no disks are added."
6390 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6392 "This function does some minimal checks to make sure the libvirt domain is "
6393 "not running (unless C<readonly> is true). In a future version we will try "
6394 "to acquire the libvirt lock on each disk."
6399 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6401 "Disks must be accessible locally. This often means that adding disks from a "
6402 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6403 "unless those disks are accessible via the same device path locally too."
6407 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6409 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6410 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6411 "libvirt URI (or one set through an environment variable, see the libvirt "
6412 "documentation for full details)."
6416 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6418 "The optional C<live> flag controls whether this call will try to connect to "
6419 "a running virtual machine C<guestfsd> process if it sees a suitable "
6420 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6421 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6422 "DAEMONS> for more information."
6427 #: ../src/guestfs-actions.pod:88
6429 "The other optional parameters are passed directly through to "
6430 "C<guestfs_add_drive_opts>."
6435 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6436 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6437 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6438 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6439 #: ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1872
6440 #: ../src/guestfs-actions.pod:1981 ../src/guestfs-actions.pod:2021
6441 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2099
6442 #: ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2719
6443 #: ../src/guestfs-actions.pod:2740 ../src/guestfs-actions.pod:4741
6444 #: ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:5275
6445 #: ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:6646
6446 #: ../src/guestfs-actions.pod:7071 ../src/guestfs-actions.pod:7084
6447 #: ../src/guestfs-actions.pod:7097
6448 msgid "On error this function returns -1."
6453 #: ../src/guestfs-actions.pod:93
6454 msgid "(Added in 1.7.4)"
6459 #: ../src/guestfs-actions.pod:95
6460 msgid "guestfs_add_domain_va"
6465 #: ../src/guestfs-actions.pod:97
6469 " guestfs_add_domain_va (guestfs_h *g,\n"
6470 " const char *dom,\n"
6477 #: ../src/guestfs-actions.pod:102
6478 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6483 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6484 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6485 #: ../src/guestfs-actions.pod:4368 ../src/guestfs-actions.pod:4380
6486 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6491 #: ../src/guestfs-actions.pod:106
6492 msgid "guestfs_add_domain_argv"
6497 #: ../src/guestfs-actions.pod:108
6501 " guestfs_add_domain_argv (guestfs_h *g,\n"
6502 " const char *dom,\n"
6503 " const struct guestfs_add_domain_argv *optargs);\n"
6509 #: ../src/guestfs-actions.pod:113
6510 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6515 #: ../src/guestfs-actions.pod:117
6516 msgid "guestfs_add_drive"
6521 #: ../src/guestfs-actions.pod:119
6525 " guestfs_add_drive (guestfs_h *g,\n"
6526 " const char *filename);\n"
6532 #: ../src/guestfs-actions.pod:123
6534 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6535 "optional parameters, so the disk is added writable, with the format being "
6536 "detected automatically."
6541 #: ../src/guestfs-actions.pod:127
6543 "Automatic detection of the format opens you up to a potential security hole "
6544 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6545 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6546 "you should think about replacing calls to this function with calls to "
6547 "C<guestfs_add_drive_opts>, and specifying the format."
6552 #: ../src/guestfs-actions.pod:138
6553 msgid "guestfs_add_drive_opts"
6558 #: ../src/guestfs-actions.pod:140
6562 " guestfs_add_drive_opts (guestfs_h *g,\n"
6563 " const char *filename,\n"
6570 #: ../src/guestfs-actions.pod:150
6573 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6574 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6575 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6581 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6583 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6584 "The first time you call this function, the disk appears as C</dev/sda>, the "
6585 "second time as C</dev/sdb>, and so on."
6590 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6592 "You don't necessarily need to be root when using libguestfs. However you "
6593 "obviously do need sufficient permissions to access the filename for whatever "
6594 "operations you want to perform (ie. read access if you just want to read the "
6595 "image or write access if you want to modify the image)."
6600 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6601 msgid "This call checks that C<filename> exists."
6606 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4326
6607 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2919
6608 msgid "The optional arguments are:"
6613 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6619 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6621 "If true then the image is treated as read-only. Writes are still allowed, "
6622 "but they are stored in a temporary snapshot overlay which is discarded at "
6623 "the end. The disk that you add is not modified."
6628 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6634 #: ../src/guestfs-actions.pod:179
6636 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6637 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6638 "Possible formats include C<raw> and C<qcow2>."
6643 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6645 "Automatic detection of the format opens you up to a potential security hole "
6646 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6647 "RHBZ#642934. Specifying the format closes this security hole."
6652 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6658 #: ../src/guestfs-actions.pod:190
6660 "This rarely-used option lets you emulate the behaviour of the deprecated "
6661 "C<guestfs_add_drive_with_if> call (q.v.)"
6666 #: ../src/guestfs-actions.pod:197
6667 msgid "(Added in 1.5.23)"
6672 #: ../src/guestfs-actions.pod:199
6673 msgid "guestfs_add_drive_opts_va"
6678 #: ../src/guestfs-actions.pod:201
6682 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6683 " const char *filename,\n"
6690 #: ../src/guestfs-actions.pod:206
6691 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6696 #: ../src/guestfs-actions.pod:210
6697 msgid "guestfs_add_drive_opts_argv"
6702 #: ../src/guestfs-actions.pod:212
6706 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6707 " const char *filename,\n"
6708 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6714 #: ../src/guestfs-actions.pod:217
6715 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6720 #: ../src/guestfs-actions.pod:221
6721 msgid "guestfs_add_drive_ro"
6726 #: ../src/guestfs-actions.pod:223
6730 " guestfs_add_drive_ro (guestfs_h *g,\n"
6731 " const char *filename);\n"
6737 #: ../src/guestfs-actions.pod:227
6739 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6740 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6741 "disk is added read-only, with the format being detected automatically."
6746 #: ../src/guestfs-actions.pod:234
6747 msgid "(Added in 1.0.38)"
6752 #: ../src/guestfs-actions.pod:236
6753 msgid "guestfs_add_drive_ro_with_if"
6758 #: ../src/guestfs-actions.pod:238
6762 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6763 " const char *filename,\n"
6764 " const char *iface);\n"
6770 #: ../src/guestfs-actions.pod:243
6772 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6773 "QEMU interface emulation to use at run time."
6778 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6779 #: ../src/guestfs-actions.pod:2351
6780 msgid "(Added in 1.0.84)"
6785 #: ../src/guestfs-actions.pod:257
6786 msgid "guestfs_add_drive_with_if"
6791 #: ../src/guestfs-actions.pod:259
6795 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6796 " const char *filename,\n"
6797 " const char *iface);\n"
6803 #: ../src/guestfs-actions.pod:264
6805 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6806 "QEMU interface emulation to use at run time."
6811 #: ../src/guestfs-actions.pod:278
6812 msgid "guestfs_aug_clear"
6817 #: ../src/guestfs-actions.pod:280
6821 " guestfs_aug_clear (guestfs_h *g,\n"
6822 " const char *augpath);\n"
6828 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6830 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6831 "L<augtool(1)> C<clear> command."
6836 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2101
6837 msgid "(Added in 1.3.4)"
6842 #: ../src/guestfs-actions.pod:291
6843 msgid "guestfs_aug_close"
6848 #: ../src/guestfs-actions.pod:293
6852 " guestfs_aug_close (guestfs_h *g);\n"
6858 #: ../src/guestfs-actions.pod:296
6860 "Close the current Augeas handle and free up any resources used by it. After "
6861 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6862 "any other Augeas functions."
6867 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6868 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6869 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6870 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6871 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6872 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6873 #: ../src/guestfs-actions.pod:5352
6874 msgid "(Added in 0.7)"
6879 #: ../src/guestfs-actions.pod:305
6880 msgid "guestfs_aug_defnode"
6885 #: ../src/guestfs-actions.pod:307
6888 " struct guestfs_int_bool *\n"
6889 " guestfs_aug_defnode (guestfs_h *g,\n"
6890 " const char *name,\n"
6891 " const char *expr,\n"
6892 " const char *val);\n"
6898 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6900 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6905 #: ../src/guestfs-actions.pod:316
6907 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6908 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6909 "containing that single node."
6914 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6916 "On success this returns a pair containing the number of nodes in the "
6917 "nodeset, and a boolean flag if a node was created."
6922 #: ../src/guestfs-actions.pod:324
6924 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6925 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6930 #: ../src/guestfs-actions.pod:330
6931 msgid "guestfs_aug_defvar"
6936 #: ../src/guestfs-actions.pod:332
6940 " guestfs_aug_defvar (guestfs_h *g,\n"
6941 " const char *name,\n"
6942 " const char *expr);\n"
6948 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6950 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6951 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6956 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6958 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6959 "evaluates to something which is not a nodeset."
6964 #: ../src/guestfs-actions.pod:348
6965 msgid "guestfs_aug_get"
6970 #: ../src/guestfs-actions.pod:350
6974 " guestfs_aug_get (guestfs_h *g,\n"
6975 " const char *augpath);\n"
6981 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6983 "Look up the value associated with C<path>. If C<path> matches exactly one "
6984 "node, the C<value> is returned."
6989 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6990 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6991 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6992 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6993 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1349
6994 #: ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1652
6995 #: ../src/guestfs-actions.pod:1815 ../src/guestfs-actions.pod:1832
6996 #: ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1933
6997 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:2124
6998 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2523
6999 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2671
7000 #: ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2805
7001 #: ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:2860
7002 #: ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:2945
7003 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3862
7004 #: ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4142
7005 #: ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:5080
7006 #: ../src/guestfs-actions.pod:5250 ../src/guestfs-actions.pod:5428
7007 #: ../src/guestfs-actions.pod:5477 ../src/guestfs-actions.pod:6089
7008 #: ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6122
7009 #: ../src/guestfs-actions.pod:6146 ../src/guestfs-actions.pod:6820
7010 #: ../src/guestfs-actions.pod:6839 ../src/guestfs-actions.pod:6857
7011 #: ../src/guestfs-actions.pod:7037 ../src/guestfs-actions.pod:7309
7013 "This function returns a string, or NULL on error. I<The caller must free "
7014 "the returned string after use>."
7019 #: ../src/guestfs-actions.pod:362
7020 msgid "guestfs_aug_init"
7025 #: ../src/guestfs-actions.pod:364
7029 " guestfs_aug_init (guestfs_h *g,\n"
7030 " const char *root,\n"
7037 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7039 "Create a new Augeas handle for editing configuration files. If there was "
7040 "any previous Augeas handle associated with this guestfs session, then it is "
7046 #: ../src/guestfs-actions.pod:373
7047 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7052 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7054 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7059 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7061 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7062 "logical I<or> of the following integers:"
7067 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7068 msgid "C<AUG_SAVE_BACKUP> = 1"
7073 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7074 msgid "Keep the original file with a C<.augsave> extension."
7079 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7080 msgid "C<AUG_SAVE_NEWFILE> = 2"
7085 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7087 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7088 "original. Overrides C<AUG_SAVE_BACKUP>."
7093 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7094 msgid "C<AUG_TYPE_CHECK> = 4"
7099 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7100 msgid "Typecheck lenses (can be expensive)."
7105 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7106 msgid "C<AUG_NO_STDINC> = 8"
7111 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7112 msgid "Do not use standard load path for modules."
7117 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7118 msgid "C<AUG_SAVE_NOOP> = 16"
7123 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7124 msgid "Make save a no-op, just record what would have been changed."
7129 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7130 msgid "C<AUG_NO_LOAD> = 32"
7135 #: ../src/guestfs-actions.pod:408
7136 msgid "Do not load the tree in C<guestfs_aug_init>."
7141 #: ../src/guestfs-actions.pod:412
7142 msgid "To close the handle, you can call C<guestfs_aug_close>."
7147 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7148 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7153 #: ../src/guestfs-actions.pod:420
7154 msgid "guestfs_aug_insert"
7159 #: ../src/guestfs-actions.pod:422
7163 " guestfs_aug_insert (guestfs_h *g,\n"
7164 " const char *augpath,\n"
7165 " const char *label,\n"
7172 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7174 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7175 "or after C<path> (depending on the boolean flag C<before>)."
7180 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7182 "C<path> must match exactly one existing node in the tree, and C<label> must "
7183 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7188 #: ../src/guestfs-actions.pod:440
7189 msgid "guestfs_aug_load"
7194 #: ../src/guestfs-actions.pod:442
7198 " guestfs_aug_load (guestfs_h *g);\n"
7204 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7205 msgid "Load files into the tree."
7210 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7211 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7216 #: ../src/guestfs-actions.pod:454
7217 msgid "guestfs_aug_ls"
7222 #: ../src/guestfs-actions.pod:456
7226 " guestfs_aug_ls (guestfs_h *g,\n"
7227 " const char *augpath);\n"
7233 #: ../src/guestfs-actions.pod:460
7235 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7236 "sorting the resulting nodes into alphabetical order."
7241 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7242 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7243 #: ../src/guestfs-actions.pod:1364 ../src/guestfs-actions.pod:1383
7244 #: ../src/guestfs-actions.pod:1486 ../src/guestfs-actions.pod:1505
7245 #: ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:2196
7246 #: ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:2231
7247 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:2298
7248 #: ../src/guestfs-actions.pod:2369 ../src/guestfs-actions.pod:2418
7249 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2879
7250 #: ../src/guestfs-actions.pod:3147 ../src/guestfs-actions.pod:3432
7251 #: ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3599
7252 #: ../src/guestfs-actions.pod:4004 ../src/guestfs-actions.pod:4702
7253 #: ../src/guestfs-actions.pod:5222 ../src/guestfs-actions.pod:5348
7254 #: ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:6162
7255 #: ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6278
7256 #: ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6448
7257 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6950
7258 #: ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7162
7259 #: ../src/guestfs-actions.pod:7181 ../src/guestfs-actions.pod:7266
7260 #: ../src/guestfs-actions.pod:7285 ../src/guestfs-actions.pod:7331
7261 #: ../src/guestfs-actions.pod:7350
7263 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7264 ">), or NULL if there was an error. I<The caller must free the strings and "
7265 "the array after use>."
7270 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7271 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1421
7272 #: ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:3256
7273 #: ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3895
7274 #: ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:4115
7275 #: ../src/guestfs-actions.pod:4278 ../src/guestfs-actions.pod:4706
7276 #: ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5558
7277 #: ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:5584
7278 #: ../src/guestfs-actions.pod:6024 ../src/guestfs-actions.pod:6662
7279 #: ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:6914
7280 #: ../src/guestfs-actions.pod:7150
7281 msgid "(Added in 0.8)"
7286 #: ../src/guestfs-actions.pod:469
7287 msgid "guestfs_aug_match"
7292 #: ../src/guestfs-actions.pod:471
7296 " guestfs_aug_match (guestfs_h *g,\n"
7297 " const char *augpath);\n"
7303 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7305 "Returns a list of paths which match the path expression C<path>. The "
7306 "returned paths are sufficiently qualified so that they match exactly one "
7307 "node in the current tree."
7312 #: ../src/guestfs-actions.pod:485
7313 msgid "guestfs_aug_mv"
7318 #: ../src/guestfs-actions.pod:487
7322 " guestfs_aug_mv (guestfs_h *g,\n"
7323 " const char *src,\n"
7324 " const char *dest);\n"
7330 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7332 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7333 "C<dest> is overwritten if it exists."
7338 #: ../src/guestfs-actions.pod:499
7339 msgid "guestfs_aug_rm"
7344 #: ../src/guestfs-actions.pod:501
7348 " guestfs_aug_rm (guestfs_h *g,\n"
7349 " const char *augpath);\n"
7355 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7356 msgid "Remove C<path> and all of its children."
7361 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7362 msgid "On success this returns the number of entries which were removed."
7367 #: ../src/guestfs-actions.pod:513
7368 msgid "guestfs_aug_save"
7373 #: ../src/guestfs-actions.pod:515
7377 " guestfs_aug_save (guestfs_h *g);\n"
7383 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7384 msgid "This writes all pending changes to disk."
7389 #: ../src/guestfs-actions.pod:520
7391 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7397 #: ../src/guestfs-actions.pod:527
7398 msgid "guestfs_aug_set"
7403 #: ../src/guestfs-actions.pod:529
7407 " guestfs_aug_set (guestfs_h *g,\n"
7408 " const char *augpath,\n"
7409 " const char *val);\n"
7415 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7416 msgid "Set the value associated with C<path> to C<val>."
7421 #: ../src/guestfs-actions.pod:536
7423 "In the Augeas API, it is possible to clear a node by setting the value to "
7424 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7425 "this call. Instead you must use the C<guestfs_aug_clear> call."
7430 #: ../src/guestfs-actions.pod:545
7431 msgid "guestfs_available"
7436 #: ../src/guestfs-actions.pod:547
7440 " guestfs_available (guestfs_h *g,\n"
7441 " char *const *groups);\n"
7447 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7449 "This command is used to check the availability of some groups of "
7450 "functionality in the appliance, which not all builds of the libguestfs "
7451 "appliance will be able to provide."
7456 #: ../src/guestfs-actions.pod:555
7458 "The libguestfs groups, and the functions that those groups correspond to, "
7459 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7460 "runtime by calling C<guestfs_available_all_groups>."
7465 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7467 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7468 "\"]> would check for the availability of the Linux inotify functions and "
7469 "Augeas (configuration file editing) functions."
7474 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7475 msgid "The command returns no error if I<all> requested groups are available."
7480 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7482 "It fails with an error if one or more of the requested groups is unavailable "
7488 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7490 "If an unknown group name is included in the list of groups then an error is "
7496 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7502 #: ../src/guestfs-actions.pod:579
7503 msgid "You must call C<guestfs_launch> before calling this function."
7508 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7510 "The reason is because we don't know what groups are supported by the "
7511 "appliance/daemon until it is running and can be queried."
7516 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7518 "If a group of functions is available, this does not necessarily mean that "
7519 "they will work. You still have to check for errors when calling individual "
7520 "API functions even if they are available."
7525 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7527 "It is usually the job of distro packagers to build complete functionality "
7528 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7529 "with all requirements satisfied, will support everything."
7534 #: ../src/guestfs-actions.pod:601
7536 "This call was added in version C<1.0.80>. In previous versions of "
7537 "libguestfs all you could do would be to speculatively execute a command to "
7538 "find out if the daemon implemented it. See also C<guestfs_version>."
7543 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7544 msgid "(Added in 1.0.80)"
7549 #: ../src/guestfs-actions.pod:612
7550 msgid "guestfs_available_all_groups"
7555 #: ../src/guestfs-actions.pod:614
7559 " guestfs_available_all_groups (guestfs_h *g);\n"
7565 #: ../src/guestfs-actions.pod:617
7567 "This command returns a list of all optional groups that this daemon knows "
7568 "about. Note this returns both supported and unsupported groups. To find "
7569 "out which ones the daemon can actually support you have to call "
7570 "C<guestfs_available> on each member of the returned list."
7575 #: ../src/guestfs-actions.pod:623
7576 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7581 #: ../src/guestfs-actions.pod:629
7582 msgid "(Added in 1.3.15)"
7587 #: ../src/guestfs-actions.pod:631
7588 msgid "guestfs_base64_in"
7593 #: ../src/guestfs-actions.pod:633
7597 " guestfs_base64_in (guestfs_h *g,\n"
7598 " const char *base64file,\n"
7599 " const char *filename);\n"
7605 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7607 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7612 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7613 msgid "(Added in 1.3.5)"
7618 #: ../src/guestfs-actions.pod:645
7619 msgid "guestfs_base64_out"
7624 #: ../src/guestfs-actions.pod:647
7628 " guestfs_base64_out (guestfs_h *g,\n"
7629 " const char *filename,\n"
7630 " const char *base64file);\n"
7636 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7638 "This command downloads the contents of C<filename>, writing it out to local "
7639 "file C<base64file> encoded as base64."
7644 #: ../src/guestfs-actions.pod:659
7645 msgid "guestfs_blockdev_flushbufs"
7650 #: ../src/guestfs-actions.pod:661
7654 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7655 " const char *device);\n"
7661 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7663 "This tells the kernel to flush internal buffers associated with C<device>."
7668 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7669 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7670 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7671 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7672 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7673 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7674 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7675 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7676 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7677 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7678 msgid "This uses the L<blockdev(8)> command."
7683 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7684 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7685 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7686 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7687 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7688 msgid "(Added in 0.9.3)"
7693 #: ../src/guestfs-actions.pod:674
7694 msgid "guestfs_blockdev_getbsz"
7699 #: ../src/guestfs-actions.pod:676
7703 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7704 " const char *device);\n"
7710 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7711 msgid "This returns the block size of a device."
7716 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7717 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7719 "(Note this is different from both I<size in blocks> and I<filesystem block "
7725 #: ../src/guestfs-actions.pod:691
7726 msgid "guestfs_blockdev_getro"
7731 #: ../src/guestfs-actions.pod:693
7735 " guestfs_blockdev_getro (guestfs_h *g,\n"
7736 " const char *device);\n"
7742 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7744 "Returns a boolean indicating if the block device is read-only (true if read-"
7745 "only, false if not)."
7750 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1404
7751 #: ../src/guestfs-actions.pod:1419 ../src/guestfs-actions.pod:1909
7752 #: ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:1992
7753 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2062
7754 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110
7755 #: ../src/guestfs-actions.pod:2965 ../src/guestfs-actions.pod:2982
7756 #: ../src/guestfs-actions.pod:3001 ../src/guestfs-actions.pod:3164
7757 #: ../src/guestfs-actions.pod:3178 ../src/guestfs-actions.pod:3193
7758 #: ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:3223
7759 #: ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3254
7760 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3281
7761 #: ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3310
7762 #: ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:4851
7763 msgid "This function returns a C truth value on success or -1 on error."
7768 #: ../src/guestfs-actions.pod:706
7769 msgid "guestfs_blockdev_getsize64"
7774 #: ../src/guestfs-actions.pod:708
7778 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7779 " const char *device);\n"
7785 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7786 msgid "This returns the size of the device in bytes."
7791 #: ../src/guestfs-actions.pod:714
7792 msgid "See also C<guestfs_blockdev_getsz>."
7797 #: ../src/guestfs-actions.pod:722
7798 msgid "guestfs_blockdev_getss"
7803 #: ../src/guestfs-actions.pod:724
7807 " guestfs_blockdev_getss (guestfs_h *g,\n"
7808 " const char *device);\n"
7814 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7816 "This returns the size of sectors on a block device. Usually 512, but can be "
7817 "larger for modern devices."
7822 #: ../src/guestfs-actions.pod:731
7824 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7830 #: ../src/guestfs-actions.pod:740
7831 msgid "guestfs_blockdev_getsz"
7836 #: ../src/guestfs-actions.pod:742
7840 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7841 " const char *device);\n"
7847 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7849 "This returns the size of the device in units of 512-byte sectors (even if "
7850 "the sectorsize isn't 512 bytes ... weird)."
7855 #: ../src/guestfs-actions.pod:749
7857 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7858 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7863 #: ../src/guestfs-actions.pod:759
7864 msgid "guestfs_blockdev_rereadpt"
7869 #: ../src/guestfs-actions.pod:761
7873 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7874 " const char *device);\n"
7880 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7881 msgid "Reread the partition table on C<device>."
7886 #: ../src/guestfs-actions.pod:773
7887 msgid "guestfs_blockdev_setbsz"
7892 #: ../src/guestfs-actions.pod:775
7896 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7897 " const char *device,\n"
7898 " int blocksize);\n"
7904 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7905 msgid "This sets the block size of a device."
7910 #: ../src/guestfs-actions.pod:791
7911 msgid "guestfs_blockdev_setro"
7916 #: ../src/guestfs-actions.pod:793
7920 " guestfs_blockdev_setro (guestfs_h *g,\n"
7921 " const char *device);\n"
7927 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7928 msgid "Sets the block device named C<device> to read-only."
7933 #: ../src/guestfs-actions.pod:805
7934 msgid "guestfs_blockdev_setrw"
7939 #: ../src/guestfs-actions.pod:807
7943 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7944 " const char *device);\n"
7950 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7951 msgid "Sets the block device named C<device> to read-write."
7956 #: ../src/guestfs-actions.pod:819
7957 msgid "guestfs_case_sensitive_path"
7962 #: ../src/guestfs-actions.pod:821
7966 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7967 " const char *path);\n"
7973 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7975 "This can be used to resolve case insensitive paths on a filesystem which is "
7976 "case sensitive. The use case is to resolve paths which you have read from "
7977 "Windows configuration files or the Windows Registry, to the true path."
7982 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7984 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7985 "(and probably others), which is that although the underlying filesystem is "
7986 "case-insensitive, the driver exports the filesystem to Linux as case-"
7992 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7994 "One consequence of this is that special directories such as C<c:\\windows> "
7995 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7996 "precise details of how they were created. In Windows itself this would not "
8002 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8004 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8010 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8012 "This function resolves the true case of each element in the path and returns "
8013 "the case-sensitive path."
8018 #: ../src/guestfs-actions.pod:847
8020 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8021 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8022 "how the directories were originally created under Windows)."
8027 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8028 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8033 #: ../src/guestfs-actions.pod:855
8034 msgid "See also C<guestfs_realpath>."
8039 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6842
8040 msgid "(Added in 1.0.75)"
8045 #: ../src/guestfs-actions.pod:862
8051 #: ../src/guestfs-actions.pod:864
8055 " guestfs_cat (guestfs_h *g,\n"
8056 " const char *path);\n"
8062 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5338
8063 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3567
8064 msgid "Return the contents of the file named C<path>."
8069 #: ../src/guestfs-actions.pod:870
8071 "Note that this function cannot correctly handle binary files (specifically, "
8072 "files containing C<\\0> character which is treated as end of string). For "
8073 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8074 "functions which have a more complex interface."
8079 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8080 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1368
8081 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1490
8082 #: ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:1758
8083 #: ../src/guestfs-actions.pod:2216 ../src/guestfs-actions.pod:2235
8084 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:2302
8085 #: ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:2348
8086 #: ../src/guestfs-actions.pod:5120 ../src/guestfs-actions.pod:5146
8087 #: ../src/guestfs-actions.pod:5277 ../src/guestfs-actions.pod:5303
8088 #: ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:6227
8089 #: ../src/guestfs-actions.pod:6282 ../src/guestfs-actions.pod:6428
8090 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:7114
8091 #: ../src/guestfs-actions.pod:7140 ../src/guestfs-actions.pod:7166
8092 #: ../src/guestfs-actions.pod:7185 ../src/guestfs-actions.pod:7270
8093 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7335
8094 #: ../src/guestfs-actions.pod:7354 ../fish/guestfish-actions.pod:587
8095 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8096 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8097 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8098 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8099 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8100 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8101 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3437
8102 #: ../fish/guestfish-actions.pod:3452 ../fish/guestfish-actions.pod:3528
8103 #: ../fish/guestfish-actions.pod:3545 ../fish/guestfish-actions.pod:3560
8104 #: ../fish/guestfish-actions.pod:4186 ../fish/guestfish-actions.pod:4232
8105 #: ../fish/guestfish-actions.pod:4317 ../fish/guestfish-actions.pod:4332
8106 #: ../fish/guestfish-actions.pod:4742 ../fish/guestfish-actions.pod:4760
8107 #: ../fish/guestfish-actions.pod:4777 ../fish/guestfish-actions.pod:4787
8108 #: ../fish/guestfish-actions.pod:4835 ../fish/guestfish-actions.pod:4845
8109 #: ../fish/guestfish-actions.pod:4874 ../fish/guestfish-actions.pod:4884
8111 "Because of the message protocol, there is a transfer limit of somewhere "
8112 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8117 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3436
8118 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3515
8119 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:4008
8120 #: ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:5226
8121 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:7001
8122 #: ../src/guestfs-actions.pod:7015
8123 msgid "(Added in 0.4)"
8128 #: ../src/guestfs-actions.pod:883
8129 msgid "guestfs_checksum"
8134 #: ../src/guestfs-actions.pod:885
8138 " guestfs_checksum (guestfs_h *g,\n"
8139 " const char *csumtype,\n"
8140 " const char *path);\n"
8146 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8148 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8153 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8155 "The type of checksum to compute is given by the C<csumtype> parameter which "
8156 "must have one of the following values:"
8161 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8167 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8169 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8175 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8181 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8182 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8187 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8193 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8194 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8199 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8205 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8206 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8211 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8217 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8218 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8223 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8229 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8230 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8235 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8241 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8242 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8247 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8248 msgid "The checksum is returned as a printable string."
8253 #: ../src/guestfs-actions.pod:931
8254 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8259 #: ../src/guestfs-actions.pod:933
8260 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8265 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8266 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:3180
8267 #: ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3270
8268 #: ../src/guestfs-actions.pod:3297 ../src/guestfs-actions.pod:6698
8269 msgid "(Added in 1.0.2)"
8274 #: ../src/guestfs-actions.pod:940
8275 msgid "guestfs_checksum_device"
8280 #: ../src/guestfs-actions.pod:942
8284 " guestfs_checksum_device (guestfs_h *g,\n"
8285 " const char *csumtype,\n"
8286 " const char *device);\n"
8292 #: ../src/guestfs-actions.pod:947
8294 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8295 "device named C<device>. For the types of checksums supported see the "
8296 "C<guestfs_checksum> command."
8301 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4757
8302 #: ../src/guestfs-actions.pod:4816 ../src/guestfs-actions.pod:4853
8303 #: ../src/guestfs-actions.pod:4871 ../src/guestfs-actions.pod:5047
8304 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6621
8305 #: ../src/guestfs-actions.pod:7027
8306 msgid "(Added in 1.3.2)"
8311 #: ../src/guestfs-actions.pod:956
8312 msgid "guestfs_checksums_out"
8317 #: ../src/guestfs-actions.pod:958
8321 " guestfs_checksums_out (guestfs_h *g,\n"
8322 " const char *csumtype,\n"
8323 " const char *directory,\n"
8324 " const char *sumsfile);\n"
8330 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8332 "This command computes the checksums of all regular files in C<directory> and "
8333 "then emits a list of those checksums to the local output file C<sumsfile>."
8338 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8340 "This can be used for verifying the integrity of a virtual machine. However "
8341 "to be properly secure you should pay attention to the output of the checksum "
8342 "command (it uses the ones from GNU coreutils). In particular when the "
8343 "filename is not printable, coreutils uses a special backslash syntax. For "
8344 "more information, see the GNU coreutils info file."
8349 #: ../src/guestfs-actions.pod:978
8350 msgid "(Added in 1.3.7)"
8355 #: ../src/guestfs-actions.pod:980
8356 msgid "guestfs_chmod"
8361 #: ../src/guestfs-actions.pod:982
8365 " guestfs_chmod (guestfs_h *g,\n"
8367 " const char *path);\n"
8373 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8375 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8381 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8383 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8384 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8390 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4259
8391 #: ../src/guestfs-actions.pod:4456 ../src/guestfs-actions.pod:4475
8392 #: ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:676
8393 #: ../fish/guestfish-actions.pod:2883 ../fish/guestfish-actions.pod:3012
8394 #: ../fish/guestfish-actions.pod:3022 ../fish/guestfish-actions.pod:3032
8395 msgid "The mode actually set is affected by the umask."
8400 #: ../src/guestfs-actions.pod:1000
8401 msgid "guestfs_chown"
8406 #: ../src/guestfs-actions.pod:1002
8410 " guestfs_chown (guestfs_h *g,\n"
8413 " const char *path);\n"
8419 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8420 msgid "Change the file owner to C<owner> and group to C<group>."
8425 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3367
8426 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2341
8428 "Only numeric uid and gid are supported. If you want to use names, you will "
8429 "need to locate and parse the password file yourself (Augeas support makes "
8430 "this relatively easy)."
8435 #: ../src/guestfs-actions.pod:1018
8436 msgid "guestfs_command"
8441 #: ../src/guestfs-actions.pod:1020
8445 " guestfs_command (guestfs_h *g,\n"
8446 " char *const *arguments);\n"
8452 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8454 "This call runs a command from the guest filesystem. The filesystem must be "
8455 "mounted, and must contain a compatible operating system (ie. something "
8456 "Linux, with the same or compatible processor architecture)."
8461 #: ../src/guestfs-actions.pod:1029
8463 "The single parameter is an argv-style list of arguments. The first element "
8464 "is the name of the program to run. Subsequent elements are parameters. The "
8465 "list must be non-empty (ie. must contain a program name). Note that the "
8466 "command runs directly, and is I<not> invoked via the shell (see "
8472 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8473 msgid "The return value is anything printed to I<stdout> by the command."
8478 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8480 "If the command returns a non-zero exit status, then this function returns an "
8481 "error message. The error message string is the content of I<stderr> from "
8487 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8489 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8490 "bin>. If you require a program from another location, you should provide "
8491 "the full path in the first parameter."
8496 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8498 "Shared libraries and data files required by the program must be available on "
8499 "filesystems which are mounted in the correct places. It is the caller's "
8500 "responsibility to ensure all filesystems that are needed are mounted at the "
8506 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8507 #: ../src/guestfs-actions.pod:1543
8508 msgid "(Added in 0.9.1)"
8513 #: ../src/guestfs-actions.pod:1062
8514 msgid "guestfs_command_lines"
8519 #: ../src/guestfs-actions.pod:1064
8523 " guestfs_command_lines (guestfs_h *g,\n"
8524 " char *const *arguments);\n"
8530 #: ../src/guestfs-actions.pod:1068
8532 "This is the same as C<guestfs_command>, but splits the result into a list of "
8538 #: ../src/guestfs-actions.pod:1071
8539 msgid "See also: C<guestfs_sh_lines>"
8544 #: ../src/guestfs-actions.pod:1082
8545 msgid "guestfs_config"
8550 #: ../src/guestfs-actions.pod:1084
8554 " guestfs_config (guestfs_h *g,\n"
8555 " const char *qemuparam,\n"
8556 " const char *qemuvalue);\n"
8562 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8564 "This can be used to add arbitrary qemu command line parameters of the form "
8565 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8566 "setting some parameters which would interfere with parameters that we use."
8571 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8572 msgid "The first character of C<param> string must be a C<-> (dash)."
8577 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8578 msgid "C<value> can be NULL."
8583 #: ../src/guestfs-actions.pod:1102
8584 msgid "guestfs_copy_size"
8589 #: ../src/guestfs-actions.pod:1104
8593 " guestfs_copy_size (guestfs_h *g,\n"
8594 " const char *src,\n"
8595 " const char *dest,\n"
8602 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8604 "This command copies exactly C<size> bytes from one source device or file "
8605 "C<src> to another destination device or file C<dest>."
8610 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8612 "Note this will fail if the source is too short or if the destination is not "
8618 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8619 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1692
8620 #: ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:6693
8621 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:7206
8622 #: ../src/guestfs-actions.pod:7225
8624 "This long-running command can generate progress notification messages so "
8625 "that the caller can display a progress bar or indicator. To receive these "
8626 "messages, the caller must register a progress callback. See L<guestfs(3)/"
8627 "guestfs_set_progress_callback>."
8632 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4035
8633 #: ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:6934
8634 #: ../src/guestfs-actions.pod:6954 ../src/guestfs-actions.pod:7040
8635 msgid "(Added in 1.0.87)"
8640 #: ../src/guestfs-actions.pod:1125
8646 #: ../src/guestfs-actions.pod:1127
8650 " guestfs_cp (guestfs_h *g,\n"
8651 " const char *src,\n"
8652 " const char *dest);\n"
8658 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8660 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8661 "destination filename or destination directory."
8666 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8667 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8668 #: ../src/guestfs-actions.pod:1406 ../src/guestfs-actions.pod:4720
8669 #: ../src/guestfs-actions.pod:5097
8670 msgid "(Added in 1.0.18)"
8675 #: ../src/guestfs-actions.pod:1139
8676 msgid "guestfs_cp_a"
8681 #: ../src/guestfs-actions.pod:1141
8685 " guestfs_cp_a (guestfs_h *g,\n"
8686 " const char *src,\n"
8687 " const char *dest);\n"
8693 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8695 "This copies a file or directory from C<src> to C<dest> recursively using the "
8701 #: ../src/guestfs-actions.pod:1153
8707 #: ../src/guestfs-actions.pod:1155
8711 " guestfs_dd (guestfs_h *g,\n"
8712 " const char *src,\n"
8713 " const char *dest);\n"
8719 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8721 "This command copies from one source device or file C<src> to another "
8722 "destination device or file C<dest>. Normally you would use this to copy to "
8723 "or from a device or partition, for example to duplicate a filesystem."
8728 #: ../src/guestfs-actions.pod:1165
8730 "If the destination is a device, it must be as large or larger than the "
8731 "source file or device, otherwise the copy will fail. This command cannot do "
8732 "partial copies (see C<guestfs_copy_size>)."
8737 #: ../src/guestfs-actions.pod:1173
8743 #: ../src/guestfs-actions.pod:1175
8747 " guestfs_df (guestfs_h *g);\n"
8753 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8754 msgid "This command runs the C<df> command to report disk space used."
8759 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8761 "This command is mostly useful for interactive sessions. It is I<not> "
8762 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8768 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8769 #: ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:2281
8770 #: ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2373
8771 #: ../src/guestfs-actions.pod:4145 ../src/guestfs-actions.pod:4620
8772 #: ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6455
8773 #: ../src/guestfs-actions.pod:7073 ../src/guestfs-actions.pod:7086
8774 #: ../src/guestfs-actions.pod:7099
8775 msgid "(Added in 1.0.54)"
8780 #: ../src/guestfs-actions.pod:1189
8781 msgid "guestfs_df_h"
8786 #: ../src/guestfs-actions.pod:1191
8790 " guestfs_df_h (guestfs_h *g);\n"
8796 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8798 "This command runs the C<df -h> command to report disk space used in human-"
8804 #: ../src/guestfs-actions.pod:1206
8805 msgid "guestfs_dmesg"
8810 #: ../src/guestfs-actions.pod:1208
8814 " guestfs_dmesg (guestfs_h *g);\n"
8820 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8822 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8823 "This is sometimes useful for extended debugging of problems."
8828 #: ../src/guestfs-actions.pod:1215
8830 "Another way to get the same information is to enable verbose messages with "
8831 "C<guestfs_set_verbose> or by setting the environment variable "
8832 "C<LIBGUESTFS_DEBUG=1> before running the program."
8837 #: ../src/guestfs-actions.pod:1225
8838 msgid "guestfs_download"
8843 #: ../src/guestfs-actions.pod:1227
8847 " guestfs_download (guestfs_h *g,\n"
8848 " const char *remotefilename,\n"
8849 " const char *filename);\n"
8855 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8856 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8858 "Download file C<remotefilename> and save it as C<filename> on the local "
8864 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6687
8865 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4490
8866 msgid "C<filename> can also be a named pipe."
8871 #: ../src/guestfs-actions.pod:1237
8872 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8877 #: ../src/guestfs-actions.pod:1248
8878 msgid "guestfs_download_offset"
8883 #: ../src/guestfs-actions.pod:1250
8887 " guestfs_download_offset (guestfs_h *g,\n"
8888 " const char *remotefilename,\n"
8889 " const char *filename,\n"
8890 " int64_t offset,\n"
8897 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8899 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8900 "region must be within the file or device)."
8905 #: ../src/guestfs-actions.pod:1263
8907 "Note that there is no limit on the amount of data that can be downloaded "
8908 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8909 "full amount unless an error occurs."
8914 #: ../src/guestfs-actions.pod:1268
8915 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8920 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6732
8921 msgid "(Added in 1.5.17)"
8926 #: ../src/guestfs-actions.pod:1279
8927 msgid "guestfs_drop_caches"
8932 #: ../src/guestfs-actions.pod:1281
8936 " guestfs_drop_caches (guestfs_h *g,\n"
8937 " int whattodrop);\n"
8943 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8945 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8946 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8947 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8952 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8953 msgid "Setting C<whattodrop> to 3 should drop everything."
8958 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8960 "This automatically calls L<sync(2)> before the operation, so that the "
8961 "maximum guest memory is freed."
8966 #: ../src/guestfs-actions.pod:1299
8972 #: ../src/guestfs-actions.pod:1301
8976 " guestfs_du (guestfs_h *g,\n"
8977 " const char *path);\n"
8983 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8985 "This command runs the C<du -s> command to estimate file space usage for "
8991 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8993 "C<path> can be a file or a directory. If C<path> is a directory then the "
8994 "estimate includes the contents of the directory and all subdirectories "
9000 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
9002 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9007 #: ../src/guestfs-actions.pod:1319
9008 msgid "guestfs_e2fsck_f"
9013 #: ../src/guestfs-actions.pod:1321
9017 " guestfs_e2fsck_f (guestfs_h *g,\n"
9018 " const char *device);\n"
9024 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:885
9026 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9027 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
9033 #: ../src/guestfs-actions.pod:1329
9035 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9036 "Normally you should use C<guestfs_fsck>."
9041 #: ../src/guestfs-actions.pod:1334
9042 msgid "(Added in 1.0.29)"
9047 #: ../src/guestfs-actions.pod:1336
9048 msgid "guestfs_echo_daemon"
9053 #: ../src/guestfs-actions.pod:1338
9057 " guestfs_echo_daemon (guestfs_h *g,\n"
9058 " char *const *words);\n"
9064 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:896
9066 "This command concatenates the list of C<words> passed with single spaces "
9067 "between them and returns the resulting string."
9072 #: ../src/guestfs-actions.pod:1345 ../fish/guestfish-actions.pod:899
9073 msgid "You can use this command to test the connection through to the daemon."
9078 #: ../src/guestfs-actions.pod:1347
9079 msgid "See also C<guestfs_ping_daemon>."
9084 #: ../src/guestfs-actions.pod:1352 ../src/guestfs-actions.pod:2089
9085 #: ../src/guestfs-actions.pod:5931
9086 msgid "(Added in 1.0.69)"
9091 #: ../src/guestfs-actions.pod:1354
9092 msgid "guestfs_egrep"
9097 #: ../src/guestfs-actions.pod:1356
9101 " guestfs_egrep (guestfs_h *g,\n"
9102 " const char *regex,\n"
9103 " const char *path);\n"
9109 #: ../src/guestfs-actions.pod:1361 ../fish/guestfish-actions.pod:907
9111 "This calls the external C<egrep> program and returns the matching lines."
9116 #: ../src/guestfs-actions.pod:1371 ../src/guestfs-actions.pod:1390
9117 #: ../src/guestfs-actions.pod:1447 ../src/guestfs-actions.pod:1493
9118 #: ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:2219
9119 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2394
9120 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2422
9121 #: ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2490
9122 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3528
9123 #: ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:3555
9124 #: ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:4555
9125 #: ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5480
9126 #: ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:6311
9127 #: ../src/guestfs-actions.pod:6324 ../src/guestfs-actions.pod:6337
9128 #: ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6372
9129 #: ../src/guestfs-actions.pod:6385 ../src/guestfs-actions.pod:6398
9130 #: ../src/guestfs-actions.pod:7169 ../src/guestfs-actions.pod:7188
9131 #: ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7292
9132 #: ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7357
9133 msgid "(Added in 1.0.66)"
9138 #: ../src/guestfs-actions.pod:1373
9139 msgid "guestfs_egrepi"
9144 #: ../src/guestfs-actions.pod:1375
9148 " guestfs_egrepi (guestfs_h *g,\n"
9149 " const char *regex,\n"
9150 " const char *path);\n"
9156 #: ../src/guestfs-actions.pod:1380 ../fish/guestfish-actions.pod:917
9158 "This calls the external C<egrep -i> program and returns the matching lines."
9163 #: ../src/guestfs-actions.pod:1392
9164 msgid "guestfs_equal"
9169 #: ../src/guestfs-actions.pod:1394
9173 " guestfs_equal (guestfs_h *g,\n"
9174 " const char *file1,\n"
9175 " const char *file2);\n"
9181 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:927
9183 "This compares the two files C<file1> and C<file2> and returns true if their "
9184 "content is exactly equal, or false otherwise."
9189 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:930
9190 msgid "The external L<cmp(1)> program is used for the comparison."
9195 #: ../src/guestfs-actions.pod:1408
9196 msgid "guestfs_exists"
9201 #: ../src/guestfs-actions.pod:1410
9205 " guestfs_exists (guestfs_h *g,\n"
9206 " const char *path);\n"
9212 #: ../src/guestfs-actions.pod:1414 ../fish/guestfish-actions.pod:936
9214 "This returns C<true> if and only if there is a file, directory (or anything) "
9215 "with the given C<path> name."
9220 #: ../src/guestfs-actions.pod:1417
9221 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9226 #: ../src/guestfs-actions.pod:1423
9227 msgid "guestfs_fallocate"
9232 #: ../src/guestfs-actions.pod:1425
9236 " guestfs_fallocate (guestfs_h *g,\n"
9237 " const char *path,\n"
9244 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1456
9245 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9247 "This command preallocates a file (containing zero bytes) named C<path> of "
9248 "size C<len> bytes. If the file exists already, it is overwritten."
9253 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:949
9255 "Do not confuse this with the guestfish-specific C<alloc> command which "
9256 "allocates a file in the host and attaches it as a device."
9261 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:953
9263 "This function is deprecated. In new code, use the C<fallocate64> call "
9269 #: ../src/guestfs-actions.pod:1449
9270 msgid "guestfs_fallocate64"
9275 #: ../src/guestfs-actions.pod:1451
9279 " guestfs_fallocate64 (guestfs_h *g,\n"
9280 " const char *path,\n"
9287 #: ../src/guestfs-actions.pod:1460
9289 "Note that this call allocates disk blocks for the file. To create a sparse "
9290 "file use C<guestfs_truncate_size> instead."
9295 #: ../src/guestfs-actions.pod:1463
9297 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9298 "oversight it only allowed 30 bit lengths to be specified, effectively "
9299 "limiting the maximum size of files created through that call to 1GB."
9304 #: ../src/guestfs-actions.pod:1468 ../fish/guestfish-actions.pod:976
9306 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9307 "commands which create a file in the host and attach it as a device."
9312 #: ../src/guestfs-actions.pod:1474
9313 msgid "(Added in 1.3.17)"
9318 #: ../src/guestfs-actions.pod:1476
9319 msgid "guestfs_fgrep"
9324 #: ../src/guestfs-actions.pod:1478
9328 " guestfs_fgrep (guestfs_h *g,\n"
9329 " const char *pattern,\n"
9330 " const char *path);\n"
9336 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:984
9338 "This calls the external C<fgrep> program and returns the matching lines."
9343 #: ../src/guestfs-actions.pod:1495
9344 msgid "guestfs_fgrepi"
9349 #: ../src/guestfs-actions.pod:1497
9353 " guestfs_fgrepi (guestfs_h *g,\n"
9354 " const char *pattern,\n"
9355 " const char *path);\n"
9361 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:994
9363 "This calls the external C<fgrep -i> program and returns the matching lines."
9368 #: ../src/guestfs-actions.pod:1514
9369 msgid "guestfs_file"
9374 #: ../src/guestfs-actions.pod:1516
9378 " guestfs_file (guestfs_h *g,\n"
9379 " const char *path);\n"
9385 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1004
9387 "This call uses the standard L<file(1)> command to determine the type or "
9388 "contents of the file."
9393 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1007
9395 "This call will also transparently look inside various types of compressed "
9401 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1010
9403 "The exact command which runs is C<file -zb path>. Note in particular that "
9404 "the filename is not prepended to the output (the C<-b> option)."
9409 #: ../src/guestfs-actions.pod:1530
9411 "This command can also be used on C</dev/> devices (and partitions, LV "
9412 "names). You can for example use this to determine if a device contains a "
9413 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9418 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1019
9420 "If the C<path> does not begin with C</dev/> then this command only works for "
9421 "the content of regular files. For other file types (directory, symbolic "
9422 "link etc) it will just return the string C<directory> etc."
9427 #: ../src/guestfs-actions.pod:1545
9428 msgid "guestfs_file_architecture"
9433 #: ../src/guestfs-actions.pod:1547
9437 " guestfs_file_architecture (guestfs_h *g,\n"
9438 " const char *filename);\n"
9444 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1028
9446 "This detects the architecture of the binary C<filename>, and returns it if "
9452 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1031
9453 msgid "Currently defined architectures are:"
9458 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1035
9464 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1037
9466 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9467 "irrespective of the precise processor requirements of the binary."
9472 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1040
9478 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1042
9479 msgid "64 bit x86-64."
9484 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1044
9490 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1046
9491 msgid "32 bit SPARC."
9496 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1048
9502 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1050
9503 msgid "64 bit SPARC V9 and above."
9508 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1052
9514 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1054
9515 msgid "Intel Itanium."
9520 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1056
9526 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1058
9527 msgid "32 bit Power PC."
9532 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1060
9538 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1062
9539 msgid "64 bit Power PC."
9544 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1066
9545 msgid "Libguestfs may return other architecture strings in future."
9550 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1068
9551 msgid "The function works on at least the following types of files:"
9556 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1074
9557 msgid "many types of Un*x and Linux binary"
9562 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1078
9563 msgid "many types of Un*x and Linux shared library"
9568 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1082
9569 msgid "Windows Win32 and Win64 binaries"
9574 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1086
9575 msgid "Windows Win32 and Win64 DLLs"
9580 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1088
9581 msgid "Win32 binaries and DLLs return C<i386>."
9586 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1090
9587 msgid "Win64 binaries and DLLs return C<x86_64>."
9592 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1094
9593 msgid "Linux kernel modules"
9598 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1098
9599 msgid "Linux new-style initrd images"
9604 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1102
9605 msgid "some non-x86 Linux vmlinuz kernels"
9610 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1106
9611 msgid "What it can't do currently:"
9616 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1112
9617 msgid "static libraries (libfoo.a)"
9622 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1116
9623 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9628 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1120
9629 msgid "x86 Linux vmlinuz kernels"
9634 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1122
9636 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9637 "compressed code, and are horribly hard to unpack. If you want to find the "
9638 "architecture of a kernel, use the architecture of the associated initrd or "
9639 "kernel module(s) instead."
9644 #: ../src/guestfs-actions.pod:1655 ../src/guestfs-actions.pod:1818
9645 #: ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:2526
9646 #: ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2633
9647 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2742
9648 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2863
9649 #: ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:3151
9650 #: ../src/guestfs-actions.pod:3283
9651 msgid "(Added in 1.5.3)"
9656 #: ../src/guestfs-actions.pod:1657
9657 msgid "guestfs_filesize"
9662 #: ../src/guestfs-actions.pod:1659
9666 " guestfs_filesize (guestfs_h *g,\n"
9667 " const char *file);\n"
9673 #: ../src/guestfs-actions.pod:1663 ../fish/guestfish-actions.pod:1133
9674 msgid "This command returns the size of C<file> in bytes."
9679 #: ../src/guestfs-actions.pod:1665
9681 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9682 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9683 "devices, use C<guestfs_blockdev_getsize64>."
9688 #: ../src/guestfs-actions.pod:1671
9689 msgid "(Added in 1.0.82)"
9694 #: ../src/guestfs-actions.pod:1673
9695 msgid "guestfs_fill"
9700 #: ../src/guestfs-actions.pod:1675
9704 " guestfs_fill (guestfs_h *g,\n"
9707 " const char *path);\n"
9713 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1143
9715 "This command creates a new file called C<path>. The initial content of the "
9716 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9722 #: ../src/guestfs-actions.pod:1685
9724 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9725 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9726 "bytes use C<guestfs_fill_pattern>."
9731 #: ../src/guestfs-actions.pod:1697
9732 msgid "(Added in 1.0.79)"
9737 #: ../src/guestfs-actions.pod:1699
9738 msgid "guestfs_fill_pattern"
9743 #: ../src/guestfs-actions.pod:1701
9747 " guestfs_fill_pattern (guestfs_h *g,\n"
9748 " const char *pattern,\n"
9750 " const char *path);\n"
9756 #: ../src/guestfs-actions.pod:1707
9758 "This function is like C<guestfs_fill> except that it creates a new file of "
9759 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9760 "pattern is truncated if necessary to ensure the length of the file is "
9761 "exactly C<len> bytes."
9766 #: ../src/guestfs-actions.pod:1719
9767 msgid "(Added in 1.3.12)"
9772 #: ../src/guestfs-actions.pod:1721
9773 msgid "guestfs_find"
9778 #: ../src/guestfs-actions.pod:1723
9782 " guestfs_find (guestfs_h *g,\n"
9783 " const char *directory);\n"
9789 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1165
9791 "This command lists out all files and directories, recursively, starting at "
9792 "C<directory>. It is essentially equivalent to running the shell command "
9793 "C<find directory -print> but some post-processing happens on the output, "
9799 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1170
9801 "This returns a list of strings I<without any prefix>. Thus if the directory "
9807 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1173
9818 #: ../src/guestfs-actions.pod:1739
9820 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9825 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1180
9837 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1185
9838 msgid "If C<directory> is not a directory, then this command returns an error."
9843 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1188
9844 msgid "The returned list is sorted."
9849 #: ../src/guestfs-actions.pod:1752
9850 msgid "See also C<guestfs_find0>."
9855 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:3972
9856 #: ../src/guestfs-actions.pod:5515
9857 msgid "(Added in 1.0.27)"
9862 #: ../src/guestfs-actions.pod:1763
9863 msgid "guestfs_find0"
9868 #: ../src/guestfs-actions.pod:1765
9872 " guestfs_find0 (guestfs_h *g,\n"
9873 " const char *directory,\n"
9874 " const char *files);\n"
9880 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1199
9882 "This command lists out all files and directories, recursively, starting at "
9883 "C<directory>, placing the resulting list in the external file called "
9889 #: ../src/guestfs-actions.pod:1774
9891 "This command works the same way as C<guestfs_find> with the following "
9897 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1210
9898 msgid "The resulting list is written to an external file."
9903 #: ../src/guestfs-actions.pod:1785 ../fish/guestfish-actions.pod:1214
9905 "Items (filenames) in the result are separated by C<\\0> characters. See "
9906 "L<find(1)> option I<-print0>."
9911 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1219
9912 msgid "This command is not limited in the number of names that it can return."
9917 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1224
9918 msgid "The result list is not sorted."
9923 #: ../src/guestfs-actions.pod:1801
9924 msgid "(Added in 1.0.74)"
9929 #: ../src/guestfs-actions.pod:1803
9930 msgid "guestfs_findfs_label"
9935 #: ../src/guestfs-actions.pod:1805
9939 " guestfs_findfs_label (guestfs_h *g,\n"
9940 " const char *label);\n"
9946 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1234
9948 "This command searches the filesystems and returns the one which has the "
9949 "given label. An error is returned if no such filesystem can be found."
9954 #: ../src/guestfs-actions.pod:1813
9955 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9960 #: ../src/guestfs-actions.pod:1820
9961 msgid "guestfs_findfs_uuid"
9966 #: ../src/guestfs-actions.pod:1822
9970 " guestfs_findfs_uuid (guestfs_h *g,\n"
9971 " const char *uuid);\n"
9977 #: ../src/guestfs-actions.pod:1826 ../fish/guestfish-actions.pod:1244
9979 "This command searches the filesystems and returns the one which has the "
9980 "given UUID. An error is returned if no such filesystem can be found."
9985 #: ../src/guestfs-actions.pod:1830
9986 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9991 #: ../src/guestfs-actions.pod:1837
9992 msgid "guestfs_fsck"
9997 #: ../src/guestfs-actions.pod:1839
10001 " guestfs_fsck (guestfs_h *g,\n"
10002 " const char *fstype,\n"
10003 " const char *device);\n"
10009 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1254
10011 "This runs the filesystem checker (fsck) on C<device> which should have "
10012 "filesystem type C<fstype>."
10017 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1257
10019 "The returned integer is the status. See L<fsck(8)> for the list of status "
10020 "codes from C<fsck>."
10025 #: ../src/guestfs-actions.pod:1856 ../fish/guestfish-actions.pod:1266
10026 msgid "Multiple status codes can be summed together."
10031 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1270
10033 "A non-zero return code can mean \"success\", for example if errors have been "
10034 "corrected on the filesystem."
10039 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1275
10040 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10045 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1280
10047 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10052 #: ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:7211
10053 msgid "(Added in 1.0.16)"
10058 #: ../src/guestfs-actions.pod:1876
10059 msgid "guestfs_get_append"
10064 #: ../src/guestfs-actions.pod:1878
10068 " guestfs_get_append (guestfs_h *g);\n"
10074 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1286
10076 "Return the additional kernel options which are added to the guest kernel "
10082 #: ../src/guestfs-actions.pod:1884 ../fish/guestfish-actions.pod:1289
10083 msgid "If C<NULL> then no options are added."
10088 #: ../src/guestfs-actions.pod:1886
10090 "This function returns a string which may be NULL. There is no way to return "
10091 "an error from this function. The string is owned by the guest handle and "
10092 "must I<not> be freed."
10097 #: ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:5193
10098 #: ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:6073
10099 #: ../src/guestfs-actions.pod:6092 ../src/guestfs-actions.pod:6108
10100 #: ../src/guestfs-actions.pod:6125 ../src/guestfs-actions.pod:6882
10101 #: ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:7254
10102 msgid "(Added in 1.0.26)"
10106 #: ../src/guestfs-actions.pod:1892
10107 msgid "guestfs_get_attach_method"
10111 #: ../src/guestfs-actions.pod:1894
10115 " guestfs_get_attach_method (guestfs_h *g);\n"
10120 #: ../src/guestfs-actions.pod:1897
10121 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10126 #: ../src/guestfs-actions.pod:1902
10127 msgid "guestfs_get_autosync"
10132 #: ../src/guestfs-actions.pod:1904
10136 " guestfs_get_autosync (guestfs_h *g);\n"
10142 #: ../src/guestfs-actions.pod:1907 ../fish/guestfish-actions.pod:1301
10143 msgid "Get the autosync flag."
10148 #: ../src/guestfs-actions.pod:1913
10149 msgid "guestfs_get_direct"
10154 #: ../src/guestfs-actions.pod:1915
10158 " guestfs_get_direct (guestfs_h *g);\n"
10164 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1307
10165 msgid "Return the direct appliance mode flag."
10170 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:5742
10171 msgid "(Added in 1.0.72)"
10176 #: ../src/guestfs-actions.pod:1924
10177 msgid "guestfs_get_e2label"
10182 #: ../src/guestfs-actions.pod:1926
10186 " guestfs_get_e2label (guestfs_h *g,\n"
10187 " const char *device);\n"
10193 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1313
10195 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10200 #: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1316
10202 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10207 #: ../src/guestfs-actions.pod:1943 ../src/guestfs-actions.pod:1964
10208 #: ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:5779
10209 msgid "(Added in 1.0.15)"
10214 #: ../src/guestfs-actions.pod:1945
10215 msgid "guestfs_get_e2uuid"
10220 #: ../src/guestfs-actions.pod:1947
10224 " guestfs_get_e2uuid (guestfs_h *g,\n"
10225 " const char *device);\n"
10231 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1327
10233 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10238 #: ../src/guestfs-actions.pod:1957 ../fish/guestfish-actions.pod:1330
10240 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10245 #: ../src/guestfs-actions.pod:1966
10246 msgid "guestfs_get_memsize"
10251 #: ../src/guestfs-actions.pod:1968
10255 " guestfs_get_memsize (guestfs_h *g);\n"
10261 #: ../src/guestfs-actions.pod:1971 ../fish/guestfish-actions.pod:1341
10263 "This gets the memory size in megabytes allocated to the qemu subprocess."
10268 #: ../src/guestfs-actions.pod:1974
10270 "If C<guestfs_set_memsize> was not called on this handle, and if "
10271 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10272 "value for memsize."
10277 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2059
10278 #: ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:5902
10279 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10280 #: ../fish/guestfish-actions.pod:3893 ../fish/guestfish-actions.pod:3980
10282 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10287 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:4263
10288 #: ../src/guestfs-actions.pod:4460 ../src/guestfs-actions.pod:4479
10289 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4510
10290 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4540
10291 #: ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5800
10292 #: ../src/guestfs-actions.pod:6047 ../src/guestfs-actions.pod:6648
10293 msgid "(Added in 1.0.55)"
10298 #: ../src/guestfs-actions.pod:1985
10299 msgid "guestfs_get_network"
10304 #: ../src/guestfs-actions.pod:1987
10308 " guestfs_get_network (guestfs_h *g);\n"
10314 #: ../src/guestfs-actions.pod:1990 ../fish/guestfish-actions.pod:1355
10315 msgid "This returns the enable network flag."
10320 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:5819
10321 msgid "(Added in 1.5.4)"
10326 #: ../src/guestfs-actions.pod:1996
10327 msgid "guestfs_get_path"
10332 #: ../src/guestfs-actions.pod:1998
10336 " guestfs_get_path (guestfs_h *g);\n"
10342 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1361
10343 msgid "Return the current search path."
10348 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1363
10350 "This is always non-NULL. If it wasn't set already, then this will return "
10351 "the default path."
10356 #: ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2035
10358 "This function returns a string, or NULL on error. The string is owned by "
10359 "the guest handle and must I<not> be freed."
10364 #: ../src/guestfs-actions.pod:2011
10365 msgid "guestfs_get_pid"
10370 #: ../src/guestfs-actions.pod:2013
10374 " guestfs_get_pid (guestfs_h *g);\n"
10380 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
10382 "Return the process ID of the qemu subprocess. If there is no qemu "
10383 "subprocess, then this will return an error."
10388 #: ../src/guestfs-actions.pod:2019 ../fish/guestfish-actions.pod:1375
10389 msgid "This is an internal call used for debugging and testing."
10394 #: ../src/guestfs-actions.pod:2023
10395 msgid "(Added in 1.0.56)"
10400 #: ../src/guestfs-actions.pod:2025
10401 msgid "guestfs_get_qemu"
10406 #: ../src/guestfs-actions.pod:2027
10410 " guestfs_get_qemu (guestfs_h *g);\n"
10416 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1381
10417 msgid "Return the current qemu binary."
10422 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1383
10424 "This is always non-NULL. If it wasn't set already, then this will return "
10425 "the default qemu binary name."
10430 #: ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:5864
10431 msgid "(Added in 1.0.6)"
10436 #: ../src/guestfs-actions.pod:2040
10437 msgid "guestfs_get_recovery_proc"
10442 #: ../src/guestfs-actions.pod:2042
10446 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10452 #: ../src/guestfs-actions.pod:2045 ../fish/guestfish-actions.pod:1390
10453 msgid "Return the recovery process enabled flag."
10458 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:3373
10459 #: ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:4070
10460 #: ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:5123
10461 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5888
10462 #: ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6571
10463 #: ../src/guestfs-actions.pod:6763
10464 msgid "(Added in 1.0.77)"
10469 #: ../src/guestfs-actions.pod:2051
10470 msgid "guestfs_get_selinux"
10475 #: ../src/guestfs-actions.pod:2053
10479 " guestfs_get_selinux (guestfs_h *g);\n"
10485 #: ../src/guestfs-actions.pod:2056
10487 "This returns the current setting of the selinux flag which is passed to the "
10488 "appliance at boot time. See C<guestfs_set_selinux>."
10493 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:2127
10494 #: ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:5965
10495 msgid "(Added in 1.0.67)"
10500 #: ../src/guestfs-actions.pod:2066
10501 msgid "guestfs_get_state"
10506 #: ../src/guestfs-actions.pod:2068
10510 " guestfs_get_state (guestfs_h *g);\n"
10516 #: ../src/guestfs-actions.pod:2071 ../fish/guestfish-actions.pod:1406
10518 "This returns the current state as an opaque integer. This is only useful "
10519 "for printing debug and internal error messages."
10524 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:3176
10525 #: ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3266
10526 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:1409
10527 #: ../fish/guestfish-actions.pod:2223 ../fish/guestfish-actions.pod:2241
10528 #: ../fish/guestfish-actions.pod:2279 ../fish/guestfish-actions.pod:2295
10529 msgid "For more information on states, see L<guestfs(3)>."
10534 #: ../src/guestfs-actions.pod:2080
10535 msgid "guestfs_get_trace"
10540 #: ../src/guestfs-actions.pod:2082
10544 " guestfs_get_trace (guestfs_h *g);\n"
10550 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1415
10551 msgid "Return the command trace flag."
10556 #: ../src/guestfs-actions.pod:2091
10557 msgid "guestfs_get_umask"
10562 #: ../src/guestfs-actions.pod:2093
10566 " guestfs_get_umask (guestfs_h *g);\n"
10572 #: ../src/guestfs-actions.pod:2096
10574 "Return the current umask. By default the umask is C<022> unless it has been "
10575 "set by calling C<guestfs_umask>."
10580 #: ../src/guestfs-actions.pod:2103
10581 msgid "guestfs_get_verbose"
10586 #: ../src/guestfs-actions.pod:2105
10590 " guestfs_get_verbose (guestfs_h *g);\n"
10596 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1428
10597 msgid "This returns the verbose messages flag."
10602 #: ../src/guestfs-actions.pod:2114
10603 msgid "guestfs_getcon"
10608 #: ../src/guestfs-actions.pod:2116
10612 " guestfs_getcon (guestfs_h *g);\n"
10618 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1434
10619 msgid "This gets the SELinux security context of the daemon."
10624 #: ../src/guestfs-actions.pod:2121
10626 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10631 #: ../src/guestfs-actions.pod:2129
10632 msgid "guestfs_getxattr"
10637 #: ../src/guestfs-actions.pod:2131
10641 " guestfs_getxattr (guestfs_h *g,\n"
10642 " const char *path,\n"
10643 " const char *name,\n"
10644 " size_t *size_r);\n"
10650 #: ../src/guestfs-actions.pod:2137
10652 "Get a single extended attribute from file C<path> named C<name>. This call "
10653 "follows symlinks. If you want to lookup an extended attribute for the "
10654 "symlink itself, use C<guestfs_lgetxattr>."
10659 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3387
10661 "Normally it is better to get all extended attributes from a file in one go "
10662 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10663 "implementations are buggy and do not provide a way to list out attributes. "
10664 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10665 "extended attributes you want in advance and call this function."
10670 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3394
10671 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2360
10673 "Extended attribute values are blobs of binary data. If there is no extended "
10674 "attribute named C<name>, this returns an error."
10679 #: ../src/guestfs-actions.pod:2151
10680 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10685 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2344
10686 #: ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:5116
10687 #: ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:5323
10689 "This function returns a buffer, or NULL on error. The size of the returned "
10690 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10695 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3403
10696 msgid "(Added in 1.7.24)"
10701 #: ../src/guestfs-actions.pod:2159
10702 msgid "guestfs_getxattrs"
10707 #: ../src/guestfs-actions.pod:2161
10710 " struct guestfs_xattr_list *\n"
10711 " guestfs_getxattrs (guestfs_h *g,\n"
10712 " const char *path);\n"
10718 #: ../src/guestfs-actions.pod:2165 ../fish/guestfish-actions.pod:1463
10720 "This call lists the extended attributes of the file or directory C<path>."
10725 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1466
10727 "At the system call level, this is a combination of the L<listxattr(2)> and "
10728 "L<getxattr(2)> calls."
10733 #: ../src/guestfs-actions.pod:2171
10734 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10739 #: ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:3415
10740 #: ../src/guestfs-actions.pod:4066
10742 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10743 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10748 #: ../src/guestfs-actions.pod:2177 ../src/guestfs-actions.pod:3419
10749 #: ../src/guestfs-actions.pod:3584 ../src/guestfs-actions.pod:3620
10750 #: ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5984
10751 #: ../src/guestfs-actions.pod:7319
10752 msgid "(Added in 1.0.59)"
10757 #: ../src/guestfs-actions.pod:2179
10758 msgid "guestfs_glob_expand"
10763 #: ../src/guestfs-actions.pod:2181
10767 " guestfs_glob_expand (guestfs_h *g,\n"
10768 " const char *pattern);\n"
10774 #: ../src/guestfs-actions.pod:2185 ../fish/guestfish-actions.pod:1475
10776 "This command searches for all the pathnames matching C<pattern> according to "
10777 "the wildcard expansion rules used by the shell."
10782 #: ../src/guestfs-actions.pod:2189 ../fish/guestfish-actions.pod:1479
10784 "If no paths match, then this returns an empty list (note: not an error)."
10789 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1482
10791 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10792 "GLOB_BRACE>. See that manual page for more details."
10797 #: ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:6149
10798 #: ../src/guestfs-actions.pod:6166
10799 msgid "(Added in 1.0.50)"
10804 #: ../src/guestfs-actions.pod:2202
10805 msgid "guestfs_grep"
10810 #: ../src/guestfs-actions.pod:2204
10814 " guestfs_grep (guestfs_h *g,\n"
10815 " const char *regex,\n"
10816 " const char *path);\n"
10822 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1490
10823 msgid "This calls the external C<grep> program and returns the matching lines."
10828 #: ../src/guestfs-actions.pod:2221
10829 msgid "guestfs_grepi"
10834 #: ../src/guestfs-actions.pod:2223
10838 " guestfs_grepi (guestfs_h *g,\n"
10839 " const char *regex,\n"
10840 " const char *path);\n"
10846 #: ../src/guestfs-actions.pod:2228 ../fish/guestfish-actions.pod:1500
10848 "This calls the external C<grep -i> program and returns the matching lines."
10853 #: ../src/guestfs-actions.pod:2240
10854 msgid "guestfs_grub_install"
10859 #: ../src/guestfs-actions.pod:2242
10863 " guestfs_grub_install (guestfs_h *g,\n"
10864 " const char *root,\n"
10865 " const char *device);\n"
10871 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
10873 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10874 "the root directory being C<root>."
10879 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1513
10881 "Note: If grub-install reports the error \"No suitable drive was found in the "
10882 "generated device map.\" it may be that you need to create a C</boot/grub/"
10883 "device.map> file first that contains the mapping between grub device names "
10884 "and Linux device names. It is usually sufficient to create a file "
10890 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1520
10893 " (hd0) /dev/vda\n"
10899 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1522
10900 msgid "replacing C</dev/vda> with the name of the installation device."
10905 #: ../src/guestfs-actions.pod:2263
10906 msgid "(Added in 1.0.17)"
10911 #: ../src/guestfs-actions.pod:2265
10912 msgid "guestfs_head"
10917 #: ../src/guestfs-actions.pod:2267
10921 " guestfs_head (guestfs_h *g,\n"
10922 " const char *path);\n"
10928 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1528
10930 "This command returns up to the first 10 lines of a file as a list of strings."
10935 #: ../src/guestfs-actions.pod:2283
10936 msgid "guestfs_head_n"
10941 #: ../src/guestfs-actions.pod:2285
10945 " guestfs_head_n (guestfs_h *g,\n"
10947 " const char *path);\n"
10953 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1538
10955 "If the parameter C<nrlines> is a positive number, this returns the first "
10956 "C<nrlines> lines of the file C<path>."
10961 #: ../src/guestfs-actions.pod:2293 ../fish/guestfish-actions.pod:1541
10963 "If the parameter C<nrlines> is a negative number, this returns lines from "
10964 "the file C<path>, excluding the last C<nrlines> lines."
10969 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:6446
10970 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4330
10971 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10976 #: ../src/guestfs-actions.pod:2307
10977 msgid "guestfs_hexdump"
10982 #: ../src/guestfs-actions.pod:2309
10986 " guestfs_hexdump (guestfs_h *g,\n"
10987 " const char *path);\n"
10993 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
10995 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10996 "readable, canonical hex dump of the file."
11001 #: ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:6230
11002 #: ../src/guestfs-actions.pod:6285
11003 msgid "(Added in 1.0.22)"
11008 #: ../src/guestfs-actions.pod:2324
11009 msgid "guestfs_initrd_cat"
11014 #: ../src/guestfs-actions.pod:2326
11018 " guestfs_initrd_cat (guestfs_h *g,\n"
11019 " const char *initrdpath,\n"
11020 " const char *filename,\n"
11021 " size_t *size_r);\n"
11027 #: ../src/guestfs-actions.pod:2332 ../fish/guestfish-actions.pod:1563
11029 "This command unpacks the file C<filename> from the initrd file called "
11030 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11036 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
11038 "For example, in guestfish you could use the following command to examine the "
11039 "boot script (usually called C</init>) contained in a Linux initrd or "
11045 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
11048 " initrd-cat /boot/initrd-<version>.img init\n"
11054 #: ../src/guestfs-actions.pod:2342
11055 msgid "See also C<guestfs_initrd_list>."
11060 #: ../src/guestfs-actions.pod:2353
11061 msgid "guestfs_initrd_list"
11066 #: ../src/guestfs-actions.pod:2355
11070 " guestfs_initrd_list (guestfs_h *g,\n"
11071 " const char *path);\n"
11077 #: ../src/guestfs-actions.pod:2359 ../fish/guestfish-actions.pod:1582
11078 msgid "This command lists out files contained in an initrd."
11083 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1584
11085 "The files are listed without any initial C</> character. The files are "
11086 "listed in the order they appear (not necessarily alphabetical). Directory "
11087 "names are listed as separate items."
11092 #: ../src/guestfs-actions.pod:2365 ../fish/guestfish-actions.pod:1588
11094 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11095 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11101 #: ../src/guestfs-actions.pod:2375
11102 msgid "guestfs_inotify_add_watch"
11107 #: ../src/guestfs-actions.pod:2377
11111 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11112 " const char *path,\n"
11119 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1596
11120 msgid "Watch C<path> for the events listed in C<mask>."
11125 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1598
11127 "Note that if C<path> is a directory then events within that directory are "
11128 "watched, but this does I<not> happen recursively (in subdirectories)."
11133 #: ../src/guestfs-actions.pod:2388 ../fish/guestfish-actions.pod:1602
11135 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11136 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11141 #: ../src/guestfs-actions.pod:2396
11142 msgid "guestfs_inotify_close"
11147 #: ../src/guestfs-actions.pod:2398
11151 " guestfs_inotify_close (guestfs_h *g);\n"
11157 #: ../src/guestfs-actions.pod:2401 ../fish/guestfish-actions.pod:1610
11159 "This closes the inotify handle which was previously opened by inotify_init. "
11160 "It removes all watches, throws away any pending events, and deallocates all "
11166 #: ../src/guestfs-actions.pod:2409
11167 msgid "guestfs_inotify_files"
11172 #: ../src/guestfs-actions.pod:2411
11176 " guestfs_inotify_files (guestfs_h *g);\n"
11182 #: ../src/guestfs-actions.pod:2414
11184 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11185 "returns a list of pathnames of objects that were touched. The returned "
11186 "pathnames are sorted and deduplicated."
11191 #: ../src/guestfs-actions.pod:2424
11192 msgid "guestfs_inotify_init"
11197 #: ../src/guestfs-actions.pod:2426
11201 " guestfs_inotify_init (guestfs_h *g,\n"
11202 " int maxevents);\n"
11208 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1626
11210 "This command creates a new inotify handle. The inotify subsystem can be "
11211 "used to notify events which happen to objects in the guest filesystem."
11216 #: ../src/guestfs-actions.pod:2434
11218 "C<maxevents> is the maximum number of events which will be queued up between "
11219 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11220 "passed as C<0>, then the kernel (or previously set) default is used. For "
11221 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11222 "throws away events, but records the fact that it threw them away by setting "
11223 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11224 "C<guestfs_inotify_read>)."
11229 #: ../src/guestfs-actions.pod:2444
11231 "Before any events are generated, you have to add some watches to the "
11232 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11233 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11238 #: ../src/guestfs-actions.pod:2450
11240 "Queued up events should be read periodically by calling "
11241 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11242 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11243 "often enough then you risk the internal queue overflowing."
11248 #: ../src/guestfs-actions.pod:2457
11250 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11251 "This also removes any watches automatically."
11256 #: ../src/guestfs-actions.pod:2461 ../fish/guestfish-actions.pod:1657
11258 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11259 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11260 "that there is one global inotify handle per libguestfs instance."
11265 #: ../src/guestfs-actions.pod:2470
11266 msgid "guestfs_inotify_read"
11271 #: ../src/guestfs-actions.pod:2472
11274 " struct guestfs_inotify_event_list *\n"
11275 " guestfs_inotify_read (guestfs_h *g);\n"
11281 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1666
11283 "Return the complete queue of events that have happened since the previous "
11289 #: ../src/guestfs-actions.pod:2478 ../fish/guestfish-actions.pod:1669
11290 msgid "If no events have happened, this returns an empty list."
11295 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1671
11297 "I<Note>: In order to make sure that all events have been read, you must call "
11298 "this function repeatedly until it returns an empty list. The reason is that "
11299 "the call will read events up to the maximum appliance-to-host message size "
11300 "and leave remaining events in the queue."
11305 #: ../src/guestfs-actions.pod:2486
11307 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11308 "there was an error. I<The caller must call "
11309 "C<guestfs_free_inotify_event_list> after use>."
11314 #: ../src/guestfs-actions.pod:2492
11315 msgid "guestfs_inotify_rm_watch"
11320 #: ../src/guestfs-actions.pod:2494
11324 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11331 #: ../src/guestfs-actions.pod:2498
11333 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11338 #: ../src/guestfs-actions.pod:2505
11339 msgid "guestfs_inspect_get_arch"
11344 #: ../src/guestfs-actions.pod:2507
11348 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11349 " const char *root);\n"
11355 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:2534
11356 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2641
11357 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2702
11358 #: ../src/guestfs-actions.pod:2729 ../src/guestfs-actions.pod:2750
11359 #: ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2816
11360 #: ../src/guestfs-actions.pod:2847 ../src/guestfs-actions.pod:2891
11361 #: ../src/guestfs-actions.pod:2933 ../src/guestfs-actions.pod:2956
11362 #: ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:2990
11363 #: ../src/guestfs-actions.pod:3009
11365 "This function should only be called with a root device string as returned by "
11366 "C<guestfs_inspect_os>."
11371 #: ../src/guestfs-actions.pod:2514
11373 "This returns the architecture of the inspected operating system. The "
11374 "possible return values are listed under C<guestfs_file_architecture>."
11379 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1695
11381 "If the architecture could not be determined, then the string C<unknown> is "
11387 #: ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2602
11388 #: ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2689
11389 #: ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2803
11390 #: ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2858
11391 #: ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:2920
11392 #: ../src/guestfs-actions.pod:2943 ../src/guestfs-actions.pod:2963
11393 #: ../src/guestfs-actions.pod:2980 ../src/guestfs-actions.pod:2999
11394 #: ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3143
11395 #: ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1772
11396 #: ../fish/guestfish-actions.pod:1824 ../fish/guestfish-actions.pod:1839
11397 #: ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:1924
11398 #: ../fish/guestfish-actions.pod:1948 ../fish/guestfish-actions.pod:1965
11399 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2013
11400 #: ../fish/guestfish-actions.pod:2029 ../fish/guestfish-actions.pod:2042
11401 #: ../fish/guestfish-actions.pod:2055 ../fish/guestfish-actions.pod:2070
11402 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2203
11403 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11408 #: ../src/guestfs-actions.pod:2528
11409 msgid "guestfs_inspect_get_distro"
11414 #: ../src/guestfs-actions.pod:2530
11418 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11419 " const char *root);\n"
11425 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1707
11427 "This returns the distro (distribution) of the inspected operating system."
11432 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1710
11433 msgid "Currently defined distros are:"
11438 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1714
11439 msgid "\"archlinux\""
11444 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1716
11445 msgid "Arch Linux."
11450 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1718
11456 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1720
11462 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1722
11468 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1724
11474 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1726
11480 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1728
11486 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1730
11487 msgid "\"linuxmint\""
11492 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1732
11493 msgid "Linux Mint."
11498 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1734
11499 msgid "\"mandriva\""
11504 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1736
11510 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1738
11516 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1740
11522 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1742
11528 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1744
11534 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1746
11535 msgid "\"redhat-based\""
11540 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1748
11541 msgid "Some Red Hat-derived distro."
11546 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1750
11552 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1752
11553 msgid "Red Hat Enterprise Linux and some derivatives."
11558 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1754
11564 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1756
11570 #: ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:2660
11571 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:1758
11572 #: ../fish/guestfish-actions.pod:1815 ../fish/guestfish-actions.pod:2004
11573 msgid "\"unknown\""
11578 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1760
11579 msgid "The distro could not be determined."
11584 #: ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:2903
11585 #: ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:1996
11586 msgid "\"windows\""
11591 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1764
11593 "Windows does not have distributions. This string is returned if the OS type "
11599 #: ../src/guestfs-actions.pod:2599 ../src/guestfs-actions.pod:2666
11600 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:1769
11601 #: ../fish/guestfish-actions.pod:1821 ../fish/guestfish-actions.pod:2010
11603 "Future versions of libguestfs may return other strings here. The caller "
11604 "should be prepared to handle any string."
11609 #: ../src/guestfs-actions.pod:2609
11610 msgid "guestfs_inspect_get_filesystems"
11615 #: ../src/guestfs-actions.pod:2611
11619 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11620 " const char *root);\n"
11626 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1781
11628 "This returns a list of all the filesystems that we think are associated with "
11629 "this operating system. This includes the root filesystem, other ordinary "
11630 "filesystems, and non-mounted devices like swap partitions."
11635 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
11637 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11638 "to be shared between operating systems."
11643 #: ../src/guestfs-actions.pod:2626
11645 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11646 "C<guestfs_inspect_get_mountpoints>."
11650 #: ../src/guestfs-actions.pod:2635
11651 msgid "guestfs_inspect_get_format"
11655 #: ../src/guestfs-actions.pod:2637
11659 " guestfs_inspect_get_format (guestfs_h *g,\n"
11660 " const char *root);\n"
11665 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1799
11667 "This returns the format of the inspected operating system. You can use it "
11668 "to detect install images, live CDs and similar."
11672 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1802
11673 msgid "Currently defined formats are:"
11677 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1806
11678 msgid "\"installed\""
11682 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
11683 msgid "This is an installed operating system."
11687 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1810
11688 msgid "\"installer\""
11692 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1812
11694 "The disk image being inspected is not an installed operating system, but a "
11695 "I<bootable> install disk, live CD, or similar."
11699 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1817
11700 msgid "The format of this disk image is not known."
11705 #: ../src/guestfs-actions.pod:2674
11706 msgid "guestfs_inspect_get_hostname"
11711 #: ../src/guestfs-actions.pod:2676
11715 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11716 " const char *root);\n"
11722 #: ../src/guestfs-actions.pod:2683 ../fish/guestfish-actions.pod:1833
11724 "This function returns the hostname of the operating system as found by "
11725 "inspection of the guest's configuration files."
11730 #: ../src/guestfs-actions.pod:2686 ../fish/guestfish-actions.pod:1836
11732 "If the hostname could not be determined, then the string C<unknown> is "
11738 #: ../src/guestfs-actions.pod:2694
11739 msgid "(Added in 1.7.9)"
11744 #: ../src/guestfs-actions.pod:2696
11745 msgid "guestfs_inspect_get_major_version"
11750 #: ../src/guestfs-actions.pod:2698
11754 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11755 " const char *root);\n"
11761 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1848
11763 "This returns the major version number of the inspected operating system."
11768 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1851
11770 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11771 "popular public names used by the operating system. Notably the operating "
11772 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11773 "1). You can find out the real versions corresponding to releases of Windows "
11774 "by consulting Wikipedia or MSDN."
11779 #: ../src/guestfs-actions.pod:2715 ../src/guestfs-actions.pod:2735
11780 #: ../fish/guestfish-actions.pod:1858 ../fish/guestfish-actions.pod:1872
11781 msgid "If the version could not be determined, then C<0> is returned."
11786 #: ../src/guestfs-actions.pod:2723
11787 msgid "guestfs_inspect_get_minor_version"
11792 #: ../src/guestfs-actions.pod:2725
11796 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11797 " const char *root);\n"
11803 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1869
11805 "This returns the minor version number of the inspected operating system."
11810 #: ../src/guestfs-actions.pod:2737
11812 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11813 "C<guestfs_inspect_get_major_version>."
11818 #: ../src/guestfs-actions.pod:2744
11819 msgid "guestfs_inspect_get_mountpoints"
11824 #: ../src/guestfs-actions.pod:2746
11828 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11829 " const char *root);\n"
11834 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1884
11836 "This returns a hash of where we think the filesystems associated with this "
11837 "operating system should be mounted. Callers should note that this is at "
11838 "best an educated guess made by reading configuration files such as C</etc/"
11839 "fstab>. I<In particular note> that this may return filesystems which are "
11840 "non-existent or not mountable and callers should be prepared to handle or "
11841 "ignore failures if they try to mount them."
11846 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1893
11848 "Each element in the returned hashtable has a key which is the path of the "
11849 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11850 "mounted there (eg. C</dev/sda1>)."
11855 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1898
11857 "Non-mounted devices such as swap devices are I<not> returned in this list."
11862 #: ../src/guestfs-actions.pod:2770
11864 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11865 "C<guestfs_inspect_get_filesystems>."
11870 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:3472
11871 #: ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:6587
11873 "This function returns a NULL-terminated array of strings, or NULL if there "
11874 "was an error. The array of strings will always have length C<2n+1>, where "
11875 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11876 "caller must free the strings and the array after use>."
11881 #: ../src/guestfs-actions.pod:2781
11882 msgid "guestfs_inspect_get_package_format"
11887 #: ../src/guestfs-actions.pod:2783
11891 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11892 " const char *root);\n"
11898 #: ../src/guestfs-actions.pod:2790
11900 "This function and C<guestfs_inspect_get_package_management> return the "
11901 "package format and package management tool used by the inspected operating "
11902 "system. For example for Fedora these functions would return C<rpm> (package "
11903 "format) and C<yum> (package management)."
11908 #: ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1917
11910 "This returns the string C<unknown> if we could not determine the package "
11911 "format I<or> if the operating system does not have a real packaging system "
11917 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1921
11919 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11920 "Future versions of libguestfs may return other strings."
11925 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2839
11926 msgid "(Added in 1.7.5)"
11931 #: ../src/guestfs-actions.pod:2810
11932 msgid "guestfs_inspect_get_package_management"
11937 #: ../src/guestfs-actions.pod:2812
11941 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11942 " const char *root);\n"
11948 #: ../src/guestfs-actions.pod:2819
11950 "C<guestfs_inspect_get_package_format> and this function return the package "
11951 "format and package management tool used by the inspected operating system. "
11952 "For example for Fedora these functions would return C<rpm> (package format) "
11953 "and C<yum> (package management)."
11958 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1939
11960 "This returns the string C<unknown> if we could not determine the package "
11961 "management tool I<or> if the operating system does not have a real packaging "
11962 "system (eg. Windows)."
11967 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1943
11969 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11970 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11971 "libguestfs may return other strings."
11976 #: ../src/guestfs-actions.pod:2841
11977 msgid "guestfs_inspect_get_product_name"
11982 #: ../src/guestfs-actions.pod:2843
11986 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11987 " const char *root);\n"
11993 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1957
11995 "This returns the product name of the inspected operating system. The "
11996 "product name is generally some freeform string which can be displayed to the "
11997 "user, but should not be parsed by programs."
12002 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1962
12004 "If the product name could not be determined, then the string C<unknown> is "
12010 #: ../src/guestfs-actions.pod:2865
12011 msgid "guestfs_inspect_get_roots"
12016 #: ../src/guestfs-actions.pod:2867
12020 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12026 #: ../src/guestfs-actions.pod:2870
12028 "This function is a convenient way to get the list of root devices, as "
12029 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12030 "the whole inspection process."
12035 #: ../src/guestfs-actions.pod:2874
12037 "This returns an empty list if either no root devices were found or the "
12038 "caller has not called C<guestfs_inspect_os>."
12043 #: ../src/guestfs-actions.pod:2883
12044 msgid "(Added in 1.7.3)"
12049 #: ../src/guestfs-actions.pod:2885
12050 msgid "guestfs_inspect_get_type"
12055 #: ../src/guestfs-actions.pod:2887
12059 " guestfs_inspect_get_type (guestfs_h *g,\n"
12060 " const char *root);\n"
12066 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1987
12068 "This returns the type of the inspected operating system. Currently defined "
12074 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1992
12080 #: ../src/guestfs-actions.pod:2901 ../fish/guestfish-actions.pod:1994
12081 msgid "Any Linux-based operating system."
12086 #: ../src/guestfs-actions.pod:2905 ../fish/guestfish-actions.pod:1998
12087 msgid "Any Microsoft Windows operating system."
12092 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2000
12093 msgid "\"freebsd\""
12098 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2002
12104 #: ../src/guestfs-actions.pod:2913 ../fish/guestfish-actions.pod:2006
12105 msgid "The operating system type could not be determined."
12110 #: ../src/guestfs-actions.pod:2927
12111 msgid "guestfs_inspect_get_windows_systemroot"
12116 #: ../src/guestfs-actions.pod:2929
12120 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12121 " const char *root);\n"
12127 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2022
12129 "This returns the Windows systemroot of the inspected guest. The systemroot "
12130 "is a directory path such as C</WINDOWS>."
12135 #: ../src/guestfs-actions.pod:2939 ../fish/guestfish-actions.pod:2025
12137 "This call assumes that the guest is Windows and that the systemroot could be "
12138 "determined by inspection. If this is not the case then an error is returned."
12143 #: ../src/guestfs-actions.pod:2948
12144 msgid "(Added in 1.5.25)"
12148 #: ../src/guestfs-actions.pod:2950
12149 msgid "guestfs_inspect_is_live"
12153 #: ../src/guestfs-actions.pod:2952
12157 " guestfs_inspect_is_live (guestfs_h *g,\n"
12158 " const char *root);\n"
12163 #: ../src/guestfs-actions.pod:2959
12165 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12166 "disk), then this returns true if a live image was detected on the disk."
12170 #: ../src/guestfs-actions.pod:2967
12171 msgid "guestfs_inspect_is_multipart"
12175 #: ../src/guestfs-actions.pod:2969
12179 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12180 " const char *root);\n"
12185 #: ../src/guestfs-actions.pod:2976
12187 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12188 "disk), then this returns true if the disk is part of a set."
12192 #: ../src/guestfs-actions.pod:2984
12193 msgid "guestfs_inspect_is_netinst"
12197 #: ../src/guestfs-actions.pod:2986
12201 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12202 " const char *root);\n"
12207 #: ../src/guestfs-actions.pod:2993
12209 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12210 "disk), then this returns true if the disk is a network installer, ie. not a "
12211 "self-contained install CD but one which is likely to require network access "
12212 "to complete the install."
12217 #: ../src/guestfs-actions.pod:3003
12218 msgid "guestfs_inspect_list_applications"
12223 #: ../src/guestfs-actions.pod:3005
12226 " struct guestfs_application_list *\n"
12227 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12228 " const char *root);\n"
12234 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2079
12235 msgid "Return the list of applications installed in the operating system."
12240 #: ../src/guestfs-actions.pod:3014
12242 "I<Note:> This call works differently from other parts of the inspection "
12243 "API. You have to call C<guestfs_inspect_os>, then "
12244 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12245 "this. Listing applications is a significantly more difficult operation "
12246 "which requires access to the full filesystem. Also note that unlike the "
12247 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12248 "the libguestfs handle, this call actually reads parts of the mounted "
12249 "filesystems during the call."
12254 #: ../src/guestfs-actions.pod:3024 ../fish/guestfish-actions.pod:2091
12256 "This returns an empty list if the inspection code was not able to determine "
12257 "the list of applications."
12262 #: ../src/guestfs-actions.pod:3027 ../fish/guestfish-actions.pod:2094
12263 msgid "The application structure contains the following fields:"
12268 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2098
12269 msgid "C<app_name>"
12274 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2100
12276 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12277 "guests, this is the package name."
12282 #: ../src/guestfs-actions.pod:3036 ../fish/guestfish-actions.pod:2103
12283 msgid "C<app_display_name>"
12288 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2105
12290 "The display name of the application, sometimes localized to the install "
12291 "language of the guest operating system."
12296 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2108
12298 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12299 "to display something can use C<app_name> instead."
12304 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
12305 msgid "C<app_epoch>"
12310 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2113
12312 "For package managers which use epochs, this contains the epoch of the "
12313 "package (an integer). If unavailable, this is returned as C<0>."
12318 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2116
12319 msgid "C<app_version>"
12324 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2118
12326 "The version string of the application or package. If unavailable this is "
12327 "returned as an empty string C<\"\">."
12332 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2121
12333 msgid "C<app_release>"
12338 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2123
12340 "The release string of the application or package, for package managers that "
12341 "use this. If unavailable this is returned as an empty string C<\"\">."
12346 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2127
12347 msgid "C<app_install_path>"
12352 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2129
12354 "The installation path of the application (on operating systems such as "
12355 "Windows which use installation paths). This path is in the format used by "
12356 "the guest operating system, it is not a libguestfs path."
12361 #: ../src/guestfs-actions.pod:3067 ../fish/guestfish-actions.pod:2134
12362 msgid "If unavailable this is returned as an empty string C<\"\">."
12367 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2136
12368 msgid "C<app_trans_path>"
12373 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2138
12375 "The install path translated into a libguestfs path. If unavailable this is "
12376 "returned as an empty string C<\"\">."
12381 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2141
12382 msgid "C<app_publisher>"
12387 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2143
12389 "The name of the publisher of the application, for package managers that use "
12390 "this. If unavailable this is returned as an empty string C<\"\">."
12395 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2147
12401 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2149
12403 "The URL (eg. upstream URL) of the application. If unavailable this is "
12404 "returned as an empty string C<\"\">."
12409 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2152
12410 msgid "C<app_source_package>"
12415 #: ../src/guestfs-actions.pod:3087 ../fish/guestfish-actions.pod:2154
12417 "For packaging systems which support this, the name of the source package. "
12418 "If unavailable this is returned as an empty string C<\"\">."
12423 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2157
12424 msgid "C<app_summary>"
12429 #: ../src/guestfs-actions.pod:3092 ../fish/guestfish-actions.pod:2159
12431 "A short (usually one line) description of the application or package. If "
12432 "unavailable this is returned as an empty string C<\"\">."
12437 #: ../src/guestfs-actions.pod:3095 ../fish/guestfish-actions.pod:2162
12438 msgid "C<app_description>"
12443 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2164
12445 "A longer description of the application or package. If unavailable this is "
12446 "returned as an empty string C<\"\">."
12451 #: ../src/guestfs-actions.pod:3104
12453 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12454 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12460 #: ../src/guestfs-actions.pod:3108
12461 msgid "(Added in 1.7.8)"
12466 #: ../src/guestfs-actions.pod:3110
12467 msgid "guestfs_inspect_os"
12472 #: ../src/guestfs-actions.pod:3112
12476 " guestfs_inspect_os (guestfs_h *g);\n"
12482 #: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2175
12484 "This function uses other libguestfs functions and certain heuristics to "
12485 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12486 "for operating systems."
12491 #: ../src/guestfs-actions.pod:3119 ../fish/guestfish-actions.pod:2179
12492 msgid "The list returned is empty if no operating systems were found."
12497 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2181
12499 "If one operating system was found, then this returns a list with a single "
12500 "element, which is the name of the root filesystem of this operating system. "
12501 "It is also possible for this function to return a list containing more than "
12502 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12503 "element being the root filesystem of one of the operating systems."
12508 #: ../src/guestfs-actions.pod:3128
12510 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12511 "functions in order to query further information about each operating system, "
12512 "such as the name and version."
12517 #: ../src/guestfs-actions.pod:3133
12519 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12520 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12521 "the contents. This should be called with no disks currently mounted. The "
12522 "function may also use Augeas, so any existing Augeas handle will be closed."
12527 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2199
12529 "This function cannot decrypt encrypted disks. The caller must do that first "
12530 "(supplying the necessary keys) if the disk is encrypted."
12535 #: ../src/guestfs-actions.pod:3145 ../src/guestfs-actions.pod:3430
12536 #: ../src/guestfs-actions.pod:3492
12537 msgid "See also C<guestfs_list_filesystems>."
12542 #: ../src/guestfs-actions.pod:3153
12543 msgid "guestfs_is_blockdev"
12548 #: ../src/guestfs-actions.pod:3155
12552 " guestfs_is_blockdev (guestfs_h *g,\n"
12553 " const char *path);\n"
12559 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2211
12561 "This returns C<true> if and only if there is a block device with the given "
12567 #: ../src/guestfs-actions.pod:3162 ../src/guestfs-actions.pod:3191
12568 #: ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3236
12569 #: ../src/guestfs-actions.pod:3252 ../src/guestfs-actions.pod:3308
12570 #: ../src/guestfs-actions.pod:3323
12571 msgid "See also C<guestfs_stat>."
12576 #: ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3195
12577 #: ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3312
12578 #: ../src/guestfs-actions.pod:3327
12579 msgid "(Added in 1.5.10)"
12584 #: ../src/guestfs-actions.pod:3168
12585 msgid "guestfs_is_busy"
12590 #: ../src/guestfs-actions.pod:3170
12594 " guestfs_is_busy (guestfs_h *g);\n"
12600 #: ../src/guestfs-actions.pod:3173 ../fish/guestfish-actions.pod:2220
12602 "This returns true iff this handle is busy processing a command (in the "
12608 #: ../src/guestfs-actions.pod:3182
12609 msgid "guestfs_is_chardev"
12614 #: ../src/guestfs-actions.pod:3184
12618 " guestfs_is_chardev (guestfs_h *g,\n"
12619 " const char *path);\n"
12625 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2229
12627 "This returns C<true> if and only if there is a character device with the "
12628 "given C<path> name."
12633 #: ../src/guestfs-actions.pod:3197
12634 msgid "guestfs_is_config"
12639 #: ../src/guestfs-actions.pod:3199
12643 " guestfs_is_config (guestfs_h *g);\n"
12649 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2238
12651 "This returns true iff this handle is being configured (in the C<CONFIG> "
12657 #: ../src/guestfs-actions.pod:3211
12658 msgid "guestfs_is_dir"
12663 #: ../src/guestfs-actions.pod:3213
12667 " guestfs_is_dir (guestfs_h *g,\n"
12668 " const char *path);\n"
12674 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2247
12676 "This returns C<true> if and only if there is a directory with the given "
12677 "C<path> name. Note that it returns false for other objects like files."
12682 #: ../src/guestfs-actions.pod:3227
12683 msgid "guestfs_is_fifo"
12688 #: ../src/guestfs-actions.pod:3229
12692 " guestfs_is_fifo (guestfs_h *g,\n"
12693 " const char *path);\n"
12699 #: ../src/guestfs-actions.pod:3233 ../fish/guestfish-actions.pod:2257
12701 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12702 "given C<path> name."
12707 #: ../src/guestfs-actions.pod:3242
12708 msgid "guestfs_is_file"
12713 #: ../src/guestfs-actions.pod:3244
12717 " guestfs_is_file (guestfs_h *g,\n"
12718 " const char *path);\n"
12724 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2266
12726 "This returns C<true> if and only if there is a regular file with the given "
12727 "C<path> name. Note that it returns false for other objects like directories."
12732 #: ../src/guestfs-actions.pod:3258
12733 msgid "guestfs_is_launching"
12738 #: ../src/guestfs-actions.pod:3260
12742 " guestfs_is_launching (guestfs_h *g);\n"
12748 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2276
12750 "This returns true iff this handle is launching the subprocess (in the "
12751 "C<LAUNCHING> state)."
12756 #: ../src/guestfs-actions.pod:3272
12757 msgid "guestfs_is_lv"
12762 #: ../src/guestfs-actions.pod:3274
12766 " guestfs_is_lv (guestfs_h *g,\n"
12767 " const char *device);\n"
12773 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2285
12775 "This command tests whether C<device> is a logical volume, and returns true "
12776 "iff this is the case."
12781 #: ../src/guestfs-actions.pod:3285
12782 msgid "guestfs_is_ready"
12787 #: ../src/guestfs-actions.pod:3287
12791 " guestfs_is_ready (guestfs_h *g);\n"
12797 #: ../src/guestfs-actions.pod:3290 ../fish/guestfish-actions.pod:2292
12799 "This returns true iff this handle is ready to accept commands (in the "
12805 #: ../src/guestfs-actions.pod:3299
12806 msgid "guestfs_is_socket"
12811 #: ../src/guestfs-actions.pod:3301
12815 " guestfs_is_socket (guestfs_h *g,\n"
12816 " const char *path);\n"
12822 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2301
12824 "This returns C<true> if and only if there is a Unix domain socket with the "
12825 "given C<path> name."
12830 #: ../src/guestfs-actions.pod:3314
12831 msgid "guestfs_is_symlink"
12836 #: ../src/guestfs-actions.pod:3316
12840 " guestfs_is_symlink (guestfs_h *g,\n"
12841 " const char *path);\n"
12847 #: ../src/guestfs-actions.pod:3320 ../fish/guestfish-actions.pod:2310
12849 "This returns C<true> if and only if there is a symbolic link with the given "
12855 #: ../src/guestfs-actions.pod:3329
12856 msgid "guestfs_kill_subprocess"
12861 #: ../src/guestfs-actions.pod:3331
12865 " guestfs_kill_subprocess (guestfs_h *g);\n"
12871 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2319
12872 msgid "This kills the qemu subprocess. You should never need to call this."
12877 #: ../src/guestfs-actions.pod:3340
12878 msgid "guestfs_launch"
12883 #: ../src/guestfs-actions.pod:3342
12887 " guestfs_launch (guestfs_h *g);\n"
12893 #: ../src/guestfs-actions.pod:3345 ../fish/guestfish-actions.pod:2327
12895 "Internally libguestfs is implemented by running a virtual machine using "
12901 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2330
12903 "You should call this after configuring the handle (eg. adding drives) but "
12904 "before performing any actions."
12909 #: ../src/guestfs-actions.pod:3355
12910 msgid "guestfs_lchown"
12915 #: ../src/guestfs-actions.pod:3357
12919 " guestfs_lchown (guestfs_h *g,\n"
12922 " const char *path);\n"
12928 #: ../src/guestfs-actions.pod:3363
12930 "Change the file owner to C<owner> and group to C<group>. This is like "
12931 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12932 "changed, not the target."
12937 #: ../src/guestfs-actions.pod:3375
12938 msgid "guestfs_lgetxattr"
12943 #: ../src/guestfs-actions.pod:3377
12947 " guestfs_lgetxattr (guestfs_h *g,\n"
12948 " const char *path,\n"
12949 " const char *name,\n"
12950 " size_t *size_r);\n"
12956 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2349
12958 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12959 "is a symlink, then this call returns an extended attribute from the symlink."
12964 #: ../src/guestfs-actions.pod:3397
12965 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12970 #: ../src/guestfs-actions.pod:3405
12971 msgid "guestfs_lgetxattrs"
12976 #: ../src/guestfs-actions.pod:3407
12979 " struct guestfs_xattr_list *\n"
12980 " guestfs_lgetxattrs (guestfs_h *g,\n"
12981 " const char *path);\n"
12987 #: ../src/guestfs-actions.pod:3411
12989 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12990 "then it returns the extended attributes of the link itself."
12995 #: ../src/guestfs-actions.pod:3421
12996 msgid "guestfs_list_devices"
13001 #: ../src/guestfs-actions.pod:3423
13005 " guestfs_list_devices (guestfs_h *g);\n"
13011 #: ../src/guestfs-actions.pod:3426 ../fish/guestfish-actions.pod:2377
13012 msgid "List all the block devices."
13017 #: ../src/guestfs-actions.pod:3428 ../fish/guestfish-actions.pod:2379
13018 msgid "The full block device names are returned, eg. C</dev/sda>."
13023 #: ../src/guestfs-actions.pod:3438
13024 msgid "guestfs_list_filesystems"
13029 #: ../src/guestfs-actions.pod:3440
13033 " guestfs_list_filesystems (guestfs_h *g);\n"
13039 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2387
13041 "This inspection command looks for filesystems on partitions, block devices "
13042 "and logical volumes, returning a list of devices containing filesystems and "
13048 #: ../src/guestfs-actions.pod:3447 ../fish/guestfish-actions.pod:2391
13050 "The return value is a hash, where the keys are the devices containing "
13051 "filesystems, and the values are the filesystem types. For example:"
13056 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2395
13059 " \"/dev/sda1\" => \"ntfs\"\n"
13060 " \"/dev/sda2\" => \"ext2\"\n"
13061 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13062 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13068 #: ../src/guestfs-actions.pod:3456 ../fish/guestfish-actions.pod:2400
13070 "The value can have the special value \"unknown\", meaning the content of the "
13071 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13076 #: ../src/guestfs-actions.pod:3460
13078 "This command runs other libguestfs commands, which might include "
13079 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13080 "soon after launch and only when nothing is mounted."
13085 #: ../src/guestfs-actions.pod:3464
13087 "Not all of the filesystems returned will be mountable. In particular, swap "
13088 "partitions are returned in the list. Also this command does not check that "
13089 "each filesystem found is valid and mountable, and some filesystems might be "
13090 "mountable but require special options. Filesystems may not all belong to a "
13091 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13096 #: ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:5083
13097 msgid "(Added in 1.5.15)"
13102 #: ../src/guestfs-actions.pod:3480
13103 msgid "guestfs_list_partitions"
13108 #: ../src/guestfs-actions.pod:3482
13112 " guestfs_list_partitions (guestfs_h *g);\n"
13118 #: ../src/guestfs-actions.pod:3485 ../fish/guestfish-actions.pod:2420
13119 msgid "List all the partitions detected on all block devices."
13124 #: ../src/guestfs-actions.pod:3487 ../fish/guestfish-actions.pod:2422
13125 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13130 #: ../src/guestfs-actions.pod:3489
13132 "This does not return logical volumes. For that you will need to call "
13138 #: ../src/guestfs-actions.pod:3500
13144 #: ../src/guestfs-actions.pod:3502
13148 " guestfs_ll (guestfs_h *g,\n"
13149 " const char *directory);\n"
13155 #: ../src/guestfs-actions.pod:3506 ../fish/guestfish-actions.pod:2433
13157 "List the files in C<directory> (relative to the root directory, there is no "
13158 "cwd) in the format of 'ls -la'."
13163 #: ../src/guestfs-actions.pod:3509 ../fish/guestfish-actions.pod:2436
13165 "This command is mostly useful for interactive sessions. It is I<not> "
13166 "intended that you try to parse the output string."
13171 #: ../src/guestfs-actions.pod:3517
13177 #: ../src/guestfs-actions.pod:3519
13181 " guestfs_ln (guestfs_h *g,\n"
13182 " const char *target,\n"
13183 " const char *linkname);\n"
13189 #: ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:2443
13190 msgid "This command creates a hard link using the C<ln> command."
13195 #: ../src/guestfs-actions.pod:3530
13196 msgid "guestfs_ln_f"
13201 #: ../src/guestfs-actions.pod:3532
13205 " guestfs_ln_f (guestfs_h *g,\n"
13206 " const char *target,\n"
13207 " const char *linkname);\n"
13213 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2449
13215 "This command creates a hard link using the C<ln -f> command. The C<-f> "
13216 "option removes the link (C<linkname>) if it exists already."
13221 #: ../src/guestfs-actions.pod:3544
13222 msgid "guestfs_ln_s"
13227 #: ../src/guestfs-actions.pod:3546
13231 " guestfs_ln_s (guestfs_h *g,\n"
13232 " const char *target,\n"
13233 " const char *linkname);\n"
13239 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2456
13240 msgid "This command creates a symbolic link using the C<ln -s> command."
13245 #: ../src/guestfs-actions.pod:3557
13246 msgid "guestfs_ln_sf"
13251 #: ../src/guestfs-actions.pod:3559
13255 " guestfs_ln_sf (guestfs_h *g,\n"
13256 " const char *target,\n"
13257 " const char *linkname);\n"
13263 #: ../src/guestfs-actions.pod:3564 ../fish/guestfish-actions.pod:2462
13265 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
13266 "option removes the link (C<linkname>) if it exists already."
13271 #: ../src/guestfs-actions.pod:3571
13272 msgid "guestfs_lremovexattr"
13277 #: ../src/guestfs-actions.pod:3573
13281 " guestfs_lremovexattr (guestfs_h *g,\n"
13282 " const char *xattr,\n"
13283 " const char *path);\n"
13289 #: ../src/guestfs-actions.pod:3578
13291 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13292 "link, then it removes an extended attribute of the link itself."
13297 #: ../src/guestfs-actions.pod:3586
13303 #: ../src/guestfs-actions.pod:3588
13307 " guestfs_ls (guestfs_h *g,\n"
13308 " const char *directory);\n"
13314 #: ../src/guestfs-actions.pod:3592 ../fish/guestfish-actions.pod:2477
13316 "List the files in C<directory> (relative to the root directory, there is no "
13317 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13322 #: ../src/guestfs-actions.pod:3596
13324 "This command is mostly useful for interactive sessions. Programs should "
13325 "probably use C<guestfs_readdir> instead."
13330 #: ../src/guestfs-actions.pod:3605
13331 msgid "guestfs_lsetxattr"
13336 #: ../src/guestfs-actions.pod:3607
13340 " guestfs_lsetxattr (guestfs_h *g,\n"
13341 " const char *xattr,\n"
13342 " const char *val,\n"
13344 " const char *path);\n"
13350 #: ../src/guestfs-actions.pod:3614
13352 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13353 "then it sets an extended attribute of the link itself."
13358 #: ../src/guestfs-actions.pod:3622
13359 msgid "guestfs_lstat"
13364 #: ../src/guestfs-actions.pod:3624
13367 " struct guestfs_stat *\n"
13368 " guestfs_lstat (guestfs_h *g,\n"
13369 " const char *path);\n"
13375 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:6186
13376 #: ../fish/guestfish-actions.pod:2496 ../fish/guestfish-actions.pod:4165
13377 msgid "Returns file information for the given C<path>."
13382 #: ../src/guestfs-actions.pod:3630
13384 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13385 "link, then the link is stat-ed, not the file it refers to."
13390 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2502
13391 msgid "This is the same as the C<lstat(2)> system call."
13396 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:6190
13398 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13399 "error. I<The caller must call C<guestfs_free_stat> after use>."
13404 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:6194
13405 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6593
13406 msgid "(Added in 0.9.2)"
13411 #: ../src/guestfs-actions.pod:3642
13412 msgid "guestfs_lstatlist"
13417 #: ../src/guestfs-actions.pod:3644
13420 " struct guestfs_stat_list *\n"
13421 " guestfs_lstatlist (guestfs_h *g,\n"
13422 " const char *path,\n"
13423 " char *const *names);\n"
13429 #: ../src/guestfs-actions.pod:3649
13431 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13432 "files, where all files are in the directory C<path>. C<names> is the list "
13433 "of files from this directory."
13438 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2512
13440 "On return you get a list of stat structs, with a one-to-one correspondence "
13441 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13442 "then the C<ino> field of that structure is set to C<-1>."
13447 #: ../src/guestfs-actions.pod:3658
13449 "This call is intended for programs that want to efficiently list a directory "
13450 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13451 "for a similarly efficient call for getting extended attributes. Very long "
13452 "directory listings might cause the protocol message size to be exceeded, "
13453 "causing this call to fail. The caller must split up such requests into "
13454 "smaller groups of names."
13459 #: ../src/guestfs-actions.pod:3666
13461 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13462 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13467 #: ../src/guestfs-actions.pod:3672
13468 msgid "guestfs_luks_add_key"
13473 #: ../src/guestfs-actions.pod:3674
13477 " guestfs_luks_add_key (guestfs_h *g,\n"
13478 " const char *device,\n"
13479 " const char *key,\n"
13480 " const char *newkey,\n"
13487 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2529
13489 "This command adds a new key on LUKS device C<device>. C<key> is any "
13490 "existing key, and is used to access the device. C<newkey> is the new key to "
13491 "add. C<keyslot> is the key slot that will be replaced."
13496 #: ../src/guestfs-actions.pod:3686
13498 "Note that if C<keyslot> already contains a key, then this command will "
13499 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13504 #: ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3732
13505 #: ../src/guestfs-actions.pod:3755 ../src/guestfs-actions.pod:3775
13506 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:3826
13508 "This function takes a key or passphrase parameter which could contain "
13509 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13515 #: ../src/guestfs-actions.pod:3696 ../src/guestfs-actions.pod:3736
13516 #: ../src/guestfs-actions.pod:3759 ../src/guestfs-actions.pod:3779
13517 msgid "(Added in 1.5.2)"
13522 #: ../src/guestfs-actions.pod:3698
13523 msgid "guestfs_luks_close"
13528 #: ../src/guestfs-actions.pod:3700
13532 " guestfs_luks_close (guestfs_h *g,\n"
13533 " const char *device);\n"
13539 #: ../src/guestfs-actions.pod:3704
13541 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13542 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13543 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13544 "underlying block device."
13549 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3811
13550 #: ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3880
13551 #: ../src/guestfs-actions.pod:3928
13552 msgid "(Added in 1.5.1)"
13557 #: ../src/guestfs-actions.pod:3714
13558 msgid "guestfs_luks_format"
13563 #: ../src/guestfs-actions.pod:3716
13567 " guestfs_luks_format (guestfs_h *g,\n"
13568 " const char *device,\n"
13569 " const char *key,\n"
13576 #: ../src/guestfs-actions.pod:3722 ../fish/guestfish-actions.pod:2555
13578 "This command erases existing data on C<device> and formats the device as a "
13579 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13580 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13585 #: ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:3752
13586 #: ../src/guestfs-actions.pod:3892 ../src/guestfs-actions.pod:4834
13587 #: ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:6021
13588 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6070
13589 #: ../src/guestfs-actions.pod:7230 ../fish/guestfish-actions.pod:2563
13590 #: ../fish/guestfish-actions.pod:2576 ../fish/guestfish-actions.pod:2660
13591 #: ../fish/guestfish-actions.pod:3234 ../fish/guestfish-actions.pod:3754
13592 #: ../fish/guestfish-actions.pod:4064 ../fish/guestfish-actions.pod:4080
13593 #: ../fish/guestfish-actions.pod:4095 ../fish/guestfish-actions.pod:4810
13595 "B<This command is dangerous. Without careful use you can easily destroy all "
13601 #: ../src/guestfs-actions.pod:3738
13602 msgid "guestfs_luks_format_cipher"
13607 #: ../src/guestfs-actions.pod:3740
13611 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13612 " const char *device,\n"
13613 " const char *key,\n"
13615 " const char *cipher);\n"
13621 #: ../src/guestfs-actions.pod:3747
13623 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13624 "set the C<cipher> used."
13629 #: ../src/guestfs-actions.pod:3761
13630 msgid "guestfs_luks_kill_slot"
13635 #: ../src/guestfs-actions.pod:3763
13639 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13640 " const char *device,\n"
13641 " const char *key,\n"
13648 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2583
13650 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13651 "device C<device>. C<key> must be one of the I<other> keys."
13656 #: ../src/guestfs-actions.pod:3781
13657 msgid "guestfs_luks_open"
13662 #: ../src/guestfs-actions.pod:3783
13666 " guestfs_luks_open (guestfs_h *g,\n"
13667 " const char *device,\n"
13668 " const char *key,\n"
13669 " const char *mapname);\n"
13675 #: ../src/guestfs-actions.pod:3789 ../fish/guestfish-actions.pod:2594
13677 "This command opens a block device which has been encrypted according to the "
13678 "Linux Unified Key Setup (LUKS) standard."
13683 #: ../src/guestfs-actions.pod:3792 ../fish/guestfish-actions.pod:2597
13684 msgid "C<device> is the encrypted block device or partition."
13689 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2599
13691 "The caller must supply one of the keys associated with the LUKS block "
13692 "device, in the C<key> parameter."
13697 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2602
13699 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13700 "writes to this block device are decrypted from and encrypted to the "
13701 "underlying C<device> respectively."
13706 #: ../src/guestfs-actions.pod:3801
13708 "If this block device contains LVM volume groups, then calling "
13709 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13715 #: ../src/guestfs-actions.pod:3813
13716 msgid "guestfs_luks_open_ro"
13721 #: ../src/guestfs-actions.pod:3815
13725 " guestfs_luks_open_ro (guestfs_h *g,\n"
13726 " const char *device,\n"
13727 " const char *key,\n"
13728 " const char *mapname);\n"
13734 #: ../src/guestfs-actions.pod:3821
13736 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13742 #: ../src/guestfs-actions.pod:3832
13743 msgid "guestfs_lvcreate"
13748 #: ../src/guestfs-actions.pod:3834
13752 " guestfs_lvcreate (guestfs_h *g,\n"
13753 " const char *logvol,\n"
13754 " const char *volgroup,\n"
13761 #: ../src/guestfs-actions.pod:3840 ../fish/guestfish-actions.pod:2627
13763 "This creates an LVM logical volume called C<logvol> on the volume group "
13764 "C<volgroup>, with C<size> megabytes."
13769 #: ../src/guestfs-actions.pod:3847
13770 msgid "guestfs_lvm_canonical_lv_name"
13775 #: ../src/guestfs-actions.pod:3849
13779 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13780 " const char *lvname);\n"
13786 #: ../src/guestfs-actions.pod:3853 ../fish/guestfish-actions.pod:2634
13788 "This converts alternative naming schemes for LVs that you might find to the "
13789 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13795 #: ../src/guestfs-actions.pod:3857 ../fish/guestfish-actions.pod:2638
13797 "This command returns an error if the C<lvname> parameter does not refer to a "
13803 #: ../src/guestfs-actions.pod:3860
13804 msgid "See also C<guestfs_is_lv>."
13809 #: ../src/guestfs-actions.pod:3865
13810 msgid "(Added in 1.5.24)"
13815 #: ../src/guestfs-actions.pod:3867
13816 msgid "guestfs_lvm_clear_filter"
13821 #: ../src/guestfs-actions.pod:3869
13825 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13831 #: ../src/guestfs-actions.pod:3872
13833 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13834 "see every block device."
13839 #: ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3917
13840 #: ../fish/guestfish-actions.pod:2650 ../fish/guestfish-actions.pod:2681
13842 "This command also clears the LVM cache and performs a volume group scan."
13847 #: ../src/guestfs-actions.pod:3882
13848 msgid "guestfs_lvm_remove_all"
13853 #: ../src/guestfs-actions.pod:3884
13857 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13863 #: ../src/guestfs-actions.pod:3887 ../fish/guestfish-actions.pod:2657
13865 "This command removes all LVM logical volumes, volume groups and physical "
13871 #: ../src/guestfs-actions.pod:3897
13872 msgid "guestfs_lvm_set_filter"
13877 #: ../src/guestfs-actions.pod:3899
13881 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13882 " char *const *devices);\n"
13888 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2667
13890 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13891 "block devices in the list C<devices>, and will ignore all other attached "
13897 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2671
13899 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13900 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13901 "there are two types of duplication possible: either cloned PVs/VGs which "
13902 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13903 "same name. In normal operation you cannot create this situation, but you "
13904 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13905 "inside the LVM metadata."
13910 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2684
13911 msgid "You can filter whole block devices or individual partitions."
13916 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2686
13918 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13919 "filesystem), even if you are not filtering out that VG."
13924 #: ../src/guestfs-actions.pod:3930
13925 msgid "guestfs_lvremove"
13930 #: ../src/guestfs-actions.pod:3932
13934 " guestfs_lvremove (guestfs_h *g,\n"
13935 " const char *device);\n"
13941 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2694
13943 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13944 "LV, such as C</dev/VG/LV>."
13949 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2697
13951 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13957 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:5180
13958 #: ../src/guestfs-actions.pod:6969
13959 msgid "(Added in 1.0.13)"
13964 #: ../src/guestfs-actions.pod:3946
13965 msgid "guestfs_lvrename"
13970 #: ../src/guestfs-actions.pod:3948
13974 " guestfs_lvrename (guestfs_h *g,\n"
13975 " const char *logvol,\n"
13976 " const char *newlogvol);\n"
13982 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2704
13983 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13988 #: ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:6982
13989 msgid "(Added in 1.0.83)"
13994 #: ../src/guestfs-actions.pod:3959
13995 msgid "guestfs_lvresize"
14000 #: ../src/guestfs-actions.pod:3961
14004 " guestfs_lvresize (guestfs_h *g,\n"
14005 " const char *device,\n"
14012 #: ../src/guestfs-actions.pod:3966 ../fish/guestfish-actions.pod:2710
14014 "This resizes (expands or shrinks) an existing LVM logical volume to "
14015 "C<mbytes>. When reducing, data in the reduced part is lost."
14020 #: ../src/guestfs-actions.pod:3974
14021 msgid "guestfs_lvresize_free"
14026 #: ../src/guestfs-actions.pod:3976
14030 " guestfs_lvresize_free (guestfs_h *g,\n"
14031 " const char *lv,\n"
14038 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2718
14040 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14041 "remaining free space in the volume group. Commonly you would call this with "
14042 "pc = 100 which expands the logical volume as much as possible, using all "
14043 "remaining free space in the volume group."
14048 #: ../src/guestfs-actions.pod:3989
14049 msgid "(Added in 1.3.3)"
14054 #: ../src/guestfs-actions.pod:3991
14055 msgid "guestfs_lvs"
14060 #: ../src/guestfs-actions.pod:3993
14064 " guestfs_lvs (guestfs_h *g);\n"
14070 #: ../src/guestfs-actions.pod:3996 ../fish/guestfish-actions.pod:2728
14072 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14078 #: ../src/guestfs-actions.pod:3999 ../fish/guestfish-actions.pod:2731
14080 "This returns a list of the logical volume device names (eg. C</dev/"
14081 "VolGroup00/LogVol00>)."
14086 #: ../src/guestfs-actions.pod:4002
14087 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14092 #: ../src/guestfs-actions.pod:4010
14093 msgid "guestfs_lvs_full"
14098 #: ../src/guestfs-actions.pod:4012
14101 " struct guestfs_lvm_lv_list *\n"
14102 " guestfs_lvs_full (guestfs_h *g);\n"
14108 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2740
14110 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14111 "(8)> command. The \"full\" version includes all fields."
14116 #: ../src/guestfs-actions.pod:4018
14118 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14119 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14124 #: ../src/guestfs-actions.pod:4024
14125 msgid "guestfs_lvuuid"
14130 #: ../src/guestfs-actions.pod:4026
14134 " guestfs_lvuuid (guestfs_h *g,\n"
14135 " const char *device);\n"
14141 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2747
14142 msgid "This command returns the UUID of the LVM LV C<device>."
14147 #: ../src/guestfs-actions.pod:4037
14148 msgid "guestfs_lxattrlist"
14153 #: ../src/guestfs-actions.pod:4039
14156 " struct guestfs_xattr_list *\n"
14157 " guestfs_lxattrlist (guestfs_h *g,\n"
14158 " const char *path,\n"
14159 " char *const *names);\n"
14165 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2753
14167 "This call allows you to get the extended attributes of multiple files, where "
14168 "all files are in the directory C<path>. C<names> is the list of files from "
14174 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2757
14176 "On return you get a flat list of xattr structs which must be interpreted "
14177 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14178 "C<attrval> in this struct is zero-length to indicate there was an error "
14179 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14180 "number (the number of following attributes for this file, which could be C<"
14181 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14182 "for the first named file. This repeats for the second and subsequent files."
14187 #: ../src/guestfs-actions.pod:4058
14189 "This call is intended for programs that want to efficiently list a directory "
14190 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14191 "a similarly efficient call for getting standard stats. Very long directory "
14192 "listings might cause the protocol message size to be exceeded, causing this "
14193 "call to fail. The caller must split up such requests into smaller groups of "
14199 #: ../src/guestfs-actions.pod:4072
14200 msgid "guestfs_mkdir"
14205 #: ../src/guestfs-actions.pod:4074
14209 " guestfs_mkdir (guestfs_h *g,\n"
14210 " const char *path);\n"
14216 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2779
14217 msgid "Create a directory named C<path>."
14222 #: ../src/guestfs-actions.pod:4084
14223 msgid "guestfs_mkdir_mode"
14228 #: ../src/guestfs-actions.pod:4086
14232 " guestfs_mkdir_mode (guestfs_h *g,\n"
14233 " const char *path,\n"
14240 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2785
14242 "This command creates a directory, setting the initial permissions of the "
14243 "directory to C<mode>."
14248 #: ../src/guestfs-actions.pod:4094 ../fish/guestfish-actions.pod:2788
14250 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14251 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14257 #: ../src/guestfs-actions.pod:4098
14258 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14263 #: ../src/guestfs-actions.pod:4104
14264 msgid "guestfs_mkdir_p"
14269 #: ../src/guestfs-actions.pod:4106
14273 " guestfs_mkdir_p (guestfs_h *g,\n"
14274 " const char *path);\n"
14280 #: ../src/guestfs-actions.pod:4110 ../fish/guestfish-actions.pod:2798
14282 "Create a directory named C<path>, creating any parent directories as "
14283 "necessary. This is like the C<mkdir -p> shell command."
14288 #: ../src/guestfs-actions.pod:4117
14289 msgid "guestfs_mkdtemp"
14294 #: ../src/guestfs-actions.pod:4119
14298 " guestfs_mkdtemp (guestfs_h *g,\n"
14299 " const char *template);\n"
14305 #: ../src/guestfs-actions.pod:4123 ../fish/guestfish-actions.pod:2805
14307 "This command creates a temporary directory. The C<template> parameter "
14308 "should be a full pathname for the temporary directory name with the final "
14309 "six characters being \"XXXXXX\"."
14314 #: ../src/guestfs-actions.pod:4128 ../fish/guestfish-actions.pod:2810
14316 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14317 "being suitable for Windows filesystems."
14322 #: ../src/guestfs-actions.pod:4131 ../fish/guestfish-actions.pod:2813
14323 msgid "The name of the temporary directory that was created is returned."
14328 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:2816
14329 msgid "The temporary directory is created with mode 0700 and is owned by root."
14334 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:2819
14336 "The caller is responsible for deleting the temporary directory and its "
14337 "contents after use."
14342 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2822
14343 msgid "See also: L<mkdtemp(3)>"
14348 #: ../src/guestfs-actions.pod:4147
14349 msgid "guestfs_mke2fs_J"
14354 #: ../src/guestfs-actions.pod:4149
14358 " guestfs_mke2fs_J (guestfs_h *g,\n"
14359 " const char *fstype,\n"
14360 " int blocksize,\n"
14361 " const char *device,\n"
14362 " const char *journal);\n"
14368 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2828
14370 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14371 "C<journal>. It is equivalent to the command:"
14376 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2832
14379 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14385 #: ../src/guestfs-actions.pod:4162
14386 msgid "See also C<guestfs_mke2journal>."
14391 #: ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4184
14392 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4218
14393 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4246
14394 #: ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4570
14395 msgid "(Added in 1.0.68)"
14400 #: ../src/guestfs-actions.pod:4168
14401 msgid "guestfs_mke2fs_JL"
14406 #: ../src/guestfs-actions.pod:4170
14410 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14411 " const char *fstype,\n"
14412 " int blocksize,\n"
14413 " const char *device,\n"
14414 " const char *label);\n"
14420 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2840
14422 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14423 "the journal labeled C<label>."
14428 #: ../src/guestfs-actions.pod:4180
14429 msgid "See also C<guestfs_mke2journal_L>."
14434 #: ../src/guestfs-actions.pod:4186
14435 msgid "guestfs_mke2fs_JU"
14440 #: ../src/guestfs-actions.pod:4188
14444 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14445 " const char *fstype,\n"
14446 " int blocksize,\n"
14447 " const char *device,\n"
14448 " const char *uuid);\n"
14454 #: ../src/guestfs-actions.pod:4195 ../fish/guestfish-actions.pod:2849
14456 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14457 "the journal with UUID C<uuid>."
14462 #: ../src/guestfs-actions.pod:4198
14463 msgid "See also C<guestfs_mke2journal_U>."
14468 #: ../src/guestfs-actions.pod:4204
14469 msgid "guestfs_mke2journal"
14474 #: ../src/guestfs-actions.pod:4206
14478 " guestfs_mke2journal (guestfs_h *g,\n"
14479 " int blocksize,\n"
14480 " const char *device);\n"
14486 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2858
14488 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14494 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2861
14497 " mke2fs -O journal_dev -b blocksize device\n"
14503 #: ../src/guestfs-actions.pod:4220
14504 msgid "guestfs_mke2journal_L"
14509 #: ../src/guestfs-actions.pod:4222
14513 " guestfs_mke2journal_L (guestfs_h *g,\n"
14514 " int blocksize,\n"
14515 " const char *label,\n"
14516 " const char *device);\n"
14522 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2867
14523 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14528 #: ../src/guestfs-actions.pod:4234
14529 msgid "guestfs_mke2journal_U"
14534 #: ../src/guestfs-actions.pod:4236
14538 " guestfs_mke2journal_U (guestfs_h *g,\n"
14539 " int blocksize,\n"
14540 " const char *uuid,\n"
14541 " const char *device);\n"
14547 #: ../src/guestfs-actions.pod:4242 ../fish/guestfish-actions.pod:2873
14548 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14553 #: ../src/guestfs-actions.pod:4248
14554 msgid "guestfs_mkfifo"
14559 #: ../src/guestfs-actions.pod:4250
14563 " guestfs_mkfifo (guestfs_h *g,\n"
14565 " const char *path);\n"
14571 #: ../src/guestfs-actions.pod:4255
14573 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14574 "is just a convenient wrapper around C<guestfs_mknod>."
14579 #: ../src/guestfs-actions.pod:4265
14580 msgid "guestfs_mkfs"
14585 #: ../src/guestfs-actions.pod:4267
14589 " guestfs_mkfs (guestfs_h *g,\n"
14590 " const char *fstype,\n"
14591 " const char *device);\n"
14597 #: ../src/guestfs-actions.pod:4272 ../fish/guestfish-actions.pod:2889
14599 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14600 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14605 #: ../src/guestfs-actions.pod:4280
14606 msgid "guestfs_mkfs_b"
14611 #: ../src/guestfs-actions.pod:4282
14615 " guestfs_mkfs_b (guestfs_h *g,\n"
14616 " const char *fstype,\n"
14617 " int blocksize,\n"
14618 " const char *device);\n"
14624 #: ../src/guestfs-actions.pod:4288
14626 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14627 "block size of the resulting filesystem. Supported block sizes depend on the "
14628 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14633 #: ../src/guestfs-actions.pod:4293 ../src/guestfs-actions.pod:4336
14634 #: ../fish/guestfish-actions.pod:2902 ../fish/guestfish-actions.pod:2929
14636 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14642 #: ../src/guestfs-actions.pod:4298 ../fish/guestfish-actions.pod:2905
14644 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14649 #: ../src/guestfs-actions.pod:4307
14650 msgid "guestfs_mkfs_opts"
14655 #: ../src/guestfs-actions.pod:4309
14659 " guestfs_mkfs_opts (guestfs_h *g,\n"
14660 " const char *fstype,\n"
14661 " const char *device,\n"
14667 #: ../src/guestfs-actions.pod:4320
14670 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14671 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14677 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2916
14679 "This function creates a filesystem on C<device>. The filesystem type is "
14680 "C<fstype>, for example C<ext3>."
14685 #: ../src/guestfs-actions.pod:4330 ../fish/guestfish-actions.pod:2923
14686 msgid "C<blocksize>"
14691 #: ../src/guestfs-actions.pod:4332 ../fish/guestfish-actions.pod:2925
14693 "The filesystem block size. Supported block sizes depend on the filesystem "
14694 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14699 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2932
14700 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14704 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2934
14705 msgid "C<features>"
14709 #: ../src/guestfs-actions.pod:4343 ../fish/guestfish-actions.pod:2936
14710 msgid "This passes the C<-O> parameter to the external mkfs program."
14714 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2938
14716 "For certain filesystem types, this allows extra filesystem features to be "
14717 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14721 #: ../src/guestfs-actions.pod:4349 ../fish/guestfish-actions.pod:2942
14723 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14728 #: ../src/guestfs-actions.pod:4356
14729 msgid "(Added in 1.7.19)"
14734 #: ../src/guestfs-actions.pod:4358
14735 msgid "guestfs_mkfs_opts_va"
14740 #: ../src/guestfs-actions.pod:4360
14744 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14745 " const char *fstype,\n"
14746 " const char *device,\n"
14747 " va_list args);\n"
14753 #: ../src/guestfs-actions.pod:4366
14754 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14759 #: ../src/guestfs-actions.pod:4370
14760 msgid "guestfs_mkfs_opts_argv"
14765 #: ../src/guestfs-actions.pod:4372
14769 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14770 " const char *fstype,\n"
14771 " const char *device,\n"
14772 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14778 #: ../src/guestfs-actions.pod:4378
14779 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14784 #: ../src/guestfs-actions.pod:4382
14785 msgid "guestfs_mkmountpoint"
14790 #: ../src/guestfs-actions.pod:4384
14794 " guestfs_mkmountpoint (guestfs_h *g,\n"
14795 " const char *exemptpath);\n"
14801 #: ../src/guestfs-actions.pod:4388
14803 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14804 "that can be used to create extra mountpoints before mounting the first "
14810 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2957
14812 "These calls are I<only> necessary in some very limited circumstances, mainly "
14813 "the case where you want to mount a mix of unrelated and/or read-only "
14814 "filesystems together."
14819 #: ../src/guestfs-actions.pod:4396 ../fish/guestfish-actions.pod:2961
14821 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14822 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14823 "inside that. You can unpack this as follows in guestfish:"
14828 #: ../src/guestfs-actions.pod:4401 ../fish/guestfish-actions.pod:2966
14831 " add-ro Fedora-11-i686-Live.iso\n"
14833 " mkmountpoint /cd\n"
14834 " mkmountpoint /sqsh\n"
14835 " mkmountpoint /ext3fs\n"
14836 " mount /dev/sda /cd\n"
14837 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14838 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14844 #: ../src/guestfs-actions.pod:4410 ../fish/guestfish-actions.pod:2975
14845 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14850 #: ../src/guestfs-actions.pod:4412
14852 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14853 "may get unexpected errors if you try to mix these calls. It is safest to "
14854 "manually unmount filesystems and remove mountpoints after use."
14859 #: ../src/guestfs-actions.pod:4416
14861 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14862 "first, so for this to work for manual mountpoints, you must ensure that the "
14863 "innermost mountpoints have the longest pathnames, as in the example code "
14869 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:2986
14871 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14875 #: ../src/guestfs-actions.pod:4423
14877 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14878 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14879 "can also trigger these issues."
14884 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4688
14885 #: ../src/guestfs-actions.pod:5598
14886 msgid "(Added in 1.0.62)"
14891 #: ../src/guestfs-actions.pod:4431
14892 msgid "guestfs_mknod"
14897 #: ../src/guestfs-actions.pod:4433
14901 " guestfs_mknod (guestfs_h *g,\n"
14905 " const char *path);\n"
14911 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:2996
14913 "This call creates block or character special devices, or named pipes (FIFOs)."
14918 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2999
14920 "The C<mode> parameter should be the mode, using the standard constants. "
14921 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14922 "used when creating block and character special devices."
14927 #: ../src/guestfs-actions.pod:4448
14929 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14930 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14931 "regular file). These constants are available in the standard Linux header "
14932 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14933 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14934 "the appropriate constant for you."
14939 #: ../src/guestfs-actions.pod:4462
14940 msgid "guestfs_mknod_b"
14945 #: ../src/guestfs-actions.pod:4464
14949 " guestfs_mknod_b (guestfs_h *g,\n"
14953 " const char *path);\n"
14959 #: ../src/guestfs-actions.pod:4471
14961 "This call creates a block device node called C<path> with mode C<mode> and "
14962 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14963 "wrapper around C<guestfs_mknod>."
14968 #: ../src/guestfs-actions.pod:4481
14969 msgid "guestfs_mknod_c"
14974 #: ../src/guestfs-actions.pod:4483
14978 " guestfs_mknod_c (guestfs_h *g,\n"
14982 " const char *path);\n"
14988 #: ../src/guestfs-actions.pod:4490
14990 "This call creates a char device node called C<path> with mode C<mode> and "
14991 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14992 "wrapper around C<guestfs_mknod>."
14997 #: ../src/guestfs-actions.pod:4500
14998 msgid "guestfs_mkswap"
15003 #: ../src/guestfs-actions.pod:4502
15007 " guestfs_mkswap (guestfs_h *g,\n"
15008 " const char *device);\n"
15014 #: ../src/guestfs-actions.pod:4506 ../fish/guestfish-actions.pod:3038
15015 msgid "Create a swap partition on C<device>."
15020 #: ../src/guestfs-actions.pod:4512
15021 msgid "guestfs_mkswap_L"
15026 #: ../src/guestfs-actions.pod:4514
15030 " guestfs_mkswap_L (guestfs_h *g,\n"
15031 " const char *label,\n"
15032 " const char *device);\n"
15038 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3044
15039 msgid "Create a swap partition on C<device> with label C<label>."
15044 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3046
15046 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15047 "sda>), just to a partition. This appears to be a limitation of the kernel "
15053 #: ../src/guestfs-actions.pod:4529
15054 msgid "guestfs_mkswap_U"
15059 #: ../src/guestfs-actions.pod:4531
15063 " guestfs_mkswap_U (guestfs_h *g,\n"
15064 " const char *uuid,\n"
15065 " const char *device);\n"
15071 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3054
15072 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15077 #: ../src/guestfs-actions.pod:4542
15078 msgid "guestfs_mkswap_file"
15083 #: ../src/guestfs-actions.pod:4544
15087 " guestfs_mkswap_file (guestfs_h *g,\n"
15088 " const char *path);\n"
15094 #: ../src/guestfs-actions.pod:4548 ../fish/guestfish-actions.pod:3060
15095 msgid "Create a swap file."
15100 #: ../src/guestfs-actions.pod:4550
15102 "This command just writes a swap file signature to an existing file. To "
15103 "create the file itself, use something like C<guestfs_fallocate>."
15108 #: ../src/guestfs-actions.pod:4557
15109 msgid "guestfs_modprobe"
15114 #: ../src/guestfs-actions.pod:4559
15118 " guestfs_modprobe (guestfs_h *g,\n"
15119 " const char *modulename);\n"
15125 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3069
15126 msgid "This loads a kernel module in the appliance."
15131 #: ../src/guestfs-actions.pod:4565 ../fish/guestfish-actions.pod:3071
15133 "The kernel module must have been whitelisted when libguestfs was built (see "
15134 "C<appliance/kmod.whitelist.in> in the source)."
15139 #: ../src/guestfs-actions.pod:4572
15140 msgid "guestfs_mount"
15145 #: ../src/guestfs-actions.pod:4574
15149 " guestfs_mount (guestfs_h *g,\n"
15150 " const char *device,\n"
15151 " const char *mountpoint);\n"
15157 #: ../src/guestfs-actions.pod:4579 ../fish/guestfish-actions.pod:3078
15159 "Mount a guest disk at a position in the filesystem. Block devices are named "
15160 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15161 "those block devices contain partitions, they will have the usual names (eg. "
15162 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15167 #: ../src/guestfs-actions.pod:4585 ../fish/guestfish-actions.pod:3084
15169 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15170 "mounted on C</> before others can be mounted. Other filesystems can only be "
15171 "mounted on directories which already exist."
15176 #: ../src/guestfs-actions.pod:4590 ../fish/guestfish-actions.pod:3089
15178 "The mounted filesystem is writable, if we have sufficient permissions on the "
15179 "underlying device."
15184 #: ../src/guestfs-actions.pod:4593
15186 "B<Important note:> When you use this call, the filesystem options C<sync> "
15187 "and C<noatime> are set implicitly. This was originally done because we "
15188 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15189 "very large negative performance impact and negligible effect on "
15190 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15191 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15192 "(use an empty string for the first parameter if you don't want any options)."
15197 #: ../src/guestfs-actions.pod:4607
15198 msgid "guestfs_mount_loop"
15203 #: ../src/guestfs-actions.pod:4609
15207 " guestfs_mount_loop (guestfs_h *g,\n"
15208 " const char *file,\n"
15209 " const char *mountpoint);\n"
15215 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3106
15217 "This command lets you mount C<file> (a filesystem image in a file) on a "
15218 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15224 #: ../src/guestfs-actions.pod:4622
15225 msgid "guestfs_mount_options"
15230 #: ../src/guestfs-actions.pod:4624
15234 " guestfs_mount_options (guestfs_h *g,\n"
15235 " const char *options,\n"
15236 " const char *device,\n"
15237 " const char *mountpoint);\n"
15243 #: ../src/guestfs-actions.pod:4630
15245 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15246 "the mount options as for the L<mount(8)> I<-o> flag."
15251 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3118
15253 "If the C<options> parameter is an empty string, then no options are passed "
15254 "(all options default to whatever the filesystem uses)."
15259 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4654
15260 #: ../src/guestfs-actions.pod:4671
15261 msgid "(Added in 1.0.10)"
15266 #: ../src/guestfs-actions.pod:4642
15267 msgid "guestfs_mount_ro"
15272 #: ../src/guestfs-actions.pod:4644
15276 " guestfs_mount_ro (guestfs_h *g,\n"
15277 " const char *device,\n"
15278 " const char *mountpoint);\n"
15284 #: ../src/guestfs-actions.pod:4649
15286 "This is the same as the C<guestfs_mount> command, but it mounts the "
15287 "filesystem with the read-only (I<-o ro>) flag."
15292 #: ../src/guestfs-actions.pod:4656
15293 msgid "guestfs_mount_vfs"
15298 #: ../src/guestfs-actions.pod:4658
15302 " guestfs_mount_vfs (guestfs_h *g,\n"
15303 " const char *options,\n"
15304 " const char *vfstype,\n"
15305 " const char *device,\n"
15306 " const char *mountpoint);\n"
15312 #: ../src/guestfs-actions.pod:4665
15314 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15315 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15321 #: ../src/guestfs-actions.pod:4673
15322 msgid "guestfs_mountpoints"
15327 #: ../src/guestfs-actions.pod:4675
15331 " guestfs_mountpoints (guestfs_h *g);\n"
15337 #: ../src/guestfs-actions.pod:4678
15339 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15340 "devices. This one returns a hash table (map) of device name to directory "
15341 "where the device is mounted."
15346 #: ../src/guestfs-actions.pod:4690
15347 msgid "guestfs_mounts"
15352 #: ../src/guestfs-actions.pod:4692
15356 " guestfs_mounts (guestfs_h *g);\n"
15362 #: ../src/guestfs-actions.pod:4695 ../fish/guestfish-actions.pod:3149
15364 "This returns the list of currently mounted filesystems. It returns the list "
15365 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15370 #: ../src/guestfs-actions.pod:4698 ../fish/guestfish-actions.pod:3152
15371 msgid "Some internal mounts are not shown."
15376 #: ../src/guestfs-actions.pod:4700
15377 msgid "See also: C<guestfs_mountpoints>"
15382 #: ../src/guestfs-actions.pod:4708
15388 #: ../src/guestfs-actions.pod:4710
15392 " guestfs_mv (guestfs_h *g,\n"
15393 " const char *src,\n"
15394 " const char *dest);\n"
15400 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3160
15402 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15403 "destination filename or destination directory."
15408 #: ../src/guestfs-actions.pod:4722
15409 msgid "guestfs_ntfs_3g_probe"
15414 #: ../src/guestfs-actions.pod:4724
15418 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15420 " const char *device);\n"
15426 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3167
15428 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15429 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15430 "write, and some cannot be mounted at all)."
15435 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3171
15437 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15438 "can be mounted read-write. Set it to false if you want to test if the "
15439 "volume can be mounted read-only."
15444 #: ../src/guestfs-actions.pod:4737 ../fish/guestfish-actions.pod:3175
15446 "The return value is an integer which C<0> if the operation would succeed, or "
15447 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15452 #: ../src/guestfs-actions.pod:4743
15453 msgid "(Added in 1.0.43)"
15458 #: ../src/guestfs-actions.pod:4745
15459 msgid "guestfs_ntfsresize"
15464 #: ../src/guestfs-actions.pod:4747
15468 " guestfs_ntfsresize (guestfs_h *g,\n"
15469 " const char *device);\n"
15475 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3183
15477 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15478 "size of the underlying device. See also L<ntfsresize(8)>."
15483 #: ../src/guestfs-actions.pod:4759
15484 msgid "guestfs_ntfsresize_size"
15489 #: ../src/guestfs-actions.pod:4761
15493 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15494 " const char *device,\n"
15495 " int64_t size);\n"
15501 #: ../src/guestfs-actions.pod:4766
15503 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15504 "to specify the new size (in bytes) explicitly."
15509 #: ../src/guestfs-actions.pod:4771 ../src/guestfs-actions.pod:5207
15510 #: ../src/guestfs-actions.pod:5280 ../src/guestfs-actions.pod:5546
15511 #: ../src/guestfs-actions.pod:7117
15512 msgid "(Added in 1.3.14)"
15517 #: ../src/guestfs-actions.pod:4773
15518 msgid "guestfs_part_add"
15523 #: ../src/guestfs-actions.pod:4775
15527 " guestfs_part_add (guestfs_h *g,\n"
15528 " const char *device,\n"
15529 " const char *prlogex,\n"
15530 " int64_t startsect,\n"
15531 " int64_t endsect);\n"
15537 #: ../src/guestfs-actions.pod:4782
15539 "This command adds a partition to C<device>. If there is no partition table "
15540 "on the device, call C<guestfs_part_init> first."
15545 #: ../src/guestfs-actions.pod:4785 ../fish/guestfish-actions.pod:3201
15547 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15548 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15549 "C<logical>) and C<e> (or C<extended>) partition types."
15554 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3206
15556 "C<startsect> and C<endsect> are the start and end of the partition in "
15557 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15558 "from the end of the disk (C<-1> is the last sector)."
15563 #: ../src/guestfs-actions.pod:4794
15565 "Creating a partition which covers the whole disk is not so easy. Use "
15566 "C<guestfs_part_disk> to do that."
15571 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4837
15572 #: ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4968
15573 #: ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5025
15574 #: ../src/guestfs-actions.pod:5065
15575 msgid "(Added in 1.0.78)"
15580 #: ../src/guestfs-actions.pod:4801
15581 msgid "guestfs_part_del"
15586 #: ../src/guestfs-actions.pod:4803
15590 " guestfs_part_del (guestfs_h *g,\n"
15591 " const char *device,\n"
15598 #: ../src/guestfs-actions.pod:4808 ../fish/guestfish-actions.pod:3217
15599 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15604 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3219
15606 "Note that in the case of MBR partitioning, deleting an extended partition "
15607 "also deletes any logical partitions it contains."
15612 #: ../src/guestfs-actions.pod:4818
15613 msgid "guestfs_part_disk"
15618 #: ../src/guestfs-actions.pod:4820
15622 " guestfs_part_disk (guestfs_h *g,\n"
15623 " const char *device,\n"
15624 " const char *parttype);\n"
15630 #: ../src/guestfs-actions.pod:4825
15632 "This command is simply a combination of C<guestfs_part_init> followed by "
15633 "C<guestfs_part_add> to create a single primary partition covering the whole "
15639 #: ../src/guestfs-actions.pod:4829
15641 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15642 "possible values are described in C<guestfs_part_init>."
15647 #: ../src/guestfs-actions.pod:4839
15648 msgid "guestfs_part_get_bootable"
15653 #: ../src/guestfs-actions.pod:4841
15657 " guestfs_part_get_bootable (guestfs_h *g,\n"
15658 " const char *device,\n"
15665 #: ../src/guestfs-actions.pod:4846 ../fish/guestfish-actions.pod:3241
15667 "This command returns true if the partition C<partnum> on C<device> has the "
15668 "bootable flag set."
15673 #: ../src/guestfs-actions.pod:4849
15674 msgid "See also C<guestfs_part_set_bootable>."
15679 #: ../src/guestfs-actions.pod:4855
15680 msgid "guestfs_part_get_mbr_id"
15685 #: ../src/guestfs-actions.pod:4857
15689 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15690 " const char *device,\n"
15697 #: ../src/guestfs-actions.pod:4862 ../fish/guestfish-actions.pod:3250
15699 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15700 "partition C<partnum>."
15705 #: ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:5041
15707 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15708 "undefined results for other partition table types (see "
15709 "C<guestfs_part_get_parttype>)."
15714 #: ../src/guestfs-actions.pod:4873
15715 msgid "guestfs_part_get_parttype"
15720 #: ../src/guestfs-actions.pod:4875
15724 " guestfs_part_get_parttype (guestfs_h *g,\n"
15725 " const char *device);\n"
15731 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3261
15733 "This command examines the partition table on C<device> and returns the "
15734 "partition table type (format) being used."
15739 #: ../src/guestfs-actions.pod:4882
15741 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15742 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15743 "possible, although unusual. See C<guestfs_part_init> for a full list."
15748 #: ../src/guestfs-actions.pod:4892
15749 msgid "guestfs_part_init"
15754 #: ../src/guestfs-actions.pod:4894
15758 " guestfs_part_init (guestfs_h *g,\n"
15759 " const char *device,\n"
15760 " const char *parttype);\n"
15766 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3273
15768 "This creates an empty partition table on C<device> of one of the partition "
15769 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15770 "(for large disks)."
15775 #: ../src/guestfs-actions.pod:4903
15777 "Initially there are no partitions. Following this, you should call "
15778 "C<guestfs_part_add> for each partition required."
15783 #: ../src/guestfs-actions.pod:4906 ../fish/guestfish-actions.pod:3280
15784 msgid "Possible values for C<parttype> are:"
15789 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3284
15790 msgid "B<efi> | B<gpt>"
15795 #: ../src/guestfs-actions.pod:4912 ../fish/guestfish-actions.pod:3286
15796 msgid "Intel EFI / GPT partition table."
15801 #: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3288
15803 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15804 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15805 "the C<mbr> format."
15810 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3292
15811 msgid "B<mbr> | B<msdos>"
15816 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3294
15818 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15819 "Windows. This partition type will B<only> work for device sizes up to 2 "
15820 "TB. For large disks we recommend using C<gpt>."
15825 #: ../src/guestfs-actions.pod:4927 ../fish/guestfish-actions.pod:3301
15827 "Other partition table types that may work but are not supported include:"
15832 #: ../src/guestfs-actions.pod:4932 ../fish/guestfish-actions.pod:3306
15838 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3308
15839 msgid "AIX disk labels."
15844 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3310
15845 msgid "B<amiga> | B<rdb>"
15850 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3312
15851 msgid "Amiga \"Rigid Disk Block\" format."
15856 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3314
15862 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3316
15863 msgid "BSD disk labels."
15868 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3318
15874 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3320
15875 msgid "DASD, used on IBM mainframes."
15880 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3322
15886 #: ../src/guestfs-actions.pod:4950 ../fish/guestfish-actions.pod:3324
15887 msgid "MIPS/SGI volumes."
15892 #: ../src/guestfs-actions.pod:4952 ../fish/guestfish-actions.pod:3326
15898 #: ../src/guestfs-actions.pod:4954 ../fish/guestfish-actions.pod:3328
15899 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15904 #: ../src/guestfs-actions.pod:4956 ../fish/guestfish-actions.pod:3330
15910 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3332
15911 msgid "NEC PC-98 format, common in Japan apparently."
15916 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3334
15922 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3336
15923 msgid "Sun disk labels."
15928 #: ../src/guestfs-actions.pod:4970
15929 msgid "guestfs_part_list"
15934 #: ../src/guestfs-actions.pod:4972
15937 " struct guestfs_partition_list *\n"
15938 " guestfs_part_list (guestfs_h *g,\n"
15939 " const char *device);\n"
15945 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3344
15947 "This command parses the partition table on C<device> and returns the list of "
15948 "partitions found."
15953 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3347
15954 msgid "The fields in the returned structure are:"
15959 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3351
15960 msgid "B<part_num>"
15965 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3353
15966 msgid "Partition number, counting from 1."
15971 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3355
15972 msgid "B<part_start>"
15977 #: ../src/guestfs-actions.pod:4989
15979 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15980 "the device's sector size, see C<guestfs_blockdev_getss>."
15985 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3360
15986 msgid "B<part_end>"
15991 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3362
15992 msgid "End of the partition in bytes."
15997 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3364
15998 msgid "B<part_size>"
16003 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3366
16004 msgid "Size of the partition in bytes."
16009 #: ../src/guestfs-actions.pod:5002
16011 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16012 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16018 #: ../src/guestfs-actions.pod:5008
16019 msgid "guestfs_part_set_bootable"
16024 #: ../src/guestfs-actions.pod:5010
16028 " guestfs_part_set_bootable (guestfs_h *g,\n"
16029 " const char *device,\n"
16031 " int bootable);\n"
16037 #: ../src/guestfs-actions.pod:5016 ../fish/guestfish-actions.pod:3374
16039 "This sets the bootable flag on partition numbered C<partnum> on device "
16040 "C<device>. Note that partitions are numbered from 1."
16045 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3377
16047 "The bootable flag is used by some operating systems (notably Windows) to "
16048 "determine which partition to boot from. It is by no means universally "
16054 #: ../src/guestfs-actions.pod:5027
16055 msgid "guestfs_part_set_mbr_id"
16060 #: ../src/guestfs-actions.pod:5029
16064 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16065 " const char *device,\n"
16073 #: ../src/guestfs-actions.pod:5035 ../fish/guestfish-actions.pod:3385
16075 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16076 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16077 "documentation are in fact hexadecimal numbers, but usually documented "
16078 "without any leading \"0x\" which might be confusing."
16083 #: ../src/guestfs-actions.pod:5049
16084 msgid "guestfs_part_set_name"
16089 #: ../src/guestfs-actions.pod:5051
16093 " guestfs_part_set_name (guestfs_h *g,\n"
16094 " const char *device,\n"
16096 " const char *name);\n"
16102 #: ../src/guestfs-actions.pod:5057 ../fish/guestfish-actions.pod:3399
16104 "This sets the partition name on partition numbered C<partnum> on device "
16105 "C<device>. Note that partitions are numbered from 1."
16110 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3402
16112 "The partition name can only be set on certain types of partition table. "
16113 "This works on C<gpt> but not on C<mbr> partitions."
16118 #: ../src/guestfs-actions.pod:5067
16119 msgid "guestfs_part_to_dev"
16124 #: ../src/guestfs-actions.pod:5069
16128 " guestfs_part_to_dev (guestfs_h *g,\n"
16129 " const char *partition);\n"
16135 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3409
16137 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16138 "partition number, returning the device name (eg. \"/dev/sdb\")."
16143 #: ../src/guestfs-actions.pod:5077
16145 "The named partition must exist, for example as a string returned from "
16146 "C<guestfs_list_partitions>."
16151 #: ../src/guestfs-actions.pod:5085
16152 msgid "guestfs_ping_daemon"
16157 #: ../src/guestfs-actions.pod:5087
16161 " guestfs_ping_daemon (guestfs_h *g);\n"
16167 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3420
16169 "This is a test probe into the guestfs daemon running inside the qemu "
16170 "subprocess. Calling this function checks that the daemon responds to the "
16171 "ping message, without affecting the daemon or attached block device(s) in "
16177 #: ../src/guestfs-actions.pod:5099
16178 msgid "guestfs_pread"
16183 #: ../src/guestfs-actions.pod:5101
16187 " guestfs_pread (guestfs_h *g,\n"
16188 " const char *path,\n"
16190 " int64_t offset,\n"
16191 " size_t *size_r);\n"
16197 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3429
16199 "This command lets you read part of a file. It reads C<count> bytes of the "
16200 "file, starting at C<offset>, from file C<path>."
16205 #: ../src/guestfs-actions.pod:5111 ../src/guestfs-actions.pod:5137
16206 #: ../fish/guestfish-actions.pod:3432 ../fish/guestfish-actions.pod:3447
16208 "This may read fewer bytes than requested. For further details see the "
16209 "L<pread(2)> system call."
16214 #: ../src/guestfs-actions.pod:5114
16215 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16220 #: ../src/guestfs-actions.pod:5125
16221 msgid "guestfs_pread_device"
16226 #: ../src/guestfs-actions.pod:5127
16230 " guestfs_pread_device (guestfs_h *g,\n"
16231 " const char *device,\n"
16233 " int64_t offset,\n"
16234 " size_t *size_r);\n"
16240 #: ../src/guestfs-actions.pod:5134 ../fish/guestfish-actions.pod:3444
16242 "This command lets you read part of a file. It reads C<count> bytes of "
16243 "C<device>, starting at C<offset>."
16248 #: ../src/guestfs-actions.pod:5140
16249 msgid "See also C<guestfs_pread>."
16254 #: ../src/guestfs-actions.pod:5149
16255 msgid "(Added in 1.5.21)"
16260 #: ../src/guestfs-actions.pod:5151
16261 msgid "guestfs_pvcreate"
16266 #: ../src/guestfs-actions.pod:5153
16270 " guestfs_pvcreate (guestfs_h *g,\n"
16271 " const char *device);\n"
16277 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3459
16279 "This creates an LVM physical volume on the named C<device>, where C<device> "
16280 "should usually be a partition name such as C</dev/sda1>."
16285 #: ../src/guestfs-actions.pod:5165
16286 msgid "guestfs_pvremove"
16291 #: ../src/guestfs-actions.pod:5167
16295 " guestfs_pvremove (guestfs_h *g,\n"
16296 " const char *device);\n"
16302 #: ../src/guestfs-actions.pod:5171 ../fish/guestfish-actions.pod:3467
16304 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16310 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3470
16312 "The implementation uses the C<pvremove> command which refuses to wipe "
16313 "physical volumes that contain any volume groups, so you have to remove those "
16319 #: ../src/guestfs-actions.pod:5182
16320 msgid "guestfs_pvresize"
16325 #: ../src/guestfs-actions.pod:5184
16329 " guestfs_pvresize (guestfs_h *g,\n"
16330 " const char *device);\n"
16336 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3478
16338 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16339 "the new size of the underlying device."
16344 #: ../src/guestfs-actions.pod:5195
16345 msgid "guestfs_pvresize_size"
16350 #: ../src/guestfs-actions.pod:5197
16354 " guestfs_pvresize_size (guestfs_h *g,\n"
16355 " const char *device,\n"
16356 " int64_t size);\n"
16362 #: ../src/guestfs-actions.pod:5202
16364 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16365 "specify the new size (in bytes) explicitly."
16370 #: ../src/guestfs-actions.pod:5209
16371 msgid "guestfs_pvs"
16376 #: ../src/guestfs-actions.pod:5211
16380 " guestfs_pvs (guestfs_h *g);\n"
16386 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3492
16388 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16394 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3495
16396 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16402 #: ../src/guestfs-actions.pod:5220
16403 msgid "See also C<guestfs_pvs_full>."
16408 #: ../src/guestfs-actions.pod:5228
16409 msgid "guestfs_pvs_full"
16414 #: ../src/guestfs-actions.pod:5230
16417 " struct guestfs_lvm_pv_list *\n"
16418 " guestfs_pvs_full (guestfs_h *g);\n"
16424 #: ../src/guestfs-actions.pod:5233 ../fish/guestfish-actions.pod:3504
16426 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16427 "(8)> command. The \"full\" version includes all fields."
16432 #: ../src/guestfs-actions.pod:5236
16434 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16435 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16440 #: ../src/guestfs-actions.pod:5242
16441 msgid "guestfs_pvuuid"
16446 #: ../src/guestfs-actions.pod:5244
16450 " guestfs_pvuuid (guestfs_h *g,\n"
16451 " const char *device);\n"
16457 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3511
16458 msgid "This command returns the UUID of the LVM PV C<device>."
16463 #: ../src/guestfs-actions.pod:5255
16464 msgid "guestfs_pwrite"
16469 #: ../src/guestfs-actions.pod:5257
16473 " guestfs_pwrite (guestfs_h *g,\n"
16474 " const char *path,\n"
16475 " const char *content,\n"
16476 " size_t content_size,\n"
16477 " int64_t offset);\n"
16483 #: ../src/guestfs-actions.pod:5264 ../fish/guestfish-actions.pod:3517
16485 "This command writes to part of a file. It writes the data buffer C<content> "
16486 "to the file C<path> starting at offset C<offset>."
16491 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3520
16493 "This command implements the L<pwrite(2)> system call, and like that system "
16494 "call it may not write the full data requested. The return value is the "
16495 "number of bytes that were actually written to the file. This could even be "
16496 "0, although short writes are unlikely for regular files in ordinary "
16502 #: ../src/guestfs-actions.pod:5273
16503 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16508 #: ../src/guestfs-actions.pod:5282
16509 msgid "guestfs_pwrite_device"
16514 #: ../src/guestfs-actions.pod:5284
16518 " guestfs_pwrite_device (guestfs_h *g,\n"
16519 " const char *device,\n"
16520 " const char *content,\n"
16521 " size_t content_size,\n"
16522 " int64_t offset);\n"
16528 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3535
16530 "This command writes to part of a device. It writes the data buffer "
16531 "C<content> to C<device> starting at offset C<offset>."
16536 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3538
16538 "This command implements the L<pwrite(2)> system call, and like that system "
16539 "call it may not write the full data requested (although short writes to disk "
16540 "devices and partitions are probably impossible with standard Linux kernels)."
16545 #: ../src/guestfs-actions.pod:5299
16546 msgid "See also C<guestfs_pwrite>."
16551 #: ../src/guestfs-actions.pod:5306
16552 msgid "(Added in 1.5.20)"
16557 #: ../src/guestfs-actions.pod:5308
16558 msgid "guestfs_read_file"
16563 #: ../src/guestfs-actions.pod:5310
16567 " guestfs_read_file (guestfs_h *g,\n"
16568 " const char *path,\n"
16569 " size_t *size_r);\n"
16575 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3552
16576 msgid "This calls returns the contents of the file C<path> as a buffer."
16581 #: ../src/guestfs-actions.pod:5318
16583 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16584 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16585 "function is limited in the total size of file that can be handled."
16590 #: ../src/guestfs-actions.pod:5330
16591 msgid "(Added in 1.0.63)"
16596 #: ../src/guestfs-actions.pod:5332
16597 msgid "guestfs_read_lines"
16602 #: ../src/guestfs-actions.pod:5334
16606 " guestfs_read_lines (guestfs_h *g,\n"
16607 " const char *path);\n"
16613 #: ../src/guestfs-actions.pod:5340 ../fish/guestfish-actions.pod:3569
16615 "The file contents are returned as a list of lines. Trailing C<LF> and "
16616 "C<CRLF> character sequences are I<not> returned."
16621 #: ../src/guestfs-actions.pod:5343
16623 "Note that this function cannot correctly handle binary files (specifically, "
16624 "files containing C<\\0> character which is treated as end of line). For "
16625 "those you need to use the C<guestfs_read_file> function which has a more "
16626 "complex interface."
16631 #: ../src/guestfs-actions.pod:5354
16632 msgid "guestfs_readdir"
16637 #: ../src/guestfs-actions.pod:5356
16640 " struct guestfs_dirent_list *\n"
16641 " guestfs_readdir (guestfs_h *g,\n"
16642 " const char *dir);\n"
16648 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3581
16649 msgid "This returns the list of directory entries in directory C<dir>."
16654 #: ../src/guestfs-actions.pod:5362 ../fish/guestfish-actions.pod:3583
16656 "All entries in the directory are returned, including C<.> and C<..>. The "
16657 "entries are I<not> sorted, but returned in the same order as the underlying "
16663 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3587
16665 "Also this call returns basic file type information about each file. The "
16666 "C<ftyp> field will contain one of the following characters:"
16671 #: ../src/guestfs-actions.pod:5371 ../fish/guestfish-actions.pod:3592
16677 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3594
16678 msgid "Block special"
16683 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3596
16689 #: ../src/guestfs-actions.pod:5377 ../fish/guestfish-actions.pod:3598
16690 msgid "Char special"
16695 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3600
16701 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3602
16707 #: ../src/guestfs-actions.pod:5383 ../fish/guestfish-actions.pod:3604
16713 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3606
16714 msgid "FIFO (named pipe)"
16719 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3608
16725 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3610
16726 msgid "Symbolic link"
16731 #: ../src/guestfs-actions.pod:5391 ../fish/guestfish-actions.pod:3612
16737 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3614
16738 msgid "Regular file"
16743 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3616
16749 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3618
16755 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3620
16761 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3622
16762 msgid "Unknown file type"
16767 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3624
16773 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3626
16775 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16780 #: ../src/guestfs-actions.pod:5410
16782 "This function is primarily intended for use by programs. To get a simple "
16783 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16784 "consumption, use C<guestfs_ll>."
16789 #: ../src/guestfs-actions.pod:5414
16791 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16792 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16797 #: ../src/guestfs-actions.pod:5420
16798 msgid "guestfs_readlink"
16803 #: ../src/guestfs-actions.pod:5422
16807 " guestfs_readlink (guestfs_h *g,\n"
16808 " const char *path);\n"
16814 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3639
16815 msgid "This command reads the target of a symbolic link."
16820 #: ../src/guestfs-actions.pod:5433
16821 msgid "guestfs_readlinklist"
16826 #: ../src/guestfs-actions.pod:5435
16830 " guestfs_readlinklist (guestfs_h *g,\n"
16831 " const char *path,\n"
16832 " char *const *names);\n"
16838 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3645
16840 "This call allows you to do a C<readlink> operation on multiple files, where "
16841 "all files are in the directory C<path>. C<names> is the list of files from "
16847 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3649
16849 "On return you get a list of strings, with a one-to-one correspondence to the "
16850 "C<names> list. Each string is the value of the symbolic link."
16855 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3653
16857 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16858 "result string is the empty string C<\"\">. However the whole operation is "
16859 "completed even if there were C<readlink(2)> errors, and so you can call this "
16860 "function with names where you don't know if they are symbolic links already "
16861 "(albeit slightly less efficient)."
16866 #: ../src/guestfs-actions.pod:5455 ../fish/guestfish-actions.pod:3660
16868 "This call is intended for programs that want to efficiently list a directory "
16869 "contents without making many round-trips. Very long directory listings "
16870 "might cause the protocol message size to be exceeded, causing this call to "
16871 "fail. The caller must split up such requests into smaller groups of names."
16876 #: ../src/guestfs-actions.pod:5468
16877 msgid "guestfs_realpath"
16882 #: ../src/guestfs-actions.pod:5470
16886 " guestfs_realpath (guestfs_h *g,\n"
16887 " const char *path);\n"
16893 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3671
16895 "Return the canonicalized absolute pathname of C<path>. The returned path "
16896 "has no C<.>, C<..> or symbolic link path elements."
16901 #: ../src/guestfs-actions.pod:5482
16902 msgid "guestfs_removexattr"
16907 #: ../src/guestfs-actions.pod:5484
16911 " guestfs_removexattr (guestfs_h *g,\n"
16912 " const char *xattr,\n"
16913 " const char *path);\n"
16919 #: ../src/guestfs-actions.pod:5489 ../fish/guestfish-actions.pod:3678
16921 "This call removes the extended attribute named C<xattr> of the file C<path>."
16926 #: ../src/guestfs-actions.pod:5492
16927 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16932 #: ../src/guestfs-actions.pod:5498
16933 msgid "guestfs_resize2fs"
16938 #: ../src/guestfs-actions.pod:5500
16942 " guestfs_resize2fs (guestfs_h *g,\n"
16943 " const char *device);\n"
16949 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:3687
16951 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16952 "underlying device."
16957 #: ../src/guestfs-actions.pod:5507
16959 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16960 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16961 "sometimes gives an error about this and sometimes not. In any case, it is "
16962 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16966 #: ../src/guestfs-actions.pod:5517
16967 msgid "guestfs_resize2fs_M"
16971 #: ../src/guestfs-actions.pod:5519
16975 " guestfs_resize2fs_M (guestfs_h *g,\n"
16976 " const char *device);\n"
16981 #: ../src/guestfs-actions.pod:5523
16983 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
16984 "resized to its minimum size. This works like the C<-M> option to the "
16985 "C<resize2fs> command."
16989 #: ../src/guestfs-actions.pod:5527
16991 "To get the resulting size of the filesystem you should call "
16992 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
16993 "These two numbers, multiplied together, give the resulting size of the "
16994 "minimal filesystem in bytes."
16999 #: ../src/guestfs-actions.pod:5534
17000 msgid "guestfs_resize2fs_size"
17005 #: ../src/guestfs-actions.pod:5536
17009 " guestfs_resize2fs_size (guestfs_h *g,\n"
17010 " const char *device,\n"
17011 " int64_t size);\n"
17017 #: ../src/guestfs-actions.pod:5541
17019 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17020 "to specify the new size (in bytes) explicitly."
17025 #: ../src/guestfs-actions.pod:5548
17031 #: ../src/guestfs-actions.pod:5550
17035 " guestfs_rm (guestfs_h *g,\n"
17036 " const char *path);\n"
17042 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3720
17043 msgid "Remove the single file C<path>."
17048 #: ../src/guestfs-actions.pod:5560
17049 msgid "guestfs_rm_rf"
17054 #: ../src/guestfs-actions.pod:5562
17058 " guestfs_rm_rf (guestfs_h *g,\n"
17059 " const char *path);\n"
17065 #: ../src/guestfs-actions.pod:5566 ../fish/guestfish-actions.pod:3726
17067 "Remove the file or directory C<path>, recursively removing the contents if "
17068 "its a directory. This is like the C<rm -rf> shell command."
17073 #: ../src/guestfs-actions.pod:5574
17074 msgid "guestfs_rmdir"
17079 #: ../src/guestfs-actions.pod:5576
17083 " guestfs_rmdir (guestfs_h *g,\n"
17084 " const char *path);\n"
17090 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3734
17091 msgid "Remove the single directory C<path>."
17096 #: ../src/guestfs-actions.pod:5586
17097 msgid "guestfs_rmmountpoint"
17102 #: ../src/guestfs-actions.pod:5588
17106 " guestfs_rmmountpoint (guestfs_h *g,\n"
17107 " const char *exemptpath);\n"
17113 #: ../src/guestfs-actions.pod:5592
17115 "This calls removes a mountpoint that was previously created with "
17116 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17121 #: ../src/guestfs-actions.pod:5600
17122 msgid "guestfs_scrub_device"
17127 #: ../src/guestfs-actions.pod:5602
17131 " guestfs_scrub_device (guestfs_h *g,\n"
17132 " const char *device);\n"
17138 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3748
17140 "This command writes patterns over C<device> to make data retrieval more "
17146 #: ../src/guestfs-actions.pod:5609 ../src/guestfs-actions.pod:5630
17147 #: ../src/guestfs-actions.pod:5649 ../fish/guestfish-actions.pod:3751
17148 #: ../fish/guestfish-actions.pod:3766 ../fish/guestfish-actions.pod:3779
17150 "It is an interface to the L<scrub(1)> program. See that manual page for "
17156 #: ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5635
17157 #: ../src/guestfs-actions.pod:5654
17158 msgid "(Added in 1.0.52)"
17163 #: ../src/guestfs-actions.pod:5619
17164 msgid "guestfs_scrub_file"
17169 #: ../src/guestfs-actions.pod:5621
17173 " guestfs_scrub_file (guestfs_h *g,\n"
17174 " const char *file);\n"
17180 #: ../src/guestfs-actions.pod:5625 ../fish/guestfish-actions.pod:3761
17182 "This command writes patterns over a file to make data retrieval more "
17188 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3764
17189 msgid "The file is I<removed> after scrubbing."
17194 #: ../src/guestfs-actions.pod:5637
17195 msgid "guestfs_scrub_freespace"
17200 #: ../src/guestfs-actions.pod:5639
17204 " guestfs_scrub_freespace (guestfs_h *g,\n"
17205 " const char *dir);\n"
17211 #: ../src/guestfs-actions.pod:5643
17213 "This command creates the directory C<dir> and then fills it with files until "
17214 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17215 "and deletes them. The intention is to scrub any free space on the partition "
17216 "containing C<dir>."
17221 #: ../src/guestfs-actions.pod:5656
17222 msgid "guestfs_set_append"
17227 #: ../src/guestfs-actions.pod:5658
17231 " guestfs_set_append (guestfs_h *g,\n"
17232 " const char *append);\n"
17238 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3788
17240 "This function is used to add additional options to the guest kernel command "
17246 #: ../src/guestfs-actions.pod:5665 ../fish/guestfish-actions.pod:3791
17248 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17249 "environment variable."
17254 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3794
17256 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17257 "(libguestfs always adds a few of its own)."
17261 #: ../src/guestfs-actions.pod:5675
17262 msgid "guestfs_set_attach_method"
17266 #: ../src/guestfs-actions.pod:5677
17270 " guestfs_set_attach_method (guestfs_h *g,\n"
17271 " const char *attachmethod);\n"
17276 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3803
17278 "Set the method that libguestfs uses to connect to the back end guestfsd "
17279 "daemon. Possible methods are:"
17283 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3810
17285 "Launch an appliance and connect to it. This is the ordinary method and the "
17290 #: ../src/guestfs-actions.pod:5691 ../fish/guestfish-actions.pod:3813
17291 msgid "C<unix:I<path>>"
17295 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3815
17296 msgid "Connect to the Unix domain socket I<path>."
17300 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3817
17302 "This method lets you connect to an existing daemon or (using virtio-serial) "
17303 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17304 "RUNNING DAEMONS>."
17309 #: ../src/guestfs-actions.pod:5703
17310 msgid "guestfs_set_autosync"
17315 #: ../src/guestfs-actions.pod:5705
17319 " guestfs_set_autosync (guestfs_h *g,\n"
17320 " int autosync);\n"
17325 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3829
17327 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17328 "effort attempt to make filesystems consistent and synchronized when the "
17329 "handle is closed (also if the program exits without closing handles)."
17334 #: ../src/guestfs-actions.pod:5714 ../fish/guestfish-actions.pod:3834
17336 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17337 "disabled by default)."
17342 #: ../src/guestfs-actions.pod:5721
17343 msgid "guestfs_set_direct"
17348 #: ../src/guestfs-actions.pod:5723
17352 " guestfs_set_direct (guestfs_h *g,\n"
17359 #: ../src/guestfs-actions.pod:5727 ../fish/guestfish-actions.pod:3843
17361 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17362 "passed directly through to the appliance once it is launched."
17367 #: ../src/guestfs-actions.pod:5731
17369 "One consequence of this is that log messages aren't caught by the library "
17370 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17376 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3851
17377 msgid "You probably don't want to use this unless you know what you are doing."
17382 #: ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:3854
17383 msgid "The default is disabled."
17388 #: ../src/guestfs-actions.pod:5744
17389 msgid "guestfs_set_e2label"
17394 #: ../src/guestfs-actions.pod:5746
17398 " guestfs_set_e2label (guestfs_h *g,\n"
17399 " const char *device,\n"
17400 " const char *label);\n"
17406 #: ../src/guestfs-actions.pod:5751 ../fish/guestfish-actions.pod:3860
17408 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17409 "C<label>. Filesystem labels are limited to 16 characters."
17414 #: ../src/guestfs-actions.pod:5755
17416 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17417 "the existing label on a filesystem."
17422 #: ../src/guestfs-actions.pod:5762
17423 msgid "guestfs_set_e2uuid"
17428 #: ../src/guestfs-actions.pod:5764
17432 " guestfs_set_e2uuid (guestfs_h *g,\n"
17433 " const char *device,\n"
17434 " const char *uuid);\n"
17440 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3871
17442 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17443 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17444 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17449 #: ../src/guestfs-actions.pod:5774
17451 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17452 "the existing UUID of a filesystem."
17457 #: ../src/guestfs-actions.pod:5781
17458 msgid "guestfs_set_memsize"
17463 #: ../src/guestfs-actions.pod:5783
17467 " guestfs_set_memsize (guestfs_h *g,\n"
17474 #: ../src/guestfs-actions.pod:5787
17476 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17477 "This only has any effect if called before C<guestfs_launch>."
17482 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3889
17484 "You can also change this by setting the environment variable "
17485 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17490 #: ../src/guestfs-actions.pod:5802
17491 msgid "guestfs_set_network"
17496 #: ../src/guestfs-actions.pod:5804
17500 " guestfs_set_network (guestfs_h *g,\n"
17507 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
17509 "If C<network> is true, then the network is enabled in the libguestfs "
17510 "appliance. The default is false."
17515 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
17517 "This affects whether commands are able to access the network (see L<guestfs"
17518 "(3)/RUNNING COMMANDS>)."
17523 #: ../src/guestfs-actions.pod:5814
17525 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17531 #: ../src/guestfs-actions.pod:5821
17532 msgid "guestfs_set_path"
17537 #: ../src/guestfs-actions.pod:5823
17541 " guestfs_set_path (guestfs_h *g,\n"
17542 " const char *searchpath);\n"
17548 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3917
17549 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17554 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3919
17556 "The default is C<$libdir/guestfs> unless overridden by setting "
17557 "C<LIBGUESTFS_PATH> environment variable."
17562 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3922
17563 msgid "Setting C<path> to C<NULL> restores the default path."
17568 #: ../src/guestfs-actions.pod:5838
17569 msgid "guestfs_set_qemu"
17574 #: ../src/guestfs-actions.pod:5840
17578 " guestfs_set_qemu (guestfs_h *g,\n"
17579 " const char *qemu);\n"
17585 #: ../src/guestfs-actions.pod:5844 ../fish/guestfish-actions.pod:3930
17586 msgid "Set the qemu binary that we will use."
17591 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3932
17593 "The default is chosen when the library was compiled by the configure script."
17598 #: ../src/guestfs-actions.pod:5849 ../fish/guestfish-actions.pod:3935
17600 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17606 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3938
17607 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17612 #: ../src/guestfs-actions.pod:5854 ../fish/guestfish-actions.pod:3940
17614 "Note that you should call this function as early as possible after creating "
17615 "the handle. This is because some pre-launch operations depend on testing "
17616 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17617 "don't retest features, and so you might see inconsistent results. Using the "
17618 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17619 "the qemu binary at the same time as the handle is created."
17624 #: ../src/guestfs-actions.pod:5866
17625 msgid "guestfs_set_recovery_proc"
17630 #: ../src/guestfs-actions.pod:5868
17634 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17635 " int recoveryproc);\n"
17641 #: ../src/guestfs-actions.pod:5872
17643 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17644 "not create a recovery process. The purpose of the recovery process is to "
17645 "stop runaway qemu processes in the case where the main program aborts "
17651 #: ../src/guestfs-actions.pod:5877
17653 "This only has any effect if called before C<guestfs_launch>, and the default "
17659 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3962
17661 "About the only time when you would want to disable this is if the main "
17662 "process will fork itself into the background (\"daemonize\" itself). In "
17663 "this case the recovery process thinks that the main program has disappeared "
17664 "and so kills qemu, which is not very helpful."
17669 #: ../src/guestfs-actions.pod:5890
17670 msgid "guestfs_set_selinux"
17675 #: ../src/guestfs-actions.pod:5892
17679 " guestfs_set_selinux (guestfs_h *g,\n"
17686 #: ../src/guestfs-actions.pod:5896 ../fish/guestfish-actions.pod:3974
17688 "This sets the selinux flag that is passed to the appliance at boot time. "
17689 "The default is C<selinux=0> (disabled)."
17694 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3977
17696 "Note that if SELinux is enabled, it is always in Permissive mode "
17697 "(C<enforcing=0>)."
17702 #: ../src/guestfs-actions.pod:5909
17703 msgid "guestfs_set_trace"
17708 #: ../src/guestfs-actions.pod:5911
17712 " guestfs_set_trace (guestfs_h *g,\n"
17718 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3989
17720 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17721 "return values are traced."
17726 #: ../src/guestfs-actions.pod:5918 ../fish/guestfish-actions.pod:3992
17728 "If you want to trace C API calls into libguestfs (and other libraries) then "
17729 "possibly a better way is to use the external ltrace(1) command."
17734 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:3996
17736 "Command traces are disabled unless the environment variable "
17737 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17741 #: ../src/guestfs-actions.pod:5925
17743 "Trace messages are normally sent to C<stderr>, unless you register a "
17744 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17749 #: ../src/guestfs-actions.pod:5933
17750 msgid "guestfs_set_verbose"
17755 #: ../src/guestfs-actions.pod:5935
17759 " guestfs_set_verbose (guestfs_h *g,\n"
17765 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:4009
17766 msgid "If C<verbose> is true, this turns on verbose messages."
17771 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:4011
17773 "Verbose messages are disabled unless the environment variable "
17774 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17778 #: ../src/guestfs-actions.pod:5944
17780 "Verbose messages are normally sent to C<stderr>, unless you register a "
17781 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17786 #: ../src/guestfs-actions.pod:5952
17787 msgid "guestfs_setcon"
17792 #: ../src/guestfs-actions.pod:5954
17796 " guestfs_setcon (guestfs_h *g,\n"
17797 " const char *context);\n"
17803 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:4022
17805 "This sets the SELinux security context of the daemon to the string "
17811 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4025
17812 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17817 #: ../src/guestfs-actions.pod:5967
17818 msgid "guestfs_setxattr"
17823 #: ../src/guestfs-actions.pod:5969
17827 " guestfs_setxattr (guestfs_h *g,\n"
17828 " const char *xattr,\n"
17829 " const char *val,\n"
17831 " const char *path);\n"
17837 #: ../src/guestfs-actions.pod:5976 ../fish/guestfish-actions.pod:4031
17839 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17840 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17845 #: ../src/guestfs-actions.pod:5980
17846 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17851 #: ../src/guestfs-actions.pod:5986
17852 msgid "guestfs_sfdisk"
17857 #: ../src/guestfs-actions.pod:5988
17861 " guestfs_sfdisk (guestfs_h *g,\n"
17862 " const char *device,\n"
17866 " char *const *lines);\n"
17872 #: ../src/guestfs-actions.pod:5996 ../fish/guestfish-actions.pod:4041
17874 "This is a direct interface to the L<sfdisk(8)> program for creating "
17875 "partitions on block devices."
17880 #: ../src/guestfs-actions.pod:5999 ../fish/guestfish-actions.pod:4044
17881 msgid "C<device> should be a block device, for example C</dev/sda>."
17886 #: ../src/guestfs-actions.pod:6001 ../fish/guestfish-actions.pod:4046
17888 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17889 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17890 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17891 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17892 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17893 "the kernel) cannot work out the right geometry and you will need to tell it."
17898 #: ../src/guestfs-actions.pod:6009 ../fish/guestfish-actions.pod:4054
17900 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17901 "refer to the L<sfdisk(8)> manpage."
17906 #: ../src/guestfs-actions.pod:6012 ../fish/guestfish-actions.pod:4057
17908 "To create a single partition occupying the whole disk, you would pass "
17909 "C<lines> as a single element list, when the single element being the string "
17915 #: ../src/guestfs-actions.pod:6016
17917 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17922 #: ../src/guestfs-actions.pod:6026
17923 msgid "guestfs_sfdiskM"
17928 #: ../src/guestfs-actions.pod:6028
17932 " guestfs_sfdiskM (guestfs_h *g,\n"
17933 " const char *device,\n"
17934 " char *const *lines);\n"
17940 #: ../src/guestfs-actions.pod:6033
17942 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17943 "partition sizes are specified in megabytes only (rounded to the nearest "
17944 "cylinder) and you don't need to specify the cyls, heads and sectors "
17945 "parameters which were rarely if ever used anyway."
17950 #: ../src/guestfs-actions.pod:6039
17952 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17953 "C<guestfs_part_disk>"
17958 #: ../src/guestfs-actions.pod:6049
17959 msgid "guestfs_sfdisk_N"
17964 #: ../src/guestfs-actions.pod:6051
17968 " guestfs_sfdisk_N (guestfs_h *g,\n"
17969 " const char *device,\n"
17974 " const char *line);\n"
17980 #: ../src/guestfs-actions.pod:6060 ../fish/guestfish-actions.pod:4087
17982 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17983 "(note: C<n> counts from 1)."
17988 #: ../src/guestfs-actions.pod:6063
17990 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17991 "for the cyls/heads/sectors parameters."
17996 #: ../src/guestfs-actions.pod:6066
17997 msgid "See also: C<guestfs_part_add>"
18002 #: ../src/guestfs-actions.pod:6075
18003 msgid "guestfs_sfdisk_disk_geometry"
18008 #: ../src/guestfs-actions.pod:6077
18012 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18013 " const char *device);\n"
18019 #: ../src/guestfs-actions.pod:6081
18021 "This displays the disk geometry of C<device> read from the partition table. "
18022 "Especially in the case where the underlying block device has been resized, "
18023 "this can be different from the kernel's idea of the geometry (see "
18024 "C<guestfs_sfdisk_kernel_geometry>)."
18029 #: ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6102
18030 #: ../fish/guestfish-actions.pod:4107 ../fish/guestfish-actions.pod:4116
18031 msgid "The result is in human-readable format, and not designed to be parsed."
18036 #: ../src/guestfs-actions.pod:6094
18037 msgid "guestfs_sfdisk_kernel_geometry"
18042 #: ../src/guestfs-actions.pod:6096
18046 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18047 " const char *device);\n"
18053 #: ../src/guestfs-actions.pod:6100 ../fish/guestfish-actions.pod:4114
18054 msgid "This displays the kernel's idea of the geometry of C<device>."
18059 #: ../src/guestfs-actions.pod:6110
18060 msgid "guestfs_sfdisk_l"
18065 #: ../src/guestfs-actions.pod:6112
18069 " guestfs_sfdisk_l (guestfs_h *g,\n"
18070 " const char *device);\n"
18076 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4123
18078 "This displays the partition table on C<device>, in the human-readable output "
18079 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18084 #: ../src/guestfs-actions.pod:6120
18085 msgid "See also: C<guestfs_part_list>"
18090 #: ../src/guestfs-actions.pod:6127
18096 #: ../src/guestfs-actions.pod:6129
18100 " guestfs_sh (guestfs_h *g,\n"
18101 " const char *command);\n"
18107 #: ../src/guestfs-actions.pod:6133 ../fish/guestfish-actions.pod:4133
18109 "This call runs a command from the guest filesystem via the guest's C</bin/"
18115 #: ../src/guestfs-actions.pod:6136
18116 msgid "This is like C<guestfs_command>, but passes the command to:"
18121 #: ../src/guestfs-actions.pod:6138 ../fish/guestfish-actions.pod:4138
18124 " /bin/sh -c \"command\"\n"
18130 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4140
18132 "Depending on the guest's shell, this usually results in wildcards being "
18133 "expanded, shell expressions being interpolated and so on."
18138 #: ../src/guestfs-actions.pod:6144
18139 msgid "All the provisos about C<guestfs_command> apply to this call."
18144 #: ../src/guestfs-actions.pod:6151
18145 msgid "guestfs_sh_lines"
18150 #: ../src/guestfs-actions.pod:6153
18154 " guestfs_sh_lines (guestfs_h *g,\n"
18155 " const char *command);\n"
18161 #: ../src/guestfs-actions.pod:6157
18163 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18169 #: ../src/guestfs-actions.pod:6160
18170 msgid "See also: C<guestfs_command_lines>"
18175 #: ../src/guestfs-actions.pod:6168
18176 msgid "guestfs_sleep"
18181 #: ../src/guestfs-actions.pod:6170
18185 " guestfs_sleep (guestfs_h *g,\n"
18192 #: ../src/guestfs-actions.pod:6174 ../fish/guestfish-actions.pod:4159
18193 msgid "Sleep for C<secs> seconds."
18198 #: ../src/guestfs-actions.pod:6178
18199 msgid "(Added in 1.0.41)"
18204 #: ../src/guestfs-actions.pod:6180 ../src/guestfs-structs.pod:109
18205 msgid "guestfs_stat"
18210 #: ../src/guestfs-actions.pod:6182
18213 " struct guestfs_stat *\n"
18214 " guestfs_stat (guestfs_h *g,\n"
18215 " const char *path);\n"
18221 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4167
18222 msgid "This is the same as the C<stat(2)> system call."
18227 #: ../src/guestfs-actions.pod:6196 ../src/guestfs-structs.pod:135
18228 msgid "guestfs_statvfs"
18233 #: ../src/guestfs-actions.pod:6198
18236 " struct guestfs_statvfs *\n"
18237 " guestfs_statvfs (guestfs_h *g,\n"
18238 " const char *path);\n"
18244 #: ../src/guestfs-actions.pod:6202 ../fish/guestfish-actions.pod:4173
18246 "Returns file system statistics for any mounted file system. C<path> should "
18247 "be a file or directory in the mounted file system (typically it is the mount "
18248 "point itself, but it doesn't need to be)."
18253 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4177
18254 msgid "This is the same as the C<statvfs(2)> system call."
18259 #: ../src/guestfs-actions.pod:6208
18261 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18262 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18267 #: ../src/guestfs-actions.pod:6214
18268 msgid "guestfs_strings"
18273 #: ../src/guestfs-actions.pod:6216
18277 " guestfs_strings (guestfs_h *g,\n"
18278 " const char *path);\n"
18284 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4183
18286 "This runs the L<strings(1)> command on a file and returns the list of "
18287 "printable strings found."
18292 #: ../src/guestfs-actions.pod:6232
18293 msgid "guestfs_strings_e"
18298 #: ../src/guestfs-actions.pod:6234
18302 " guestfs_strings_e (guestfs_h *g,\n"
18303 " const char *encoding,\n"
18304 " const char *path);\n"
18310 #: ../src/guestfs-actions.pod:6239
18312 "This is like the C<guestfs_strings> command, but allows you to specify the "
18313 "encoding of strings that are looked for in the source file C<path>."
18318 #: ../src/guestfs-actions.pod:6243 ../fish/guestfish-actions.pod:4197
18319 msgid "Allowed encodings are:"
18324 #: ../src/guestfs-actions.pod:6247 ../fish/guestfish-actions.pod:4201
18330 #: ../src/guestfs-actions.pod:6249
18332 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18333 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18338 #: ../src/guestfs-actions.pod:6252 ../fish/guestfish-actions.pod:4206
18344 #: ../src/guestfs-actions.pod:6254 ../fish/guestfish-actions.pod:4208
18345 msgid "Single 8-bit-byte characters."
18350 #: ../src/guestfs-actions.pod:6256 ../fish/guestfish-actions.pod:4210
18356 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4212
18357 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18362 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4215
18363 msgid "l (lower case letter L)"
18368 #: ../src/guestfs-actions.pod:6263 ../fish/guestfish-actions.pod:4217
18370 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18371 "examining binaries in Windows guests."
18376 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4220
18382 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4222
18383 msgid "32-bit big endian such as UCS-4BE."
18388 #: ../src/guestfs-actions.pod:6270 ../fish/guestfish-actions.pod:4224
18394 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4226
18395 msgid "32-bit little endian such as UCS-4LE."
18400 #: ../src/guestfs-actions.pod:6276 ../fish/guestfish-actions.pod:4230
18401 msgid "The returned strings are transcoded to UTF-8."
18406 #: ../src/guestfs-actions.pod:6287
18407 msgid "guestfs_swapoff_device"
18412 #: ../src/guestfs-actions.pod:6289
18416 " guestfs_swapoff_device (guestfs_h *g,\n"
18417 " const char *device);\n"
18423 #: ../src/guestfs-actions.pod:6293
18425 "This command disables the libguestfs appliance swap device or partition "
18426 "named C<device>. See C<guestfs_swapon_device>."
18431 #: ../src/guestfs-actions.pod:6301
18432 msgid "guestfs_swapoff_file"
18437 #: ../src/guestfs-actions.pod:6303
18441 " guestfs_swapoff_file (guestfs_h *g,\n"
18442 " const char *file);\n"
18448 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4247
18449 msgid "This command disables the libguestfs appliance swap on file."
18454 #: ../src/guestfs-actions.pod:6313
18455 msgid "guestfs_swapoff_label"
18460 #: ../src/guestfs-actions.pod:6315
18464 " guestfs_swapoff_label (guestfs_h *g,\n"
18465 " const char *label);\n"
18471 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4253
18473 "This command disables the libguestfs appliance swap on labeled swap "
18479 #: ../src/guestfs-actions.pod:6326
18480 msgid "guestfs_swapoff_uuid"
18485 #: ../src/guestfs-actions.pod:6328
18489 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18490 " const char *uuid);\n"
18496 #: ../src/guestfs-actions.pod:6332 ../fish/guestfish-actions.pod:4260
18498 "This command disables the libguestfs appliance swap partition with the given "
18504 #: ../src/guestfs-actions.pod:6339
18505 msgid "guestfs_swapon_device"
18510 #: ../src/guestfs-actions.pod:6341
18514 " guestfs_swapon_device (guestfs_h *g,\n"
18515 " const char *device);\n"
18521 #: ../src/guestfs-actions.pod:6345
18523 "This command enables the libguestfs appliance to use the swap device or "
18524 "partition named C<device>. The increased memory is made available for all "
18525 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18530 #: ../src/guestfs-actions.pod:6350 ../fish/guestfish-actions.pod:4272
18532 "Note that you should not swap to existing guest swap partitions unless you "
18533 "know what you are doing. They may contain hibernation information, or other "
18534 "information that the guest doesn't want you to trash. You also risk leaking "
18535 "information about the host to the guest this way. Instead, attach a new "
18536 "host device to the guest and swap on that."
18541 #: ../src/guestfs-actions.pod:6361
18542 msgid "guestfs_swapon_file"
18547 #: ../src/guestfs-actions.pod:6363
18551 " guestfs_swapon_file (guestfs_h *g,\n"
18552 " const char *file);\n"
18558 #: ../src/guestfs-actions.pod:6367
18560 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18566 #: ../src/guestfs-actions.pod:6374
18567 msgid "guestfs_swapon_label"
18572 #: ../src/guestfs-actions.pod:6376
18576 " guestfs_swapon_label (guestfs_h *g,\n"
18577 " const char *label);\n"
18583 #: ../src/guestfs-actions.pod:6380
18585 "This command enables swap to a labeled swap partition. See "
18586 "C<guestfs_swapon_device> for other notes."
18591 #: ../src/guestfs-actions.pod:6387
18592 msgid "guestfs_swapon_uuid"
18597 #: ../src/guestfs-actions.pod:6389
18601 " guestfs_swapon_uuid (guestfs_h *g,\n"
18602 " const char *uuid);\n"
18608 #: ../src/guestfs-actions.pod:6393
18610 "This command enables swap to a swap partition with the given UUID. See "
18611 "C<guestfs_swapon_device> for other notes."
18616 #: ../src/guestfs-actions.pod:6400
18617 msgid "guestfs_sync"
18622 #: ../src/guestfs-actions.pod:6402
18626 " guestfs_sync (guestfs_h *g);\n"
18632 #: ../src/guestfs-actions.pod:6405 ../fish/guestfish-actions.pod:4304
18634 "This syncs the disk, so that any writes are flushed through to the "
18635 "underlying disk image."
18640 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4307
18642 "You should always call this if you have modified a disk image, before "
18643 "closing the handle."
18648 #: ../src/guestfs-actions.pod:6415
18649 msgid "guestfs_tail"
18654 #: ../src/guestfs-actions.pod:6417
18658 " guestfs_tail (guestfs_h *g,\n"
18659 " const char *path);\n"
18665 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4314
18667 "This command returns up to the last 10 lines of a file as a list of strings."
18672 #: ../src/guestfs-actions.pod:6433
18673 msgid "guestfs_tail_n"
18678 #: ../src/guestfs-actions.pod:6435
18682 " guestfs_tail_n (guestfs_h *g,\n"
18684 " const char *path);\n"
18690 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4324
18692 "If the parameter C<nrlines> is a positive number, this returns the last "
18693 "C<nrlines> lines of the file C<path>."
18698 #: ../src/guestfs-actions.pod:6443 ../fish/guestfish-actions.pod:4327
18700 "If the parameter C<nrlines> is a negative number, this returns lines from "
18701 "the file C<path>, starting with the C<-nrlines>th line."
18706 #: ../src/guestfs-actions.pod:6457
18707 msgid "guestfs_tar_in"
18712 #: ../src/guestfs-actions.pod:6459
18716 " guestfs_tar_in (guestfs_h *g,\n"
18717 " const char *tarfile,\n"
18718 " const char *directory);\n"
18724 #: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4339
18726 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18727 "tar file) into C<directory>."
18732 #: ../src/guestfs-actions.pod:6467
18734 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18739 #: ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6489
18740 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6521
18741 msgid "(Added in 1.0.3)"
18746 #: ../src/guestfs-actions.pod:6474
18747 msgid "guestfs_tar_out"
18752 #: ../src/guestfs-actions.pod:6476
18756 " guestfs_tar_out (guestfs_h *g,\n"
18757 " const char *directory,\n"
18758 " const char *tarfile);\n"
18764 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4351
18766 "This command packs the contents of C<directory> and downloads it to local "
18772 #: ../src/guestfs-actions.pod:6484
18774 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18775 "C<guestfs_txz_out>."
18780 #: ../src/guestfs-actions.pod:6491
18781 msgid "guestfs_tgz_in"
18786 #: ../src/guestfs-actions.pod:6493
18790 " guestfs_tgz_in (guestfs_h *g,\n"
18791 " const char *tarball,\n"
18792 " const char *directory);\n"
18798 #: ../src/guestfs-actions.pod:6498 ../fish/guestfish-actions.pod:4363
18800 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18801 "tar file) into C<directory>."
18806 #: ../src/guestfs-actions.pod:6501
18807 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18812 #: ../src/guestfs-actions.pod:6507
18813 msgid "guestfs_tgz_out"
18818 #: ../src/guestfs-actions.pod:6509
18822 " guestfs_tgz_out (guestfs_h *g,\n"
18823 " const char *directory,\n"
18824 " const char *tarball);\n"
18830 #: ../src/guestfs-actions.pod:6514 ../fish/guestfish-actions.pod:4374
18832 "This command packs the contents of C<directory> and downloads it to local "
18838 #: ../src/guestfs-actions.pod:6517
18839 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18844 #: ../src/guestfs-actions.pod:6523
18845 msgid "guestfs_touch"
18850 #: ../src/guestfs-actions.pod:6525
18854 " guestfs_touch (guestfs_h *g,\n"
18855 " const char *path);\n"
18861 #: ../src/guestfs-actions.pod:6529 ../fish/guestfish-actions.pod:4385
18863 "Touch acts like the L<touch(1)> command. It can be used to update the "
18864 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18870 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4389
18872 "This command only works on regular files, and will fail on other file types "
18873 "such as directories, symbolic links, block special etc."
18878 #: ../src/guestfs-actions.pod:6540
18879 msgid "guestfs_truncate"
18884 #: ../src/guestfs-actions.pod:6542
18888 " guestfs_truncate (guestfs_h *g,\n"
18889 " const char *path);\n"
18895 #: ../src/guestfs-actions.pod:6546 ../fish/guestfish-actions.pod:4396
18897 "This command truncates C<path> to a zero-length file. The file must exist "
18903 #: ../src/guestfs-actions.pod:6553
18904 msgid "guestfs_truncate_size"
18909 #: ../src/guestfs-actions.pod:6555
18913 " guestfs_truncate_size (guestfs_h *g,\n"
18914 " const char *path,\n"
18915 " int64_t size);\n"
18921 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4403
18923 "This command truncates C<path> to size C<size> bytes. The file must exist "
18929 #: ../src/guestfs-actions.pod:6563
18931 "If the current file size is less than C<size> then the file is extended to "
18932 "the required size with zero bytes. This creates a sparse file (ie. disk "
18933 "blocks are not allocated for the file until you write to it). To create a "
18934 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18939 #: ../src/guestfs-actions.pod:6573
18940 msgid "guestfs_tune2fs_l"
18945 #: ../src/guestfs-actions.pod:6575
18949 " guestfs_tune2fs_l (guestfs_h *g,\n"
18950 " const char *device);\n"
18956 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4416
18958 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18964 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4419
18966 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18967 "for more details. The list of fields returned isn't clearly defined, and "
18968 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18969 "and the filesystem itself."
18974 #: ../src/guestfs-actions.pod:6595
18975 msgid "guestfs_txz_in"
18980 #: ../src/guestfs-actions.pod:6597
18984 " guestfs_txz_in (guestfs_h *g,\n"
18985 " const char *tarball,\n"
18986 " const char *directory);\n"
18992 #: ../src/guestfs-actions.pod:6602 ../fish/guestfish-actions.pod:4428
18994 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18995 "tar file) into C<directory>."
19000 #: ../src/guestfs-actions.pod:6609
19001 msgid "guestfs_txz_out"
19006 #: ../src/guestfs-actions.pod:6611
19010 " guestfs_txz_out (guestfs_h *g,\n"
19011 " const char *directory,\n"
19012 " const char *tarball);\n"
19018 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4437
19020 "This command packs the contents of C<directory> and downloads it to local "
19021 "file C<tarball> (as an xz compressed tar archive)."
19026 #: ../src/guestfs-actions.pod:6623
19027 msgid "guestfs_umask"
19032 #: ../src/guestfs-actions.pod:6625
19036 " guestfs_umask (guestfs_h *g,\n"
19043 #: ../src/guestfs-actions.pod:6629 ../fish/guestfish-actions.pod:4446
19045 "This function sets the mask used for creating new files and device nodes to "
19051 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4449
19053 "Typical umask values would be C<022> which creates new files with "
19054 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19055 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19060 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
19062 "The default umask is C<022>. This is important because it means that "
19063 "directories and device nodes will be created with C<0644> or C<0755> mode "
19064 "even if you specify C<0777>."
19069 #: ../src/guestfs-actions.pod:6641
19071 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19072 "C<guestfs_mkdir>."
19077 #: ../src/guestfs-actions.pod:6644 ../fish/guestfish-actions.pod:4461
19078 msgid "This call returns the previous umask."
19083 #: ../src/guestfs-actions.pod:6650
19084 msgid "guestfs_umount"
19089 #: ../src/guestfs-actions.pod:6652
19093 " guestfs_umount (guestfs_h *g,\n"
19094 " const char *pathordevice);\n"
19100 #: ../src/guestfs-actions.pod:6656 ../fish/guestfish-actions.pod:4469
19102 "This unmounts the given filesystem. The filesystem may be specified either "
19103 "by its mountpoint (path) or the device which contains the filesystem."
19108 #: ../src/guestfs-actions.pod:6664
19109 msgid "guestfs_umount_all"
19114 #: ../src/guestfs-actions.pod:6666
19118 " guestfs_umount_all (guestfs_h *g);\n"
19124 #: ../src/guestfs-actions.pod:6669 ../fish/guestfish-actions.pod:4479
19125 msgid "This unmounts all mounted filesystems."
19130 #: ../src/guestfs-actions.pod:6671 ../fish/guestfish-actions.pod:4481
19131 msgid "Some internal mounts are not unmounted by this call."
19136 #: ../src/guestfs-actions.pod:6677
19137 msgid "guestfs_upload"
19142 #: ../src/guestfs-actions.pod:6679
19146 " guestfs_upload (guestfs_h *g,\n"
19147 " const char *filename,\n"
19148 " const char *remotefilename);\n"
19154 #: ../src/guestfs-actions.pod:6684 ../src/guestfs-actions.pod:6708
19155 #: ../fish/guestfish-actions.pod:4487 ../fish/guestfish-actions.pod:4500
19156 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19161 #: ../src/guestfs-actions.pod:6689
19162 msgid "See also C<guestfs_download>."
19167 #: ../src/guestfs-actions.pod:6700
19168 msgid "guestfs_upload_offset"
19173 #: ../src/guestfs-actions.pod:6702
19177 " guestfs_upload_offset (guestfs_h *g,\n"
19178 " const char *filename,\n"
19179 " const char *remotefilename,\n"
19180 " int64_t offset);\n"
19186 #: ../src/guestfs-actions.pod:6711 ../fish/guestfish-actions.pod:4503
19188 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19189 "The intention is to overwrite parts of existing files or devices, although "
19190 "if a non-existant file is specified then it is created with a \"hole\" "
19191 "before C<offset>. The size of the data written is implicit in the size of "
19192 "the source C<filename>."
19197 #: ../src/guestfs-actions.pod:6718
19199 "Note that there is no limit on the amount of data that can be uploaded with "
19200 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19201 "full amount unless an error occurs."
19206 #: ../src/guestfs-actions.pod:6723
19207 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19212 #: ../src/guestfs-actions.pod:6734
19213 msgid "guestfs_utimens"
19218 #: ../src/guestfs-actions.pod:6736
19222 " guestfs_utimens (guestfs_h *g,\n"
19223 " const char *path,\n"
19224 " int64_t atsecs,\n"
19225 " int64_t atnsecs,\n"
19226 " int64_t mtsecs,\n"
19227 " int64_t mtnsecs);\n"
19233 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4523
19234 msgid "This command sets the timestamps of a file with nanosecond precision."
19239 #: ../src/guestfs-actions.pod:6747 ../fish/guestfish-actions.pod:4526
19241 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19247 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4529
19249 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19250 "nanoseconds from the epoch."
19255 #: ../src/guestfs-actions.pod:6753 ../fish/guestfish-actions.pod:4532
19257 "If the C<*nsecs> field contains the special value C<-1> then the "
19258 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19259 "ignored in this case)."
19264 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4536
19266 "If the C<*nsecs> field contains the special value C<-2> then the "
19267 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19273 #: ../src/guestfs-actions.pod:6765 ../src/guestfs-structs.pod:175
19274 msgid "guestfs_version"
19279 #: ../src/guestfs-actions.pod:6767
19282 " struct guestfs_version *\n"
19283 " guestfs_version (guestfs_h *g);\n"
19289 #: ../src/guestfs-actions.pod:6770 ../fish/guestfish-actions.pod:4544
19291 "Return the libguestfs version number that the program is linked against."
19296 #: ../src/guestfs-actions.pod:6773 ../fish/guestfish-actions.pod:4547
19298 "Note that because of dynamic linking this is not necessarily the version of "
19299 "libguestfs that you compiled against. You can compile the program, and then "
19300 "at runtime dynamically link against a completely different C<libguestfs.so> "
19306 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4552
19308 "This call was added in version C<1.0.58>. In previous versions of "
19309 "libguestfs there was no way to get the version number. From C code you can "
19310 "use dynamic linker functions to find out if this symbol exists (if it "
19311 "doesn't, then it's an earlier version)."
19316 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4558
19318 "The call returns a structure with four elements. The first three (C<major>, "
19319 "C<minor> and C<release>) are numbers and correspond to the usual version "
19320 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19321 "but may be used for distro-specific information."
19326 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4564
19328 "To construct the original version string: C<$major.$minor.$release$extra>"
19333 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4567
19334 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19339 #: ../src/guestfs-actions.pod:6795
19341 "I<Note:> Don't use this call to test for availability of features. In "
19342 "enterprise distributions we backport features from later versions into "
19343 "earlier versions, making this an unreliable way to test for features. Use "
19344 "C<guestfs_available> instead."
19349 #: ../src/guestfs-actions.pod:6801
19351 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19352 "error. I<The caller must call C<guestfs_free_version> after use>."
19357 #: ../src/guestfs-actions.pod:6805
19358 msgid "(Added in 1.0.58)"
19363 #: ../src/guestfs-actions.pod:6807
19364 msgid "guestfs_vfs_label"
19369 #: ../src/guestfs-actions.pod:6809
19373 " guestfs_vfs_label (guestfs_h *g,\n"
19374 " const char *device);\n"
19380 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4579
19381 msgid "This returns the filesystem label of the filesystem on C<device>."
19386 #: ../src/guestfs-actions.pod:6816 ../fish/guestfish-actions.pod:4582
19387 msgid "If the filesystem is unlabeled, this returns the empty string."
19392 #: ../src/guestfs-actions.pod:6818
19393 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19398 #: ../src/guestfs-actions.pod:6823 ../src/guestfs-actions.pod:6860
19399 msgid "(Added in 1.3.18)"
19404 #: ../src/guestfs-actions.pod:6825
19405 msgid "guestfs_vfs_type"
19410 #: ../src/guestfs-actions.pod:6827
19414 " guestfs_vfs_type (guestfs_h *g,\n"
19415 " const char *device);\n"
19421 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4590
19423 "This command gets the filesystem type corresponding to the filesystem on "
19429 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4593
19431 "For most filesystems, the result is the name of the Linux VFS module which "
19432 "would be used to mount this filesystem if you mounted it without specifying "
19433 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19438 #: ../src/guestfs-actions.pod:6844
19439 msgid "guestfs_vfs_uuid"
19444 #: ../src/guestfs-actions.pod:6846
19448 " guestfs_vfs_uuid (guestfs_h *g,\n"
19449 " const char *device);\n"
19455 #: ../src/guestfs-actions.pod:6850 ../fish/guestfish-actions.pod:4602
19456 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19461 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4605
19462 msgid "If the filesystem does not have a UUID, this returns the empty string."
19467 #: ../src/guestfs-actions.pod:6855
19468 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19473 #: ../src/guestfs-actions.pod:6862
19474 msgid "guestfs_vg_activate"
19479 #: ../src/guestfs-actions.pod:6864
19483 " guestfs_vg_activate (guestfs_h *g,\n"
19485 " char *const *volgroups);\n"
19491 #: ../src/guestfs-actions.pod:6869 ../fish/guestfish-actions.pod:4613
19493 "This command activates or (if C<activate> is false) deactivates all logical "
19494 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19495 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19496 "deactivated, then those devices disappear."
19501 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4619
19502 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19507 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4621
19509 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19510 "activated or deactivated."
19515 #: ../src/guestfs-actions.pod:6884
19516 msgid "guestfs_vg_activate_all"
19521 #: ../src/guestfs-actions.pod:6886
19525 " guestfs_vg_activate_all (guestfs_h *g,\n"
19526 " int activate);\n"
19532 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4628
19534 "This command activates or (if C<activate> is false) deactivates all logical "
19535 "volumes in all volume groups. If activated, then they are made known to the "
19536 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19537 "those devices disappear."
19542 #: ../src/guestfs-actions.pod:6896 ../fish/guestfish-actions.pod:4634
19543 msgid "This command is the same as running C<vgchange -a y|n>"
19548 #: ../src/guestfs-actions.pod:6902
19549 msgid "guestfs_vgcreate"
19554 #: ../src/guestfs-actions.pod:6904
19558 " guestfs_vgcreate (guestfs_h *g,\n"
19559 " const char *volgroup,\n"
19560 " char *const *physvols);\n"
19566 #: ../src/guestfs-actions.pod:6909 ../fish/guestfish-actions.pod:4640
19568 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19569 "of physical volumes C<physvols>."
19574 #: ../src/guestfs-actions.pod:6916
19575 msgid "guestfs_vglvuuids"
19580 #: ../src/guestfs-actions.pod:6918
19584 " guestfs_vglvuuids (guestfs_h *g,\n"
19585 " const char *vgname);\n"
19591 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4647
19593 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19594 "volumes created in this volume group."
19599 #: ../src/guestfs-actions.pod:6925
19601 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19602 "associate logical volumes and volume groups."
19607 #: ../src/guestfs-actions.pod:6928
19608 msgid "See also C<guestfs_vgpvuuids>."
19613 #: ../src/guestfs-actions.pod:6936
19614 msgid "guestfs_vgpvuuids"
19619 #: ../src/guestfs-actions.pod:6938
19623 " guestfs_vgpvuuids (guestfs_h *g,\n"
19624 " const char *vgname);\n"
19630 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4659
19632 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19633 "volumes that this volume group resides on."
19638 #: ../src/guestfs-actions.pod:6945
19640 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
19641 "associate physical volumes and volume groups."
19646 #: ../src/guestfs-actions.pod:6948
19647 msgid "See also C<guestfs_vglvuuids>."
19652 #: ../src/guestfs-actions.pod:6956
19653 msgid "guestfs_vgremove"
19658 #: ../src/guestfs-actions.pod:6958
19662 " guestfs_vgremove (guestfs_h *g,\n"
19663 " const char *vgname);\n"
19669 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4671
19670 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19675 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4673
19677 "This also forcibly removes all logical volumes in the volume group (if any)."
19682 #: ../src/guestfs-actions.pod:6971
19683 msgid "guestfs_vgrename"
19688 #: ../src/guestfs-actions.pod:6973
19692 " guestfs_vgrename (guestfs_h *g,\n"
19693 " const char *volgroup,\n"
19694 " const char *newvolgroup);\n"
19700 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4680
19701 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19706 #: ../src/guestfs-actions.pod:6984
19707 msgid "guestfs_vgs"
19712 #: ../src/guestfs-actions.pod:6986
19716 " guestfs_vgs (guestfs_h *g);\n"
19722 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4686
19724 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19730 #: ../src/guestfs-actions.pod:6992 ../fish/guestfish-actions.pod:4689
19732 "This returns a list of just the volume group names that were detected (eg. "
19738 #: ../src/guestfs-actions.pod:6995
19739 msgid "See also C<guestfs_vgs_full>."
19744 #: ../src/guestfs-actions.pod:7003
19745 msgid "guestfs_vgs_full"
19750 #: ../src/guestfs-actions.pod:7005
19753 " struct guestfs_lvm_vg_list *\n"
19754 " guestfs_vgs_full (guestfs_h *g);\n"
19760 #: ../src/guestfs-actions.pod:7008 ../fish/guestfish-actions.pod:4698
19762 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19763 "> command. The \"full\" version includes all fields."
19768 #: ../src/guestfs-actions.pod:7011
19770 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
19771 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
19776 #: ../src/guestfs-actions.pod:7017
19777 msgid "guestfs_vgscan"
19782 #: ../src/guestfs-actions.pod:7019
19786 " guestfs_vgscan (guestfs_h *g);\n"
19792 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4705
19794 "This rescans all block devices and rebuilds the list of LVM physical "
19795 "volumes, volume groups and logical volumes."
19800 #: ../src/guestfs-actions.pod:7029
19801 msgid "guestfs_vguuid"
19806 #: ../src/guestfs-actions.pod:7031
19810 " guestfs_vguuid (guestfs_h *g,\n"
19811 " const char *vgname);\n"
19817 #: ../src/guestfs-actions.pod:7035 ../fish/guestfish-actions.pod:4712
19818 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19823 #: ../src/guestfs-actions.pod:7042
19824 msgid "guestfs_wait_ready"
19829 #: ../src/guestfs-actions.pod:7044
19833 " guestfs_wait_ready (guestfs_h *g);\n"
19839 #: ../src/guestfs-actions.pod:7047
19840 msgid "This function is a no op."
19845 #: ../src/guestfs-actions.pod:7049
19847 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19848 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19849 "is no longer necessary because C<guestfs_launch> now does the waiting."
19854 #: ../src/guestfs-actions.pod:7054
19856 "If you see any calls to this function in code then you can just remove them, "
19857 "unless you want to retain compatibility with older versions of the API."
19862 #: ../src/guestfs-actions.pod:7062
19863 msgid "guestfs_wc_c"
19868 #: ../src/guestfs-actions.pod:7064
19872 " guestfs_wc_c (guestfs_h *g,\n"
19873 " const char *path);\n"
19879 #: ../src/guestfs-actions.pod:7068 ../fish/guestfish-actions.pod:4718
19881 "This command counts the characters in a file, using the C<wc -c> external "
19887 #: ../src/guestfs-actions.pod:7075
19888 msgid "guestfs_wc_l"
19893 #: ../src/guestfs-actions.pod:7077
19897 " guestfs_wc_l (guestfs_h *g,\n"
19898 " const char *path);\n"
19904 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4725
19906 "This command counts the lines in a file, using the C<wc -l> external command."
19911 #: ../src/guestfs-actions.pod:7088
19912 msgid "guestfs_wc_w"
19917 #: ../src/guestfs-actions.pod:7090
19921 " guestfs_wc_w (guestfs_h *g,\n"
19922 " const char *path);\n"
19928 #: ../src/guestfs-actions.pod:7094 ../fish/guestfish-actions.pod:4732
19930 "This command counts the words in a file, using the C<wc -w> external command."
19935 #: ../src/guestfs-actions.pod:7101
19936 msgid "guestfs_write"
19941 #: ../src/guestfs-actions.pod:7103
19945 " guestfs_write (guestfs_h *g,\n"
19946 " const char *path,\n"
19947 " const char *content,\n"
19948 " size_t content_size);\n"
19954 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4739
19956 "This call creates a file called C<path>. The content of the file is the "
19957 "string C<content> (which can contain any 8 bit data)."
19962 #: ../src/guestfs-actions.pod:7119
19963 msgid "guestfs_write_file"
19968 #: ../src/guestfs-actions.pod:7121
19972 " guestfs_write_file (guestfs_h *g,\n"
19973 " const char *path,\n"
19974 " const char *content,\n"
19981 #: ../src/guestfs-actions.pod:7127 ../fish/guestfish-actions.pod:4749
19983 "This call creates a file called C<path>. The contents of the file is the "
19984 "string C<content> (which can contain any 8 bit data), with length C<size>."
19989 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4753
19991 "As a special case, if C<size> is C<0> then the length is calculated using "
19992 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19997 #: ../src/guestfs-actions.pod:7135 ../fish/guestfish-actions.pod:4757
19999 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20000 "I<not> work, even if the length is specified."
20005 #: ../src/guestfs-actions.pod:7143 ../fish/guestfish-actions.pod:4763
20007 "This function is deprecated. In new code, use the C<write> call instead."
20012 #: ../src/guestfs-actions.pod:7152
20013 msgid "guestfs_zegrep"
20018 #: ../src/guestfs-actions.pod:7154
20022 " guestfs_zegrep (guestfs_h *g,\n"
20023 " const char *regex,\n"
20024 " const char *path);\n"
20030 #: ../src/guestfs-actions.pod:7159 ../fish/guestfish-actions.pod:4774
20032 "This calls the external C<zegrep> program and returns the matching lines."
20037 #: ../src/guestfs-actions.pod:7171
20038 msgid "guestfs_zegrepi"
20043 #: ../src/guestfs-actions.pod:7173
20047 " guestfs_zegrepi (guestfs_h *g,\n"
20048 " const char *regex,\n"
20049 " const char *path);\n"
20055 #: ../src/guestfs-actions.pod:7178 ../fish/guestfish-actions.pod:4784
20057 "This calls the external C<zegrep -i> program and returns the matching lines."
20062 #: ../src/guestfs-actions.pod:7190
20063 msgid "guestfs_zero"
20068 #: ../src/guestfs-actions.pod:7192
20072 " guestfs_zero (guestfs_h *g,\n"
20073 " const char *device);\n"
20079 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4794
20080 msgid "This command writes zeroes over the first few blocks of C<device>."
20085 #: ../src/guestfs-actions.pod:7198 ../fish/guestfish-actions.pod:4796
20087 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20088 "securely wipe the device). It should be sufficient to remove any partition "
20089 "tables, filesystem superblocks and so on."
20094 #: ../src/guestfs-actions.pod:7202
20095 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20100 #: ../src/guestfs-actions.pod:7213
20101 msgid "guestfs_zero_device"
20106 #: ../src/guestfs-actions.pod:7215
20110 " guestfs_zero_device (guestfs_h *g,\n"
20111 " const char *device);\n"
20117 #: ../src/guestfs-actions.pod:7219
20119 "This command writes zeroes over the entire C<device>. Compare with "
20120 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20125 #: ../src/guestfs-actions.pod:7233
20126 msgid "(Added in 1.3.1)"
20131 #: ../src/guestfs-actions.pod:7235
20132 msgid "guestfs_zerofree"
20137 #: ../src/guestfs-actions.pod:7237
20141 " guestfs_zerofree (guestfs_h *g,\n"
20142 " const char *device);\n"
20148 #: ../src/guestfs-actions.pod:7241 ../fish/guestfish-actions.pod:4817
20150 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20151 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20152 "possible to compress the filesystem more effectively."
20157 #: ../src/guestfs-actions.pod:7246 ../fish/guestfish-actions.pod:4822
20158 msgid "You should B<not> run this program if the filesystem is mounted."
20163 #: ../src/guestfs-actions.pod:7249 ../fish/guestfish-actions.pod:4825
20165 "It is possible that using this program can damage the filesystem or data on "
20171 #: ../src/guestfs-actions.pod:7256
20172 msgid "guestfs_zfgrep"
20177 #: ../src/guestfs-actions.pod:7258
20181 " guestfs_zfgrep (guestfs_h *g,\n"
20182 " const char *pattern,\n"
20183 " const char *path);\n"
20189 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4832
20191 "This calls the external C<zfgrep> program and returns the matching lines."
20196 #: ../src/guestfs-actions.pod:7275
20197 msgid "guestfs_zfgrepi"
20202 #: ../src/guestfs-actions.pod:7277
20206 " guestfs_zfgrepi (guestfs_h *g,\n"
20207 " const char *pattern,\n"
20208 " const char *path);\n"
20214 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4842
20216 "This calls the external C<zfgrep -i> program and returns the matching lines."
20221 #: ../src/guestfs-actions.pod:7294
20222 msgid "guestfs_zfile"
20227 #: ../src/guestfs-actions.pod:7296
20231 " guestfs_zfile (guestfs_h *g,\n"
20232 " const char *meth,\n"
20233 " const char *path);\n"
20239 #: ../src/guestfs-actions.pod:7301 ../fish/guestfish-actions.pod:4852
20241 "This command runs C<file> after first decompressing C<path> using C<method>."
20246 #: ../src/guestfs-actions.pod:7304 ../fish/guestfish-actions.pod:4855
20247 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20252 #: ../src/guestfs-actions.pod:7306
20254 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20260 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4860
20262 "This function is deprecated. In new code, use the C<file> call instead."
20267 #: ../src/guestfs-actions.pod:7321
20268 msgid "guestfs_zgrep"
20273 #: ../src/guestfs-actions.pod:7323
20277 " guestfs_zgrep (guestfs_h *g,\n"
20278 " const char *regex,\n"
20279 " const char *path);\n"
20285 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4871
20287 "This calls the external C<zgrep> program and returns the matching lines."
20292 #: ../src/guestfs-actions.pod:7340
20293 msgid "guestfs_zgrepi"
20298 #: ../src/guestfs-actions.pod:7342
20302 " guestfs_zgrepi (guestfs_h *g,\n"
20303 " const char *regex,\n"
20304 " const char *path);\n"
20310 #: ../src/guestfs-actions.pod:7347 ../fish/guestfish-actions.pod:4881
20312 "This calls the external C<zgrep -i> program and returns the matching lines."
20317 #: ../src/guestfs-availability.pod:3
20323 #: ../src/guestfs-availability.pod:5
20325 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20326 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20327 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20328 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20329 "L</guestfs_aug_save> L</guestfs_aug_set>"
20334 #: ../src/guestfs-availability.pod:21
20340 #: ../src/guestfs-availability.pod:23
20342 "The following functions: L</guestfs_inotify_add_watch> L</"
20343 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20344 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20349 #: ../src/guestfs-availability.pod:31
20350 msgid "B<linuxfsuuid>"
20355 #: ../src/guestfs-availability.pod:33
20357 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20358 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20363 #: ../src/guestfs-availability.pod:40
20364 msgid "B<linuxmodules>"
20369 #: ../src/guestfs-availability.pod:42
20370 msgid "The following functions: L</guestfs_modprobe>"
20375 #: ../src/guestfs-availability.pod:45
20376 msgid "B<linuxxattrs>"
20381 #: ../src/guestfs-availability.pod:47
20383 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20384 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20385 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20386 "guestfs_setxattr>"
20391 #: ../src/guestfs-availability.pod:58
20397 #: ../src/guestfs-availability.pod:60
20399 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20400 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20401 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20406 #: ../src/guestfs-availability.pod:69
20412 #: ../src/guestfs-availability.pod:71
20414 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20415 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20416 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20417 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20418 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20419 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20420 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20425 #: ../src/guestfs-availability.pod:94
20431 #: ../src/guestfs-availability.pod:96
20433 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20434 "guestfs_mknod_b> L</guestfs_mknod_c>"
20439 #: ../src/guestfs-availability.pod:102
20445 #: ../src/guestfs-availability.pod:104
20446 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20451 #: ../src/guestfs-availability.pod:107
20452 msgid "B<ntfsprogs>"
20457 #: ../src/guestfs-availability.pod:109
20459 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20464 #: ../src/guestfs-availability.pod:113
20465 msgid "B<realpath>"
20470 #: ../src/guestfs-availability.pod:115
20471 msgid "The following functions: L</guestfs_realpath>"
20476 #: ../src/guestfs-availability.pod:118
20482 #: ../src/guestfs-availability.pod:120
20484 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20485 "guestfs_scrub_freespace>"
20490 #: ../src/guestfs-availability.pod:125
20496 #: ../src/guestfs-availability.pod:127
20497 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20502 #: ../src/guestfs-availability.pod:131
20508 #: ../src/guestfs-availability.pod:133
20509 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20514 #: ../src/guestfs-availability.pod:137
20515 msgid "B<zerofree>"
20520 #: ../src/guestfs-availability.pod:139
20521 msgid "The following functions: L</guestfs_zerofree>"
20526 #: ../src/guestfs-structs.pod:1
20527 msgid "guestfs_int_bool"
20532 #: ../src/guestfs-structs.pod:3
20535 " struct guestfs_int_bool {\n"
20544 #: ../src/guestfs-structs.pod:8
20547 " struct guestfs_int_bool_list {\n"
20548 " uint32_t len; /* Number of elements in list. */\n"
20549 " struct guestfs_int_bool *val; /* Elements. */\n"
20556 #: ../src/guestfs-structs.pod:13
20559 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20560 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20566 #: ../src/guestfs-structs.pod:16
20567 msgid "guestfs_lvm_pv"
20572 #: ../src/guestfs-structs.pod:18
20575 " struct guestfs_lvm_pv {\n"
20576 " char *pv_name;\n"
20577 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20578 " char pv_uuid[32];\n"
20580 " uint64_t pv_size;\n"
20581 " uint64_t dev_size;\n"
20582 " uint64_t pv_free;\n"
20583 " uint64_t pv_used;\n"
20584 " char *pv_attr;\n"
20585 " int64_t pv_pe_count;\n"
20586 " int64_t pv_pe_alloc_count;\n"
20587 " char *pv_tags;\n"
20588 " uint64_t pe_start;\n"
20589 " int64_t pv_mda_count;\n"
20590 " uint64_t pv_mda_free;\n"
20597 #: ../src/guestfs-structs.pod:36
20600 " struct guestfs_lvm_pv_list {\n"
20601 " uint32_t len; /* Number of elements in list. */\n"
20602 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20609 #: ../src/guestfs-structs.pod:41
20612 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20613 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20619 #: ../src/guestfs-structs.pod:44
20620 msgid "guestfs_lvm_vg"
20625 #: ../src/guestfs-structs.pod:46
20628 " struct guestfs_lvm_vg {\n"
20629 " char *vg_name;\n"
20630 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20631 " char vg_uuid[32];\n"
20633 " char *vg_attr;\n"
20634 " uint64_t vg_size;\n"
20635 " uint64_t vg_free;\n"
20636 " char *vg_sysid;\n"
20637 " uint64_t vg_extent_size;\n"
20638 " int64_t vg_extent_count;\n"
20639 " int64_t vg_free_count;\n"
20640 " int64_t max_lv;\n"
20641 " int64_t max_pv;\n"
20642 " int64_t pv_count;\n"
20643 " int64_t lv_count;\n"
20644 " int64_t snap_count;\n"
20645 " int64_t vg_seqno;\n"
20646 " char *vg_tags;\n"
20647 " int64_t vg_mda_count;\n"
20648 " uint64_t vg_mda_free;\n"
20655 #: ../src/guestfs-structs.pod:69
20658 " struct guestfs_lvm_vg_list {\n"
20659 " uint32_t len; /* Number of elements in list. */\n"
20660 " struct guestfs_lvm_vg *val; /* Elements. */\n"
20667 #: ../src/guestfs-structs.pod:74
20670 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
20671 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
20677 #: ../src/guestfs-structs.pod:77
20678 msgid "guestfs_lvm_lv"
20683 #: ../src/guestfs-structs.pod:79
20686 " struct guestfs_lvm_lv {\n"
20687 " char *lv_name;\n"
20688 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20689 " char lv_uuid[32];\n"
20690 " char *lv_attr;\n"
20691 " int64_t lv_major;\n"
20692 " int64_t lv_minor;\n"
20693 " int64_t lv_kernel_major;\n"
20694 " int64_t lv_kernel_minor;\n"
20695 " uint64_t lv_size;\n"
20696 " int64_t seg_count;\n"
20698 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20699 " float snap_percent;\n"
20700 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20701 " float copy_percent;\n"
20702 " char *move_pv;\n"
20703 " char *lv_tags;\n"
20704 " char *mirror_log;\n"
20705 " char *modules;\n"
20712 #: ../src/guestfs-structs.pod:101
20715 " struct guestfs_lvm_lv_list {\n"
20716 " uint32_t len; /* Number of elements in list. */\n"
20717 " struct guestfs_lvm_lv *val; /* Elements. */\n"
20724 #: ../src/guestfs-structs.pod:106
20727 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
20728 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
20734 #: ../src/guestfs-structs.pod:111
20737 " struct guestfs_stat {\n"
20741 " int64_t nlink;\n"
20746 " int64_t blksize;\n"
20747 " int64_t blocks;\n"
20748 " int64_t atime;\n"
20749 " int64_t mtime;\n"
20750 " int64_t ctime;\n"
20757 #: ../src/guestfs-structs.pod:127
20760 " struct guestfs_stat_list {\n"
20761 " uint32_t len; /* Number of elements in list. */\n"
20762 " struct guestfs_stat *val; /* Elements. */\n"
20769 #: ../src/guestfs-structs.pod:132
20772 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
20773 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
20779 #: ../src/guestfs-structs.pod:137
20782 " struct guestfs_statvfs {\n"
20783 " int64_t bsize;\n"
20784 " int64_t frsize;\n"
20785 " int64_t blocks;\n"
20786 " int64_t bfree;\n"
20787 " int64_t bavail;\n"
20788 " int64_t files;\n"
20789 " int64_t ffree;\n"
20790 " int64_t favail;\n"
20793 " int64_t namemax;\n"
20800 #: ../src/guestfs-structs.pod:151
20803 " struct guestfs_statvfs_list {\n"
20804 " uint32_t len; /* Number of elements in list. */\n"
20805 " struct guestfs_statvfs *val; /* Elements. */\n"
20812 #: ../src/guestfs-structs.pod:156
20815 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
20816 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20822 #: ../src/guestfs-structs.pod:159
20823 msgid "guestfs_dirent"
20828 #: ../src/guestfs-structs.pod:161
20831 " struct guestfs_dirent {\n"
20841 #: ../src/guestfs-structs.pod:167
20844 " struct guestfs_dirent_list {\n"
20845 " uint32_t len; /* Number of elements in list. */\n"
20846 " struct guestfs_dirent *val; /* Elements. */\n"
20853 #: ../src/guestfs-structs.pod:172
20856 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20857 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20863 #: ../src/guestfs-structs.pod:177
20866 " struct guestfs_version {\n"
20867 " int64_t major;\n"
20868 " int64_t minor;\n"
20869 " int64_t release;\n"
20877 #: ../src/guestfs-structs.pod:184
20880 " struct guestfs_version_list {\n"
20881 " uint32_t len; /* Number of elements in list. */\n"
20882 " struct guestfs_version *val; /* Elements. */\n"
20889 #: ../src/guestfs-structs.pod:189
20892 " void guestfs_free_version (struct guestfs_free_version *);\n"
20893 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20899 #: ../src/guestfs-structs.pod:192
20900 msgid "guestfs_xattr"
20905 #: ../src/guestfs-structs.pod:194
20908 " struct guestfs_xattr {\n"
20909 " char *attrname;\n"
20910 " /* The next two fields describe a byte array. */\n"
20911 " uint32_t attrval_len;\n"
20912 " char *attrval;\n"
20919 #: ../src/guestfs-structs.pod:201
20922 " struct guestfs_xattr_list {\n"
20923 " uint32_t len; /* Number of elements in list. */\n"
20924 " struct guestfs_xattr *val; /* Elements. */\n"
20931 #: ../src/guestfs-structs.pod:206
20934 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20935 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
20941 #: ../src/guestfs-structs.pod:209
20942 msgid "guestfs_inotify_event"
20947 #: ../src/guestfs-structs.pod:211
20950 " struct guestfs_inotify_event {\n"
20951 " int64_t in_wd;\n"
20952 " uint32_t in_mask;\n"
20953 " uint32_t in_cookie;\n"
20954 " char *in_name;\n"
20961 #: ../src/guestfs-structs.pod:218
20964 " struct guestfs_inotify_event_list {\n"
20965 " uint32_t len; /* Number of elements in list. */\n"
20966 " struct guestfs_inotify_event *val; /* Elements. */\n"
20973 #: ../src/guestfs-structs.pod:223
20976 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20977 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20983 #: ../src/guestfs-structs.pod:226
20984 msgid "guestfs_partition"
20989 #: ../src/guestfs-structs.pod:228
20992 " struct guestfs_partition {\n"
20993 " int32_t part_num;\n"
20994 " uint64_t part_start;\n"
20995 " uint64_t part_end;\n"
20996 " uint64_t part_size;\n"
21003 #: ../src/guestfs-structs.pod:235
21006 " struct guestfs_partition_list {\n"
21007 " uint32_t len; /* Number of elements in list. */\n"
21008 " struct guestfs_partition *val; /* Elements. */\n"
21015 #: ../src/guestfs-structs.pod:240
21018 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21019 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21025 #: ../src/guestfs-structs.pod:243
21026 msgid "guestfs_application"
21031 #: ../src/guestfs-structs.pod:245
21034 " struct guestfs_application {\n"
21035 " char *app_name;\n"
21036 " char *app_display_name;\n"
21037 " int32_t app_epoch;\n"
21038 " char *app_version;\n"
21039 " char *app_release;\n"
21040 " char *app_install_path;\n"
21041 " char *app_trans_path;\n"
21042 " char *app_publisher;\n"
21043 " char *app_url;\n"
21044 " char *app_source_package;\n"
21045 " char *app_summary;\n"
21046 " char *app_description;\n"
21053 #: ../src/guestfs-structs.pod:260
21056 " struct guestfs_application_list {\n"
21057 " uint32_t len; /* Number of elements in list. */\n"
21058 " struct guestfs_application *val; /* Elements. */\n"
21065 #: ../src/guestfs-structs.pod:265
21068 " void guestfs_free_application (struct guestfs_free_application *);\n"
21069 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21075 #: ../fish/guestfish.pod:5
21076 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21081 #: ../fish/guestfish.pod:9
21084 " guestfish [--options] [commands]\n"
21090 #: ../fish/guestfish.pod:11
21099 #: ../fish/guestfish.pod:13
21102 " guestfish [--ro|--rw] -a disk.img\n"
21108 #: ../fish/guestfish.pod:15
21111 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21117 #: ../fish/guestfish.pod:17
21120 " guestfish -d libvirt-domain\n"
21126 #: ../fish/guestfish.pod:19
21129 " guestfish [--ro|--rw] -a disk.img -i\n"
21135 #: ../fish/guestfish.pod:21
21138 " guestfish -d libvirt-domain -i\n"
21144 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21145 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21151 #: ../fish/guestfish.pod:25
21153 "Using guestfish in read/write mode on live virtual machines can be "
21154 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21155 "option to use guestfish safely if the disk image or virtual machine might be "
21161 #: ../fish/guestfish.pod:32
21163 "Guestfish is a shell and command-line tool for examining and modifying "
21164 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21165 "functionality of the guestfs API, see L<guestfs(3)>."
21170 #: ../fish/guestfish.pod:36
21172 "Guestfish gives you structured access to the libguestfs API, from shell "
21173 "scripts or the command line or interactively. If you want to rescue a "
21174 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21180 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:928
21181 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
21182 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
21188 #: ../fish/guestfish.pod:43
21189 msgid "As an interactive shell"
21194 #: ../fish/guestfish.pod:45
21203 #: ../fish/guestfish.pod:47
21206 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21207 " editing virtual machine filesystems.\n"
21213 #: ../fish/guestfish.pod:50
21216 " Type: 'help' for a list of commands\n"
21217 " 'man' to read the manual\n"
21218 " 'quit' to quit the shell\n"
21224 #: ../fish/guestfish.pod:54
21227 " ><fs> add-ro disk.img\n"
21229 " ><fs> list-filesystems\n"
21230 " /dev/sda1: ext4\n"
21231 " /dev/vg_guest/lv_root: ext4\n"
21232 " /dev/vg_guest/lv_swap: swap\n"
21233 " ><fs> mount /dev/vg_guest/lv_root /\n"
21234 " ><fs> cat /etc/fstab\n"
21236 " # Created by anaconda\n"
21244 #: ../fish/guestfish.pod:67
21245 msgid "From shell scripts"
21250 #: ../fish/guestfish.pod:69
21251 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21256 #: ../fish/guestfish.pod:71
21259 " guestfish <<_EOF_\n"
21262 " mount /dev/vg_guest/lv_root /\n"
21263 " write /etc/motd \"Welcome, new users\"\n"
21270 #: ../fish/guestfish.pod:78
21271 msgid "List the LVM logical volumes in a disk image:"
21276 #: ../fish/guestfish.pod:80
21279 " guestfish -a disk.img --ro <<_EOF_\n"
21288 #: ../fish/guestfish.pod:85
21289 msgid "List all the filesystems in a disk image:"
21294 #: ../fish/guestfish.pod:87
21297 " guestfish -a disk.img --ro <<_EOF_\n"
21299 " list-filesystems\n"
21306 #: ../fish/guestfish.pod:92
21307 msgid "On one command line"
21312 #: ../fish/guestfish.pod:94
21313 msgid "Update C</etc/resolv.conf> in a guest:"
21318 #: ../fish/guestfish.pod:96
21322 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21323 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21329 #: ../fish/guestfish.pod:100
21330 msgid "Edit C</boot/grub/grub.conf> interactively:"
21335 #: ../fish/guestfish.pod:102
21338 " guestfish --rw --add disk.img \\\n"
21339 " --mount /dev/vg_guest/lv_root \\\n"
21340 " --mount /dev/sda1:/boot \\\n"
21341 " edit /boot/grub/grub.conf\n"
21347 #: ../fish/guestfish.pod:107
21348 msgid "Mount disks automatically"
21353 #: ../fish/guestfish.pod:109
21355 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21360 #: ../fish/guestfish.pod:112
21363 " guestfish --ro -a disk.img -i cat /etc/group\n"
21369 #: ../fish/guestfish.pod:114
21372 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21378 #: ../fish/guestfish.pod:116
21379 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21384 #: ../fish/guestfish.pod:118
21387 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21393 #: ../fish/guestfish.pod:120
21394 msgid "As a script interpreter"
21399 #: ../fish/guestfish.pod:122
21400 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21405 #: ../fish/guestfish.pod:124
21408 " #!/usr/bin/guestfish -f\n"
21409 " sparse test1.img 100M\n"
21411 " part-disk /dev/sda mbr\n"
21412 " mkfs ext2 /dev/sda1\n"
21418 #: ../fish/guestfish.pod:130
21419 msgid "Start with a prepared disk"
21424 #: ../fish/guestfish.pod:132
21426 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21427 "single ext2-formatted partition:"
21432 #: ../fish/guestfish.pod:135
21435 " guestfish -N fs\n"
21441 #: ../fish/guestfish.pod:137
21442 msgid "To list what is available do:"
21447 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:919
21450 " guestfish -N help | less\n"
21456 #: ../fish/guestfish.pod:141
21457 msgid "Remote control"
21462 #: ../fish/guestfish.pod:143
21465 " eval \"`guestfish --listen`\"\n"
21466 " guestfish --remote add-ro disk.img\n"
21467 " guestfish --remote run\n"
21468 " guestfish --remote lvs\n"
21474 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21475 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
21476 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
21477 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
21478 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
21484 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21485 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104
21486 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
21487 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
21488 #: ../tools/virt-list-partitions.pl:62
21494 #: ../fish/guestfish.pod:154
21495 msgid "Displays general help on options."
21500 #: ../fish/guestfish.pod:156
21506 #: ../fish/guestfish.pod:158
21507 msgid "B<--cmd-help>"
21512 #: ../fish/guestfish.pod:160
21513 msgid "Lists all available guestfish commands."
21518 #: ../fish/guestfish.pod:162
21524 #: ../fish/guestfish.pod:164
21525 msgid "B<--cmd-help cmd>"
21530 #: ../fish/guestfish.pod:166
21531 msgid "Displays detailed help on a single command C<cmd>."
21536 #: ../fish/guestfish.pod:168
21537 msgid "B<-a image>"
21542 #: ../fish/guestfish.pod:170
21543 msgid "B<--add image>"
21548 #: ../fish/guestfish.pod:172
21549 msgid "Add a block device or virtual machine image to the shell."
21554 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21556 "The format of the disk image is auto-detected. To override this and force a "
21557 "particular format use the I<--format=..> option."
21562 #: ../fish/guestfish.pod:177
21564 "Using this flag is mostly equivalent to using the C<add> command, with "
21565 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21566 "the I<--format:...> flag was given."
21571 #: ../fish/guestfish.pod:181
21577 #: ../fish/guestfish.pod:183
21578 msgid "B<--connect URI>"
21583 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21585 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21586 "URI to use. The default is to use the default libvirt connection."
21591 #: ../fish/guestfish.pod:189
21597 #: ../fish/guestfish.pod:191
21599 "If using the I<--listen> option and a csh-like shell, use this option. See "
21600 "section L</REMOTE CONTROL AND CSH> below."
21605 #: ../fish/guestfish.pod:194
21606 msgid "B<-d libvirt-domain>"
21611 #: ../fish/guestfish.pod:196
21612 msgid "B<--domain libvirt-domain>"
21617 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21619 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21620 "used, then any libvirt domain can be used. However in write mode, only "
21621 "libvirt domains which are shut down can be named here."
21626 #: ../fish/guestfish.pod:202
21628 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21629 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21630 "if the I<--format:...> flag was given."
21635 #: ../fish/guestfish.pod:206
21641 #: ../fish/guestfish.pod:208
21642 msgid "B<--no-dest-paths>"
21647 #: ../fish/guestfish.pod:210
21649 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21650 "to hit the tab key to complete paths on the guest filesystem, but this "
21651 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21652 "allow this feature to be disabled."
21657 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
21658 msgid "B<--echo-keys>"
21663 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
21665 "When prompting for keys and passphrases, guestfish normally turns echoing "
21666 "off so you cannot see what you are typing. If you are not worried about "
21667 "Tempest attacks and there is no one else in the room you can specify this "
21668 "flag to see what you are typing."
21673 #: ../fish/guestfish.pod:222
21679 #: ../fish/guestfish.pod:224
21680 msgid "B<--file file>"
21685 #: ../fish/guestfish.pod:226
21686 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21691 #: ../fish/guestfish.pod:229
21694 " #!/usr/bin/guestfish -f\n"
21700 #: ../fish/guestfish.pod:231
21701 msgid "B<--format=raw|qcow2|..>"
21706 #: ../fish/guestfish.pod:233
21707 msgid "B<--format>"
21712 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
21714 "The default for the I<-a> option is to auto-detect the format of the disk "
21715 "image. Using this forces the disk format for I<-a> options which follow on "
21716 "the command line. Using I<--format> with no argument switches back to auto-"
21717 "detection for subsequent I<-a> options."
21722 #: ../fish/guestfish.pod:242
21725 " guestfish --format=raw -a disk.img\n"
21731 #: ../fish/guestfish.pod:244
21732 msgid "forces raw format (no auto-detection) for C<disk.img>."
21737 #: ../fish/guestfish.pod:246
21740 " guestfish --format=raw -a disk.img --format -a another.img\n"
21746 #: ../fish/guestfish.pod:248
21748 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
21749 "detection for C<another.img>."
21754 #: ../fish/guestfish.pod:251
21756 "If you have untrusted raw-format guest disk images, you should use this "
21757 "option to specify the disk format. This avoids a possible security problem "
21758 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21763 #: ../fish/guestfish.pod:256
21769 #: ../fish/guestfish.pod:258
21770 msgid "B<--inspector>"
21775 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
21777 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21778 "system and mount filesystems as they would be mounted on the real virtual "
21784 #: ../fish/guestfish.pod:264
21785 msgid "Typical usage is either:"
21790 #: ../fish/guestfish.pod:266
21793 " guestfish -d myguest -i\n"
21799 #: ../fish/guestfish.pod:268
21800 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21805 #: ../fish/guestfish.pod:270
21808 " guestfish --ro -d myguest -i\n"
21814 #: ../fish/guestfish.pod:272
21815 msgid "(for active domains, readonly), or specify the block device directly:"
21820 #: ../fish/guestfish.pod:274
21823 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21829 #: ../fish/guestfish.pod:276
21831 "Note that the command line syntax changed slightly over older versions of "
21832 "guestfish. You can still use the old syntax:"
21837 #: ../fish/guestfish.pod:279
21840 " guestfish [--ro] -i disk.img\n"
21846 #: ../fish/guestfish.pod:281
21849 " guestfish [--ro] -i libvirt-domain\n"
21855 #: ../fish/guestfish.pod:283
21857 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21858 "then using other commands to mount the filesystems that were found."
21863 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21864 msgid "B<--keys-from-stdin>"
21869 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21871 "Read key or passphrase parameters from stdin. The default is to try to read "
21872 "passphrases from the user by opening C</dev/tty>."
21877 #: ../fish/guestfish.pod:292
21878 msgid "B<--listen>"
21883 #: ../fish/guestfish.pod:294
21885 "Fork into the background and listen for remote commands. See section L</"
21886 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21890 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
21895 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
21897 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
21898 "ATTACHING TO RUNNING DAEMONS>)."
21903 #: ../fish/guestfish.pod:302
21904 msgid "B<-m dev[:mountpoint]>"
21909 #: ../fish/guestfish.pod:304
21910 msgid "B<--mount dev[:mountpoint]>"
21915 #: ../fish/guestfish.pod:306
21916 msgid "Mount the named partition or logical volume on the given mountpoint."
21921 #: ../fish/guestfish.pod:308
21922 msgid "If the mountpoint is omitted, it defaults to C</>."
21927 #: ../fish/guestfish.pod:310
21928 msgid "You have to mount something on C</> before most commands will work."
21933 #: ../fish/guestfish.pod:312
21935 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21941 #: ../fish/guestfish.pod:315
21943 "If you don't know what filesystems a disk image contains, you can either run "
21944 "guestfish without this option, then list the partitions, filesystems and LVs "
21945 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21946 "commands), or you can use the L<virt-filesystems(1)> program."
21951 #: ../fish/guestfish.pod:321
21953 "Using this flag is mostly equivalent to using the C<mount-options> command "
21954 "or the C<mount-ro> command if the I<--ro> flag was given."
21959 #: ../fish/guestfish.pod:324
21965 #: ../fish/guestfish.pod:326
21966 msgid "B<--no-sync>"
21971 #: ../fish/guestfish.pod:328
21973 "Disable autosync. This is enabled by default. See the discussion of "
21974 "autosync in the L<guestfs(3)> manpage."
21979 #: ../fish/guestfish.pod:331
21985 #: ../fish/guestfish.pod:333
21986 msgid "B<--new type>"
21991 #: ../fish/guestfish.pod:335
21997 #: ../fish/guestfish.pod:337
21999 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22000 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22001 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22007 #: ../fish/guestfish.pod:342
22008 msgid "B<--progress-bars>"
22013 #: ../fish/guestfish.pod:344
22014 msgid "Enable progress bars, even when guestfish is used non-interactively."
22019 #: ../fish/guestfish.pod:346
22021 "Progress bars are enabled by default when guestfish is used as an "
22022 "interactive shell."
22027 #: ../fish/guestfish.pod:349
22028 msgid "B<--no-progress-bars>"
22033 #: ../fish/guestfish.pod:351
22034 msgid "Disable progress bars."
22039 #: ../fish/guestfish.pod:353
22040 msgid "B<--remote[=pid]>"
22045 #: ../fish/guestfish.pod:355
22047 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22048 "CONTROL GUESTFISH OVER A SOCKET> below."
22053 #: ../fish/guestfish.pod:358
22059 #: ../fish/guestfish.pod:360
22065 #: ../fish/guestfish.pod:362
22067 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22068 "mounts are done read-only."
22073 #: ../fish/guestfish.pod:365
22075 "The option must always be used if the disk image or virtual machine might be "
22076 "running, and is generally recommended in cases where you don't need write "
22077 "access to the disk."
22082 #: ../fish/guestfish.pod:369
22084 "Note that prepared disk images created with I<-N> are not affected by this "
22085 "option. Also commands like C<add> are not affected - you have to specify "
22086 "the C<readonly:true> option explicitly if you need it."
22091 #: ../fish/guestfish.pod:373
22092 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22097 #: ../fish/guestfish.pod:375 ../fuse/guestmount.pod:213
22098 msgid "B<--selinux>"
22103 #: ../fish/guestfish.pod:377
22104 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22109 #: ../fish/guestfish.pod:379
22115 #: ../fish/guestfish.pod:381
22116 msgid "B<--verbose>"
22121 #: ../fish/guestfish.pod:383
22123 "Enable very verbose messages. This is particularly useful if you find a bug."
22128 #: ../fish/guestfish.pod:386
22134 #: ../fish/guestfish.pod:388 ../tools/virt-edit.pl:88
22135 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
22136 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22137 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22138 msgid "B<--version>"
22143 #: ../fish/guestfish.pod:390
22144 msgid "Display the guestfish / libguestfs version number and exit."
22149 #: ../fish/guestfish.pod:392
22155 #: ../fish/guestfish.pod:394
22161 #: ../fish/guestfish.pod:396
22163 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
22169 #: ../fish/guestfish.pod:399
22175 #: ../fish/guestfish.pod:401
22176 msgid "Echo each command before executing it."
22181 #: ../fish/guestfish.pod:405
22182 msgid "COMMANDS ON COMMAND LINE"
22187 #: ../fish/guestfish.pod:407
22189 "Any additional (non-option) arguments are treated as commands to execute."
22194 #: ../fish/guestfish.pod:410
22196 "Commands to execute should be separated by a colon (C<:>), where the colon "
22197 "is a separate parameter. Thus:"
22202 #: ../fish/guestfish.pod:413
22205 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22211 #: ../fish/guestfish.pod:415
22213 "If there are no additional arguments, then we enter a shell, either an "
22214 "interactive shell with a prompt (if the input is a terminal) or a non-"
22215 "interactive shell."
22220 #: ../fish/guestfish.pod:419
22222 "In either command line mode or non-interactive shell, the first command that "
22223 "gives an error causes the whole shell to exit. In interactive mode (with a "
22224 "prompt) if a command fails, you can continue to enter commands."
22229 #: ../fish/guestfish.pod:424
22230 msgid "USING launch (OR run)"
22235 #: ../fish/guestfish.pod:426
22237 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22238 "then launch it, then mount any disks you need, and finally issue actions/"
22239 "commands. So the general order of the day is:"
22244 #: ../fish/guestfish.pod:434
22245 msgid "add or -a/--add"
22250 #: ../fish/guestfish.pod:438
22251 msgid "launch (aka run)"
22256 #: ../fish/guestfish.pod:442
22257 msgid "mount or -m/--mount"
22262 #: ../fish/guestfish.pod:446
22263 msgid "any other commands"
22268 #: ../fish/guestfish.pod:450
22270 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22271 "guest before mounting or performing any other commands."
22276 #: ../fish/guestfish.pod:453
22278 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22279 "I<--new> options were given then C<run> is done automatically, simply "
22280 "because guestfish can't perform the action you asked for without doing this."
22285 #: ../fish/guestfish.pod:458
22286 msgid "OPENING DISKS FOR READ AND WRITE"
22291 #: ../fish/guestfish.pod:460
22293 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
22294 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
22295 "open disk images read-only or for writing."
22300 #: ../fish/guestfish.pod:464
22302 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
22303 "disk images supplied on the command line for write. To open a disk image "
22304 "read-only you have to do I<-a image --ro>."
22309 #: ../fish/guestfish.pod:468
22311 "This matters: If you accidentally open a live VM disk image writable then "
22312 "you will cause irreversible disk corruption."
22316 #: ../fish/guestfish.pod:471
22318 "By libguestfs 1.10 we intend to change the default the other way. Disk "
22319 "images will be opened read-only. You will have to either specify "
22320 "I<guestfish --rw> or change a configuration file in order to get write "
22321 "access for disk images specified by those other command line options."
22326 #: ../fish/guestfish.pod:476
22328 "This version of guestfish has a I<--rw> option which does nothing (it is "
22329 "already the default). However it is highly recommended that you use this "
22330 "option to indicate that guestfish needs write access, and to prepare your "
22331 "scripts for the day when this option will be required for write access."
22336 #: ../fish/guestfish.pod:482
22338 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22339 "other libguestfs program apart from guestfish and guestmount."
22344 #: ../fish/guestfish.pod:485
22350 #: ../fish/guestfish.pod:487
22352 "You can quote ordinary parameters using either single or double quotes. For "
22358 #: ../fish/guestfish.pod:490
22361 " add \"file with a space.img\"\n"
22367 #: ../fish/guestfish.pod:492
22370 " rm '/file name'\n"
22376 #: ../fish/guestfish.pod:494
22385 #: ../fish/guestfish.pod:496
22387 "A few commands require a list of strings to be passed. For these, use a "
22388 "whitespace-separated list, enclosed in quotes. Strings containing "
22389 "whitespace to be passed through must be enclosed in single quotes. A "
22390 "literal single quote must be escaped with a backslash."
22395 #: ../fish/guestfish.pod:501
22398 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22399 " command \"/bin/echo 'foo bar'\"\n"
22400 " command \"/bin/echo \\'foo\\'\"\n"
22406 #: ../fish/guestfish.pod:505
22407 msgid "OPTIONAL ARGUMENTS"
22412 #: ../fish/guestfish.pod:507
22414 "Some commands take optional arguments. These arguments appear in this "
22415 "documentation as C<[argname:..]>. You can use them as in these examples:"
22420 #: ../fish/guestfish.pod:511
22423 " add-drive-opts filename\n"
22429 #: ../fish/guestfish.pod:513
22432 " add-drive-opts filename readonly:true\n"
22438 #: ../fish/guestfish.pod:515
22441 " add-drive-opts filename format:qcow2 readonly:false\n"
22447 #: ../fish/guestfish.pod:517
22449 "Each optional argument can appear at most once. All optional arguments must "
22450 "appear after the required ones."
22455 #: ../fish/guestfish.pod:520
22461 #: ../fish/guestfish.pod:522
22463 "This section applies to all commands which can take integers as parameters."
22468 #: ../fish/guestfish.pod:525
22469 msgid "SIZE SUFFIX"
22474 #: ../fish/guestfish.pod:527
22476 "When the command takes a parameter measured in bytes, you can use one of the "
22477 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22482 #: ../fish/guestfish.pod:533
22483 msgid "B<k> or B<K> or B<KiB>"
22488 #: ../fish/guestfish.pod:535
22489 msgid "The size in kilobytes (multiplied by 1024)."
22494 #: ../fish/guestfish.pod:537
22500 #: ../fish/guestfish.pod:539
22501 msgid "The size in SI 1000 byte units."
22506 #: ../fish/guestfish.pod:541
22507 msgid "B<M> or B<MiB>"
22512 #: ../fish/guestfish.pod:543
22513 msgid "The size in megabytes (multiplied by 1048576)."
22518 #: ../fish/guestfish.pod:545
22524 #: ../fish/guestfish.pod:547
22525 msgid "The size in SI 1000000 byte units."
22530 #: ../fish/guestfish.pod:549
22531 msgid "B<G> or B<GiB>"
22536 #: ../fish/guestfish.pod:551
22537 msgid "The size in gigabytes (multiplied by 2**30)."
22542 #: ../fish/guestfish.pod:553
22548 #: ../fish/guestfish.pod:555
22549 msgid "The size in SI 10**9 byte units."
22554 #: ../fish/guestfish.pod:557
22555 msgid "B<T> or B<TiB>"
22560 #: ../fish/guestfish.pod:559
22561 msgid "The size in terabytes (multiplied by 2**40)."
22566 #: ../fish/guestfish.pod:561
22572 #: ../fish/guestfish.pod:563
22573 msgid "The size in SI 10**12 byte units."
22578 #: ../fish/guestfish.pod:565
22579 msgid "B<P> or B<PiB>"
22584 #: ../fish/guestfish.pod:567
22585 msgid "The size in petabytes (multiplied by 2**50)."
22590 #: ../fish/guestfish.pod:569
22596 #: ../fish/guestfish.pod:571
22597 msgid "The size in SI 10**15 byte units."
22602 #: ../fish/guestfish.pod:573
22603 msgid "B<E> or B<EiB>"
22608 #: ../fish/guestfish.pod:575
22609 msgid "The size in exabytes (multiplied by 2**60)."
22614 #: ../fish/guestfish.pod:577
22620 #: ../fish/guestfish.pod:579
22621 msgid "The size in SI 10**18 byte units."
22626 #: ../fish/guestfish.pod:581
22627 msgid "B<Z> or B<ZiB>"
22632 #: ../fish/guestfish.pod:583
22633 msgid "The size in zettabytes (multiplied by 2**70)."
22638 #: ../fish/guestfish.pod:585
22644 #: ../fish/guestfish.pod:587
22645 msgid "The size in SI 10**21 byte units."
22650 #: ../fish/guestfish.pod:589
22651 msgid "B<Y> or B<YiB>"
22656 #: ../fish/guestfish.pod:591
22657 msgid "The size in yottabytes (multiplied by 2**80)."
22662 #: ../fish/guestfish.pod:593
22668 #: ../fish/guestfish.pod:595
22669 msgid "The size in SI 10**24 byte units."
22674 #: ../fish/guestfish.pod:601
22677 " truncate-size /file 1G\n"
22683 #: ../fish/guestfish.pod:603
22684 msgid "would truncate the file to 1 gigabyte."
22689 #: ../fish/guestfish.pod:605
22691 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22692 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22693 "suffix will probably not do what you expect."
22698 #: ../fish/guestfish.pod:609
22699 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22704 #: ../fish/guestfish.pod:611
22706 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22707 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22712 #: ../fish/guestfish.pod:614
22715 " 1234 decimal number 1234\n"
22716 " 02322 octal number, equivalent to decimal 1234\n"
22717 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22723 #: ../fish/guestfish.pod:618
22725 "When using the C<chmod> command, you almost always want to specify an octal "
22726 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22727 "L<chmod(1)> program):"
22732 #: ../fish/guestfish.pod:622
22735 " chmod 0777 /public # OK\n"
22736 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22742 #: ../fish/guestfish.pod:625
22744 "Commands that return numbers usually print them in decimal, but some "
22745 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22746 "octal, preceeded by C<0>)."
22751 #: ../fish/guestfish.pod:629
22752 msgid "WILDCARDS AND GLOBBING"
22757 #: ../fish/guestfish.pod:631
22759 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22760 "(globbing) by default. So for example the following will not do what you "
22766 #: ../fish/guestfish.pod:635
22775 #: ../fish/guestfish.pod:637
22777 "Assuming you don't have a directory called literally C</home/*> then the "
22778 "above command will return an error."
22783 #: ../fish/guestfish.pod:640
22784 msgid "To perform wildcard expansion, use the C<glob> command."
22789 #: ../fish/guestfish.pod:642
22792 " glob rm-rf /home/*\n"
22798 #: ../fish/guestfish.pod:644
22800 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
22801 "many times), equivalent to:"
22806 #: ../fish/guestfish.pod:647
22809 " rm-rf /home/jim\n"
22810 " rm-rf /home/joe\n"
22811 " rm-rf /home/mary\n"
22817 #: ../fish/guestfish.pod:651
22818 msgid "C<glob> only works on simple guest paths and not on device names."
22823 #: ../fish/guestfish.pod:653
22825 "If you have several parameters, each containing a wildcard, then glob will "
22826 "perform a Cartesian product."
22831 #: ../fish/guestfish.pod:656
22837 #: ../fish/guestfish.pod:658
22839 "Any line which starts with a I<#> character is treated as a comment and "
22840 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22841 "a command. For example:"
22846 #: ../fish/guestfish.pod:662
22849 " # this is a comment\n"
22850 " # this is a comment\n"
22851 " foo # NOT a comment\n"
22857 #: ../fish/guestfish.pod:666
22858 msgid "Blank lines are also ignored."
22863 #: ../fish/guestfish.pod:668
22864 msgid "RUNNING COMMANDS LOCALLY"
22869 #: ../fish/guestfish.pod:670
22871 "Any line which starts with a I<!> character is treated as a command sent to "
22872 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22877 #: ../fish/guestfish.pod:674
22881 " tgz-out /remote local/remote-data.tar.gz\n"
22887 #: ../fish/guestfish.pod:677
22889 "will create a directory C<local> on the host, and then export the contents "
22890 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22891 "(See C<tgz-out>)."
22896 #: ../fish/guestfish.pod:681
22898 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22899 "effect, due to the way that subprocesses work in Unix."
22903 #: ../fish/guestfish.pod:684
22904 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
22908 #: ../fish/guestfish.pod:686
22910 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
22911 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
22912 "and executed as guestfish commands."
22916 #: ../fish/guestfish.pod:690
22918 "Thus you can use shell script to construct arbitrary guestfish commands "
22919 "which are then parsed by guestfish."
22923 #: ../fish/guestfish.pod:693
22925 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
22926 "through C</foo.100>) using guestfish commands alone. However this is simple "
22927 "if we use a shell script to create the guestfish commands for us:"
22931 #: ../fish/guestfish.pod:698
22934 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
22939 #: ../fish/guestfish.pod:700
22940 msgid "or with names like C</foo.001>:"
22944 #: ../fish/guestfish.pod:702
22947 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
22952 #: ../fish/guestfish.pod:704
22954 "When using guestfish interactively it can be helpful to just run the shell "
22955 "script first (ie. remove the initial C<E<lt>> character so it is just an "
22956 "ordinary I<!> local command), see what guestfish commands it would run, and "
22957 "when you are happy with those prepend the C<E<lt>> character to run the "
22958 "guestfish commands for real."
22963 #: ../fish/guestfish.pod:710
22969 #: ../fish/guestfish.pod:712
22971 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
22972 "command (a guestfish command) to the second command (any host command). For "
22978 #: ../fish/guestfish.pod:716
22981 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
22987 #: ../fish/guestfish.pod:718
22989 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
22990 "program). The above command would list all accounts in the guest filesystem "
22991 "which have UID 0, ie. root accounts including backdoors. Other examples:"
22996 #: ../fish/guestfish.pod:723
22999 " hexdump /bin/ls | head\n"
23000 " list-devices | tail -1\n"
23001 " tgz-out / - | tar ztf -\n"
23007 #: ../fish/guestfish.pod:727
23009 "The space before the pipe symbol is required, any space after the pipe "
23010 "symbol is optional. Everything after the pipe symbol is just passed "
23011 "straight to the host shell, so it can contain redirections, globs and "
23012 "anything else that makes sense on the host side."
23017 #: ../fish/guestfish.pod:732
23019 "To use a literal argument which begins with a pipe symbol, you have to quote "
23025 #: ../fish/guestfish.pod:735
23034 #: ../fish/guestfish.pod:737
23035 msgid "HOME DIRECTORIES"
23040 #: ../fish/guestfish.pod:739
23042 "If a parameter starts with the character C<~> then the tilde may be expanded "
23043 "as a home directory path (either C<~> for the current user's home directory, "
23044 "or C<~user> for another user)."
23049 #: ../fish/guestfish.pod:743
23051 "Note that home directory expansion happens for users known I<on the host>, "
23052 "not in the guest filesystem."
23057 #: ../fish/guestfish.pod:746
23059 "To use a literal argument which begins with a tilde, you have to quote it, "
23065 #: ../fish/guestfish.pod:749
23074 #: ../fish/guestfish.pod:753
23076 "Libguestfs has some support for Linux guests encrypted according to the "
23077 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23078 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23079 "LUKS is supported."
23084 #: ../fish/guestfish.pod:758
23085 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23090 #: ../fish/guestfish.pod:760
23093 " ><fs> vfs-type /dev/sda2\n"
23100 #: ../fish/guestfish.pod:763
23102 "Then open those devices using L</luks-open>. This creates a device-mapper "
23103 "device called C</dev/mapper/luksdev>."
23108 #: ../fish/guestfish.pod:766
23111 " ><fs> luks-open /dev/sda2 luksdev\n"
23112 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23118 #: ../fish/guestfish.pod:769
23120 "Finally you have to tell LVM to scan for volume groups on the newly created "
23126 #: ../fish/guestfish.pod:772
23130 " vg-activate-all true\n"
23136 #: ../fish/guestfish.pod:775
23137 msgid "The logical volume(s) can now be mounted in the usual way."
23142 #: ../fish/guestfish.pod:777
23144 "Before closing a LUKS device you must unmount any logical volumes on it and "
23145 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23146 "one. Then you can close the mapper device:"
23151 #: ../fish/guestfish.pod:781
23154 " vg-activate false /dev/VG\n"
23155 " luks-close /dev/mapper/luksdev\n"
23161 #: ../fish/guestfish.pod:784
23162 msgid "WINDOWS PATHS"
23167 #: ../fish/guestfish.pod:786
23169 "If a path is prefixed with C<win:> then you can use Windows-style paths "
23170 "(with some limitations). The following commands are equivalent:"
23175 #: ../fish/guestfish.pod:789
23178 " file /WINDOWS/system32/config/system.LOG\n"
23184 #: ../fish/guestfish.pod:791
23187 " file win:/windows/system32/config/system.log\n"
23193 #: ../fish/guestfish.pod:793
23196 " file win:\\windows\\system32\\config\\system.log\n"
23202 #: ../fish/guestfish.pod:795
23205 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
23211 #: ../fish/guestfish.pod:797
23213 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
23214 "handles case insensitivity like Windows would. This only works in argument "
23215 "positions that expect a path."
23220 #: ../fish/guestfish.pod:801
23221 msgid "UPLOADING AND DOWNLOADING FILES"
23226 #: ../fish/guestfish.pod:803
23228 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23229 "others which upload from or download to a local file, you can use the "
23230 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23235 #: ../fish/guestfish.pod:807
23244 #: ../fish/guestfish.pod:809
23246 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23251 #: ../fish/guestfish.pod:812
23254 " tar-out /etc - | tar tf -\n"
23260 #: ../fish/guestfish.pod:814
23262 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23263 "command (see L</PIPES>)."
23268 #: ../fish/guestfish.pod:817
23270 "When using C<-> to read from stdin, the input is read up to the end of "
23271 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23272 "some arbitrary end marker:"
23277 #: ../fish/guestfish.pod:821
23280 " upload -<<END /foo\n"
23290 #: ../fish/guestfish.pod:827
23292 "Any string of characters can be used instead of C<END>. The end marker must "
23293 "appear on a line of its own, without any preceeding or following characters "
23294 "(not even spaces)."
23299 #: ../fish/guestfish.pod:831
23301 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23302 "upload local files (so-called \"FileIn\" parameters in the generator)."
23307 #: ../fish/guestfish.pod:834
23308 msgid "EXIT ON ERROR BEHAVIOUR"
23313 #: ../fish/guestfish.pod:836
23315 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23316 "taking commands from a human over a tty), and will exit on the first error "
23317 "in non-interactive mode (scripts, commands given on the command line)."
23322 #: ../fish/guestfish.pod:841
23324 "If you prefix a command with a I<-> character, then that command will not "
23325 "cause guestfish to exit, even if that (one) command returns an error."
23330 #: ../fish/guestfish.pod:845
23331 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23336 #: ../fish/guestfish.pod:847
23338 "Guestfish can be remote-controlled over a socket. This is useful "
23339 "particularly in shell scripts where you want to make several different "
23340 "changes to a filesystem, but you don't want the overhead of starting up a "
23341 "guestfish process each time."
23346 #: ../fish/guestfish.pod:852
23347 msgid "Start a guestfish server process using:"
23352 #: ../fish/guestfish.pod:854
23355 " eval \"`guestfish --listen`\"\n"
23361 #: ../fish/guestfish.pod:856
23362 msgid "and then send it commands by doing:"
23367 #: ../fish/guestfish.pod:858
23370 " guestfish --remote cmd [...]\n"
23376 #: ../fish/guestfish.pod:860
23377 msgid "To cause the server to exit, send it the exit command:"
23382 #: ../fish/guestfish.pod:862
23385 " guestfish --remote exit\n"
23391 #: ../fish/guestfish.pod:864
23393 "Note that the server will normally exit if there is an error in a command. "
23394 "You can change this in the usual way. See section L</EXIT ON ERROR "
23400 #: ../fish/guestfish.pod:868
23401 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23406 #: ../fish/guestfish.pod:870
23408 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23409 "is how the I<--remote> option knows where to send the commands. You can "
23410 "have several guestfish listener processes running using:"
23415 #: ../fish/guestfish.pod:874
23418 " eval \"`guestfish --listen`\"\n"
23419 " pid1=$GUESTFISH_PID\n"
23420 " eval \"`guestfish --listen`\"\n"
23421 " pid2=$GUESTFISH_PID\n"
23423 " guestfish --remote=$pid1 cmd\n"
23424 " guestfish --remote=$pid2 cmd\n"
23430 #: ../fish/guestfish.pod:882
23431 msgid "REMOTE CONTROL AND CSH"
23436 #: ../fish/guestfish.pod:884
23438 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23444 #: ../fish/guestfish.pod:887
23447 " eval \"`guestfish --listen --csh`\"\n"
23453 #: ../fish/guestfish.pod:889
23454 msgid "REMOTE CONTROL DETAILS"
23459 #: ../fish/guestfish.pod:891
23461 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23462 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23463 "and C<$PID> is the process ID of the server."
23468 #: ../fish/guestfish.pod:895
23469 msgid "Guestfish client and server versions must match exactly."
23474 #: ../fish/guestfish.pod:897
23475 msgid "PREPARED DISK IMAGES"
23480 #: ../fish/guestfish.pod:899
23482 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23483 "preformatted disk images that guestfish can make for you to save typing. "
23484 "This is particularly useful for testing purposes. This option is used "
23485 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23486 "can be mixed with I<-a>)."
23491 #: ../fish/guestfish.pod:905
23493 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23494 "the second and so on. Existing files in the current directory are "
23500 #: ../fish/guestfish.pod:909
23502 "The type briefly describes how the disk should be sized, partitioned, how "
23503 "filesystem(s) should be created, and how content should be added. "
23504 "Optionally the type can be followed by extra parameters, separated by C<:> "
23505 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23506 "allocated disk, containing a single partition, with the partition formatted "
23507 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23513 #: ../fish/guestfish.pod:917
23514 msgid "To list the available types and any extra parameters they take, run:"
23519 #: ../fish/guestfish.pod:921
23521 "Note that the prepared filesystem is not mounted. You would usually have to "
23522 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23527 #: ../fish/guestfish.pod:925
23529 "If any I<-N> or I<--new> options are given, the guest is automatically "
23535 #: ../fish/guestfish.pod:930
23536 msgid "Create a 100MB disk with an ext4-formatted partition:"
23541 #: ../fish/guestfish.pod:932
23544 " guestfish -N fs:ext4\n"
23550 #: ../fish/guestfish.pod:934
23551 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23556 #: ../fish/guestfish.pod:936
23559 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23565 #: ../fish/guestfish.pod:938
23566 msgid "Create a blank 200MB disk:"
23571 #: ../fish/guestfish.pod:940
23574 " guestfish -N disk:200M\n"
23580 #: ../fish/guestfish.pod:942
23581 msgid "PROGRESS BARS"
23586 #: ../fish/guestfish.pod:944
23588 "Some (not all) long-running commands send progress notification messages as "
23589 "they are running. Guestfish turns these messages into progress bars."
23594 #: ../fish/guestfish.pod:948
23596 "When a command that supports progress bars takes longer than two seconds to "
23597 "run, and if progress bars are enabled, then you will see one appearing below "
23603 #: ../fish/guestfish.pod:952
23606 " ><fs> copy-size /large-file /another-file 2048M\n"
23607 " / 10% [#####-----------------------------------------] 00:30\n"
23613 #: ../fish/guestfish.pod:955
23615 "The spinner on the left hand side moves round once for every progress "
23616 "notification received from the backend. This is a (reasonably) golden "
23617 "assurance that the command is \"doing something\" even if the progress bar "
23618 "is not moving, because the command is able to send the progress "
23619 "notifications. When the bar reaches 100% and the command finishes, the "
23620 "spinner disappears."
23625 #: ../fish/guestfish.pod:962
23627 "Progress bars are enabled by default when guestfish is used interactively. "
23628 "You can enable them even for non-interactive modes using I<--progress-bars>, "
23629 "and you can disable them completely using I<--no-progress-bars>."
23634 #: ../fish/guestfish.pod:967
23635 msgid "GUESTFISH COMMANDS"
23640 #: ../fish/guestfish.pod:969
23642 "The commands in this section are guestfish convenience commands, in other "
23643 "words, they are not part of the L<guestfs(3)> API."
23648 #: ../fish/guestfish.pod:972
23654 #: ../fish/guestfish.pod:974
23664 #: ../fish/guestfish.pod:977
23665 msgid "Without any parameter, this provides general help."
23670 #: ../fish/guestfish.pod:979
23671 msgid "With a C<cmd> parameter, this displays detailed help for that command."
23676 #: ../fish/guestfish.pod:981
23677 msgid "quit | exit"
23682 #: ../fish/guestfish.pod:983
23683 msgid "This exits guestfish. You can also use C<^D> key."
23688 #: ../fish/guestfish.pod:985
23689 msgid "@FISH_COMMANDS@"
23694 #: ../fish/guestfish.pod:987
23700 #: ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:83
23706 #: ../fish/guestfish.pod:993
23708 "guestfish returns 0 if the commands completed without error, or 1 if there "
23714 #: ../fish/guestfish.pod:1000
23720 #: ../fish/guestfish.pod:1002
23722 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23728 #: ../fish/guestfish.pod:1005
23729 msgid "GUESTFISH_PID"
23734 #: ../fish/guestfish.pod:1007
23736 "Used with the I<--remote> option to specify the remote guestfish process to "
23737 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23742 #: ../fish/guestfish.pod:1011
23748 #: ../fish/guestfish.pod:1013
23750 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23751 "not specified, the external L<hexedit(1)> program is used."
23756 #: ../fish/guestfish.pod:1017
23762 #: ../fish/guestfish.pod:1019
23764 "If compiled with GNU readline support, various files in the home directory "
23765 "can be used. See L</FILES>."
23770 #: ../fish/guestfish.pod:1028
23772 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23773 "effect as using the B<-v> option."
23778 #: ../fish/guestfish.pod:1040
23780 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23781 "the discussion of paths in L<guestfs(3)>."
23786 #: ../fish/guestfish.pod:1051
23787 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
23792 #: ../fish/guestfish.pod:1053
23798 #: ../fish/guestfish.pod:1055
23800 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
23806 #: ../fish/guestfish.pod:1071 ../test-tool/libguestfs-test-tool.pod:88
23812 #: ../fish/guestfish.pod:1075
23813 msgid "$HOME/.guestfish"
23818 #: ../fish/guestfish.pod:1077
23820 "If compiled with GNU readline support, then the command history is saved in "
23826 #: ../fish/guestfish.pod:1080
23827 msgid "$HOME/.inputrc"
23832 #: ../fish/guestfish.pod:1082
23833 msgid "/etc/inputrc"
23838 #: ../fish/guestfish.pod:1084
23840 "If compiled with GNU readline support, then these files can be used to "
23841 "configure readline. For further information, please see L<readline(3)/"
23842 "INITIALIZATION FILE>."
23847 #: ../fish/guestfish.pod:1088
23848 msgid "To write rules which only apply to guestfish, use:"
23853 #: ../fish/guestfish.pod:1090
23864 #: ../fish/guestfish.pod:1094
23866 "Variables that you can set in inputrc that change the behaviour of guestfish "
23867 "in useful ways include:"
23872 #: ../fish/guestfish.pod:1099
23873 msgid "completion-ignore-case (default: on)"
23878 #: ../fish/guestfish.pod:1101
23880 "By default, guestfish will ignore case when tab-completing paths on the "
23886 #: ../fish/guestfish.pod:1104
23889 " set completion-ignore-case off\n"
23895 #: ../fish/guestfish.pod:1106
23896 msgid "to make guestfish case sensitive."
23901 #: ../fish/guestfish.pod:1110
23907 #: ../fish/guestfish.pod:1112
23908 msgid "test2.img (etc)"
23913 #: ../fish/guestfish.pod:1114
23915 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
23916 "will be created in the file C<test1.img> in the current directory. The "
23917 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
23918 "the same name will be overwritten."
23922 #: ../fish/guestfish.pod:1123
23924 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
23925 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
23926 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
23927 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
23928 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
23929 ">, L<hexedit(1)>."
23934 #: ../fish/guestfish.pod:1153 ../test-tool/libguestfs-test-tool.pod:124
23935 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:372
23936 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518
23937 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
23938 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
23940 "This program is free software; you can redistribute it and/or modify it "
23941 "under the terms of the GNU General Public License as published by the Free "
23942 "Software Foundation; either version 2 of the License, or (at your option) "
23943 "any later version."
23948 #: ../fish/guestfish.pod:1158 ../test-tool/libguestfs-test-tool.pod:129
23949 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:377
23950 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523
23951 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
23952 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
23954 "This program is distributed in the hope that it will be useful, but WITHOUT "
23955 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
23956 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
23962 #: ../fish/guestfish.pod:1163 ../test-tool/libguestfs-test-tool.pod:134
23963 #: ../fuse/guestmount.pod:268 ../tools/virt-edit.pl:382
23964 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528
23965 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
23966 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
23968 "You should have received a copy of the GNU General Public License along with "
23969 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
23970 "Ave, Cambridge, MA 02139, USA."
23975 #: ../fish/guestfish-actions.pod:1
23981 #: ../fish/guestfish-actions.pod:3
23984 " add-cdrom filename\n"
23990 #: ../fish/guestfish-actions.pod:15
23992 "This call checks for the existence of C<filename>. This stops you from "
23993 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23994 "and C<http:> URLs. To specify those, use the general L</config> call "
24000 #: ../fish/guestfish-actions.pod:22
24002 "If you just want to add an ISO file (often you use this as an efficient way "
24003 "to transfer large files into the guest), then you should probably use L</add-"
24004 "drive-ro> instead."
24009 #: ../fish/guestfish-actions.pod:35
24015 #: ../fish/guestfish-actions.pod:37
24020 #: ../fish/guestfish-actions.pod:39
24023 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24029 #: ../fish/guestfish-actions.pod:41
24031 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24032 "It works by connecting to libvirt, requesting the domain and domain XML from "
24033 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24038 #: ../fish/guestfish-actions.pod:71
24040 "The other optional parameters are passed directly through to L</add-drive-"
24046 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24047 #: ../fish/guestfish-actions.pod:2947
24049 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24054 #: ../fish/guestfish-actions.pod:76
24060 #: ../fish/guestfish-actions.pod:78
24063 " add-drive filename\n"
24069 #: ../fish/guestfish-actions.pod:80
24071 "This function is the equivalent of calling L</add-drive-opts> with no "
24072 "optional parameters, so the disk is added writable, with the format being "
24073 "detected automatically."
24078 #: ../fish/guestfish-actions.pod:84
24080 "Automatic detection of the format opens you up to a potential security hole "
24081 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24082 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24083 "you should think about replacing calls to this function with calls to L</add-"
24084 "drive-opts>, and specifying the format."
24089 #: ../fish/guestfish-actions.pod:91
24090 msgid "add-drive-opts"
24095 #: ../fish/guestfish-actions.pod:93
24101 #: ../fish/guestfish-actions.pod:95
24104 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24110 #: ../fish/guestfish-actions.pod:122
24112 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24113 "add-drive-ro>) then the format is automatically detected. Possible formats "
24114 "include C<raw> and C<qcow2>."
24119 #: ../fish/guestfish-actions.pod:133
24121 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24122 "add-drive-with-if> call (q.v.)"
24127 #: ../fish/guestfish-actions.pod:140
24128 msgid "add-drive-ro"
24133 #: ../fish/guestfish-actions.pod:142
24139 #: ../fish/guestfish-actions.pod:144
24142 " add-drive-ro filename\n"
24148 #: ../fish/guestfish-actions.pod:146
24150 "This function is the equivalent of calling L</add-drive-opts> with the "
24151 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24152 "is added read-only, with the format being detected automatically."
24157 #: ../fish/guestfish-actions.pod:151
24158 msgid "add-drive-ro-with-if"
24163 #: ../fish/guestfish-actions.pod:153
24166 " add-drive-ro-with-if filename iface\n"
24172 #: ../fish/guestfish-actions.pod:155
24174 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24175 "interface emulation to use at run time."
24180 #: ../fish/guestfish-actions.pod:165
24181 msgid "add-drive-with-if"
24186 #: ../fish/guestfish-actions.pod:167
24189 " add-drive-with-if filename iface\n"
24195 #: ../fish/guestfish-actions.pod:169
24197 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24198 "interface emulation to use at run time."
24203 #: ../fish/guestfish-actions.pod:179
24209 #: ../fish/guestfish-actions.pod:181
24212 " aug-clear augpath\n"
24218 #: ../fish/guestfish-actions.pod:186
24224 #: ../fish/guestfish-actions.pod:188
24233 #: ../fish/guestfish-actions.pod:190
24235 "Close the current Augeas handle and free up any resources used by it. After "
24236 "calling this, you have to call L</aug-init> again before you can use any "
24237 "other Augeas functions."
24242 #: ../fish/guestfish-actions.pod:195
24243 msgid "aug-defnode"
24248 #: ../fish/guestfish-actions.pod:197
24251 " aug-defnode name expr val\n"
24257 #: ../fish/guestfish-actions.pod:202
24259 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24260 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24261 "containing that single node."
24266 #: ../fish/guestfish-actions.pod:210
24272 #: ../fish/guestfish-actions.pod:212
24275 " aug-defvar name expr\n"
24281 #: ../fish/guestfish-actions.pod:221
24287 #: ../fish/guestfish-actions.pod:223
24290 " aug-get augpath\n"
24296 #: ../fish/guestfish-actions.pod:228
24302 #: ../fish/guestfish-actions.pod:230
24305 " aug-init root flags\n"
24311 #: ../fish/guestfish-actions.pod:236
24312 msgid "You must call this before using any other L</aug-*> commands."
24317 #: ../fish/guestfish-actions.pod:271
24318 msgid "Do not load the tree in L</aug-init>."
24323 #: ../fish/guestfish-actions.pod:275
24324 msgid "To close the handle, you can call L</aug-close>."
24329 #: ../fish/guestfish-actions.pod:279
24335 #: ../fish/guestfish-actions.pod:281
24338 " aug-insert augpath label true|false\n"
24344 #: ../fish/guestfish-actions.pod:291
24350 #: ../fish/guestfish-actions.pod:293
24359 #: ../fish/guestfish-actions.pod:300
24365 #: ../fish/guestfish-actions.pod:302
24368 " aug-ls augpath\n"
24374 #: ../fish/guestfish-actions.pod:304
24376 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24377 "resulting nodes into alphabetical order."
24382 #: ../fish/guestfish-actions.pod:307
24388 #: ../fish/guestfish-actions.pod:309
24391 " aug-match augpath\n"
24397 #: ../fish/guestfish-actions.pod:315
24403 #: ../fish/guestfish-actions.pod:317
24406 " aug-mv src dest\n"
24412 #: ../fish/guestfish-actions.pod:322
24418 #: ../fish/guestfish-actions.pod:324
24421 " aug-rm augpath\n"
24427 #: ../fish/guestfish-actions.pod:330
24433 #: ../fish/guestfish-actions.pod:332
24442 #: ../fish/guestfish-actions.pod:336
24444 "The flags which were passed to L</aug-init> affect exactly how files are "
24450 #: ../fish/guestfish-actions.pod:339
24456 #: ../fish/guestfish-actions.pod:341
24459 " aug-set augpath val\n"
24465 #: ../fish/guestfish-actions.pod:345
24467 "In the Augeas API, it is possible to clear a node by setting the value to "
24468 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24469 "this call. Instead you must use the L</aug-clear> call."
24474 #: ../fish/guestfish-actions.pod:350
24480 #: ../fish/guestfish-actions.pod:352
24483 " available 'groups ...'\n"
24489 #: ../fish/guestfish-actions.pod:358
24491 "The libguestfs groups, and the functions that those groups correspond to, "
24492 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24493 "runtime by calling L</available-all-groups>."
24498 #: ../fish/guestfish-actions.pod:382
24499 msgid "You must call L</launch> before calling this function."
24504 #: ../fish/guestfish-actions.pod:404
24506 "This call was added in version C<1.0.80>. In previous versions of "
24507 "libguestfs all you could do would be to speculatively execute a command to "
24508 "find out if the daemon implemented it. See also L</version>."
24513 #: ../fish/guestfish-actions.pod:411
24514 msgid "available-all-groups"
24519 #: ../fish/guestfish-actions.pod:413
24522 " available-all-groups\n"
24528 #: ../fish/guestfish-actions.pod:415
24530 "This command returns a list of all optional groups that this daemon knows "
24531 "about. Note this returns both supported and unsupported groups. To find "
24532 "out which ones the daemon can actually support you have to call L</"
24533 "available> on each member of the returned list."
24538 #: ../fish/guestfish-actions.pod:421
24539 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24544 #: ../fish/guestfish-actions.pod:423
24550 #: ../fish/guestfish-actions.pod:425
24553 " base64-in (base64file|-) filename\n"
24559 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24560 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24561 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24562 #: ../fish/guestfish-actions.pod:4345 ../fish/guestfish-actions.pod:4357
24563 #: ../fish/guestfish-actions.pod:4368 ../fish/guestfish-actions.pod:4379
24564 #: ../fish/guestfish-actions.pod:4431 ../fish/guestfish-actions.pod:4440
24565 #: ../fish/guestfish-actions.pod:4494 ../fish/guestfish-actions.pod:4517
24566 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24571 #: ../fish/guestfish-actions.pod:432
24577 #: ../fish/guestfish-actions.pod:434
24580 " base64-out filename (base64file|-)\n"
24586 #: ../fish/guestfish-actions.pod:441
24587 msgid "blockdev-flushbufs"
24592 #: ../fish/guestfish-actions.pod:443
24595 " blockdev-flushbufs device\n"
24601 #: ../fish/guestfish-actions.pod:450
24602 msgid "blockdev-getbsz"
24607 #: ../fish/guestfish-actions.pod:452
24610 " blockdev-getbsz device\n"
24616 #: ../fish/guestfish-actions.pod:461
24617 msgid "blockdev-getro"
24622 #: ../fish/guestfish-actions.pod:463
24625 " blockdev-getro device\n"
24631 #: ../fish/guestfish-actions.pod:470
24632 msgid "blockdev-getsize64"
24637 #: ../fish/guestfish-actions.pod:472
24640 " blockdev-getsize64 device\n"
24646 #: ../fish/guestfish-actions.pod:476
24647 msgid "See also L</blockdev-getsz>."
24652 #: ../fish/guestfish-actions.pod:480
24653 msgid "blockdev-getss"
24658 #: ../fish/guestfish-actions.pod:482
24661 " blockdev-getss device\n"
24667 #: ../fish/guestfish-actions.pod:487
24669 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
24674 #: ../fish/guestfish-actions.pod:492
24675 msgid "blockdev-getsz"
24680 #: ../fish/guestfish-actions.pod:494
24683 " blockdev-getsz device\n"
24689 #: ../fish/guestfish-actions.pod:499
24691 "See also L</blockdev-getss> for the real sector size of the device, and L</"
24692 "blockdev-getsize64> for the more useful I<size in bytes>."
24697 #: ../fish/guestfish-actions.pod:505
24698 msgid "blockdev-rereadpt"
24703 #: ../fish/guestfish-actions.pod:507
24706 " blockdev-rereadpt device\n"
24712 #: ../fish/guestfish-actions.pod:513
24713 msgid "blockdev-setbsz"
24718 #: ../fish/guestfish-actions.pod:515
24721 " blockdev-setbsz device blocksize\n"
24727 #: ../fish/guestfish-actions.pod:524
24728 msgid "blockdev-setro"
24733 #: ../fish/guestfish-actions.pod:526
24736 " blockdev-setro device\n"
24742 #: ../fish/guestfish-actions.pod:532
24743 msgid "blockdev-setrw"
24748 #: ../fish/guestfish-actions.pod:534
24751 " blockdev-setrw device\n"
24757 #: ../fish/guestfish-actions.pod:540
24758 msgid "case-sensitive-path"
24763 #: ../fish/guestfish-actions.pod:542
24766 " case-sensitive-path path\n"
24772 #: ../fish/guestfish-actions.pod:566
24774 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
24775 "WINDOWS/system32\"> (the exact return value would depend on details of how "
24776 "the directories were originally created under Windows)."
24781 #: ../fish/guestfish-actions.pod:574
24782 msgid "See also L</realpath>."
24787 #: ../fish/guestfish-actions.pod:576
24793 #: ../fish/guestfish-actions.pod:578
24802 #: ../fish/guestfish-actions.pod:582
24804 "Note that this function cannot correctly handle binary files (specifically, "
24805 "files containing C<\\0> character which is treated as end of string). For "
24806 "those you need to use the L</read-file> or L</download> functions which have "
24807 "a more complex interface."
24812 #: ../fish/guestfish-actions.pod:590
24818 #: ../fish/guestfish-actions.pod:592
24821 " checksum csumtype path\n"
24827 #: ../fish/guestfish-actions.pod:635
24828 msgid "To get the checksum for a device, use L</checksum-device>."
24833 #: ../fish/guestfish-actions.pod:637
24834 msgid "To get the checksums for many files, use L</checksums-out>."
24839 #: ../fish/guestfish-actions.pod:639
24840 msgid "checksum-device"
24845 #: ../fish/guestfish-actions.pod:641
24848 " checksum-device csumtype device\n"
24854 #: ../fish/guestfish-actions.pod:643
24856 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
24857 "device named C<device>. For the types of checksums supported see the L</"
24858 "checksum> command."
24863 #: ../fish/guestfish-actions.pod:647
24864 msgid "checksums-out"
24869 #: ../fish/guestfish-actions.pod:649
24872 " checksums-out csumtype directory (sumsfile|-)\n"
24878 #: ../fish/guestfish-actions.pod:665
24884 #: ../fish/guestfish-actions.pod:667
24887 " chmod mode path\n"
24893 #: ../fish/guestfish-actions.pod:678
24899 #: ../fish/guestfish-actions.pod:680
24902 " chown owner group path\n"
24908 #: ../fish/guestfish-actions.pod:688
24914 #: ../fish/guestfish-actions.pod:690
24917 " command 'arguments ...'\n"
24923 #: ../fish/guestfish-actions.pod:697
24925 "The single parameter is an argv-style list of arguments. The first element "
24926 "is the name of the program to run. Subsequent elements are parameters. The "
24927 "list must be non-empty (ie. must contain a program name). Note that the "
24928 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
24933 #: ../fish/guestfish-actions.pod:725
24934 msgid "command-lines"
24939 #: ../fish/guestfish-actions.pod:727
24942 " command-lines 'arguments ...'\n"
24948 #: ../fish/guestfish-actions.pod:729
24950 "This is the same as L</command>, but splits the result into a list of lines."
24955 #: ../fish/guestfish-actions.pod:732
24956 msgid "See also: L</sh-lines>"
24961 #: ../fish/guestfish-actions.pod:737
24967 #: ../fish/guestfish-actions.pod:739
24970 " config qemuparam qemuvalue\n"
24976 #: ../fish/guestfish-actions.pod:750
24982 #: ../fish/guestfish-actions.pod:752
24985 " copy-size src dest size\n"
24991 #: ../fish/guestfish-actions.pod:760
24997 #: ../fish/guestfish-actions.pod:762
25006 #: ../fish/guestfish-actions.pod:767
25012 #: ../fish/guestfish-actions.pod:769
25021 #: ../fish/guestfish-actions.pod:774
25027 #: ../fish/guestfish-actions.pod:776
25036 #: ../fish/guestfish-actions.pod:783
25038 "If the destination is a device, it must be as large or larger than the "
25039 "source file or device, otherwise the copy will fail. This command cannot do "
25040 "partial copies (see L</copy-size>)."
25045 #: ../fish/guestfish-actions.pod:787
25051 #: ../fish/guestfish-actions.pod:789
25060 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25062 "This command is mostly useful for interactive sessions. It is I<not> "
25063 "intended that you try to parse the output string. Use L</statvfs> from "
25069 #: ../fish/guestfish-actions.pod:797
25075 #: ../fish/guestfish-actions.pod:799
25084 #: ../fish/guestfish-actions.pod:808
25090 #: ../fish/guestfish-actions.pod:810
25099 #: ../fish/guestfish-actions.pod:816
25101 "Another way to get the same information is to enable verbose messages with "
25102 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25103 "before running the program."
25108 #: ../fish/guestfish-actions.pod:821
25114 #: ../fish/guestfish-actions.pod:823
25117 " download remotefilename (filename|-)\n"
25123 #: ../fish/guestfish-actions.pod:830
25124 msgid "See also L</upload>, L</cat>."
25129 #: ../fish/guestfish-actions.pod:834
25130 msgid "download-offset"
25135 #: ../fish/guestfish-actions.pod:836
25138 " download-offset remotefilename (filename|-) offset size\n"
25144 #: ../fish/guestfish-actions.pod:844
25146 "Note that there is no limit on the amount of data that can be downloaded "
25147 "with this call, unlike with L</pread>, and this call always reads the full "
25148 "amount unless an error occurs."
25153 #: ../fish/guestfish-actions.pod:849
25154 msgid "See also L</download>, L</pread>."
25159 #: ../fish/guestfish-actions.pod:853
25160 msgid "drop-caches"
25165 #: ../fish/guestfish-actions.pod:855
25168 " drop-caches whattodrop\n"
25174 #: ../fish/guestfish-actions.pod:867
25180 #: ../fish/guestfish-actions.pod:869
25189 #: ../fish/guestfish-actions.pod:881
25195 #: ../fish/guestfish-actions.pod:883
25198 " e2fsck-f device\n"
25204 #: ../fish/guestfish-actions.pod:889
25206 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25207 "should use L</fsck>."
25212 #: ../fish/guestfish-actions.pod:892
25213 msgid "echo-daemon"
25218 #: ../fish/guestfish-actions.pod:894
25221 " echo-daemon 'words ...'\n"
25227 #: ../fish/guestfish-actions.pod:901
25228 msgid "See also L</ping-daemon>."
25233 #: ../fish/guestfish-actions.pod:903
25239 #: ../fish/guestfish-actions.pod:905
25242 " egrep regex path\n"
25248 #: ../fish/guestfish-actions.pod:913
25254 #: ../fish/guestfish-actions.pod:915
25257 " egrepi regex path\n"
25263 #: ../fish/guestfish-actions.pod:923
25269 #: ../fish/guestfish-actions.pod:925
25272 " equal file1 file2\n"
25278 #: ../fish/guestfish-actions.pod:932
25284 #: ../fish/guestfish-actions.pod:934
25293 #: ../fish/guestfish-actions.pod:939
25294 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25299 #: ../fish/guestfish-actions.pod:941
25305 #: ../fish/guestfish-actions.pod:943
25308 " fallocate path len\n"
25314 #: ../fish/guestfish-actions.pod:960
25315 msgid "fallocate64"
25320 #: ../fish/guestfish-actions.pod:962
25323 " fallocate64 path len\n"
25329 #: ../fish/guestfish-actions.pod:968
25331 "Note that this call allocates disk blocks for the file. To create a sparse "
25332 "file use L</truncate-size> instead."
25337 #: ../fish/guestfish-actions.pod:971
25339 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25340 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25341 "maximum size of files created through that call to 1GB."
25346 #: ../fish/guestfish-actions.pod:980
25352 #: ../fish/guestfish-actions.pod:982
25355 " fgrep pattern path\n"
25361 #: ../fish/guestfish-actions.pod:990
25367 #: ../fish/guestfish-actions.pod:992
25370 " fgrepi pattern path\n"
25376 #: ../fish/guestfish-actions.pod:1000
25382 #: ../fish/guestfish-actions.pod:1002
25391 #: ../fish/guestfish-actions.pod:1014
25393 "This command can also be used on C</dev/> devices (and partitions, LV "
25394 "names). You can for example use this to determine if a device contains a "
25395 "filesystem, although it's usually better to use L</vfs-type>."
25400 #: ../fish/guestfish-actions.pod:1024
25401 msgid "file-architecture"
25406 #: ../fish/guestfish-actions.pod:1026
25409 " file-architecture filename\n"
25415 #: ../fish/guestfish-actions.pod:1129
25421 #: ../fish/guestfish-actions.pod:1131
25430 #: ../fish/guestfish-actions.pod:1135
25432 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25433 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25438 #: ../fish/guestfish-actions.pod:1139
25444 #: ../fish/guestfish-actions.pod:1141
25447 " fill c len path\n"
25453 #: ../fish/guestfish-actions.pod:1147
25455 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25456 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25457 "L</fill-pattern>."
25462 #: ../fish/guestfish-actions.pod:1152
25463 msgid "fill-pattern"
25468 #: ../fish/guestfish-actions.pod:1154
25471 " fill-pattern pattern len path\n"
25477 #: ../fish/guestfish-actions.pod:1156
25479 "This function is like L</fill> except that it creates a new file of length "
25480 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25481 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25487 #: ../fish/guestfish-actions.pod:1161
25493 #: ../fish/guestfish-actions.pod:1163
25496 " find directory\n"
25502 #: ../fish/guestfish-actions.pod:1177
25503 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25508 #: ../fish/guestfish-actions.pod:1190
25509 msgid "See also L</find0>."
25514 #: ../fish/guestfish-actions.pod:1195
25520 #: ../fish/guestfish-actions.pod:1197
25523 " find0 directory (files|-)\n"
25529 #: ../fish/guestfish-actions.pod:1203
25531 "This command works the same way as L</find> with the following exceptions:"
25536 #: ../fish/guestfish-actions.pod:1230
25537 msgid "findfs-label"
25542 #: ../fish/guestfish-actions.pod:1232
25545 " findfs-label label\n"
25551 #: ../fish/guestfish-actions.pod:1238
25552 msgid "To find the label of a filesystem, use L</vfs-label>."
25557 #: ../fish/guestfish-actions.pod:1240
25558 msgid "findfs-uuid"
25563 #: ../fish/guestfish-actions.pod:1242
25566 " findfs-uuid uuid\n"
25572 #: ../fish/guestfish-actions.pod:1248
25573 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25578 #: ../fish/guestfish-actions.pod:1250
25584 #: ../fish/guestfish-actions.pod:1252
25587 " fsck fstype device\n"
25593 #: ../fish/guestfish-actions.pod:1282
25599 #: ../fish/guestfish-actions.pod:1284
25607 #: ../fish/guestfish-actions.pod:1291
25608 msgid "get-attach-method"
25612 #: ../fish/guestfish-actions.pod:1293
25615 " get-attach-method\n"
25620 #: ../fish/guestfish-actions.pod:1295
25621 msgid "Return the current attach method. See L</set-attach-method>."
25626 #: ../fish/guestfish-actions.pod:1297
25627 msgid "get-autosync"
25632 #: ../fish/guestfish-actions.pod:1299
25641 #: ../fish/guestfish-actions.pod:1303
25647 #: ../fish/guestfish-actions.pod:1305
25656 #: ../fish/guestfish-actions.pod:1309
25657 msgid "get-e2label"
25662 #: ../fish/guestfish-actions.pod:1311
25665 " get-e2label device\n"
25671 #: ../fish/guestfish-actions.pod:1323
25677 #: ../fish/guestfish-actions.pod:1325
25680 " get-e2uuid device\n"
25686 #: ../fish/guestfish-actions.pod:1337
25687 msgid "get-memsize"
25692 #: ../fish/guestfish-actions.pod:1339
25701 #: ../fish/guestfish-actions.pod:1344
25703 "If L</set-memsize> was not called on this handle, and if "
25704 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
25705 "value for memsize."
25710 #: ../fish/guestfish-actions.pod:1351
25711 msgid "get-network"
25716 #: ../fish/guestfish-actions.pod:1353
25725 #: ../fish/guestfish-actions.pod:1357
25731 #: ../fish/guestfish-actions.pod:1359
25740 #: ../fish/guestfish-actions.pod:1366
25746 #: ../fish/guestfish-actions.pod:1368
25752 #: ../fish/guestfish-actions.pod:1370
25761 #: ../fish/guestfish-actions.pod:1377
25767 #: ../fish/guestfish-actions.pod:1379
25776 #: ../fish/guestfish-actions.pod:1386
25777 msgid "get-recovery-proc"
25782 #: ../fish/guestfish-actions.pod:1388
25785 " get-recovery-proc\n"
25791 #: ../fish/guestfish-actions.pod:1392
25792 msgid "get-selinux"
25797 #: ../fish/guestfish-actions.pod:1394
25806 #: ../fish/guestfish-actions.pod:1396
25808 "This returns the current setting of the selinux flag which is passed to the "
25809 "appliance at boot time. See L</set-selinux>."
25814 #: ../fish/guestfish-actions.pod:1402
25820 #: ../fish/guestfish-actions.pod:1404
25829 #: ../fish/guestfish-actions.pod:1411
25835 #: ../fish/guestfish-actions.pod:1413
25844 #: ../fish/guestfish-actions.pod:1417
25850 #: ../fish/guestfish-actions.pod:1419
25859 #: ../fish/guestfish-actions.pod:1421
25861 "Return the current umask. By default the umask is C<022> unless it has been "
25862 "set by calling L</umask>."
25867 #: ../fish/guestfish-actions.pod:1424
25868 msgid "get-verbose"
25873 #: ../fish/guestfish-actions.pod:1426
25882 #: ../fish/guestfish-actions.pod:1430
25888 #: ../fish/guestfish-actions.pod:1432
25897 #: ../fish/guestfish-actions.pod:1436
25898 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
25903 #: ../fish/guestfish-actions.pod:1439
25909 #: ../fish/guestfish-actions.pod:1441
25912 " getxattr path name\n"
25918 #: ../fish/guestfish-actions.pod:1443
25920 "Get a single extended attribute from file C<path> named C<name>. This call "
25921 "follows symlinks. If you want to lookup an extended attribute for the "
25922 "symlink itself, use L</lgetxattr>."
25927 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2353
25929 "Normally it is better to get all extended attributes from a file in one go "
25930 "by calling L</getxattrs>. However some Linux filesystem implementations are "
25931 "buggy and do not provide a way to list out attributes. For these "
25932 "filesystems (notably ntfs-3g) you have to know the names of the extended "
25933 "attributes you want in advance and call this function."
25938 #: ../fish/guestfish-actions.pod:1457
25939 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
25944 #: ../fish/guestfish-actions.pod:1459
25950 #: ../fish/guestfish-actions.pod:1461
25953 " getxattrs path\n"
25959 #: ../fish/guestfish-actions.pod:1469
25960 msgid "See also: L</lgetxattrs>, L<attr(5)>."
25965 #: ../fish/guestfish-actions.pod:1471
25966 msgid "glob-expand"
25971 #: ../fish/guestfish-actions.pod:1473
25974 " glob-expand pattern\n"
25980 #: ../fish/guestfish-actions.pod:1486
25986 #: ../fish/guestfish-actions.pod:1488
25989 " grep regex path\n"
25995 #: ../fish/guestfish-actions.pod:1496
26001 #: ../fish/guestfish-actions.pod:1498
26004 " grepi regex path\n"
26010 #: ../fish/guestfish-actions.pod:1506
26011 msgid "grub-install"
26016 #: ../fish/guestfish-actions.pod:1508
26019 " grub-install root device\n"
26025 #: ../fish/guestfish-actions.pod:1524
26031 #: ../fish/guestfish-actions.pod:1526
26040 #: ../fish/guestfish-actions.pod:1534
26046 #: ../fish/guestfish-actions.pod:1536
26049 " head-n nrlines path\n"
26055 #: ../fish/guestfish-actions.pod:1549
26061 #: ../fish/guestfish-actions.pod:1551
26070 #: ../fish/guestfish-actions.pod:1559
26076 #: ../fish/guestfish-actions.pod:1561
26079 " initrd-cat initrdpath filename\n"
26085 #: ../fish/guestfish-actions.pod:1573
26086 msgid "See also L</initrd-list>."
26091 #: ../fish/guestfish-actions.pod:1578
26092 msgid "initrd-list"
26097 #: ../fish/guestfish-actions.pod:1580
26100 " initrd-list path\n"
26106 #: ../fish/guestfish-actions.pod:1592
26107 msgid "inotify-add-watch"
26112 #: ../fish/guestfish-actions.pod:1594
26115 " inotify-add-watch path mask\n"
26121 #: ../fish/guestfish-actions.pod:1606
26122 msgid "inotify-close"
26127 #: ../fish/guestfish-actions.pod:1608
26136 #: ../fish/guestfish-actions.pod:1614
26137 msgid "inotify-files"
26142 #: ../fish/guestfish-actions.pod:1616
26151 #: ../fish/guestfish-actions.pod:1618
26153 "This function is a helpful wrapper around L</inotify-read> which just "
26154 "returns a list of pathnames of objects that were touched. The returned "
26155 "pathnames are sorted and deduplicated."
26160 #: ../fish/guestfish-actions.pod:1622
26161 msgid "inotify-init"
26166 #: ../fish/guestfish-actions.pod:1624
26169 " inotify-init maxevents\n"
26175 #: ../fish/guestfish-actions.pod:1630
26177 "C<maxevents> is the maximum number of events which will be queued up between "
26178 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26179 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26180 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26181 "but records the fact that it threw them away by setting a flag "
26182 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26187 #: ../fish/guestfish-actions.pod:1640
26189 "Before any events are generated, you have to add some watches to the "
26190 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26191 "L</inotify-watch-all>."
26196 #: ../fish/guestfish-actions.pod:1646
26198 "Queued up events should be read periodically by calling L</inotify-read> (or "
26199 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26200 "If you don't read the events out often enough then you risk the internal "
26201 "queue overflowing."
26206 #: ../fish/guestfish-actions.pod:1653
26208 "The handle should be closed after use by calling L</inotify-close>. This "
26209 "also removes any watches automatically."
26214 #: ../fish/guestfish-actions.pod:1662
26215 msgid "inotify-read"
26220 #: ../fish/guestfish-actions.pod:1664
26229 #: ../fish/guestfish-actions.pod:1677
26230 msgid "inotify-rm-watch"
26235 #: ../fish/guestfish-actions.pod:1679
26238 " inotify-rm-watch wd\n"
26244 #: ../fish/guestfish-actions.pod:1681
26245 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26250 #: ../fish/guestfish-actions.pod:1684
26251 msgid "inspect-get-arch"
26256 #: ../fish/guestfish-actions.pod:1686
26259 " inspect-get-arch root\n"
26265 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26266 #: ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1796
26267 #: ../fish/guestfish-actions.pod:1830 ../fish/guestfish-actions.pod:1845
26268 #: ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:1881
26269 #: ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1930
26270 #: ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1984
26271 #: ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2035
26272 #: ../fish/guestfish-actions.pod:2048 ../fish/guestfish-actions.pod:2061
26273 #: ../fish/guestfish-actions.pod:2076
26275 "This function should only be called with a root device string as returned by "
26281 #: ../fish/guestfish-actions.pod:1691
26283 "This returns the architecture of the inspected operating system. The "
26284 "possible return values are listed under L</file-architecture>."
26289 #: ../fish/guestfish-actions.pod:1700
26290 msgid "inspect-get-distro"
26295 #: ../fish/guestfish-actions.pod:1702
26298 " inspect-get-distro root\n"
26304 #: ../fish/guestfish-actions.pod:1774
26305 msgid "inspect-get-filesystems"
26310 #: ../fish/guestfish-actions.pod:1776
26313 " inspect-get-filesystems root\n"
26319 #: ../fish/guestfish-actions.pod:1789
26321 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26322 "get-mountpoints>."
26326 #: ../fish/guestfish-actions.pod:1792
26327 msgid "inspect-get-format"
26331 #: ../fish/guestfish-actions.pod:1794
26334 " inspect-get-format root\n"
26340 #: ../fish/guestfish-actions.pod:1826
26341 msgid "inspect-get-hostname"
26346 #: ../fish/guestfish-actions.pod:1828
26349 " inspect-get-hostname root\n"
26355 #: ../fish/guestfish-actions.pod:1841
26356 msgid "inspect-get-major-version"
26361 #: ../fish/guestfish-actions.pod:1843
26364 " inspect-get-major-version root\n"
26370 #: ../fish/guestfish-actions.pod:1862
26371 msgid "inspect-get-minor-version"
26376 #: ../fish/guestfish-actions.pod:1864
26379 " inspect-get-minor-version root\n"
26385 #: ../fish/guestfish-actions.pod:1874
26387 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26388 "get-major-version>."
26393 #: ../fish/guestfish-actions.pod:1877
26394 msgid "inspect-get-mountpoints"
26399 #: ../fish/guestfish-actions.pod:1879
26402 " inspect-get-mountpoints root\n"
26408 #: ../fish/guestfish-actions.pod:1901
26410 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26411 "get-filesystems>."
26416 #: ../fish/guestfish-actions.pod:1904
26417 msgid "inspect-get-package-format"
26422 #: ../fish/guestfish-actions.pod:1906
26425 " inspect-get-package-format root\n"
26431 #: ../fish/guestfish-actions.pod:1911
26433 "This function and L</inspect-get-package-management> return the package "
26434 "format and package management tool used by the inspected operating system. "
26435 "For example for Fedora these functions would return C<rpm> (package format) "
26436 "and C<yum> (package management)."
26441 #: ../fish/guestfish-actions.pod:1926
26442 msgid "inspect-get-package-management"
26447 #: ../fish/guestfish-actions.pod:1928
26450 " inspect-get-package-management root\n"
26456 #: ../fish/guestfish-actions.pod:1933
26458 "L</inspect-get-package-format> and this function return the package format "
26459 "and package management tool used by the inspected operating system. For "
26460 "example for Fedora these functions would return C<rpm> (package format) and "
26461 "C<yum> (package management)."
26466 #: ../fish/guestfish-actions.pod:1950
26467 msgid "inspect-get-product-name"
26472 #: ../fish/guestfish-actions.pod:1952
26475 " inspect-get-product-name root\n"
26481 #: ../fish/guestfish-actions.pod:1967
26482 msgid "inspect-get-roots"
26487 #: ../fish/guestfish-actions.pod:1969
26490 " inspect-get-roots\n"
26496 #: ../fish/guestfish-actions.pod:1971
26498 "This function is a convenient way to get the list of root devices, as "
26499 "returned from a previous call to L</inspect-os>, but without redoing the "
26500 "whole inspection process."
26505 #: ../fish/guestfish-actions.pod:1975
26507 "This returns an empty list if either no root devices were found or the "
26508 "caller has not called L</inspect-os>."
26513 #: ../fish/guestfish-actions.pod:1980
26514 msgid "inspect-get-type"
26519 #: ../fish/guestfish-actions.pod:1982
26522 " inspect-get-type root\n"
26528 #: ../fish/guestfish-actions.pod:2015
26529 msgid "inspect-get-windows-systemroot"
26534 #: ../fish/guestfish-actions.pod:2017
26537 " inspect-get-windows-systemroot root\n"
26542 #: ../fish/guestfish-actions.pod:2031
26543 msgid "inspect-is-live"
26547 #: ../fish/guestfish-actions.pod:2033
26550 " inspect-is-live root\n"
26555 #: ../fish/guestfish-actions.pod:2038
26557 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26558 "then this returns true if a live image was detected on the disk."
26562 #: ../fish/guestfish-actions.pod:2044
26563 msgid "inspect-is-multipart"
26567 #: ../fish/guestfish-actions.pod:2046
26570 " inspect-is-multipart root\n"
26575 #: ../fish/guestfish-actions.pod:2051
26577 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26578 "then this returns true if the disk is part of a set."
26582 #: ../fish/guestfish-actions.pod:2057
26583 msgid "inspect-is-netinst"
26587 #: ../fish/guestfish-actions.pod:2059
26590 " inspect-is-netinst root\n"
26595 #: ../fish/guestfish-actions.pod:2064
26597 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26598 "then this returns true if the disk is a network installer, ie. not a self-"
26599 "contained install CD but one which is likely to require network access to "
26600 "complete the install."
26605 #: ../fish/guestfish-actions.pod:2072
26606 msgid "inspect-list-applications"
26611 #: ../fish/guestfish-actions.pod:2074
26614 " inspect-list-applications root\n"
26620 #: ../fish/guestfish-actions.pod:2081
26622 "I<Note:> This call works differently from other parts of the inspection "
26623 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
26624 "then mount up the disks, before calling this. Listing applications is a "
26625 "significantly more difficult operation which requires access to the full "
26626 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
26627 "are just returning data cached in the libguestfs handle, this call actually "
26628 "reads parts of the mounted filesystems during the call."
26633 #: ../fish/guestfish-actions.pod:2171
26639 #: ../fish/guestfish-actions.pod:2173
26648 #: ../fish/guestfish-actions.pod:2188
26650 "You can pass the root string(s) returned to other L</inspect-get-*> "
26651 "functions in order to query further information about each operating system, "
26652 "such as the name and version."
26657 #: ../fish/guestfish-actions.pod:2193
26659 "This function uses other libguestfs features such as L</mount-ro> and L</"
26660 "umount-all> in order to mount and unmount filesystems and look at the "
26661 "contents. This should be called with no disks currently mounted. The "
26662 "function may also use Augeas, so any existing Augeas handle will be closed."
26667 #: ../fish/guestfish-actions.pod:2205 ../fish/guestfish-actions.pod:2381
26668 #: ../fish/guestfish-actions.pod:2427
26669 msgid "See also L</list-filesystems>."
26674 #: ../fish/guestfish-actions.pod:2207
26675 msgid "is-blockdev"
26680 #: ../fish/guestfish-actions.pod:2209
26683 " is-blockdev path\n"
26689 #: ../fish/guestfish-actions.pod:2214 ../fish/guestfish-actions.pod:2232
26690 #: ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2260
26691 #: ../fish/guestfish-actions.pod:2270 ../fish/guestfish-actions.pod:2304
26692 #: ../fish/guestfish-actions.pod:2313
26693 msgid "See also L</stat>."
26698 #: ../fish/guestfish-actions.pod:2216
26704 #: ../fish/guestfish-actions.pod:2218
26713 #: ../fish/guestfish-actions.pod:2225
26719 #: ../fish/guestfish-actions.pod:2227
26722 " is-chardev path\n"
26728 #: ../fish/guestfish-actions.pod:2234
26734 #: ../fish/guestfish-actions.pod:2236
26743 #: ../fish/guestfish-actions.pod:2243
26749 #: ../fish/guestfish-actions.pod:2245
26758 #: ../fish/guestfish-actions.pod:2253
26764 #: ../fish/guestfish-actions.pod:2255
26773 #: ../fish/guestfish-actions.pod:2262
26779 #: ../fish/guestfish-actions.pod:2264
26788 #: ../fish/guestfish-actions.pod:2272
26789 msgid "is-launching"
26794 #: ../fish/guestfish-actions.pod:2274
26803 #: ../fish/guestfish-actions.pod:2281
26809 #: ../fish/guestfish-actions.pod:2283
26818 #: ../fish/guestfish-actions.pod:2288
26824 #: ../fish/guestfish-actions.pod:2290
26833 #: ../fish/guestfish-actions.pod:2297
26839 #: ../fish/guestfish-actions.pod:2299
26842 " is-socket path\n"
26848 #: ../fish/guestfish-actions.pod:2306
26854 #: ../fish/guestfish-actions.pod:2308
26857 " is-symlink path\n"
26863 #: ../fish/guestfish-actions.pod:2315
26864 msgid "kill-subprocess"
26869 #: ../fish/guestfish-actions.pod:2317
26872 " kill-subprocess\n"
26878 #: ../fish/guestfish-actions.pod:2321
26884 #: ../fish/guestfish-actions.pod:2323
26890 #: ../fish/guestfish-actions.pod:2325
26899 #: ../fish/guestfish-actions.pod:2333
26905 #: ../fish/guestfish-actions.pod:2335
26908 " lchown owner group path\n"
26914 #: ../fish/guestfish-actions.pod:2337
26916 "Change the file owner to C<owner> and group to C<group>. This is like L</"
26917 "chown> but if C<path> is a symlink then the link itself is changed, not the "
26923 #: ../fish/guestfish-actions.pod:2345
26929 #: ../fish/guestfish-actions.pod:2347
26932 " lgetxattr path name\n"
26938 #: ../fish/guestfish-actions.pod:2363
26939 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
26944 #: ../fish/guestfish-actions.pod:2365
26950 #: ../fish/guestfish-actions.pod:2367
26953 " lgetxattrs path\n"
26959 #: ../fish/guestfish-actions.pod:2369
26961 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
26962 "it returns the extended attributes of the link itself."
26967 #: ../fish/guestfish-actions.pod:2373
26968 msgid "list-devices"
26973 #: ../fish/guestfish-actions.pod:2375
26982 #: ../fish/guestfish-actions.pod:2383
26983 msgid "list-filesystems"
26988 #: ../fish/guestfish-actions.pod:2385
26991 " list-filesystems\n"
26997 #: ../fish/guestfish-actions.pod:2404
26999 "This command runs other libguestfs commands, which might include L</mount> "
27000 "and L</umount>, and therefore you should use this soon after launch and only "
27001 "when nothing is mounted."
27006 #: ../fish/guestfish-actions.pod:2408
27008 "Not all of the filesystems returned will be mountable. In particular, swap "
27009 "partitions are returned in the list. Also this command does not check that "
27010 "each filesystem found is valid and mountable, and some filesystems might be "
27011 "mountable but require special options. Filesystems may not all belong to a "
27012 "single logical operating system (use L</inspect-os> to look for OSes)."
27017 #: ../fish/guestfish-actions.pod:2416
27018 msgid "list-partitions"
27023 #: ../fish/guestfish-actions.pod:2418
27026 " list-partitions\n"
27032 #: ../fish/guestfish-actions.pod:2424
27034 "This does not return logical volumes. For that you will need to call L</"
27040 #: ../fish/guestfish-actions.pod:2429
27046 #: ../fish/guestfish-actions.pod:2431
27055 #: ../fish/guestfish-actions.pod:2439
27061 #: ../fish/guestfish-actions.pod:2441
27064 " ln target linkname\n"
27070 #: ../fish/guestfish-actions.pod:2445
27076 #: ../fish/guestfish-actions.pod:2447
27079 " ln-f target linkname\n"
27085 #: ../fish/guestfish-actions.pod:2452
27091 #: ../fish/guestfish-actions.pod:2454
27094 " ln-s target linkname\n"
27100 #: ../fish/guestfish-actions.pod:2458
27106 #: ../fish/guestfish-actions.pod:2460
27109 " ln-sf target linkname\n"
27115 #: ../fish/guestfish-actions.pod:2465
27116 msgid "lremovexattr"
27121 #: ../fish/guestfish-actions.pod:2467
27124 " lremovexattr xattr path\n"
27130 #: ../fish/guestfish-actions.pod:2469
27132 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27133 "it removes an extended attribute of the link itself."
27138 #: ../fish/guestfish-actions.pod:2473
27144 #: ../fish/guestfish-actions.pod:2475
27153 #: ../fish/guestfish-actions.pod:2481
27155 "This command is mostly useful for interactive sessions. Programs should "
27156 "probably use L</readdir> instead."
27161 #: ../fish/guestfish-actions.pod:2484
27167 #: ../fish/guestfish-actions.pod:2486
27170 " lsetxattr xattr val vallen path\n"
27176 #: ../fish/guestfish-actions.pod:2488
27178 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27179 "sets an extended attribute of the link itself."
27184 #: ../fish/guestfish-actions.pod:2492
27190 #: ../fish/guestfish-actions.pod:2494
27199 #: ../fish/guestfish-actions.pod:2498
27201 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27202 "the link is stat-ed, not the file it refers to."
27207 #: ../fish/guestfish-actions.pod:2504
27213 #: ../fish/guestfish-actions.pod:2506
27216 " lstatlist path 'names ...'\n"
27222 #: ../fish/guestfish-actions.pod:2508
27224 "This call allows you to perform the L</lstat> operation on multiple files, "
27225 "where all files are in the directory C<path>. C<names> is the list of files "
27226 "from this directory."
27231 #: ../fish/guestfish-actions.pod:2517
27233 "This call is intended for programs that want to efficiently list a directory "
27234 "contents without making many round-trips. See also L</lxattrlist> for a "
27235 "similarly efficient call for getting extended attributes. Very long "
27236 "directory listings might cause the protocol message size to be exceeded, "
27237 "causing this call to fail. The caller must split up such requests into "
27238 "smaller groups of names."
27243 #: ../fish/guestfish-actions.pod:2525
27244 msgid "luks-add-key"
27249 #: ../fish/guestfish-actions.pod:2527
27252 " luks-add-key device keyslot\n"
27258 #: ../fish/guestfish-actions.pod:2534
27260 "Note that if C<keyslot> already contains a key, then this command will "
27261 "fail. You have to use L</luks-kill-slot> first to remove that key."
27266 #: ../fish/guestfish-actions.pod:2538 ../fish/guestfish-actions.pod:2560
27267 #: ../fish/guestfish-actions.pod:2573 ../fish/guestfish-actions.pod:2587
27268 #: ../fish/guestfish-actions.pod:2610 ../fish/guestfish-actions.pod:2620
27270 "This command has one or more key or passphrase parameters. Guestfish will "
27271 "prompt for these separately."
27276 #: ../fish/guestfish-actions.pod:2541
27282 #: ../fish/guestfish-actions.pod:2543
27285 " luks-close device\n"
27291 #: ../fish/guestfish-actions.pod:2545
27293 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27294 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27295 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27301 #: ../fish/guestfish-actions.pod:2551
27302 msgid "luks-format"
27307 #: ../fish/guestfish-actions.pod:2553
27310 " luks-format device keyslot\n"
27316 #: ../fish/guestfish-actions.pod:2566
27317 msgid "luks-format-cipher"
27322 #: ../fish/guestfish-actions.pod:2568
27325 " luks-format-cipher device keyslot cipher\n"
27331 #: ../fish/guestfish-actions.pod:2570
27333 "This command is the same as L</luks-format> but it also allows you to set "
27334 "the C<cipher> used."
27339 #: ../fish/guestfish-actions.pod:2579
27340 msgid "luks-kill-slot"
27345 #: ../fish/guestfish-actions.pod:2581
27348 " luks-kill-slot device keyslot\n"
27354 #: ../fish/guestfish-actions.pod:2590
27360 #: ../fish/guestfish-actions.pod:2592
27363 " luks-open device mapname\n"
27369 #: ../fish/guestfish-actions.pod:2606
27371 "If this block device contains LVM volume groups, then calling L</vgscan> "
27372 "followed by L</vg-activate-all> will make them visible."
27377 #: ../fish/guestfish-actions.pod:2613
27378 msgid "luks-open-ro"
27383 #: ../fish/guestfish-actions.pod:2615
27386 " luks-open-ro device mapname\n"
27392 #: ../fish/guestfish-actions.pod:2617
27394 "This is the same as L</luks-open> except that a read-only mapping is created."
27399 #: ../fish/guestfish-actions.pod:2623
27405 #: ../fish/guestfish-actions.pod:2625
27408 " lvcreate logvol volgroup mbytes\n"
27414 #: ../fish/guestfish-actions.pod:2630
27415 msgid "lvm-canonical-lv-name"
27420 #: ../fish/guestfish-actions.pod:2632
27423 " lvm-canonical-lv-name lvname\n"
27429 #: ../fish/guestfish-actions.pod:2641
27430 msgid "See also L</is-lv>."
27435 #: ../fish/guestfish-actions.pod:2643
27436 msgid "lvm-clear-filter"
27441 #: ../fish/guestfish-actions.pod:2645
27444 " lvm-clear-filter\n"
27450 #: ../fish/guestfish-actions.pod:2647
27452 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27458 #: ../fish/guestfish-actions.pod:2653
27459 msgid "lvm-remove-all"
27464 #: ../fish/guestfish-actions.pod:2655
27467 " lvm-remove-all\n"
27473 #: ../fish/guestfish-actions.pod:2663
27474 msgid "lvm-set-filter"
27479 #: ../fish/guestfish-actions.pod:2665
27482 " lvm-set-filter 'devices ...'\n"
27488 #: ../fish/guestfish-actions.pod:2690
27494 #: ../fish/guestfish-actions.pod:2692
27497 " lvremove device\n"
27503 #: ../fish/guestfish-actions.pod:2700
27509 #: ../fish/guestfish-actions.pod:2702
27512 " lvrename logvol newlogvol\n"
27518 #: ../fish/guestfish-actions.pod:2706
27524 #: ../fish/guestfish-actions.pod:2708
27527 " lvresize device mbytes\n"
27533 #: ../fish/guestfish-actions.pod:2714
27534 msgid "lvresize-free"
27539 #: ../fish/guestfish-actions.pod:2716
27542 " lvresize-free lv percent\n"
27548 #: ../fish/guestfish-actions.pod:2724
27554 #: ../fish/guestfish-actions.pod:2726
27563 #: ../fish/guestfish-actions.pod:2734
27564 msgid "See also L</lvs-full>, L</list-filesystems>."
27569 #: ../fish/guestfish-actions.pod:2736
27575 #: ../fish/guestfish-actions.pod:2738
27584 #: ../fish/guestfish-actions.pod:2743
27590 #: ../fish/guestfish-actions.pod:2745
27599 #: ../fish/guestfish-actions.pod:2749
27605 #: ../fish/guestfish-actions.pod:2751
27608 " lxattrlist path 'names ...'\n"
27614 #: ../fish/guestfish-actions.pod:2767
27616 "This call is intended for programs that want to efficiently list a directory "
27617 "contents without making many round-trips. See also L</lstatlist> for a "
27618 "similarly efficient call for getting standard stats. Very long directory "
27619 "listings might cause the protocol message size to be exceeded, causing this "
27620 "call to fail. The caller must split up such requests into smaller groups of "
27626 #: ../fish/guestfish-actions.pod:2775
27632 #: ../fish/guestfish-actions.pod:2777
27641 #: ../fish/guestfish-actions.pod:2781
27647 #: ../fish/guestfish-actions.pod:2783
27650 " mkdir-mode path mode\n"
27656 #: ../fish/guestfish-actions.pod:2792
27657 msgid "See also L</mkdir>, L</umask>"
27662 #: ../fish/guestfish-actions.pod:2794
27668 #: ../fish/guestfish-actions.pod:2796
27677 #: ../fish/guestfish-actions.pod:2801
27683 #: ../fish/guestfish-actions.pod:2803
27686 " mkdtemp template\n"
27692 #: ../fish/guestfish-actions.pod:2824
27698 #: ../fish/guestfish-actions.pod:2826
27701 " mke2fs-J fstype blocksize device journal\n"
27707 #: ../fish/guestfish-actions.pod:2834
27708 msgid "See also L</mke2journal>."
27713 #: ../fish/guestfish-actions.pod:2836
27719 #: ../fish/guestfish-actions.pod:2838
27722 " mke2fs-JL fstype blocksize device label\n"
27728 #: ../fish/guestfish-actions.pod:2843
27729 msgid "See also L</mke2journal-L>."
27734 #: ../fish/guestfish-actions.pod:2845
27740 #: ../fish/guestfish-actions.pod:2847
27743 " mke2fs-JU fstype blocksize device uuid\n"
27749 #: ../fish/guestfish-actions.pod:2852
27750 msgid "See also L</mke2journal-U>."
27755 #: ../fish/guestfish-actions.pod:2854
27756 msgid "mke2journal"
27761 #: ../fish/guestfish-actions.pod:2856
27764 " mke2journal blocksize device\n"
27770 #: ../fish/guestfish-actions.pod:2863
27771 msgid "mke2journal-L"
27776 #: ../fish/guestfish-actions.pod:2865
27779 " mke2journal-L blocksize label device\n"
27785 #: ../fish/guestfish-actions.pod:2869
27786 msgid "mke2journal-U"
27791 #: ../fish/guestfish-actions.pod:2871
27794 " mke2journal-U blocksize uuid device\n"
27800 #: ../fish/guestfish-actions.pod:2875
27806 #: ../fish/guestfish-actions.pod:2877
27809 " mkfifo mode path\n"
27815 #: ../fish/guestfish-actions.pod:2879
27817 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
27818 "is just a convenient wrapper around L</mknod>."
27823 #: ../fish/guestfish-actions.pod:2885
27829 #: ../fish/guestfish-actions.pod:2887
27832 " mkfs fstype device\n"
27838 #: ../fish/guestfish-actions.pod:2893
27844 #: ../fish/guestfish-actions.pod:2895
27847 " mkfs-b fstype blocksize device\n"
27853 #: ../fish/guestfish-actions.pod:2897
27855 "This call is similar to L</mkfs>, but it allows you to control the block "
27856 "size of the resulting filesystem. Supported block sizes depend on the "
27857 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
27862 #: ../fish/guestfish-actions.pod:2912
27867 #: ../fish/guestfish-actions.pod:2914
27870 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
27876 #: ../fish/guestfish-actions.pod:2949
27877 msgid "mkmountpoint"
27882 #: ../fish/guestfish-actions.pod:2951
27885 " mkmountpoint exemptpath\n"
27891 #: ../fish/guestfish-actions.pod:2953
27893 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
27894 "to create extra mountpoints before mounting the first filesystem."
27899 #: ../fish/guestfish-actions.pod:2977
27901 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
27902 "unexpected errors if you try to mix these calls. It is safest to manually "
27903 "unmount filesystems and remove mountpoints after use."
27908 #: ../fish/guestfish-actions.pod:2981
27910 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
27911 "for this to work for manual mountpoints, you must ensure that the innermost "
27912 "mountpoints have the longest pathnames, as in the example code above."
27916 #: ../fish/guestfish-actions.pod:2988
27918 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
27919 "L</umount-all> to be called when the handle is closed which can also trigger "
27925 #: ../fish/guestfish-actions.pod:2992
27931 #: ../fish/guestfish-actions.pod:2994
27934 " mknod mode devmajor devminor path\n"
27940 #: ../fish/guestfish-actions.pod:3004
27942 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
27943 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
27944 "regular file). These constants are available in the standard Linux header "
27945 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
27946 "wrappers around this command which bitwise OR in the appropriate constant "
27952 #: ../fish/guestfish-actions.pod:3014
27958 #: ../fish/guestfish-actions.pod:3016
27961 " mknod-b mode devmajor devminor path\n"
27967 #: ../fish/guestfish-actions.pod:3018
27969 "This call creates a block device node called C<path> with mode C<mode> and "
27970 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27971 "wrapper around L</mknod>."
27976 #: ../fish/guestfish-actions.pod:3024
27982 #: ../fish/guestfish-actions.pod:3026
27985 " mknod-c mode devmajor devminor path\n"
27991 #: ../fish/guestfish-actions.pod:3028
27993 "This call creates a char device node called C<path> with mode C<mode> and "
27994 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27995 "wrapper around L</mknod>."
28000 #: ../fish/guestfish-actions.pod:3034
28006 #: ../fish/guestfish-actions.pod:3036
28015 #: ../fish/guestfish-actions.pod:3040
28021 #: ../fish/guestfish-actions.pod:3042
28024 " mkswap-L label device\n"
28030 #: ../fish/guestfish-actions.pod:3050
28036 #: ../fish/guestfish-actions.pod:3052
28039 " mkswap-U uuid device\n"
28045 #: ../fish/guestfish-actions.pod:3056
28046 msgid "mkswap-file"
28051 #: ../fish/guestfish-actions.pod:3058
28054 " mkswap-file path\n"
28060 #: ../fish/guestfish-actions.pod:3062
28062 "This command just writes a swap file signature to an existing file. To "
28063 "create the file itself, use something like L</fallocate>."
28068 #: ../fish/guestfish-actions.pod:3065
28074 #: ../fish/guestfish-actions.pod:3067
28077 " modprobe modulename\n"
28083 #: ../fish/guestfish-actions.pod:3074
28089 #: ../fish/guestfish-actions.pod:3076
28092 " mount device mountpoint\n"
28098 #: ../fish/guestfish-actions.pod:3092
28100 "B<Important note:> When you use this call, the filesystem options C<sync> "
28101 "and C<noatime> are set implicitly. This was originally done because we "
28102 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28103 "very large negative performance impact and negligible effect on "
28104 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28105 "code that needs performance, and instead use L</mount-options> (use an empty "
28106 "string for the first parameter if you don't want any options)."
28111 #: ../fish/guestfish-actions.pod:3102
28117 #: ../fish/guestfish-actions.pod:3104
28120 " mount-loop file mountpoint\n"
28126 #: ../fish/guestfish-actions.pod:3110
28127 msgid "mount-options"
28132 #: ../fish/guestfish-actions.pod:3112
28135 " mount-options options device mountpoint\n"
28141 #: ../fish/guestfish-actions.pod:3114
28143 "This is the same as the L</mount> command, but it allows you to set the "
28144 "mount options as for the L<mount(8)> I<-o> flag."
28149 #: ../fish/guestfish-actions.pod:3122
28155 #: ../fish/guestfish-actions.pod:3124
28158 " mount-ro device mountpoint\n"
28164 #: ../fish/guestfish-actions.pod:3126
28166 "This is the same as the L</mount> command, but it mounts the filesystem with "
28167 "the read-only (I<-o ro>) flag."
28172 #: ../fish/guestfish-actions.pod:3129
28178 #: ../fish/guestfish-actions.pod:3131
28181 " mount-vfs options vfstype device mountpoint\n"
28187 #: ../fish/guestfish-actions.pod:3133
28189 "This is the same as the L</mount> command, but it allows you to set both the "
28190 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28195 #: ../fish/guestfish-actions.pod:3137
28196 msgid "mountpoints"
28201 #: ../fish/guestfish-actions.pod:3139
28210 #: ../fish/guestfish-actions.pod:3141
28212 "This call is similar to L</mounts>. That call returns a list of devices. "
28213 "This one returns a hash table (map) of device name to directory where the "
28214 "device is mounted."
28219 #: ../fish/guestfish-actions.pod:3145
28225 #: ../fish/guestfish-actions.pod:3147
28234 #: ../fish/guestfish-actions.pod:3154
28235 msgid "See also: L</mountpoints>"
28240 #: ../fish/guestfish-actions.pod:3156
28246 #: ../fish/guestfish-actions.pod:3158
28255 #: ../fish/guestfish-actions.pod:3163
28256 msgid "ntfs-3g-probe"
28261 #: ../fish/guestfish-actions.pod:3165
28264 " ntfs-3g-probe true|false device\n"
28270 #: ../fish/guestfish-actions.pod:3179
28276 #: ../fish/guestfish-actions.pod:3181
28279 " ntfsresize device\n"
28285 #: ../fish/guestfish-actions.pod:3187
28286 msgid "ntfsresize-size"
28291 #: ../fish/guestfish-actions.pod:3189
28294 " ntfsresize-size device size\n"
28300 #: ../fish/guestfish-actions.pod:3191
28302 "This command is the same as L</ntfsresize> except that it allows you to "
28303 "specify the new size (in bytes) explicitly."
28308 #: ../fish/guestfish-actions.pod:3194
28314 #: ../fish/guestfish-actions.pod:3196
28317 " part-add device prlogex startsect endsect\n"
28323 #: ../fish/guestfish-actions.pod:3198
28325 "This command adds a partition to C<device>. If there is no partition table "
28326 "on the device, call L</part-init> first."
28331 #: ../fish/guestfish-actions.pod:3210
28333 "Creating a partition which covers the whole disk is not so easy. Use L</"
28334 "part-disk> to do that."
28339 #: ../fish/guestfish-actions.pod:3213
28345 #: ../fish/guestfish-actions.pod:3215
28348 " part-del device partnum\n"
28354 #: ../fish/guestfish-actions.pod:3223
28360 #: ../fish/guestfish-actions.pod:3225
28363 " part-disk device parttype\n"
28369 #: ../fish/guestfish-actions.pod:3227
28371 "This command is simply a combination of L</part-init> followed by L</part-"
28372 "add> to create a single primary partition covering the whole disk."
28377 #: ../fish/guestfish-actions.pod:3231
28379 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28380 "possible values are described in L</part-init>."
28385 #: ../fish/guestfish-actions.pod:3237
28386 msgid "part-get-bootable"
28391 #: ../fish/guestfish-actions.pod:3239
28394 " part-get-bootable device partnum\n"
28400 #: ../fish/guestfish-actions.pod:3244
28401 msgid "See also L</part-set-bootable>."
28406 #: ../fish/guestfish-actions.pod:3246
28407 msgid "part-get-mbr-id"
28412 #: ../fish/guestfish-actions.pod:3248
28415 " part-get-mbr-id device partnum\n"
28421 #: ../fish/guestfish-actions.pod:3253 ../fish/guestfish-actions.pod:3391
28423 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28424 "undefined results for other partition table types (see L</part-get-"
28430 #: ../fish/guestfish-actions.pod:3257
28431 msgid "part-get-parttype"
28436 #: ../fish/guestfish-actions.pod:3259
28439 " part-get-parttype device\n"
28445 #: ../fish/guestfish-actions.pod:3264
28447 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28448 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28449 "possible, although unusual. See L</part-init> for a full list."
28454 #: ../fish/guestfish-actions.pod:3269
28460 #: ../fish/guestfish-actions.pod:3271
28463 " part-init device parttype\n"
28469 #: ../fish/guestfish-actions.pod:3277
28471 "Initially there are no partitions. Following this, you should call L</part-"
28472 "add> for each partition required."
28477 #: ../fish/guestfish-actions.pod:3340
28483 #: ../fish/guestfish-actions.pod:3342
28486 " part-list device\n"
28492 #: ../fish/guestfish-actions.pod:3357
28494 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28495 "the device's sector size, see L</blockdev-getss>."
28500 #: ../fish/guestfish-actions.pod:3370
28501 msgid "part-set-bootable"
28506 #: ../fish/guestfish-actions.pod:3372
28509 " part-set-bootable device partnum true|false\n"
28515 #: ../fish/guestfish-actions.pod:3381
28516 msgid "part-set-mbr-id"
28521 #: ../fish/guestfish-actions.pod:3383
28524 " part-set-mbr-id device partnum idbyte\n"
28530 #: ../fish/guestfish-actions.pod:3395
28531 msgid "part-set-name"
28536 #: ../fish/guestfish-actions.pod:3397
28539 " part-set-name device partnum name\n"
28545 #: ../fish/guestfish-actions.pod:3405
28546 msgid "part-to-dev"
28551 #: ../fish/guestfish-actions.pod:3407
28554 " part-to-dev partition\n"
28560 #: ../fish/guestfish-actions.pod:3413
28562 "The named partition must exist, for example as a string returned from L</"
28563 "list-partitions>."
28568 #: ../fish/guestfish-actions.pod:3416
28569 msgid "ping-daemon"
28574 #: ../fish/guestfish-actions.pod:3418
28583 #: ../fish/guestfish-actions.pod:3425
28589 #: ../fish/guestfish-actions.pod:3427
28592 " pread path count offset\n"
28598 #: ../fish/guestfish-actions.pod:3435
28599 msgid "See also L</pwrite>, L</pread-device>."
28604 #: ../fish/guestfish-actions.pod:3440
28605 msgid "pread-device"
28610 #: ../fish/guestfish-actions.pod:3442
28613 " pread-device device count offset\n"
28619 #: ../fish/guestfish-actions.pod:3450
28620 msgid "See also L</pread>."
28625 #: ../fish/guestfish-actions.pod:3455
28631 #: ../fish/guestfish-actions.pod:3457
28634 " pvcreate device\n"
28640 #: ../fish/guestfish-actions.pod:3463
28646 #: ../fish/guestfish-actions.pod:3465
28649 " pvremove device\n"
28655 #: ../fish/guestfish-actions.pod:3474
28661 #: ../fish/guestfish-actions.pod:3476
28664 " pvresize device\n"
28670 #: ../fish/guestfish-actions.pod:3481
28671 msgid "pvresize-size"
28676 #: ../fish/guestfish-actions.pod:3483
28679 " pvresize-size device size\n"
28685 #: ../fish/guestfish-actions.pod:3485
28687 "This command is the same as L</pvresize> except that it allows you to "
28688 "specify the new size (in bytes) explicitly."
28693 #: ../fish/guestfish-actions.pod:3488
28699 #: ../fish/guestfish-actions.pod:3490
28708 #: ../fish/guestfish-actions.pod:3498
28709 msgid "See also L</pvs-full>."
28714 #: ../fish/guestfish-actions.pod:3500
28720 #: ../fish/guestfish-actions.pod:3502
28729 #: ../fish/guestfish-actions.pod:3507
28735 #: ../fish/guestfish-actions.pod:3509
28744 #: ../fish/guestfish-actions.pod:3513
28750 #: ../fish/guestfish-actions.pod:3515
28753 " pwrite path content offset\n"
28759 #: ../fish/guestfish-actions.pod:3526
28760 msgid "See also L</pread>, L</pwrite-device>."
28765 #: ../fish/guestfish-actions.pod:3531
28766 msgid "pwrite-device"
28771 #: ../fish/guestfish-actions.pod:3533
28774 " pwrite-device device content offset\n"
28780 #: ../fish/guestfish-actions.pod:3543
28781 msgid "See also L</pwrite>."
28786 #: ../fish/guestfish-actions.pod:3548
28792 #: ../fish/guestfish-actions.pod:3550
28795 " read-file path\n"
28801 #: ../fish/guestfish-actions.pod:3555
28803 "Unlike L</cat>, this function can correctly handle files that contain "
28804 "embedded ASCII NUL characters. However unlike L</download>, this function "
28805 "is limited in the total size of file that can be handled."
28810 #: ../fish/guestfish-actions.pod:3563
28816 #: ../fish/guestfish-actions.pod:3565
28819 " read-lines path\n"
28825 #: ../fish/guestfish-actions.pod:3572
28827 "Note that this function cannot correctly handle binary files (specifically, "
28828 "files containing C<\\0> character which is treated as end of line). For "
28829 "those you need to use the L</read-file> function which has a more complex "
28835 #: ../fish/guestfish-actions.pod:3577
28841 #: ../fish/guestfish-actions.pod:3579
28850 #: ../fish/guestfish-actions.pod:3631
28852 "This function is primarily intended for use by programs. To get a simple "
28853 "list of names, use L</ls>. To get a printable directory for human "
28854 "consumption, use L</ll>."
28859 #: ../fish/guestfish-actions.pod:3635
28865 #: ../fish/guestfish-actions.pod:3637
28874 #: ../fish/guestfish-actions.pod:3641
28875 msgid "readlinklist"
28880 #: ../fish/guestfish-actions.pod:3643
28883 " readlinklist path 'names ...'\n"
28889 #: ../fish/guestfish-actions.pod:3667
28895 #: ../fish/guestfish-actions.pod:3669
28904 #: ../fish/guestfish-actions.pod:3674
28905 msgid "removexattr"
28910 #: ../fish/guestfish-actions.pod:3676
28913 " removexattr xattr path\n"
28919 #: ../fish/guestfish-actions.pod:3681
28920 msgid "See also: L</lremovexattr>, L<attr(5)>."
28925 #: ../fish/guestfish-actions.pod:3683
28931 #: ../fish/guestfish-actions.pod:3685
28934 " resize2fs device\n"
28940 #: ../fish/guestfish-actions.pod:3690
28942 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
28943 "before calling this command. For unknown reasons C<resize2fs> sometimes "
28944 "gives an error about this and sometimes not. In any case, it is always safe "
28945 "to call L</e2fsck-f> before calling this function."
28949 #: ../fish/guestfish-actions.pod:3696
28950 msgid "resize2fs-M"
28954 #: ../fish/guestfish-actions.pod:3698
28957 " resize2fs-M device\n"
28962 #: ../fish/guestfish-actions.pod:3700
28964 "This command is the same as L</resize2fs>, but the filesystem is resized to "
28965 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
28970 #: ../fish/guestfish-actions.pod:3704
28972 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
28973 "and read the C<Block size> and C<Block count> values. These two numbers, "
28974 "multiplied together, give the resulting size of the minimal filesystem in "
28980 #: ../fish/guestfish-actions.pod:3709
28981 msgid "resize2fs-size"
28986 #: ../fish/guestfish-actions.pod:3711
28989 " resize2fs-size device size\n"
28995 #: ../fish/guestfish-actions.pod:3713
28997 "This command is the same as L</resize2fs> except that it allows you to "
28998 "specify the new size (in bytes) explicitly."
29003 #: ../fish/guestfish-actions.pod:3716
29009 #: ../fish/guestfish-actions.pod:3718
29018 #: ../fish/guestfish-actions.pod:3722
29024 #: ../fish/guestfish-actions.pod:3724
29033 #: ../fish/guestfish-actions.pod:3730
29039 #: ../fish/guestfish-actions.pod:3732
29048 #: ../fish/guestfish-actions.pod:3736
29049 msgid "rmmountpoint"
29054 #: ../fish/guestfish-actions.pod:3738
29057 " rmmountpoint exemptpath\n"
29063 #: ../fish/guestfish-actions.pod:3740
29065 "This calls removes a mountpoint that was previously created with L</"
29066 "mkmountpoint>. See L</mkmountpoint> for full details."
29071 #: ../fish/guestfish-actions.pod:3744
29072 msgid "scrub-device"
29077 #: ../fish/guestfish-actions.pod:3746
29080 " scrub-device device\n"
29086 #: ../fish/guestfish-actions.pod:3757
29092 #: ../fish/guestfish-actions.pod:3759
29095 " scrub-file file\n"
29101 #: ../fish/guestfish-actions.pod:3769
29102 msgid "scrub-freespace"
29107 #: ../fish/guestfish-actions.pod:3771
29110 " scrub-freespace dir\n"
29116 #: ../fish/guestfish-actions.pod:3773
29118 "This command creates the directory C<dir> and then fills it with files until "
29119 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29120 "deletes them. The intention is to scrub any free space on the partition "
29121 "containing C<dir>."
29126 #: ../fish/guestfish-actions.pod:3782
29132 #: ../fish/guestfish-actions.pod:3784
29138 #: ../fish/guestfish-actions.pod:3786
29141 " set-append append\n"
29146 #: ../fish/guestfish-actions.pod:3797
29147 msgid "set-attach-method"
29151 #: ../fish/guestfish-actions.pod:3799
29152 msgid "attach-method"
29156 #: ../fish/guestfish-actions.pod:3801
29159 " set-attach-method attachmethod\n"
29165 #: ../fish/guestfish-actions.pod:3823
29166 msgid "set-autosync"
29171 #: ../fish/guestfish-actions.pod:3825
29177 #: ../fish/guestfish-actions.pod:3827
29180 " set-autosync true|false\n"
29186 #: ../fish/guestfish-actions.pod:3837
29192 #: ../fish/guestfish-actions.pod:3839
29198 #: ../fish/guestfish-actions.pod:3841
29201 " set-direct true|false\n"
29207 #: ../fish/guestfish-actions.pod:3847
29209 "One consequence of this is that log messages aren't caught by the library "
29210 "and handled by L</set-log-message-callback>, but go straight to stdout."
29215 #: ../fish/guestfish-actions.pod:3856
29216 msgid "set-e2label"
29221 #: ../fish/guestfish-actions.pod:3858
29224 " set-e2label device label\n"
29230 #: ../fish/guestfish-actions.pod:3864
29232 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29233 "label on a filesystem."
29238 #: ../fish/guestfish-actions.pod:3867
29244 #: ../fish/guestfish-actions.pod:3869
29247 " set-e2uuid device uuid\n"
29253 #: ../fish/guestfish-actions.pod:3876
29255 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29256 "UUID of a filesystem."
29261 #: ../fish/guestfish-actions.pod:3879
29262 msgid "set-memsize"
29267 #: ../fish/guestfish-actions.pod:3881
29273 #: ../fish/guestfish-actions.pod:3883
29276 " set-memsize memsize\n"
29282 #: ../fish/guestfish-actions.pod:3885
29284 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29285 "This only has any effect if called before L</launch>."
29290 #: ../fish/guestfish-actions.pod:3896
29291 msgid "set-network"
29296 #: ../fish/guestfish-actions.pod:3898
29302 #: ../fish/guestfish-actions.pod:3900
29305 " set-network true|false\n"
29311 #: ../fish/guestfish-actions.pod:3908
29313 "You must call this before calling L</launch>, otherwise it has no effect."
29318 #: ../fish/guestfish-actions.pod:3911
29324 #: ../fish/guestfish-actions.pod:3913
29330 #: ../fish/guestfish-actions.pod:3915
29333 " set-path searchpath\n"
29339 #: ../fish/guestfish-actions.pod:3924
29345 #: ../fish/guestfish-actions.pod:3926
29351 #: ../fish/guestfish-actions.pod:3928
29360 #: ../fish/guestfish-actions.pod:3948
29361 msgid "set-recovery-proc"
29366 #: ../fish/guestfish-actions.pod:3950
29367 msgid "recovery-proc"
29372 #: ../fish/guestfish-actions.pod:3952
29375 " set-recovery-proc true|false\n"
29381 #: ../fish/guestfish-actions.pod:3954
29383 "If this is called with the parameter C<false> then L</launch> does not "
29384 "create a recovery process. The purpose of the recovery process is to stop "
29385 "runaway qemu processes in the case where the main program aborts abruptly."
29390 #: ../fish/guestfish-actions.pod:3959
29392 "This only has any effect if called before L</launch>, and the default is "
29398 #: ../fish/guestfish-actions.pod:3968
29399 msgid "set-selinux"
29404 #: ../fish/guestfish-actions.pod:3970
29410 #: ../fish/guestfish-actions.pod:3972
29413 " set-selinux true|false\n"
29419 #: ../fish/guestfish-actions.pod:3983
29425 #: ../fish/guestfish-actions.pod:3985
29431 #: ../fish/guestfish-actions.pod:3987
29434 " set-trace true|false\n"
29439 #: ../fish/guestfish-actions.pod:3999
29441 "Trace messages are normally sent to C<stderr>, unless you register a "
29442 "callback to send them somewhere else (see L</set-event-callback>)."
29447 #: ../fish/guestfish-actions.pod:4003
29448 msgid "set-verbose"
29453 #: ../fish/guestfish-actions.pod:4005
29459 #: ../fish/guestfish-actions.pod:4007
29462 " set-verbose true|false\n"
29467 #: ../fish/guestfish-actions.pod:4014
29469 "Verbose messages are normally sent to C<stderr>, unless you register a "
29470 "callback to send them somewhere else (see L</set-event-callback>)."
29475 #: ../fish/guestfish-actions.pod:4018
29481 #: ../fish/guestfish-actions.pod:4020
29484 " setcon context\n"
29490 #: ../fish/guestfish-actions.pod:4027
29496 #: ../fish/guestfish-actions.pod:4029
29499 " setxattr xattr val vallen path\n"
29505 #: ../fish/guestfish-actions.pod:4035
29506 msgid "See also: L</lsetxattr>, L<attr(5)>."
29511 #: ../fish/guestfish-actions.pod:4037
29517 #: ../fish/guestfish-actions.pod:4039
29520 " sfdisk device cyls heads sectors 'lines ...'\n"
29526 #: ../fish/guestfish-actions.pod:4061
29527 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
29532 #: ../fish/guestfish-actions.pod:4067
29538 #: ../fish/guestfish-actions.pod:4069
29541 " sfdiskM device 'lines ...'\n"
29547 #: ../fish/guestfish-actions.pod:4071
29549 "This is a simplified interface to the L</sfdisk> command, where partition "
29550 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
29551 "you don't need to specify the cyls, heads and sectors parameters which were "
29552 "rarely if ever used anyway."
29557 #: ../fish/guestfish-actions.pod:4077
29558 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
29563 #: ../fish/guestfish-actions.pod:4083
29569 #: ../fish/guestfish-actions.pod:4085
29572 " sfdisk-N device partnum cyls heads sectors line\n"
29578 #: ../fish/guestfish-actions.pod:4090
29580 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
29581 "cyls/heads/sectors parameters."
29586 #: ../fish/guestfish-actions.pod:4093
29587 msgid "See also: L</part-add>"
29592 #: ../fish/guestfish-actions.pod:4098
29593 msgid "sfdisk-disk-geometry"
29598 #: ../fish/guestfish-actions.pod:4100
29601 " sfdisk-disk-geometry device\n"
29607 #: ../fish/guestfish-actions.pod:4102
29609 "This displays the disk geometry of C<device> read from the partition table. "
29610 "Especially in the case where the underlying block device has been resized, "
29611 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
29612 "kernel-geometry>)."
29617 #: ../fish/guestfish-actions.pod:4110
29618 msgid "sfdisk-kernel-geometry"
29623 #: ../fish/guestfish-actions.pod:4112
29626 " sfdisk-kernel-geometry device\n"
29632 #: ../fish/guestfish-actions.pod:4119
29638 #: ../fish/guestfish-actions.pod:4121
29641 " sfdisk-l device\n"
29647 #: ../fish/guestfish-actions.pod:4127
29648 msgid "See also: L</part-list>"
29653 #: ../fish/guestfish-actions.pod:4129
29659 #: ../fish/guestfish-actions.pod:4131
29668 #: ../fish/guestfish-actions.pod:4136
29669 msgid "This is like L</command>, but passes the command to:"
29674 #: ../fish/guestfish-actions.pod:4144
29675 msgid "All the provisos about L</command> apply to this call."
29680 #: ../fish/guestfish-actions.pod:4146
29686 #: ../fish/guestfish-actions.pod:4148
29689 " sh-lines command\n"
29695 #: ../fish/guestfish-actions.pod:4150
29696 msgid "This is the same as L</sh>, but splits the result into a list of lines."
29701 #: ../fish/guestfish-actions.pod:4153
29702 msgid "See also: L</command-lines>"
29707 #: ../fish/guestfish-actions.pod:4155
29713 #: ../fish/guestfish-actions.pod:4157
29722 #: ../fish/guestfish-actions.pod:4161
29728 #: ../fish/guestfish-actions.pod:4163
29737 #: ../fish/guestfish-actions.pod:4169
29743 #: ../fish/guestfish-actions.pod:4171
29752 #: ../fish/guestfish-actions.pod:4179
29758 #: ../fish/guestfish-actions.pod:4181
29767 #: ../fish/guestfish-actions.pod:4189
29773 #: ../fish/guestfish-actions.pod:4191
29776 " strings-e encoding path\n"
29782 #: ../fish/guestfish-actions.pod:4193
29784 "This is like the L</strings> command, but allows you to specify the encoding "
29785 "of strings that are looked for in the source file C<path>."
29790 #: ../fish/guestfish-actions.pod:4203
29792 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29793 "ISO-8859-X (this is what L</strings> uses)."
29798 #: ../fish/guestfish-actions.pod:4235
29799 msgid "swapoff-device"
29804 #: ../fish/guestfish-actions.pod:4237
29807 " swapoff-device device\n"
29813 #: ../fish/guestfish-actions.pod:4239
29815 "This command disables the libguestfs appliance swap device or partition "
29816 "named C<device>. See L</swapon-device>."
29821 #: ../fish/guestfish-actions.pod:4243
29822 msgid "swapoff-file"
29827 #: ../fish/guestfish-actions.pod:4245
29830 " swapoff-file file\n"
29836 #: ../fish/guestfish-actions.pod:4249
29837 msgid "swapoff-label"
29842 #: ../fish/guestfish-actions.pod:4251
29845 " swapoff-label label\n"
29851 #: ../fish/guestfish-actions.pod:4256
29852 msgid "swapoff-uuid"
29857 #: ../fish/guestfish-actions.pod:4258
29860 " swapoff-uuid uuid\n"
29866 #: ../fish/guestfish-actions.pod:4263
29867 msgid "swapon-device"
29872 #: ../fish/guestfish-actions.pod:4265
29875 " swapon-device device\n"
29881 #: ../fish/guestfish-actions.pod:4267
29883 "This command enables the libguestfs appliance to use the swap device or "
29884 "partition named C<device>. The increased memory is made available for all "
29885 "commands, for example those run using L</command> or L</sh>."
29890 #: ../fish/guestfish-actions.pod:4279
29891 msgid "swapon-file"
29896 #: ../fish/guestfish-actions.pod:4281
29899 " swapon-file file\n"
29905 #: ../fish/guestfish-actions.pod:4283
29907 "This command enables swap to a file. See L</swapon-device> for other notes."
29912 #: ../fish/guestfish-actions.pod:4286
29913 msgid "swapon-label"
29918 #: ../fish/guestfish-actions.pod:4288
29921 " swapon-label label\n"
29927 #: ../fish/guestfish-actions.pod:4290
29929 "This command enables swap to a labeled swap partition. See L</swapon-"
29930 "device> for other notes."
29935 #: ../fish/guestfish-actions.pod:4293
29936 msgid "swapon-uuid"
29941 #: ../fish/guestfish-actions.pod:4295
29944 " swapon-uuid uuid\n"
29950 #: ../fish/guestfish-actions.pod:4297
29952 "This command enables swap to a swap partition with the given UUID. See L</"
29953 "swapon-device> for other notes."
29958 #: ../fish/guestfish-actions.pod:4300
29964 #: ../fish/guestfish-actions.pod:4302
29973 #: ../fish/guestfish-actions.pod:4310
29979 #: ../fish/guestfish-actions.pod:4312
29988 #: ../fish/guestfish-actions.pod:4320
29994 #: ../fish/guestfish-actions.pod:4322
29997 " tail-n nrlines path\n"
30003 #: ../fish/guestfish-actions.pod:4335
30009 #: ../fish/guestfish-actions.pod:4337
30012 " tar-in (tarfile|-) directory\n"
30018 #: ../fish/guestfish-actions.pod:4342
30019 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30024 #: ../fish/guestfish-actions.pod:4347
30030 #: ../fish/guestfish-actions.pod:4349
30033 " tar-out directory (tarfile|-)\n"
30039 #: ../fish/guestfish-actions.pod:4354
30040 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30045 #: ../fish/guestfish-actions.pod:4359
30051 #: ../fish/guestfish-actions.pod:4361
30054 " tgz-in (tarball|-) directory\n"
30060 #: ../fish/guestfish-actions.pod:4366
30061 msgid "To upload an uncompressed tarball, use L</tar-in>."
30066 #: ../fish/guestfish-actions.pod:4370
30072 #: ../fish/guestfish-actions.pod:4372
30075 " tgz-out directory (tarball|-)\n"
30081 #: ../fish/guestfish-actions.pod:4377
30082 msgid "To download an uncompressed tarball, use L</tar-out>."
30087 #: ../fish/guestfish-actions.pod:4381
30093 #: ../fish/guestfish-actions.pod:4383
30102 #: ../fish/guestfish-actions.pod:4392
30108 #: ../fish/guestfish-actions.pod:4394
30117 #: ../fish/guestfish-actions.pod:4399
30118 msgid "truncate-size"
30123 #: ../fish/guestfish-actions.pod:4401
30126 " truncate-size path size\n"
30132 #: ../fish/guestfish-actions.pod:4406
30134 "If the current file size is less than C<size> then the file is extended to "
30135 "the required size with zero bytes. This creates a sparse file (ie. disk "
30136 "blocks are not allocated for the file until you write to it). To create a "
30137 "non-sparse file of zeroes, use L</fallocate64> instead."
30142 #: ../fish/guestfish-actions.pod:4412
30148 #: ../fish/guestfish-actions.pod:4414
30151 " tune2fs-l device\n"
30157 #: ../fish/guestfish-actions.pod:4424
30163 #: ../fish/guestfish-actions.pod:4426
30166 " txz-in (tarball|-) directory\n"
30172 #: ../fish/guestfish-actions.pod:4433
30178 #: ../fish/guestfish-actions.pod:4435
30181 " txz-out directory (tarball|-)\n"
30187 #: ../fish/guestfish-actions.pod:4442
30193 #: ../fish/guestfish-actions.pod:4444
30202 #: ../fish/guestfish-actions.pod:4458
30203 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30208 #: ../fish/guestfish-actions.pod:4463
30214 #: ../fish/guestfish-actions.pod:4465
30220 #: ../fish/guestfish-actions.pod:4467
30223 " umount pathordevice\n"
30229 #: ../fish/guestfish-actions.pod:4473
30235 #: ../fish/guestfish-actions.pod:4475
30236 msgid "unmount-all"
30241 #: ../fish/guestfish-actions.pod:4477
30250 #: ../fish/guestfish-actions.pod:4483
30256 #: ../fish/guestfish-actions.pod:4485
30259 " upload (filename|-) remotefilename\n"
30265 #: ../fish/guestfish-actions.pod:4492
30266 msgid "See also L</download>."
30271 #: ../fish/guestfish-actions.pod:4496
30272 msgid "upload-offset"
30277 #: ../fish/guestfish-actions.pod:4498
30280 " upload-offset (filename|-) remotefilename offset\n"
30286 #: ../fish/guestfish-actions.pod:4510
30288 "Note that there is no limit on the amount of data that can be uploaded with "
30289 "this call, unlike with L</pwrite>, and this call always writes the full "
30290 "amount unless an error occurs."
30295 #: ../fish/guestfish-actions.pod:4515
30296 msgid "See also L</upload>, L</pwrite>."
30301 #: ../fish/guestfish-actions.pod:4519
30307 #: ../fish/guestfish-actions.pod:4521
30310 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30316 #: ../fish/guestfish-actions.pod:4540
30322 #: ../fish/guestfish-actions.pod:4542
30331 #: ../fish/guestfish-actions.pod:4569
30333 "I<Note:> Don't use this call to test for availability of features. In "
30334 "enterprise distributions we backport features from later versions into "
30335 "earlier versions, making this an unreliable way to test for features. Use "
30336 "L</available> instead."
30341 #: ../fish/guestfish-actions.pod:4575
30347 #: ../fish/guestfish-actions.pod:4577
30350 " vfs-label device\n"
30356 #: ../fish/guestfish-actions.pod:4584
30357 msgid "To find a filesystem from the label, use L</findfs-label>."
30362 #: ../fish/guestfish-actions.pod:4586
30368 #: ../fish/guestfish-actions.pod:4588
30371 " vfs-type device\n"
30377 #: ../fish/guestfish-actions.pod:4598
30383 #: ../fish/guestfish-actions.pod:4600
30386 " vfs-uuid device\n"
30392 #: ../fish/guestfish-actions.pod:4607
30393 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30398 #: ../fish/guestfish-actions.pod:4609
30399 msgid "vg-activate"
30404 #: ../fish/guestfish-actions.pod:4611
30407 " vg-activate true|false 'volgroups ...'\n"
30413 #: ../fish/guestfish-actions.pod:4624
30414 msgid "vg-activate-all"
30419 #: ../fish/guestfish-actions.pod:4626
30422 " vg-activate-all true|false\n"
30428 #: ../fish/guestfish-actions.pod:4636
30434 #: ../fish/guestfish-actions.pod:4638
30437 " vgcreate volgroup 'physvols ...'\n"
30443 #: ../fish/guestfish-actions.pod:4643
30449 #: ../fish/guestfish-actions.pod:4645
30452 " vglvuuids vgname\n"
30458 #: ../fish/guestfish-actions.pod:4650
30460 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30461 "logical volumes and volume groups."
30466 #: ../fish/guestfish-actions.pod:4653
30467 msgid "See also L</vgpvuuids>."
30472 #: ../fish/guestfish-actions.pod:4655
30478 #: ../fish/guestfish-actions.pod:4657
30481 " vgpvuuids vgname\n"
30487 #: ../fish/guestfish-actions.pod:4662
30489 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30490 "physical volumes and volume groups."
30495 #: ../fish/guestfish-actions.pod:4665
30496 msgid "See also L</vglvuuids>."
30501 #: ../fish/guestfish-actions.pod:4667
30507 #: ../fish/guestfish-actions.pod:4669
30510 " vgremove vgname\n"
30516 #: ../fish/guestfish-actions.pod:4676
30522 #: ../fish/guestfish-actions.pod:4678
30525 " vgrename volgroup newvolgroup\n"
30531 #: ../fish/guestfish-actions.pod:4682
30537 #: ../fish/guestfish-actions.pod:4684
30546 #: ../fish/guestfish-actions.pod:4692
30547 msgid "See also L</vgs-full>."
30552 #: ../fish/guestfish-actions.pod:4694
30558 #: ../fish/guestfish-actions.pod:4696
30567 #: ../fish/guestfish-actions.pod:4701
30573 #: ../fish/guestfish-actions.pod:4703
30582 #: ../fish/guestfish-actions.pod:4708
30588 #: ../fish/guestfish-actions.pod:4710
30597 #: ../fish/guestfish-actions.pod:4714
30603 #: ../fish/guestfish-actions.pod:4716
30612 #: ../fish/guestfish-actions.pod:4721
30618 #: ../fish/guestfish-actions.pod:4723
30627 #: ../fish/guestfish-actions.pod:4728
30633 #: ../fish/guestfish-actions.pod:4730
30642 #: ../fish/guestfish-actions.pod:4735
30648 #: ../fish/guestfish-actions.pod:4737
30651 " write path content\n"
30657 #: ../fish/guestfish-actions.pod:4745
30663 #: ../fish/guestfish-actions.pod:4747
30666 " write-file path content size\n"
30672 #: ../fish/guestfish-actions.pod:4770
30678 #: ../fish/guestfish-actions.pod:4772
30681 " zegrep regex path\n"
30687 #: ../fish/guestfish-actions.pod:4780
30693 #: ../fish/guestfish-actions.pod:4782
30696 " zegrepi regex path\n"
30702 #: ../fish/guestfish-actions.pod:4790
30708 #: ../fish/guestfish-actions.pod:4792
30717 #: ../fish/guestfish-actions.pod:4800
30718 msgid "See also: L</zero-device>, L</scrub-device>."
30723 #: ../fish/guestfish-actions.pod:4802
30724 msgid "zero-device"
30729 #: ../fish/guestfish-actions.pod:4804
30732 " zero-device device\n"
30738 #: ../fish/guestfish-actions.pod:4806
30740 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
30741 "which just zeroes the first few blocks of a device."
30746 #: ../fish/guestfish-actions.pod:4813
30752 #: ../fish/guestfish-actions.pod:4815
30755 " zerofree device\n"
30761 #: ../fish/guestfish-actions.pod:4828
30767 #: ../fish/guestfish-actions.pod:4830
30770 " zfgrep pattern path\n"
30776 #: ../fish/guestfish-actions.pod:4838
30782 #: ../fish/guestfish-actions.pod:4840
30785 " zfgrepi pattern path\n"
30791 #: ../fish/guestfish-actions.pod:4848
30797 #: ../fish/guestfish-actions.pod:4850
30800 " zfile meth path\n"
30806 #: ../fish/guestfish-actions.pod:4857
30808 "Since 1.0.63, use L</file> instead which can now process compressed files."
30813 #: ../fish/guestfish-actions.pod:4867
30819 #: ../fish/guestfish-actions.pod:4869
30822 " zgrep regex path\n"
30828 #: ../fish/guestfish-actions.pod:4877
30834 #: ../fish/guestfish-actions.pod:4879
30837 " zgrepi regex path\n"
30843 #: ../fish/guestfish-commands.pod:1
30849 #: ../fish/guestfish-commands.pod:3
30855 #: ../fish/guestfish-commands.pod:5
30858 " alloc filename size\n"
30864 #: ../fish/guestfish-commands.pod:7
30866 "This creates an empty (zeroed) file of the given size, and then adds so it "
30867 "can be further examined."
30872 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
30873 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
30878 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
30879 msgid "Size can be specified using standard suffixes, eg. C<1M>."
30884 #: ../fish/guestfish-commands.pod:14
30886 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
30887 "image, see L</PREPARED DISK IMAGES>."
30892 #: ../fish/guestfish-commands.pod:17
30898 #: ../fish/guestfish-commands.pod:19
30901 " copy-in local [local ...] /remotedir\n"
30907 #: ../fish/guestfish-commands.pod:21
30909 "C<copy-in> copies local files or directories recursively into the disk "
30910 "image, placing them in the directory called C</remotedir> (which must "
30911 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
30912 "other commands as necessary."
30917 #: ../fish/guestfish-commands.pod:26
30919 "Multiple local files and directories can be specified, but the last "
30920 "parameter must always be a remote directory. Wildcards cannot be used."
30925 #: ../fish/guestfish-commands.pod:30
30931 #: ../fish/guestfish-commands.pod:32
30934 " copy-out remote [remote ...] localdir\n"
30940 #: ../fish/guestfish-commands.pod:34
30942 "C<copy-out> copies remote files or directories recursively out of the disk "
30943 "image, placing them on the host disk in a local directory called C<localdir> "
30944 "(which must exist). This guestfish meta-command turns into a sequence of L</"
30945 "download>, L</tar-out> and other commands as necessary."
30950 #: ../fish/guestfish-commands.pod:40
30952 "Multiple remote files and directories can be specified, but the last "
30953 "parameter must always be a local directory. To download to the current "
30954 "directory, use C<.> as in:"
30959 #: ../fish/guestfish-commands.pod:44
30962 " copy-out /home .\n"
30968 #: ../fish/guestfish-commands.pod:46
30970 "Wildcards cannot be used in the ordinary command, but you can use them with "
30971 "the help of L</glob> like this:"
30976 #: ../fish/guestfish-commands.pod:49
30979 " glob copy-out /home/* .\n"
30985 #: ../fish/guestfish-commands.pod:51
30991 #: ../fish/guestfish-commands.pod:53
30994 " echo [params ...]\n"
31000 #: ../fish/guestfish-commands.pod:55
31001 msgid "This echos the parameters to the terminal."
31006 #: ../fish/guestfish-commands.pod:57
31012 #: ../fish/guestfish-commands.pod:59
31018 #: ../fish/guestfish-commands.pod:61
31024 #: ../fish/guestfish-commands.pod:63
31033 #: ../fish/guestfish-commands.pod:65
31035 "This is used to edit a file. It downloads the file, edits it locally using "
31036 "your editor, then uploads the result."
31041 #: ../fish/guestfish-commands.pod:68
31043 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31044 "or C<emacs> you will get those corresponding editors."
31049 #: ../fish/guestfish-commands.pod:72
31055 #: ../fish/guestfish-commands.pod:74
31058 " glob command args...\n"
31064 #: ../fish/guestfish-commands.pod:76
31066 "Expand wildcards in any paths in the args list, and run C<command> "
31067 "repeatedly on each matching path."
31072 #: ../fish/guestfish-commands.pod:79
31073 msgid "See L</WILDCARDS AND GLOBBING>."
31078 #: ../fish/guestfish-commands.pod:81
31084 #: ../fish/guestfish-commands.pod:83
31087 " hexedit <filename|device>\n"
31088 " hexedit <filename|device> <max>\n"
31089 " hexedit <filename|device> <start> <max>\n"
31095 #: ../fish/guestfish-commands.pod:87
31097 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31103 #: ../fish/guestfish-commands.pod:90
31105 "This command works by downloading potentially the whole file or device, "
31106 "editing it locally, then uploading it. If the file or device is large, you "
31107 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31108 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31109 "usual modifiers allowed such as C<1M> (1 megabyte)."
31114 #: ../fish/guestfish-commands.pod:97
31115 msgid "For example to edit the first few sectors of a disk you might do:"
31120 #: ../fish/guestfish-commands.pod:100
31123 " hexedit /dev/sda 1M\n"
31129 #: ../fish/guestfish-commands.pod:102
31131 "which would allow you to edit anywhere within the first megabyte of the disk."
31136 #: ../fish/guestfish-commands.pod:105
31137 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31142 #: ../fish/guestfish-commands.pod:107
31145 " hexedit /dev/sda1 0x400 0x400\n"
31151 #: ../fish/guestfish-commands.pod:109
31152 msgid "(assuming the superblock is in the standard location)."
31157 #: ../fish/guestfish-commands.pod:111
31159 "This command requires the external L<hexedit(1)> program. You can specify "
31160 "another program to use by setting the C<HEXEDITOR> environment variable."
31165 #: ../fish/guestfish-commands.pod:115
31166 msgid "See also L</hexdump>."
31171 #: ../fish/guestfish-commands.pod:117
31177 #: ../fish/guestfish-commands.pod:119
31186 #: ../fish/guestfish-commands.pod:121
31188 "Change the local directory, ie. the current directory of guestfish itself."
31193 #: ../fish/guestfish-commands.pod:124
31194 msgid "Note that C<!cd> won't do what you might expect."
31199 #: ../fish/guestfish-commands.pod:126
31205 #: ../fish/guestfish-commands.pod:128
31211 #: ../fish/guestfish-commands.pod:130
31220 #: ../fish/guestfish-commands.pod:132
31221 msgid "Opens the manual page for guestfish."
31226 #: ../fish/guestfish-commands.pod:134
31232 #: ../fish/guestfish-commands.pod:136
31238 #: ../fish/guestfish-commands.pod:138
31247 #: ../fish/guestfish-commands.pod:140
31256 #: ../fish/guestfish-commands.pod:142
31257 msgid "This is used to view a file."
31262 #: ../fish/guestfish-commands.pod:144
31264 "The default viewer is C<$PAGER>. However if you use the alternate command "
31265 "C<less> you will get the C<less> command specifically."
31270 #: ../fish/guestfish-commands.pod:147
31276 #: ../fish/guestfish-commands.pod:149
31285 #: ../fish/guestfish-commands.pod:151
31287 "Close and reopen the libguestfs handle. It is not necessary to use this "
31288 "normally, because the handle is closed properly when guestfish exits. "
31289 "However this is occasionally useful for testing."
31294 #: ../fish/guestfish-commands.pod:155
31300 #: ../fish/guestfish-commands.pod:157
31303 " sparse filename size\n"
31309 #: ../fish/guestfish-commands.pod:159
31311 "This creates an empty sparse file of the given size, and then adds so it can "
31312 "be further examined."
31317 #: ../fish/guestfish-commands.pod:162
31319 "In all respects it works the same as the L</alloc> command, except that the "
31320 "image file is allocated sparsely, which means that disk blocks are not "
31321 "assigned to the file until they are needed. Sparse disk files only use "
31322 "space when written to, but they are slower and there is a danger you could "
31323 "run out of real disk space during a write operation."
31328 #: ../fish/guestfish-commands.pod:172
31334 #: ../fish/guestfish-commands.pod:174
31343 #: ../fish/guestfish-commands.pod:176
31345 "This command returns a list of the optional groups known to the daemon, and "
31346 "indicates which ones are supported by this build of the libguestfs appliance."
31351 #: ../fish/guestfish-commands.pod:180
31352 msgid "See also L<guestfs(3)/AVAILABILITY>."
31357 #: ../fish/guestfish-commands.pod:182
31363 #: ../fish/guestfish-commands.pod:184
31366 " time command args...\n"
31372 #: ../fish/guestfish-commands.pod:186
31374 "Run the command as usual, but print the elapsed time afterwards. This can "
31375 "be useful for benchmarking operations."
31380 #: ../test-tool/libguestfs-test-tool.pod:5
31381 msgid "libguestfs-test-tool - End user tests for libguestfs"
31386 #: ../test-tool/libguestfs-test-tool.pod:9
31389 " libguestfs-test-tool [--options]\n"
31395 #: ../test-tool/libguestfs-test-tool.pod:13
31397 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31398 "and developers, to allow them to check basic libguestfs functionality is "
31399 "working. This is needed because libguestfs occasionally breaks for reasons "
31400 "beyond our control: usually because of changes in the underlying qemu or "
31401 "kernel packages, or the host environment."
31406 #: ../test-tool/libguestfs-test-tool.pod:20
31407 msgid "If you suspect a problem in libguestfs, then just run:"
31412 #: ../test-tool/libguestfs-test-tool.pod:22
31415 " libguestfs-test-tool\n"
31421 #: ../test-tool/libguestfs-test-tool.pod:24
31422 msgid "It will print lots of diagnostic messages."
31427 #: ../test-tool/libguestfs-test-tool.pod:26
31428 msgid "If it runs to completion successfully, you will see this near the end:"
31433 #: ../test-tool/libguestfs-test-tool.pod:28
31436 " ===== TEST FINISHED OK =====\n"
31442 #: ../test-tool/libguestfs-test-tool.pod:30
31443 msgid "and the test tool will exit with code 0."
31448 #: ../test-tool/libguestfs-test-tool.pod:32
31450 "If it fails (and/or exits with non-zero error code), please paste the "
31451 "B<complete, unedited> output of the test tool into a bug report. More "
31452 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31458 #: ../test-tool/libguestfs-test-tool.pod:41
31464 #: ../test-tool/libguestfs-test-tool.pod:43
31465 msgid "Display short usage information and exit."
31470 #: ../test-tool/libguestfs-test-tool.pod:45
31471 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
31476 #: ../test-tool/libguestfs-test-tool.pod:47
31478 "Pass an alternate name for the helper program. libguestfs-test-tool will "
31479 "normally look in the C<$libexec> directory that was configured when the tool "
31485 #: ../test-tool/libguestfs-test-tool.pod:51
31486 msgid "I<--qemu qemu_binary>"
31491 #: ../test-tool/libguestfs-test-tool.pod:53
31493 "If you have downloaded another qemu binary, point this option at the full "
31494 "path of the binary to try it."
31499 #: ../test-tool/libguestfs-test-tool.pod:56
31500 msgid "I<--qemudir qemu_source_dir>"
31505 #: ../test-tool/libguestfs-test-tool.pod:58
31507 "If you have compiled qemu from source, point this option at the source "
31508 "directory to try it."
31513 #: ../test-tool/libguestfs-test-tool.pod:61
31514 msgid "I<--timeout N>"
31519 #: ../test-tool/libguestfs-test-tool.pod:63
31521 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31522 "does not usually need to be adjusted unless your machine is very slow."
31527 #: ../test-tool/libguestfs-test-tool.pod:69
31528 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31533 #: ../test-tool/libguestfs-test-tool.pod:71
31535 "If you have compiled another version of qemu from source and would like to "
31536 "try that, then you can use the I<--qemudir> option to point to the qemu "
31537 "source directory."
31542 #: ../test-tool/libguestfs-test-tool.pod:75
31544 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
31545 "option to point to the binary."
31550 #: ../test-tool/libguestfs-test-tool.pod:78
31552 "When using an alternate qemu with libguestfs, usually you would need to "
31553 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
31554 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
31555 "use either of the I<--qemudir> or I<--qemu> options."
31560 #: ../test-tool/libguestfs-test-tool.pod:85
31562 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
31563 "I<1> if there was an error."
31568 #: ../test-tool/libguestfs-test-tool.pod:92
31569 msgid "/usr/libexec/libguestfs-test-tool-helper"
31574 #: ../test-tool/libguestfs-test-tool.pod:94
31576 "This helper program is run inside the appliance and provides additional "
31582 #: ../test-tool/libguestfs-test-tool.pod:97
31583 msgid "/usr/bin/mkisofs"
31588 #: ../test-tool/libguestfs-test-tool.pod:99
31590 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
31591 "which is used as part of the tests."
31596 #: ../test-tool/libguestfs-test-tool.pod:106
31598 "For the full list of environment variables which may affect libguestfs, "
31599 "please see the L<guestfs(3)> manual page."
31604 #: ../test-tool/libguestfs-test-tool.pod:111
31605 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
31610 #: ../test-tool/libguestfs-test-tool.pod:121
31611 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
31616 #: ../fuse/guestmount.pod:5
31618 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
31623 #: ../fuse/guestmount.pod:9
31626 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
31632 #: ../fuse/guestmount.pod:11
31635 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
31641 #: ../fuse/guestmount.pod:13
31644 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
31650 #: ../fuse/guestmount.pod:17
31652 "You must I<not> use C<guestmount> in read-write mode on live virtual "
31653 "machines. If you do this, you risk disk corruption in the VM."
31658 #: ../fuse/guestmount.pod:22
31660 "The guestmount program can be used to mount virtual machine filesystems and "
31661 "other disk images on the host. It uses libguestfs for access to the guest "
31662 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
31663 "a mountable device."
31668 #: ../fuse/guestmount.pod:27
31670 "Along with other options, you have to give at least one device (I<-a> "
31671 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
31672 "option) or use the I<-i> inspection option. How this works is better "
31673 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
31679 #: ../fuse/guestmount.pod:33
31681 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
31682 "by you, and the filesystem will not be visible to any other users unless you "
31683 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
31684 "the filesystem, use the C<fusermount -u> command."
31689 #: ../fuse/guestmount.pod:41
31691 "For a typical Windows guest which has its main filesystem on the first "
31697 #: ../fuse/guestmount.pod:44
31700 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
31706 #: ../fuse/guestmount.pod:46
31708 "For a typical Linux guest which has a /boot filesystem on the first "
31709 "partition, and the root filesystem on a logical volume:"
31714 #: ../fuse/guestmount.pod:49
31717 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
31723 #: ../fuse/guestmount.pod:51
31724 msgid "To get libguestfs to detect guest mountpoints for you:"
31729 #: ../fuse/guestmount.pod:53
31732 " guestmount -a guest.img -i --ro /mnt\n"
31738 #: ../fuse/guestmount.pod:55
31739 msgid "For a libvirt guest called \"Guest\" you could do:"
31744 #: ../fuse/guestmount.pod:57
31747 " guestmount -d Guest -i --ro /mnt\n"
31753 #: ../fuse/guestmount.pod:59
31755 "If you don't know what filesystems are contained in a guest or disk image, "
31756 "use L<virt-filesystems(1)> first:"
31761 #: ../fuse/guestmount.pod:62
31764 " virt-filesystems MyGuest\n"
31770 #: ../fuse/guestmount.pod:64
31772 "If you want to trace the libguestfs calls but without excessive debugging "
31773 "information, we recommend:"
31778 #: ../fuse/guestmount.pod:67
31781 " guestmount [...] --trace /mnt\n"
31787 #: ../fuse/guestmount.pod:69
31788 msgid "If you want to debug the program, we recommend:"
31793 #: ../fuse/guestmount.pod:71
31796 " guestmount [...] --trace --verbose /mnt\n"
31802 #: ../fuse/guestmount.pod:77
31803 msgid "B<-a image> | B<--add image>"
31808 #: ../fuse/guestmount.pod:79
31809 msgid "Add a block device or virtual machine image."
31814 #: ../fuse/guestmount.pod:84
31815 msgid "B<-c URI> | B<--connect URI>"
31820 #: ../fuse/guestmount.pod:90
31821 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
31826 #: ../fuse/guestmount.pod:96
31827 msgid "B<--dir-cache-timeout N>"
31832 #: ../fuse/guestmount.pod:98
31834 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
31835 "seconds. The readdir cache [actually, there are several semi-independent "
31836 "caches] is populated after a readdir(2) call with the stat and extended "
31837 "attributes of the files in the directory, in anticipation that they will be "
31838 "requested soon after."
31843 #: ../fuse/guestmount.pod:104
31845 "There is also a different attribute cache implemented by FUSE (see the FUSE "
31846 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
31847 "requests, only cache existing ones."
31852 #: ../fuse/guestmount.pod:115
31853 msgid "B<--format=raw|qcow2|..> | B<--format>"
31858 #: ../fuse/guestmount.pod:122
31860 "If you have untrusted raw-format guest disk images, you should use this "
31861 "option to specify the disk format. This avoids a possible security problem "
31862 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
31863 "guestfs_add_drive_opts>."
31868 #: ../fuse/guestmount.pod:127
31869 msgid "B<--fuse-help>"
31874 #: ../fuse/guestmount.pod:129
31875 msgid "Display help on special FUSE options (see I<-o> below)."
31880 #: ../fuse/guestmount.pod:133
31881 msgid "Display brief help and exit."
31886 #: ../fuse/guestmount.pod:135
31887 msgid "B<-i> | B<--inspector>"
31892 #: ../fuse/guestmount.pod:151
31893 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
31898 #: ../fuse/guestmount.pod:153
31900 "Mount the named partition or logical volume on the given mountpoint B<in the "
31901 "guest> (this has nothing to do with mountpoints in the host)."
31906 #: ../fuse/guestmount.pod:156
31908 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
31909 "something on C</>."
31914 #: ../fuse/guestmount.pod:159
31915 msgid "B<-n> | B<--no-sync>"
31920 #: ../fuse/guestmount.pod:161
31922 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
31923 "unmounted. If you specify this option, then we don't attempt to sync the "
31924 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
31929 #: ../fuse/guestmount.pod:166
31930 msgid "B<-o option> | B<--option option>"
31935 #: ../fuse/guestmount.pod:168
31936 msgid "Pass extra options to FUSE."
31941 #: ../fuse/guestmount.pod:170
31943 "To get a list of all the extra options supported by FUSE, use the command "
31944 "below. Note that only the FUSE I<-o> options can be passed, and only some "
31945 "of them are a good idea."
31950 #: ../fuse/guestmount.pod:174
31953 " guestmount --fuse-help\n"
31959 #: ../fuse/guestmount.pod:176
31960 msgid "Some potentially useful FUSE options:"
31965 #: ../fuse/guestmount.pod:180
31966 msgid "B<-o allow_other>"
31971 #: ../fuse/guestmount.pod:182
31972 msgid "Allow other users to see the filesystem."
31977 #: ../fuse/guestmount.pod:184
31978 msgid "B<-o attr_timeout=N>"
31983 #: ../fuse/guestmount.pod:186
31984 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
31989 #: ../fuse/guestmount.pod:188
31990 msgid "B<-o kernel_cache>"
31995 #: ../fuse/guestmount.pod:190
31997 "Allow the kernel to cache files (reduces the number of reads that have to go "
31998 "through the L<guestfs(3)> API). This is generally a good idea if you can "
31999 "afford the extra memory usage."
32004 #: ../fuse/guestmount.pod:194
32005 msgid "B<-o uid=N> B<-o gid=N>"
32010 #: ../fuse/guestmount.pod:196
32012 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32013 "the chosen values."
32018 #: ../fuse/guestmount.pod:201
32019 msgid "B<-r> | B<--ro>"
32024 #: ../fuse/guestmount.pod:203
32026 "Add devices and mount everything read-only. Also disallow writes and make "
32027 "the disk appear read-only to FUSE."
32032 #: ../fuse/guestmount.pod:206
32034 "This is highly recommended if you are not going to edit the guest disk. If "
32035 "the guest is running and this option is I<not> supplied, then there is a "
32036 "strong risk of disk corruption in the guest. We try to prevent this from "
32037 "happening, but it is not always possible."
32042 #: ../fuse/guestmount.pod:211
32043 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32048 #: ../fuse/guestmount.pod:215
32049 msgid "Enable SELinux support for the guest."
32054 #: ../fuse/guestmount.pod:217
32055 msgid "B<-v> | B<--verbose>"
32060 #: ../fuse/guestmount.pod:219
32061 msgid "Enable verbose messages from underlying libguestfs."
32066 #: ../fuse/guestmount.pod:221
32067 msgid "B<-V> | B<--version>"
32072 #: ../fuse/guestmount.pod:223
32073 msgid "Display the program version and exit."
32078 #: ../fuse/guestmount.pod:225
32079 msgid "B<-w> | B<--rw>"
32084 #: ../fuse/guestmount.pod:227
32086 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
32087 "FOR READ AND WRITE>."
32092 #: ../fuse/guestmount.pod:230
32093 msgid "B<-x> | B<--trace>"
32098 #: ../fuse/guestmount.pod:232
32099 msgid "Trace libguestfs calls and entry into each FUSE function."
32104 #: ../fuse/guestmount.pod:234
32105 msgid "This also stops the daemon from forking into the background."
32110 #: ../fuse/guestmount.pod:240
32112 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32113 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32119 #: ../tools/virt-edit.pl:34
32120 msgid "virt-edit - Edit a file in a virtual machine"
32125 #: ../tools/virt-edit.pl:38
32128 " virt-edit [--options] domname file\n"
32134 #: ../tools/virt-edit.pl:40
32137 " virt-edit [--options] disk.img [disk.img ...] file\n"
32143 #: ../tools/virt-edit.pl:42
32146 " virt-edit [domname|disk.img] file -e 'expr'\n"
32152 #: ../tools/virt-edit.pl:46
32154 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32155 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32156 "doing this, but doesn't catch all cases."
32161 #: ../tools/virt-edit.pl:52
32163 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32164 "the named virtual machine (or disk image)."
32169 #: ../tools/virt-edit.pl:55
32171 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
32172 "you should look at the L<guestfish(1)> tool."
32177 #: ../tools/virt-edit.pl:60
32178 msgid "Edit the named files interactively:"
32183 #: ../tools/virt-edit.pl:62
32186 " virt-edit mydomain /boot/grub/grub.conf\n"
32192 #: ../tools/virt-edit.pl:64
32195 " virt-edit mydomain /etc/passwd\n"
32201 #: ../tools/virt-edit.pl:66
32203 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32204 "below). To change the init default level to 5:"
32209 #: ../tools/virt-edit.pl:70
32212 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32218 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106
32219 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32220 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32221 msgid "Display brief help."
32226 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114
32227 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
32228 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
32229 #: ../tools/virt-list-partitions.pl:72
32230 msgid "Display version number and exit."
32235 #: ../tools/virt-edit.pl:96
32236 msgid "B<--backup extension> | B<-b extension>"
32241 #: ../tools/virt-edit.pl:98
32243 "Create a backup of the original file I<in the guest disk image>. The backup "
32244 "has the original filename with C<extension> added."
32249 #: ../tools/virt-edit.pl:101
32251 "Usually the first character of C<extension> would be a dot C<.> so you would "
32257 #: ../tools/virt-edit.pl:104
32260 " virt-edit -b .orig [etc]\n"
32266 #: ../tools/virt-edit.pl:106
32267 msgid "By default, no backup file is made."
32272 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128
32273 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32274 #: ../tools/virt-list-partitions.pl:78
32275 msgid "B<--connect URI> | B<-c URI>"
32280 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130
32281 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32282 #: ../tools/virt-list-partitions.pl:80
32284 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32285 "to the default libvirt hypervisor."
32290 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133
32291 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32292 #: ../tools/virt-list-partitions.pl:83
32294 "If you specify guest block devices directly, then libvirt is not used at all."
32299 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140
32300 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
32301 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
32302 msgid "B<--format> raw"
32307 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142
32308 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32309 #: ../tools/virt-list-partitions.pl:92
32311 "Specify the format of disk images given on the command line. If this is "
32312 "omitted then the format is autodetected from the content of the disk image."
32317 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146
32318 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32319 #: ../tools/virt-list-partitions.pl:96
32321 "If disk images are requested from libvirt, then this program asks libvirt "
32322 "for this information. In this case, the value of the format parameter is "
32328 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150
32329 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
32330 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32331 #: ../tools/virt-list-partitions.pl:100
32333 "If working with untrusted raw-format guest disk images, you should ensure "
32334 "the format is always specified."
32339 #: ../tools/virt-edit.pl:141
32340 msgid "B<--expr EXPR> | B<-e EXPR>"
32345 #: ../tools/virt-edit.pl:143
32347 "Instead of launching the external editor, non-interactively apply the Perl "
32348 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32354 #: ../tools/virt-edit.pl:147
32356 "Be careful to properly quote the expression to prevent it from being altered "
32362 #: ../tools/virt-edit.pl:268
32363 msgid "NON-INTERACTIVE EDITING"
32368 #: ../tools/virt-edit.pl:270
32370 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32371 "administrator can interactively edit the file."
32376 #: ../tools/virt-edit.pl:273
32378 "There are two ways also to use C<virt-edit> from scripts in order to make "
32379 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32380 "like this, it's less error-prone to write scripts directly using the "
32381 "libguestfs API and Augeas for configuration file editing.)"
32386 #: ../tools/virt-edit.pl:279
32388 "The first method is to temporarily set C<$EDITOR> to any script or program "
32389 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32390 "update C<tmpfile> in place however it likes."
32395 #: ../tools/virt-edit.pl:283
32397 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
32398 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32399 "instances of C<foo> with C<bar> in a file:"
32404 #: ../tools/virt-edit.pl:287
32407 " virt-edit domname filename -e 's/foo/bar/'\n"
32413 #: ../tools/virt-edit.pl:289
32415 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32416 "For example to delete root's password you could do:"
32421 #: ../tools/virt-edit.pl:292
32424 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32430 #: ../tools/virt-edit.pl:294
32432 "What really happens is that the snippet is evaluated as a Perl expression "
32433 "for each line of the file. The line, including the final C<\\n>, is passed "
32434 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32439 #: ../tools/virt-edit.pl:299
32441 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32442 "C<apache> user account from the password file you can do:"
32447 #: ../tools/virt-edit.pl:302
32450 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32456 #: ../tools/virt-edit.pl:304
32458 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32459 "the end of the file is rather difficult this way since there is no concept "
32460 "of \"last line of the file\" - your expression just doesn't get called "
32461 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32467 #: ../tools/virt-edit.pl:310
32469 "The variable C<$lineno> contains the current line number. As is "
32470 "traditional, the first line in the file is number C<1>."
32475 #: ../tools/virt-edit.pl:313
32477 "The return value from the expression is ignored, but the expression may call "
32478 "C<die> in order to abort the whole program, leaving the original file "
32484 #: ../tools/virt-edit.pl:317
32486 "Remember when matching the end of a line that C<$_> may contain the final C<"
32487 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32488 "newline then neither of these. Thus to match or substitute some text at the "
32489 "end of a line, use this regular expression:"
32494 #: ../tools/virt-edit.pl:322
32497 " /some text(\\r?\\n)?$/\n"
32503 #: ../tools/virt-edit.pl:324
32505 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32506 "$_> itself (since that would remove all newlines from the file):"
32511 #: ../tools/virt-edit.pl:328
32514 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32520 #: ../tools/virt-edit.pl:334
32526 #: ../tools/virt-edit.pl:336
32528 "If set, this string is used as the editor. It may contain arguments, eg. C<"
32534 #: ../tools/virt-edit.pl:339
32535 msgid "If not set, C<vi> is used."
32540 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559
32541 #: ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182
32542 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
32543 #: ../tools/virt-list-partitions.pl:250
32544 msgid "SHELL QUOTING"
32549 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567
32550 #: ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184
32551 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
32552 #: ../tools/virt-list-partitions.pl:252
32554 "Libvirt guest names can contain arbitrary characters, some of which have "
32555 "meaning to the shell such as C<#> and space. You may need to quote or "
32556 "escape these characters on the command line. See the shell manual page L<sh"
32557 "(1)> for details."
32561 #: ../tools/virt-edit.pl:352
32563 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
32564 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
32565 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
32570 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598
32571 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202
32572 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
32573 #: ../tools/virt-list-partitions.pl:269
32579 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600
32580 #: ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204
32581 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
32582 #: ../tools/virt-list-partitions.pl:271
32583 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
32588 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
32589 msgid "Copyright (C) 2009-2010 Red Hat Inc."
32594 #: ../tools/virt-win-reg.pl:37
32596 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
32601 #: ../tools/virt-win-reg.pl:41
32604 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
32610 #: ../tools/virt-win-reg.pl:43
32613 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
32619 #: ../tools/virt-win-reg.pl:45
32622 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
32628 #: ../tools/virt-win-reg.pl:47
32631 " virt-win-reg --merge domname [input.reg ...]\n"
32637 #: ../tools/virt-win-reg.pl:49
32640 " virt-win-reg [--options] disk.img ... # instead of domname\n"
32646 #: ../tools/virt-win-reg.pl:53
32648 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
32649 "virtual machines. If you do this, you I<will> get irreversible disk "
32650 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
32651 "but doesn't catch all cases."
32656 #: ../tools/virt-win-reg.pl:58
32658 "Modifying the Windows Registry is an inherently risky operation. The format "
32659 "is deliberately obscure and undocumented, and Registry changes can leave the "
32660 "system unbootable. Therefore when using the C<--merge> option, make sure "
32661 "you have a reliable backup first."
32666 #: ../tools/virt-win-reg.pl:65
32668 "This program can export and merge Windows Registry entries from a Windows "
32674 #: ../tools/virt-win-reg.pl:68
32676 "The first parameter is the libvirt guest name or the raw disk image of a "
32682 #: ../tools/virt-win-reg.pl:71
32684 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
32685 "exported (recursively). For example:"
32690 #: ../tools/virt-win-reg.pl:74
32693 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
32699 #: ../tools/virt-win-reg.pl:76
32701 "You can also display single values from within registry keys, for example:"
32706 #: ../tools/virt-win-reg.pl:79
32709 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
32710 " $ virt-win-reg Windows7 $cvkey ProductName\n"
32711 " Windows 7 Enterprise\n"
32717 #: ../tools/virt-win-reg.pl:83
32719 "With C<--merge>, you can merge a textual regedit file into the Windows "
32725 #: ../tools/virt-win-reg.pl:86
32728 " $ virt-win-reg --merge Windows7 changes.reg\n"
32734 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
32740 #: ../tools/virt-win-reg.pl:90
32742 "This program is only meant for simple access to the registry. If you want "
32743 "to do complicated things with the registry, we suggest you download the "
32744 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
32745 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
32746 "L<hivexregedit(1)>."
32751 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
32757 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
32758 msgid "Enable debugging messages."
32763 #: ../tools/virt-win-reg.pl:157
32769 #: ../tools/virt-win-reg.pl:159
32771 "In merge mode, this merges a textual regedit file into the Windows Registry "
32772 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
32773 "displays or exports Registry entries instead."
32778 #: ../tools/virt-win-reg.pl:163
32780 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
32781 "result in disk corruption. However exporting (without this flag) is always "
32787 #: ../tools/virt-win-reg.pl:171
32788 msgid "B<--encoding> UTF-16LE|ASCII"
32793 #: ../tools/virt-win-reg.pl:173
32795 "When merging (only), you may need to specify the encoding for strings to be "
32796 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
32797 "(3)/ENCODING STRINGS>."
32802 #: ../tools/virt-win-reg.pl:177
32804 "The default is to use UTF-16LE, which should work with recent versions of "
32810 #: ../tools/virt-win-reg.pl:402
32811 msgid "SUPPORTED SYSTEMS"
32816 #: ../tools/virt-win-reg.pl:404
32818 "The program currently supports Windows NT-derived guests starting with "
32819 "Windows XP through to at least Windows 7."
32824 #: ../tools/virt-win-reg.pl:407
32826 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
32827 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
32828 "and C<HKEY_USERS\\.DEFAULT>."
32833 #: ../tools/virt-win-reg.pl:411
32835 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
32841 #: ../tools/virt-win-reg.pl:414
32843 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
32849 #: ../tools/virt-win-reg.pl:417
32855 #: ../tools/virt-win-reg.pl:419
32857 "C<virt-win-reg> expects that regedit files have already been reencoded in "
32858 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
32859 "style line endings. Since Windows regedit files are often in UTF-16LE with "
32860 "Windows-style line endings, you may need to reencode the whole file before "
32861 "or after processing."
32866 #: ../tools/virt-win-reg.pl:425
32868 "To reencode a file from Windows format to Linux (before processing it with "
32869 "the C<--merge> option), you would do something like this:"
32874 #: ../tools/virt-win-reg.pl:428
32877 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
32883 #: ../tools/virt-win-reg.pl:430
32885 "To go in the opposite direction, after exporting and before sending the file "
32886 "to a Windows user, do something like this:"
32891 #: ../tools/virt-win-reg.pl:433
32894 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
32900 #: ../tools/virt-win-reg.pl:435
32901 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
32906 #: ../tools/virt-win-reg.pl:437
32908 "If you are unsure about the current encoding, use the L<file(1)> command. "
32909 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
32910 "style (CRLF) line endings, like this:"
32915 #: ../tools/virt-win-reg.pl:441
32918 " $ file software.reg\n"
32919 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
32920 " with CRLF line terminators\n"
32926 #: ../tools/virt-win-reg.pl:445
32927 msgid "This file would need conversion before you could C<--merge> it."
32932 #: ../tools/virt-win-reg.pl:447
32933 msgid "CurrentControlSet etc."
32938 #: ../tools/virt-win-reg.pl:449
32940 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
32941 "Registry at the level of the hive file, and therefore you cannot modify "
32947 #: ../tools/virt-win-reg.pl:453
32949 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
32950 "circumstances it might refer to another control set. The way to find out is "
32951 "to look at the C<HKLM\\SYSTEM\\Select> key:"
32956 #: ../tools/virt-win-reg.pl:457
32959 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
32960 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
32961 " \"Current\"=dword:00000001\n"
32962 " \"Default\"=dword:00000001\n"
32963 " \"Failed\"=dword:00000000\n"
32964 " \"LastKnownGood\"=dword:00000002\n"
32970 #: ../tools/virt-win-reg.pl:464
32971 msgid "\"Current\" is the one which Windows will choose when it boots."
32976 #: ../tools/virt-win-reg.pl:466
32978 "Similarly, other C<Current...> keys in the path may need to be replaced."
32983 #: ../tools/virt-win-reg.pl:469
32984 msgid "WINDOWS TIPS"
32989 #: ../tools/virt-win-reg.pl:471
32991 "Note that some of these tips modify the guest disk image. The guest I<must> "
32992 "be shut off, else you will get disk corruption."
32997 #: ../tools/virt-win-reg.pl:474
32998 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33003 #: ../tools/virt-win-reg.pl:476
33005 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33006 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33007 "is uploaded into C<C:\\>:"
33012 #: ../tools/virt-win-reg.pl:480
33015 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33021 #: ../tools/virt-win-reg.pl:482
33022 msgid "Prepare a regedit file containing the registry change:"
33027 #: ../tools/virt-win-reg.pl:484
33030 " cat > test.reg <<'EOF'\n"
33031 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33032 " \"Test\"=\"c:\\\\test.bat\"\n"
33039 #: ../tools/virt-win-reg.pl:489
33041 "In this example we use the key C<RunOnce> which means that the script will "
33042 "run precisely once when the first user logs in. If you want it to run every "
33043 "time a user logs in, replace C<RunOnce> with C<Run>."
33048 #: ../tools/virt-win-reg.pl:493
33049 msgid "Now update the registry:"
33054 #: ../tools/virt-win-reg.pl:495
33057 " virt-win-reg --merge WindowsGuest test.reg\n"
33063 #: ../tools/virt-win-reg.pl:497
33064 msgid "INSTALLING A SERVICE"
33069 #: ../tools/virt-win-reg.pl:499
33071 "This section assumes you are familiar with Windows services, and you either "
33072 "have a program which handles the Windows Service Control Protocol directly "
33073 "or you want to run any program using a service wrapper like SrvAny or the "
33079 #: ../tools/virt-win-reg.pl:504
33081 "First upload the program and optionally the service wrapper. In this case "
33082 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33087 #: ../tools/virt-win-reg.pl:508
33090 " guestfish -i -d WindowsGuest <<EOF\n"
33091 " upload rhsrvany.exe /rhsrvany.exe\n"
33092 " upload test.exe /test.exe\n"
33099 #: ../tools/virt-win-reg.pl:513
33101 "Prepare a regedit file containing the registry changes. In this example, "
33102 "the first registry change is needed for the service itself or the service "
33103 "wrapper (if used). The second registry change is only needed because I am "
33104 "using the RHSrvAny service wrapper."
33109 #: ../tools/virt-win-reg.pl:518
33112 " cat > service.reg <<'EOF'\n"
33113 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33114 " \"Type\"=dword:00000010\n"
33115 " \"Start\"=dword:00000002\n"
33116 " \"ErrorControl\"=dword:00000001\n"
33117 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33118 " \"DisplayName\"=\"RHSrvAny\"\n"
33119 " \"ObjectName\"=\"NetworkService\"\n"
33125 #: ../tools/virt-win-reg.pl:527
33128 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33129 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33130 " \"PWD\"=\"c:\\\\Temp\"\n"
33137 #: ../tools/virt-win-reg.pl:538
33139 "For use of C<ControlSet001> see the section above in this manual page. You "
33140 "may need to adjust this according to the control set that is in use by the "
33146 #: ../tools/virt-win-reg.pl:544
33148 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33149 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33150 "privileged account."
33155 #: ../tools/virt-win-reg.pl:550
33157 "For the meaning of the magic numbers, see this Microsoft KB article: "
33158 "L<http://support.microsoft.com/kb/103000>."
33163 #: ../tools/virt-win-reg.pl:555
33164 msgid "Update the registry:"
33169 #: ../tools/virt-win-reg.pl:557
33172 " virt-win-reg --merge WindowsGuest service.reg\n"
33178 #: ../tools/virt-win-reg.pl:561
33180 "Be careful when passing parameters containing C<\\> (backslash) in the "
33181 "shell. Usually you will have to use 'single quotes' or double backslashes "
33182 "(but not both) to protect them from the shell."
33187 #: ../tools/virt-win-reg.pl:565
33188 msgid "Paths and value names are case-insensitive."
33193 #: ../tools/virt-win-reg.pl:574
33195 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33196 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33197 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33202 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33204 "When reporting bugs, please enable debugging and capture the I<complete> "
33210 #: ../tools/virt-win-reg.pl:592
33213 " export LIBGUESTFS_DEBUG=1\n"
33214 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33220 #: ../tools/virt-win-reg.pl:595
33222 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33228 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516
33229 #: ../tools/virt-make-fs.pl:570
33230 msgid "Copyright (C) 2010 Red Hat Inc."
33235 #: ../tools/virt-resize.pl:42
33236 msgid "virt-resize - Resize a virtual machine disk"
33241 #: ../tools/virt-resize.pl:46
33244 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
33245 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
33246 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
33252 #: ../tools/virt-resize.pl:52
33254 "Virt-resize is a tool which can resize a virtual machine disk, making it "
33255 "larger or smaller overall, and resizing or deleting any partitions contained "
33261 #: ../tools/virt-resize.pl:56
33263 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
33264 "not> be used on live virtual machines - for consistent results, shut the "
33265 "virtual machine down before resizing it."
33270 #: ../tools/virt-resize.pl:60
33272 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
33273 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
33278 #: ../tools/virt-resize.pl:66
33280 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
33281 "fill the extra 5GB of space."
33285 #: ../tools/virt-resize.pl:69
33288 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
33289 " virt-filesystems --long -h --all -a olddisk\n"
33290 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
33291 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
33297 #: ../tools/virt-resize.pl:74
33299 "As above, but make the /boot partition 200MB bigger, while giving the "
33300 "remaining space to /dev/sda2:"
33305 #: ../tools/virt-resize.pl:77
33308 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
33314 #: ../tools/virt-resize.pl:79
33315 msgid "As above, but the output format will be uncompressed qcow2:"
33320 #: ../tools/virt-resize.pl:81
33323 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
33324 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
33330 #: ../tools/virt-resize.pl:84
33331 msgid "DETAILED USAGE"
33336 #: ../tools/virt-resize.pl:86
33337 msgid "EXPANDING A VIRTUAL MACHINE DISK"
33342 #: ../tools/virt-resize.pl:90
33343 msgid "1. Shut down the virtual machine"
33348 #: ../tools/virt-resize.pl:92
33349 msgid "2. Locate input disk image"
33354 #: ../tools/virt-resize.pl:94
33356 "Locate the input disk image (ie. the file or device on the host containing "
33357 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
33358 "dumpxml> like this to find the disk image name:"
33363 #: ../tools/virt-resize.pl:98
33366 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
33367 " Found 1 nodes:\n"
33369 " <source dev=\"/dev/vg/lv_guest\" />\n"
33375 #: ../tools/virt-resize.pl:103
33376 msgid "3. Look at current sizing"
33381 #: ../tools/virt-resize.pl:105
33382 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
33387 #: ../tools/virt-resize.pl:108
33390 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
33391 " Name Type Size Parent\n"
33392 " /dev/sda1 partition 101M /dev/sda\n"
33393 " /dev/sda2 partition 7.9G /dev/sda\n"
33394 " /dev/sda device 8.0G -\n"
33400 #: ../tools/virt-resize.pl:114
33402 "(This example is a virtual machine with an 8 GB disk which we would like to "
33403 "expand up to 10 GB)."
33408 #: ../tools/virt-resize.pl:117
33409 msgid "4. Create output disk"
33414 #: ../tools/virt-resize.pl:119
33416 "Virt-resize cannot do in-place disk modifications. You have to have space "
33417 "to store the resized output disk."
33422 #: ../tools/virt-resize.pl:122
33424 "To store the resized disk image in a file, create a file of a suitable size:"
33429 #: ../tools/virt-resize.pl:125
33432 " # rm -f outdisk\n"
33433 " # truncate -s 10G outdisk\n"
33439 #: ../tools/virt-resize.pl:128
33440 msgid "Or use L<lvcreate(1)> to create a logical volume:"
33445 #: ../tools/virt-resize.pl:130
33448 " # lvcreate -L 10G -n lv_name vg_name\n"
33454 #: ../tools/virt-resize.pl:132
33455 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
33460 #: ../tools/virt-resize.pl:134
33463 " # virsh pool-list\n"
33464 " # virsh vol-create-as poolname newvol 10G\n"
33470 #: ../tools/virt-resize.pl:137
33476 #: ../tools/virt-resize.pl:139
33478 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
33479 "file) and the output disk. The output disk is the one created in the "
33485 #: ../tools/virt-resize.pl:143
33488 " # virt-resize indisk outdisk\n"
33494 #: ../tools/virt-resize.pl:145
33496 "This command just copies disk image C<indisk> to disk image C<outdisk> "
33497 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
33498 "larger, then an extra, empty partition is created at the end of the disk "
33499 "covering the extra space. If C<outdisk> is smaller, then it will give an "
33505 #: ../tools/virt-resize.pl:151
33507 "More realistically you'd want to expand existing partitions in the disk "
33508 "image by passing extra options (for the full list see the L</OPTIONS> "
33514 #: ../tools/virt-resize.pl:155
33516 "L</--expand> is the most useful option. It expands the named partition "
33517 "within the disk to fill any extra space:"
33522 #: ../tools/virt-resize.pl:158
33525 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
33531 #: ../tools/virt-resize.pl:160
33533 "(In this case, an extra partition is I<not> created at the end of the disk, "
33534 "because there will be no unused space)."
33539 #: ../tools/virt-resize.pl:163
33541 "L</--resize> is the other commonly used option. The following would "
33542 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
33543 "rest of the available space:"
33548 #: ../tools/virt-resize.pl:167
33551 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
33552 " indisk outdisk\n"
33558 #: ../tools/virt-resize.pl:170
33560 "If the expanded partition in the image contains a filesystem or LVM PV, then "
33561 "if virt-resize knows how, it will resize the contents, the equivalent of "
33562 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
33563 ">. However virt-resize does not know how to resize some filesystems, so you "
33564 "would have to online resize them after booting the guest."
33569 #: ../tools/virt-resize.pl:177
33570 msgid "Other options are covered below."
33575 #: ../tools/virt-resize.pl:179
33581 #: ../tools/virt-resize.pl:181
33582 msgid "Thoroughly test the new disk image I<before> discarding the old one."
33587 #: ../tools/virt-resize.pl:183
33588 msgid "If you are using libvirt, edit the XML to point at the new disk:"
33593 #: ../tools/virt-resize.pl:185
33596 " # virsh edit guestname\n"
33602 #: ../tools/virt-resize.pl:187
33604 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
33605 "html#elementsDisks>"
33610 #: ../tools/virt-resize.pl:190
33611 msgid "Then start up the domain with the new, resized disk:"
33616 #: ../tools/virt-resize.pl:192
33619 " # virsh start guestname\n"
33625 #: ../tools/virt-resize.pl:194
33627 "and check that it still works. See also the L</NOTES> section below for "
33628 "additional information."
33633 #: ../tools/virt-resize.pl:197
33634 msgid "7. Resize LVs etc inside the guest"
33639 #: ../tools/virt-resize.pl:199
33640 msgid "(This can also be done offline using L<guestfish(1)>)"
33645 #: ../tools/virt-resize.pl:201
33647 "Once the guest has booted you should see the new space available, at least "
33648 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
33649 "may need to resize LVs inside PVs, and also resize filesystem types that "
33650 "virt-resize does not know how to expand."
33655 #: ../tools/virt-resize.pl:208
33656 msgid "SHRINKING A VIRTUAL MACHINE DISK"
33661 #: ../tools/virt-resize.pl:210
33663 "Shrinking is somewhat more complex than expanding, and only an overview is "
33669 #: ../tools/virt-resize.pl:213
33671 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
33672 "filesystems). The user has to shrink content before passing the disk image "
33673 "to virt-resize, and virt-resize will check that the content has been shrunk "
33679 #: ../tools/virt-resize.pl:218
33680 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
33685 #: ../tools/virt-resize.pl:220
33687 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
33688 "steps 3 and 4 above to allocate a new disk image."
33693 #: ../tools/virt-resize.pl:223
33695 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
33700 #: ../tools/virt-resize.pl:226
33701 msgid "IGNORING OR DELETING PARTITIONS"
33706 #: ../tools/virt-resize.pl:228
33708 "virt-resize also gives a convenient way to ignore or delete partitions when "
33709 "copying from the input disk to the output disk. Ignoring a partition speeds "
33710 "up the copy where you don't care about the existing contents of a "
33711 "partition. Deleting a partition removes it completely, but note that it "
33712 "also renumbers any partitions after the one which is deleted, which can "
33713 "leave some guests unbootable."
33718 #: ../tools/virt-resize.pl:235
33719 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
33724 #: ../tools/virt-resize.pl:237
33726 "If the input disk is in qcow2 format, then you may prefer that the output is "
33727 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
33728 "the fly. The output format is simply determined by the format of the empty "
33729 "output container that you provide. Thus to create qcow2 output, use:"
33734 #: ../tools/virt-resize.pl:243
33737 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
33743 #: ../tools/virt-resize.pl:245
33744 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
33749 #: ../tools/virt-resize.pl:247
33750 msgid "Similarly, to get non-sparse raw output use:"
33755 #: ../tools/virt-resize.pl:249
33758 " fallocate -l size outdisk\n"
33764 #: ../tools/virt-resize.pl:251
33766 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
33767 "dev/zero of=outdisk bs=1M count=..>)"
33772 #: ../tools/virt-resize.pl:264
33773 msgid "Display help."
33778 #: ../tools/virt-resize.pl:278
33779 msgid "B<--resize part=size>"
33784 #: ../tools/virt-resize.pl:280
33786 "Resize the named partition (expanding or shrinking it) so that it has the "
33792 #: ../tools/virt-resize.pl:283
33794 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
33795 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
33796 "Exabytes; or as a percentage of the current size; or as a relative number or "
33797 "percentage. For example:"
33802 #: ../tools/virt-resize.pl:288
33805 " --resize /dev/sda2=10G\n"
33811 #: ../tools/virt-resize.pl:290
33814 " --resize /dev/sda4=90%\n"
33820 #: ../tools/virt-resize.pl:292
33823 " --resize /dev/sda2=+1G\n"
33829 #: ../tools/virt-resize.pl:294
33832 " --resize /dev/sda2=-200M\n"
33838 #: ../tools/virt-resize.pl:296
33841 " --resize /dev/sda1=+128K\n"
33847 #: ../tools/virt-resize.pl:298
33850 " --resize /dev/sda1=+10%\n"
33856 #: ../tools/virt-resize.pl:300
33859 " --resize /dev/sda1=-10%\n"
33865 #: ../tools/virt-resize.pl:302
33867 "You can increase the size of any partition. Virt-resize will expand the "
33868 "direct content of the partition if it knows how (see C<--expand> below)."
33873 #: ../tools/virt-resize.pl:306
33875 "You can only I<decrease> the size of partitions that contain filesystems or "
33876 "PVs which have already been shrunk. Virt-resize will check this has been "
33877 "done before proceeding, or else will print an error (see also C<--resize-"
33883 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
33884 #: ../tools/virt-resize.pl:420
33885 msgid "You can give this option multiple times."
33890 #: ../tools/virt-resize.pl:317
33891 msgid "B<--resize-force part=size>"
33896 #: ../tools/virt-resize.pl:319
33898 "This is the same as C<--resize> except that it will let you decrease the "
33899 "size of any partition. Generally this means you will lose any data which "
33900 "was at the end of the partition you shrink, but you may not care about that "
33901 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
33902 "as a swap partition)."
33907 #: ../tools/virt-resize.pl:325
33908 msgid "See also the C<--ignore> option."
33913 #: ../tools/virt-resize.pl:331
33914 msgid "B<--expand part>"
33919 #: ../tools/virt-resize.pl:333
33921 "Expand the named partition so it uses up all extra space (space left over "
33922 "after any other resize changes that you request have been done)."
33927 #: ../tools/virt-resize.pl:336
33929 "If virt-resize knows how, it will expand the direct content of the "
33930 "partition. For example, if the partition is an LVM PV, it will expand the "
33931 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
33932 "content it doesn't know about alone."
33937 #: ../tools/virt-resize.pl:341
33938 msgid "Currently virt-resize can resize:"
33943 #: ../tools/virt-resize.pl:347
33945 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
33951 #: ../tools/virt-resize.pl:352
33953 "NTFS filesystems contained directly in a partition, if libguestfs was "
33954 "compiled with support for NTFS."
33959 #: ../tools/virt-resize.pl:355
33961 "The filesystem must have been shut down consistently last time it was used. "
33962 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
33963 "consistency check, so at the first boot after resizing Windows will check "
33969 #: ../tools/virt-resize.pl:362
33971 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
33972 "inside the PV, but see the C<--LV-expand> option. The user could also "
33973 "resize LVs as desired after boot."
33978 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
33979 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
33984 #: ../tools/virt-resize.pl:374
33985 msgid "B<--shrink part>"
33990 #: ../tools/virt-resize.pl:376
33992 "Shrink the named partition until the overall disk image fits in the "
33993 "destination. The named partition B<must> contain a filesystem or PV which "
33994 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
33995 "online tools). Virt-resize will check this and give an error if it has not "
34001 #: ../tools/virt-resize.pl:382
34003 "The amount by which the overall disk must be shrunk (after carrying out all "
34004 "other operations requested by the user) is called the \"deficit\". For "
34005 "example, a straight copy (assume no other operations) from a 5GB disk image "
34006 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
34007 "would give an error unless the user specified a partition to shrink and that "
34008 "partition had more than a gigabyte of free space."
34013 #: ../tools/virt-resize.pl:396
34014 msgid "B<--ignore part>"
34019 #: ../tools/virt-resize.pl:398
34021 "Ignore the named partition. Effectively this means the partition is "
34022 "allocated on the destination disk, but the content is not copied across from "
34023 "the source disk. The content of the partition will be blank (all zero "
34029 #: ../tools/virt-resize.pl:409
34030 msgid "B<--delete part>"
34035 #: ../tools/virt-resize.pl:411
34037 "Delete the named partition. It would be more accurate to describe this as "
34038 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
34039 "the original disk image is left intact."
34044 #: ../tools/virt-resize.pl:415
34046 "Note that when you delete a partition, then anything contained in the "
34047 "partition is also deleted. Furthermore, this causes any partitions that "
34048 "come after to be I<renumbered>, which can easily make your guest unbootable."
34053 #: ../tools/virt-resize.pl:426
34054 msgid "B<--LV-expand logvol>"
34059 #: ../tools/virt-resize.pl:428
34061 "This takes the logical volume and, as a final step, expands it to fill all "
34062 "the space available in its volume group. A typical usage, assuming a Linux "
34063 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
34064 "lv_root> would be:"
34069 #: ../tools/virt-resize.pl:433
34072 " virt-resize indisk outdisk \\\n"
34073 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
34079 #: ../tools/virt-resize.pl:436
34081 "This would first expand the partition (and PV), and then expand the root "
34082 "device to fill the extra space in the PV."
34087 #: ../tools/virt-resize.pl:439
34089 "The contents of the LV are also resized if virt-resize knows how to do "
34090 "that. You can stop virt-resize from trying to expand the content by using "
34091 "the option C<--no-expand-content>."
34096 #: ../tools/virt-resize.pl:443
34097 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
34102 #: ../tools/virt-resize.pl:446
34104 "You can give this option multiple times, I<but> it doesn't make sense to do "
34105 "this unless the logical volumes you specify are all in different volume "
34111 #: ../tools/virt-resize.pl:454
34112 msgid "B<--no-copy-boot-loader>"
34117 #: ../tools/virt-resize.pl:456
34119 "By default, virt-resize copies over some sectors at the start of the disk "
34120 "(up to the beginning of the first partition). Commonly these sectors "
34121 "contain the Master Boot Record (MBR) and the boot loader, and are required "
34122 "in order for the guest to boot correctly."
34127 #: ../tools/virt-resize.pl:461
34129 "If you specify this flag, then this initial copy is not done. You may need "
34130 "to reinstall the boot loader in this case."
34135 #: ../tools/virt-resize.pl:469
34136 msgid "B<--no-extra-partition>"
34141 #: ../tools/virt-resize.pl:471
34143 "By default, virt-resize creates an extra partition if there is any extra, "
34144 "unused space after all resizing has happened. Use this option to prevent "
34145 "the extra partition from being created. If you do this then the extra space "
34146 "will be inaccessible until you run fdisk, parted, or some other partitioning "
34147 "tool in the guest."
34152 #: ../tools/virt-resize.pl:477
34154 "Note that if the surplus space is smaller than 10 MB, no extra partition "
34160 #: ../tools/virt-resize.pl:484
34161 msgid "B<--no-expand-content>"
34166 #: ../tools/virt-resize.pl:486
34168 "By default, virt-resize will try to expand the direct contents of "
34169 "partitions, if it knows how (see C<--expand> option above)."
34174 #: ../tools/virt-resize.pl:489
34176 "If you give the C<--no-expand-content> option then virt-resize will not "
34182 #: ../tools/virt-resize.pl:496
34183 msgid "B<-d> | B<--debug>"
34188 #: ../tools/virt-resize.pl:504
34189 msgid "B<-n> | B<--dryrun>"
34194 #: ../tools/virt-resize.pl:506
34195 msgid "Print a summary of what would be done, but don't do anything."
34200 #: ../tools/virt-resize.pl:512
34201 msgid "B<-q> | B<--quiet>"
34206 #: ../tools/virt-resize.pl:514
34207 msgid "Don't print the summary."
34212 #: ../tools/virt-resize.pl:522
34214 "Specify the format of the input disk image. If this flag is not given then "
34215 "it is auto-detected from the image itself."
34220 #: ../tools/virt-resize.pl:528
34222 "Note that this option I<does not> affect the output format. See L</QCOW2 "
34223 "AND NON-SPARSE RAW FORMATS>."
34228 #: ../tools/virt-resize.pl:535
34229 msgid "B<--output-format> raw"
34234 #: ../tools/virt-resize.pl:537
34236 "Specify the format of the output disk image. If this flag is not given then "
34237 "it is auto-detected from the image itself."
34242 #: ../tools/virt-resize.pl:543
34244 "Note that you still need to create the output disk with the right format. "
34245 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
34250 #: ../tools/virt-resize.pl:1425
34256 #: ../tools/virt-resize.pl:1427
34257 msgid "\"Partition 1 does not end on cylinder boundary.\""
34262 #: ../tools/virt-resize.pl:1429
34264 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
34265 "means the partitions will not be aligned to the ancient CHS geometry. "
34266 "However CHS geometry is meaningless for disks manufactured since the early "
34267 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
34268 "cylinders is not required by any modern operating system."
34273 #: ../tools/virt-resize.pl:1436
34274 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
34279 #: ../tools/virt-resize.pl:1438
34281 "In Windows Vista and later versions, Microsoft switched to using a separate "
34282 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
34283 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
34284 "the boot partition. Doing so seems to break the guest completely. However "
34285 "expanding the second partition (ie. C: drive) should work."
34290 #: ../tools/virt-resize.pl:1445
34292 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
34293 "NTFS partitions have been expanded. This is just a safety check and (unless "
34294 "it find errors) is nothing to worry about."
34299 #: ../tools/virt-resize.pl:1449
34300 msgid "GUEST BOOT STUCK AT \"GRUB\""
34305 #: ../tools/virt-resize.pl:1451
34307 "If a Linux guest does not boot after resizing, and the boot is stuck after "
34308 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
34309 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
34310 "although we think is to do with partition alignment."
34315 #: ../tools/virt-resize.pl:1456
34318 " guestfish -i -a newdisk\n"
34319 " ><fs> cat /boot/grub/device.map\n"
34320 " # check the contents of this file are sensible or\n"
34321 " # edit the file if necessary\n"
34322 " ><fs> grub-install / /dev/vda\n"
34329 #: ../tools/virt-resize.pl:1463
34331 "For more flexible guest reconfiguration, including if you need to specify "
34332 "other parameters to grub-install, use L<virt-rescue(1)>."
34337 #: ../tools/virt-resize.pl:1466
34338 msgid "ALTERNATIVE TOOLS"
34343 #: ../tools/virt-resize.pl:1468
34345 "There are several proprietary tools for resizing partitions. We won't "
34346 "mention any here."
34351 #: ../tools/virt-resize.pl:1471
34353 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
34354 "operations on disk images. They can resize and move partitions, but I don't "
34355 "think they can do anything with the contents, and they certainly don't "
34361 #: ../tools/virt-resize.pl:1476
34363 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
34364 "but at a much lower level. You will probably end up hand-calculating sector "
34365 "offsets, which is something that virt-resize was designed to avoid. If you "
34366 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
34372 #: ../tools/virt-resize.pl:1491
34374 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
34375 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
34376 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
34377 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
34378 "libguestfs.org/>."
34383 #: ../tools/virt-list-filesystems.pl:32
34385 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34390 #: ../tools/virt-list-filesystems.pl:36
34393 " virt-list-filesystems [--options] domname\n"
34399 #: ../tools/virt-list-filesystems.pl:38
34402 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34408 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34410 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34416 #: ../tools/virt-list-filesystems.pl:45
34418 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34419 "are contained in a virtual machine or disk image."
34424 #: ../tools/virt-list-filesystems.pl:49
34426 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34427 "functionality. For more complex cases you should look at the L<guestfish(1)"
34433 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34434 msgid "B<-l> | B<--long>"
34439 #: ../tools/virt-list-filesystems.pl:108
34441 "With this option, C<virt-list-filesystems> displays the type of each "
34442 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34447 #: ../tools/virt-list-filesystems.pl:115
34448 msgid "B<-a> | B<--all>"
34453 #: ../tools/virt-list-filesystems.pl:117
34455 "Normally we only show mountable filesystems. If this option is given then "
34456 "swap devices are shown too."
34461 #: ../tools/virt-list-filesystems.pl:191
34463 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34464 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34465 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34470 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34471 msgid "Copyright (C) 2009 Red Hat Inc."
34476 #: ../tools/virt-tar.pl:33
34477 msgid "virt-tar - Extract or upload files to a virtual machine"
34482 #: ../tools/virt-tar.pl:37
34485 " virt-tar [--options] -x domname directory tarball\n"
34491 #: ../tools/virt-tar.pl:39
34494 " virt-tar [--options] -u domname tarball directory\n"
34500 #: ../tools/virt-tar.pl:41
34503 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34509 #: ../tools/virt-tar.pl:43
34512 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34517 #: ../tools/virt-tar.pl:47
34519 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34520 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34525 #: ../tools/virt-tar.pl:52
34526 msgid "Download C</home> from the VM into a local tarball:"
34531 #: ../tools/virt-tar.pl:54
34534 " virt-tar -x domname /home home.tar\n"
34540 #: ../tools/virt-tar.pl:56
34543 " virt-tar -zx domname /home home.tar.gz\n"
34549 #: ../tools/virt-tar.pl:58
34550 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34555 #: ../tools/virt-tar.pl:60
34558 " virt-tar -u domname uploadstuff.tar /tmp\n"
34564 #: ../tools/virt-tar.pl:62
34567 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34573 #: ../tools/virt-tar.pl:66
34575 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
34576 "virtual machines. If you do this, you risk disk corruption in the VM. "
34577 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34582 #: ../tools/virt-tar.pl:71
34584 "You can use C<-x> (extract) on live virtual machines, but you might get "
34585 "inconsistent results or errors if there is filesystem activity inside the "
34586 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34587 "work, but the only way to guarantee consistent results is if the virtual "
34588 "machine is shut down."
34593 #: ../tools/virt-tar.pl:79
34595 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34596 "parts of a guest filesystem. There are many possibilities: making backups, "
34597 "uploading data files, snooping on guest activity, fixing or customizing "
34603 #: ../tools/virt-tar.pl:84
34605 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34606 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34607 "should look at the L<guestfish(1)> tool."
34612 #: ../tools/virt-tar.pl:88
34614 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
34615 "its contents (recursively) from the virtual machine into a local tarball. "
34616 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
34617 "virtual machine. You cannot use these two options together."
34622 #: ../tools/virt-tar.pl:94
34624 "In addition, you may need to use the C<-z> (gZip) option to enable "
34625 "compression. When uploading, you have to specify C<-z> if the upload file "
34626 "is compressed because virt-tar won't detect this on its own."
34631 #: ../tools/virt-tar.pl:98
34633 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34634 "example it cannot do PKZip files or bzip2 compression. If you want that "
34635 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34636 "the L<libguestfs(3)> API)."
34641 #: ../tools/virt-tar.pl:156
34642 msgid "B<-x> | B<--extract> | B<--download>"
34647 #: ../tools/virt-tar.pl:158
34648 msgid "B<-u> | B<--upload>"
34653 #: ../tools/virt-tar.pl:160
34655 "Use C<-x> to extract (download) a directory from a virtual machine to a "
34661 #: ../tools/virt-tar.pl:163
34663 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
34664 "Please read the L</WARNING> section above before using this option."
34669 #: ../tools/virt-tar.pl:167
34670 msgid "You must specify exactly one of these options."
34675 #: ../tools/virt-tar.pl:173
34676 msgid "B<-z> | B<--gzip>"
34681 #: ../tools/virt-tar.pl:175
34682 msgid "Specify that the input or output tarball is gzip-compressed."
34686 #: ../tools/virt-tar.pl:288
34688 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34689 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34690 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34696 #: ../tools/virt-make-fs.pl:37
34697 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34702 #: ../tools/virt-make-fs.pl:41
34705 " virt-make-fs [--options] input.tar output.img\n"
34711 #: ../tools/virt-make-fs.pl:43
34714 " virt-make-fs [--options] input.tar.gz output.img\n"
34720 #: ../tools/virt-make-fs.pl:45
34723 " virt-make-fs [--options] directory output.img\n"
34729 #: ../tools/virt-make-fs.pl:49
34731 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34732 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34733 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34734 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34735 "you want to attach these filesystems to existing virtual machines (eg. to "
34736 "import large amounts of read-only data to a VM)."
34741 #: ../tools/virt-make-fs.pl:57
34742 msgid "Basic usage is:"
34747 #: ../tools/virt-make-fs.pl:59
34750 " virt-make-fs input output\n"
34756 #: ../tools/virt-make-fs.pl:61
34758 "where C<input> is either a directory containing files that you want to add, "
34759 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34760 "C<output> is a disk image. The input type is detected automatically. The "
34761 "output disk image defaults to a raw ext2 image unless you specify extra "
34762 "flags (see L</OPTIONS> below)."
34767 #: ../tools/virt-make-fs.pl:67
34768 msgid "EXTRA SPACE"
34773 #: ../tools/virt-make-fs.pl:69
34775 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34776 "the files that it contains, but might have extra space. Depending on how "
34777 "you are going to use the output, you might think this extra space is wasted "
34778 "and want to minimize it, or you might want to leave space so that more files "
34779 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34780 "but you can use the C<--size> flag to leave space in the filesystem if you "
34786 #: ../tools/virt-make-fs.pl:77
34788 "An alternative way to leave extra space but not make the output image any "
34789 "bigger is to use an alternative disk image format (instead of the default "
34790 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
34791 "image format (check your hypervisor supports this before using it). This "
34792 "allows you to choose a large C<--size> but the extra space won't actually be "
34793 "allocated in the image until you try to store something in it."
34797 #: ../tools/virt-make-fs.pl:85
34799 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34800 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34801 "to build another image from scratch."
34806 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34807 #: ../tools/virt-make-fs.pl:142
34813 #: ../tools/virt-make-fs.pl:91
34816 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34822 #: ../tools/virt-make-fs.pl:93
34823 msgid "FILESYSTEM TYPE"
34828 #: ../tools/virt-make-fs.pl:95
34830 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34831 "libguestfs supports can be used (but I<not> read-only formats like "
34832 "ISO9660). Here are some of the more common choices:"
34837 #: ../tools/virt-make-fs.pl:101
34843 #: ../tools/virt-make-fs.pl:103
34845 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34846 "you are not going to use the filesystem in a way that requires the journal, "
34847 "then this is just wasted overhead."
34852 #: ../tools/virt-make-fs.pl:107
34853 msgid "I<ntfs> or I<vfat>"
34858 #: ../tools/virt-make-fs.pl:109
34859 msgid "Useful if exporting data to a Windows guest."
34864 #: ../tools/virt-make-fs.pl:111
34866 "I<Note for vfat>: The tar archive or local directory must only contain files "
34867 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34868 "program running within libguestfs is unable to change the ownership of non-"
34869 "root files, since vfat itself does not support this."
34874 #: ../tools/virt-make-fs.pl:116
34880 #: ../tools/virt-make-fs.pl:118
34882 "Lower overhead than C<ext2>, but certain limitations on filename length and "
34883 "total filesystem size."
34888 #: ../tools/virt-make-fs.pl:125
34891 " virt-make-fs --type=minix input minixfs.img\n"
34897 #: ../tools/virt-make-fs.pl:127
34898 msgid "TO PARTITION OR NOT TO PARTITION"
34903 #: ../tools/virt-make-fs.pl:129
34904 msgid "Optionally virt-make-fs can add a partition table to the output disk."
34909 #: ../tools/virt-make-fs.pl:131
34911 "Adding a partition can make the disk image more compatible with certain "
34912 "virtualized operating systems which don't expect to see a filesystem "
34913 "directly located on a block device (Linux doesn't care and will happily "
34914 "handle both types)."
34919 #: ../tools/virt-make-fs.pl:136
34921 "On the other hand, if you have a partition table then the output image is no "
34922 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
34923 "directly on a partitioned disk image. (However libguestfs tools such as "
34924 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
34929 #: ../tools/virt-make-fs.pl:144
34930 msgid "Add an MBR partition:"
34935 #: ../tools/virt-make-fs.pl:146
34938 " virt-make-fs --partition -- input disk.img\n"
34944 #: ../tools/virt-make-fs.pl:148
34946 "If the output disk image could be terabyte-sized or larger, it's better to "
34947 "use an EFI/GPT-compatible partition table:"
34952 #: ../tools/virt-make-fs.pl:151
34955 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
34961 #: ../tools/virt-make-fs.pl:179
34962 msgid "Enable debugging information."
34967 #: ../tools/virt-make-fs.pl:185
34968 msgid "B<--size=E<lt>NE<gt>>"
34973 #: ../tools/virt-make-fs.pl:187
34974 msgid "B<--size=+E<lt>NE<gt>>"
34979 #: ../tools/virt-make-fs.pl:189
34980 msgid "B<-s E<lt>NE<gt>>"
34985 #: ../tools/virt-make-fs.pl:191
34986 msgid "B<-s +E<lt>NE<gt>>"
34991 #: ../tools/virt-make-fs.pl:193
34993 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
34998 #: ../tools/virt-make-fs.pl:196
35000 "If this option is I<not> given, then the output image will be just large "
35001 "enough to contain all the files, with not much wasted space."
35006 #: ../tools/virt-make-fs.pl:199
35008 "To choose a fixed size output disk, specify an absolute number followed by b/"
35009 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35010 "Petabytes or Exabytes. This must be large enough to contain all the input "
35011 "files, else you will get an error."
35016 #: ../tools/virt-make-fs.pl:204
35018 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
35019 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35020 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
35021 "the input files, and (approximately) an extra 200 MB free space."
35026 #: ../tools/virt-make-fs.pl:210
35028 "Note that virt-make-fs estimates free space, and therefore will not produce "
35029 "filesystems containing precisely the free space requested. (It is much more "
35030 "expensive and time-consuming to produce a filesystem which has precisely the "
35031 "desired free space)."
35036 #: ../tools/virt-make-fs.pl:219
35037 msgid "B<--format=E<lt>fmtE<gt>>"
35042 #: ../tools/virt-make-fs.pl:221
35043 msgid "B<-F E<lt>fmtE<gt>>"
35048 #: ../tools/virt-make-fs.pl:223
35049 msgid "Choose the output disk image format."
35054 #: ../tools/virt-make-fs.pl:225
35055 msgid "The default is C<raw> (raw disk image)."
35060 #: ../tools/virt-make-fs.pl:227
35062 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
35063 "that would really make sense here is C<qcow2>."
35068 #: ../tools/virt-make-fs.pl:234
35069 msgid "B<--type=E<lt>fsE<gt>>"
35074 #: ../tools/virt-make-fs.pl:236
35075 msgid "B<-t E<lt>fsE<gt>>"
35080 #: ../tools/virt-make-fs.pl:238
35081 msgid "Choose the output filesystem type."
35086 #: ../tools/virt-make-fs.pl:240
35087 msgid "The default is C<ext2>."
35092 #: ../tools/virt-make-fs.pl:242
35094 "Any filesystem which is supported read-write by libguestfs can be used here."
35099 #: ../tools/virt-make-fs.pl:249
35100 msgid "B<--partition>"
35105 #: ../tools/virt-make-fs.pl:251
35106 msgid "B<--partition=E<lt>parttypeE<gt>>"
35111 #: ../tools/virt-make-fs.pl:253
35113 "If specified, this flag adds an MBR partition table to the output disk image."
35118 #: ../tools/virt-make-fs.pl:256
35120 "You can change the partition table type, eg. C<--partition=gpt> for large "
35126 #: ../tools/virt-make-fs.pl:259
35128 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
35129 "might consider the next parameter to be the partition type. For example:"
35134 #: ../tools/virt-make-fs.pl:263
35137 " virt-make-fs --partition input.tar ...\n"
35143 #: ../tools/virt-make-fs.pl:265
35145 "would cause virt-make-fs to think you wanted to use a partition type of "
35146 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
35147 "dash) between options and the input file argument:"
35152 #: ../tools/virt-make-fs.pl:269
35155 " virt-make-fs --partition -- input.tar ...\n"
35160 #: ../tools/virt-make-fs.pl:541
35162 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
35163 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
35164 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
35169 #: ../tools/virt-make-fs.pl:558
35172 " export LIBGUESTFS_DEBUG=1\n"
35173 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
35179 #: ../tools/virt-make-fs.pl:561
35181 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
35187 #: ../tools/virt-list-partitions.pl:32
35189 "virt-list-partitions - List partitions in a virtual machine or disk image"
35194 #: ../tools/virt-list-partitions.pl:36
35197 " virt-list-partitions [--options] domname\n"
35203 #: ../tools/virt-list-partitions.pl:38
35206 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35212 #: ../tools/virt-list-partitions.pl:45
35214 "C<virt-list-partitions> is a command line tool to list the partitions that "
35215 "are contained in a virtual machine or disk image. It is mainly useful as a "
35216 "first step to using L<virt-resize(1)>."
35221 #: ../tools/virt-list-partitions.pl:50
35223 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35224 "functionality. For more complex cases you should look at the L<guestfish(1)"
35230 #: ../tools/virt-list-partitions.pl:107
35231 msgid "B<-h> | B<--human-readable>"
35236 #: ../tools/virt-list-partitions.pl:109
35237 msgid "Show sizes in human-readable form (eg. \"1G\")."
35242 #: ../tools/virt-list-partitions.pl:117
35244 "With this option, C<virt-list-partitions> displays the type and size of each "
35245 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35250 #: ../tools/virt-list-partitions.pl:124
35251 msgid "B<-t> | B<--total>"
35256 #: ../tools/virt-list-partitions.pl:126
35258 "Display the total size of each block device (as a separate row or rows)."
35263 #: ../tools/virt-list-partitions.pl:259
35265 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
35266 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
35267 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."