1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-04-01 09:14+0200\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
22 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
23 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
24 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../tools/virt-list-partitions.pl:30
32 #: ../src/guestfs.pod:5
33 msgid "guestfs - Library for accessing and modifying virtual machine images"
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
41 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
42 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
43 #: ../tools/virt-list-partitions.pl:34
49 #: ../src/guestfs.pod:9
52 " #include <guestfs.h>\n"
58 #: ../src/guestfs.pod:11
61 " guestfs_h *g = guestfs_create ();\n"
62 " guestfs_add_drive (g, \"guest.img\");\n"
63 " guestfs_launch (g);\n"
64 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
65 " guestfs_touch (g, \"/hello\");\n"
66 " guestfs_umount (g, \"/\");\n"
67 " guestfs_close (g);\n"
73 #: ../src/guestfs.pod:19
76 " cc prog.c -o prog -lguestfs\n"
78 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
84 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
85 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
86 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
87 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
88 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
89 #: ../tools/virt-list-partitions.pl:40
95 #: ../src/guestfs.pod:25
97 "Libguestfs is a library for accessing and modifying guest disk images. "
98 "Amongst the things this is good for: making batch configuration changes to "
99 "guests, getting disk used/free statistics (see also: virt-df), migrating "
100 "between virtualization systems (see also: virt-p2v), performing partial "
101 "backups, performing partial guest clones, cloning guests and changing "
102 "registry/UUID/hostname info, and much else besides."
107 #: ../src/guestfs.pod:33
109 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
110 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
111 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
117 #: ../src/guestfs.pod:38
119 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
120 "what filesystem is in each LV, etc.). It can also run commands in the "
121 "context of the guest. Also you can access filesystems over FUSE."
126 #: ../src/guestfs.pod:43
128 "Libguestfs is a library that can be linked with C and C++ management "
129 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
130 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
136 #: ../src/guestfs.pod:48
138 "You don't need to be root to use libguestfs, although obviously you do need "
139 "enough permissions to access the disk images."
144 #: ../src/guestfs.pod:51
146 "Libguestfs is a large API because it can do many things. For a gentle "
147 "introduction, please read the L</API OVERVIEW> section next."
152 #: ../src/guestfs.pod:54
154 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
166 #: ../src/guestfs.pod:59
168 "This section provides a gentler overview of the libguestfs API. We also try "
169 "to group API calls together, where that may not be obvious from reading "
170 "about the individual calls in the main section of this manual."
175 #: ../src/guestfs.pod:64
181 #: ../src/guestfs.pod:66
183 "Before you can use libguestfs calls, you have to create a handle. Then you "
184 "must add at least one disk image to the handle, followed by launching the "
185 "handle, then performing whatever operations you want, and finally closing "
186 "the handle. By convention we use the single letter C<g> for the name of the "
187 "handle variable, although of course you can use any name you want."
192 #: ../src/guestfs.pod:73
193 msgid "The general structure of all libguestfs-using programs looks like this:"
198 #: ../src/guestfs.pod:76
201 " guestfs_h *g = guestfs_create ();\n"
207 #: ../src/guestfs.pod:78
210 " /* Call guestfs_add_drive additional times if there are\n"
211 " * multiple disk images.\n"
213 " guestfs_add_drive (g, \"guest.img\");\n"
219 #: ../src/guestfs.pod:83
222 " /* Most manipulation calls won't work until you've launched\n"
223 " * the handle 'g'. You have to do this _after_ adding drives\n"
224 " * and _before_ other commands.\n"
226 " guestfs_launch (g);\n"
232 #: ../src/guestfs.pod:89
235 " /* Now you can examine what partitions, LVs etc are available.\n"
237 " char **partitions = guestfs_list_partitions (g);\n"
238 " char **logvols = guestfs_lvs (g);\n"
244 #: ../src/guestfs.pod:94
247 " /* To access a filesystem in the image, you must mount it.\n"
249 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
254 #: ../src/guestfs.pod:98
257 " /* Now you can perform filesystem actions on the guest\n"
260 " guestfs_touch (g, \"/hello\");\n"
266 #: ../src/guestfs.pod:103
269 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
270 " * it is done automatically when you close the handle. See\n"
271 " * discussion of autosync in this page.\n"
273 " guestfs_sync (g);\n"
279 #: ../src/guestfs.pod:109
282 " /* Close the handle 'g'. */\n"
283 " guestfs_close (g);\n"
289 #: ../src/guestfs.pod:112
291 "The code above doesn't include any error checking. In real code you should "
292 "check return values carefully for errors. In general all functions that "
293 "return integers return C<-1> on error, and all functions that return "
294 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
295 "how to handle errors, and consult the documentation for each function call "
296 "below to see precisely how they return error indications. See L<guestfs-"
297 "examples(3)> for fully worked examples."
302 #: ../src/guestfs.pod:121
308 #: ../src/guestfs.pod:123
310 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
311 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
312 "actual block device, or simply an empty file of zeroes that you have created "
313 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
319 #: ../src/guestfs.pod:129
321 "The call you should use in modern code for adding drives is L</"
322 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
323 "specifying that the format is raw, do:"
328 #: ../src/guestfs.pod:133
331 " guestfs_add_drive_opts (g, filename,\n"
332 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
345 #: ../src/guestfs.pod:139
348 " guestfs_add_drive_opts (g, filename,\n"
349 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
350 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
357 #: ../src/guestfs.pod:144
359 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
360 "libguestfs won't modify the file."
365 #: ../src/guestfs.pod:147
367 "Be extremely cautious if the disk image is in use, eg. if it is being used "
368 "by a virtual machine. Adding it read-write will almost certainly cause disk "
369 "corruption, but adding it read-only is safe."
374 #: ../src/guestfs.pod:151
376 "You must add at least one disk image, and you may add multiple disk images. "
377 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
378 "first one you added), C</dev/sdb> (for the second one you added), etc."
383 #: ../src/guestfs.pod:156
385 "Once L</guestfs_launch> has been called you cannot add any more images. You "
386 "can call L</guestfs_list_devices> to get a list of the device names, in the "
387 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
392 #: ../src/guestfs.pod:161
397 #: ../src/guestfs.pod:163
399 "Before you can read or write files, create directories and so on in a disk "
400 "image that contains filesystems, you have to mount those filesystems using "
401 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
402 "a disk image contains (for example) one partition with a filesystem on that "
403 "partition, then you can mount it directly:"
407 #: ../src/guestfs.pod:170
410 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
415 #: ../src/guestfs.pod:172
417 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
418 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
419 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
420 "that these are libguestfs virtual devices, and are nothing to do with host "
425 #: ../src/guestfs.pod:178
427 "If you are given a disk image and you don't know what it contains then you "
428 "have to find out. Libguestfs can do that too: use L</"
429 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
430 "LVs, and either try mounting each to see what is mountable, or else examine "
431 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
432 "filesystems, use L</guestfs_list_filesystems>."
436 #: ../src/guestfs.pod:186
438 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
439 "L</INSPECTION> below). But you might find it easier to look at higher level "
440 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
444 #: ../src/guestfs.pod:191
446 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
447 "several other variations of the C<guestfs_mount_*> call."
452 #: ../src/guestfs.pod:194
453 msgid "FILESYSTEM ACCESS AND MODIFICATION"
458 #: ../src/guestfs.pod:196
460 "The majority of the libguestfs API consists of fairly low-level calls for "
461 "accessing and modifying the files, directories, symlinks etc on mounted "
462 "filesystems. There are over a hundred such calls which you can find listed "
463 "in detail below in this man page, and we don't even pretend to cover them "
464 "all in this overview."
469 #: ../src/guestfs.pod:202
471 "Specify filenames as full paths, starting with C<\"/\"> and including the "
477 #: ../src/guestfs.pod:205
479 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
480 "the file called C<\"etc/passwd\"> then you could do:"
485 #: ../src/guestfs.pod:208
488 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
494 #: ../src/guestfs.pod:210
496 "This would return C<data> as a newly allocated buffer containing the full "
497 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
498 "or C<NULL> if there was an error."
503 #: ../src/guestfs.pod:214
505 "As another example, to create a top-level directory on that filesystem "
506 "called C<\"var\"> you would do:"
511 #: ../src/guestfs.pod:217
514 " guestfs_mkdir (g, \"/var\");\n"
520 #: ../src/guestfs.pod:219
521 msgid "To create a symlink you could do:"
526 #: ../src/guestfs.pod:221
529 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
530 " \"/etc/rc3.d/S30portmap\");\n"
536 #: ../src/guestfs.pod:224
538 "Libguestfs will reject attempts to use relative paths and there is no "
539 "concept of a current working directory."
544 #: ../src/guestfs.pod:227
546 "Libguestfs can return errors in many situations: for example if the "
547 "filesystem isn't writable, or if a file or directory that you requested "
548 "doesn't exist. If you are using the C API (documented here) you have to "
549 "check for those error conditions after each call. (Other language bindings "
550 "turn these errors into exceptions)."
555 #: ../src/guestfs.pod:233
557 "File writes are affected by the per-handle umask, set by calling L</"
558 "guestfs_umask> and defaulting to 022. See L</UMASK>."
563 #: ../src/guestfs.pod:236
569 #: ../src/guestfs.pod:238
571 "Libguestfs contains API calls to read, create and modify partition tables on "
577 #: ../src/guestfs.pod:241
579 "In the common case where you want to create a single partition covering the "
580 "whole disk, you should use the L</guestfs_part_disk> call:"
585 #: ../src/guestfs.pod:245
588 " const char *parttype = \"mbr\";\n"
589 " if (disk_is_larger_than_2TB)\n"
590 " parttype = \"gpt\";\n"
591 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
597 #: ../src/guestfs.pod:250
599 "Obviously this effectively wipes anything that was on that disk image before."
604 #: ../src/guestfs.pod:253
610 #: ../src/guestfs.pod:255
612 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
613 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
614 "you familiarize yourself with the concepts of physical volumes, volume "
615 "groups and logical volumes."
620 #: ../src/guestfs.pod:260
622 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
623 "tldp.org/HOWTO/LVM-HOWTO/>."
628 #: ../src/guestfs.pod:263
633 #: ../src/guestfs.pod:265
635 "Use L</guestfs_cat> to download small, text only files. This call is "
636 "limited to files which are less than 2 MB and which cannot contain any ASCII "
637 "NUL (C<\\0>) characters. However the API is very simple to use."
642 #: ../src/guestfs.pod:269
644 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
645 "bit data, since it returns a (pointer, size) pair. However it is still "
646 "limited to \"small\" files, less than 2 MB."
651 #: ../src/guestfs.pod:273
653 "L</guestfs_download> can be used to download any file, with no limits on "
654 "content or size (even files larger than 4 GB)."
659 #: ../src/guestfs.pod:276
661 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
666 #: ../src/guestfs.pod:279
672 #: ../src/guestfs.pod:281
674 "It's often the case that you want to write a file or files to the disk image."
679 #: ../src/guestfs.pod:284
681 "To write a small file with fixed content, use L</guestfs_write>. To create "
682 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
683 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
684 "of other functions for creating test files, for example L</guestfs_fill> and "
685 "L</guestfs_fill_pattern>."
690 #: ../src/guestfs.pod:290
692 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
693 "file content or size (even files larger than 4 GB)."
698 #: ../src/guestfs.pod:293
700 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
705 #: ../src/guestfs.pod:295
707 "However the fastest way to upload I<large numbers of arbitrary files> is to "
708 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
709 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
710 "in a predictable way (eg. adding it last after all other drives) then you "
711 "can get the device name from L</guestfs_list_devices> and mount it directly "
712 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
713 "portable between kernel versions, and they don't support labels or UUIDs. "
714 "If you want to pre-build an image or you need to mount it using a label or "
715 "UUID, use an ISO image instead."
720 #: ../src/guestfs.pod:306
726 #: ../src/guestfs.pod:308
728 "There are various different commands for copying between files and devices "
729 "and in and out of the guest filesystem. These are summarised in the table "
735 #: ../src/guestfs.pod:314
736 msgid "B<file> to B<file>"
741 #: ../src/guestfs.pod:316
743 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
744 "directories recursively."
749 #: ../src/guestfs.pod:319
750 msgid "B<file or device> to B<file or device>"
755 #: ../src/guestfs.pod:321
757 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
758 "devices in the guest."
763 #: ../src/guestfs.pod:324
764 msgid "Example: duplicate the contents of an LV:"
769 #: ../src/guestfs.pod:326
772 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
778 #: ../src/guestfs.pod:328
780 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
781 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
782 "guestfs_copy_size>."
787 #: ../src/guestfs.pod:332
788 msgid "B<file on the host> to B<file or device>"
793 #: ../src/guestfs.pod:334
794 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
799 #: ../src/guestfs.pod:336
800 msgid "B<file or device> to B<file on the host>"
805 #: ../src/guestfs.pod:338
806 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
811 #: ../src/guestfs.pod:342
812 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
817 #: ../src/guestfs.pod:344
819 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
820 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
821 "appears you can only upload and download to files. However many Un*x-like "
822 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
823 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
824 "and arbitrary file descriptor N."
829 #: ../src/guestfs.pod:352
830 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
834 #: ../src/guestfs.pod:355
837 " guestfs_download (g, filename, \"/dev/stdout\");\n"
843 #: ../src/guestfs.pod:357
844 msgid "and you can write tar output to a pipe C<fd> by doing:"
848 #: ../src/guestfs.pod:359
852 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
853 " guestfs_tar_out (g, \"/\", devfd);\n"
859 #: ../src/guestfs.pod:363
860 msgid "LISTING FILES"
865 #: ../src/guestfs.pod:365
867 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
868 "L<guestfish(1)>-equivalent command C<ll>)."
873 #: ../src/guestfs.pod:368
875 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
876 "programs, as a flat list of strings."
881 #: ../src/guestfs.pod:371
883 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
884 "directory, plus additional information about each one. It is more "
885 "equivalent to using the L<readdir(3)> call on a local filesystem."
890 #: ../src/guestfs.pod:375
892 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
897 #: ../src/guestfs.pod:378
898 msgid "RUNNING COMMANDS"
903 #: ../src/guestfs.pod:380
905 "Although libguestfs is primarily an API for manipulating files inside guest "
906 "images, we also provide some limited facilities for running commands inside "
912 #: ../src/guestfs.pod:384
913 msgid "There are many limitations to this:"
918 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
919 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
920 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1088
921 #: ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101
922 #: ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136
923 #: ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166
924 #: ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178
925 #: ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669
926 #: ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779
927 #: ../src/guestfs.pod:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019
928 #: ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387
929 #: ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2863
930 #: ../src/guestfs.pod:2867 ../src/guestfs.pod:2871 ../src/guestfs.pod:2875
931 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
932 #: ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585
933 #: ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599
934 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
935 #: ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607
936 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1619
937 #: ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1633
938 #: ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1641
939 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1783
940 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
941 #: ../src/guestfs-actions.pod:1854 ../src/guestfs-actions.pod:1858
942 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish.pod:443
943 #: ../fish/guestfish.pod:447 ../fish/guestfish.pod:451
944 #: ../fish/guestfish.pod:455 ../fish/guestfish-actions.pod:13
945 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380
946 #: ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395
947 #: ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072
948 #: ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080
949 #: ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092
950 #: ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100
951 #: ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114
952 #: ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208
953 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217
954 #: ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264
955 #: ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273
956 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
957 #: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345
958 #: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
964 #: ../src/guestfs.pod:390
966 "The kernel version that the command runs under will be different from what "
972 #: ../src/guestfs.pod:395
974 "If the command needs to communicate with daemons, then most likely they "
980 #: ../src/guestfs.pod:400
981 msgid "The command will be running in limited memory."
986 #: ../src/guestfs.pod:404
988 "The network may not be available unless you enable it (see L</"
989 "guestfs_set_network>)."
994 #: ../src/guestfs.pod:409
995 msgid "Only supports Linux guests (not Windows, BSD, etc)."
1000 #: ../src/guestfs.pod:413
1002 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1007 #: ../src/guestfs.pod:418
1009 "For SELinux guests, you may need to enable SELinux and load policy first. "
1010 "See L</SELINUX> in this manpage."
1015 #: ../src/guestfs.pod:423
1017 "I<Security:> It is not safe to run commands from untrusted, possibly "
1018 "malicious guests. These commands may attempt to exploit your program by "
1019 "sending unexpected output. They could also try to exploit the Linux kernel "
1020 "or qemu provided by the libguestfs appliance. They could use the network "
1021 "provided by the libguestfs appliance to bypass ordinary network partitions "
1022 "and firewalls. They could use the elevated privileges or different SELinux "
1023 "context of your program to their advantage."
1028 #: ../src/guestfs.pod:432
1030 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1031 "(a script which runs when the guest next boots normally), and to have this "
1032 "script run the commands you want in the normal context of the running guest, "
1033 "network security and so on. For information about other security issues, "
1039 #: ../src/guestfs.pod:440
1041 "The two main API calls to run commands are L</guestfs_command> and L</"
1042 "guestfs_sh> (there are also variations)."
1047 #: ../src/guestfs.pod:443
1049 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1050 "shell globs, redirections, etc will work."
1055 #: ../src/guestfs.pod:446
1056 msgid "CONFIGURATION FILES"
1061 #: ../src/guestfs.pod:448
1063 "To read and write configuration files in Linux guest filesystems, we "
1064 "strongly recommend using Augeas. For example, Augeas understands how to "
1065 "read and write, say, a Linux shadow password file or X.org configuration "
1066 "file, and so avoids you having to write that code."
1071 #: ../src/guestfs.pod:453
1073 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1074 "document Augeas itself here because there is excellent documentation on the "
1075 "L<http://augeas.net/> website."
1080 #: ../src/guestfs.pod:457
1082 "If you don't want to use Augeas (you fool!) then try calling L</"
1083 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1089 #: ../src/guestfs.pod:461
1095 #: ../src/guestfs.pod:463
1097 "We support SELinux guests. To ensure that labeling happens correctly in "
1098 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1103 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1104 #: ../src/guestfs.pod:2426
1110 #: ../src/guestfs.pod:471
1111 msgid "Before launching, do:"
1116 #: ../src/guestfs.pod:473
1119 " guestfs_set_selinux (g, 1);\n"
1125 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1126 #: ../src/guestfs.pod:2451
1132 #: ../src/guestfs.pod:477
1134 "After mounting the guest's filesystem(s), load the policy. This is best "
1135 "done by running the L<load_policy(8)> command in the guest itself:"
1140 #: ../src/guestfs.pod:481
1143 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1149 #: ../src/guestfs.pod:483
1151 "(Older versions of C<load_policy> require you to specify the name of the "
1157 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1163 #: ../src/guestfs.pod:488
1165 "Optionally, set the security context for the API. The correct security "
1166 "context to use can only be known by inspecting the guest. As an example:"
1171 #: ../src/guestfs.pod:492
1174 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1180 #: ../src/guestfs.pod:496
1181 msgid "This will work for running commands and editing existing files."
1186 #: ../src/guestfs.pod:498
1188 "When new files are created, you may need to label them explicitly, for "
1189 "example by running the external command C<restorecon pathname>."
1194 #: ../src/guestfs.pod:502
1200 #: ../src/guestfs.pod:504
1202 "Certain calls are affected by the current file mode creation mask (the "
1203 "\"umask\"). In particular ones which create files or directories, such as "
1204 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1205 "either the default mode that the file is created with or modifies the mode "
1211 #: ../src/guestfs.pod:510
1213 "The default umask is C<022>, so files are created with modes such as C<0644> "
1214 "and directories with C<0755>."
1219 #: ../src/guestfs.pod:513
1221 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1222 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1223 "guestfs_chmod> after creating each file or directory."
1228 #: ../src/guestfs.pod:517
1229 msgid "For more information about umask, see L<umask(2)>."
1234 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1235 msgid "ENCRYPTED DISKS"
1240 #: ../src/guestfs.pod:521
1242 "Libguestfs allows you to access Linux guests which have been encrypted using "
1243 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1244 "standard. This includes nearly all whole disk encryption systems used by "
1245 "modern Linux guests."
1250 #: ../src/guestfs.pod:527
1252 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1253 "returns the string C<crypto_LUKS>)."
1258 #: ../src/guestfs.pod:530
1260 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1261 "will require the passphrase!"
1266 #: ../src/guestfs.pod:533
1268 "Opening a LUKS device creates a new device mapper device called C</dev/"
1269 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1270 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1271 "from and encrypted to the underlying block device respectively."
1276 #: ../src/guestfs.pod:539
1278 "LVM volume groups on the device can be made visible by calling L</"
1279 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1280 "(s) can now be mounted in the usual way."
1285 #: ../src/guestfs.pod:543
1287 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1288 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1289 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1290 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1291 "underlying encrypted block device)."
1296 #: ../src/guestfs.pod:550
1301 #: ../src/guestfs.pod:552
1303 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1304 "contains operating systems, an install CD or a live CD. (These APIs used to "
1305 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1306 "version 1.5.3 the most frequently used part of this library has been "
1307 "rewritten in C and moved into the core code)."
1312 #: ../src/guestfs.pod:559
1314 "Add all disks belonging to the unknown virtual machine and call L</"
1315 "guestfs_launch> in the usual way."
1320 #: ../src/guestfs.pod:562
1322 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1323 "and certain heuristics, and returns a list of operating systems that were "
1324 "found. An empty list means none were found. A single element is the root "
1325 "filesystem of the operating system. For dual- or multi-boot guests, "
1326 "multiple roots can be returned, each one corresponding to a separate "
1327 "operating system. (Multi-boot virtual machines are extremely rare in the "
1328 "world of virtualization, but since this scenario can happen, we have built "
1329 "libguestfs to deal with it.)"
1334 #: ../src/guestfs.pod:571
1336 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1337 "to get additional details about that operating system. For example, call L</"
1338 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1339 "Windows and Linux-based operating systems respectively."
1344 #: ../src/guestfs.pod:577
1346 "Un*x-like and Linux-based operating systems usually consist of several "
1347 "filesystems which are mounted at boot time (for example, a separate boot "
1348 "partition mounted on C</boot>). The inspection rules are able to detect how "
1349 "filesystems correspond to mount points. Call "
1350 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1351 "hash table like this example:"
1356 #: ../src/guestfs.pod:584
1359 " /boot => /dev/sda1\n"
1360 " / => /dev/vg_guest/lv_root\n"
1361 " /usr => /dev/vg_guest/lv_usr\n"
1367 #: ../src/guestfs.pod:588
1369 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1370 "filesystems as suggested."
1375 #: ../src/guestfs.pod:591
1377 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1378 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1383 #: ../src/guestfs.pod:595
1385 "Inspection currently only works for some common operating systems. "
1386 "Contributors are welcome to send patches for other operating systems that we "
1387 "currently cannot detect."
1392 #: ../src/guestfs.pod:599
1394 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1395 "for more details. The L</guestfs_inspect_os> function just ignores any "
1396 "encrypted devices."
1401 #: ../src/guestfs.pod:603
1403 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1404 "inspection and caches the results in the guest handle. Subsequent calls to "
1405 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1406 "read the disks. If you change the content of the guest disks, you can redo "
1407 "inspection by calling L</guestfs_inspect_os> again. (L</"
1408 "guestfs_inspect_list_applications> works a little differently from the other "
1409 "calls and does read the disks. See documentation for that function for "
1414 #: ../src/guestfs.pod:612
1415 msgid "INSPECTING INSTALL DISKS"
1419 #: ../src/guestfs.pod:614
1421 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1426 #: ../src/guestfs.pod:617
1428 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1429 "system, which currently can be C<installed> (a regular operating system) or "
1430 "C<installer> (some sort of install disk)."
1434 #: ../src/guestfs.pod:621
1436 "Further information is available about the operating system that can be "
1437 "installed using the regular inspection APIs like L</"
1438 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1442 #: ../src/guestfs.pod:626
1444 "Some additional information specific to installer disks is also available "
1445 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1446 "guestfs_inspect_is_multipart> calls."
1451 #: ../src/guestfs.pod:631
1452 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1457 #: ../src/guestfs.pod:633
1459 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1460 "ntfs-3g.org/> driver."
1465 #: ../src/guestfs.pod:636
1466 msgid "DRIVE LETTERS AND PATHS"
1471 #: ../src/guestfs.pod:638
1473 "DOS and Windows still use drive letters, and the filesystems are always "
1474 "treated as case insensitive by Windows itself, and therefore you might find "
1475 "a Windows configuration file referring to a path like C<c:\\windows"
1476 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1477 "might be referred to as C</WINDOWS/System32>."
1482 #: ../src/guestfs.pod:644
1484 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1485 "libguestfs to read the appropriate Windows Registry and configuration files, "
1486 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1492 #: ../src/guestfs.pod:649
1494 "Replacing backslash characters with forward slash characters is also outside "
1495 "the scope of libguestfs, but something that you can easily do."
1500 #: ../src/guestfs.pod:652
1502 "Where we can help is in resolving the case insensitivity of paths. For "
1503 "this, call L</guestfs_case_sensitive_path>."
1508 #: ../src/guestfs.pod:655
1509 msgid "ACCESSING THE WINDOWS REGISTRY"
1514 #: ../src/guestfs.pod:657
1516 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1517 "files, through the library C<hivex> which is part of the libguestfs project "
1518 "although ships as a separate tarball. You have to locate and download the "
1519 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1520 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1521 "reg(1)> for more help on this issue."
1526 #: ../src/guestfs.pod:665
1527 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1532 #: ../src/guestfs.pod:667
1534 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1535 "provide something which looks like a Linux symlink. The way it tries to do "
1536 "the rewriting is described here:"
1541 #: ../src/guestfs.pod:671
1543 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1549 #: ../src/guestfs.pod:673
1551 "The essential problem is that ntfs-3g simply does not have enough "
1552 "information to do a correct job. NTFS links can contain drive letters and "
1553 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1554 "It is almost certainly the case that libguestfs callers should ignore what "
1555 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1560 #: ../src/guestfs.pod:680
1562 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1563 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1564 "attribute, and read the raw reparse data from that (you can find the format "
1565 "documented in various places around the web)."
1570 #: ../src/guestfs.pod:685
1571 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1576 #: ../src/guestfs.pod:687
1578 "There are other useful extended attributes that can be read from ntfs-3g "
1579 "filesystems (using L</guestfs_getxattr>). See:"
1584 #: ../src/guestfs.pod:690
1586 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1591 #: ../src/guestfs.pod:692
1592 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1597 #: ../src/guestfs.pod:694
1599 "Although we don't want to discourage you from using the C API, we will "
1600 "mention here that the same API is also available in other languages."
1604 #: ../src/guestfs.pod:697
1606 "The API is broadly identical in all supported languages. This means that "
1607 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1608 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1609 "OCaml. In other words, a straightforward, predictable isomorphism between "
1615 #: ../src/guestfs.pod:703
1617 "Error messages are automatically transformed into exceptions if the language "
1623 #: ../src/guestfs.pod:706
1625 "We don't try to \"object orientify\" parts of the API in OO languages, "
1626 "although contributors are welcome to write higher level APIs above what we "
1627 "provide in their favourite languages if they wish."
1632 #: ../src/guestfs.pod:712
1638 #: ../src/guestfs.pod:714
1640 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1641 "identical to the C API. C++ classes and exceptions are not used."
1646 #: ../src/guestfs.pod:718
1652 #: ../src/guestfs.pod:720
1654 "The C# bindings are highly experimental. Please read the warnings at the "
1655 "top of C<csharp/Libguestfs.cs>."
1660 #: ../src/guestfs.pod:723
1666 #: ../src/guestfs.pod:725
1668 "This is the only language binding that is working but incomplete. Only "
1669 "calls which return simple integers have been bound in Haskell, and we are "
1670 "looking for help to complete this binding."
1675 #: ../src/guestfs.pod:729
1681 #: ../src/guestfs.pod:731
1683 "Full documentation is contained in the Javadoc which is distributed with "
1689 #: ../src/guestfs.pod:734
1694 #: ../src/guestfs.pod:736
1695 msgid "See L<guestfs-ocaml(3)>."
1700 #: ../src/guestfs.pod:738
1705 #: ../src/guestfs.pod:740
1706 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1711 #: ../src/guestfs.pod:742
1717 #: ../src/guestfs.pod:744
1719 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1720 "the php-libguestfs package for your distribution."
1725 #: ../src/guestfs.pod:747
1726 msgid "The PHP binding only works correctly on 64 bit machines."
1731 #: ../src/guestfs.pod:749
1736 #: ../src/guestfs.pod:751
1737 msgid "See L<guestfs-python(3)>."
1742 #: ../src/guestfs.pod:753
1747 #: ../src/guestfs.pod:755
1748 msgid "See L<guestfs-ruby(3)>."
1753 #: ../src/guestfs.pod:757
1754 msgid "B<shell scripts>"
1758 #: ../src/guestfs.pod:759
1759 msgid "See L<guestfish(1)>."
1764 #: ../src/guestfs.pod:763
1765 msgid "LIBGUESTFS GOTCHAS"
1770 #: ../src/guestfs.pod:765
1772 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1773 "system [...] that works in the way it is documented but is counterintuitive "
1774 "and almost invites mistakes.\""
1779 #: ../src/guestfs.pod:769
1781 "Since we developed libguestfs and the associated tools, there are several "
1782 "things we would have designed differently, but are now stuck with for "
1783 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1784 "release, you can expect these to change. Beware of them."
1789 #: ../src/guestfs.pod:777
1790 msgid "Autosync / forgetting to sync."
1795 #: ../src/guestfs.pod:779
1797 "When modifying a filesystem from C or another language, you B<must> unmount "
1798 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1799 "libguestfs handle. You can also call:"
1804 #: ../src/guestfs.pod:783
1807 " guestfs_set_autosync (g, 1);\n"
1813 #: ../src/guestfs.pod:785
1815 "to have the unmount/sync done automatically for you when the handle 'g' is "
1816 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1821 #: ../src/guestfs.pod:789
1823 "If you forget to do this, then it is entirely possible that your changes "
1824 "won't be written out, or will be partially written, or (very rarely) that "
1825 "you'll get disk corruption."
1830 #: ../src/guestfs.pod:793
1832 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1833 "guestfish scripts that forget to sync will work just fine, which can make "
1834 "this very puzzling if you are trying to debug a problem."
1839 #: ../src/guestfs.pod:797
1841 "Update: Autosync is enabled by default for all API users starting from "
1842 "libguestfs 1.5.24."
1847 #: ../src/guestfs.pod:800
1848 msgid "Mount option C<-o sync> should not be the default."
1853 #: ../src/guestfs.pod:802
1855 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1856 "However C<-o sync> does not add any reliability benefit, but does have a "
1857 "very large performance impact."
1862 #: ../src/guestfs.pod:806
1864 "The work around is to use L</guestfs_mount_options> and set the mount "
1865 "options that you actually want to use."
1870 #: ../src/guestfs.pod:809
1871 msgid "Read-only should be the default."
1876 #: ../src/guestfs.pod:811
1878 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1879 "specify I<--rw> if you want to make changes to the image."
1884 #: ../src/guestfs.pod:814
1885 msgid "This would reduce the potential to corrupt live VM images."
1890 #: ../src/guestfs.pod:816
1892 "Note that many filesystems change the disk when you just mount and unmount, "
1893 "even if you didn't perform any writes. You need to use L</"
1894 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1899 #: ../src/guestfs.pod:820
1900 msgid "guestfish command line is hard to use."
1905 #: ../src/guestfs.pod:822
1907 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1908 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1909 "exist, so it fails. In earlier versions of guestfish the error message was "
1910 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1911 "we should have used C<guestfish -c command> to run commands."
1916 #: ../src/guestfs.pod:829
1917 msgid "guestfish megabyte modifiers don't work right on all commands"
1922 #: ../src/guestfs.pod:831
1924 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1925 "other modifiers). What guestfish actually does is to multiply the number "
1926 "part by the modifier part and pass the result to the C API. However this "
1927 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1928 "expecting some other unit (eg. megabytes)."
1933 #: ../src/guestfs.pod:838
1934 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1939 #: ../src/guestfs.pod:840
1942 " lvcreate LV VG 100M\n"
1948 #: ../src/guestfs.pod:842
1950 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1951 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1952 "megabytes * megabytes) logical volume. The error message you get from this "
1953 "is also a little obscure."
1958 #: ../src/guestfs.pod:847
1960 "This could be fixed in the generator by specially marking parameters and "
1961 "return values which take bytes or other units."
1966 #: ../src/guestfs.pod:850
1967 msgid "Ambiguity between devices and paths"
1972 #: ../src/guestfs.pod:852
1974 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1975 "sdb2>) and a similar pathname. A file might just happen to be called "
1976 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1981 #: ../src/guestfs.pod:857
1983 "In the current API we usually resolve this ambiguity by having two separate "
1984 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1985 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1986 "detecting if the path supplied begins with C</dev/>."
1991 #: ../src/guestfs.pod:863
1993 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1994 "make paths/devices into structured names. One way to do this would be to "
1995 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1996 "aspect of grub. Another way would be to use a structured type, equivalent "
1997 "to this OCaml type:"
2002 #: ../src/guestfs.pod:869
2005 " type path = Path of string | Device of int | Partition of int * int\n"
2011 #: ../src/guestfs.pod:871
2012 msgid "which would allow you to pass arguments like:"
2017 #: ../src/guestfs.pod:873
2020 " Path \"/foo/bar\"\n"
2021 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
2022 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
2023 " Path \"/dev/sdb2\" (* not a device *)\n"
2029 #: ../src/guestfs.pod:878
2031 "As you can see there are still problems to resolve even with this "
2032 "representation. Also consider how it might work in guestfish."
2037 #: ../src/guestfs.pod:883
2038 msgid "PROTOCOL LIMITS"
2043 #: ../src/guestfs.pod:885
2045 "Internally libguestfs uses a message-based protocol to pass API calls and "
2046 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2047 "plenty more detail about this). The maximum message size used by the "
2048 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2049 "aware of this limit. The API calls which may be affected are individually "
2050 "documented, with a link back to this section of the documentation."
2055 #: ../src/guestfs.pod:893
2057 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2058 "a simple string. Because this string is at some point internally encoded as "
2059 "a message, the maximum size that it can return is slightly under 4 MB. If "
2060 "the requested file is larger than this then you will get an error."
2065 #: ../src/guestfs.pod:899
2067 "In order to transfer large files into and out of the guest filesystem, you "
2068 "need to use particular calls that support this. The sections L</UPLOADING> "
2069 "and L</DOWNLOADING> document how to do this."
2074 #: ../src/guestfs.pod:903
2076 "You might also consider mounting the disk image using our FUSE filesystem "
2077 "support (L<guestmount(1)>)."
2082 #: ../src/guestfs.pod:906
2083 msgid "KEYS AND PASSPHRASES"
2088 #: ../src/guestfs.pod:908
2090 "Certain libguestfs calls take a parameter that contains sensitive key "
2091 "material, passed in as a C string."
2096 #: ../src/guestfs.pod:911
2098 "In the future we would hope to change the libguestfs implementation so that "
2099 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2100 "swap. However this is I<not> done at the moment, because of the complexity "
2101 "of such an implementation."
2106 #: ../src/guestfs.pod:916
2108 "Therefore you should be aware that any key parameter you pass to libguestfs "
2109 "might end up being written out to the swap partition. If this is a concern, "
2110 "scrub the swap partition or don't use libguestfs on encrypted devices."
2115 #: ../src/guestfs.pod:921
2116 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2121 #: ../src/guestfs.pod:923
2123 "All high-level libguestfs actions are synchronous. If you want to use "
2124 "libguestfs asynchronously then you must create a thread."
2129 #: ../src/guestfs.pod:926
2131 "Only use the handle from a single thread. Either use the handle exclusively "
2132 "from one thread, or provide your own mutex so that two threads cannot issue "
2133 "calls on the same handle at the same time."
2138 #: ../src/guestfs.pod:930
2140 "See the graphical program guestfs-browser for one possible architecture for "
2141 "multithreaded programs using libvirt and libguestfs."
2146 #: ../src/guestfs.pod:933
2151 #: ../src/guestfs.pod:935
2153 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2159 #: ../src/guestfs.pod:938
2161 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2162 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2167 #: ../src/guestfs.pod:941
2169 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2170 "to change the directories that libguestfs will search in. The value is a "
2171 "colon-separated list of paths. The current directory is I<not> searched "
2172 "unless the path contains an empty element or C<.>. For example "
2173 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2174 "then C</usr/lib/guestfs>."
2179 #: ../src/guestfs.pod:948
2180 msgid "QEMU WRAPPERS"
2185 #: ../src/guestfs.pod:950
2187 "If you want to compile your own qemu, run qemu from a non-standard location, "
2188 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2194 #: ../src/guestfs.pod:954
2196 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2197 "last command in the shell script (so that qemu replaces the shell and "
2198 "becomes the direct child of the libguestfs-using program). If you don't do "
2199 "this, then the qemu process won't be cleaned up correctly."
2204 #: ../src/guestfs.pod:959
2206 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2212 #: ../src/guestfs.pod:962
2216 " qemudir=/home/rjones/d/qemu\n"
2217 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2223 #: ../src/guestfs.pod:966
2225 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2226 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2232 #: ../src/guestfs.pod:970
2235 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2241 #: ../src/guestfs.pod:972
2243 "Note that libguestfs also calls qemu with the -help and -version options in "
2244 "order to determine features."
2248 #: ../src/guestfs.pod:975
2249 msgid "ATTACHING TO RUNNING DAEMONS"
2253 #: ../src/guestfs.pod:977
2255 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2256 "babies. Use with caution."
2260 #: ../src/guestfs.pod:980
2262 "I<Note (2):> This section explains how to attach to a running daemon from a "
2263 "low level perspective. For most users, simply using virt tools such as "
2264 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2268 #: ../src/guestfs.pod:984
2269 msgid "Using guestfs_set_attach_method"
2273 #: ../src/guestfs.pod:986
2275 "By calling L</guestfs_set_attach_method> you can change how the library "
2276 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2277 "ARCHITECTURE> for some background)."
2281 #: ../src/guestfs.pod:990
2283 "The normal attach method is C<appliance>, where a small appliance is created "
2284 "containing the daemon, and then the library connects to this."
2288 #: ../src/guestfs.pod:993
2290 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2291 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2292 "daemon over the Unix domain socket."
2296 #: ../src/guestfs.pod:997
2298 "The normal use for this is to connect to a running virtual machine that "
2299 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2300 "files inside the live virtual machine."
2304 #: ../src/guestfs.pod:1001
2305 msgid "Using guestfs_add_domain with live flag"
2309 #: ../src/guestfs.pod:1003
2311 "L</guestfs_add_domain> provides some help for getting the correct attach "
2312 "method. If you pass the C<live> option to this function, then (if the "
2313 "virtual machine is running) it will examine the libvirt XML looking for a "
2314 "virtio-serial channel to connect to:"
2318 #: ../src/guestfs.pod:1009
2325 " <channel type='unix'>\n"
2326 " <source mode='bind' path='/path/to/socket'/>\n"
2327 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2336 #: ../src/guestfs.pod:1021
2338 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2339 "method to C<unix:/path/to/socket>."
2343 #: ../src/guestfs.pod:1024
2345 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2346 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2347 "to attach to and modify live virtual machines."
2351 #: ../src/guestfs.pod:1028
2353 "The virtual machine needs to have been set up beforehand so that it has the "
2354 "virtio-serial channel and so that guestfsd is running inside it."
2359 #: ../src/guestfs.pod:1032
2360 msgid "ABI GUARANTEE"
2365 #: ../src/guestfs.pod:1034
2367 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2368 "actions as outlined in this section. Although we will deprecate some "
2369 "actions, for example if they get replaced by newer calls, we will keep the "
2370 "old actions forever. This allows you the developer to program in confidence "
2371 "against the libguestfs API."
2376 #: ../src/guestfs.pod:1040
2377 msgid "BLOCK DEVICE NAMING"
2382 #: ../src/guestfs.pod:1042
2384 "In the kernel there is now quite a profusion of schemata for naming block "
2385 "devices (in this context, by I<block device> I mean a physical or virtual "
2386 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2387 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2388 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2389 "for the old IDE driver (particularly for SATA devices) those devices also "
2390 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2391 "paravirtualized drivers. This has created several different naming systems, "
2392 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2397 #: ../src/guestfs.pod:1054
2399 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2400 "Linux kernel to access block devices. We can run a variety of appliances "
2401 "based on a variety of Linux kernels."
2406 #: ../src/guestfs.pod:1058
2408 "This causes a problem for libguestfs because many API calls use device or "
2409 "partition names. Working scripts and the recipe (example) scripts that we "
2410 "make available over the internet could fail if the naming scheme changes."
2415 #: ../src/guestfs.pod:1063
2417 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2418 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2419 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2420 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2425 #: ../src/guestfs.pod:1069
2427 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2428 "L</guestfs_list_partitions> and similar calls return the true names of the "
2429 "devices and partitions as known to the appliance."
2434 #: ../src/guestfs.pod:1074
2435 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2440 #: ../src/guestfs.pod:1076
2442 "Usually this translation is transparent. However in some (very rare) cases "
2443 "you may need to know the exact algorithm. Such cases include where you use "
2444 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2445 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2450 #: ../src/guestfs.pod:1082
2452 "The algorithm is applied only to I<parameters> which are known to be either "
2453 "device or partition names. Return values from functions such as L</"
2454 "guestfs_list_devices> are never changed."
2459 #: ../src/guestfs.pod:1090
2460 msgid "Is the string a parameter which is a device or partition name?"
2465 #: ../src/guestfs.pod:1094
2466 msgid "Does the string begin with C</dev/sd>?"
2471 #: ../src/guestfs.pod:1098
2473 "Does the named device exist? If so, we use that device. However if I<not> "
2474 "then we continue with this algorithm."
2479 #: ../src/guestfs.pod:1103
2480 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2485 #: ../src/guestfs.pod:1105
2486 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2491 #: ../src/guestfs.pod:1107
2492 msgid "If that named device exists, use it. If not, continue."
2497 #: ../src/guestfs.pod:1111
2498 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2503 #: ../src/guestfs.pod:1113
2504 msgid "If that named device exists, use it. If not, return an error."
2509 #: ../src/guestfs.pod:1117
2510 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2515 #: ../src/guestfs.pod:1119
2517 "Although the standard naming scheme and automatic translation is useful for "
2518 "simple programs and guestfish scripts, for larger programs it is best not to "
2519 "rely on this mechanism."
2524 #: ../src/guestfs.pod:1123
2526 "Where possible for maximum future portability programs using libguestfs "
2527 "should use these future-proof techniques:"
2532 #: ../src/guestfs.pod:1130
2534 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2535 "device names, and then use those names directly."
2540 #: ../src/guestfs.pod:1133
2542 "Since those device names exist by definition, they will never be translated."
2547 #: ../src/guestfs.pod:1138
2549 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2550 "filesystem labels."
2555 #: ../src/guestfs.pod:1143
2561 #: ../src/guestfs.pod:1145
2563 "This section discusses security implications of using libguestfs, "
2564 "particularly with untrusted or malicious guests or disk images."
2569 #: ../src/guestfs.pod:1148
2570 msgid "GENERAL SECURITY CONSIDERATIONS"
2575 #: ../src/guestfs.pod:1150
2577 "Be careful with any files or data that you download from a guest (by "
2578 "\"download\" we mean not just the L</guestfs_download> command but any "
2579 "command that reads files, filenames, directories or anything else from a "
2580 "disk image). An attacker could manipulate the data to fool your program "
2581 "into doing the wrong thing. Consider cases such as:"
2586 #: ../src/guestfs.pod:1160
2587 msgid "the data (file etc) not being present"
2592 #: ../src/guestfs.pod:1164
2593 msgid "being present but empty"
2598 #: ../src/guestfs.pod:1168
2599 msgid "being much larger than normal"
2604 #: ../src/guestfs.pod:1172
2605 msgid "containing arbitrary 8 bit data"
2610 #: ../src/guestfs.pod:1176
2611 msgid "being in an unexpected character encoding"
2616 #: ../src/guestfs.pod:1180
2617 msgid "containing homoglyphs."
2622 #: ../src/guestfs.pod:1184
2623 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2628 #: ../src/guestfs.pod:1186
2630 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2631 "(VFS) module can sometimes be escalated into exploits by deliberately "
2632 "creating a malicious, malformed filesystem. These exploits are very severe "
2633 "for two reasons. Firstly there are very many filesystem drivers in the "
2634 "kernel, and many of them are infrequently used and not much developer "
2635 "attention has been paid to the code. Linux userspace helps potential "
2636 "crackers by detecting the filesystem type and automatically choosing the "
2637 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2638 "the administrator. Secondly, a kernel-level exploit is like a local root "
2639 "exploit (worse in some ways), giving immediate and total access to the "
2640 "system right down to the hardware level."
2645 #: ../src/guestfs.pod:1199
2647 "That explains why you should never mount a filesystem from an untrusted "
2648 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2649 "inside a qemu virtual machine, usually running as a non-root user. The "
2650 "attacker would need to write a filesystem which first exploited the kernel, "
2651 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2652 "the libguestfs protocol, and finally to be as serious as the host kernel "
2653 "exploit it would need to escalate its privileges to root. This multi-step "
2654 "escalation, performed by a static piece of data, is thought to be extremely "
2655 "hard to do, although we never say 'never' about security issues."
2660 #: ../src/guestfs.pod:1210
2662 "In any case callers can reduce the attack surface by forcing the filesystem "
2663 "type when mounting (use L</guestfs_mount_vfs>)."
2668 #: ../src/guestfs.pod:1213
2669 msgid "PROTOCOL SECURITY"
2674 #: ../src/guestfs.pod:1215
2676 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2677 "defined upper message size. However a program that uses libguestfs must "
2678 "also take care - for example you can write a program that downloads a binary "
2679 "from a disk image and executes it locally, and no amount of protocol "
2680 "security will save you from the consequences."
2685 #: ../src/guestfs.pod:1221
2686 msgid "INSPECTION SECURITY"
2691 #: ../src/guestfs.pod:1223
2693 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2694 "directly from the guest, and these could contain any 8 bit data. Callers "
2695 "should be careful to escape these before printing them to a structured file "
2696 "(for example, use HTML escaping if creating a web page)."
2701 #: ../src/guestfs.pod:1229
2703 "Guest configuration may be altered in unusual ways by the administrator of "
2704 "the virtual machine, and may not reflect reality (particularly for untrusted "
2705 "or actively malicious guests). For example we parse the hostname from "
2706 "configuration files like C</etc/sysconfig/network> that we find in the "
2707 "guest, but the guest administrator can easily manipulate these files to "
2708 "provide the wrong hostname."
2713 #: ../src/guestfs.pod:1237
2715 "The inspection API parses guest configuration using two external libraries: "
2716 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2717 "designed to be robust in the face of malicious data, although denial of "
2718 "service attacks are still possible, for example with oversized configuration "
2724 #: ../src/guestfs.pod:1243
2725 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2730 #: ../src/guestfs.pod:1245
2732 "Be very cautious about running commands from the guest. By running a "
2733 "command in the guest, you are giving CPU time to a binary that you do not "
2734 "control, under the same user account as the library, albeit wrapped in qemu "
2735 "virtualization. More information and alternatives can be found in the "
2736 "section L</RUNNING COMMANDS>."
2741 #: ../src/guestfs.pod:1251
2742 msgid "CVE-2010-3851"
2747 #: ../src/guestfs.pod:1253
2748 msgid "https://bugzilla.redhat.com/642934"
2753 #: ../src/guestfs.pod:1255
2755 "This security bug concerns the automatic disk format detection that qemu "
2756 "does on disk images."
2761 #: ../src/guestfs.pod:1258
2763 "A raw disk image is just the raw bytes, there is no header. Other disk "
2764 "images like qcow2 contain a special header. Qemu deals with this by looking "
2765 "for one of the known headers, and if none is found then assuming the disk "
2766 "image must be raw."
2771 #: ../src/guestfs.pod:1263
2773 "This allows a guest which has been given a raw disk image to write some "
2774 "other header. At next boot (or when the disk image is accessed by "
2775 "libguestfs) qemu would do autodetection and think the disk image format was, "
2776 "say, qcow2 based on the header written by the guest."
2781 #: ../src/guestfs.pod:1268
2783 "This in itself would not be a problem, but qcow2 offers many features, one "
2784 "of which is to allow a disk image to refer to another image (called the "
2785 "\"backing disk\"). It does this by placing the path to the backing disk "
2786 "into the qcow2 header. This path is not validated and could point to any "
2787 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2788 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2789 "control of the attacker."
2794 #: ../src/guestfs.pod:1276
2796 "In libguestfs this is rather hard to exploit except under two circumstances:"
2801 #: ../src/guestfs.pod:1283
2802 msgid "You have enabled the network or have opened the disk in write mode."
2807 #: ../src/guestfs.pod:1287
2809 "You are also running untrusted code from the guest (see L</RUNNING "
2815 #: ../src/guestfs.pod:1292
2817 "The way to avoid this is to specify the expected disk format when adding "
2818 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2819 "should always do this if the disk is raw format, and it's a good idea for "
2825 #: ../src/guestfs.pod:1297
2827 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2828 "format is fetched from libvirt and passed through."
2833 #: ../src/guestfs.pod:1300
2835 "For libguestfs tools, use the I<--format> command line parameter as "
2841 #: ../src/guestfs.pod:1303
2842 msgid "CONNECTION MANAGEMENT"
2847 #: ../src/guestfs.pod:1305
2853 #: ../src/guestfs.pod:1307
2855 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2856 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2857 "handle and release all resources used."
2862 #: ../src/guestfs.pod:1311
2864 "For information on using multiple handles and threads, see the section L</"
2865 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2870 #: ../src/guestfs.pod:1314
2871 msgid "guestfs_create"
2876 #: ../src/guestfs.pod:1316
2879 " guestfs_h *guestfs_create (void);\n"
2885 #: ../src/guestfs.pod:1318
2886 msgid "Create a connection handle."
2891 #: ../src/guestfs.pod:1320
2893 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2894 "on the handle at least once."
2899 #: ../src/guestfs.pod:1323
2901 "This function returns a non-NULL pointer to a handle on success or NULL on "
2907 #: ../src/guestfs.pod:1326
2908 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2913 #: ../src/guestfs.pod:1328
2915 "You may also want to configure error handling for the handle. See L</ERROR "
2916 "HANDLING> section below."
2921 #: ../src/guestfs.pod:1331
2922 msgid "guestfs_close"
2927 #: ../src/guestfs.pod:1333
2930 " void guestfs_close (guestfs_h *g);\n"
2936 #: ../src/guestfs.pod:1335
2937 msgid "This closes the connection handle and frees up all resources used."
2942 #: ../src/guestfs.pod:1337
2943 msgid "ERROR HANDLING"
2948 #: ../src/guestfs.pod:1339
2950 "API functions can return errors. For example, almost all functions that "
2951 "return C<int> will return C<-1> to indicate an error."
2956 #: ../src/guestfs.pod:1342
2958 "Additional information is available for errors: an error message string and "
2959 "optionally an error number (errno) if the thing that failed was a system "
2965 #: ../src/guestfs.pod:1346
2967 "You can get at the additional information about the last error on the handle "
2968 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2969 "up an error handler with L</guestfs_set_error_handler>."
2974 #: ../src/guestfs.pod:1351
2976 "When the handle is created, a default error handler is installed which "
2977 "prints the error message string to C<stderr>. For small short-running "
2978 "command line programs it is sufficient to do:"
2983 #: ../src/guestfs.pod:1355
2986 " if (guestfs_launch (g) == -1)\n"
2987 " exit (EXIT_FAILURE);\n"
2993 #: ../src/guestfs.pod:1358
2995 "since the default error handler will ensure that an error message has been "
2996 "printed to C<stderr> before the program exits."
3001 #: ../src/guestfs.pod:1361
3003 "For other programs the caller will almost certainly want to install an "
3004 "alternate error handler or do error handling in-line like this:"
3009 #: ../src/guestfs.pod:1364
3012 " g = guestfs_create ();\n"
3018 #: ../src/guestfs.pod:1366
3021 " /* This disables the default behaviour of printing errors\n"
3023 " guestfs_set_error_handler (g, NULL, NULL);\n"
3029 #: ../src/guestfs.pod:1370
3032 " if (guestfs_launch (g) == -1) {\n"
3033 " /* Examine the error message and print it etc. */\n"
3034 " char *msg = guestfs_last_error (g);\n"
3035 " int errnum = guestfs_last_errno (g);\n"
3036 " fprintf (stderr, \"%s\\n\", msg);\n"
3044 #: ../src/guestfs.pod:1378
3046 "Out of memory errors are handled differently. The default action is to call "
3047 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
3048 "guestfs_set_out_of_memory_handler>."
3053 #: ../src/guestfs.pod:1382
3055 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
3056 "because there is no handle if this happens there is no way to get additional "
3057 "error information. However L</guestfs_create> is supposed to be a "
3058 "lightweight operation which can only fail because of insufficient memory (it "
3059 "returns NULL in this case)."
3064 #: ../src/guestfs.pod:1388
3065 msgid "guestfs_last_error"
3070 #: ../src/guestfs.pod:1390
3073 " const char *guestfs_last_error (guestfs_h *g);\n"
3079 #: ../src/guestfs.pod:1392
3081 "This returns the last error message that happened on C<g>. If there has not "
3082 "been an error since the handle was created, then this returns C<NULL>."
3087 #: ../src/guestfs.pod:1396
3089 "The lifetime of the returned string is until the next error occurs, or L</"
3090 "guestfs_close> is called."
3095 #: ../src/guestfs.pod:1399
3096 msgid "guestfs_last_errno"
3101 #: ../src/guestfs.pod:1401
3104 " int guestfs_last_errno (guestfs_h *g);\n"
3110 #: ../src/guestfs.pod:1403
3111 msgid "This returns the last error number (errno) that happened on C<g>."
3116 #: ../src/guestfs.pod:1405
3117 msgid "If successful, an errno integer not equal to zero is returned."
3122 #: ../src/guestfs.pod:1407
3124 "If no error, this returns 0. This call can return 0 in three situations:"
3129 #: ../src/guestfs.pod:1414
3130 msgid "There has not been any error on the handle."
3135 #: ../src/guestfs.pod:1418
3137 "There has been an error but the errno was meaningless. This corresponds to "
3138 "the case where the error did not come from a failed system call, but for "
3139 "some other reason."
3144 #: ../src/guestfs.pod:1424
3146 "There was an error from a failed system call, but for some reason the errno "
3147 "was not captured and returned. This usually indicates a bug in libguestfs."
3152 #: ../src/guestfs.pod:1430
3154 "Libguestfs tries to convert the errno from inside the applicance into a "
3155 "corresponding errno for the caller (not entirely trivial: the appliance "
3156 "might be running a completely different operating system from the library "
3157 "and error numbers are not standardized across Un*xen). If this could not be "
3158 "done, then the error is translated to C<EINVAL>. In practice this should "
3159 "only happen in very rare circumstances."
3164 #: ../src/guestfs.pod:1438
3165 msgid "guestfs_set_error_handler"
3170 #: ../src/guestfs.pod:1440
3173 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3175 " const char *msg);\n"
3176 " void guestfs_set_error_handler (guestfs_h *g,\n"
3177 " guestfs_error_handler_cb cb,\n"
3184 #: ../src/guestfs.pod:1447
3186 "The callback C<cb> will be called if there is an error. The parameters "
3187 "passed to the callback are an opaque data pointer and the error message "
3193 #: ../src/guestfs.pod:1451
3195 "C<errno> is not passed to the callback. To get that the callback must call "
3196 "L</guestfs_last_errno>."
3201 #: ../src/guestfs.pod:1454
3203 "Note that the message string C<msg> is freed as soon as the callback "
3204 "function returns, so if you want to stash it somewhere you must make your "
3210 #: ../src/guestfs.pod:1458
3211 msgid "The default handler prints messages on C<stderr>."
3216 #: ../src/guestfs.pod:1460
3217 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3222 #: ../src/guestfs.pod:1462
3223 msgid "guestfs_get_error_handler"
3228 #: ../src/guestfs.pod:1464
3231 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3232 " void **opaque_rtn);\n"
3238 #: ../src/guestfs.pod:1467
3239 msgid "Returns the current error handler callback."
3244 #: ../src/guestfs.pod:1469
3245 msgid "guestfs_set_out_of_memory_handler"
3250 #: ../src/guestfs.pod:1471
3253 " typedef void (*guestfs_abort_cb) (void);\n"
3254 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3255 " guestfs_abort_cb);\n"
3261 #: ../src/guestfs.pod:1475
3263 "The callback C<cb> will be called if there is an out of memory situation. "
3264 "I<Note this callback must not return>."
3269 #: ../src/guestfs.pod:1478
3270 msgid "The default is to call L<abort(3)>."
3275 #: ../src/guestfs.pod:1480
3277 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3282 #: ../src/guestfs.pod:1483
3283 msgid "guestfs_get_out_of_memory_handler"
3288 #: ../src/guestfs.pod:1485
3291 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3297 #: ../src/guestfs.pod:1487
3298 msgid "This returns the current out of memory handler."
3303 #: ../src/guestfs.pod:1489
3309 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
3315 #: ../src/guestfs.pod:1493
3321 #: ../src/guestfs.pod:1495
3327 #: ../src/guestfs.pod:1497
3328 msgid "AVAILABILITY"
3333 #: ../src/guestfs.pod:1499
3334 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3339 #: ../src/guestfs.pod:1501
3341 "Using L</guestfs_available> you can test availability of the following "
3342 "groups of functions. This test queries the appliance to see if the "
3343 "appliance you are currently using supports the functionality."
3348 #: ../src/guestfs.pod:1506
3349 msgid "@AVAILABILITY@"
3354 #: ../src/guestfs.pod:1508
3355 msgid "GUESTFISH supported COMMAND"
3360 #: ../src/guestfs.pod:1510
3362 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3363 "prints out the available groups and whether they are supported by this build "
3364 "of libguestfs. Note however that you have to do C<run> first."
3369 #: ../src/guestfs.pod:1515
3370 msgid "SINGLE CALLS AT COMPILE TIME"
3375 #: ../src/guestfs.pod:1517
3377 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3378 "function, such as:"
3383 #: ../src/guestfs.pod:1520
3386 " #define LIBGUESTFS_HAVE_DD 1\n"
3392 #: ../src/guestfs.pod:1522
3393 msgid "if L</guestfs_dd> is available."
3398 #: ../src/guestfs.pod:1524
3400 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3401 "function is available at compile time, we recommended using build tools such "
3402 "as autoconf or cmake. For example in autotools you could use:"
3407 #: ../src/guestfs.pod:1529
3410 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3411 " AC_CHECK_FUNCS([guestfs_dd])\n"
3417 #: ../src/guestfs.pod:1532
3419 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3425 #: ../src/guestfs.pod:1535
3426 msgid "SINGLE CALLS AT RUN TIME"
3431 #: ../src/guestfs.pod:1537
3433 "Testing at compile time doesn't guarantee that a function really exists in "
3434 "the library. The reason is that you might be dynamically linked against a "
3435 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3436 "This situation unfortunately results in a segmentation fault, which is a "
3437 "shortcoming of the C dynamic linking system itself."
3442 #: ../src/guestfs.pod:1544
3444 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3445 "in this example program (note that you still need the compile time check as "
3451 #: ../src/guestfs.pod:1548
3454 " #include <stdio.h>\n"
3455 " #include <stdlib.h>\n"
3456 " #include <unistd.h>\n"
3457 " #include <dlfcn.h>\n"
3458 " #include <guestfs.h>\n"
3464 #: ../src/guestfs.pod:1554
3469 " #ifdef LIBGUESTFS_HAVE_DD\n"
3471 " int has_function;\n"
3477 #: ../src/guestfs.pod:1560
3480 " /* Test if the function guestfs_dd is really available. */\n"
3481 " dl = dlopen (NULL, RTLD_LAZY);\n"
3483 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3484 " exit (EXIT_FAILURE);\n"
3486 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3493 #: ../src/guestfs.pod:1569
3496 " if (!has_function)\n"
3497 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3499 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3500 " /* Now it's safe to call\n"
3501 " guestfs_dd (g, \"foo\", \"bar\");\n"
3505 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3513 #: ../src/guestfs.pod:1582
3515 "You may think the above is an awful lot of hassle, and it is. There are "
3516 "other ways outside of the C linking system to ensure that this kind of "
3517 "incompatibility never arises, such as using package versioning:"
3522 #: ../src/guestfs.pod:1587
3525 " Requires: libguestfs >= 1.0.80\n"
3531 #: ../src/guestfs.pod:1589
3532 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3537 #: ../src/guestfs.pod:1591
3539 "A recent feature of the API is the introduction of calls which take optional "
3540 "arguments. In C these are declared 3 ways. The main way is as a call which "
3541 "takes variable arguments (ie. C<...>), as in this example:"
3546 #: ../src/guestfs.pod:1596
3549 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3555 #: ../src/guestfs.pod:1598
3557 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3558 "call with no optional arguments specified:"
3563 #: ../src/guestfs.pod:1601
3566 " guestfs_add_drive_opts (g, filename, -1);\n"
3572 #: ../src/guestfs.pod:1603
3573 msgid "With a single optional argument:"
3578 #: ../src/guestfs.pod:1605
3581 " guestfs_add_drive_opts (g, filename,\n"
3582 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3589 #: ../src/guestfs.pod:1609
3595 #: ../src/guestfs.pod:1611
3598 " guestfs_add_drive_opts (g, filename,\n"
3599 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3600 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3607 #: ../src/guestfs.pod:1616
3609 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3615 #: ../src/guestfs.pod:1619
3616 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3621 #: ../src/guestfs.pod:1621
3623 "The second variant has the same name with the suffix C<_va>, which works the "
3624 "same way but takes a C<va_list>. See the C manual for details. For the "
3625 "example function, this is declared:"
3630 #: ../src/guestfs.pod:1625
3633 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3640 #: ../src/guestfs.pod:1628
3641 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3646 #: ../src/guestfs.pod:1630
3648 "The third variant is useful where you need to construct these calls. You "
3649 "pass in a structure where you fill in the optional fields. The structure "
3650 "has a bitmask as the first element which you must set to indicate which "
3651 "fields you have filled in. For our example function the structure and call "
3657 #: ../src/guestfs.pod:1636
3660 " struct guestfs_add_drive_opts_argv {\n"
3661 " uint64_t bitmask;\n"
3663 " const char *format;\n"
3666 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3667 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3673 #: ../src/guestfs.pod:1645
3674 msgid "You could call it like this:"
3679 #: ../src/guestfs.pod:1647
3682 " struct guestfs_add_drive_opts_argv optargs = {\n"
3683 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3684 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3686 " .format = \"qcow2\"\n"
3693 #: ../src/guestfs.pod:1654
3696 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3702 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3703 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:9
3704 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3710 #: ../src/guestfs.pod:1662
3711 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3716 #: ../src/guestfs.pod:1667
3717 msgid "You do not need to fill in all fields of the structure."
3722 #: ../src/guestfs.pod:1671
3724 "There must be a one-to-one correspondence between fields of the structure "
3725 "that are filled in, and bits set in the bitmask."
3730 #: ../src/guestfs.pod:1676
3731 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3736 #: ../src/guestfs.pod:1678
3738 "In other languages, optional arguments are expressed in the way that is "
3739 "natural for that language. We refer you to the language-specific "
3740 "documentation for more details on that."
3745 #: ../src/guestfs.pod:1682
3746 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3751 #: ../src/guestfs.pod:1684
3752 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3756 #: ../src/guestfs.pod:1686
3758 "B<Note:> This section documents the generic event mechanism introduced in "
3759 "libguestfs 1.10, which you should use in new code if possible. The old "
3760 "functions C<guestfs_set_log_message_callback>, "
3761 "C<guestfs_set_subprocess_quit_callback>, "
3762 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3763 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3768 #: ../src/guestfs.pod:1694
3770 "Handles generate events when certain things happen, such as log messages "
3771 "being generated, progress messages during long-running operations, or the "
3772 "handle being closed. The API calls described below let you register a "
3773 "callback to be called when events happen. You can register multiple "
3774 "callbacks (for the same, different or overlapping sets of events), and "
3775 "individually remove callbacks. If callbacks are not removed, then they "
3776 "remain in force until the handle is closed."
3780 #: ../src/guestfs.pod:1702
3782 "In the current implementation, events are only generated synchronously: that "
3783 "means that events (and hence callbacks) can only happen while you are in the "
3784 "middle of making another libguestfs call. The callback is called in the "
3789 #: ../src/guestfs.pod:1707
3791 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3792 "unsigned integers, or a message buffer. Payloads are discussed later on."
3796 #: ../src/guestfs.pod:1711
3797 msgid "CLASSES OF EVENTS"
3801 #: ../src/guestfs.pod:1715
3802 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3806 #: ../src/guestfs.pod:1718
3808 "The callback function will be called while the handle is being closed "
3809 "(synchronously from L</guestfs_close>)."
3814 #: ../src/guestfs.pod:1721
3816 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3817 "handles that are open when the program exits. This means that this callback "
3818 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3819 "problems in higher-level languages (eg. if your HLL interpreter has already "
3820 "been cleaned up by the time this is called, and if your callback then jumps "
3821 "into some HLL function)."
3825 #: ../src/guestfs.pod:1728
3827 "If no callback is registered: the handle is closed without any callback "
3832 #: ../src/guestfs.pod:1731
3833 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3837 #: ../src/guestfs.pod:1734
3839 "The callback function will be called when the child process quits, either "
3840 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3841 "corresponds to a transition from any state to the CONFIG state)."
3845 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3846 msgid "If no callback is registered: the event is ignored."
3850 #: ../src/guestfs.pod:1740
3851 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3855 #: ../src/guestfs.pod:1743
3857 "The callback function will be called when the child process becomes ready "
3858 "first time after it has been launched. (This corresponds to a transition "
3859 "from LAUNCHING to the READY state)."
3863 #: ../src/guestfs.pod:1749
3864 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3869 #: ../src/guestfs.pod:1752
3871 "Some long-running operations can generate progress messages. If this "
3872 "callback is registered, then it will be called each time a progress message "
3873 "is generated (usually two seconds after the operation started, and three "
3874 "times per second thereafter until it completes, although the frequency may "
3875 "change in future versions)."
3879 #: ../src/guestfs.pod:1758
3881 "The callback receives in the payload four unsigned 64 bit numbers which are "
3882 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3886 #: ../src/guestfs.pod:1761
3888 "The units of C<total> are not defined, although for some operations C<total> "
3889 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3890 "or megabytes), and C<position> may be the portion which has been transferred."
3895 #: ../src/guestfs.pod:1766
3896 msgid "The only defined and stable parts of the API are:"
3901 #: ../src/guestfs.pod:1772
3903 "The callback can display to the user some type of progress bar or indicator "
3904 "which shows the ratio of C<position>:C<total>."
3909 #: ../src/guestfs.pod:1777
3910 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3915 #: ../src/guestfs.pod:1781
3917 "If any progress notification is sent during a call, then a final progress "
3918 "notification is always sent when C<position> = C<total>."
3923 #: ../src/guestfs.pod:1784
3925 "This is to simplify caller code, so callers can easily set the progress "
3926 "indicator to \"100%\" at the end of the operation, without requiring special "
3927 "code to detect this case."
3931 #: ../src/guestfs.pod:1790
3933 "The callback also receives the procedure number (C<proc_nr>) and serial "
3934 "number (C<serial>) of the call. These are only useful for debugging "
3935 "protocol issues, and the callback can normally ignore them. The callback "
3936 "may want to print these numbers in error messages or debugging messages."
3940 #: ../src/guestfs.pod:1796
3941 msgid "If no callback is registered: progress messages are discarded."
3945 #: ../src/guestfs.pod:1798
3946 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3950 #: ../src/guestfs.pod:1801
3952 "The callback function is called whenever a log message is generated by qemu, "
3953 "the appliance kernel, guestfsd (daemon), or utility programs."
3957 #: ../src/guestfs.pod:1804
3959 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3960 "guestfs_launch>) then additional debug messages are generated."
3964 #: ../src/guestfs.pod:1807 ../src/guestfs.pod:1821
3966 "If no callback is registered: the messages are discarded unless the verbose "
3967 "flag is set in which case they are sent to stderr. You can override the "
3968 "printing of verbose messages to stderr by setting up a callback."
3972 #: ../src/guestfs.pod:1812
3973 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3977 #: ../src/guestfs.pod:1815
3979 "The callback function is called whenever a log message is generated by the "
3980 "library part of libguestfs."
3984 #: ../src/guestfs.pod:1818
3986 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3987 "messages are generated."
3991 #: ../src/guestfs.pod:1826
3992 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3996 #: ../src/guestfs.pod:1829
3998 "The callback function is called whenever a trace message is generated. This "
3999 "only applies if the trace flag (L</guestfs_set_trace>) is set."
4003 #: ../src/guestfs.pod:1832
4005 "If no callback is registered: the messages are sent to stderr. You can "
4006 "override the printing of trace messages to stderr by setting up a callback."
4010 #: ../src/guestfs.pod:1838
4011 msgid "guestfs_set_event_callback"
4015 #: ../src/guestfs.pod:1840
4018 " int guestfs_set_event_callback (guestfs_h *g,\n"
4019 " guestfs_event_callback cb,\n"
4020 " uint64_t event_bitmask,\n"
4027 #: ../src/guestfs.pod:1846
4029 "This function registers a callback (C<cb>) for all event classes in the "
4034 #: ../src/guestfs.pod:1849
4036 "For example, to register for all log message events, you could call this "
4037 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
4038 "To register a single callback for all possible classes of events, use "
4039 "C<GUESTFS_EVENT_ALL>."
4043 #: ../src/guestfs.pod:1855
4044 msgid "C<flags> should always be passed as 0."
4048 #: ../src/guestfs.pod:1857
4050 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
4051 "it for any purpose."
4055 #: ../src/guestfs.pod:1860
4057 "The return value is the event handle (an integer) which you can use to "
4058 "delete the callback (see below)."
4062 #: ../src/guestfs.pod:1863
4064 "If there is an error, this function returns C<-1>, and sets the error in the "
4065 "handle in the usual way (see L</guestfs_last_error> etc.)"
4069 #: ../src/guestfs.pod:1866
4071 "Callbacks remain in effect until they are deleted, or until the handle is "
4076 #: ../src/guestfs.pod:1869
4078 "In the case where multiple callbacks are registered for a particular event "
4079 "class, all of the callbacks are called. The order in which multiple "
4080 "callbacks are called is not defined."
4084 #: ../src/guestfs.pod:1873
4085 msgid "guestfs_delete_event_callback"
4089 #: ../src/guestfs.pod:1875
4092 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
4097 #: ../src/guestfs.pod:1877
4099 "Delete a callback that was previously registered. C<event_handle> should be "
4100 "the integer that was returned by a previous call to "
4101 "C<guestfs_set_event_callback> on the same handle."
4105 #: ../src/guestfs.pod:1881
4106 msgid "guestfs_event_callback"
4110 #: ../src/guestfs.pod:1883
4113 " typedef void (*guestfs_event_callback) (\n"
4116 " uint64_t event,\n"
4117 " int event_handle,\n"
4119 " const char *buf, size_t buf_len,\n"
4120 " const uint64_t *array, size_t array_len);\n"
4125 #: ../src/guestfs.pod:1892
4127 "This is the type of the event callback function that you have to provide."
4131 #: ../src/guestfs.pod:1895
4133 "The basic parameters are: the handle (C<g>), the opaque user pointer "
4134 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
4135 "handle, and C<flags> which in the current API you should ignore."
4139 #: ../src/guestfs.pod:1899
4141 "The remaining parameters contain the event payload (if any). Each event may "
4142 "contain a payload, which usually relates to the event class, but for future "
4143 "proofing your code should be written to handle any payload for any event "
4148 #: ../src/guestfs.pod:1904
4150 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
4151 "there is no message buffer). Note that this message buffer can contain "
4152 "arbitrary 8 bit data, including NUL bytes."
4156 #: ../src/guestfs.pod:1908
4158 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
4159 "moment this is only used for progress messages."
4163 #: ../src/guestfs.pod:1911
4164 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
4168 #: ../src/guestfs.pod:1913
4170 "One motivation for the generic event API was to allow GUI programs to "
4171 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
4172 "unconditionally to C<stderr>."
4176 #: ../src/guestfs.pod:1917
4178 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
4179 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
4180 "messages are not events; you must capture error messages separately)."
4184 #: ../src/guestfs.pod:1922
4186 "Programs have to set up a callback to capture the classes of events of "
4191 #: ../src/guestfs.pod:1925
4195 " guestfs_set_event_callback\n"
4196 " (g, message_callback,\n"
4197 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
4198 " GUESTFS_EVENT_TRACE,\n"
4199 " 0, NULL) == -1)\n"
4200 " if (eh == -1) {\n"
4201 " // handle error in the usual way\n"
4207 #: ../src/guestfs.pod:1935
4209 "The callback can then direct messages to the appropriate place. In this "
4210 "example, messages are directed to syslog:"
4214 #: ../src/guestfs.pod:1938
4218 " message_callback (\n"
4221 " uint64_t event,\n"
4222 " int event_handle,\n"
4224 " const char *buf, size_t buf_len,\n"
4225 " const uint64_t *array, size_t array_len)\n"
4227 " const int priority = LOG_USER|LOG_INFO;\n"
4228 " if (buf_len > 0)\n"
4229 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
4236 #: ../src/guestfs.pod:1953
4237 msgid "PRIVATE DATA AREA"
4241 #: ../src/guestfs.pod:1955
4243 "You can attach named pieces of private data to the libguestfs handle, fetch "
4244 "them by name, and walk over them, for the lifetime of the handle. This is "
4245 "called the private data area and is only available from the C API."
4250 #: ../src/guestfs.pod:1960
4251 msgid "To attach a named piece of data, use the following call:"
4256 #: ../src/guestfs.pod:1962
4259 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
4265 #: ../src/guestfs.pod:1964
4267 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
4268 "pointer (which can be C<NULL>). Any previous item with the same name is "
4274 #: ../src/guestfs.pod:1968
4276 "You can use any C<key> you want, but names beginning with an underscore "
4277 "character are reserved for internal libguestfs purposes (for implementing "
4278 "language bindings). It is recommended to prefix the name with some unique "
4279 "string to avoid collisions with other users."
4284 #: ../src/guestfs.pod:1973
4285 msgid "To retrieve the pointer, use:"
4290 #: ../src/guestfs.pod:1975
4293 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
4299 #: ../src/guestfs.pod:1977
4301 "This function returns C<NULL> if either no data is found associated with "
4302 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4307 #: ../src/guestfs.pod:1981
4309 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4310 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4311 "all. In particular, libguestfs does I<not> try to free the data when the "
4312 "handle is closed. If the data must be freed, then the caller must either "
4313 "free it before calling L</guestfs_close> or must set up a close callback to "
4314 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4318 #: ../src/guestfs.pod:1988
4319 msgid "To walk over all entries, use these two functions:"
4323 #: ../src/guestfs.pod:1990
4326 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4331 #: ../src/guestfs.pod:1992
4334 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4339 #: ../src/guestfs.pod:1994
4341 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4342 "not have any particular meaning -- keys are not returned in any defined "
4343 "order). A pointer to the key is returned in C<*key_rtn> and the "
4344 "corresponding data pointer is returned from the function. C<NULL> is "
4345 "returned if there are no keys stored in the handle."
4349 #: ../src/guestfs.pod:2000
4351 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4352 "value of this function is also C<NULL> is there are no further entries to "
4357 #: ../src/guestfs.pod:2004
4358 msgid "Notes about walking over entries:"
4362 #: ../src/guestfs.pod:2010
4364 "You must not call C<guestfs_set_private> while walking over the entries."
4368 #: ../src/guestfs.pod:2015
4370 "The handle maintains an internal iterator which is reset when you call "
4371 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4372 "call C<guestfs_set_private>."
4376 #: ../src/guestfs.pod:2021
4377 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4381 #: ../src/guestfs.pod:2023
4384 " guestfs_set_private (g, key, NULL);\n"
4389 #: ../src/guestfs.pod:2025
4390 msgid "then that C<key> is not returned when walking."
4394 #: ../src/guestfs.pod:2029
4396 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4397 "C<guestfs_next_private> or C<guestfs_set_private>."
4401 #: ../src/guestfs.pod:2035
4403 "The following example code shows how to print all keys and data pointers "
4404 "that are associated with the handle C<g>:"
4408 #: ../src/guestfs.pod:2038
4411 " const char *key;\n"
4412 " void *data = guestfs_first_private (g, &key);\n"
4413 " while (data != NULL)\n"
4415 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4416 " data = guestfs_next_private (g, &key);\n"
4422 #: ../src/guestfs.pod:2046
4424 "More commonly you are only interested in keys that begin with an application-"
4425 "specific prefix C<foo_>. Modify the loop like so:"
4429 #: ../src/guestfs.pod:2049
4432 " const char *key;\n"
4433 " void *data = guestfs_first_private (g, &key);\n"
4434 " while (data != NULL)\n"
4436 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4437 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4438 " data = guestfs_next_private (g, &key);\n"
4444 #: ../src/guestfs.pod:2058
4446 "If you need to modify keys while walking, then you have to jump back to the "
4447 "beginning of the loop. For example, to delete all keys prefixed with "
4452 #: ../src/guestfs.pod:2062
4455 " const char *key;\n"
4458 " data = guestfs_first_private (g, &key);\n"
4459 " while (data != NULL)\n"
4461 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4463 " guestfs_set_private (g, key, NULL);\n"
4464 " /* note that 'key' pointer is now invalid, and so is\n"
4465 " the internal iterator */\n"
4468 " data = guestfs_next_private (g, &key);\n"
4474 #: ../src/guestfs.pod:2078
4476 "Note that the above loop is guaranteed to terminate because the keys are "
4477 "being deleted, but other manipulations of keys within the loop might not "
4478 "terminate unless you also maintain an indication of which keys have been "
4484 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4490 #: ../src/guestfs.pod:2085
4492 "<!-- old anchor for the next section --> <a name="
4493 "\"state_machine_and_low_level_event_api\"/>"
4498 #: ../src/guestfs.pod:2090
4499 msgid "ARCHITECTURE"
4504 #: ../src/guestfs.pod:2092
4506 "Internally, libguestfs is implemented by running an appliance (a special "
4507 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4508 "process of the main program."
4513 #: ../src/guestfs.pod:2096
4516 " ___________________\n"
4518 " | main program |\n"
4520 " | | child process / appliance\n"
4521 " | | __________________________\n"
4523 " +-------------------+ RPC | +-----------------+ |\n"
4524 " | libguestfs <--------------------> guestfsd | |\n"
4525 " | | | +-----------------+ |\n"
4526 " \\___________________/ | | Linux kernel | |\n"
4527 " | +--^--------------+ |\n"
4528 " \\_________|________________/\n"
4534 " \\______________/\n"
4540 #: ../src/guestfs.pod:2116
4542 "The library, linked to the main program, creates the child process and hence "
4543 "the appliance in the L</guestfs_launch> function."
4548 #: ../src/guestfs.pod:2119
4550 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4551 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4552 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4553 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4554 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4555 "attached to the qemu process which translates device access by the "
4556 "appliance's Linux kernel into accesses to the image."
4561 #: ../src/guestfs.pod:2128
4563 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4564 "Although the disk image you are attached to might also be used by some "
4565 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4566 "care if both libguestfs's qemu process and your virtual machine are trying "
4567 "to update the disk image at the same time, since these usually results in "
4568 "massive disk corruption)."
4573 #: ../src/guestfs.pod:2135
4574 msgid "STATE MACHINE"
4579 #: ../src/guestfs.pod:2137
4580 msgid "libguestfs uses a state machine to model the child process:"
4585 #: ../src/guestfs.pod:2139
4597 " / | \\ \\ guestfs_launch\n"
4598 " / | _\\__V______\n"
4600 " / | | LAUNCHING |\n"
4601 " / | \\___________/\n"
4603 " / | guestfs_launch\n"
4605 " ______ / __|____V\n"
4606 " / \\ ------> / \\\n"
4607 " | BUSY | | READY |\n"
4608 " \\______/ <------ \\________/\n"
4614 #: ../src/guestfs.pod:2161
4616 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4617 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4618 "(3) alternating between READY and BUSY as commands are issued to, and "
4619 "carried out by, the child process."
4624 #: ../src/guestfs.pod:2166
4626 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4627 "asynchronously at any time (eg. due to some internal error), and that causes "
4628 "the state to transition back to CONFIG."
4633 #: ../src/guestfs.pod:2170
4635 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4636 "issued when in the CONFIG state."
4641 #: ../src/guestfs.pod:2173
4643 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4644 "L</guestfs_launch> blocks until the child process is READY to accept "
4645 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4646 "moves the state from CONFIG to LAUNCHING while it is running."
4651 #: ../src/guestfs.pod:2179
4653 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4654 "state. These API calls block waiting for the command to be carried out (ie. "
4655 "the state to transition to BUSY and then back to READY). There are no non-"
4656 "blocking versions, and no way to issue more than one command per handle at "
4662 #: ../src/guestfs.pod:2185
4664 "Finally, the child process sends asynchronous messages back to the main "
4665 "program, such as kernel log messages. You can register a callback to "
4666 "receive these messages."
4671 #: ../src/guestfs.pod:2189
4677 #: ../src/guestfs.pod:2191
4678 msgid "COMMUNICATION PROTOCOL"
4683 #: ../src/guestfs.pod:2193
4685 "Don't rely on using this protocol directly. This section documents how it "
4686 "currently works, but it may change at any time."
4691 #: ../src/guestfs.pod:2196
4693 "The protocol used to talk between the library and the daemon running inside "
4694 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4695 "1014, RFC 1832, RFC 4506)."
4700 #: ../src/guestfs.pod:2200
4702 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4703 "this file is automatically generated)."
4708 #: ../src/guestfs.pod:2203
4710 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4711 "and C<FileOut> parameters, which are handled with very simple request/reply "
4712 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4713 "parameters, which use the same request and reply messages, but they may also "
4714 "be followed by files sent using a chunked encoding."
4719 #: ../src/guestfs.pod:2210
4720 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4725 #: ../src/guestfs.pod:2212
4726 msgid "For ordinary functions, the request message is:"
4731 #: ../src/guestfs.pod:2214
4734 " total length (header + arguments,\n"
4735 " but not including the length word itself)\n"
4736 " struct guestfs_message_header (encoded as XDR)\n"
4737 " struct guestfs_<foo>_args (encoded as XDR)\n"
4743 #: ../src/guestfs.pod:2219
4745 "The total length field allows the daemon to allocate a fixed size buffer "
4746 "into which it slurps the rest of the message. As a result, the total length "
4747 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4748 "effective size of any request is limited to somewhere under this size."
4753 #: ../src/guestfs.pod:2225
4755 "Note also that many functions don't take any arguments, in which case the "
4756 "C<guestfs_I<foo>_args> is completely omitted."
4761 #: ../src/guestfs.pod:2228
4763 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4764 "receiver knows what type of args structure to expect, or none at all."
4769 #: ../src/guestfs.pod:2232
4771 "For functions that take optional arguments, the optional arguments are "
4772 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4773 "arguments. A bitmask in the header indicates which optional arguments are "
4774 "meaningful. The bitmask is also checked to see if it contains bits set "
4775 "which the daemon does not know about (eg. if more optional arguments were "
4776 "added in a later version of the library), and this causes the call to be "
4782 #: ../src/guestfs.pod:2240
4783 msgid "The reply message for ordinary functions is:"
4788 #: ../src/guestfs.pod:2242
4791 " total length (header + ret,\n"
4792 " but not including the length word itself)\n"
4793 " struct guestfs_message_header (encoded as XDR)\n"
4794 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4800 #: ../src/guestfs.pod:2247
4802 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4803 "functions that return no formal return values."
4808 #: ../src/guestfs.pod:2250
4810 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4815 #: ../src/guestfs.pod:2253
4817 "In the case of an error, a flag is set in the header, and the reply message "
4818 "is slightly changed:"
4823 #: ../src/guestfs.pod:2256
4826 " total length (header + error,\n"
4827 " but not including the length word itself)\n"
4828 " struct guestfs_message_header (encoded as XDR)\n"
4829 " struct guestfs_message_error (encoded as XDR)\n"
4835 #: ../src/guestfs.pod:2261
4837 "The C<guestfs_message_error> structure contains the error message as a "
4843 #: ../src/guestfs.pod:2264
4844 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4849 #: ../src/guestfs.pod:2266
4851 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4852 "The normal request message is sent (see above). However this is followed by "
4853 "a sequence of file chunks."
4858 #: ../src/guestfs.pod:2270
4861 " total length (header + arguments,\n"
4862 " but not including the length word itself,\n"
4863 " and not including the chunks)\n"
4864 " struct guestfs_message_header (encoded as XDR)\n"
4865 " struct guestfs_<foo>_args (encoded as XDR)\n"
4866 " sequence of chunks for FileIn param #0\n"
4867 " sequence of chunks for FileIn param #1 etc.\n"
4873 #: ../src/guestfs.pod:2278
4874 msgid "The \"sequence of chunks\" is:"
4879 #: ../src/guestfs.pod:2280
4882 " length of chunk (not including length word itself)\n"
4883 " struct guestfs_chunk (encoded as XDR)\n"
4884 " length of chunk\n"
4885 " struct guestfs_chunk (encoded as XDR)\n"
4887 " length of chunk\n"
4888 " struct guestfs_chunk (with data.data_len == 0)\n"
4894 #: ../src/guestfs.pod:2288
4896 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4897 "is set in the final chunk to indicate either successful completion or early "
4903 #: ../src/guestfs.pod:2292
4905 "At time of writing there are no functions that have more than one FileIn "
4906 "parameter. However this is (theoretically) supported, by sending the "
4907 "sequence of chunks for each FileIn parameter one after another (from left to "
4913 #: ../src/guestfs.pod:2297
4915 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4916 "transfer. The library does this by sending a chunk with a special flag set "
4917 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4918 "RPC, does I<not> send any reply, and goes back to reading the next request."
4923 #: ../src/guestfs.pod:2303
4925 "The daemon may also cancel. It does this by writing a special word "
4926 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4927 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4928 "cancel chunk). The special word is chosen so that even if cancellation "
4929 "happens right at the end of the transfer (after the library has finished "
4930 "writing and has started listening for the reply), the \"spurious\" cancel "
4931 "flag will not be confused with the reply message."
4936 #: ../src/guestfs.pod:2312
4938 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4939 "limit), and also files where the size is not known in advance (eg. from "
4940 "pipes or sockets). However the chunks are rather small "
4941 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4942 "to keep much in memory."
4947 #: ../src/guestfs.pod:2318
4948 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4953 #: ../src/guestfs.pod:2320
4955 "The protocol for FileOut parameters is exactly the same as for FileIn "
4956 "parameters, but with the roles of daemon and library reversed."
4961 #: ../src/guestfs.pod:2323
4964 " total length (header + ret,\n"
4965 " but not including the length word itself,\n"
4966 " and not including the chunks)\n"
4967 " struct guestfs_message_header (encoded as XDR)\n"
4968 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4969 " sequence of chunks for FileOut param #0\n"
4970 " sequence of chunks for FileOut param #1 etc.\n"
4976 #: ../src/guestfs.pod:2331
4977 msgid "INITIAL MESSAGE"
4982 #: ../src/guestfs.pod:2333
4984 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4985 "which indicates that the guest and daemon is alive. This is what L</"
4986 "guestfs_launch> waits for."
4991 #: ../src/guestfs.pod:2337
4992 msgid "PROGRESS NOTIFICATION MESSAGES"
4997 #: ../src/guestfs.pod:2339
4999 "The daemon may send progress notification messages at any time. These are "
5000 "distinguished by the normal length word being replaced by "
5001 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
5005 #: ../src/guestfs.pod:2343
5007 "The library turns them into progress callbacks (see L</"
5008 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
5014 #: ../src/guestfs.pod:2347
5016 "The daemon self-limits the frequency of progress messages it sends (see "
5017 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
5023 #: ../src/guestfs.pod:2351
5024 msgid "LIBGUESTFS VERSION NUMBERS"
5029 #: ../src/guestfs.pod:2353
5031 "Since April 2010, libguestfs has started to make separate development and "
5032 "stable releases, along with corresponding branches in our git repository. "
5033 "These separate releases can be identified by version number:"
5038 #: ../src/guestfs.pod:2358
5041 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
5042 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
5048 " | `-------- sub-version\n"
5050 " `------ always '1' because we don't change the ABI\n"
5056 #: ../src/guestfs.pod:2369
5057 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
5062 #: ../src/guestfs.pod:2371
5064 "As time passes we cherry pick fixes from the development branch and backport "
5065 "those into the stable branch, the effect being that the stable branch should "
5066 "get more stable and less buggy over time. So the stable releases are ideal "
5067 "for people who don't need new features but would just like the software to "
5073 #: ../src/guestfs.pod:2377
5074 msgid "Our criteria for backporting changes are:"
5079 #: ../src/guestfs.pod:2383
5081 "Documentation changes which don't affect any code are backported unless the "
5082 "documentation refers to a future feature which is not in stable."
5087 #: ../src/guestfs.pod:2389
5089 "Bug fixes which are not controversial, fix obvious problems, and have been "
5090 "well tested are backported."
5095 #: ../src/guestfs.pod:2394
5097 "Simple rearrangements of code which shouldn't affect how it works get "
5098 "backported. This is so that the code in the two branches doesn't get too "
5099 "far out of step, allowing us to backport future fixes more easily."
5104 #: ../src/guestfs.pod:2400
5106 "We I<don't> backport new features, new APIs, new tools etc, except in one "
5107 "exceptional case: the new feature is required in order to implement an "
5108 "important bug fix."
5113 #: ../src/guestfs.pod:2406
5115 "A new stable branch starts when we think the new features in development are "
5116 "substantial and compelling enough over the current stable branch to warrant "
5117 "it. When that happens we create new stable and development versions 1.N.0 "
5118 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
5119 "stable at this point, but by backporting fixes from development, that branch "
5120 "will stabilize over time."
5124 #: ../src/guestfs.pod:2414
5125 msgid "EXTENDING LIBGUESTFS"
5129 #: ../src/guestfs.pod:2416
5130 msgid "ADDING A NEW API ACTION"
5134 #: ../src/guestfs.pod:2418
5136 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
5137 "documentation) are generated, and this makes it easy to extend the "
5142 #: ../src/guestfs.pod:2422
5143 msgid "To add a new API action there are two changes:"
5147 #: ../src/guestfs.pod:2428
5149 "You need to add a description of the call (name, parameters, return type, "
5150 "tests, documentation) to C<generator/generator_actions.ml>."
5154 #: ../src/guestfs.pod:2431
5156 "There are two sorts of API action, depending on whether the call goes "
5157 "through to the daemon in the appliance, or is serviced entirely by the "
5158 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
5159 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
5160 "an example of the latter, since a trace flag is maintained in the handle and "
5161 "all tracing is done on the library side."
5165 #: ../src/guestfs.pod:2439
5167 "Most new actions are of the first type, and get added to the "
5168 "C<daemon_functions> list. Each function has a unique procedure number used "
5169 "in the RPC protocol which is assigned to that action when we publish "
5170 "libguestfs and cannot be reused. Take the latest procedure number and "
5175 #: ../src/guestfs.pod:2445
5177 "For library-only actions of the second type, add to the "
5178 "C<non_daemon_functions> list. Since these functions are serviced by the "
5179 "library and do not travel over the RPC mechanism to the daemon, these "
5180 "functions do not need a procedure number, and so the procedure number is set "
5185 #: ../src/guestfs.pod:2453
5186 msgid "Implement the action (in C):"
5190 #: ../src/guestfs.pod:2455
5192 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
5193 "C<daemon/> directory."
5197 #: ../src/guestfs.pod:2458
5199 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
5200 "(note: double underscore) in the C<src/> directory."
5204 #: ../src/guestfs.pod:2461
5205 msgid "In either case, use another function as an example of what to do."
5209 #: ../src/guestfs.pod:2465
5210 msgid "After making these changes, use C<make> to compile."
5214 #: ../src/guestfs.pod:2467
5216 "Note that you don't need to implement the RPC, language bindings, manual "
5217 "pages or anything else. It's all automatically generated from the OCaml "
5222 #: ../src/guestfs.pod:2471
5223 msgid "ADDING TESTS FOR AN API ACTION"
5227 #: ../src/guestfs.pod:2473
5229 "You can supply zero or as many tests as you want per API call. The tests "
5230 "can either be added as part of the API description (C<generator/"
5231 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
5232 "into C<regressions/>. Note that adding a script to C<regressions/> is "
5233 "slower, so if possible use the first method."
5237 #: ../src/guestfs.pod:2479
5239 "The following describes the test environment used when you add an API test "
5240 "in C<generator_actions.ml>."
5244 #: ../src/guestfs.pod:2482
5245 msgid "The test environment has 4 block devices:"
5249 #: ../src/guestfs.pod:2486
5250 msgid "C</dev/sda> 500MB"
5254 #: ../src/guestfs.pod:2488
5255 msgid "General block device for testing."
5259 #: ../src/guestfs.pod:2490
5260 msgid "C</dev/sdb> 50MB"
5264 #: ../src/guestfs.pod:2492
5266 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
5271 #: ../src/guestfs.pod:2495
5272 msgid "C</dev/sdc> 10MB"
5276 #: ../src/guestfs.pod:2497
5277 msgid "Used in a few tests where two block devices are needed."
5281 #: ../src/guestfs.pod:2499
5286 #: ../src/guestfs.pod:2501
5287 msgid "ISO with fixed content (see C<images/test.iso>)."
5291 #: ../src/guestfs.pod:2505
5293 "To be able to run the tests in a reasonable amount of time, the libguestfs "
5294 "appliance and block devices are reused between tests. So don't try testing "
5295 "L</guestfs_kill_subprocess> :-x"
5299 #: ../src/guestfs.pod:2509
5301 "Each test starts with an initial scenario, selected using one of the "
5302 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
5303 "initialize the disks mentioned above in a particular way as documented in "
5304 "C<generator_types.ml>. You should not assume anything about the previous "
5305 "contents of other disks that are not initialized."
5309 #: ../src/guestfs.pod:2515
5311 "You can add a prerequisite clause to any individual test. This is a run-"
5312 "time check, which, if it fails, causes the test to be skipped. Useful if "
5313 "testing a command which might not work on all variations of libguestfs "
5314 "builds. A test that has prerequisite of C<Always> means to run "
5319 #: ../src/guestfs.pod:2521
5321 "In addition, packagers can skip individual tests by setting environment "
5322 "variables before running C<make check>."
5326 #: ../src/guestfs.pod:2524
5329 " SKIP_TEST_<CMD>_<NUM>=1\n"
5334 #: ../src/guestfs.pod:2526
5335 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
5339 #: ../src/guestfs.pod:2528
5344 #: ../src/guestfs.pod:2530
5347 " SKIP_TEST_<CMD>=1\n"
5352 #: ../src/guestfs.pod:2532
5353 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
5357 #: ../src/guestfs.pod:2534
5358 msgid "Packagers can run only certain tests by setting for example:"
5362 #: ../src/guestfs.pod:2536
5365 " TEST_ONLY=\"vfs_type zerofree\"\n"
5370 #: ../src/guestfs.pod:2538
5372 "See C<capitests/tests.c> for more details of how these environment variables "
5377 #: ../src/guestfs.pod:2541
5378 msgid "DEBUGGING NEW API ACTIONS"
5382 #: ../src/guestfs.pod:2543
5383 msgid "Test new actions work before submitting them."
5387 #: ../src/guestfs.pod:2545
5388 msgid "You can use guestfish to try out new commands."
5392 #: ../src/guestfs.pod:2547
5394 "Debugging the daemon is a problem because it runs inside a minimal "
5395 "environment. However you can fprintf messages in the daemon to stderr, and "
5396 "they will show up if you use C<guestfish -v>."
5400 #: ../src/guestfs.pod:2551
5401 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5405 #: ../src/guestfs.pod:2553
5407 "Our C source code generally adheres to some basic code-formatting "
5408 "conventions. The existing code base is not totally consistent on this "
5409 "front, but we do prefer that contributed code be formatted similarly. In "
5410 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5411 "indentation level, and other than that, follow the K&R style."
5415 #: ../src/guestfs.pod:2559
5417 "If you use Emacs, add the following to one of one of your start-up files (e."
5418 "g., ~/.emacs), to help ensure that you get indentation right:"
5422 #: ../src/guestfs.pod:2562
5425 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5426 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5427 " (add-hook 'find-file-hook\n"
5428 " '(lambda () (if (and buffer-file-name\n"
5429 " (string-match \"/libguestfs\\\\>\"\n"
5430 " (buffer-file-name))\n"
5431 " (not (string-equal mode-name \"Change Log\"))\n"
5432 " (not (string-equal mode-name \"Makefile\")))\n"
5433 " (setq indent-tabs-mode nil))))\n"
5438 #: ../src/guestfs.pod:2572
5441 " ;;; When editing C sources in libguestfs, use this style.\n"
5442 " (defun libguestfs-c-mode ()\n"
5443 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5445 " (c-set-style \"K&R\")\n"
5446 " (setq c-indent-level 2)\n"
5447 " (setq c-basic-offset 2))\n"
5448 " (add-hook 'c-mode-hook\n"
5449 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5450 " (buffer-file-name))\n"
5451 " (libguestfs-c-mode))))\n"
5456 #: ../src/guestfs.pod:2584
5457 msgid "Enable warnings when compiling (and fix any problems this finds):"
5461 #: ../src/guestfs.pod:2587
5464 " ./configure --enable-gcc-warnings\n"
5469 #: ../src/guestfs.pod:2589
5470 msgid "Useful targets are:"
5474 #: ../src/guestfs.pod:2591
5477 " make syntax-check # checks the syntax of the C code\n"
5478 " make check # runs the test suite\n"
5483 #: ../src/guestfs.pod:2594
5484 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5488 #: ../src/guestfs.pod:2596
5490 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5491 "which are used to do shell quoting."
5495 #: ../src/guestfs.pod:2601
5500 #: ../src/guestfs.pod:2603
5502 "Simple shell quoted string. Any spaces or other shell characters are "
5507 #: ../src/guestfs.pod:2606
5512 #: ../src/guestfs.pod:2608
5514 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5520 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5521 msgid "For example:"
5525 #: ../src/guestfs.pod:2615
5528 " asprintf (&cmd, \"cat %R\", path);\n"
5533 #: ../src/guestfs.pod:2617
5534 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5538 #: ../src/guestfs.pod:2619
5540 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5541 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5542 "they are not passed via the shell (instead, straight to exec). You probably "
5543 "want to use the C<sysroot_path()> function however."
5547 #: ../src/guestfs.pod:2625
5548 msgid "SUBMITTING YOUR NEW API ACTIONS"
5552 #: ../src/guestfs.pod:2627
5554 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5555 "libguestfs> and CC to L<rjones@redhat.com>."
5559 #: ../src/guestfs.pod:2631
5560 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5564 #: ../src/guestfs.pod:2633
5565 msgid "We support i18n (gettext anyhow) in the library."
5569 #: ../src/guestfs.pod:2635
5571 "However many messages come from the daemon, and we don't translate those at "
5572 "the moment. One reason is that the appliance generally has all locale files "
5573 "removed from it, because they take up a lot of space. So we'd have to readd "
5574 "some of those, as well as copying our PO files into the appliance."
5578 #: ../src/guestfs.pod:2641
5580 "Debugging messages are never translated, since they are intended for the "
5585 #: ../src/guestfs.pod:2644
5586 msgid "SOURCE CODE SUBDIRECTORIES"
5590 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5725
5591 #: ../fish/guestfish-actions.pod:3842
5592 msgid "C<appliance>"
5596 #: ../src/guestfs.pod:2650
5597 msgid "The libguestfs appliance, build scripts and so on."
5601 #: ../src/guestfs.pod:2652
5602 msgid "C<capitests>"
5606 #: ../src/guestfs.pod:2654
5607 msgid "Automated tests of the C API."
5611 #: ../src/guestfs.pod:2656
5616 #: ../src/guestfs.pod:2658
5618 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5623 #: ../src/guestfs.pod:2661
5628 #: ../src/guestfs.pod:2663
5629 msgid "Outside contributions, experimental parts."
5633 #: ../src/guestfs.pod:2665
5638 #: ../src/guestfs.pod:2667
5640 "The daemon that runs inside the libguestfs appliance and carries out actions."
5644 #: ../src/guestfs.pod:2670
5649 #: ../src/guestfs.pod:2672
5650 msgid "L<virt-df(1)> command and documentation."
5654 #: ../src/guestfs.pod:2674
5659 #: ../src/guestfs.pod:2676
5660 msgid "C API example code."
5664 #: ../src/guestfs.pod:2678
5669 #: ../src/guestfs.pod:2680
5671 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5672 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5673 "L<virt-tar-out(1)>."
5677 #: ../src/guestfs.pod:2684
5682 #: ../src/guestfs.pod:2686
5684 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5688 #: ../src/guestfs.pod:2688
5689 msgid "C<generator>"
5693 #: ../src/guestfs.pod:2690
5695 "The crucially important generator, used to automatically generate large "
5696 "amounts of boilerplate C code for things like RPC and bindings."
5700 #: ../src/guestfs.pod:2693
5705 #: ../src/guestfs.pod:2695
5706 msgid "Files used by the test suite."
5710 #: ../src/guestfs.pod:2697
5711 msgid "Some \"phony\" guest images which we test against."
5715 #: ../src/guestfs.pod:2699
5716 msgid "C<inspector>"
5720 #: ../src/guestfs.pod:2701
5721 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5725 #: ../src/guestfs.pod:2703
5730 #: ../src/guestfs.pod:2705
5731 msgid "Logo used on the website. The fish is called Arthur by the way."
5735 #: ../src/guestfs.pod:2707
5740 #: ../src/guestfs.pod:2709
5741 msgid "M4 macros used by autoconf."
5745 #: ../src/guestfs.pod:2711
5750 #: ../src/guestfs.pod:2713
5751 msgid "Translations of simple gettext strings."
5755 #: ../src/guestfs.pod:2715
5760 #: ../src/guestfs.pod:2717
5762 "The build infrastructure and PO files for translations of manpages and POD "
5763 "files. Eventually this will be combined with the C<po> directory, but that "
5764 "is rather complicated."
5768 #: ../src/guestfs.pod:2721
5769 msgid "C<regressions>"
5773 #: ../src/guestfs.pod:2723
5774 msgid "Regression tests."
5778 #: ../src/guestfs.pod:2725
5783 #: ../src/guestfs.pod:2727
5784 msgid "L<virt-rescue(1)> command and documentation."
5788 #: ../src/guestfs.pod:2729
5793 #: ../src/guestfs.pod:2731
5794 msgid "Source code to the C library."
5798 #: ../src/guestfs.pod:2733
5803 #: ../src/guestfs.pod:2735
5804 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5808 #: ../src/guestfs.pod:2737
5809 msgid "C<test-tool>"
5813 #: ../src/guestfs.pod:2739
5815 "Test tool for end users to test if their qemu/kernel combination will work "
5820 #: ../src/guestfs.pod:2742
5825 #: ../src/guestfs.pod:2744
5830 #: ../src/guestfs.pod:2746
5835 #: ../src/guestfs.pod:2748
5840 #: ../src/guestfs.pod:2750
5845 #: ../src/guestfs.pod:2752
5850 #: ../src/guestfs.pod:2754
5855 #: ../src/guestfs.pod:2756
5860 #: ../src/guestfs.pod:2758
5861 msgid "Language bindings."
5866 #: ../src/guestfs.pod:2762 ../fish/guestfish.pod:1010
5867 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5868 msgid "ENVIRONMENT VARIABLES"
5873 #: ../src/guestfs.pod:2766 ../fish/guestfish.pod:1036
5874 msgid "LIBGUESTFS_APPEND"
5879 #: ../src/guestfs.pod:2768 ../fish/guestfish.pod:1038
5880 msgid "Pass additional options to the guest kernel."
5885 #: ../src/guestfs.pod:2770 ../fish/guestfish.pod:1040
5886 msgid "LIBGUESTFS_DEBUG"
5891 #: ../src/guestfs.pod:2772
5893 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5894 "effect as calling C<guestfs_set_verbose (g, 1)>."
5899 #: ../src/guestfs.pod:2775 ../fish/guestfish.pod:1045
5900 msgid "LIBGUESTFS_MEMSIZE"
5905 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1047
5907 "Set the memory allocated to the qemu process, in megabytes. For example:"
5912 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1050
5915 " LIBGUESTFS_MEMSIZE=700\n"
5921 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1052
5922 msgid "LIBGUESTFS_PATH"
5926 #: ../src/guestfs.pod:2784
5928 "Set the path that libguestfs uses to search for a supermin appliance. See "
5929 "the discussion of paths in section L</PATH> above."
5934 #: ../src/guestfs.pod:2787 ../fish/guestfish.pod:1057
5935 msgid "LIBGUESTFS_QEMU"
5940 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1059
5942 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5943 "which was found at compile time by the configure script is used."
5948 #: ../src/guestfs.pod:2793
5949 msgid "See also L</QEMU WRAPPERS> above."
5954 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1063
5955 msgid "LIBGUESTFS_TRACE"
5960 #: ../src/guestfs.pod:2797
5962 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5963 "effect as calling C<guestfs_set_trace (g, 1)>."
5968 #: ../src/guestfs.pod:2800 ../fish/guestfish.pod:1072
5973 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1074
5975 "Location of temporary directory, defaults to C</tmp> except for the cached "
5976 "supermin appliance which defaults to C</var/tmp>."
5980 #: ../src/guestfs.pod:2805 ../fish/guestfish.pod:1077
5982 "If libguestfs was compiled to use the supermin appliance then the real "
5983 "appliance is cached in this directory, shared between all handles belonging "
5984 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5985 "use in case C</var/tmp> is not large enough."
5990 #: ../src/guestfs.pod:2813 ../fish/guestfish.pod:1144
5991 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:267
5992 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572
5993 #: ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189
5994 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5995 #: ../tools/virt-list-partitions.pl:257
6000 #: ../src/guestfs.pod:2815
6002 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
6003 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
6004 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
6005 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
6006 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
6007 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
6008 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
6013 #: ../src/guestfs.pod:2842
6015 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
6016 "(8)>, L<disktype(1)>."
6021 #: ../src/guestfs.pod:2849 ../tools/virt-win-reg.pl:587
6022 #: ../tools/virt-make-fs.pl:553
6028 #: ../src/guestfs.pod:2851
6029 msgid "To get a list of bugs against libguestfs use this link:"
6034 #: ../src/guestfs.pod:2853
6036 "L<https://bugzilla.redhat.com/buglist.cgi?"
6037 "component=libguestfs&product=Virtualization+Tools>"
6042 #: ../src/guestfs.pod:2855
6043 msgid "To report a new bug against libguestfs use this link:"
6048 #: ../src/guestfs.pod:2857
6050 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
6051 "component=libguestfs&product=Virtualization+Tools>"
6056 #: ../src/guestfs.pod:2859
6057 msgid "When reporting a bug, please check:"
6062 #: ../src/guestfs.pod:2865
6063 msgid "That the bug hasn't been reported already."
6068 #: ../src/guestfs.pod:2869
6069 msgid "That you are testing a recent version."
6074 #: ../src/guestfs.pod:2873
6075 msgid "Describe the bug accurately, and give a way to reproduce it."
6080 #: ../src/guestfs.pod:2877
6082 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
6088 #: ../src/guestfs.pod:2882 ../fish/guestfish.pod:1167
6089 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:278
6095 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1169
6096 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:280
6097 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
6102 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1171
6103 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:282
6104 #: ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602
6105 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206
6106 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
6107 #: ../tools/virt-list-partitions.pl:273
6113 #: ../src/guestfs.pod:2888 ../fuse/guestmount.pod:284
6114 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
6119 #: ../src/guestfs.pod:2891
6121 "This library is free software; you can redistribute it and/or modify it "
6122 "under the terms of the GNU Lesser General Public License as published by the "
6123 "Free Software Foundation; either version 2 of the License, or (at your "
6124 "option) any later version."
6129 #: ../src/guestfs.pod:2896
6131 "This library is distributed in the hope that it will be useful, but WITHOUT "
6132 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
6133 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
6139 #: ../src/guestfs.pod:2901
6141 "You should have received a copy of the GNU Lesser General Public License "
6142 "along with this library; if not, write to the Free Software Foundation, "
6143 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
6148 #: ../src/guestfs-actions.pod:1
6149 msgid "guestfs_add_cdrom"
6154 #: ../src/guestfs-actions.pod:3
6158 " guestfs_add_cdrom (guestfs_h *g,\n"
6159 " const char *filename);\n"
6165 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
6166 msgid "This function adds a virtual CD-ROM disk image to the guest."
6171 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
6172 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
6177 #: ../src/guestfs-actions.pod:17
6179 "This call checks for the existence of C<filename>. This stops you from "
6180 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6181 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6187 #: ../src/guestfs-actions.pod:24
6189 "If you just want to add an ISO file (often you use this as an efficient way "
6190 "to transfer large files into the guest), then you should probably use "
6191 "C<guestfs_add_drive_ro> instead."
6196 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
6197 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
6198 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
6199 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
6200 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
6201 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
6202 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
6203 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
6204 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
6205 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
6206 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
6207 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
6208 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
6209 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
6210 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
6211 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
6212 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1332
6213 #: ../src/guestfs-actions.pod:1438 ../src/guestfs-actions.pod:1472
6214 #: ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1712
6215 #: ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2261
6216 #: ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2466
6217 #: ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:3375
6218 #: ../src/guestfs-actions.pod:3390 ../src/guestfs-actions.pod:3410
6219 #: ../src/guestfs-actions.pod:3565 ../src/guestfs-actions.pod:3579
6220 #: ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:3606
6221 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3657
6222 #: ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:3749
6223 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:3789
6224 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3844
6225 #: ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3882
6226 #: ../src/guestfs-actions.pod:3917 ../src/guestfs-actions.pod:3929
6227 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:3981
6228 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4009
6229 #: ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4119
6230 #: ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4152
6231 #: ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4221
6232 #: ../src/guestfs-actions.pod:4239 ../src/guestfs-actions.pod:4255
6233 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4283
6234 #: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4315
6235 #: ../src/guestfs-actions.pod:4335 ../src/guestfs-actions.pod:4393
6236 #: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4497
6237 #: ../src/guestfs-actions.pod:4516 ../src/guestfs-actions.pod:4535
6238 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4564
6239 #: ../src/guestfs-actions.pod:4577 ../src/guestfs-actions.pod:4592
6240 #: ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4642
6241 #: ../src/guestfs-actions.pod:4657 ../src/guestfs-actions.pod:4677
6242 #: ../src/guestfs-actions.pod:4691 ../src/guestfs-actions.pod:4708
6243 #: ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4794
6244 #: ../src/guestfs-actions.pod:4808 ../src/guestfs-actions.pod:4836
6245 #: ../src/guestfs-actions.pod:4853 ../src/guestfs-actions.pod:4871
6246 #: ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5062
6247 #: ../src/guestfs-actions.pod:5084 ../src/guestfs-actions.pod:5102
6248 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5200
6249 #: ../src/guestfs-actions.pod:5217 ../src/guestfs-actions.pod:5230
6250 #: ../src/guestfs-actions.pod:5244 ../src/guestfs-actions.pod:5533
6251 #: ../src/guestfs-actions.pod:5552 ../src/guestfs-actions.pod:5571
6252 #: ../src/guestfs-actions.pod:5583 ../src/guestfs-actions.pod:5595
6253 #: ../src/guestfs-actions.pod:5609 ../src/guestfs-actions.pod:5621
6254 #: ../src/guestfs-actions.pod:5635 ../src/guestfs-actions.pod:5651
6255 #: ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5691
6256 #: ../src/guestfs-actions.pod:5710 ../src/guestfs-actions.pod:5740
6257 #: ../src/guestfs-actions.pod:5756 ../src/guestfs-actions.pod:5779
6258 #: ../src/guestfs-actions.pod:5797 ../src/guestfs-actions.pod:5816
6259 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5856
6260 #: ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5901
6261 #: ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5944
6262 #: ../src/guestfs-actions.pod:5968 ../src/guestfs-actions.pod:5987
6263 #: ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6021
6264 #: ../src/guestfs-actions.pod:6058 ../src/guestfs-actions.pod:6081
6265 #: ../src/guestfs-actions.pod:6107 ../src/guestfs-actions.pod:6215
6266 #: ../src/guestfs-actions.pod:6336 ../src/guestfs-actions.pod:6348
6267 #: ../src/guestfs-actions.pod:6361 ../src/guestfs-actions.pod:6374
6268 #: ../src/guestfs-actions.pod:6396 ../src/guestfs-actions.pod:6409
6269 #: ../src/guestfs-actions.pod:6422 ../src/guestfs-actions.pod:6435
6270 #: ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6509
6271 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6542
6272 #: ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6575
6273 #: ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6608
6274 #: ../src/guestfs-actions.pod:6644 ../src/guestfs-actions.pod:6658
6275 #: ../src/guestfs-actions.pod:6699 ../src/guestfs-actions.pod:6712
6276 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-actions.pod:6764
6277 #: ../src/guestfs-actions.pod:6800 ../src/guestfs-actions.pod:6919
6278 #: ../src/guestfs-actions.pod:6937 ../src/guestfs-actions.pod:6951
6279 #: ../src/guestfs-actions.pod:7006 ../src/guestfs-actions.pod:7019
6280 #: ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7097
6281 #: ../src/guestfs-actions.pod:7151 ../src/guestfs-actions.pod:7177
6282 #: ../src/guestfs-actions.pod:7243 ../src/guestfs-actions.pod:7262
6283 #: ../src/guestfs-actions.pod:7291
6284 msgid "This function returns 0 on success or -1 on error."
6289 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6290 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6291 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6293 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6299 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6300 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1443
6301 #: ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:1960
6302 #: ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:7185
6303 #: ../src/guestfs-actions.pod:7354 ../fish/guestfish-actions.pod:31
6304 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6305 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6306 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:2942
6307 #: ../fish/guestfish-actions.pod:4800 ../fish/guestfish-actions.pod:4897
6309 "Deprecated functions will not be removed from the API, but the fact that "
6310 "they are deprecated indicates that there are problems with correct use of "
6316 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6317 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1911
6318 #: ../src/guestfs-actions.pod:2009 ../src/guestfs-actions.pod:2112
6319 #: ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3392
6320 #: ../src/guestfs-actions.pod:4644 ../src/guestfs-actions.pod:5758
6321 #: ../src/guestfs-actions.pod:5875 ../src/guestfs-actions.pod:5989
6322 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6577
6323 #: ../src/guestfs-actions.pod:7099
6324 msgid "(Added in 0.3)"
6329 #: ../src/guestfs-actions.pod:41
6330 msgid "guestfs_add_domain"
6335 #: ../src/guestfs-actions.pod:43
6339 " guestfs_add_domain (guestfs_h *g,\n"
6340 " const char *dom,\n"
6347 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6348 #: ../src/guestfs-actions.pod:4354
6350 "You may supply a list of optional arguments to this call. Use zero or more "
6351 "of the following pairs of parameters, and terminate the list with C<-1> on "
6352 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6356 #: ../src/guestfs-actions.pod:53
6359 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6360 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6361 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6362 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6368 #: ../src/guestfs-actions.pod:58
6370 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6371 "It works by connecting to libvirt, requesting the domain and domain XML from "
6372 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6378 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6380 "The number of disks added is returned. This operation is atomic: if an "
6381 "error is returned, then no disks are added."
6386 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6388 "This function does some minimal checks to make sure the libvirt domain is "
6389 "not running (unless C<readonly> is true). In a future version we will try "
6390 "to acquire the libvirt lock on each disk."
6395 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6397 "Disks must be accessible locally. This often means that adding disks from a "
6398 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6399 "unless those disks are accessible via the same device path locally too."
6403 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6405 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6406 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6407 "libvirt URI (or one set through an environment variable, see the libvirt "
6408 "documentation for full details)."
6412 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6414 "The optional C<live> flag controls whether this call will try to connect to "
6415 "a running virtual machine C<guestfsd> process if it sees a suitable "
6416 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6417 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6418 "DAEMONS> for more information."
6423 #: ../src/guestfs-actions.pod:88
6425 "The other optional parameters are passed directly through to "
6426 "C<guestfs_add_drive_opts>."
6431 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6432 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6433 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6434 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6435 #: ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1872
6436 #: ../src/guestfs-actions.pod:1981 ../src/guestfs-actions.pod:2021
6437 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2099
6438 #: ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2723
6439 #: ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:4780
6440 #: ../src/guestfs-actions.pod:4908 ../src/guestfs-actions.pod:5314
6441 #: ../src/guestfs-actions.pod:5340 ../src/guestfs-actions.pod:6685
6442 #: ../src/guestfs-actions.pod:7110 ../src/guestfs-actions.pod:7123
6443 #: ../src/guestfs-actions.pod:7136
6444 msgid "On error this function returns -1."
6449 #: ../src/guestfs-actions.pod:93
6450 msgid "(Added in 1.7.4)"
6455 #: ../src/guestfs-actions.pod:95
6456 msgid "guestfs_add_domain_va"
6461 #: ../src/guestfs-actions.pod:97
6465 " guestfs_add_domain_va (guestfs_h *g,\n"
6466 " const char *dom,\n"
6473 #: ../src/guestfs-actions.pod:102
6474 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6479 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6480 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6481 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4419
6482 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6487 #: ../src/guestfs-actions.pod:106
6488 msgid "guestfs_add_domain_argv"
6493 #: ../src/guestfs-actions.pod:108
6497 " guestfs_add_domain_argv (guestfs_h *g,\n"
6498 " const char *dom,\n"
6499 " const struct guestfs_add_domain_argv *optargs);\n"
6505 #: ../src/guestfs-actions.pod:113
6506 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6511 #: ../src/guestfs-actions.pod:117
6512 msgid "guestfs_add_drive"
6517 #: ../src/guestfs-actions.pod:119
6521 " guestfs_add_drive (guestfs_h *g,\n"
6522 " const char *filename);\n"
6528 #: ../src/guestfs-actions.pod:123
6530 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6531 "optional parameters, so the disk is added writable, with the format being "
6532 "detected automatically."
6537 #: ../src/guestfs-actions.pod:127
6539 "Automatic detection of the format opens you up to a potential security hole "
6540 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6541 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6542 "you should think about replacing calls to this function with calls to "
6543 "C<guestfs_add_drive_opts>, and specifying the format."
6548 #: ../src/guestfs-actions.pod:138
6549 msgid "guestfs_add_drive_opts"
6554 #: ../src/guestfs-actions.pod:140
6558 " guestfs_add_drive_opts (guestfs_h *g,\n"
6559 " const char *filename,\n"
6566 #: ../src/guestfs-actions.pod:150
6569 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6570 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6571 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6577 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6579 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6580 "The first time you call this function, the disk appears as C</dev/sda>, the "
6581 "second time as C</dev/sdb>, and so on."
6586 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6588 "You don't necessarily need to be root when using libguestfs. However you "
6589 "obviously do need sufficient permissions to access the filename for whatever "
6590 "operations you want to perform (ie. read access if you just want to read the "
6591 "image or write access if you want to modify the image)."
6596 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6597 msgid "This call checks that C<filename> exists."
6602 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4365
6603 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2953
6604 msgid "The optional arguments are:"
6609 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6615 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6617 "If true then the image is treated as read-only. Writes are still allowed, "
6618 "but they are stored in a temporary snapshot overlay which is discarded at "
6619 "the end. The disk that you add is not modified."
6624 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6630 #: ../src/guestfs-actions.pod:179
6632 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6633 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6634 "Possible formats include C<raw> and C<qcow2>."
6639 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6641 "Automatic detection of the format opens you up to a potential security hole "
6642 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6643 "RHBZ#642934. Specifying the format closes this security hole."
6648 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6654 #: ../src/guestfs-actions.pod:190
6656 "This rarely-used option lets you emulate the behaviour of the deprecated "
6657 "C<guestfs_add_drive_with_if> call (q.v.)"
6662 #: ../src/guestfs-actions.pod:197
6663 msgid "(Added in 1.5.23)"
6668 #: ../src/guestfs-actions.pod:199
6669 msgid "guestfs_add_drive_opts_va"
6674 #: ../src/guestfs-actions.pod:201
6678 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6679 " const char *filename,\n"
6686 #: ../src/guestfs-actions.pod:206
6687 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6692 #: ../src/guestfs-actions.pod:210
6693 msgid "guestfs_add_drive_opts_argv"
6698 #: ../src/guestfs-actions.pod:212
6702 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6703 " const char *filename,\n"
6704 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6710 #: ../src/guestfs-actions.pod:217
6711 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6716 #: ../src/guestfs-actions.pod:221
6717 msgid "guestfs_add_drive_ro"
6722 #: ../src/guestfs-actions.pod:223
6726 " guestfs_add_drive_ro (guestfs_h *g,\n"
6727 " const char *filename);\n"
6733 #: ../src/guestfs-actions.pod:227
6735 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6736 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6737 "disk is added read-only, with the format being detected automatically."
6742 #: ../src/guestfs-actions.pod:234
6743 msgid "(Added in 1.0.38)"
6748 #: ../src/guestfs-actions.pod:236
6749 msgid "guestfs_add_drive_ro_with_if"
6754 #: ../src/guestfs-actions.pod:238
6758 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6759 " const char *filename,\n"
6760 " const char *iface);\n"
6766 #: ../src/guestfs-actions.pod:243
6768 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6769 "QEMU interface emulation to use at run time."
6774 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6775 #: ../src/guestfs-actions.pod:2351
6776 msgid "(Added in 1.0.84)"
6781 #: ../src/guestfs-actions.pod:257
6782 msgid "guestfs_add_drive_with_if"
6787 #: ../src/guestfs-actions.pod:259
6791 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6792 " const char *filename,\n"
6793 " const char *iface);\n"
6799 #: ../src/guestfs-actions.pod:264
6801 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6802 "QEMU interface emulation to use at run time."
6807 #: ../src/guestfs-actions.pod:278
6808 msgid "guestfs_aug_clear"
6813 #: ../src/guestfs-actions.pod:280
6817 " guestfs_aug_clear (guestfs_h *g,\n"
6818 " const char *augpath);\n"
6824 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6826 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6827 "L<augtool(1)> C<clear> command."
6832 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2101
6833 msgid "(Added in 1.3.4)"
6838 #: ../src/guestfs-actions.pod:291
6839 msgid "guestfs_aug_close"
6844 #: ../src/guestfs-actions.pod:293
6848 " guestfs_aug_close (guestfs_h *g);\n"
6854 #: ../src/guestfs-actions.pod:296
6856 "Close the current Augeas handle and free up any resources used by it. After "
6857 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6858 "any other Augeas functions."
6863 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6864 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6865 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6866 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6867 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6868 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6869 #: ../src/guestfs-actions.pod:5391
6870 msgid "(Added in 0.7)"
6875 #: ../src/guestfs-actions.pod:305
6876 msgid "guestfs_aug_defnode"
6881 #: ../src/guestfs-actions.pod:307
6884 " struct guestfs_int_bool *\n"
6885 " guestfs_aug_defnode (guestfs_h *g,\n"
6886 " const char *name,\n"
6887 " const char *expr,\n"
6888 " const char *val);\n"
6894 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6896 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6901 #: ../src/guestfs-actions.pod:316
6903 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6904 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6905 "containing that single node."
6910 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6912 "On success this returns a pair containing the number of nodes in the "
6913 "nodeset, and a boolean flag if a node was created."
6918 #: ../src/guestfs-actions.pod:324
6920 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6921 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6926 #: ../src/guestfs-actions.pod:330
6927 msgid "guestfs_aug_defvar"
6932 #: ../src/guestfs-actions.pod:332
6936 " guestfs_aug_defvar (guestfs_h *g,\n"
6937 " const char *name,\n"
6938 " const char *expr);\n"
6944 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6946 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6947 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6952 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6954 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6955 "evaluates to something which is not a nodeset."
6960 #: ../src/guestfs-actions.pod:348
6961 msgid "guestfs_aug_get"
6966 #: ../src/guestfs-actions.pod:350
6970 " guestfs_aug_get (guestfs_h *g,\n"
6971 " const char *augpath);\n"
6977 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6979 "Look up the value associated with C<path>. If C<path> matches exactly one "
6980 "node, the C<value> is returned."
6985 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6986 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6987 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6988 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6989 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1349
6990 #: ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1652
6991 #: ../src/guestfs-actions.pod:1815 ../src/guestfs-actions.pod:1832
6992 #: ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1933
6993 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:2124
6994 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2523
6995 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2675
6996 #: ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:2809
6997 #: ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2864
6998 #: ../src/guestfs-actions.pod:2901 ../src/guestfs-actions.pod:2961
6999 #: ../src/guestfs-actions.pod:2984 ../src/guestfs-actions.pod:3551
7000 #: ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:4071
7001 #: ../src/guestfs-actions.pod:4181 ../src/guestfs-actions.pod:4926
7002 #: ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5289
7003 #: ../src/guestfs-actions.pod:5467 ../src/guestfs-actions.pod:5516
7004 #: ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6144
7005 #: ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6185
7006 #: ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6878
7007 #: ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:7076
7008 #: ../src/guestfs-actions.pod:7348
7010 "This function returns a string, or NULL on error. I<The caller must free "
7011 "the returned string after use>."
7016 #: ../src/guestfs-actions.pod:362
7017 msgid "guestfs_aug_init"
7022 #: ../src/guestfs-actions.pod:364
7026 " guestfs_aug_init (guestfs_h *g,\n"
7027 " const char *root,\n"
7034 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
7036 "Create a new Augeas handle for editing configuration files. If there was "
7037 "any previous Augeas handle associated with this guestfs session, then it is "
7043 #: ../src/guestfs-actions.pod:373
7044 msgid "You must call this before using any other C<guestfs_aug_*> commands."
7049 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
7051 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7056 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
7058 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7059 "logical I<or> of the following integers:"
7064 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
7065 msgid "C<AUG_SAVE_BACKUP> = 1"
7070 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
7071 msgid "Keep the original file with a C<.augsave> extension."
7076 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
7077 msgid "C<AUG_SAVE_NEWFILE> = 2"
7082 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
7084 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7085 "original. Overrides C<AUG_SAVE_BACKUP>."
7090 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
7091 msgid "C<AUG_TYPE_CHECK> = 4"
7096 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
7097 msgid "Typecheck lenses (can be expensive)."
7102 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
7103 msgid "C<AUG_NO_STDINC> = 8"
7108 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
7109 msgid "Do not use standard load path for modules."
7114 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
7115 msgid "C<AUG_SAVE_NOOP> = 16"
7120 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
7121 msgid "Make save a no-op, just record what would have been changed."
7126 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
7127 msgid "C<AUG_NO_LOAD> = 32"
7132 #: ../src/guestfs-actions.pod:408
7133 msgid "Do not load the tree in C<guestfs_aug_init>."
7138 #: ../src/guestfs-actions.pod:412
7139 msgid "To close the handle, you can call C<guestfs_aug_close>."
7144 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
7145 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7150 #: ../src/guestfs-actions.pod:420
7151 msgid "guestfs_aug_insert"
7156 #: ../src/guestfs-actions.pod:422
7160 " guestfs_aug_insert (guestfs_h *g,\n"
7161 " const char *augpath,\n"
7162 " const char *label,\n"
7169 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
7171 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7172 "or after C<path> (depending on the boolean flag C<before>)."
7177 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
7179 "C<path> must match exactly one existing node in the tree, and C<label> must "
7180 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7185 #: ../src/guestfs-actions.pod:440
7186 msgid "guestfs_aug_load"
7191 #: ../src/guestfs-actions.pod:442
7195 " guestfs_aug_load (guestfs_h *g);\n"
7201 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
7202 msgid "Load files into the tree."
7207 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
7208 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7213 #: ../src/guestfs-actions.pod:454
7214 msgid "guestfs_aug_ls"
7219 #: ../src/guestfs-actions.pod:456
7223 " guestfs_aug_ls (guestfs_h *g,\n"
7224 " const char *augpath);\n"
7230 #: ../src/guestfs-actions.pod:460
7232 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
7233 "sorting the resulting nodes into alphabetical order."
7238 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
7239 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
7240 #: ../src/guestfs-actions.pod:1364 ../src/guestfs-actions.pod:1383
7241 #: ../src/guestfs-actions.pod:1486 ../src/guestfs-actions.pod:1505
7242 #: ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:2196
7243 #: ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:2231
7244 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:2298
7245 #: ../src/guestfs-actions.pod:2369 ../src/guestfs-actions.pod:2418
7246 #: ../src/guestfs-actions.pod:2633 ../src/guestfs-actions.pod:2918
7247 #: ../src/guestfs-actions.pod:3186 ../src/guestfs-actions.pod:3471
7248 #: ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:3638
7249 #: ../src/guestfs-actions.pod:4043 ../src/guestfs-actions.pod:4741
7250 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5387
7251 #: ../src/guestfs-actions.pod:5501 ../src/guestfs-actions.pod:6201
7252 #: ../src/guestfs-actions.pod:6262 ../src/guestfs-actions.pod:6317
7253 #: ../src/guestfs-actions.pod:6463 ../src/guestfs-actions.pod:6487
7254 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6989
7255 #: ../src/guestfs-actions.pod:7036 ../src/guestfs-actions.pod:7201
7256 #: ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7305
7257 #: ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7370
7258 #: ../src/guestfs-actions.pod:7389
7260 "This function returns a NULL-terminated array of strings (like L<environ(3)"
7261 ">), or NULL if there was an error. I<The caller must free the strings and "
7262 "the array after use>."
7267 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
7268 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1421
7269 #: ../src/guestfs-actions.pod:3264 ../src/guestfs-actions.pod:3295
7270 #: ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3934
7271 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4154
7272 #: ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4745
7273 #: ../src/guestfs-actions.pod:5202 ../src/guestfs-actions.pod:5597
7274 #: ../src/guestfs-actions.pod:5611 ../src/guestfs-actions.pod:5623
7275 #: ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6701
7276 #: ../src/guestfs-actions.pod:6714 ../src/guestfs-actions.pod:6953
7277 #: ../src/guestfs-actions.pod:7189
7278 msgid "(Added in 0.8)"
7283 #: ../src/guestfs-actions.pod:469
7284 msgid "guestfs_aug_match"
7289 #: ../src/guestfs-actions.pod:471
7293 " guestfs_aug_match (guestfs_h *g,\n"
7294 " const char *augpath);\n"
7300 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
7302 "Returns a list of paths which match the path expression C<path>. The "
7303 "returned paths are sufficiently qualified so that they match exactly one "
7304 "node in the current tree."
7309 #: ../src/guestfs-actions.pod:485
7310 msgid "guestfs_aug_mv"
7315 #: ../src/guestfs-actions.pod:487
7319 " guestfs_aug_mv (guestfs_h *g,\n"
7320 " const char *src,\n"
7321 " const char *dest);\n"
7327 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
7329 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7330 "C<dest> is overwritten if it exists."
7335 #: ../src/guestfs-actions.pod:499
7336 msgid "guestfs_aug_rm"
7341 #: ../src/guestfs-actions.pod:501
7345 " guestfs_aug_rm (guestfs_h *g,\n"
7346 " const char *augpath);\n"
7352 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
7353 msgid "Remove C<path> and all of its children."
7358 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
7359 msgid "On success this returns the number of entries which were removed."
7364 #: ../src/guestfs-actions.pod:513
7365 msgid "guestfs_aug_save"
7370 #: ../src/guestfs-actions.pod:515
7374 " guestfs_aug_save (guestfs_h *g);\n"
7380 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
7381 msgid "This writes all pending changes to disk."
7386 #: ../src/guestfs-actions.pod:520
7388 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7394 #: ../src/guestfs-actions.pod:527
7395 msgid "guestfs_aug_set"
7400 #: ../src/guestfs-actions.pod:529
7404 " guestfs_aug_set (guestfs_h *g,\n"
7405 " const char *augpath,\n"
7406 " const char *val);\n"
7412 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7413 msgid "Set the value associated with C<path> to C<val>."
7418 #: ../src/guestfs-actions.pod:536
7420 "In the Augeas API, it is possible to clear a node by setting the value to "
7421 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7422 "this call. Instead you must use the C<guestfs_aug_clear> call."
7427 #: ../src/guestfs-actions.pod:545
7428 msgid "guestfs_available"
7433 #: ../src/guestfs-actions.pod:547
7437 " guestfs_available (guestfs_h *g,\n"
7438 " char *const *groups);\n"
7444 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7446 "This command is used to check the availability of some groups of "
7447 "functionality in the appliance, which not all builds of the libguestfs "
7448 "appliance will be able to provide."
7453 #: ../src/guestfs-actions.pod:555
7455 "The libguestfs groups, and the functions that those groups correspond to, "
7456 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7457 "runtime by calling C<guestfs_available_all_groups>."
7462 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7464 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7465 "\"]> would check for the availability of the Linux inotify functions and "
7466 "Augeas (configuration file editing) functions."
7471 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7472 msgid "The command returns no error if I<all> requested groups are available."
7477 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7479 "It fails with an error if one or more of the requested groups is unavailable "
7485 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7487 "If an unknown group name is included in the list of groups then an error is "
7493 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7499 #: ../src/guestfs-actions.pod:579
7500 msgid "You must call C<guestfs_launch> before calling this function."
7505 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7507 "The reason is because we don't know what groups are supported by the "
7508 "appliance/daemon until it is running and can be queried."
7513 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7515 "If a group of functions is available, this does not necessarily mean that "
7516 "they will work. You still have to check for errors when calling individual "
7517 "API functions even if they are available."
7522 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7524 "It is usually the job of distro packagers to build complete functionality "
7525 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7526 "with all requirements satisfied, will support everything."
7531 #: ../src/guestfs-actions.pod:601
7533 "This call was added in version C<1.0.80>. In previous versions of "
7534 "libguestfs all you could do would be to speculatively execute a command to "
7535 "find out if the daemon implemented it. See also C<guestfs_version>."
7540 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7541 msgid "(Added in 1.0.80)"
7546 #: ../src/guestfs-actions.pod:612
7547 msgid "guestfs_available_all_groups"
7552 #: ../src/guestfs-actions.pod:614
7556 " guestfs_available_all_groups (guestfs_h *g);\n"
7562 #: ../src/guestfs-actions.pod:617
7564 "This command returns a list of all optional groups that this daemon knows "
7565 "about. Note this returns both supported and unsupported groups. To find "
7566 "out which ones the daemon can actually support you have to call "
7567 "C<guestfs_available> on each member of the returned list."
7572 #: ../src/guestfs-actions.pod:623
7573 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7578 #: ../src/guestfs-actions.pod:629
7579 msgid "(Added in 1.3.15)"
7584 #: ../src/guestfs-actions.pod:631
7585 msgid "guestfs_base64_in"
7590 #: ../src/guestfs-actions.pod:633
7594 " guestfs_base64_in (guestfs_h *g,\n"
7595 " const char *base64file,\n"
7596 " const char *filename);\n"
7602 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7604 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7609 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7610 msgid "(Added in 1.3.5)"
7615 #: ../src/guestfs-actions.pod:645
7616 msgid "guestfs_base64_out"
7621 #: ../src/guestfs-actions.pod:647
7625 " guestfs_base64_out (guestfs_h *g,\n"
7626 " const char *filename,\n"
7627 " const char *base64file);\n"
7633 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7635 "This command downloads the contents of C<filename>, writing it out to local "
7636 "file C<base64file> encoded as base64."
7641 #: ../src/guestfs-actions.pod:659
7642 msgid "guestfs_blockdev_flushbufs"
7647 #: ../src/guestfs-actions.pod:661
7651 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7652 " const char *device);\n"
7658 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7660 "This tells the kernel to flush internal buffers associated with C<device>."
7665 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7666 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7667 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7668 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7669 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7670 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7671 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7672 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7673 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7674 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7675 msgid "This uses the L<blockdev(8)> command."
7680 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7681 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7682 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7683 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7684 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7685 msgid "(Added in 0.9.3)"
7690 #: ../src/guestfs-actions.pod:674
7691 msgid "guestfs_blockdev_getbsz"
7696 #: ../src/guestfs-actions.pod:676
7700 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7701 " const char *device);\n"
7707 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7708 msgid "This returns the block size of a device."
7713 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7714 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7716 "(Note this is different from both I<size in blocks> and I<filesystem block "
7722 #: ../src/guestfs-actions.pod:691
7723 msgid "guestfs_blockdev_getro"
7728 #: ../src/guestfs-actions.pod:693
7732 " guestfs_blockdev_getro (guestfs_h *g,\n"
7733 " const char *device);\n"
7739 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7741 "Returns a boolean indicating if the block device is read-only (true if read-"
7742 "only, false if not)."
7747 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1404
7748 #: ../src/guestfs-actions.pod:1419 ../src/guestfs-actions.pod:1909
7749 #: ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:1992
7750 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2062
7751 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110
7752 #: ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3021
7753 #: ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3203
7754 #: ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3232
7755 #: ../src/guestfs-actions.pod:3246 ../src/guestfs-actions.pod:3262
7756 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3293
7757 #: ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3320
7758 #: ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3349
7759 #: ../src/guestfs-actions.pod:3364 ../src/guestfs-actions.pod:4890
7760 msgid "This function returns a C truth value on success or -1 on error."
7765 #: ../src/guestfs-actions.pod:706
7766 msgid "guestfs_blockdev_getsize64"
7771 #: ../src/guestfs-actions.pod:708
7775 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7776 " const char *device);\n"
7782 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7783 msgid "This returns the size of the device in bytes."
7788 #: ../src/guestfs-actions.pod:714
7789 msgid "See also C<guestfs_blockdev_getsz>."
7794 #: ../src/guestfs-actions.pod:722
7795 msgid "guestfs_blockdev_getss"
7800 #: ../src/guestfs-actions.pod:724
7804 " guestfs_blockdev_getss (guestfs_h *g,\n"
7805 " const char *device);\n"
7811 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7813 "This returns the size of sectors on a block device. Usually 512, but can be "
7814 "larger for modern devices."
7819 #: ../src/guestfs-actions.pod:731
7821 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7827 #: ../src/guestfs-actions.pod:740
7828 msgid "guestfs_blockdev_getsz"
7833 #: ../src/guestfs-actions.pod:742
7837 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7838 " const char *device);\n"
7844 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7846 "This returns the size of the device in units of 512-byte sectors (even if "
7847 "the sectorsize isn't 512 bytes ... weird)."
7852 #: ../src/guestfs-actions.pod:749
7854 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7855 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7860 #: ../src/guestfs-actions.pod:759
7861 msgid "guestfs_blockdev_rereadpt"
7866 #: ../src/guestfs-actions.pod:761
7870 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7871 " const char *device);\n"
7877 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7878 msgid "Reread the partition table on C<device>."
7883 #: ../src/guestfs-actions.pod:773
7884 msgid "guestfs_blockdev_setbsz"
7889 #: ../src/guestfs-actions.pod:775
7893 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7894 " const char *device,\n"
7895 " int blocksize);\n"
7901 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7902 msgid "This sets the block size of a device."
7907 #: ../src/guestfs-actions.pod:791
7908 msgid "guestfs_blockdev_setro"
7913 #: ../src/guestfs-actions.pod:793
7917 " guestfs_blockdev_setro (guestfs_h *g,\n"
7918 " const char *device);\n"
7924 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7925 msgid "Sets the block device named C<device> to read-only."
7930 #: ../src/guestfs-actions.pod:805
7931 msgid "guestfs_blockdev_setrw"
7936 #: ../src/guestfs-actions.pod:807
7940 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7941 " const char *device);\n"
7947 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7948 msgid "Sets the block device named C<device> to read-write."
7953 #: ../src/guestfs-actions.pod:819
7954 msgid "guestfs_case_sensitive_path"
7959 #: ../src/guestfs-actions.pod:821
7963 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7964 " const char *path);\n"
7970 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7972 "This can be used to resolve case insensitive paths on a filesystem which is "
7973 "case sensitive. The use case is to resolve paths which you have read from "
7974 "Windows configuration files or the Windows Registry, to the true path."
7979 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7981 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7982 "(and probably others), which is that although the underlying filesystem is "
7983 "case-insensitive, the driver exports the filesystem to Linux as case-"
7989 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7991 "One consequence of this is that special directories such as C<c:\\windows> "
7992 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7993 "precise details of how they were created. In Windows itself this would not "
7999 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
8001 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
8007 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
8009 "This function resolves the true case of each element in the path and returns "
8010 "the case-sensitive path."
8015 #: ../src/guestfs-actions.pod:847
8017 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
8018 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
8019 "how the directories were originally created under Windows)."
8024 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
8025 msgid "I<Note>: This function does not handle drive names, backslashes etc."
8030 #: ../src/guestfs-actions.pod:855
8031 msgid "See also C<guestfs_realpath>."
8036 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6881
8037 msgid "(Added in 1.0.75)"
8042 #: ../src/guestfs-actions.pod:862
8048 #: ../src/guestfs-actions.pod:864
8052 " guestfs_cat (guestfs_h *g,\n"
8053 " const char *path);\n"
8059 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5377
8060 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3601
8061 msgid "Return the contents of the file named C<path>."
8066 #: ../src/guestfs-actions.pod:870
8068 "Note that this function cannot correctly handle binary files (specifically, "
8069 "files containing C<\\0> character which is treated as end of string). For "
8070 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
8071 "functions which have a more complex interface."
8076 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
8077 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1368
8078 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1490
8079 #: ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:1758
8080 #: ../src/guestfs-actions.pod:2216 ../src/guestfs-actions.pod:2235
8081 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:2302
8082 #: ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:2348
8083 #: ../src/guestfs-actions.pod:5159 ../src/guestfs-actions.pod:5185
8084 #: ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5342
8085 #: ../src/guestfs-actions.pod:5366 ../src/guestfs-actions.pod:6266
8086 #: ../src/guestfs-actions.pod:6321 ../src/guestfs-actions.pod:6467
8087 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:7153
8088 #: ../src/guestfs-actions.pod:7179 ../src/guestfs-actions.pod:7205
8089 #: ../src/guestfs-actions.pod:7224 ../src/guestfs-actions.pod:7309
8090 #: ../src/guestfs-actions.pod:7328 ../src/guestfs-actions.pod:7374
8091 #: ../src/guestfs-actions.pod:7393 ../fish/guestfish-actions.pod:587
8092 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
8093 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
8094 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
8095 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
8096 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
8097 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
8098 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3471
8099 #: ../fish/guestfish-actions.pod:3486 ../fish/guestfish-actions.pod:3562
8100 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3594
8101 #: ../fish/guestfish-actions.pod:4220 ../fish/guestfish-actions.pod:4266
8102 #: ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4366
8103 #: ../fish/guestfish-actions.pod:4776 ../fish/guestfish-actions.pod:4794
8104 #: ../fish/guestfish-actions.pod:4811 ../fish/guestfish-actions.pod:4821
8105 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
8106 #: ../fish/guestfish-actions.pod:4908 ../fish/guestfish-actions.pod:4918
8108 "Because of the message protocol, there is a transfer limit of somewhere "
8109 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8114 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3475
8115 #: ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3554
8116 #: ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:4047
8117 #: ../src/guestfs-actions.pod:4061 ../src/guestfs-actions.pod:5265
8118 #: ../src/guestfs-actions.pod:5279 ../src/guestfs-actions.pod:7040
8119 #: ../src/guestfs-actions.pod:7054
8120 msgid "(Added in 0.4)"
8125 #: ../src/guestfs-actions.pod:883
8126 msgid "guestfs_checksum"
8131 #: ../src/guestfs-actions.pod:885
8135 " guestfs_checksum (guestfs_h *g,\n"
8136 " const char *csumtype,\n"
8137 " const char *path);\n"
8143 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
8145 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8150 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
8152 "The type of checksum to compute is given by the C<csumtype> parameter which "
8153 "must have one of the following values:"
8158 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
8164 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
8166 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8172 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
8178 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
8179 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8184 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
8190 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
8191 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8196 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
8202 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
8203 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8208 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
8214 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
8215 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8220 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
8226 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
8227 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8232 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
8238 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
8239 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8244 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
8245 msgid "The checksum is returned as a printable string."
8250 #: ../src/guestfs-actions.pod:931
8251 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
8256 #: ../src/guestfs-actions.pod:933
8257 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
8262 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
8263 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:3219
8264 #: ../src/guestfs-actions.pod:3248 ../src/guestfs-actions.pod:3309
8265 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:6737
8266 msgid "(Added in 1.0.2)"
8271 #: ../src/guestfs-actions.pod:940
8272 msgid "guestfs_checksum_device"
8277 #: ../src/guestfs-actions.pod:942
8281 " guestfs_checksum_device (guestfs_h *g,\n"
8282 " const char *csumtype,\n"
8283 " const char *device);\n"
8289 #: ../src/guestfs-actions.pod:947
8291 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8292 "device named C<device>. For the types of checksums supported see the "
8293 "C<guestfs_checksum> command."
8298 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4796
8299 #: ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4892
8300 #: ../src/guestfs-actions.pod:4910 ../src/guestfs-actions.pod:5086
8301 #: ../src/guestfs-actions.pod:6646 ../src/guestfs-actions.pod:6660
8302 #: ../src/guestfs-actions.pod:7066
8303 msgid "(Added in 1.3.2)"
8308 #: ../src/guestfs-actions.pod:956
8309 msgid "guestfs_checksums_out"
8314 #: ../src/guestfs-actions.pod:958
8318 " guestfs_checksums_out (guestfs_h *g,\n"
8319 " const char *csumtype,\n"
8320 " const char *directory,\n"
8321 " const char *sumsfile);\n"
8327 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
8329 "This command computes the checksums of all regular files in C<directory> and "
8330 "then emits a list of those checksums to the local output file C<sumsfile>."
8335 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
8337 "This can be used for verifying the integrity of a virtual machine. However "
8338 "to be properly secure you should pay attention to the output of the checksum "
8339 "command (it uses the ones from GNU coreutils). In particular when the "
8340 "filename is not printable, coreutils uses a special backslash syntax. For "
8341 "more information, see the GNU coreutils info file."
8346 #: ../src/guestfs-actions.pod:978
8347 msgid "(Added in 1.3.7)"
8352 #: ../src/guestfs-actions.pod:980
8353 msgid "guestfs_chmod"
8358 #: ../src/guestfs-actions.pod:982
8362 " guestfs_chmod (guestfs_h *g,\n"
8364 " const char *path);\n"
8370 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
8372 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8378 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
8380 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8381 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8387 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4298
8388 #: ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:4514
8389 #: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:676
8390 #: ../fish/guestfish-actions.pod:2917 ../fish/guestfish-actions.pod:3046
8391 #: ../fish/guestfish-actions.pod:3056 ../fish/guestfish-actions.pod:3066
8392 msgid "The mode actually set is affected by the umask."
8397 #: ../src/guestfs-actions.pod:1000
8398 msgid "guestfs_chown"
8403 #: ../src/guestfs-actions.pod:1002
8407 " guestfs_chown (guestfs_h *g,\n"
8410 " const char *path);\n"
8416 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
8417 msgid "Change the file owner to C<owner> and group to C<group>."
8422 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3406
8423 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2375
8425 "Only numeric uid and gid are supported. If you want to use names, you will "
8426 "need to locate and parse the password file yourself (Augeas support makes "
8427 "this relatively easy)."
8432 #: ../src/guestfs-actions.pod:1018
8433 msgid "guestfs_command"
8438 #: ../src/guestfs-actions.pod:1020
8442 " guestfs_command (guestfs_h *g,\n"
8443 " char *const *arguments);\n"
8449 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
8451 "This call runs a command from the guest filesystem. The filesystem must be "
8452 "mounted, and must contain a compatible operating system (ie. something "
8453 "Linux, with the same or compatible processor architecture)."
8458 #: ../src/guestfs-actions.pod:1029
8460 "The single parameter is an argv-style list of arguments. The first element "
8461 "is the name of the program to run. Subsequent elements are parameters. The "
8462 "list must be non-empty (ie. must contain a program name). Note that the "
8463 "command runs directly, and is I<not> invoked via the shell (see "
8469 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
8470 msgid "The return value is anything printed to I<stdout> by the command."
8475 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
8477 "If the command returns a non-zero exit status, then this function returns an "
8478 "error message. The error message string is the content of I<stderr> from "
8484 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
8486 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8487 "bin>. If you require a program from another location, you should provide "
8488 "the full path in the first parameter."
8493 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
8495 "Shared libraries and data files required by the program must be available on "
8496 "filesystems which are mounted in the correct places. It is the caller's "
8497 "responsibility to ensure all filesystems that are needed are mounted at the "
8503 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
8504 #: ../src/guestfs-actions.pod:1543
8505 msgid "(Added in 0.9.1)"
8510 #: ../src/guestfs-actions.pod:1062
8511 msgid "guestfs_command_lines"
8516 #: ../src/guestfs-actions.pod:1064
8520 " guestfs_command_lines (guestfs_h *g,\n"
8521 " char *const *arguments);\n"
8527 #: ../src/guestfs-actions.pod:1068
8529 "This is the same as C<guestfs_command>, but splits the result into a list of "
8535 #: ../src/guestfs-actions.pod:1071
8536 msgid "See also: C<guestfs_sh_lines>"
8541 #: ../src/guestfs-actions.pod:1082
8542 msgid "guestfs_config"
8547 #: ../src/guestfs-actions.pod:1084
8551 " guestfs_config (guestfs_h *g,\n"
8552 " const char *qemuparam,\n"
8553 " const char *qemuvalue);\n"
8559 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8561 "This can be used to add arbitrary qemu command line parameters of the form "
8562 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8563 "setting some parameters which would interfere with parameters that we use."
8568 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8569 msgid "The first character of C<param> string must be a C<-> (dash)."
8574 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8575 msgid "C<value> can be NULL."
8580 #: ../src/guestfs-actions.pod:1102
8581 msgid "guestfs_copy_size"
8586 #: ../src/guestfs-actions.pod:1104
8590 " guestfs_copy_size (guestfs_h *g,\n"
8591 " const char *src,\n"
8592 " const char *dest,\n"
8599 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8601 "This command copies exactly C<size> bytes from one source device or file "
8602 "C<src> to another destination device or file C<dest>."
8607 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8609 "Note this will fail if the source is too short or if the destination is not "
8615 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8616 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1692
8617 #: ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:6732
8618 #: ../src/guestfs-actions.pod:6766 ../src/guestfs-actions.pod:7245
8619 #: ../src/guestfs-actions.pod:7264
8621 "This long-running command can generate progress notification messages so "
8622 "that the caller can display a progress bar or indicator. To receive these "
8623 "messages, the caller must register a progress callback. See L<guestfs(3)/"
8624 "guestfs_set_progress_callback>."
8629 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4074
8630 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:6973
8631 #: ../src/guestfs-actions.pod:6993 ../src/guestfs-actions.pod:7079
8632 msgid "(Added in 1.0.87)"
8637 #: ../src/guestfs-actions.pod:1125
8643 #: ../src/guestfs-actions.pod:1127
8647 " guestfs_cp (guestfs_h *g,\n"
8648 " const char *src,\n"
8649 " const char *dest);\n"
8655 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8657 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8658 "destination filename or destination directory."
8663 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8664 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8665 #: ../src/guestfs-actions.pod:1406 ../src/guestfs-actions.pod:4759
8666 #: ../src/guestfs-actions.pod:5136
8667 msgid "(Added in 1.0.18)"
8672 #: ../src/guestfs-actions.pod:1139
8673 msgid "guestfs_cp_a"
8678 #: ../src/guestfs-actions.pod:1141
8682 " guestfs_cp_a (guestfs_h *g,\n"
8683 " const char *src,\n"
8684 " const char *dest);\n"
8690 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8692 "This copies a file or directory from C<src> to C<dest> recursively using the "
8698 #: ../src/guestfs-actions.pod:1153
8704 #: ../src/guestfs-actions.pod:1155
8708 " guestfs_dd (guestfs_h *g,\n"
8709 " const char *src,\n"
8710 " const char *dest);\n"
8716 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8718 "This command copies from one source device or file C<src> to another "
8719 "destination device or file C<dest>. Normally you would use this to copy to "
8720 "or from a device or partition, for example to duplicate a filesystem."
8725 #: ../src/guestfs-actions.pod:1165
8727 "If the destination is a device, it must be as large or larger than the "
8728 "source file or device, otherwise the copy will fail. This command cannot do "
8729 "partial copies (see C<guestfs_copy_size>)."
8734 #: ../src/guestfs-actions.pod:1173
8740 #: ../src/guestfs-actions.pod:1175
8744 " guestfs_df (guestfs_h *g);\n"
8750 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8751 msgid "This command runs the C<df> command to report disk space used."
8756 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8758 "This command is mostly useful for interactive sessions. It is I<not> "
8759 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8765 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8766 #: ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:2281
8767 #: ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2373
8768 #: ../src/guestfs-actions.pod:4184 ../src/guestfs-actions.pod:4659
8769 #: ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6494
8770 #: ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7125
8771 #: ../src/guestfs-actions.pod:7138
8772 msgid "(Added in 1.0.54)"
8777 #: ../src/guestfs-actions.pod:1189
8778 msgid "guestfs_df_h"
8783 #: ../src/guestfs-actions.pod:1191
8787 " guestfs_df_h (guestfs_h *g);\n"
8793 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8795 "This command runs the C<df -h> command to report disk space used in human-"
8801 #: ../src/guestfs-actions.pod:1206
8802 msgid "guestfs_dmesg"
8807 #: ../src/guestfs-actions.pod:1208
8811 " guestfs_dmesg (guestfs_h *g);\n"
8817 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8819 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8820 "This is sometimes useful for extended debugging of problems."
8825 #: ../src/guestfs-actions.pod:1215
8827 "Another way to get the same information is to enable verbose messages with "
8828 "C<guestfs_set_verbose> or by setting the environment variable "
8829 "C<LIBGUESTFS_DEBUG=1> before running the program."
8834 #: ../src/guestfs-actions.pod:1225
8835 msgid "guestfs_download"
8840 #: ../src/guestfs-actions.pod:1227
8844 " guestfs_download (guestfs_h *g,\n"
8845 " const char *remotefilename,\n"
8846 " const char *filename);\n"
8852 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8853 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8855 "Download file C<remotefilename> and save it as C<filename> on the local "
8861 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6726
8862 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4524
8863 msgid "C<filename> can also be a named pipe."
8868 #: ../src/guestfs-actions.pod:1237
8869 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8874 #: ../src/guestfs-actions.pod:1248
8875 msgid "guestfs_download_offset"
8880 #: ../src/guestfs-actions.pod:1250
8884 " guestfs_download_offset (guestfs_h *g,\n"
8885 " const char *remotefilename,\n"
8886 " const char *filename,\n"
8887 " int64_t offset,\n"
8894 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8896 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8897 "region must be within the file or device)."
8902 #: ../src/guestfs-actions.pod:1263
8904 "Note that there is no limit on the amount of data that can be downloaded "
8905 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8906 "full amount unless an error occurs."
8911 #: ../src/guestfs-actions.pod:1268
8912 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8917 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6771
8918 msgid "(Added in 1.5.17)"
8923 #: ../src/guestfs-actions.pod:1279
8924 msgid "guestfs_drop_caches"
8929 #: ../src/guestfs-actions.pod:1281
8933 " guestfs_drop_caches (guestfs_h *g,\n"
8934 " int whattodrop);\n"
8940 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8942 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8943 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8944 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8949 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8950 msgid "Setting C<whattodrop> to 3 should drop everything."
8955 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8957 "This automatically calls L<sync(2)> before the operation, so that the "
8958 "maximum guest memory is freed."
8963 #: ../src/guestfs-actions.pod:1299
8969 #: ../src/guestfs-actions.pod:1301
8973 " guestfs_du (guestfs_h *g,\n"
8974 " const char *path);\n"
8980 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8982 "This command runs the C<du -s> command to estimate file space usage for "
8988 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8990 "C<path> can be a file or a directory. If C<path> is a directory then the "
8991 "estimate includes the contents of the directory and all subdirectories "
8997 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8999 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
9004 #: ../src/guestfs-actions.pod:1319
9005 msgid "guestfs_e2fsck_f"
9010 #: ../src/guestfs-actions.pod:1321
9014 " guestfs_e2fsck_f (guestfs_h *g,\n"
9015 " const char *device);\n"
9021 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:885
9023 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
9024 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
9030 #: ../src/guestfs-actions.pod:1329
9032 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
9033 "Normally you should use C<guestfs_fsck>."
9038 #: ../src/guestfs-actions.pod:1334
9039 msgid "(Added in 1.0.29)"
9044 #: ../src/guestfs-actions.pod:1336
9045 msgid "guestfs_echo_daemon"
9050 #: ../src/guestfs-actions.pod:1338
9054 " guestfs_echo_daemon (guestfs_h *g,\n"
9055 " char *const *words);\n"
9061 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:896
9063 "This command concatenates the list of C<words> passed with single spaces "
9064 "between them and returns the resulting string."
9069 #: ../src/guestfs-actions.pod:1345 ../fish/guestfish-actions.pod:899
9070 msgid "You can use this command to test the connection through to the daemon."
9075 #: ../src/guestfs-actions.pod:1347
9076 msgid "See also C<guestfs_ping_daemon>."
9081 #: ../src/guestfs-actions.pod:1352 ../src/guestfs-actions.pod:2089
9082 #: ../src/guestfs-actions.pod:5970
9083 msgid "(Added in 1.0.69)"
9088 #: ../src/guestfs-actions.pod:1354
9089 msgid "guestfs_egrep"
9094 #: ../src/guestfs-actions.pod:1356
9098 " guestfs_egrep (guestfs_h *g,\n"
9099 " const char *regex,\n"
9100 " const char *path);\n"
9106 #: ../src/guestfs-actions.pod:1361 ../fish/guestfish-actions.pod:907
9108 "This calls the external C<egrep> program and returns the matching lines."
9113 #: ../src/guestfs-actions.pod:1371 ../src/guestfs-actions.pod:1390
9114 #: ../src/guestfs-actions.pod:1447 ../src/guestfs-actions.pod:1493
9115 #: ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:2219
9116 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2394
9117 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2422
9118 #: ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2490
9119 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3567
9120 #: ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3594
9121 #: ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:4594
9122 #: ../src/guestfs-actions.pod:5470 ../src/guestfs-actions.pod:5519
9123 #: ../src/guestfs-actions.pod:6338 ../src/guestfs-actions.pod:6350
9124 #: ../src/guestfs-actions.pod:6363 ../src/guestfs-actions.pod:6376
9125 #: ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6411
9126 #: ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6437
9127 #: ../src/guestfs-actions.pod:7208 ../src/guestfs-actions.pod:7227
9128 #: ../src/guestfs-actions.pod:7312 ../src/guestfs-actions.pod:7331
9129 #: ../src/guestfs-actions.pod:7377 ../src/guestfs-actions.pod:7396
9130 msgid "(Added in 1.0.66)"
9135 #: ../src/guestfs-actions.pod:1373
9136 msgid "guestfs_egrepi"
9141 #: ../src/guestfs-actions.pod:1375
9145 " guestfs_egrepi (guestfs_h *g,\n"
9146 " const char *regex,\n"
9147 " const char *path);\n"
9153 #: ../src/guestfs-actions.pod:1380 ../fish/guestfish-actions.pod:917
9155 "This calls the external C<egrep -i> program and returns the matching lines."
9160 #: ../src/guestfs-actions.pod:1392
9161 msgid "guestfs_equal"
9166 #: ../src/guestfs-actions.pod:1394
9170 " guestfs_equal (guestfs_h *g,\n"
9171 " const char *file1,\n"
9172 " const char *file2);\n"
9178 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:927
9180 "This compares the two files C<file1> and C<file2> and returns true if their "
9181 "content is exactly equal, or false otherwise."
9186 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:930
9187 msgid "The external L<cmp(1)> program is used for the comparison."
9192 #: ../src/guestfs-actions.pod:1408
9193 msgid "guestfs_exists"
9198 #: ../src/guestfs-actions.pod:1410
9202 " guestfs_exists (guestfs_h *g,\n"
9203 " const char *path);\n"
9209 #: ../src/guestfs-actions.pod:1414 ../fish/guestfish-actions.pod:936
9211 "This returns C<true> if and only if there is a file, directory (or anything) "
9212 "with the given C<path> name."
9217 #: ../src/guestfs-actions.pod:1417
9218 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
9223 #: ../src/guestfs-actions.pod:1423
9224 msgid "guestfs_fallocate"
9229 #: ../src/guestfs-actions.pod:1425
9233 " guestfs_fallocate (guestfs_h *g,\n"
9234 " const char *path,\n"
9241 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1456
9242 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
9244 "This command preallocates a file (containing zero bytes) named C<path> of "
9245 "size C<len> bytes. If the file exists already, it is overwritten."
9250 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:949
9252 "Do not confuse this with the guestfish-specific C<alloc> command which "
9253 "allocates a file in the host and attaches it as a device."
9258 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:953
9260 "This function is deprecated. In new code, use the C<fallocate64> call "
9266 #: ../src/guestfs-actions.pod:1449
9267 msgid "guestfs_fallocate64"
9272 #: ../src/guestfs-actions.pod:1451
9276 " guestfs_fallocate64 (guestfs_h *g,\n"
9277 " const char *path,\n"
9284 #: ../src/guestfs-actions.pod:1460
9286 "Note that this call allocates disk blocks for the file. To create a sparse "
9287 "file use C<guestfs_truncate_size> instead."
9292 #: ../src/guestfs-actions.pod:1463
9294 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
9295 "oversight it only allowed 30 bit lengths to be specified, effectively "
9296 "limiting the maximum size of files created through that call to 1GB."
9301 #: ../src/guestfs-actions.pod:1468 ../fish/guestfish-actions.pod:976
9303 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9304 "commands which create a file in the host and attach it as a device."
9309 #: ../src/guestfs-actions.pod:1474
9310 msgid "(Added in 1.3.17)"
9315 #: ../src/guestfs-actions.pod:1476
9316 msgid "guestfs_fgrep"
9321 #: ../src/guestfs-actions.pod:1478
9325 " guestfs_fgrep (guestfs_h *g,\n"
9326 " const char *pattern,\n"
9327 " const char *path);\n"
9333 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:984
9335 "This calls the external C<fgrep> program and returns the matching lines."
9340 #: ../src/guestfs-actions.pod:1495
9341 msgid "guestfs_fgrepi"
9346 #: ../src/guestfs-actions.pod:1497
9350 " guestfs_fgrepi (guestfs_h *g,\n"
9351 " const char *pattern,\n"
9352 " const char *path);\n"
9358 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:994
9360 "This calls the external C<fgrep -i> program and returns the matching lines."
9365 #: ../src/guestfs-actions.pod:1514
9366 msgid "guestfs_file"
9371 #: ../src/guestfs-actions.pod:1516
9375 " guestfs_file (guestfs_h *g,\n"
9376 " const char *path);\n"
9382 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1004
9384 "This call uses the standard L<file(1)> command to determine the type or "
9385 "contents of the file."
9390 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1007
9392 "This call will also transparently look inside various types of compressed "
9398 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1010
9400 "The exact command which runs is C<file -zb path>. Note in particular that "
9401 "the filename is not prepended to the output (the C<-b> option)."
9406 #: ../src/guestfs-actions.pod:1530
9408 "This command can also be used on C</dev/> devices (and partitions, LV "
9409 "names). You can for example use this to determine if a device contains a "
9410 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
9415 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1019
9417 "If the C<path> does not begin with C</dev/> then this command only works for "
9418 "the content of regular files. For other file types (directory, symbolic "
9419 "link etc) it will just return the string C<directory> etc."
9424 #: ../src/guestfs-actions.pod:1545
9425 msgid "guestfs_file_architecture"
9430 #: ../src/guestfs-actions.pod:1547
9434 " guestfs_file_architecture (guestfs_h *g,\n"
9435 " const char *filename);\n"
9441 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1028
9443 "This detects the architecture of the binary C<filename>, and returns it if "
9449 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1031
9450 msgid "Currently defined architectures are:"
9455 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1035
9461 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1037
9463 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9464 "irrespective of the precise processor requirements of the binary."
9469 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1040
9475 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1042
9476 msgid "64 bit x86-64."
9481 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1044
9487 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1046
9488 msgid "32 bit SPARC."
9493 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1048
9499 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1050
9500 msgid "64 bit SPARC V9 and above."
9505 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1052
9511 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1054
9512 msgid "Intel Itanium."
9517 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1056
9523 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1058
9524 msgid "32 bit Power PC."
9529 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1060
9535 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1062
9536 msgid "64 bit Power PC."
9541 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1066
9542 msgid "Libguestfs may return other architecture strings in future."
9547 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1068
9548 msgid "The function works on at least the following types of files:"
9553 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1074
9554 msgid "many types of Un*x and Linux binary"
9559 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1078
9560 msgid "many types of Un*x and Linux shared library"
9565 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1082
9566 msgid "Windows Win32 and Win64 binaries"
9571 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1086
9572 msgid "Windows Win32 and Win64 DLLs"
9577 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1088
9578 msgid "Win32 binaries and DLLs return C<i386>."
9583 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1090
9584 msgid "Win64 binaries and DLLs return C<x86_64>."
9589 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1094
9590 msgid "Linux kernel modules"
9595 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1098
9596 msgid "Linux new-style initrd images"
9601 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1102
9602 msgid "some non-x86 Linux vmlinuz kernels"
9607 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1106
9608 msgid "What it can't do currently:"
9613 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1112
9614 msgid "static libraries (libfoo.a)"
9619 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1116
9620 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9625 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1120
9626 msgid "x86 Linux vmlinuz kernels"
9631 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1122
9633 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9634 "compressed code, and are horribly hard to unpack. If you want to find the "
9635 "architecture of a kernel, use the architecture of the associated initrd or "
9636 "kernel module(s) instead."
9641 #: ../src/guestfs-actions.pod:1655 ../src/guestfs-actions.pod:1818
9642 #: ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:2526
9643 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2637
9644 #: ../src/guestfs-actions.pod:2725 ../src/guestfs-actions.pod:2746
9645 #: ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:2867
9646 #: ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3190
9647 #: ../src/guestfs-actions.pod:3322
9648 msgid "(Added in 1.5.3)"
9653 #: ../src/guestfs-actions.pod:1657
9654 msgid "guestfs_filesize"
9659 #: ../src/guestfs-actions.pod:1659
9663 " guestfs_filesize (guestfs_h *g,\n"
9664 " const char *file);\n"
9670 #: ../src/guestfs-actions.pod:1663 ../fish/guestfish-actions.pod:1133
9671 msgid "This command returns the size of C<file> in bytes."
9676 #: ../src/guestfs-actions.pod:1665
9678 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9679 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9680 "devices, use C<guestfs_blockdev_getsize64>."
9685 #: ../src/guestfs-actions.pod:1671
9686 msgid "(Added in 1.0.82)"
9691 #: ../src/guestfs-actions.pod:1673
9692 msgid "guestfs_fill"
9697 #: ../src/guestfs-actions.pod:1675
9701 " guestfs_fill (guestfs_h *g,\n"
9704 " const char *path);\n"
9710 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1143
9712 "This command creates a new file called C<path>. The initial content of the "
9713 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9719 #: ../src/guestfs-actions.pod:1685
9721 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9722 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9723 "bytes use C<guestfs_fill_pattern>."
9728 #: ../src/guestfs-actions.pod:1697
9729 msgid "(Added in 1.0.79)"
9734 #: ../src/guestfs-actions.pod:1699
9735 msgid "guestfs_fill_pattern"
9740 #: ../src/guestfs-actions.pod:1701
9744 " guestfs_fill_pattern (guestfs_h *g,\n"
9745 " const char *pattern,\n"
9747 " const char *path);\n"
9753 #: ../src/guestfs-actions.pod:1707
9755 "This function is like C<guestfs_fill> except that it creates a new file of "
9756 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9757 "pattern is truncated if necessary to ensure the length of the file is "
9758 "exactly C<len> bytes."
9763 #: ../src/guestfs-actions.pod:1719
9764 msgid "(Added in 1.3.12)"
9769 #: ../src/guestfs-actions.pod:1721
9770 msgid "guestfs_find"
9775 #: ../src/guestfs-actions.pod:1723
9779 " guestfs_find (guestfs_h *g,\n"
9780 " const char *directory);\n"
9786 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1165
9788 "This command lists out all files and directories, recursively, starting at "
9789 "C<directory>. It is essentially equivalent to running the shell command "
9790 "C<find directory -print> but some post-processing happens on the output, "
9796 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1170
9798 "This returns a list of strings I<without any prefix>. Thus if the directory "
9804 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1173
9815 #: ../src/guestfs-actions.pod:1739
9817 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9822 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1180
9834 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1185
9835 msgid "If C<directory> is not a directory, then this command returns an error."
9840 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1188
9841 msgid "The returned list is sorted."
9846 #: ../src/guestfs-actions.pod:1752
9847 msgid "See also C<guestfs_find0>."
9852 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:4011
9853 #: ../src/guestfs-actions.pod:5554
9854 msgid "(Added in 1.0.27)"
9859 #: ../src/guestfs-actions.pod:1763
9860 msgid "guestfs_find0"
9865 #: ../src/guestfs-actions.pod:1765
9869 " guestfs_find0 (guestfs_h *g,\n"
9870 " const char *directory,\n"
9871 " const char *files);\n"
9877 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1199
9879 "This command lists out all files and directories, recursively, starting at "
9880 "C<directory>, placing the resulting list in the external file called "
9886 #: ../src/guestfs-actions.pod:1774
9888 "This command works the same way as C<guestfs_find> with the following "
9894 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1210
9895 msgid "The resulting list is written to an external file."
9900 #: ../src/guestfs-actions.pod:1785 ../fish/guestfish-actions.pod:1214
9902 "Items (filenames) in the result are separated by C<\\0> characters. See "
9903 "L<find(1)> option I<-print0>."
9908 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1219
9909 msgid "This command is not limited in the number of names that it can return."
9914 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1224
9915 msgid "The result list is not sorted."
9920 #: ../src/guestfs-actions.pod:1801
9921 msgid "(Added in 1.0.74)"
9926 #: ../src/guestfs-actions.pod:1803
9927 msgid "guestfs_findfs_label"
9932 #: ../src/guestfs-actions.pod:1805
9936 " guestfs_findfs_label (guestfs_h *g,\n"
9937 " const char *label);\n"
9943 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1234
9945 "This command searches the filesystems and returns the one which has the "
9946 "given label. An error is returned if no such filesystem can be found."
9951 #: ../src/guestfs-actions.pod:1813
9952 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9957 #: ../src/guestfs-actions.pod:1820
9958 msgid "guestfs_findfs_uuid"
9963 #: ../src/guestfs-actions.pod:1822
9967 " guestfs_findfs_uuid (guestfs_h *g,\n"
9968 " const char *uuid);\n"
9974 #: ../src/guestfs-actions.pod:1826 ../fish/guestfish-actions.pod:1244
9976 "This command searches the filesystems and returns the one which has the "
9977 "given UUID. An error is returned if no such filesystem can be found."
9982 #: ../src/guestfs-actions.pod:1830
9983 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9988 #: ../src/guestfs-actions.pod:1837
9989 msgid "guestfs_fsck"
9994 #: ../src/guestfs-actions.pod:1839
9998 " guestfs_fsck (guestfs_h *g,\n"
9999 " const char *fstype,\n"
10000 " const char *device);\n"
10006 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1254
10008 "This runs the filesystem checker (fsck) on C<device> which should have "
10009 "filesystem type C<fstype>."
10014 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1257
10016 "The returned integer is the status. See L<fsck(8)> for the list of status "
10017 "codes from C<fsck>."
10022 #: ../src/guestfs-actions.pod:1856 ../fish/guestfish-actions.pod:1266
10023 msgid "Multiple status codes can be summed together."
10028 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1270
10030 "A non-zero return code can mean \"success\", for example if errors have been "
10031 "corrected on the filesystem."
10036 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1275
10037 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
10042 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1280
10044 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
10049 #: ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:7250
10050 msgid "(Added in 1.0.16)"
10055 #: ../src/guestfs-actions.pod:1876
10056 msgid "guestfs_get_append"
10061 #: ../src/guestfs-actions.pod:1878
10065 " guestfs_get_append (guestfs_h *g);\n"
10071 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1286
10073 "Return the additional kernel options which are added to the guest kernel "
10079 #: ../src/guestfs-actions.pod:1884 ../fish/guestfish-actions.pod:1289
10080 msgid "If C<NULL> then no options are added."
10085 #: ../src/guestfs-actions.pod:1886
10087 "This function returns a string which may be NULL. There is no way to return "
10088 "an error from this function. The string is owned by the guest handle and "
10089 "must I<not> be freed."
10094 #: ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:5232
10095 #: ../src/guestfs-actions.pod:5712 ../src/guestfs-actions.pod:6112
10096 #: ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6147
10097 #: ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6921
10098 #: ../src/guestfs-actions.pod:6939 ../src/guestfs-actions.pod:7293
10099 msgid "(Added in 1.0.26)"
10103 #: ../src/guestfs-actions.pod:1892
10104 msgid "guestfs_get_attach_method"
10108 #: ../src/guestfs-actions.pod:1894
10112 " guestfs_get_attach_method (guestfs_h *g);\n"
10117 #: ../src/guestfs-actions.pod:1897
10118 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
10123 #: ../src/guestfs-actions.pod:1902
10124 msgid "guestfs_get_autosync"
10129 #: ../src/guestfs-actions.pod:1904
10133 " guestfs_get_autosync (guestfs_h *g);\n"
10139 #: ../src/guestfs-actions.pod:1907 ../fish/guestfish-actions.pod:1301
10140 msgid "Get the autosync flag."
10145 #: ../src/guestfs-actions.pod:1913
10146 msgid "guestfs_get_direct"
10151 #: ../src/guestfs-actions.pod:1915
10155 " guestfs_get_direct (guestfs_h *g);\n"
10161 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1307
10162 msgid "Return the direct appliance mode flag."
10167 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:5781
10168 msgid "(Added in 1.0.72)"
10173 #: ../src/guestfs-actions.pod:1924
10174 msgid "guestfs_get_e2label"
10179 #: ../src/guestfs-actions.pod:1926
10183 " guestfs_get_e2label (guestfs_h *g,\n"
10184 " const char *device);\n"
10190 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1313
10192 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
10197 #: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1316
10199 "This function is deprecated. In new code, use the C<vfs_label> call instead."
10204 #: ../src/guestfs-actions.pod:1943 ../src/guestfs-actions.pod:1964
10205 #: ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5818
10206 msgid "(Added in 1.0.15)"
10211 #: ../src/guestfs-actions.pod:1945
10212 msgid "guestfs_get_e2uuid"
10217 #: ../src/guestfs-actions.pod:1947
10221 " guestfs_get_e2uuid (guestfs_h *g,\n"
10222 " const char *device);\n"
10228 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1327
10230 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
10235 #: ../src/guestfs-actions.pod:1957 ../fish/guestfish-actions.pod:1330
10237 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
10242 #: ../src/guestfs-actions.pod:1966
10243 msgid "guestfs_get_memsize"
10248 #: ../src/guestfs-actions.pod:1968
10252 " guestfs_get_memsize (guestfs_h *g);\n"
10258 #: ../src/guestfs-actions.pod:1971 ../fish/guestfish-actions.pod:1341
10260 "This gets the memory size in megabytes allocated to the qemu subprocess."
10265 #: ../src/guestfs-actions.pod:1974
10267 "If C<guestfs_set_memsize> was not called on this handle, and if "
10268 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
10269 "value for memsize."
10274 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2059
10275 #: ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5941
10276 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
10277 #: ../fish/guestfish-actions.pod:3927 ../fish/guestfish-actions.pod:4014
10279 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
10284 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:4302
10285 #: ../src/guestfs-actions.pod:4499 ../src/guestfs-actions.pod:4518
10286 #: ../src/guestfs-actions.pod:4537 ../src/guestfs-actions.pod:4549
10287 #: ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4579
10288 #: ../src/guestfs-actions.pod:5457 ../src/guestfs-actions.pod:5839
10289 #: ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6687
10290 msgid "(Added in 1.0.55)"
10295 #: ../src/guestfs-actions.pod:1985
10296 msgid "guestfs_get_network"
10301 #: ../src/guestfs-actions.pod:1987
10305 " guestfs_get_network (guestfs_h *g);\n"
10311 #: ../src/guestfs-actions.pod:1990 ../fish/guestfish-actions.pod:1355
10312 msgid "This returns the enable network flag."
10317 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:5858
10318 msgid "(Added in 1.5.4)"
10323 #: ../src/guestfs-actions.pod:1996
10324 msgid "guestfs_get_path"
10329 #: ../src/guestfs-actions.pod:1998
10333 " guestfs_get_path (guestfs_h *g);\n"
10339 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1361
10340 msgid "Return the current search path."
10345 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1363
10347 "This is always non-NULL. If it wasn't set already, then this will return "
10348 "the default path."
10353 #: ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2035
10355 "This function returns a string, or NULL on error. The string is owned by "
10356 "the guest handle and must I<not> be freed."
10361 #: ../src/guestfs-actions.pod:2011
10362 msgid "guestfs_get_pid"
10367 #: ../src/guestfs-actions.pod:2013
10371 " guestfs_get_pid (guestfs_h *g);\n"
10377 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
10379 "Return the process ID of the qemu subprocess. If there is no qemu "
10380 "subprocess, then this will return an error."
10385 #: ../src/guestfs-actions.pod:2019 ../fish/guestfish-actions.pod:1375
10386 msgid "This is an internal call used for debugging and testing."
10391 #: ../src/guestfs-actions.pod:2023
10392 msgid "(Added in 1.0.56)"
10397 #: ../src/guestfs-actions.pod:2025
10398 msgid "guestfs_get_qemu"
10403 #: ../src/guestfs-actions.pod:2027
10407 " guestfs_get_qemu (guestfs_h *g);\n"
10413 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1381
10414 msgid "Return the current qemu binary."
10419 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1383
10421 "This is always non-NULL. If it wasn't set already, then this will return "
10422 "the default qemu binary name."
10427 #: ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:5903
10428 msgid "(Added in 1.0.6)"
10433 #: ../src/guestfs-actions.pod:2040
10434 msgid "guestfs_get_recovery_proc"
10439 #: ../src/guestfs-actions.pod:2042
10443 " guestfs_get_recovery_proc (guestfs_h *g);\n"
10449 #: ../src/guestfs-actions.pod:2045 ../fish/guestfish-actions.pod:1390
10450 msgid "Return the recovery process enabled flag."
10455 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:3412
10456 #: ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:4109
10457 #: ../src/guestfs-actions.pod:4141 ../src/guestfs-actions.pod:5162
10458 #: ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:5927
10459 #: ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6610
10460 #: ../src/guestfs-actions.pod:6802
10461 msgid "(Added in 1.0.77)"
10466 #: ../src/guestfs-actions.pod:2051
10467 msgid "guestfs_get_selinux"
10472 #: ../src/guestfs-actions.pod:2053
10476 " guestfs_get_selinux (guestfs_h *g);\n"
10482 #: ../src/guestfs-actions.pod:2056
10484 "This returns the current setting of the selinux flag which is passed to the "
10485 "appliance at boot time. See C<guestfs_set_selinux>."
10490 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:2127
10491 #: ../src/guestfs-actions.pod:5946 ../src/guestfs-actions.pod:6004
10492 msgid "(Added in 1.0.67)"
10497 #: ../src/guestfs-actions.pod:2066
10498 msgid "guestfs_get_state"
10503 #: ../src/guestfs-actions.pod:2068
10507 " guestfs_get_state (guestfs_h *g);\n"
10513 #: ../src/guestfs-actions.pod:2071 ../fish/guestfish-actions.pod:1406
10515 "This returns the current state as an opaque integer. This is only useful "
10516 "for printing debug and internal error messages."
10521 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:3215
10522 #: ../src/guestfs-actions.pod:3244 ../src/guestfs-actions.pod:3305
10523 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:1409
10524 #: ../fish/guestfish-actions.pod:2257 ../fish/guestfish-actions.pod:2275
10525 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2329
10526 msgid "For more information on states, see L<guestfs(3)>."
10531 #: ../src/guestfs-actions.pod:2080
10532 msgid "guestfs_get_trace"
10537 #: ../src/guestfs-actions.pod:2082
10541 " guestfs_get_trace (guestfs_h *g);\n"
10547 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1415
10548 msgid "Return the command trace flag."
10553 #: ../src/guestfs-actions.pod:2091
10554 msgid "guestfs_get_umask"
10559 #: ../src/guestfs-actions.pod:2093
10563 " guestfs_get_umask (guestfs_h *g);\n"
10569 #: ../src/guestfs-actions.pod:2096
10571 "Return the current umask. By default the umask is C<022> unless it has been "
10572 "set by calling C<guestfs_umask>."
10577 #: ../src/guestfs-actions.pod:2103
10578 msgid "guestfs_get_verbose"
10583 #: ../src/guestfs-actions.pod:2105
10587 " guestfs_get_verbose (guestfs_h *g);\n"
10593 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1428
10594 msgid "This returns the verbose messages flag."
10599 #: ../src/guestfs-actions.pod:2114
10600 msgid "guestfs_getcon"
10605 #: ../src/guestfs-actions.pod:2116
10609 " guestfs_getcon (guestfs_h *g);\n"
10615 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1434
10616 msgid "This gets the SELinux security context of the daemon."
10621 #: ../src/guestfs-actions.pod:2121
10623 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10628 #: ../src/guestfs-actions.pod:2129
10629 msgid "guestfs_getxattr"
10634 #: ../src/guestfs-actions.pod:2131
10638 " guestfs_getxattr (guestfs_h *g,\n"
10639 " const char *path,\n"
10640 " const char *name,\n"
10641 " size_t *size_r);\n"
10647 #: ../src/guestfs-actions.pod:2137
10649 "Get a single extended attribute from file C<path> named C<name>. This call "
10650 "follows symlinks. If you want to lookup an extended attribute for the "
10651 "symlink itself, use C<guestfs_lgetxattr>."
10656 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3426
10658 "Normally it is better to get all extended attributes from a file in one go "
10659 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10660 "implementations are buggy and do not provide a way to list out attributes. "
10661 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10662 "extended attributes you want in advance and call this function."
10667 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3433
10668 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2394
10670 "Extended attribute values are blobs of binary data. If there is no extended "
10671 "attribute named C<name>, this returns an error."
10676 #: ../src/guestfs-actions.pod:2151
10677 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10682 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2344
10683 #: ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:5155
10684 #: ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5362
10686 "This function returns a buffer, or NULL on error. The size of the returned "
10687 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10692 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3442
10693 msgid "(Added in 1.7.24)"
10698 #: ../src/guestfs-actions.pod:2159
10699 msgid "guestfs_getxattrs"
10704 #: ../src/guestfs-actions.pod:2161
10707 " struct guestfs_xattr_list *\n"
10708 " guestfs_getxattrs (guestfs_h *g,\n"
10709 " const char *path);\n"
10715 #: ../src/guestfs-actions.pod:2165 ../fish/guestfish-actions.pod:1463
10717 "This call lists the extended attributes of the file or directory C<path>."
10722 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1466
10724 "At the system call level, this is a combination of the L<listxattr(2)> and "
10725 "L<getxattr(2)> calls."
10730 #: ../src/guestfs-actions.pod:2171
10731 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10736 #: ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:3454
10737 #: ../src/guestfs-actions.pod:4105
10739 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10740 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10745 #: ../src/guestfs-actions.pod:2177 ../src/guestfs-actions.pod:3458
10746 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3659
10747 #: ../src/guestfs-actions.pod:5535 ../src/guestfs-actions.pod:6023
10748 #: ../src/guestfs-actions.pod:7358
10749 msgid "(Added in 1.0.59)"
10754 #: ../src/guestfs-actions.pod:2179
10755 msgid "guestfs_glob_expand"
10760 #: ../src/guestfs-actions.pod:2181
10764 " guestfs_glob_expand (guestfs_h *g,\n"
10765 " const char *pattern);\n"
10771 #: ../src/guestfs-actions.pod:2185 ../fish/guestfish-actions.pod:1475
10773 "This command searches for all the pathnames matching C<pattern> according to "
10774 "the wildcard expansion rules used by the shell."
10779 #: ../src/guestfs-actions.pod:2189 ../fish/guestfish-actions.pod:1479
10781 "If no paths match, then this returns an empty list (note: not an error)."
10786 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1482
10788 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10789 "GLOB_BRACE>. See that manual page for more details."
10794 #: ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:6188
10795 #: ../src/guestfs-actions.pod:6205
10796 msgid "(Added in 1.0.50)"
10801 #: ../src/guestfs-actions.pod:2202
10802 msgid "guestfs_grep"
10807 #: ../src/guestfs-actions.pod:2204
10811 " guestfs_grep (guestfs_h *g,\n"
10812 " const char *regex,\n"
10813 " const char *path);\n"
10819 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1490
10820 msgid "This calls the external C<grep> program and returns the matching lines."
10825 #: ../src/guestfs-actions.pod:2221
10826 msgid "guestfs_grepi"
10831 #: ../src/guestfs-actions.pod:2223
10835 " guestfs_grepi (guestfs_h *g,\n"
10836 " const char *regex,\n"
10837 " const char *path);\n"
10843 #: ../src/guestfs-actions.pod:2228 ../fish/guestfish-actions.pod:1500
10845 "This calls the external C<grep -i> program and returns the matching lines."
10850 #: ../src/guestfs-actions.pod:2240
10851 msgid "guestfs_grub_install"
10856 #: ../src/guestfs-actions.pod:2242
10860 " guestfs_grub_install (guestfs_h *g,\n"
10861 " const char *root,\n"
10862 " const char *device);\n"
10868 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
10870 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10871 "the root directory being C<root>."
10876 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1513
10878 "Note: If grub-install reports the error \"No suitable drive was found in the "
10879 "generated device map.\" it may be that you need to create a C</boot/grub/"
10880 "device.map> file first that contains the mapping between grub device names "
10881 "and Linux device names. It is usually sufficient to create a file "
10887 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1520
10890 " (hd0) /dev/vda\n"
10896 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1522
10897 msgid "replacing C</dev/vda> with the name of the installation device."
10902 #: ../src/guestfs-actions.pod:2263
10903 msgid "(Added in 1.0.17)"
10908 #: ../src/guestfs-actions.pod:2265
10909 msgid "guestfs_head"
10914 #: ../src/guestfs-actions.pod:2267
10918 " guestfs_head (guestfs_h *g,\n"
10919 " const char *path);\n"
10925 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1528
10927 "This command returns up to the first 10 lines of a file as a list of strings."
10932 #: ../src/guestfs-actions.pod:2283
10933 msgid "guestfs_head_n"
10938 #: ../src/guestfs-actions.pod:2285
10942 " guestfs_head_n (guestfs_h *g,\n"
10944 " const char *path);\n"
10950 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1538
10952 "If the parameter C<nrlines> is a positive number, this returns the first "
10953 "C<nrlines> lines of the file C<path>."
10958 #: ../src/guestfs-actions.pod:2293 ../fish/guestfish-actions.pod:1541
10960 "If the parameter C<nrlines> is a negative number, this returns lines from "
10961 "the file C<path>, excluding the last C<nrlines> lines."
10966 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:6485
10967 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4364
10968 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10973 #: ../src/guestfs-actions.pod:2307
10974 msgid "guestfs_hexdump"
10979 #: ../src/guestfs-actions.pod:2309
10983 " guestfs_hexdump (guestfs_h *g,\n"
10984 " const char *path);\n"
10990 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
10992 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10993 "readable, canonical hex dump of the file."
10998 #: ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:6269
10999 #: ../src/guestfs-actions.pod:6324
11000 msgid "(Added in 1.0.22)"
11005 #: ../src/guestfs-actions.pod:2324
11006 msgid "guestfs_initrd_cat"
11011 #: ../src/guestfs-actions.pod:2326
11015 " guestfs_initrd_cat (guestfs_h *g,\n"
11016 " const char *initrdpath,\n"
11017 " const char *filename,\n"
11018 " size_t *size_r);\n"
11024 #: ../src/guestfs-actions.pod:2332 ../fish/guestfish-actions.pod:1563
11026 "This command unpacks the file C<filename> from the initrd file called "
11027 "C<initrdpath>. The filename must be given I<without> the initial C</> "
11033 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
11035 "For example, in guestfish you could use the following command to examine the "
11036 "boot script (usually called C</init>) contained in a Linux initrd or "
11042 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
11045 " initrd-cat /boot/initrd-<version>.img init\n"
11051 #: ../src/guestfs-actions.pod:2342
11052 msgid "See also C<guestfs_initrd_list>."
11057 #: ../src/guestfs-actions.pod:2353
11058 msgid "guestfs_initrd_list"
11063 #: ../src/guestfs-actions.pod:2355
11067 " guestfs_initrd_list (guestfs_h *g,\n"
11068 " const char *path);\n"
11074 #: ../src/guestfs-actions.pod:2359 ../fish/guestfish-actions.pod:1582
11075 msgid "This command lists out files contained in an initrd."
11080 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1584
11082 "The files are listed without any initial C</> character. The files are "
11083 "listed in the order they appear (not necessarily alphabetical). Directory "
11084 "names are listed as separate items."
11089 #: ../src/guestfs-actions.pod:2365 ../fish/guestfish-actions.pod:1588
11091 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
11092 "initrd. We I<only> support the newer initramfs format (compressed cpio "
11098 #: ../src/guestfs-actions.pod:2375
11099 msgid "guestfs_inotify_add_watch"
11104 #: ../src/guestfs-actions.pod:2377
11108 " guestfs_inotify_add_watch (guestfs_h *g,\n"
11109 " const char *path,\n"
11116 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1596
11117 msgid "Watch C<path> for the events listed in C<mask>."
11122 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1598
11124 "Note that if C<path> is a directory then events within that directory are "
11125 "watched, but this does I<not> happen recursively (in subdirectories)."
11130 #: ../src/guestfs-actions.pod:2388 ../fish/guestfish-actions.pod:1602
11132 "Note for non-C or non-Linux callers: the inotify events are defined by the "
11133 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
11138 #: ../src/guestfs-actions.pod:2396
11139 msgid "guestfs_inotify_close"
11144 #: ../src/guestfs-actions.pod:2398
11148 " guestfs_inotify_close (guestfs_h *g);\n"
11154 #: ../src/guestfs-actions.pod:2401 ../fish/guestfish-actions.pod:1610
11156 "This closes the inotify handle which was previously opened by inotify_init. "
11157 "It removes all watches, throws away any pending events, and deallocates all "
11163 #: ../src/guestfs-actions.pod:2409
11164 msgid "guestfs_inotify_files"
11169 #: ../src/guestfs-actions.pod:2411
11173 " guestfs_inotify_files (guestfs_h *g);\n"
11179 #: ../src/guestfs-actions.pod:2414
11181 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
11182 "returns a list of pathnames of objects that were touched. The returned "
11183 "pathnames are sorted and deduplicated."
11188 #: ../src/guestfs-actions.pod:2424
11189 msgid "guestfs_inotify_init"
11194 #: ../src/guestfs-actions.pod:2426
11198 " guestfs_inotify_init (guestfs_h *g,\n"
11199 " int maxevents);\n"
11205 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1626
11207 "This command creates a new inotify handle. The inotify subsystem can be "
11208 "used to notify events which happen to objects in the guest filesystem."
11213 #: ../src/guestfs-actions.pod:2434
11215 "C<maxevents> is the maximum number of events which will be queued up between "
11216 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
11217 "passed as C<0>, then the kernel (or previously set) default is used. For "
11218 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
11219 "throws away events, but records the fact that it threw them away by setting "
11220 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
11221 "C<guestfs_inotify_read>)."
11226 #: ../src/guestfs-actions.pod:2444
11228 "Before any events are generated, you have to add some watches to the "
11229 "internal watch list. See: C<guestfs_inotify_add_watch>, "
11230 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
11235 #: ../src/guestfs-actions.pod:2450
11237 "Queued up events should be read periodically by calling "
11238 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
11239 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
11240 "often enough then you risk the internal queue overflowing."
11245 #: ../src/guestfs-actions.pod:2457
11247 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
11248 "This also removes any watches automatically."
11253 #: ../src/guestfs-actions.pod:2461 ../fish/guestfish-actions.pod:1657
11255 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
11256 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
11257 "that there is one global inotify handle per libguestfs instance."
11262 #: ../src/guestfs-actions.pod:2470
11263 msgid "guestfs_inotify_read"
11268 #: ../src/guestfs-actions.pod:2472
11271 " struct guestfs_inotify_event_list *\n"
11272 " guestfs_inotify_read (guestfs_h *g);\n"
11278 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1666
11280 "Return the complete queue of events that have happened since the previous "
11286 #: ../src/guestfs-actions.pod:2478 ../fish/guestfish-actions.pod:1669
11287 msgid "If no events have happened, this returns an empty list."
11292 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1671
11294 "I<Note>: In order to make sure that all events have been read, you must call "
11295 "this function repeatedly until it returns an empty list. The reason is that "
11296 "the call will read events up to the maximum appliance-to-host message size "
11297 "and leave remaining events in the queue."
11302 #: ../src/guestfs-actions.pod:2486
11304 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
11305 "there was an error. I<The caller must call "
11306 "C<guestfs_free_inotify_event_list> after use>."
11311 #: ../src/guestfs-actions.pod:2492
11312 msgid "guestfs_inotify_rm_watch"
11317 #: ../src/guestfs-actions.pod:2494
11321 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
11328 #: ../src/guestfs-actions.pod:2498
11330 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
11335 #: ../src/guestfs-actions.pod:2505
11336 msgid "guestfs_inspect_get_arch"
11341 #: ../src/guestfs-actions.pod:2507
11345 " guestfs_inspect_get_arch (guestfs_h *g,\n"
11346 " const char *root);\n"
11352 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:2534
11353 #: ../src/guestfs-actions.pod:2619 ../src/guestfs-actions.pod:2645
11354 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2706
11355 #: ../src/guestfs-actions.pod:2733 ../src/guestfs-actions.pod:2754
11356 #: ../src/guestfs-actions.pod:2791 ../src/guestfs-actions.pod:2820
11357 #: ../src/guestfs-actions.pod:2851 ../src/guestfs-actions.pod:2875
11358 #: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2972
11359 #: ../src/guestfs-actions.pod:2995 ../src/guestfs-actions.pod:3012
11360 #: ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3048
11362 "This function should only be called with a root device string as returned by "
11363 "C<guestfs_inspect_os>."
11368 #: ../src/guestfs-actions.pod:2514
11370 "This returns the architecture of the inspected operating system. The "
11371 "possible return values are listed under C<guestfs_file_architecture>."
11376 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1695
11378 "If the architecture could not be determined, then the string C<unknown> is "
11384 #: ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2606
11385 #: ../src/guestfs-actions.pod:2673 ../src/guestfs-actions.pod:2693
11386 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2807
11387 #: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2862
11388 #: ../src/guestfs-actions.pod:2916 ../src/guestfs-actions.pod:2959
11389 #: ../src/guestfs-actions.pod:2982 ../src/guestfs-actions.pod:3002
11390 #: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3038
11391 #: ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3182
11392 #: ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1776
11393 #: ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:1843
11394 #: ../fish/guestfish-actions.pod:1864 ../fish/guestfish-actions.pod:1928
11395 #: ../fish/guestfish-actions.pod:1952 ../fish/guestfish-actions.pod:1969
11396 #: ../fish/guestfish-actions.pod:2012 ../fish/guestfish-actions.pod:2047
11397 #: ../fish/guestfish-actions.pod:2063 ../fish/guestfish-actions.pod:2076
11398 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2104
11399 #: ../fish/guestfish-actions.pod:2203 ../fish/guestfish-actions.pod:2237
11400 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
11405 #: ../src/guestfs-actions.pod:2528
11406 msgid "guestfs_inspect_get_distro"
11411 #: ../src/guestfs-actions.pod:2530
11415 " guestfs_inspect_get_distro (guestfs_h *g,\n"
11416 " const char *root);\n"
11422 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1707
11424 "This returns the distro (distribution) of the inspected operating system."
11429 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1710
11430 msgid "Currently defined distros are:"
11435 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1714
11436 msgid "\"archlinux\""
11441 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1716
11442 msgid "Arch Linux."
11447 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1718
11453 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1720
11459 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1722
11465 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1724
11471 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1726
11477 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1728
11483 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1730
11484 msgid "\"linuxmint\""
11489 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1732
11490 msgid "Linux Mint."
11495 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1734
11496 msgid "\"mandriva\""
11501 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1736
11507 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1738
11513 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1740
11519 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1742
11525 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1744
11531 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1746
11532 msgid "\"redhat-based\""
11537 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1748
11538 msgid "Some Red Hat-derived distro."
11543 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1750
11549 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1752
11550 msgid "Red Hat Enterprise Linux and some derivatives."
11554 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1754
11555 msgid "\"slackware\""
11559 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1756
11565 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1758
11571 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1760
11577 #: ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:2664
11578 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:1762
11579 #: ../fish/guestfish-actions.pod:1819 ../fish/guestfish-actions.pod:2038
11580 msgid "\"unknown\""
11585 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1764
11586 msgid "The distro could not be determined."
11591 #: ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:2942
11592 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2030
11593 msgid "\"windows\""
11598 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1768
11600 "Windows does not have distributions. This string is returned if the OS type "
11606 #: ../src/guestfs-actions.pod:2603 ../src/guestfs-actions.pod:2670
11607 #: ../src/guestfs-actions.pod:2956 ../fish/guestfish-actions.pod:1773
11608 #: ../fish/guestfish-actions.pod:1825 ../fish/guestfish-actions.pod:2044
11610 "Future versions of libguestfs may return other strings here. The caller "
11611 "should be prepared to handle any string."
11616 #: ../src/guestfs-actions.pod:2613
11617 msgid "guestfs_inspect_get_filesystems"
11622 #: ../src/guestfs-actions.pod:2615
11626 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11627 " const char *root);\n"
11633 #: ../src/guestfs-actions.pod:2622 ../fish/guestfish-actions.pod:1785
11635 "This returns a list of all the filesystems that we think are associated with "
11636 "this operating system. This includes the root filesystem, other ordinary "
11637 "filesystems, and non-mounted devices like swap partitions."
11642 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1790
11644 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11645 "to be shared between operating systems."
11650 #: ../src/guestfs-actions.pod:2630
11652 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11653 "C<guestfs_inspect_get_mountpoints>."
11657 #: ../src/guestfs-actions.pod:2639
11658 msgid "guestfs_inspect_get_format"
11662 #: ../src/guestfs-actions.pod:2641
11666 " guestfs_inspect_get_format (guestfs_h *g,\n"
11667 " const char *root);\n"
11672 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1803
11674 "This returns the format of the inspected operating system. You can use it "
11675 "to detect install images, live CDs and similar."
11679 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1806
11680 msgid "Currently defined formats are:"
11684 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1810
11685 msgid "\"installed\""
11689 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1812
11690 msgid "This is an installed operating system."
11694 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1814
11695 msgid "\"installer\""
11699 #: ../src/guestfs-actions.pod:2661 ../fish/guestfish-actions.pod:1816
11701 "The disk image being inspected is not an installed operating system, but a "
11702 "I<bootable> install disk, live CD, or similar."
11706 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1821
11707 msgid "The format of this disk image is not known."
11712 #: ../src/guestfs-actions.pod:2678
11713 msgid "guestfs_inspect_get_hostname"
11718 #: ../src/guestfs-actions.pod:2680
11722 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11723 " const char *root);\n"
11729 #: ../src/guestfs-actions.pod:2687 ../fish/guestfish-actions.pod:1837
11731 "This function returns the hostname of the operating system as found by "
11732 "inspection of the guest's configuration files."
11737 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:1840
11739 "If the hostname could not be determined, then the string C<unknown> is "
11745 #: ../src/guestfs-actions.pod:2698
11746 msgid "(Added in 1.7.9)"
11751 #: ../src/guestfs-actions.pod:2700
11752 msgid "guestfs_inspect_get_major_version"
11757 #: ../src/guestfs-actions.pod:2702
11761 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11762 " const char *root);\n"
11768 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1852
11770 "This returns the major version number of the inspected operating system."
11775 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1855
11777 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11778 "popular public names used by the operating system. Notably the operating "
11779 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11780 "1). You can find out the real versions corresponding to releases of Windows "
11781 "by consulting Wikipedia or MSDN."
11786 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2739
11787 #: ../fish/guestfish-actions.pod:1862 ../fish/guestfish-actions.pod:1876
11788 msgid "If the version could not be determined, then C<0> is returned."
11793 #: ../src/guestfs-actions.pod:2727
11794 msgid "guestfs_inspect_get_minor_version"
11799 #: ../src/guestfs-actions.pod:2729
11803 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11804 " const char *root);\n"
11810 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
11812 "This returns the minor version number of the inspected operating system."
11817 #: ../src/guestfs-actions.pod:2741
11819 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11820 "C<guestfs_inspect_get_major_version>."
11825 #: ../src/guestfs-actions.pod:2748
11826 msgid "guestfs_inspect_get_mountpoints"
11831 #: ../src/guestfs-actions.pod:2750
11835 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11836 " const char *root);\n"
11841 #: ../src/guestfs-actions.pod:2757 ../fish/guestfish-actions.pod:1888
11843 "This returns a hash of where we think the filesystems associated with this "
11844 "operating system should be mounted. Callers should note that this is at "
11845 "best an educated guess made by reading configuration files such as C</etc/"
11846 "fstab>. I<In particular note> that this may return filesystems which are "
11847 "non-existent or not mountable and callers should be prepared to handle or "
11848 "ignore failures if they try to mount them."
11853 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1897
11855 "Each element in the returned hashtable has a key which is the path of the "
11856 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11857 "mounted there (eg. C</dev/sda1>)."
11862 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1902
11864 "Non-mounted devices such as swap devices are I<not> returned in this list."
11869 #: ../src/guestfs-actions.pod:2774
11871 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11872 "C<guestfs_inspect_get_filesystems>."
11877 #: ../src/guestfs-actions.pod:2777 ../src/guestfs-actions.pod:3511
11878 #: ../src/guestfs-actions.pod:4721 ../src/guestfs-actions.pod:6626
11880 "This function returns a NULL-terminated array of strings, or NULL if there "
11881 "was an error. The array of strings will always have length C<2n+1>, where "
11882 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11883 "caller must free the strings and the array after use>."
11888 #: ../src/guestfs-actions.pod:2785
11889 msgid "guestfs_inspect_get_package_format"
11894 #: ../src/guestfs-actions.pod:2787
11898 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11899 " const char *root);\n"
11905 #: ../src/guestfs-actions.pod:2794
11907 "This function and C<guestfs_inspect_get_package_management> return the "
11908 "package format and package management tool used by the inspected operating "
11909 "system. For example for Fedora these functions would return C<rpm> (package "
11910 "format) and C<yum> (package management)."
11915 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1921
11917 "This returns the string C<unknown> if we could not determine the package "
11918 "format I<or> if the operating system does not have a real packaging system "
11924 #: ../src/guestfs-actions.pod:2804 ../fish/guestfish-actions.pod:1925
11926 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11927 "Future versions of libguestfs may return other strings."
11932 #: ../src/guestfs-actions.pod:2812 ../src/guestfs-actions.pod:2843
11933 msgid "(Added in 1.7.5)"
11938 #: ../src/guestfs-actions.pod:2814
11939 msgid "guestfs_inspect_get_package_management"
11944 #: ../src/guestfs-actions.pod:2816
11948 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11949 " const char *root);\n"
11955 #: ../src/guestfs-actions.pod:2823
11957 "C<guestfs_inspect_get_package_format> and this function return the package "
11958 "format and package management tool used by the inspected operating system. "
11959 "For example for Fedora these functions would return C<rpm> (package format) "
11960 "and C<yum> (package management)."
11965 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1943
11967 "This returns the string C<unknown> if we could not determine the package "
11968 "management tool I<or> if the operating system does not have a real packaging "
11969 "system (eg. Windows)."
11974 #: ../src/guestfs-actions.pod:2833 ../fish/guestfish-actions.pod:1947
11976 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11977 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11978 "libguestfs may return other strings."
11983 #: ../src/guestfs-actions.pod:2845
11984 msgid "guestfs_inspect_get_product_name"
11989 #: ../src/guestfs-actions.pod:2847
11993 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11994 " const char *root);\n"
12000 #: ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1961
12002 "This returns the product name of the inspected operating system. The "
12003 "product name is generally some freeform string which can be displayed to the "
12004 "user, but should not be parsed by programs."
12009 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1966
12011 "If the product name could not be determined, then the string C<unknown> is "
12016 #: ../src/guestfs-actions.pod:2869
12017 msgid "guestfs_inspect_get_product_variant"
12021 #: ../src/guestfs-actions.pod:2871
12025 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
12026 " const char *root);\n"
12031 #: ../src/guestfs-actions.pod:2878 ../fish/guestfish-actions.pod:1978
12032 msgid "This returns the product variant of the inspected operating system."
12036 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1981
12038 "For Windows guests, this returns the contents of the Registry key C<HKLM"
12039 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
12040 "is usually a string such as C<Client> or C<Server> (other values are "
12041 "possible). This can be used to distinguish consumer and enterprise versions "
12042 "of Windows that have the same version number (for example, Windows 7 and "
12043 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
12044 "the latter is C<Server>)."
12048 #: ../src/guestfs-actions.pod:2890 ../fish/guestfish-actions.pod:1990
12050 "For enterprise Linux guests, in future we intend this to return the product "
12051 "variant such as C<Desktop>, C<Server> and so on. But this is not "
12052 "implemented at present."
12056 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1994
12058 "If the product variant could not be determined, then the string C<unknown> "
12063 #: ../src/guestfs-actions.pod:2897
12065 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
12066 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
12071 #: ../src/guestfs-actions.pod:2904
12072 msgid "guestfs_inspect_get_roots"
12077 #: ../src/guestfs-actions.pod:2906
12081 " guestfs_inspect_get_roots (guestfs_h *g);\n"
12087 #: ../src/guestfs-actions.pod:2909
12089 "This function is a convenient way to get the list of root devices, as "
12090 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
12091 "the whole inspection process."
12096 #: ../src/guestfs-actions.pod:2913
12098 "This returns an empty list if either no root devices were found or the "
12099 "caller has not called C<guestfs_inspect_os>."
12104 #: ../src/guestfs-actions.pod:2922
12105 msgid "(Added in 1.7.3)"
12110 #: ../src/guestfs-actions.pod:2924
12111 msgid "guestfs_inspect_get_type"
12116 #: ../src/guestfs-actions.pod:2926
12120 " guestfs_inspect_get_type (guestfs_h *g,\n"
12121 " const char *root);\n"
12127 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2021
12129 "This returns the type of the inspected operating system. Currently defined "
12135 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2026
12141 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2028
12142 msgid "Any Linux-based operating system."
12147 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2032
12148 msgid "Any Microsoft Windows operating system."
12153 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2034
12154 msgid "\"freebsd\""
12159 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2036
12165 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2040
12166 msgid "The operating system type could not be determined."
12171 #: ../src/guestfs-actions.pod:2966
12172 msgid "guestfs_inspect_get_windows_systemroot"
12177 #: ../src/guestfs-actions.pod:2968
12181 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
12182 " const char *root);\n"
12188 #: ../src/guestfs-actions.pod:2975 ../fish/guestfish-actions.pod:2056
12190 "This returns the Windows systemroot of the inspected guest. The systemroot "
12191 "is a directory path such as C</WINDOWS>."
12196 #: ../src/guestfs-actions.pod:2978 ../fish/guestfish-actions.pod:2059
12198 "This call assumes that the guest is Windows and that the systemroot could be "
12199 "determined by inspection. If this is not the case then an error is returned."
12204 #: ../src/guestfs-actions.pod:2987
12205 msgid "(Added in 1.5.25)"
12209 #: ../src/guestfs-actions.pod:2989
12210 msgid "guestfs_inspect_is_live"
12214 #: ../src/guestfs-actions.pod:2991
12218 " guestfs_inspect_is_live (guestfs_h *g,\n"
12219 " const char *root);\n"
12224 #: ../src/guestfs-actions.pod:2998
12226 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12227 "disk), then this returns true if a live image was detected on the disk."
12231 #: ../src/guestfs-actions.pod:3006
12232 msgid "guestfs_inspect_is_multipart"
12236 #: ../src/guestfs-actions.pod:3008
12240 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
12241 " const char *root);\n"
12246 #: ../src/guestfs-actions.pod:3015
12248 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12249 "disk), then this returns true if the disk is part of a set."
12253 #: ../src/guestfs-actions.pod:3023
12254 msgid "guestfs_inspect_is_netinst"
12258 #: ../src/guestfs-actions.pod:3025
12262 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
12263 " const char *root);\n"
12268 #: ../src/guestfs-actions.pod:3032
12270 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
12271 "disk), then this returns true if the disk is a network installer, ie. not a "
12272 "self-contained install CD but one which is likely to require network access "
12273 "to complete the install."
12278 #: ../src/guestfs-actions.pod:3042
12279 msgid "guestfs_inspect_list_applications"
12284 #: ../src/guestfs-actions.pod:3044
12287 " struct guestfs_application_list *\n"
12288 " guestfs_inspect_list_applications (guestfs_h *g,\n"
12289 " const char *root);\n"
12295 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2113
12296 msgid "Return the list of applications installed in the operating system."
12301 #: ../src/guestfs-actions.pod:3053
12303 "I<Note:> This call works differently from other parts of the inspection "
12304 "API. You have to call C<guestfs_inspect_os>, then "
12305 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
12306 "this. Listing applications is a significantly more difficult operation "
12307 "which requires access to the full filesystem. Also note that unlike the "
12308 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
12309 "the libguestfs handle, this call actually reads parts of the mounted "
12310 "filesystems during the call."
12315 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2125
12317 "This returns an empty list if the inspection code was not able to determine "
12318 "the list of applications."
12323 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2128
12324 msgid "The application structure contains the following fields:"
12329 #: ../src/guestfs-actions.pod:3070 ../fish/guestfish-actions.pod:2132
12330 msgid "C<app_name>"
12335 #: ../src/guestfs-actions.pod:3072 ../fish/guestfish-actions.pod:2134
12337 "The name of the application. For Red Hat-derived and Debian-derived Linux "
12338 "guests, this is the package name."
12343 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2137
12344 msgid "C<app_display_name>"
12349 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2139
12351 "The display name of the application, sometimes localized to the install "
12352 "language of the guest operating system."
12357 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2142
12359 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
12360 "to display something can use C<app_name> instead."
12365 #: ../src/guestfs-actions.pod:3083 ../fish/guestfish-actions.pod:2145
12366 msgid "C<app_epoch>"
12371 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2147
12373 "For package managers which use epochs, this contains the epoch of the "
12374 "package (an integer). If unavailable, this is returned as C<0>."
12379 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2150
12380 msgid "C<app_version>"
12385 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2152
12387 "The version string of the application or package. If unavailable this is "
12388 "returned as an empty string C<\"\">."
12393 #: ../src/guestfs-actions.pod:3093 ../fish/guestfish-actions.pod:2155
12394 msgid "C<app_release>"
12399 #: ../src/guestfs-actions.pod:3095 ../fish/guestfish-actions.pod:2157
12401 "The release string of the application or package, for package managers that "
12402 "use this. If unavailable this is returned as an empty string C<\"\">."
12407 #: ../src/guestfs-actions.pod:3099 ../fish/guestfish-actions.pod:2161
12408 msgid "C<app_install_path>"
12413 #: ../src/guestfs-actions.pod:3101 ../fish/guestfish-actions.pod:2163
12415 "The installation path of the application (on operating systems such as "
12416 "Windows which use installation paths). This path is in the format used by "
12417 "the guest operating system, it is not a libguestfs path."
12422 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2168
12423 msgid "If unavailable this is returned as an empty string C<\"\">."
12428 #: ../src/guestfs-actions.pod:3108 ../fish/guestfish-actions.pod:2170
12429 msgid "C<app_trans_path>"
12434 #: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2172
12436 "The install path translated into a libguestfs path. If unavailable this is "
12437 "returned as an empty string C<\"\">."
12442 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2175
12443 msgid "C<app_publisher>"
12448 #: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2177
12450 "The name of the publisher of the application, for package managers that use "
12451 "this. If unavailable this is returned as an empty string C<\"\">."
12456 #: ../src/guestfs-actions.pod:3119 ../fish/guestfish-actions.pod:2181
12462 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2183
12464 "The URL (eg. upstream URL) of the application. If unavailable this is "
12465 "returned as an empty string C<\"\">."
12470 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2186
12471 msgid "C<app_source_package>"
12476 #: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2188
12478 "For packaging systems which support this, the name of the source package. "
12479 "If unavailable this is returned as an empty string C<\"\">."
12484 #: ../src/guestfs-actions.pod:3129 ../fish/guestfish-actions.pod:2191
12485 msgid "C<app_summary>"
12490 #: ../src/guestfs-actions.pod:3131 ../fish/guestfish-actions.pod:2193
12492 "A short (usually one line) description of the application or package. If "
12493 "unavailable this is returned as an empty string C<\"\">."
12498 #: ../src/guestfs-actions.pod:3134 ../fish/guestfish-actions.pod:2196
12499 msgid "C<app_description>"
12504 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2198
12506 "A longer description of the application or package. If unavailable this is "
12507 "returned as an empty string C<\"\">."
12512 #: ../src/guestfs-actions.pod:3143
12514 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12515 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12521 #: ../src/guestfs-actions.pod:3147
12522 msgid "(Added in 1.7.8)"
12527 #: ../src/guestfs-actions.pod:3149
12528 msgid "guestfs_inspect_os"
12533 #: ../src/guestfs-actions.pod:3151
12537 " guestfs_inspect_os (guestfs_h *g);\n"
12543 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2209
12545 "This function uses other libguestfs functions and certain heuristics to "
12546 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12547 "for operating systems."
12552 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2213
12553 msgid "The list returned is empty if no operating systems were found."
12558 #: ../src/guestfs-actions.pod:3160 ../fish/guestfish-actions.pod:2215
12560 "If one operating system was found, then this returns a list with a single "
12561 "element, which is the name of the root filesystem of this operating system. "
12562 "It is also possible for this function to return a list containing more than "
12563 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12564 "element being the root filesystem of one of the operating systems."
12569 #: ../src/guestfs-actions.pod:3167
12571 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12572 "functions in order to query further information about each operating system, "
12573 "such as the name and version."
12578 #: ../src/guestfs-actions.pod:3172
12580 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12581 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12582 "the contents. This should be called with no disks currently mounted. The "
12583 "function may also use Augeas, so any existing Augeas handle will be closed."
12588 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2233
12590 "This function cannot decrypt encrypted disks. The caller must do that first "
12591 "(supplying the necessary keys) if the disk is encrypted."
12596 #: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3469
12597 #: ../src/guestfs-actions.pod:3531
12598 msgid "See also C<guestfs_list_filesystems>."
12603 #: ../src/guestfs-actions.pod:3192
12604 msgid "guestfs_is_blockdev"
12609 #: ../src/guestfs-actions.pod:3194
12613 " guestfs_is_blockdev (guestfs_h *g,\n"
12614 " const char *path);\n"
12620 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2245
12622 "This returns C<true> if and only if there is a block device with the given "
12628 #: ../src/guestfs-actions.pod:3201 ../src/guestfs-actions.pod:3230
12629 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3275
12630 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3347
12631 #: ../src/guestfs-actions.pod:3362
12632 msgid "See also C<guestfs_stat>."
12637 #: ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3234
12638 #: ../src/guestfs-actions.pod:3279 ../src/guestfs-actions.pod:3351
12639 #: ../src/guestfs-actions.pod:3366
12640 msgid "(Added in 1.5.10)"
12645 #: ../src/guestfs-actions.pod:3207
12646 msgid "guestfs_is_busy"
12651 #: ../src/guestfs-actions.pod:3209
12655 " guestfs_is_busy (guestfs_h *g);\n"
12661 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2254
12663 "This returns true iff this handle is busy processing a command (in the "
12669 #: ../src/guestfs-actions.pod:3221
12670 msgid "guestfs_is_chardev"
12675 #: ../src/guestfs-actions.pod:3223
12679 " guestfs_is_chardev (guestfs_h *g,\n"
12680 " const char *path);\n"
12686 #: ../src/guestfs-actions.pod:3227 ../fish/guestfish-actions.pod:2263
12688 "This returns C<true> if and only if there is a character device with the "
12689 "given C<path> name."
12694 #: ../src/guestfs-actions.pod:3236
12695 msgid "guestfs_is_config"
12700 #: ../src/guestfs-actions.pod:3238
12704 " guestfs_is_config (guestfs_h *g);\n"
12710 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2272
12712 "This returns true iff this handle is being configured (in the C<CONFIG> "
12718 #: ../src/guestfs-actions.pod:3250
12719 msgid "guestfs_is_dir"
12724 #: ../src/guestfs-actions.pod:3252
12728 " guestfs_is_dir (guestfs_h *g,\n"
12729 " const char *path);\n"
12735 #: ../src/guestfs-actions.pod:3256 ../fish/guestfish-actions.pod:2281
12737 "This returns C<true> if and only if there is a directory with the given "
12738 "C<path> name. Note that it returns false for other objects like files."
12743 #: ../src/guestfs-actions.pod:3266
12744 msgid "guestfs_is_fifo"
12749 #: ../src/guestfs-actions.pod:3268
12753 " guestfs_is_fifo (guestfs_h *g,\n"
12754 " const char *path);\n"
12760 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2291
12762 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12763 "given C<path> name."
12768 #: ../src/guestfs-actions.pod:3281
12769 msgid "guestfs_is_file"
12774 #: ../src/guestfs-actions.pod:3283
12778 " guestfs_is_file (guestfs_h *g,\n"
12779 " const char *path);\n"
12785 #: ../src/guestfs-actions.pod:3287 ../fish/guestfish-actions.pod:2300
12787 "This returns C<true> if and only if there is a regular file with the given "
12788 "C<path> name. Note that it returns false for other objects like directories."
12793 #: ../src/guestfs-actions.pod:3297
12794 msgid "guestfs_is_launching"
12799 #: ../src/guestfs-actions.pod:3299
12803 " guestfs_is_launching (guestfs_h *g);\n"
12809 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2310
12811 "This returns true iff this handle is launching the subprocess (in the "
12812 "C<LAUNCHING> state)."
12817 #: ../src/guestfs-actions.pod:3311
12818 msgid "guestfs_is_lv"
12823 #: ../src/guestfs-actions.pod:3313
12827 " guestfs_is_lv (guestfs_h *g,\n"
12828 " const char *device);\n"
12834 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2319
12836 "This command tests whether C<device> is a logical volume, and returns true "
12837 "iff this is the case."
12842 #: ../src/guestfs-actions.pod:3324
12843 msgid "guestfs_is_ready"
12848 #: ../src/guestfs-actions.pod:3326
12852 " guestfs_is_ready (guestfs_h *g);\n"
12858 #: ../src/guestfs-actions.pod:3329 ../fish/guestfish-actions.pod:2326
12860 "This returns true iff this handle is ready to accept commands (in the "
12866 #: ../src/guestfs-actions.pod:3338
12867 msgid "guestfs_is_socket"
12872 #: ../src/guestfs-actions.pod:3340
12876 " guestfs_is_socket (guestfs_h *g,\n"
12877 " const char *path);\n"
12883 #: ../src/guestfs-actions.pod:3344 ../fish/guestfish-actions.pod:2335
12885 "This returns C<true> if and only if there is a Unix domain socket with the "
12886 "given C<path> name."
12891 #: ../src/guestfs-actions.pod:3353
12892 msgid "guestfs_is_symlink"
12897 #: ../src/guestfs-actions.pod:3355
12901 " guestfs_is_symlink (guestfs_h *g,\n"
12902 " const char *path);\n"
12908 #: ../src/guestfs-actions.pod:3359 ../fish/guestfish-actions.pod:2344
12910 "This returns C<true> if and only if there is a symbolic link with the given "
12916 #: ../src/guestfs-actions.pod:3368
12917 msgid "guestfs_kill_subprocess"
12922 #: ../src/guestfs-actions.pod:3370
12926 " guestfs_kill_subprocess (guestfs_h *g);\n"
12932 #: ../src/guestfs-actions.pod:3373 ../fish/guestfish-actions.pod:2353
12933 msgid "This kills the qemu subprocess. You should never need to call this."
12938 #: ../src/guestfs-actions.pod:3379
12939 msgid "guestfs_launch"
12944 #: ../src/guestfs-actions.pod:3381
12948 " guestfs_launch (guestfs_h *g);\n"
12954 #: ../src/guestfs-actions.pod:3384 ../fish/guestfish-actions.pod:2361
12956 "Internally libguestfs is implemented by running a virtual machine using "
12962 #: ../src/guestfs-actions.pod:3387 ../fish/guestfish-actions.pod:2364
12964 "You should call this after configuring the handle (eg. adding drives) but "
12965 "before performing any actions."
12970 #: ../src/guestfs-actions.pod:3394
12971 msgid "guestfs_lchown"
12976 #: ../src/guestfs-actions.pod:3396
12980 " guestfs_lchown (guestfs_h *g,\n"
12983 " const char *path);\n"
12989 #: ../src/guestfs-actions.pod:3402
12991 "Change the file owner to C<owner> and group to C<group>. This is like "
12992 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12993 "changed, not the target."
12998 #: ../src/guestfs-actions.pod:3414
12999 msgid "guestfs_lgetxattr"
13004 #: ../src/guestfs-actions.pod:3416
13008 " guestfs_lgetxattr (guestfs_h *g,\n"
13009 " const char *path,\n"
13010 " const char *name,\n"
13011 " size_t *size_r);\n"
13017 #: ../src/guestfs-actions.pod:3422 ../fish/guestfish-actions.pod:2383
13019 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
13020 "is a symlink, then this call returns an extended attribute from the symlink."
13025 #: ../src/guestfs-actions.pod:3436
13026 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
13031 #: ../src/guestfs-actions.pod:3444
13032 msgid "guestfs_lgetxattrs"
13037 #: ../src/guestfs-actions.pod:3446
13040 " struct guestfs_xattr_list *\n"
13041 " guestfs_lgetxattrs (guestfs_h *g,\n"
13042 " const char *path);\n"
13048 #: ../src/guestfs-actions.pod:3450
13050 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
13051 "then it returns the extended attributes of the link itself."
13056 #: ../src/guestfs-actions.pod:3460
13057 msgid "guestfs_list_devices"
13062 #: ../src/guestfs-actions.pod:3462
13066 " guestfs_list_devices (guestfs_h *g);\n"
13072 #: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2411
13073 msgid "List all the block devices."
13078 #: ../src/guestfs-actions.pod:3467 ../fish/guestfish-actions.pod:2413
13079 msgid "The full block device names are returned, eg. C</dev/sda>."
13084 #: ../src/guestfs-actions.pod:3477
13085 msgid "guestfs_list_filesystems"
13090 #: ../src/guestfs-actions.pod:3479
13094 " guestfs_list_filesystems (guestfs_h *g);\n"
13100 #: ../src/guestfs-actions.pod:3482 ../fish/guestfish-actions.pod:2421
13102 "This inspection command looks for filesystems on partitions, block devices "
13103 "and logical volumes, returning a list of devices containing filesystems and "
13109 #: ../src/guestfs-actions.pod:3486 ../fish/guestfish-actions.pod:2425
13111 "The return value is a hash, where the keys are the devices containing "
13112 "filesystems, and the values are the filesystem types. For example:"
13117 #: ../src/guestfs-actions.pod:3490 ../fish/guestfish-actions.pod:2429
13120 " \"/dev/sda1\" => \"ntfs\"\n"
13121 " \"/dev/sda2\" => \"ext2\"\n"
13122 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
13123 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
13129 #: ../src/guestfs-actions.pod:3495 ../fish/guestfish-actions.pod:2434
13131 "The value can have the special value \"unknown\", meaning the content of the "
13132 "device is undetermined or empty. \"swap\" means a Linux swap partition."
13137 #: ../src/guestfs-actions.pod:3499
13139 "This command runs other libguestfs commands, which might include "
13140 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
13141 "soon after launch and only when nothing is mounted."
13146 #: ../src/guestfs-actions.pod:3503
13148 "Not all of the filesystems returned will be mountable. In particular, swap "
13149 "partitions are returned in the list. Also this command does not check that "
13150 "each filesystem found is valid and mountable, and some filesystems might be "
13151 "mountable but require special options. Filesystems may not all belong to a "
13152 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
13157 #: ../src/guestfs-actions.pod:3517 ../src/guestfs-actions.pod:5122
13158 msgid "(Added in 1.5.15)"
13163 #: ../src/guestfs-actions.pod:3519
13164 msgid "guestfs_list_partitions"
13169 #: ../src/guestfs-actions.pod:3521
13173 " guestfs_list_partitions (guestfs_h *g);\n"
13179 #: ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:2454
13180 msgid "List all the partitions detected on all block devices."
13185 #: ../src/guestfs-actions.pod:3526 ../fish/guestfish-actions.pod:2456
13186 msgid "The full partition device names are returned, eg. C</dev/sda1>"
13191 #: ../src/guestfs-actions.pod:3528
13193 "This does not return logical volumes. For that you will need to call "
13199 #: ../src/guestfs-actions.pod:3539
13205 #: ../src/guestfs-actions.pod:3541
13209 " guestfs_ll (guestfs_h *g,\n"
13210 " const char *directory);\n"
13216 #: ../src/guestfs-actions.pod:3545 ../fish/guestfish-actions.pod:2467
13218 "List the files in C<directory> (relative to the root directory, there is no "
13219 "cwd) in the format of 'ls -la'."
13224 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2470
13226 "This command is mostly useful for interactive sessions. It is I<not> "
13227 "intended that you try to parse the output string."
13232 #: ../src/guestfs-actions.pod:3556
13238 #: ../src/guestfs-actions.pod:3558
13242 " guestfs_ln (guestfs_h *g,\n"
13243 " const char *target,\n"
13244 " const char *linkname);\n"
13250 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2477
13251 msgid "This command creates a hard link using the C<ln> command."
13256 #: ../src/guestfs-actions.pod:3569
13257 msgid "guestfs_ln_f"
13262 #: ../src/guestfs-actions.pod:3571
13266 " guestfs_ln_f (guestfs_h *g,\n"
13267 " const char *target,\n"
13268 " const char *linkname);\n"
13274 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2483
13276 "This command creates a hard link using the C<ln -f> command. The C<-f> "
13277 "option removes the link (C<linkname>) if it exists already."
13282 #: ../src/guestfs-actions.pod:3583
13283 msgid "guestfs_ln_s"
13288 #: ../src/guestfs-actions.pod:3585
13292 " guestfs_ln_s (guestfs_h *g,\n"
13293 " const char *target,\n"
13294 " const char *linkname);\n"
13300 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2490
13301 msgid "This command creates a symbolic link using the C<ln -s> command."
13306 #: ../src/guestfs-actions.pod:3596
13307 msgid "guestfs_ln_sf"
13312 #: ../src/guestfs-actions.pod:3598
13316 " guestfs_ln_sf (guestfs_h *g,\n"
13317 " const char *target,\n"
13318 " const char *linkname);\n"
13324 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2496
13326 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
13327 "option removes the link (C<linkname>) if it exists already."
13332 #: ../src/guestfs-actions.pod:3610
13333 msgid "guestfs_lremovexattr"
13338 #: ../src/guestfs-actions.pod:3612
13342 " guestfs_lremovexattr (guestfs_h *g,\n"
13343 " const char *xattr,\n"
13344 " const char *path);\n"
13350 #: ../src/guestfs-actions.pod:3617
13352 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
13353 "link, then it removes an extended attribute of the link itself."
13358 #: ../src/guestfs-actions.pod:3625
13364 #: ../src/guestfs-actions.pod:3627
13368 " guestfs_ls (guestfs_h *g,\n"
13369 " const char *directory);\n"
13375 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2511
13377 "List the files in C<directory> (relative to the root directory, there is no "
13378 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
13383 #: ../src/guestfs-actions.pod:3635
13385 "This command is mostly useful for interactive sessions. Programs should "
13386 "probably use C<guestfs_readdir> instead."
13391 #: ../src/guestfs-actions.pod:3644
13392 msgid "guestfs_lsetxattr"
13397 #: ../src/guestfs-actions.pod:3646
13401 " guestfs_lsetxattr (guestfs_h *g,\n"
13402 " const char *xattr,\n"
13403 " const char *val,\n"
13405 " const char *path);\n"
13411 #: ../src/guestfs-actions.pod:3653
13413 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
13414 "then it sets an extended attribute of the link itself."
13419 #: ../src/guestfs-actions.pod:3661
13420 msgid "guestfs_lstat"
13425 #: ../src/guestfs-actions.pod:3663
13428 " struct guestfs_stat *\n"
13429 " guestfs_lstat (guestfs_h *g,\n"
13430 " const char *path);\n"
13436 #: ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:6225
13437 #: ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:4199
13438 msgid "Returns file information for the given C<path>."
13443 #: ../src/guestfs-actions.pod:3669
13445 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
13446 "link, then the link is stat-ed, not the file it refers to."
13451 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2536
13452 msgid "This is the same as the C<lstat(2)> system call."
13457 #: ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:6229
13459 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13460 "error. I<The caller must call C<guestfs_free_stat> after use>."
13465 #: ../src/guestfs-actions.pod:3679 ../src/guestfs-actions.pod:6233
13466 #: ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6632
13467 msgid "(Added in 0.9.2)"
13472 #: ../src/guestfs-actions.pod:3681
13473 msgid "guestfs_lstatlist"
13478 #: ../src/guestfs-actions.pod:3683
13481 " struct guestfs_stat_list *\n"
13482 " guestfs_lstatlist (guestfs_h *g,\n"
13483 " const char *path,\n"
13484 " char *const *names);\n"
13490 #: ../src/guestfs-actions.pod:3688
13492 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13493 "files, where all files are in the directory C<path>. C<names> is the list "
13494 "of files from this directory."
13499 #: ../src/guestfs-actions.pod:3692 ../fish/guestfish-actions.pod:2546
13501 "On return you get a list of stat structs, with a one-to-one correspondence "
13502 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13503 "then the C<ino> field of that structure is set to C<-1>."
13508 #: ../src/guestfs-actions.pod:3697
13510 "This call is intended for programs that want to efficiently list a directory "
13511 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13512 "for a similarly efficient call for getting extended attributes. Very long "
13513 "directory listings might cause the protocol message size to be exceeded, "
13514 "causing this call to fail. The caller must split up such requests into "
13515 "smaller groups of names."
13520 #: ../src/guestfs-actions.pod:3705
13522 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13523 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13528 #: ../src/guestfs-actions.pod:3711
13529 msgid "guestfs_luks_add_key"
13534 #: ../src/guestfs-actions.pod:3713
13538 " guestfs_luks_add_key (guestfs_h *g,\n"
13539 " const char *device,\n"
13540 " const char *key,\n"
13541 " const char *newkey,\n"
13548 #: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2563
13550 "This command adds a new key on LUKS device C<device>. C<key> is any "
13551 "existing key, and is used to access the device. C<newkey> is the new key to "
13552 "add. C<keyslot> is the key slot that will be replaced."
13557 #: ../src/guestfs-actions.pod:3725
13559 "Note that if C<keyslot> already contains a key, then this command will "
13560 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13565 #: ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:3771
13566 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3814
13567 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3865
13569 "This function takes a key or passphrase parameter which could contain "
13570 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13576 #: ../src/guestfs-actions.pod:3735 ../src/guestfs-actions.pod:3775
13577 #: ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:3818
13578 msgid "(Added in 1.5.2)"
13583 #: ../src/guestfs-actions.pod:3737
13584 msgid "guestfs_luks_close"
13589 #: ../src/guestfs-actions.pod:3739
13593 " guestfs_luks_close (guestfs_h *g,\n"
13594 " const char *device);\n"
13600 #: ../src/guestfs-actions.pod:3743
13602 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13603 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13604 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13605 "underlying block device."
13610 #: ../src/guestfs-actions.pod:3751 ../src/guestfs-actions.pod:3850
13611 #: ../src/guestfs-actions.pod:3869 ../src/guestfs-actions.pod:3919
13612 #: ../src/guestfs-actions.pod:3967
13613 msgid "(Added in 1.5.1)"
13618 #: ../src/guestfs-actions.pod:3753
13619 msgid "guestfs_luks_format"
13624 #: ../src/guestfs-actions.pod:3755
13628 " guestfs_luks_format (guestfs_h *g,\n"
13629 " const char *device,\n"
13630 " const char *key,\n"
13637 #: ../src/guestfs-actions.pod:3761 ../fish/guestfish-actions.pod:2589
13639 "This command erases existing data on C<device> and formats the device as a "
13640 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13641 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13646 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3791
13647 #: ../src/guestfs-actions.pod:3931 ../src/guestfs-actions.pod:4873
13648 #: ../src/guestfs-actions.pod:5653 ../src/guestfs-actions.pod:6060
13649 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6109
13650 #: ../src/guestfs-actions.pod:7269 ../fish/guestfish-actions.pod:2597
13651 #: ../fish/guestfish-actions.pod:2610 ../fish/guestfish-actions.pod:2694
13652 #: ../fish/guestfish-actions.pod:3268 ../fish/guestfish-actions.pod:3788
13653 #: ../fish/guestfish-actions.pod:4098 ../fish/guestfish-actions.pod:4114
13654 #: ../fish/guestfish-actions.pod:4129 ../fish/guestfish-actions.pod:4844
13656 "B<This command is dangerous. Without careful use you can easily destroy all "
13662 #: ../src/guestfs-actions.pod:3777
13663 msgid "guestfs_luks_format_cipher"
13668 #: ../src/guestfs-actions.pod:3779
13672 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13673 " const char *device,\n"
13674 " const char *key,\n"
13676 " const char *cipher);\n"
13682 #: ../src/guestfs-actions.pod:3786
13684 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13685 "set the C<cipher> used."
13690 #: ../src/guestfs-actions.pod:3800
13691 msgid "guestfs_luks_kill_slot"
13696 #: ../src/guestfs-actions.pod:3802
13700 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13701 " const char *device,\n"
13702 " const char *key,\n"
13709 #: ../src/guestfs-actions.pod:3808 ../fish/guestfish-actions.pod:2617
13711 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13712 "device C<device>. C<key> must be one of the I<other> keys."
13717 #: ../src/guestfs-actions.pod:3820
13718 msgid "guestfs_luks_open"
13723 #: ../src/guestfs-actions.pod:3822
13727 " guestfs_luks_open (guestfs_h *g,\n"
13728 " const char *device,\n"
13729 " const char *key,\n"
13730 " const char *mapname);\n"
13736 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2628
13738 "This command opens a block device which has been encrypted according to the "
13739 "Linux Unified Key Setup (LUKS) standard."
13744 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2631
13745 msgid "C<device> is the encrypted block device or partition."
13750 #: ../src/guestfs-actions.pod:3833 ../fish/guestfish-actions.pod:2633
13752 "The caller must supply one of the keys associated with the LUKS block "
13753 "device, in the C<key> parameter."
13758 #: ../src/guestfs-actions.pod:3836 ../fish/guestfish-actions.pod:2636
13760 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13761 "writes to this block device are decrypted from and encrypted to the "
13762 "underlying C<device> respectively."
13767 #: ../src/guestfs-actions.pod:3840
13769 "If this block device contains LVM volume groups, then calling "
13770 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13776 #: ../src/guestfs-actions.pod:3852
13777 msgid "guestfs_luks_open_ro"
13782 #: ../src/guestfs-actions.pod:3854
13786 " guestfs_luks_open_ro (guestfs_h *g,\n"
13787 " const char *device,\n"
13788 " const char *key,\n"
13789 " const char *mapname);\n"
13795 #: ../src/guestfs-actions.pod:3860
13797 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13803 #: ../src/guestfs-actions.pod:3871
13804 msgid "guestfs_lvcreate"
13809 #: ../src/guestfs-actions.pod:3873
13813 " guestfs_lvcreate (guestfs_h *g,\n"
13814 " const char *logvol,\n"
13815 " const char *volgroup,\n"
13822 #: ../src/guestfs-actions.pod:3879 ../fish/guestfish-actions.pod:2661
13824 "This creates an LVM logical volume called C<logvol> on the volume group "
13825 "C<volgroup>, with C<size> megabytes."
13830 #: ../src/guestfs-actions.pod:3886
13831 msgid "guestfs_lvm_canonical_lv_name"
13836 #: ../src/guestfs-actions.pod:3888
13840 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13841 " const char *lvname);\n"
13847 #: ../src/guestfs-actions.pod:3892 ../fish/guestfish-actions.pod:2668
13849 "This converts alternative naming schemes for LVs that you might find to the "
13850 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13856 #: ../src/guestfs-actions.pod:3896 ../fish/guestfish-actions.pod:2672
13858 "This command returns an error if the C<lvname> parameter does not refer to a "
13864 #: ../src/guestfs-actions.pod:3899
13865 msgid "See also C<guestfs_is_lv>."
13870 #: ../src/guestfs-actions.pod:3904
13871 msgid "(Added in 1.5.24)"
13876 #: ../src/guestfs-actions.pod:3906
13877 msgid "guestfs_lvm_clear_filter"
13882 #: ../src/guestfs-actions.pod:3908
13886 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13892 #: ../src/guestfs-actions.pod:3911
13894 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13895 "see every block device."
13900 #: ../src/guestfs-actions.pod:3914 ../src/guestfs-actions.pod:3956
13901 #: ../fish/guestfish-actions.pod:2684 ../fish/guestfish-actions.pod:2715
13903 "This command also clears the LVM cache and performs a volume group scan."
13908 #: ../src/guestfs-actions.pod:3921
13909 msgid "guestfs_lvm_remove_all"
13914 #: ../src/guestfs-actions.pod:3923
13918 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13924 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2691
13926 "This command removes all LVM logical volumes, volume groups and physical "
13932 #: ../src/guestfs-actions.pod:3936
13933 msgid "guestfs_lvm_set_filter"
13938 #: ../src/guestfs-actions.pod:3938
13942 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13943 " char *const *devices);\n"
13949 #: ../src/guestfs-actions.pod:3942 ../fish/guestfish-actions.pod:2701
13951 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13952 "block devices in the list C<devices>, and will ignore all other attached "
13958 #: ../src/guestfs-actions.pod:3946 ../fish/guestfish-actions.pod:2705
13960 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13961 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13962 "there are two types of duplication possible: either cloned PVs/VGs which "
13963 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13964 "same name. In normal operation you cannot create this situation, but you "
13965 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13966 "inside the LVM metadata."
13971 #: ../src/guestfs-actions.pod:3959 ../fish/guestfish-actions.pod:2718
13972 msgid "You can filter whole block devices or individual partitions."
13977 #: ../src/guestfs-actions.pod:3961 ../fish/guestfish-actions.pod:2720
13979 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13980 "filesystem), even if you are not filtering out that VG."
13985 #: ../src/guestfs-actions.pod:3969
13986 msgid "guestfs_lvremove"
13991 #: ../src/guestfs-actions.pod:3971
13995 " guestfs_lvremove (guestfs_h *g,\n"
13996 " const char *device);\n"
14002 #: ../src/guestfs-actions.pod:3975 ../fish/guestfish-actions.pod:2728
14004 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
14005 "LV, such as C</dev/VG/LV>."
14010 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2731
14012 "You can also remove all LVs in a volume group by specifying the VG name, C</"
14018 #: ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:5219
14019 #: ../src/guestfs-actions.pod:7008
14020 msgid "(Added in 1.0.13)"
14025 #: ../src/guestfs-actions.pod:3985
14026 msgid "guestfs_lvrename"
14031 #: ../src/guestfs-actions.pod:3987
14035 " guestfs_lvrename (guestfs_h *g,\n"
14036 " const char *logvol,\n"
14037 " const char *newlogvol);\n"
14043 #: ../src/guestfs-actions.pod:3992 ../fish/guestfish-actions.pod:2738
14044 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
14049 #: ../src/guestfs-actions.pod:3996 ../src/guestfs-actions.pod:7021
14050 msgid "(Added in 1.0.83)"
14055 #: ../src/guestfs-actions.pod:3998
14056 msgid "guestfs_lvresize"
14061 #: ../src/guestfs-actions.pod:4000
14065 " guestfs_lvresize (guestfs_h *g,\n"
14066 " const char *device,\n"
14073 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2744
14075 "This resizes (expands or shrinks) an existing LVM logical volume to "
14076 "C<mbytes>. When reducing, data in the reduced part is lost."
14081 #: ../src/guestfs-actions.pod:4013
14082 msgid "guestfs_lvresize_free"
14087 #: ../src/guestfs-actions.pod:4015
14091 " guestfs_lvresize_free (guestfs_h *g,\n"
14092 " const char *lv,\n"
14099 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:2752
14101 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
14102 "remaining free space in the volume group. Commonly you would call this with "
14103 "pc = 100 which expands the logical volume as much as possible, using all "
14104 "remaining free space in the volume group."
14109 #: ../src/guestfs-actions.pod:4028
14110 msgid "(Added in 1.3.3)"
14115 #: ../src/guestfs-actions.pod:4030
14116 msgid "guestfs_lvs"
14121 #: ../src/guestfs-actions.pod:4032
14125 " guestfs_lvs (guestfs_h *g);\n"
14131 #: ../src/guestfs-actions.pod:4035 ../fish/guestfish-actions.pod:2762
14133 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14139 #: ../src/guestfs-actions.pod:4038 ../fish/guestfish-actions.pod:2765
14141 "This returns a list of the logical volume device names (eg. C</dev/"
14142 "VolGroup00/LogVol00>)."
14147 #: ../src/guestfs-actions.pod:4041
14148 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
14153 #: ../src/guestfs-actions.pod:4049
14154 msgid "guestfs_lvs_full"
14159 #: ../src/guestfs-actions.pod:4051
14162 " struct guestfs_lvm_lv_list *\n"
14163 " guestfs_lvs_full (guestfs_h *g);\n"
14169 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2774
14171 "List all the logical volumes detected. This is the equivalent of the L<lvs"
14172 "(8)> command. The \"full\" version includes all fields."
14177 #: ../src/guestfs-actions.pod:4057
14179 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
14180 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
14185 #: ../src/guestfs-actions.pod:4063
14186 msgid "guestfs_lvuuid"
14191 #: ../src/guestfs-actions.pod:4065
14195 " guestfs_lvuuid (guestfs_h *g,\n"
14196 " const char *device);\n"
14202 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2781
14203 msgid "This command returns the UUID of the LVM LV C<device>."
14208 #: ../src/guestfs-actions.pod:4076
14209 msgid "guestfs_lxattrlist"
14214 #: ../src/guestfs-actions.pod:4078
14217 " struct guestfs_xattr_list *\n"
14218 " guestfs_lxattrlist (guestfs_h *g,\n"
14219 " const char *path,\n"
14220 " char *const *names);\n"
14226 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2787
14228 "This call allows you to get the extended attributes of multiple files, where "
14229 "all files are in the directory C<path>. C<names> is the list of files from "
14235 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2791
14237 "On return you get a flat list of xattr structs which must be interpreted "
14238 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
14239 "C<attrval> in this struct is zero-length to indicate there was an error "
14240 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
14241 "number (the number of following attributes for this file, which could be C<"
14242 "\"0\">). Then after the first xattr struct are the zero or more attributes "
14243 "for the first named file. This repeats for the second and subsequent files."
14248 #: ../src/guestfs-actions.pod:4097
14250 "This call is intended for programs that want to efficiently list a directory "
14251 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
14252 "a similarly efficient call for getting standard stats. Very long directory "
14253 "listings might cause the protocol message size to be exceeded, causing this "
14254 "call to fail. The caller must split up such requests into smaller groups of "
14260 #: ../src/guestfs-actions.pod:4111
14261 msgid "guestfs_mkdir"
14266 #: ../src/guestfs-actions.pod:4113
14270 " guestfs_mkdir (guestfs_h *g,\n"
14271 " const char *path);\n"
14277 #: ../src/guestfs-actions.pod:4117 ../fish/guestfish-actions.pod:2813
14278 msgid "Create a directory named C<path>."
14283 #: ../src/guestfs-actions.pod:4123
14284 msgid "guestfs_mkdir_mode"
14289 #: ../src/guestfs-actions.pod:4125
14293 " guestfs_mkdir_mode (guestfs_h *g,\n"
14294 " const char *path,\n"
14301 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2819
14303 "This command creates a directory, setting the initial permissions of the "
14304 "directory to C<mode>."
14309 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2822
14311 "For common Linux filesystems, the actual mode which is set will be C<mode & "
14312 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
14318 #: ../src/guestfs-actions.pod:4137
14319 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
14324 #: ../src/guestfs-actions.pod:4143
14325 msgid "guestfs_mkdir_p"
14330 #: ../src/guestfs-actions.pod:4145
14334 " guestfs_mkdir_p (guestfs_h *g,\n"
14335 " const char *path);\n"
14341 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2832
14343 "Create a directory named C<path>, creating any parent directories as "
14344 "necessary. This is like the C<mkdir -p> shell command."
14349 #: ../src/guestfs-actions.pod:4156
14350 msgid "guestfs_mkdtemp"
14355 #: ../src/guestfs-actions.pod:4158
14359 " guestfs_mkdtemp (guestfs_h *g,\n"
14360 " const char *template);\n"
14366 #: ../src/guestfs-actions.pod:4162 ../fish/guestfish-actions.pod:2839
14368 "This command creates a temporary directory. The C<template> parameter "
14369 "should be a full pathname for the temporary directory name with the final "
14370 "six characters being \"XXXXXX\"."
14375 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2844
14377 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
14378 "being suitable for Windows filesystems."
14383 #: ../src/guestfs-actions.pod:4170 ../fish/guestfish-actions.pod:2847
14384 msgid "The name of the temporary directory that was created is returned."
14389 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2850
14390 msgid "The temporary directory is created with mode 0700 and is owned by root."
14395 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2853
14397 "The caller is responsible for deleting the temporary directory and its "
14398 "contents after use."
14403 #: ../src/guestfs-actions.pod:4179 ../fish/guestfish-actions.pod:2856
14404 msgid "See also: L<mkdtemp(3)>"
14409 #: ../src/guestfs-actions.pod:4186
14410 msgid "guestfs_mke2fs_J"
14415 #: ../src/guestfs-actions.pod:4188
14419 " guestfs_mke2fs_J (guestfs_h *g,\n"
14420 " const char *fstype,\n"
14421 " int blocksize,\n"
14422 " const char *device,\n"
14423 " const char *journal);\n"
14429 #: ../src/guestfs-actions.pod:4195 ../fish/guestfish-actions.pod:2862
14431 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14432 "C<journal>. It is equivalent to the command:"
14437 #: ../src/guestfs-actions.pod:4199 ../fish/guestfish-actions.pod:2866
14440 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
14446 #: ../src/guestfs-actions.pod:4201
14447 msgid "See also C<guestfs_mke2journal>."
14452 #: ../src/guestfs-actions.pod:4205 ../src/guestfs-actions.pod:4223
14453 #: ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4257
14454 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:4285
14455 #: ../src/guestfs-actions.pod:4344 ../src/guestfs-actions.pod:4609
14456 msgid "(Added in 1.0.68)"
14461 #: ../src/guestfs-actions.pod:4207
14462 msgid "guestfs_mke2fs_JL"
14467 #: ../src/guestfs-actions.pod:4209
14471 " guestfs_mke2fs_JL (guestfs_h *g,\n"
14472 " const char *fstype,\n"
14473 " int blocksize,\n"
14474 " const char *device,\n"
14475 " const char *label);\n"
14481 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2874
14483 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14484 "the journal labeled C<label>."
14489 #: ../src/guestfs-actions.pod:4219
14490 msgid "See also C<guestfs_mke2journal_L>."
14495 #: ../src/guestfs-actions.pod:4225
14496 msgid "guestfs_mke2fs_JU"
14501 #: ../src/guestfs-actions.pod:4227
14505 " guestfs_mke2fs_JU (guestfs_h *g,\n"
14506 " const char *fstype,\n"
14507 " int blocksize,\n"
14508 " const char *device,\n"
14509 " const char *uuid);\n"
14515 #: ../src/guestfs-actions.pod:4234 ../fish/guestfish-actions.pod:2883
14517 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
14518 "the journal with UUID C<uuid>."
14523 #: ../src/guestfs-actions.pod:4237
14524 msgid "See also C<guestfs_mke2journal_U>."
14529 #: ../src/guestfs-actions.pod:4243
14530 msgid "guestfs_mke2journal"
14535 #: ../src/guestfs-actions.pod:4245
14539 " guestfs_mke2journal (guestfs_h *g,\n"
14540 " int blocksize,\n"
14541 " const char *device);\n"
14547 #: ../src/guestfs-actions.pod:4250 ../fish/guestfish-actions.pod:2892
14549 "This creates an ext2 external journal on C<device>. It is equivalent to the "
14555 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2895
14558 " mke2fs -O journal_dev -b blocksize device\n"
14564 #: ../src/guestfs-actions.pod:4259
14565 msgid "guestfs_mke2journal_L"
14570 #: ../src/guestfs-actions.pod:4261
14574 " guestfs_mke2journal_L (guestfs_h *g,\n"
14575 " int blocksize,\n"
14576 " const char *label,\n"
14577 " const char *device);\n"
14583 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2901
14584 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14589 #: ../src/guestfs-actions.pod:4273
14590 msgid "guestfs_mke2journal_U"
14595 #: ../src/guestfs-actions.pod:4275
14599 " guestfs_mke2journal_U (guestfs_h *g,\n"
14600 " int blocksize,\n"
14601 " const char *uuid,\n"
14602 " const char *device);\n"
14608 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2907
14609 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14614 #: ../src/guestfs-actions.pod:4287
14615 msgid "guestfs_mkfifo"
14620 #: ../src/guestfs-actions.pod:4289
14624 " guestfs_mkfifo (guestfs_h *g,\n"
14626 " const char *path);\n"
14632 #: ../src/guestfs-actions.pod:4294
14634 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14635 "is just a convenient wrapper around C<guestfs_mknod>."
14640 #: ../src/guestfs-actions.pod:4304
14641 msgid "guestfs_mkfs"
14646 #: ../src/guestfs-actions.pod:4306
14650 " guestfs_mkfs (guestfs_h *g,\n"
14651 " const char *fstype,\n"
14652 " const char *device);\n"
14658 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2923
14660 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14661 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14666 #: ../src/guestfs-actions.pod:4319
14667 msgid "guestfs_mkfs_b"
14672 #: ../src/guestfs-actions.pod:4321
14676 " guestfs_mkfs_b (guestfs_h *g,\n"
14677 " const char *fstype,\n"
14678 " int blocksize,\n"
14679 " const char *device);\n"
14685 #: ../src/guestfs-actions.pod:4327
14687 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14688 "block size of the resulting filesystem. Supported block sizes depend on the "
14689 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14694 #: ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4375
14695 #: ../fish/guestfish-actions.pod:2936 ../fish/guestfish-actions.pod:2963
14697 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14703 #: ../src/guestfs-actions.pod:4337 ../fish/guestfish-actions.pod:2939
14705 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14710 #: ../src/guestfs-actions.pod:4346
14711 msgid "guestfs_mkfs_opts"
14716 #: ../src/guestfs-actions.pod:4348
14720 " guestfs_mkfs_opts (guestfs_h *g,\n"
14721 " const char *fstype,\n"
14722 " const char *device,\n"
14728 #: ../src/guestfs-actions.pod:4359
14731 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14732 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14738 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2950
14740 "This function creates a filesystem on C<device>. The filesystem type is "
14741 "C<fstype>, for example C<ext3>."
14746 #: ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:2957
14747 msgid "C<blocksize>"
14752 #: ../src/guestfs-actions.pod:4371 ../fish/guestfish-actions.pod:2959
14754 "The filesystem block size. Supported block sizes depend on the filesystem "
14755 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14760 #: ../src/guestfs-actions.pod:4378 ../fish/guestfish-actions.pod:2966
14761 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14765 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2968
14766 msgid "C<features>"
14770 #: ../src/guestfs-actions.pod:4382 ../fish/guestfish-actions.pod:2970
14771 msgid "This passes the C<-O> parameter to the external mkfs program."
14775 #: ../src/guestfs-actions.pod:4384 ../fish/guestfish-actions.pod:2972
14777 "For certain filesystem types, this allows extra filesystem features to be "
14778 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14782 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:2976
14784 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14789 #: ../src/guestfs-actions.pod:4395
14790 msgid "(Added in 1.7.19)"
14795 #: ../src/guestfs-actions.pod:4397
14796 msgid "guestfs_mkfs_opts_va"
14801 #: ../src/guestfs-actions.pod:4399
14805 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14806 " const char *fstype,\n"
14807 " const char *device,\n"
14808 " va_list args);\n"
14814 #: ../src/guestfs-actions.pod:4405
14815 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14820 #: ../src/guestfs-actions.pod:4409
14821 msgid "guestfs_mkfs_opts_argv"
14826 #: ../src/guestfs-actions.pod:4411
14830 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14831 " const char *fstype,\n"
14832 " const char *device,\n"
14833 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14839 #: ../src/guestfs-actions.pod:4417
14840 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14845 #: ../src/guestfs-actions.pod:4421
14846 msgid "guestfs_mkmountpoint"
14851 #: ../src/guestfs-actions.pod:4423
14855 " guestfs_mkmountpoint (guestfs_h *g,\n"
14856 " const char *exemptpath);\n"
14862 #: ../src/guestfs-actions.pod:4427
14864 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14865 "that can be used to create extra mountpoints before mounting the first "
14871 #: ../src/guestfs-actions.pod:4431 ../fish/guestfish-actions.pod:2991
14873 "These calls are I<only> necessary in some very limited circumstances, mainly "
14874 "the case where you want to mount a mix of unrelated and/or read-only "
14875 "filesystems together."
14880 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:2995
14882 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14883 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14884 "inside that. You can unpack this as follows in guestfish:"
14889 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:3000
14892 " add-ro Fedora-11-i686-Live.iso\n"
14894 " mkmountpoint /cd\n"
14895 " mkmountpoint /sqsh\n"
14896 " mkmountpoint /ext3fs\n"
14897 " mount /dev/sda /cd\n"
14898 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14899 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14905 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:3009
14906 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14911 #: ../src/guestfs-actions.pod:4451
14913 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14914 "may get unexpected errors if you try to mix these calls. It is safest to "
14915 "manually unmount filesystems and remove mountpoints after use."
14920 #: ../src/guestfs-actions.pod:4455
14922 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14923 "first, so for this to work for manual mountpoints, you must ensure that the "
14924 "innermost mountpoints have the longest pathnames, as in the example code "
14930 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3020
14932 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14936 #: ../src/guestfs-actions.pod:4462
14938 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14939 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14940 "can also trigger these issues."
14945 #: ../src/guestfs-actions.pod:4468 ../src/guestfs-actions.pod:4727
14946 #: ../src/guestfs-actions.pod:5637
14947 msgid "(Added in 1.0.62)"
14952 #: ../src/guestfs-actions.pod:4470
14953 msgid "guestfs_mknod"
14958 #: ../src/guestfs-actions.pod:4472
14962 " guestfs_mknod (guestfs_h *g,\n"
14966 " const char *path);\n"
14972 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3030
14974 "This call creates block or character special devices, or named pipes (FIFOs)."
14979 #: ../src/guestfs-actions.pod:4482 ../fish/guestfish-actions.pod:3033
14981 "The C<mode> parameter should be the mode, using the standard constants. "
14982 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14983 "used when creating block and character special devices."
14988 #: ../src/guestfs-actions.pod:4487
14990 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14991 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14992 "regular file). These constants are available in the standard Linux header "
14993 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14994 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14995 "the appropriate constant for you."
15000 #: ../src/guestfs-actions.pod:4501
15001 msgid "guestfs_mknod_b"
15006 #: ../src/guestfs-actions.pod:4503
15010 " guestfs_mknod_b (guestfs_h *g,\n"
15014 " const char *path);\n"
15020 #: ../src/guestfs-actions.pod:4510
15022 "This call creates a block device node called C<path> with mode C<mode> and "
15023 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15024 "wrapper around C<guestfs_mknod>."
15029 #: ../src/guestfs-actions.pod:4520
15030 msgid "guestfs_mknod_c"
15035 #: ../src/guestfs-actions.pod:4522
15039 " guestfs_mknod_c (guestfs_h *g,\n"
15043 " const char *path);\n"
15049 #: ../src/guestfs-actions.pod:4529
15051 "This call creates a char device node called C<path> with mode C<mode> and "
15052 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
15053 "wrapper around C<guestfs_mknod>."
15058 #: ../src/guestfs-actions.pod:4539
15059 msgid "guestfs_mkswap"
15064 #: ../src/guestfs-actions.pod:4541
15068 " guestfs_mkswap (guestfs_h *g,\n"
15069 " const char *device);\n"
15075 #: ../src/guestfs-actions.pod:4545 ../fish/guestfish-actions.pod:3072
15076 msgid "Create a swap partition on C<device>."
15081 #: ../src/guestfs-actions.pod:4551
15082 msgid "guestfs_mkswap_L"
15087 #: ../src/guestfs-actions.pod:4553
15091 " guestfs_mkswap_L (guestfs_h *g,\n"
15092 " const char *label,\n"
15093 " const char *device);\n"
15099 #: ../src/guestfs-actions.pod:4558 ../fish/guestfish-actions.pod:3078
15100 msgid "Create a swap partition on C<device> with label C<label>."
15105 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3080
15107 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
15108 "sda>), just to a partition. This appears to be a limitation of the kernel "
15114 #: ../src/guestfs-actions.pod:4568
15115 msgid "guestfs_mkswap_U"
15120 #: ../src/guestfs-actions.pod:4570
15124 " guestfs_mkswap_U (guestfs_h *g,\n"
15125 " const char *uuid,\n"
15126 " const char *device);\n"
15132 #: ../src/guestfs-actions.pod:4575 ../fish/guestfish-actions.pod:3088
15133 msgid "Create a swap partition on C<device> with UUID C<uuid>."
15138 #: ../src/guestfs-actions.pod:4581
15139 msgid "guestfs_mkswap_file"
15144 #: ../src/guestfs-actions.pod:4583
15148 " guestfs_mkswap_file (guestfs_h *g,\n"
15149 " const char *path);\n"
15155 #: ../src/guestfs-actions.pod:4587 ../fish/guestfish-actions.pod:3094
15156 msgid "Create a swap file."
15161 #: ../src/guestfs-actions.pod:4589
15163 "This command just writes a swap file signature to an existing file. To "
15164 "create the file itself, use something like C<guestfs_fallocate>."
15169 #: ../src/guestfs-actions.pod:4596
15170 msgid "guestfs_modprobe"
15175 #: ../src/guestfs-actions.pod:4598
15179 " guestfs_modprobe (guestfs_h *g,\n"
15180 " const char *modulename);\n"
15186 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3103
15187 msgid "This loads a kernel module in the appliance."
15192 #: ../src/guestfs-actions.pod:4604 ../fish/guestfish-actions.pod:3105
15194 "The kernel module must have been whitelisted when libguestfs was built (see "
15195 "C<appliance/kmod.whitelist.in> in the source)."
15200 #: ../src/guestfs-actions.pod:4611
15201 msgid "guestfs_mount"
15206 #: ../src/guestfs-actions.pod:4613
15210 " guestfs_mount (guestfs_h *g,\n"
15211 " const char *device,\n"
15212 " const char *mountpoint);\n"
15218 #: ../src/guestfs-actions.pod:4618 ../fish/guestfish-actions.pod:3112
15220 "Mount a guest disk at a position in the filesystem. Block devices are named "
15221 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
15222 "those block devices contain partitions, they will have the usual names (eg. "
15223 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
15228 #: ../src/guestfs-actions.pod:4624 ../fish/guestfish-actions.pod:3118
15230 "The rules are the same as for L<mount(2)>: A filesystem must first be "
15231 "mounted on C</> before others can be mounted. Other filesystems can only be "
15232 "mounted on directories which already exist."
15237 #: ../src/guestfs-actions.pod:4629 ../fish/guestfish-actions.pod:3123
15239 "The mounted filesystem is writable, if we have sufficient permissions on the "
15240 "underlying device."
15245 #: ../src/guestfs-actions.pod:4632
15247 "B<Important note:> When you use this call, the filesystem options C<sync> "
15248 "and C<noatime> are set implicitly. This was originally done because we "
15249 "thought it would improve reliability, but it turns out that I<-o sync> has a "
15250 "very large negative performance impact and negligible effect on "
15251 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
15252 "in any code that needs performance, and instead use C<guestfs_mount_options> "
15253 "(use an empty string for the first parameter if you don't want any options)."
15258 #: ../src/guestfs-actions.pod:4646
15259 msgid "guestfs_mount_loop"
15264 #: ../src/guestfs-actions.pod:4648
15268 " guestfs_mount_loop (guestfs_h *g,\n"
15269 " const char *file,\n"
15270 " const char *mountpoint);\n"
15276 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3140
15278 "This command lets you mount C<file> (a filesystem image in a file) on a "
15279 "mount point. It is entirely equivalent to the command C<mount -o loop file "
15285 #: ../src/guestfs-actions.pod:4661
15286 msgid "guestfs_mount_options"
15291 #: ../src/guestfs-actions.pod:4663
15295 " guestfs_mount_options (guestfs_h *g,\n"
15296 " const char *options,\n"
15297 " const char *device,\n"
15298 " const char *mountpoint);\n"
15304 #: ../src/guestfs-actions.pod:4669
15306 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15307 "the mount options as for the L<mount(8)> I<-o> flag."
15312 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3152
15314 "If the C<options> parameter is an empty string, then no options are passed "
15315 "(all options default to whatever the filesystem uses)."
15320 #: ../src/guestfs-actions.pod:4679 ../src/guestfs-actions.pod:4693
15321 #: ../src/guestfs-actions.pod:4710
15322 msgid "(Added in 1.0.10)"
15327 #: ../src/guestfs-actions.pod:4681
15328 msgid "guestfs_mount_ro"
15333 #: ../src/guestfs-actions.pod:4683
15337 " guestfs_mount_ro (guestfs_h *g,\n"
15338 " const char *device,\n"
15339 " const char *mountpoint);\n"
15345 #: ../src/guestfs-actions.pod:4688
15347 "This is the same as the C<guestfs_mount> command, but it mounts the "
15348 "filesystem with the read-only (I<-o ro>) flag."
15353 #: ../src/guestfs-actions.pod:4695
15354 msgid "guestfs_mount_vfs"
15359 #: ../src/guestfs-actions.pod:4697
15363 " guestfs_mount_vfs (guestfs_h *g,\n"
15364 " const char *options,\n"
15365 " const char *vfstype,\n"
15366 " const char *device,\n"
15367 " const char *mountpoint);\n"
15373 #: ../src/guestfs-actions.pod:4704
15375 "This is the same as the C<guestfs_mount> command, but it allows you to set "
15376 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
15382 #: ../src/guestfs-actions.pod:4712
15383 msgid "guestfs_mountpoints"
15388 #: ../src/guestfs-actions.pod:4714
15392 " guestfs_mountpoints (guestfs_h *g);\n"
15398 #: ../src/guestfs-actions.pod:4717
15400 "This call is similar to C<guestfs_mounts>. That call returns a list of "
15401 "devices. This one returns a hash table (map) of device name to directory "
15402 "where the device is mounted."
15407 #: ../src/guestfs-actions.pod:4729
15408 msgid "guestfs_mounts"
15413 #: ../src/guestfs-actions.pod:4731
15417 " guestfs_mounts (guestfs_h *g);\n"
15423 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3183
15425 "This returns the list of currently mounted filesystems. It returns the list "
15426 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
15431 #: ../src/guestfs-actions.pod:4737 ../fish/guestfish-actions.pod:3186
15432 msgid "Some internal mounts are not shown."
15437 #: ../src/guestfs-actions.pod:4739
15438 msgid "See also: C<guestfs_mountpoints>"
15443 #: ../src/guestfs-actions.pod:4747
15449 #: ../src/guestfs-actions.pod:4749
15453 " guestfs_mv (guestfs_h *g,\n"
15454 " const char *src,\n"
15455 " const char *dest);\n"
15461 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3194
15463 "This moves a file from C<src> to C<dest> where C<dest> is either a "
15464 "destination filename or destination directory."
15469 #: ../src/guestfs-actions.pod:4761
15470 msgid "guestfs_ntfs_3g_probe"
15475 #: ../src/guestfs-actions.pod:4763
15479 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
15481 " const char *device);\n"
15487 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3201
15489 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
15490 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
15491 "write, and some cannot be mounted at all)."
15496 #: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3205
15498 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
15499 "can be mounted read-write. Set it to false if you want to test if the "
15500 "volume can be mounted read-only."
15505 #: ../src/guestfs-actions.pod:4776 ../fish/guestfish-actions.pod:3209
15507 "The return value is an integer which C<0> if the operation would succeed, or "
15508 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
15513 #: ../src/guestfs-actions.pod:4782
15514 msgid "(Added in 1.0.43)"
15519 #: ../src/guestfs-actions.pod:4784
15520 msgid "guestfs_ntfsresize"
15525 #: ../src/guestfs-actions.pod:4786
15529 " guestfs_ntfsresize (guestfs_h *g,\n"
15530 " const char *device);\n"
15536 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3217
15538 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
15539 "size of the underlying device. See also L<ntfsresize(8)>."
15544 #: ../src/guestfs-actions.pod:4798
15545 msgid "guestfs_ntfsresize_size"
15550 #: ../src/guestfs-actions.pod:4800
15554 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15555 " const char *device,\n"
15556 " int64_t size);\n"
15562 #: ../src/guestfs-actions.pod:4805
15564 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15565 "to specify the new size (in bytes) explicitly."
15570 #: ../src/guestfs-actions.pod:4810 ../src/guestfs-actions.pod:5246
15571 #: ../src/guestfs-actions.pod:5319 ../src/guestfs-actions.pod:5585
15572 #: ../src/guestfs-actions.pod:7156
15573 msgid "(Added in 1.3.14)"
15578 #: ../src/guestfs-actions.pod:4812
15579 msgid "guestfs_part_add"
15584 #: ../src/guestfs-actions.pod:4814
15588 " guestfs_part_add (guestfs_h *g,\n"
15589 " const char *device,\n"
15590 " const char *prlogex,\n"
15591 " int64_t startsect,\n"
15592 " int64_t endsect);\n"
15598 #: ../src/guestfs-actions.pod:4821
15600 "This command adds a partition to C<device>. If there is no partition table "
15601 "on the device, call C<guestfs_part_init> first."
15606 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3235
15608 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15609 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15610 "C<logical>) and C<e> (or C<extended>) partition types."
15615 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3240
15617 "C<startsect> and C<endsect> are the start and end of the partition in "
15618 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15619 "from the end of the disk (C<-1> is the last sector)."
15624 #: ../src/guestfs-actions.pod:4833
15626 "Creating a partition which covers the whole disk is not so easy. Use "
15627 "C<guestfs_part_disk> to do that."
15632 #: ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4876
15633 #: ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:5007
15634 #: ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5064
15635 #: ../src/guestfs-actions.pod:5104
15636 msgid "(Added in 1.0.78)"
15641 #: ../src/guestfs-actions.pod:4840
15642 msgid "guestfs_part_del"
15647 #: ../src/guestfs-actions.pod:4842
15651 " guestfs_part_del (guestfs_h *g,\n"
15652 " const char *device,\n"
15659 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3251
15660 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15665 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3253
15667 "Note that in the case of MBR partitioning, deleting an extended partition "
15668 "also deletes any logical partitions it contains."
15673 #: ../src/guestfs-actions.pod:4857
15674 msgid "guestfs_part_disk"
15679 #: ../src/guestfs-actions.pod:4859
15683 " guestfs_part_disk (guestfs_h *g,\n"
15684 " const char *device,\n"
15685 " const char *parttype);\n"
15691 #: ../src/guestfs-actions.pod:4864
15693 "This command is simply a combination of C<guestfs_part_init> followed by "
15694 "C<guestfs_part_add> to create a single primary partition covering the whole "
15700 #: ../src/guestfs-actions.pod:4868
15702 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15703 "possible values are described in C<guestfs_part_init>."
15708 #: ../src/guestfs-actions.pod:4878
15709 msgid "guestfs_part_get_bootable"
15714 #: ../src/guestfs-actions.pod:4880
15718 " guestfs_part_get_bootable (guestfs_h *g,\n"
15719 " const char *device,\n"
15726 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3275
15728 "This command returns true if the partition C<partnum> on C<device> has the "
15729 "bootable flag set."
15734 #: ../src/guestfs-actions.pod:4888
15735 msgid "See also C<guestfs_part_set_bootable>."
15740 #: ../src/guestfs-actions.pod:4894
15741 msgid "guestfs_part_get_mbr_id"
15746 #: ../src/guestfs-actions.pod:4896
15750 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15751 " const char *device,\n"
15758 #: ../src/guestfs-actions.pod:4901 ../fish/guestfish-actions.pod:3284
15760 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15761 "partition C<partnum>."
15766 #: ../src/guestfs-actions.pod:4904 ../src/guestfs-actions.pod:5080
15768 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15769 "undefined results for other partition table types (see "
15770 "C<guestfs_part_get_parttype>)."
15775 #: ../src/guestfs-actions.pod:4912
15776 msgid "guestfs_part_get_parttype"
15781 #: ../src/guestfs-actions.pod:4914
15785 " guestfs_part_get_parttype (guestfs_h *g,\n"
15786 " const char *device);\n"
15792 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3295
15794 "This command examines the partition table on C<device> and returns the "
15795 "partition table type (format) being used."
15800 #: ../src/guestfs-actions.pod:4921
15802 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15803 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15804 "possible, although unusual. See C<guestfs_part_init> for a full list."
15809 #: ../src/guestfs-actions.pod:4931
15810 msgid "guestfs_part_init"
15815 #: ../src/guestfs-actions.pod:4933
15819 " guestfs_part_init (guestfs_h *g,\n"
15820 " const char *device,\n"
15821 " const char *parttype);\n"
15827 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3307
15829 "This creates an empty partition table on C<device> of one of the partition "
15830 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15831 "(for large disks)."
15836 #: ../src/guestfs-actions.pod:4942
15838 "Initially there are no partitions. Following this, you should call "
15839 "C<guestfs_part_add> for each partition required."
15844 #: ../src/guestfs-actions.pod:4945 ../fish/guestfish-actions.pod:3314
15845 msgid "Possible values for C<parttype> are:"
15850 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3318
15851 msgid "B<efi> | B<gpt>"
15856 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3320
15857 msgid "Intel EFI / GPT partition table."
15862 #: ../src/guestfs-actions.pod:4953 ../fish/guestfish-actions.pod:3322
15864 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15865 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15866 "the C<mbr> format."
15871 #: ../src/guestfs-actions.pod:4957 ../fish/guestfish-actions.pod:3326
15872 msgid "B<mbr> | B<msdos>"
15877 #: ../src/guestfs-actions.pod:4959 ../fish/guestfish-actions.pod:3328
15879 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15880 "Windows. This partition type will B<only> work for device sizes up to 2 "
15881 "TB. For large disks we recommend using C<gpt>."
15886 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3335
15888 "Other partition table types that may work but are not supported include:"
15893 #: ../src/guestfs-actions.pod:4971 ../fish/guestfish-actions.pod:3340
15899 #: ../src/guestfs-actions.pod:4973 ../fish/guestfish-actions.pod:3342
15900 msgid "AIX disk labels."
15905 #: ../src/guestfs-actions.pod:4975 ../fish/guestfish-actions.pod:3344
15906 msgid "B<amiga> | B<rdb>"
15911 #: ../src/guestfs-actions.pod:4977 ../fish/guestfish-actions.pod:3346
15912 msgid "Amiga \"Rigid Disk Block\" format."
15917 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3348
15923 #: ../src/guestfs-actions.pod:4981 ../fish/guestfish-actions.pod:3350
15924 msgid "BSD disk labels."
15929 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3352
15935 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3354
15936 msgid "DASD, used on IBM mainframes."
15941 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3356
15947 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3358
15948 msgid "MIPS/SGI volumes."
15953 #: ../src/guestfs-actions.pod:4991 ../fish/guestfish-actions.pod:3360
15959 #: ../src/guestfs-actions.pod:4993 ../fish/guestfish-actions.pod:3362
15960 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15965 #: ../src/guestfs-actions.pod:4995 ../fish/guestfish-actions.pod:3364
15971 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3366
15972 msgid "NEC PC-98 format, common in Japan apparently."
15977 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3368
15983 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3370
15984 msgid "Sun disk labels."
15989 #: ../src/guestfs-actions.pod:5009
15990 msgid "guestfs_part_list"
15995 #: ../src/guestfs-actions.pod:5011
15998 " struct guestfs_partition_list *\n"
15999 " guestfs_part_list (guestfs_h *g,\n"
16000 " const char *device);\n"
16006 #: ../src/guestfs-actions.pod:5015 ../fish/guestfish-actions.pod:3378
16008 "This command parses the partition table on C<device> and returns the list of "
16009 "partitions found."
16014 #: ../src/guestfs-actions.pod:5018 ../fish/guestfish-actions.pod:3381
16015 msgid "The fields in the returned structure are:"
16020 #: ../src/guestfs-actions.pod:5022 ../fish/guestfish-actions.pod:3385
16021 msgid "B<part_num>"
16026 #: ../src/guestfs-actions.pod:5024 ../fish/guestfish-actions.pod:3387
16027 msgid "Partition number, counting from 1."
16032 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3389
16033 msgid "B<part_start>"
16038 #: ../src/guestfs-actions.pod:5028
16040 "Start of the partition I<in bytes>. To get sectors you have to divide by "
16041 "the device's sector size, see C<guestfs_blockdev_getss>."
16046 #: ../src/guestfs-actions.pod:5031 ../fish/guestfish-actions.pod:3394
16047 msgid "B<part_end>"
16052 #: ../src/guestfs-actions.pod:5033 ../fish/guestfish-actions.pod:3396
16053 msgid "End of the partition in bytes."
16058 #: ../src/guestfs-actions.pod:5035 ../fish/guestfish-actions.pod:3398
16059 msgid "B<part_size>"
16064 #: ../src/guestfs-actions.pod:5037 ../fish/guestfish-actions.pod:3400
16065 msgid "Size of the partition in bytes."
16070 #: ../src/guestfs-actions.pod:5041
16072 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
16073 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
16079 #: ../src/guestfs-actions.pod:5047
16080 msgid "guestfs_part_set_bootable"
16085 #: ../src/guestfs-actions.pod:5049
16089 " guestfs_part_set_bootable (guestfs_h *g,\n"
16090 " const char *device,\n"
16092 " int bootable);\n"
16098 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3408
16100 "This sets the bootable flag on partition numbered C<partnum> on device "
16101 "C<device>. Note that partitions are numbered from 1."
16106 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3411
16108 "The bootable flag is used by some operating systems (notably Windows) to "
16109 "determine which partition to boot from. It is by no means universally "
16115 #: ../src/guestfs-actions.pod:5066
16116 msgid "guestfs_part_set_mbr_id"
16121 #: ../src/guestfs-actions.pod:5068
16125 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
16126 " const char *device,\n"
16134 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3419
16136 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
16137 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
16138 "documentation are in fact hexadecimal numbers, but usually documented "
16139 "without any leading \"0x\" which might be confusing."
16144 #: ../src/guestfs-actions.pod:5088
16145 msgid "guestfs_part_set_name"
16150 #: ../src/guestfs-actions.pod:5090
16154 " guestfs_part_set_name (guestfs_h *g,\n"
16155 " const char *device,\n"
16157 " const char *name);\n"
16163 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3433
16165 "This sets the partition name on partition numbered C<partnum> on device "
16166 "C<device>. Note that partitions are numbered from 1."
16171 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3436
16173 "The partition name can only be set on certain types of partition table. "
16174 "This works on C<gpt> but not on C<mbr> partitions."
16179 #: ../src/guestfs-actions.pod:5106
16180 msgid "guestfs_part_to_dev"
16185 #: ../src/guestfs-actions.pod:5108
16189 " guestfs_part_to_dev (guestfs_h *g,\n"
16190 " const char *partition);\n"
16196 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3443
16198 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
16199 "partition number, returning the device name (eg. \"/dev/sdb\")."
16204 #: ../src/guestfs-actions.pod:5116
16206 "The named partition must exist, for example as a string returned from "
16207 "C<guestfs_list_partitions>."
16212 #: ../src/guestfs-actions.pod:5124
16213 msgid "guestfs_ping_daemon"
16218 #: ../src/guestfs-actions.pod:5126
16222 " guestfs_ping_daemon (guestfs_h *g);\n"
16228 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3454
16230 "This is a test probe into the guestfs daemon running inside the qemu "
16231 "subprocess. Calling this function checks that the daemon responds to the "
16232 "ping message, without affecting the daemon or attached block device(s) in "
16238 #: ../src/guestfs-actions.pod:5138
16239 msgid "guestfs_pread"
16244 #: ../src/guestfs-actions.pod:5140
16248 " guestfs_pread (guestfs_h *g,\n"
16249 " const char *path,\n"
16251 " int64_t offset,\n"
16252 " size_t *size_r);\n"
16258 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3463
16260 "This command lets you read part of a file. It reads C<count> bytes of the "
16261 "file, starting at C<offset>, from file C<path>."
16266 #: ../src/guestfs-actions.pod:5150 ../src/guestfs-actions.pod:5176
16267 #: ../fish/guestfish-actions.pod:3466 ../fish/guestfish-actions.pod:3481
16269 "This may read fewer bytes than requested. For further details see the "
16270 "L<pread(2)> system call."
16275 #: ../src/guestfs-actions.pod:5153
16276 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
16281 #: ../src/guestfs-actions.pod:5164
16282 msgid "guestfs_pread_device"
16287 #: ../src/guestfs-actions.pod:5166
16291 " guestfs_pread_device (guestfs_h *g,\n"
16292 " const char *device,\n"
16294 " int64_t offset,\n"
16295 " size_t *size_r);\n"
16301 #: ../src/guestfs-actions.pod:5173 ../fish/guestfish-actions.pod:3478
16303 "This command lets you read part of a file. It reads C<count> bytes of "
16304 "C<device>, starting at C<offset>."
16309 #: ../src/guestfs-actions.pod:5179
16310 msgid "See also C<guestfs_pread>."
16315 #: ../src/guestfs-actions.pod:5188
16316 msgid "(Added in 1.5.21)"
16321 #: ../src/guestfs-actions.pod:5190
16322 msgid "guestfs_pvcreate"
16327 #: ../src/guestfs-actions.pod:5192
16331 " guestfs_pvcreate (guestfs_h *g,\n"
16332 " const char *device);\n"
16338 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3493
16340 "This creates an LVM physical volume on the named C<device>, where C<device> "
16341 "should usually be a partition name such as C</dev/sda1>."
16346 #: ../src/guestfs-actions.pod:5204
16347 msgid "guestfs_pvremove"
16352 #: ../src/guestfs-actions.pod:5206
16356 " guestfs_pvremove (guestfs_h *g,\n"
16357 " const char *device);\n"
16363 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3501
16365 "This wipes a physical volume C<device> so that LVM will no longer recognise "
16371 #: ../src/guestfs-actions.pod:5213 ../fish/guestfish-actions.pod:3504
16373 "The implementation uses the C<pvremove> command which refuses to wipe "
16374 "physical volumes that contain any volume groups, so you have to remove those "
16380 #: ../src/guestfs-actions.pod:5221
16381 msgid "guestfs_pvresize"
16386 #: ../src/guestfs-actions.pod:5223
16390 " guestfs_pvresize (guestfs_h *g,\n"
16391 " const char *device);\n"
16397 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3512
16399 "This resizes (expands or shrinks) an existing LVM physical volume to match "
16400 "the new size of the underlying device."
16405 #: ../src/guestfs-actions.pod:5234
16406 msgid "guestfs_pvresize_size"
16411 #: ../src/guestfs-actions.pod:5236
16415 " guestfs_pvresize_size (guestfs_h *g,\n"
16416 " const char *device,\n"
16417 " int64_t size);\n"
16423 #: ../src/guestfs-actions.pod:5241
16425 "This command is the same as C<guestfs_pvresize> except that it allows you to "
16426 "specify the new size (in bytes) explicitly."
16431 #: ../src/guestfs-actions.pod:5248
16432 msgid "guestfs_pvs"
16437 #: ../src/guestfs-actions.pod:5250
16441 " guestfs_pvs (guestfs_h *g);\n"
16447 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3526
16449 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16455 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:3529
16457 "This returns a list of just the device names that contain PVs (eg. C</dev/"
16463 #: ../src/guestfs-actions.pod:5259
16464 msgid "See also C<guestfs_pvs_full>."
16469 #: ../src/guestfs-actions.pod:5267
16470 msgid "guestfs_pvs_full"
16475 #: ../src/guestfs-actions.pod:5269
16478 " struct guestfs_lvm_pv_list *\n"
16479 " guestfs_pvs_full (guestfs_h *g);\n"
16485 #: ../src/guestfs-actions.pod:5272 ../fish/guestfish-actions.pod:3538
16487 "List all the physical volumes detected. This is the equivalent of the L<pvs"
16488 "(8)> command. The \"full\" version includes all fields."
16493 #: ../src/guestfs-actions.pod:5275
16495 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
16496 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
16501 #: ../src/guestfs-actions.pod:5281
16502 msgid "guestfs_pvuuid"
16507 #: ../src/guestfs-actions.pod:5283
16511 " guestfs_pvuuid (guestfs_h *g,\n"
16512 " const char *device);\n"
16518 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3545
16519 msgid "This command returns the UUID of the LVM PV C<device>."
16524 #: ../src/guestfs-actions.pod:5294
16525 msgid "guestfs_pwrite"
16530 #: ../src/guestfs-actions.pod:5296
16534 " guestfs_pwrite (guestfs_h *g,\n"
16535 " const char *path,\n"
16536 " const char *content,\n"
16537 " size_t content_size,\n"
16538 " int64_t offset);\n"
16544 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3551
16546 "This command writes to part of a file. It writes the data buffer C<content> "
16547 "to the file C<path> starting at offset C<offset>."
16552 #: ../src/guestfs-actions.pod:5306 ../fish/guestfish-actions.pod:3554
16554 "This command implements the L<pwrite(2)> system call, and like that system "
16555 "call it may not write the full data requested. The return value is the "
16556 "number of bytes that were actually written to the file. This could even be "
16557 "0, although short writes are unlikely for regular files in ordinary "
16563 #: ../src/guestfs-actions.pod:5312
16564 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16569 #: ../src/guestfs-actions.pod:5321
16570 msgid "guestfs_pwrite_device"
16575 #: ../src/guestfs-actions.pod:5323
16579 " guestfs_pwrite_device (guestfs_h *g,\n"
16580 " const char *device,\n"
16581 " const char *content,\n"
16582 " size_t content_size,\n"
16583 " int64_t offset);\n"
16589 #: ../src/guestfs-actions.pod:5330 ../fish/guestfish-actions.pod:3569
16591 "This command writes to part of a device. It writes the data buffer "
16592 "C<content> to C<device> starting at offset C<offset>."
16597 #: ../src/guestfs-actions.pod:5333 ../fish/guestfish-actions.pod:3572
16599 "This command implements the L<pwrite(2)> system call, and like that system "
16600 "call it may not write the full data requested (although short writes to disk "
16601 "devices and partitions are probably impossible with standard Linux kernels)."
16606 #: ../src/guestfs-actions.pod:5338
16607 msgid "See also C<guestfs_pwrite>."
16612 #: ../src/guestfs-actions.pod:5345
16613 msgid "(Added in 1.5.20)"
16618 #: ../src/guestfs-actions.pod:5347
16619 msgid "guestfs_read_file"
16624 #: ../src/guestfs-actions.pod:5349
16628 " guestfs_read_file (guestfs_h *g,\n"
16629 " const char *path,\n"
16630 " size_t *size_r);\n"
16636 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3586
16637 msgid "This calls returns the contents of the file C<path> as a buffer."
16642 #: ../src/guestfs-actions.pod:5357
16644 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16645 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16646 "function is limited in the total size of file that can be handled."
16651 #: ../src/guestfs-actions.pod:5369
16652 msgid "(Added in 1.0.63)"
16657 #: ../src/guestfs-actions.pod:5371
16658 msgid "guestfs_read_lines"
16663 #: ../src/guestfs-actions.pod:5373
16667 " guestfs_read_lines (guestfs_h *g,\n"
16668 " const char *path);\n"
16674 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3603
16676 "The file contents are returned as a list of lines. Trailing C<LF> and "
16677 "C<CRLF> character sequences are I<not> returned."
16682 #: ../src/guestfs-actions.pod:5382
16684 "Note that this function cannot correctly handle binary files (specifically, "
16685 "files containing C<\\0> character which is treated as end of line). For "
16686 "those you need to use the C<guestfs_read_file> function which has a more "
16687 "complex interface."
16692 #: ../src/guestfs-actions.pod:5393
16693 msgid "guestfs_readdir"
16698 #: ../src/guestfs-actions.pod:5395
16701 " struct guestfs_dirent_list *\n"
16702 " guestfs_readdir (guestfs_h *g,\n"
16703 " const char *dir);\n"
16709 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3615
16710 msgid "This returns the list of directory entries in directory C<dir>."
16715 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3617
16717 "All entries in the directory are returned, including C<.> and C<..>. The "
16718 "entries are I<not> sorted, but returned in the same order as the underlying "
16724 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3621
16726 "Also this call returns basic file type information about each file. The "
16727 "C<ftyp> field will contain one of the following characters:"
16732 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3626
16738 #: ../src/guestfs-actions.pod:5412 ../fish/guestfish-actions.pod:3628
16739 msgid "Block special"
16744 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
16750 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3632
16751 msgid "Char special"
16756 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3634
16762 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3636
16768 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
16774 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3640
16775 msgid "FIFO (named pipe)"
16780 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3642
16786 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3644
16787 msgid "Symbolic link"
16792 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3646
16798 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3648
16799 msgid "Regular file"
16804 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3650
16810 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3652
16816 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3654
16822 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3656
16823 msgid "Unknown file type"
16828 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:3658
16834 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3660
16836 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16841 #: ../src/guestfs-actions.pod:5449
16843 "This function is primarily intended for use by programs. To get a simple "
16844 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16845 "consumption, use C<guestfs_ll>."
16850 #: ../src/guestfs-actions.pod:5453
16852 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16853 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16858 #: ../src/guestfs-actions.pod:5459
16859 msgid "guestfs_readlink"
16864 #: ../src/guestfs-actions.pod:5461
16868 " guestfs_readlink (guestfs_h *g,\n"
16869 " const char *path);\n"
16875 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3673
16876 msgid "This command reads the target of a symbolic link."
16881 #: ../src/guestfs-actions.pod:5472
16882 msgid "guestfs_readlinklist"
16887 #: ../src/guestfs-actions.pod:5474
16891 " guestfs_readlinklist (guestfs_h *g,\n"
16892 " const char *path,\n"
16893 " char *const *names);\n"
16899 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3679
16901 "This call allows you to do a C<readlink> operation on multiple files, where "
16902 "all files are in the directory C<path>. C<names> is the list of files from "
16908 #: ../src/guestfs-actions.pod:5483 ../fish/guestfish-actions.pod:3683
16910 "On return you get a list of strings, with a one-to-one correspondence to the "
16911 "C<names> list. Each string is the value of the symbolic link."
16916 #: ../src/guestfs-actions.pod:5487 ../fish/guestfish-actions.pod:3687
16918 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16919 "result string is the empty string C<\"\">. However the whole operation is "
16920 "completed even if there were C<readlink(2)> errors, and so you can call this "
16921 "function with names where you don't know if they are symbolic links already "
16922 "(albeit slightly less efficient)."
16927 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3694
16929 "This call is intended for programs that want to efficiently list a directory "
16930 "contents without making many round-trips. Very long directory listings "
16931 "might cause the protocol message size to be exceeded, causing this call to "
16932 "fail. The caller must split up such requests into smaller groups of names."
16937 #: ../src/guestfs-actions.pod:5507
16938 msgid "guestfs_realpath"
16943 #: ../src/guestfs-actions.pod:5509
16947 " guestfs_realpath (guestfs_h *g,\n"
16948 " const char *path);\n"
16954 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3705
16956 "Return the canonicalized absolute pathname of C<path>. The returned path "
16957 "has no C<.>, C<..> or symbolic link path elements."
16962 #: ../src/guestfs-actions.pod:5521
16963 msgid "guestfs_removexattr"
16968 #: ../src/guestfs-actions.pod:5523
16972 " guestfs_removexattr (guestfs_h *g,\n"
16973 " const char *xattr,\n"
16974 " const char *path);\n"
16980 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3712
16982 "This call removes the extended attribute named C<xattr> of the file C<path>."
16987 #: ../src/guestfs-actions.pod:5531
16988 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16993 #: ../src/guestfs-actions.pod:5537
16994 msgid "guestfs_resize2fs"
16999 #: ../src/guestfs-actions.pod:5539
17003 " guestfs_resize2fs (guestfs_h *g,\n"
17004 " const char *device);\n"
17010 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3721
17012 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
17013 "underlying device."
17018 #: ../src/guestfs-actions.pod:5546
17020 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
17021 "C<device> before calling this command. For unknown reasons C<resize2fs> "
17022 "sometimes gives an error about this and sometimes not. In any case, it is "
17023 "always safe to call C<guestfs_e2fsck_f> before calling this function."
17027 #: ../src/guestfs-actions.pod:5556
17028 msgid "guestfs_resize2fs_M"
17032 #: ../src/guestfs-actions.pod:5558
17036 " guestfs_resize2fs_M (guestfs_h *g,\n"
17037 " const char *device);\n"
17042 #: ../src/guestfs-actions.pod:5562
17044 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
17045 "resized to its minimum size. This works like the C<-M> option to the "
17046 "C<resize2fs> command."
17050 #: ../src/guestfs-actions.pod:5566
17052 "To get the resulting size of the filesystem you should call "
17053 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
17054 "These two numbers, multiplied together, give the resulting size of the "
17055 "minimal filesystem in bytes."
17060 #: ../src/guestfs-actions.pod:5573
17061 msgid "guestfs_resize2fs_size"
17066 #: ../src/guestfs-actions.pod:5575
17070 " guestfs_resize2fs_size (guestfs_h *g,\n"
17071 " const char *device,\n"
17072 " int64_t size);\n"
17078 #: ../src/guestfs-actions.pod:5580
17080 "This command is the same as C<guestfs_resize2fs> except that it allows you "
17081 "to specify the new size (in bytes) explicitly."
17086 #: ../src/guestfs-actions.pod:5587
17092 #: ../src/guestfs-actions.pod:5589
17096 " guestfs_rm (guestfs_h *g,\n"
17097 " const char *path);\n"
17103 #: ../src/guestfs-actions.pod:5593 ../fish/guestfish-actions.pod:3754
17104 msgid "Remove the single file C<path>."
17109 #: ../src/guestfs-actions.pod:5599
17110 msgid "guestfs_rm_rf"
17115 #: ../src/guestfs-actions.pod:5601
17119 " guestfs_rm_rf (guestfs_h *g,\n"
17120 " const char *path);\n"
17126 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:3760
17128 "Remove the file or directory C<path>, recursively removing the contents if "
17129 "its a directory. This is like the C<rm -rf> shell command."
17134 #: ../src/guestfs-actions.pod:5613
17135 msgid "guestfs_rmdir"
17140 #: ../src/guestfs-actions.pod:5615
17144 " guestfs_rmdir (guestfs_h *g,\n"
17145 " const char *path);\n"
17151 #: ../src/guestfs-actions.pod:5619 ../fish/guestfish-actions.pod:3768
17152 msgid "Remove the single directory C<path>."
17157 #: ../src/guestfs-actions.pod:5625
17158 msgid "guestfs_rmmountpoint"
17163 #: ../src/guestfs-actions.pod:5627
17167 " guestfs_rmmountpoint (guestfs_h *g,\n"
17168 " const char *exemptpath);\n"
17174 #: ../src/guestfs-actions.pod:5631
17176 "This calls removes a mountpoint that was previously created with "
17177 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
17182 #: ../src/guestfs-actions.pod:5639
17183 msgid "guestfs_scrub_device"
17188 #: ../src/guestfs-actions.pod:5641
17192 " guestfs_scrub_device (guestfs_h *g,\n"
17193 " const char *device);\n"
17199 #: ../src/guestfs-actions.pod:5645 ../fish/guestfish-actions.pod:3782
17201 "This command writes patterns over C<device> to make data retrieval more "
17207 #: ../src/guestfs-actions.pod:5648 ../src/guestfs-actions.pod:5669
17208 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3785
17209 #: ../fish/guestfish-actions.pod:3800 ../fish/guestfish-actions.pod:3813
17211 "It is an interface to the L<scrub(1)> program. See that manual page for "
17217 #: ../src/guestfs-actions.pod:5656 ../src/guestfs-actions.pod:5674
17218 #: ../src/guestfs-actions.pod:5693
17219 msgid "(Added in 1.0.52)"
17224 #: ../src/guestfs-actions.pod:5658
17225 msgid "guestfs_scrub_file"
17230 #: ../src/guestfs-actions.pod:5660
17234 " guestfs_scrub_file (guestfs_h *g,\n"
17235 " const char *file);\n"
17241 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3795
17243 "This command writes patterns over a file to make data retrieval more "
17249 #: ../src/guestfs-actions.pod:5667 ../fish/guestfish-actions.pod:3798
17250 msgid "The file is I<removed> after scrubbing."
17255 #: ../src/guestfs-actions.pod:5676
17256 msgid "guestfs_scrub_freespace"
17261 #: ../src/guestfs-actions.pod:5678
17265 " guestfs_scrub_freespace (guestfs_h *g,\n"
17266 " const char *dir);\n"
17272 #: ../src/guestfs-actions.pod:5682
17274 "This command creates the directory C<dir> and then fills it with files until "
17275 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
17276 "and deletes them. The intention is to scrub any free space on the partition "
17277 "containing C<dir>."
17282 #: ../src/guestfs-actions.pod:5695
17283 msgid "guestfs_set_append"
17288 #: ../src/guestfs-actions.pod:5697
17292 " guestfs_set_append (guestfs_h *g,\n"
17293 " const char *append);\n"
17299 #: ../src/guestfs-actions.pod:5701 ../fish/guestfish-actions.pod:3822
17301 "This function is used to add additional options to the guest kernel command "
17307 #: ../src/guestfs-actions.pod:5704 ../fish/guestfish-actions.pod:3825
17309 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
17310 "environment variable."
17315 #: ../src/guestfs-actions.pod:5707 ../fish/guestfish-actions.pod:3828
17317 "Setting C<append> to C<NULL> means I<no> additional options are passed "
17318 "(libguestfs always adds a few of its own)."
17322 #: ../src/guestfs-actions.pod:5714
17323 msgid "guestfs_set_attach_method"
17327 #: ../src/guestfs-actions.pod:5716
17331 " guestfs_set_attach_method (guestfs_h *g,\n"
17332 " const char *attachmethod);\n"
17337 #: ../src/guestfs-actions.pod:5720 ../fish/guestfish-actions.pod:3837
17339 "Set the method that libguestfs uses to connect to the back end guestfsd "
17340 "daemon. Possible methods are:"
17344 #: ../src/guestfs-actions.pod:5727 ../fish/guestfish-actions.pod:3844
17346 "Launch an appliance and connect to it. This is the ordinary method and the "
17351 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3847
17352 msgid "C<unix:I<path>>"
17356 #: ../src/guestfs-actions.pod:5732 ../fish/guestfish-actions.pod:3849
17357 msgid "Connect to the Unix domain socket I<path>."
17361 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3851
17363 "This method lets you connect to an existing daemon or (using virtio-serial) "
17364 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
17365 "RUNNING DAEMONS>."
17370 #: ../src/guestfs-actions.pod:5742
17371 msgid "guestfs_set_autosync"
17376 #: ../src/guestfs-actions.pod:5744
17380 " guestfs_set_autosync (guestfs_h *g,\n"
17381 " int autosync);\n"
17386 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3863
17388 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
17389 "effort attempt to make filesystems consistent and synchronized when the "
17390 "handle is closed (also if the program exits without closing handles)."
17395 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3868
17397 "This is enabled by default (since libguestfs 1.5.24, previously it was "
17398 "disabled by default)."
17403 #: ../src/guestfs-actions.pod:5760
17404 msgid "guestfs_set_direct"
17409 #: ../src/guestfs-actions.pod:5762
17413 " guestfs_set_direct (guestfs_h *g,\n"
17420 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3877
17422 "If the direct appliance mode flag is enabled, then stdin and stdout are "
17423 "passed directly through to the appliance once it is launched."
17428 #: ../src/guestfs-actions.pod:5770
17430 "One consequence of this is that log messages aren't caught by the library "
17431 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
17437 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3885
17438 msgid "You probably don't want to use this unless you know what you are doing."
17443 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3888
17444 msgid "The default is disabled."
17449 #: ../src/guestfs-actions.pod:5783
17450 msgid "guestfs_set_e2label"
17455 #: ../src/guestfs-actions.pod:5785
17459 " guestfs_set_e2label (guestfs_h *g,\n"
17460 " const char *device,\n"
17461 " const char *label);\n"
17467 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3894
17469 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
17470 "C<label>. Filesystem labels are limited to 16 characters."
17475 #: ../src/guestfs-actions.pod:5794
17477 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
17478 "the existing label on a filesystem."
17483 #: ../src/guestfs-actions.pod:5801
17484 msgid "guestfs_set_e2uuid"
17489 #: ../src/guestfs-actions.pod:5803
17493 " guestfs_set_e2uuid (guestfs_h *g,\n"
17494 " const char *device,\n"
17495 " const char *uuid);\n"
17501 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3905
17503 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
17504 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17505 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17510 #: ../src/guestfs-actions.pod:5813
17512 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
17513 "the existing UUID of a filesystem."
17518 #: ../src/guestfs-actions.pod:5820
17519 msgid "guestfs_set_memsize"
17524 #: ../src/guestfs-actions.pod:5822
17528 " guestfs_set_memsize (guestfs_h *g,\n"
17535 #: ../src/guestfs-actions.pod:5826
17537 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17538 "This only has any effect if called before C<guestfs_launch>."
17543 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3923
17545 "You can also change this by setting the environment variable "
17546 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17551 #: ../src/guestfs-actions.pod:5841
17552 msgid "guestfs_set_network"
17557 #: ../src/guestfs-actions.pod:5843
17561 " guestfs_set_network (guestfs_h *g,\n"
17568 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3936
17570 "If C<network> is true, then the network is enabled in the libguestfs "
17571 "appliance. The default is false."
17576 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3939
17578 "This affects whether commands are able to access the network (see L<guestfs"
17579 "(3)/RUNNING COMMANDS>)."
17584 #: ../src/guestfs-actions.pod:5853
17586 "You must call this before calling C<guestfs_launch>, otherwise it has no "
17592 #: ../src/guestfs-actions.pod:5860
17593 msgid "guestfs_set_path"
17598 #: ../src/guestfs-actions.pod:5862
17602 " guestfs_set_path (guestfs_h *g,\n"
17603 " const char *searchpath);\n"
17609 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3951
17610 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17615 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3953
17617 "The default is C<$libdir/guestfs> unless overridden by setting "
17618 "C<LIBGUESTFS_PATH> environment variable."
17623 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3956
17624 msgid "Setting C<path> to C<NULL> restores the default path."
17629 #: ../src/guestfs-actions.pod:5877
17630 msgid "guestfs_set_qemu"
17635 #: ../src/guestfs-actions.pod:5879
17639 " guestfs_set_qemu (guestfs_h *g,\n"
17640 " const char *qemu);\n"
17646 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3964
17647 msgid "Set the qemu binary that we will use."
17652 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3966
17654 "The default is chosen when the library was compiled by the configure script."
17659 #: ../src/guestfs-actions.pod:5888 ../fish/guestfish-actions.pod:3969
17661 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17667 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3972
17668 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17673 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3974
17675 "Note that you should call this function as early as possible after creating "
17676 "the handle. This is because some pre-launch operations depend on testing "
17677 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17678 "don't retest features, and so you might see inconsistent results. Using the "
17679 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17680 "the qemu binary at the same time as the handle is created."
17685 #: ../src/guestfs-actions.pod:5905
17686 msgid "guestfs_set_recovery_proc"
17691 #: ../src/guestfs-actions.pod:5907
17695 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17696 " int recoveryproc);\n"
17702 #: ../src/guestfs-actions.pod:5911
17704 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17705 "not create a recovery process. The purpose of the recovery process is to "
17706 "stop runaway qemu processes in the case where the main program aborts "
17712 #: ../src/guestfs-actions.pod:5916
17714 "This only has any effect if called before C<guestfs_launch>, and the default "
17720 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3996
17722 "About the only time when you would want to disable this is if the main "
17723 "process will fork itself into the background (\"daemonize\" itself). In "
17724 "this case the recovery process thinks that the main program has disappeared "
17725 "and so kills qemu, which is not very helpful."
17730 #: ../src/guestfs-actions.pod:5929
17731 msgid "guestfs_set_selinux"
17736 #: ../src/guestfs-actions.pod:5931
17740 " guestfs_set_selinux (guestfs_h *g,\n"
17747 #: ../src/guestfs-actions.pod:5935 ../fish/guestfish-actions.pod:4008
17749 "This sets the selinux flag that is passed to the appliance at boot time. "
17750 "The default is C<selinux=0> (disabled)."
17755 #: ../src/guestfs-actions.pod:5938 ../fish/guestfish-actions.pod:4011
17757 "Note that if SELinux is enabled, it is always in Permissive mode "
17758 "(C<enforcing=0>)."
17763 #: ../src/guestfs-actions.pod:5948
17764 msgid "guestfs_set_trace"
17769 #: ../src/guestfs-actions.pod:5950
17773 " guestfs_set_trace (guestfs_h *g,\n"
17779 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4023
17781 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17782 "return values are traced."
17787 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4026
17789 "If you want to trace C API calls into libguestfs (and other libraries) then "
17790 "possibly a better way is to use the external ltrace(1) command."
17795 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4030
17797 "Command traces are disabled unless the environment variable "
17798 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17802 #: ../src/guestfs-actions.pod:5964
17804 "Trace messages are normally sent to C<stderr>, unless you register a "
17805 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17810 #: ../src/guestfs-actions.pod:5972
17811 msgid "guestfs_set_verbose"
17816 #: ../src/guestfs-actions.pod:5974
17820 " guestfs_set_verbose (guestfs_h *g,\n"
17826 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4043
17827 msgid "If C<verbose> is true, this turns on verbose messages."
17832 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4045
17834 "Verbose messages are disabled unless the environment variable "
17835 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17839 #: ../src/guestfs-actions.pod:5983
17841 "Verbose messages are normally sent to C<stderr>, unless you register a "
17842 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17847 #: ../src/guestfs-actions.pod:5991
17848 msgid "guestfs_setcon"
17853 #: ../src/guestfs-actions.pod:5993
17857 " guestfs_setcon (guestfs_h *g,\n"
17858 " const char *context);\n"
17864 #: ../src/guestfs-actions.pod:5997 ../fish/guestfish-actions.pod:4056
17866 "This sets the SELinux security context of the daemon to the string "
17872 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4059
17873 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17878 #: ../src/guestfs-actions.pod:6006
17879 msgid "guestfs_setxattr"
17884 #: ../src/guestfs-actions.pod:6008
17888 " guestfs_setxattr (guestfs_h *g,\n"
17889 " const char *xattr,\n"
17890 " const char *val,\n"
17892 " const char *path);\n"
17898 #: ../src/guestfs-actions.pod:6015 ../fish/guestfish-actions.pod:4065
17900 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17901 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17906 #: ../src/guestfs-actions.pod:6019
17907 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17912 #: ../src/guestfs-actions.pod:6025
17913 msgid "guestfs_sfdisk"
17918 #: ../src/guestfs-actions.pod:6027
17922 " guestfs_sfdisk (guestfs_h *g,\n"
17923 " const char *device,\n"
17927 " char *const *lines);\n"
17933 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4075
17935 "This is a direct interface to the L<sfdisk(8)> program for creating "
17936 "partitions on block devices."
17941 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4078
17942 msgid "C<device> should be a block device, for example C</dev/sda>."
17947 #: ../src/guestfs-actions.pod:6040 ../fish/guestfish-actions.pod:4080
17949 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17950 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17951 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17952 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17953 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17954 "the kernel) cannot work out the right geometry and you will need to tell it."
17959 #: ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:4088
17961 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17962 "refer to the L<sfdisk(8)> manpage."
17967 #: ../src/guestfs-actions.pod:6051 ../fish/guestfish-actions.pod:4091
17969 "To create a single partition occupying the whole disk, you would pass "
17970 "C<lines> as a single element list, when the single element being the string "
17976 #: ../src/guestfs-actions.pod:6055
17978 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17983 #: ../src/guestfs-actions.pod:6065
17984 msgid "guestfs_sfdiskM"
17989 #: ../src/guestfs-actions.pod:6067
17993 " guestfs_sfdiskM (guestfs_h *g,\n"
17994 " const char *device,\n"
17995 " char *const *lines);\n"
18001 #: ../src/guestfs-actions.pod:6072
18003 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
18004 "partition sizes are specified in megabytes only (rounded to the nearest "
18005 "cylinder) and you don't need to specify the cyls, heads and sectors "
18006 "parameters which were rarely if ever used anyway."
18011 #: ../src/guestfs-actions.pod:6078
18013 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
18014 "C<guestfs_part_disk>"
18019 #: ../src/guestfs-actions.pod:6088
18020 msgid "guestfs_sfdisk_N"
18025 #: ../src/guestfs-actions.pod:6090
18029 " guestfs_sfdisk_N (guestfs_h *g,\n"
18030 " const char *device,\n"
18035 " const char *line);\n"
18041 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4121
18043 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
18044 "(note: C<n> counts from 1)."
18049 #: ../src/guestfs-actions.pod:6102
18051 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
18052 "for the cyls/heads/sectors parameters."
18057 #: ../src/guestfs-actions.pod:6105
18058 msgid "See also: C<guestfs_part_add>"
18063 #: ../src/guestfs-actions.pod:6114
18064 msgid "guestfs_sfdisk_disk_geometry"
18069 #: ../src/guestfs-actions.pod:6116
18073 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
18074 " const char *device);\n"
18080 #: ../src/guestfs-actions.pod:6120
18082 "This displays the disk geometry of C<device> read from the partition table. "
18083 "Especially in the case where the underlying block device has been resized, "
18084 "this can be different from the kernel's idea of the geometry (see "
18085 "C<guestfs_sfdisk_kernel_geometry>)."
18090 #: ../src/guestfs-actions.pod:6125 ../src/guestfs-actions.pod:6141
18091 #: ../fish/guestfish-actions.pod:4141 ../fish/guestfish-actions.pod:4150
18092 msgid "The result is in human-readable format, and not designed to be parsed."
18097 #: ../src/guestfs-actions.pod:6133
18098 msgid "guestfs_sfdisk_kernel_geometry"
18103 #: ../src/guestfs-actions.pod:6135
18107 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
18108 " const char *device);\n"
18114 #: ../src/guestfs-actions.pod:6139 ../fish/guestfish-actions.pod:4148
18115 msgid "This displays the kernel's idea of the geometry of C<device>."
18120 #: ../src/guestfs-actions.pod:6149
18121 msgid "guestfs_sfdisk_l"
18126 #: ../src/guestfs-actions.pod:6151
18130 " guestfs_sfdisk_l (guestfs_h *g,\n"
18131 " const char *device);\n"
18137 #: ../src/guestfs-actions.pod:6155 ../fish/guestfish-actions.pod:4157
18139 "This displays the partition table on C<device>, in the human-readable output "
18140 "of the L<sfdisk(8)> command. It is not intended to be parsed."
18145 #: ../src/guestfs-actions.pod:6159
18146 msgid "See also: C<guestfs_part_list>"
18151 #: ../src/guestfs-actions.pod:6166
18157 #: ../src/guestfs-actions.pod:6168
18161 " guestfs_sh (guestfs_h *g,\n"
18162 " const char *command);\n"
18168 #: ../src/guestfs-actions.pod:6172 ../fish/guestfish-actions.pod:4167
18170 "This call runs a command from the guest filesystem via the guest's C</bin/"
18176 #: ../src/guestfs-actions.pod:6175
18177 msgid "This is like C<guestfs_command>, but passes the command to:"
18182 #: ../src/guestfs-actions.pod:6177 ../fish/guestfish-actions.pod:4172
18185 " /bin/sh -c \"command\"\n"
18191 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4174
18193 "Depending on the guest's shell, this usually results in wildcards being "
18194 "expanded, shell expressions being interpolated and so on."
18199 #: ../src/guestfs-actions.pod:6183
18200 msgid "All the provisos about C<guestfs_command> apply to this call."
18205 #: ../src/guestfs-actions.pod:6190
18206 msgid "guestfs_sh_lines"
18211 #: ../src/guestfs-actions.pod:6192
18215 " guestfs_sh_lines (guestfs_h *g,\n"
18216 " const char *command);\n"
18222 #: ../src/guestfs-actions.pod:6196
18224 "This is the same as C<guestfs_sh>, but splits the result into a list of "
18230 #: ../src/guestfs-actions.pod:6199
18231 msgid "See also: C<guestfs_command_lines>"
18236 #: ../src/guestfs-actions.pod:6207
18237 msgid "guestfs_sleep"
18242 #: ../src/guestfs-actions.pod:6209
18246 " guestfs_sleep (guestfs_h *g,\n"
18253 #: ../src/guestfs-actions.pod:6213 ../fish/guestfish-actions.pod:4193
18254 msgid "Sleep for C<secs> seconds."
18259 #: ../src/guestfs-actions.pod:6217
18260 msgid "(Added in 1.0.41)"
18265 #: ../src/guestfs-actions.pod:6219 ../src/guestfs-structs.pod:109
18266 msgid "guestfs_stat"
18271 #: ../src/guestfs-actions.pod:6221
18274 " struct guestfs_stat *\n"
18275 " guestfs_stat (guestfs_h *g,\n"
18276 " const char *path);\n"
18282 #: ../src/guestfs-actions.pod:6227 ../fish/guestfish-actions.pod:4201
18283 msgid "This is the same as the C<stat(2)> system call."
18288 #: ../src/guestfs-actions.pod:6235 ../src/guestfs-structs.pod:135
18289 msgid "guestfs_statvfs"
18294 #: ../src/guestfs-actions.pod:6237
18297 " struct guestfs_statvfs *\n"
18298 " guestfs_statvfs (guestfs_h *g,\n"
18299 " const char *path);\n"
18305 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4207
18307 "Returns file system statistics for any mounted file system. C<path> should "
18308 "be a file or directory in the mounted file system (typically it is the mount "
18309 "point itself, but it doesn't need to be)."
18314 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4211
18315 msgid "This is the same as the C<statvfs(2)> system call."
18320 #: ../src/guestfs-actions.pod:6247
18322 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
18323 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
18328 #: ../src/guestfs-actions.pod:6253
18329 msgid "guestfs_strings"
18334 #: ../src/guestfs-actions.pod:6255
18338 " guestfs_strings (guestfs_h *g,\n"
18339 " const char *path);\n"
18345 #: ../src/guestfs-actions.pod:6259 ../fish/guestfish-actions.pod:4217
18347 "This runs the L<strings(1)> command on a file and returns the list of "
18348 "printable strings found."
18353 #: ../src/guestfs-actions.pod:6271
18354 msgid "guestfs_strings_e"
18359 #: ../src/guestfs-actions.pod:6273
18363 " guestfs_strings_e (guestfs_h *g,\n"
18364 " const char *encoding,\n"
18365 " const char *path);\n"
18371 #: ../src/guestfs-actions.pod:6278
18373 "This is like the C<guestfs_strings> command, but allows you to specify the "
18374 "encoding of strings that are looked for in the source file C<path>."
18379 #: ../src/guestfs-actions.pod:6282 ../fish/guestfish-actions.pod:4231
18380 msgid "Allowed encodings are:"
18385 #: ../src/guestfs-actions.pod:6286 ../fish/guestfish-actions.pod:4235
18391 #: ../src/guestfs-actions.pod:6288
18393 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18394 "ISO-8859-X (this is what C<guestfs_strings> uses)."
18399 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4240
18405 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4242
18406 msgid "Single 8-bit-byte characters."
18411 #: ../src/guestfs-actions.pod:6295 ../fish/guestfish-actions.pod:4244
18417 #: ../src/guestfs-actions.pod:6297 ../fish/guestfish-actions.pod:4246
18418 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18423 #: ../src/guestfs-actions.pod:6300 ../fish/guestfish-actions.pod:4249
18424 msgid "l (lower case letter L)"
18429 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4251
18431 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18432 "examining binaries in Windows guests."
18437 #: ../src/guestfs-actions.pod:6305 ../fish/guestfish-actions.pod:4254
18443 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4256
18444 msgid "32-bit big endian such as UCS-4BE."
18449 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4258
18455 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4260
18456 msgid "32-bit little endian such as UCS-4LE."
18461 #: ../src/guestfs-actions.pod:6315 ../fish/guestfish-actions.pod:4264
18462 msgid "The returned strings are transcoded to UTF-8."
18467 #: ../src/guestfs-actions.pod:6326
18468 msgid "guestfs_swapoff_device"
18473 #: ../src/guestfs-actions.pod:6328
18477 " guestfs_swapoff_device (guestfs_h *g,\n"
18478 " const char *device);\n"
18484 #: ../src/guestfs-actions.pod:6332
18486 "This command disables the libguestfs appliance swap device or partition "
18487 "named C<device>. See C<guestfs_swapon_device>."
18492 #: ../src/guestfs-actions.pod:6340
18493 msgid "guestfs_swapoff_file"
18498 #: ../src/guestfs-actions.pod:6342
18502 " guestfs_swapoff_file (guestfs_h *g,\n"
18503 " const char *file);\n"
18509 #: ../src/guestfs-actions.pod:6346 ../fish/guestfish-actions.pod:4281
18510 msgid "This command disables the libguestfs appliance swap on file."
18515 #: ../src/guestfs-actions.pod:6352
18516 msgid "guestfs_swapoff_label"
18521 #: ../src/guestfs-actions.pod:6354
18525 " guestfs_swapoff_label (guestfs_h *g,\n"
18526 " const char *label);\n"
18532 #: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4287
18534 "This command disables the libguestfs appliance swap on labeled swap "
18540 #: ../src/guestfs-actions.pod:6365
18541 msgid "guestfs_swapoff_uuid"
18546 #: ../src/guestfs-actions.pod:6367
18550 " guestfs_swapoff_uuid (guestfs_h *g,\n"
18551 " const char *uuid);\n"
18557 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4294
18559 "This command disables the libguestfs appliance swap partition with the given "
18565 #: ../src/guestfs-actions.pod:6378
18566 msgid "guestfs_swapon_device"
18571 #: ../src/guestfs-actions.pod:6380
18575 " guestfs_swapon_device (guestfs_h *g,\n"
18576 " const char *device);\n"
18582 #: ../src/guestfs-actions.pod:6384
18584 "This command enables the libguestfs appliance to use the swap device or "
18585 "partition named C<device>. The increased memory is made available for all "
18586 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
18591 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4306
18593 "Note that you should not swap to existing guest swap partitions unless you "
18594 "know what you are doing. They may contain hibernation information, or other "
18595 "information that the guest doesn't want you to trash. You also risk leaking "
18596 "information about the host to the guest this way. Instead, attach a new "
18597 "host device to the guest and swap on that."
18602 #: ../src/guestfs-actions.pod:6400
18603 msgid "guestfs_swapon_file"
18608 #: ../src/guestfs-actions.pod:6402
18612 " guestfs_swapon_file (guestfs_h *g,\n"
18613 " const char *file);\n"
18619 #: ../src/guestfs-actions.pod:6406
18621 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
18627 #: ../src/guestfs-actions.pod:6413
18628 msgid "guestfs_swapon_label"
18633 #: ../src/guestfs-actions.pod:6415
18637 " guestfs_swapon_label (guestfs_h *g,\n"
18638 " const char *label);\n"
18644 #: ../src/guestfs-actions.pod:6419
18646 "This command enables swap to a labeled swap partition. See "
18647 "C<guestfs_swapon_device> for other notes."
18652 #: ../src/guestfs-actions.pod:6426
18653 msgid "guestfs_swapon_uuid"
18658 #: ../src/guestfs-actions.pod:6428
18662 " guestfs_swapon_uuid (guestfs_h *g,\n"
18663 " const char *uuid);\n"
18669 #: ../src/guestfs-actions.pod:6432
18671 "This command enables swap to a swap partition with the given UUID. See "
18672 "C<guestfs_swapon_device> for other notes."
18677 #: ../src/guestfs-actions.pod:6439
18678 msgid "guestfs_sync"
18683 #: ../src/guestfs-actions.pod:6441
18687 " guestfs_sync (guestfs_h *g);\n"
18693 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4338
18695 "This syncs the disk, so that any writes are flushed through to the "
18696 "underlying disk image."
18701 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4341
18703 "You should always call this if you have modified a disk image, before "
18704 "closing the handle."
18709 #: ../src/guestfs-actions.pod:6454
18710 msgid "guestfs_tail"
18715 #: ../src/guestfs-actions.pod:6456
18719 " guestfs_tail (guestfs_h *g,\n"
18720 " const char *path);\n"
18726 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4348
18728 "This command returns up to the last 10 lines of a file as a list of strings."
18733 #: ../src/guestfs-actions.pod:6472
18734 msgid "guestfs_tail_n"
18739 #: ../src/guestfs-actions.pod:6474
18743 " guestfs_tail_n (guestfs_h *g,\n"
18745 " const char *path);\n"
18751 #: ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:4358
18753 "If the parameter C<nrlines> is a positive number, this returns the last "
18754 "C<nrlines> lines of the file C<path>."
18759 #: ../src/guestfs-actions.pod:6482 ../fish/guestfish-actions.pod:4361
18761 "If the parameter C<nrlines> is a negative number, this returns lines from "
18762 "the file C<path>, starting with the C<-nrlines>th line."
18767 #: ../src/guestfs-actions.pod:6496
18768 msgid "guestfs_tar_in"
18773 #: ../src/guestfs-actions.pod:6498
18777 " guestfs_tar_in (guestfs_h *g,\n"
18778 " const char *tarfile,\n"
18779 " const char *directory);\n"
18785 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4373
18787 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18788 "tar file) into C<directory>."
18793 #: ../src/guestfs-actions.pod:6506
18795 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18800 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6528
18801 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6560
18802 msgid "(Added in 1.0.3)"
18807 #: ../src/guestfs-actions.pod:6513
18808 msgid "guestfs_tar_out"
18813 #: ../src/guestfs-actions.pod:6515
18817 " guestfs_tar_out (guestfs_h *g,\n"
18818 " const char *directory,\n"
18819 " const char *tarfile);\n"
18825 #: ../src/guestfs-actions.pod:6520 ../fish/guestfish-actions.pod:4385
18827 "This command packs the contents of C<directory> and downloads it to local "
18833 #: ../src/guestfs-actions.pod:6523
18835 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18836 "C<guestfs_txz_out>."
18841 #: ../src/guestfs-actions.pod:6530
18842 msgid "guestfs_tgz_in"
18847 #: ../src/guestfs-actions.pod:6532
18851 " guestfs_tgz_in (guestfs_h *g,\n"
18852 " const char *tarball,\n"
18853 " const char *directory);\n"
18859 #: ../src/guestfs-actions.pod:6537 ../fish/guestfish-actions.pod:4397
18861 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18862 "tar file) into C<directory>."
18867 #: ../src/guestfs-actions.pod:6540
18868 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18873 #: ../src/guestfs-actions.pod:6546
18874 msgid "guestfs_tgz_out"
18879 #: ../src/guestfs-actions.pod:6548
18883 " guestfs_tgz_out (guestfs_h *g,\n"
18884 " const char *directory,\n"
18885 " const char *tarball);\n"
18891 #: ../src/guestfs-actions.pod:6553 ../fish/guestfish-actions.pod:4408
18893 "This command packs the contents of C<directory> and downloads it to local "
18899 #: ../src/guestfs-actions.pod:6556
18900 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18905 #: ../src/guestfs-actions.pod:6562
18906 msgid "guestfs_touch"
18911 #: ../src/guestfs-actions.pod:6564
18915 " guestfs_touch (guestfs_h *g,\n"
18916 " const char *path);\n"
18922 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4419
18924 "Touch acts like the L<touch(1)> command. It can be used to update the "
18925 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18931 #: ../src/guestfs-actions.pod:6572 ../fish/guestfish-actions.pod:4423
18933 "This command only works on regular files, and will fail on other file types "
18934 "such as directories, symbolic links, block special etc."
18939 #: ../src/guestfs-actions.pod:6579
18940 msgid "guestfs_truncate"
18945 #: ../src/guestfs-actions.pod:6581
18949 " guestfs_truncate (guestfs_h *g,\n"
18950 " const char *path);\n"
18956 #: ../src/guestfs-actions.pod:6585 ../fish/guestfish-actions.pod:4430
18958 "This command truncates C<path> to a zero-length file. The file must exist "
18964 #: ../src/guestfs-actions.pod:6592
18965 msgid "guestfs_truncate_size"
18970 #: ../src/guestfs-actions.pod:6594
18974 " guestfs_truncate_size (guestfs_h *g,\n"
18975 " const char *path,\n"
18976 " int64_t size);\n"
18982 #: ../src/guestfs-actions.pod:6599 ../fish/guestfish-actions.pod:4437
18984 "This command truncates C<path> to size C<size> bytes. The file must exist "
18990 #: ../src/guestfs-actions.pod:6602
18992 "If the current file size is less than C<size> then the file is extended to "
18993 "the required size with zero bytes. This creates a sparse file (ie. disk "
18994 "blocks are not allocated for the file until you write to it). To create a "
18995 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
19000 #: ../src/guestfs-actions.pod:6612
19001 msgid "guestfs_tune2fs_l"
19006 #: ../src/guestfs-actions.pod:6614
19010 " guestfs_tune2fs_l (guestfs_h *g,\n"
19011 " const char *device);\n"
19017 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4450
19019 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
19025 #: ../src/guestfs-actions.pod:6621 ../fish/guestfish-actions.pod:4453
19027 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
19028 "for more details. The list of fields returned isn't clearly defined, and "
19029 "depends on both the version of C<tune2fs> that libguestfs was built against, "
19030 "and the filesystem itself."
19035 #: ../src/guestfs-actions.pod:6634
19036 msgid "guestfs_txz_in"
19041 #: ../src/guestfs-actions.pod:6636
19045 " guestfs_txz_in (guestfs_h *g,\n"
19046 " const char *tarball,\n"
19047 " const char *directory);\n"
19053 #: ../src/guestfs-actions.pod:6641 ../fish/guestfish-actions.pod:4462
19055 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
19056 "tar file) into C<directory>."
19061 #: ../src/guestfs-actions.pod:6648
19062 msgid "guestfs_txz_out"
19067 #: ../src/guestfs-actions.pod:6650
19071 " guestfs_txz_out (guestfs_h *g,\n"
19072 " const char *directory,\n"
19073 " const char *tarball);\n"
19079 #: ../src/guestfs-actions.pod:6655 ../fish/guestfish-actions.pod:4471
19081 "This command packs the contents of C<directory> and downloads it to local "
19082 "file C<tarball> (as an xz compressed tar archive)."
19087 #: ../src/guestfs-actions.pod:6662
19088 msgid "guestfs_umask"
19093 #: ../src/guestfs-actions.pod:6664
19097 " guestfs_umask (guestfs_h *g,\n"
19104 #: ../src/guestfs-actions.pod:6668 ../fish/guestfish-actions.pod:4480
19106 "This function sets the mask used for creating new files and device nodes to "
19112 #: ../src/guestfs-actions.pod:6671 ../fish/guestfish-actions.pod:4483
19114 "Typical umask values would be C<022> which creates new files with "
19115 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
19116 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
19121 #: ../src/guestfs-actions.pod:6676 ../fish/guestfish-actions.pod:4488
19123 "The default umask is C<022>. This is important because it means that "
19124 "directories and device nodes will be created with C<0644> or C<0755> mode "
19125 "even if you specify C<0777>."
19130 #: ../src/guestfs-actions.pod:6680
19132 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
19133 "C<guestfs_mkdir>."
19138 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4495
19139 msgid "This call returns the previous umask."
19144 #: ../src/guestfs-actions.pod:6689
19145 msgid "guestfs_umount"
19150 #: ../src/guestfs-actions.pod:6691
19154 " guestfs_umount (guestfs_h *g,\n"
19155 " const char *pathordevice);\n"
19161 #: ../src/guestfs-actions.pod:6695 ../fish/guestfish-actions.pod:4503
19163 "This unmounts the given filesystem. The filesystem may be specified either "
19164 "by its mountpoint (path) or the device which contains the filesystem."
19169 #: ../src/guestfs-actions.pod:6703
19170 msgid "guestfs_umount_all"
19175 #: ../src/guestfs-actions.pod:6705
19179 " guestfs_umount_all (guestfs_h *g);\n"
19185 #: ../src/guestfs-actions.pod:6708 ../fish/guestfish-actions.pod:4513
19186 msgid "This unmounts all mounted filesystems."
19191 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4515
19192 msgid "Some internal mounts are not unmounted by this call."
19197 #: ../src/guestfs-actions.pod:6716
19198 msgid "guestfs_upload"
19203 #: ../src/guestfs-actions.pod:6718
19207 " guestfs_upload (guestfs_h *g,\n"
19208 " const char *filename,\n"
19209 " const char *remotefilename);\n"
19215 #: ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:6747
19216 #: ../fish/guestfish-actions.pod:4521 ../fish/guestfish-actions.pod:4534
19217 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
19222 #: ../src/guestfs-actions.pod:6728
19223 msgid "See also C<guestfs_download>."
19228 #: ../src/guestfs-actions.pod:6739
19229 msgid "guestfs_upload_offset"
19234 #: ../src/guestfs-actions.pod:6741
19238 " guestfs_upload_offset (guestfs_h *g,\n"
19239 " const char *filename,\n"
19240 " const char *remotefilename,\n"
19241 " int64_t offset);\n"
19247 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4537
19249 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
19250 "The intention is to overwrite parts of existing files or devices, although "
19251 "if a non-existant file is specified then it is created with a \"hole\" "
19252 "before C<offset>. The size of the data written is implicit in the size of "
19253 "the source C<filename>."
19258 #: ../src/guestfs-actions.pod:6757
19260 "Note that there is no limit on the amount of data that can be uploaded with "
19261 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
19262 "full amount unless an error occurs."
19267 #: ../src/guestfs-actions.pod:6762
19268 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
19273 #: ../src/guestfs-actions.pod:6773
19274 msgid "guestfs_utimens"
19279 #: ../src/guestfs-actions.pod:6775
19283 " guestfs_utimens (guestfs_h *g,\n"
19284 " const char *path,\n"
19285 " int64_t atsecs,\n"
19286 " int64_t atnsecs,\n"
19287 " int64_t mtsecs,\n"
19288 " int64_t mtnsecs);\n"
19294 #: ../src/guestfs-actions.pod:6783 ../fish/guestfish-actions.pod:4557
19295 msgid "This command sets the timestamps of a file with nanosecond precision."
19300 #: ../src/guestfs-actions.pod:6786 ../fish/guestfish-actions.pod:4560
19302 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
19308 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4563
19310 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
19311 "nanoseconds from the epoch."
19316 #: ../src/guestfs-actions.pod:6792 ../fish/guestfish-actions.pod:4566
19318 "If the C<*nsecs> field contains the special value C<-1> then the "
19319 "corresponding timestamp is set to the current time. (The C<*secs> field is "
19320 "ignored in this case)."
19325 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4570
19327 "If the C<*nsecs> field contains the special value C<-2> then the "
19328 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
19334 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-structs.pod:175
19335 msgid "guestfs_version"
19340 #: ../src/guestfs-actions.pod:6806
19343 " struct guestfs_version *\n"
19344 " guestfs_version (guestfs_h *g);\n"
19350 #: ../src/guestfs-actions.pod:6809 ../fish/guestfish-actions.pod:4578
19352 "Return the libguestfs version number that the program is linked against."
19357 #: ../src/guestfs-actions.pod:6812 ../fish/guestfish-actions.pod:4581
19359 "Note that because of dynamic linking this is not necessarily the version of "
19360 "libguestfs that you compiled against. You can compile the program, and then "
19361 "at runtime dynamically link against a completely different C<libguestfs.so> "
19367 #: ../src/guestfs-actions.pod:6817 ../fish/guestfish-actions.pod:4586
19369 "This call was added in version C<1.0.58>. In previous versions of "
19370 "libguestfs there was no way to get the version number. From C code you can "
19371 "use dynamic linker functions to find out if this symbol exists (if it "
19372 "doesn't, then it's an earlier version)."
19377 #: ../src/guestfs-actions.pod:6823 ../fish/guestfish-actions.pod:4592
19379 "The call returns a structure with four elements. The first three (C<major>, "
19380 "C<minor> and C<release>) are numbers and correspond to the usual version "
19381 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19382 "but may be used for distro-specific information."
19387 #: ../src/guestfs-actions.pod:6829 ../fish/guestfish-actions.pod:4598
19389 "To construct the original version string: C<$major.$minor.$release$extra>"
19394 #: ../src/guestfs-actions.pod:6832 ../fish/guestfish-actions.pod:4601
19395 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19400 #: ../src/guestfs-actions.pod:6834
19402 "I<Note:> Don't use this call to test for availability of features. In "
19403 "enterprise distributions we backport features from later versions into "
19404 "earlier versions, making this an unreliable way to test for features. Use "
19405 "C<guestfs_available> instead."
19410 #: ../src/guestfs-actions.pod:6840
19412 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
19413 "error. I<The caller must call C<guestfs_free_version> after use>."
19418 #: ../src/guestfs-actions.pod:6844
19419 msgid "(Added in 1.0.58)"
19424 #: ../src/guestfs-actions.pod:6846
19425 msgid "guestfs_vfs_label"
19430 #: ../src/guestfs-actions.pod:6848
19434 " guestfs_vfs_label (guestfs_h *g,\n"
19435 " const char *device);\n"
19441 #: ../src/guestfs-actions.pod:6852 ../fish/guestfish-actions.pod:4613
19442 msgid "This returns the filesystem label of the filesystem on C<device>."
19447 #: ../src/guestfs-actions.pod:6855 ../fish/guestfish-actions.pod:4616
19448 msgid "If the filesystem is unlabeled, this returns the empty string."
19453 #: ../src/guestfs-actions.pod:6857
19454 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
19459 #: ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6899
19460 msgid "(Added in 1.3.18)"
19465 #: ../src/guestfs-actions.pod:6864
19466 msgid "guestfs_vfs_type"
19471 #: ../src/guestfs-actions.pod:6866
19475 " guestfs_vfs_type (guestfs_h *g,\n"
19476 " const char *device);\n"
19482 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4624
19484 "This command gets the filesystem type corresponding to the filesystem on "
19490 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4627
19492 "For most filesystems, the result is the name of the Linux VFS module which "
19493 "would be used to mount this filesystem if you mounted it without specifying "
19494 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19499 #: ../src/guestfs-actions.pod:6883
19500 msgid "guestfs_vfs_uuid"
19505 #: ../src/guestfs-actions.pod:6885
19509 " guestfs_vfs_uuid (guestfs_h *g,\n"
19510 " const char *device);\n"
19516 #: ../src/guestfs-actions.pod:6889 ../fish/guestfish-actions.pod:4636
19517 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19522 #: ../src/guestfs-actions.pod:6892 ../fish/guestfish-actions.pod:4639
19523 msgid "If the filesystem does not have a UUID, this returns the empty string."
19528 #: ../src/guestfs-actions.pod:6894
19529 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
19534 #: ../src/guestfs-actions.pod:6901
19535 msgid "guestfs_vg_activate"
19540 #: ../src/guestfs-actions.pod:6903
19544 " guestfs_vg_activate (guestfs_h *g,\n"
19546 " char *const *volgroups);\n"
19552 #: ../src/guestfs-actions.pod:6908 ../fish/guestfish-actions.pod:4647
19554 "This command activates or (if C<activate> is false) deactivates all logical "
19555 "volumes in the listed volume groups C<volgroups>. If activated, then they "
19556 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
19557 "deactivated, then those devices disappear."
19562 #: ../src/guestfs-actions.pod:6914 ../fish/guestfish-actions.pod:4653
19563 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19568 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4655
19570 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19571 "activated or deactivated."
19576 #: ../src/guestfs-actions.pod:6923
19577 msgid "guestfs_vg_activate_all"
19582 #: ../src/guestfs-actions.pod:6925
19586 " guestfs_vg_activate_all (guestfs_h *g,\n"
19587 " int activate);\n"
19593 #: ../src/guestfs-actions.pod:6929 ../fish/guestfish-actions.pod:4662
19595 "This command activates or (if C<activate> is false) deactivates all logical "
19596 "volumes in all volume groups. If activated, then they are made known to the "
19597 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
19598 "those devices disappear."
19603 #: ../src/guestfs-actions.pod:6935 ../fish/guestfish-actions.pod:4668
19604 msgid "This command is the same as running C<vgchange -a y|n>"
19609 #: ../src/guestfs-actions.pod:6941
19610 msgid "guestfs_vgcreate"
19615 #: ../src/guestfs-actions.pod:6943
19619 " guestfs_vgcreate (guestfs_h *g,\n"
19620 " const char *volgroup,\n"
19621 " char *const *physvols);\n"
19627 #: ../src/guestfs-actions.pod:6948 ../fish/guestfish-actions.pod:4674
19629 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19630 "of physical volumes C<physvols>."
19635 #: ../src/guestfs-actions.pod:6955
19636 msgid "guestfs_vglvuuids"
19641 #: ../src/guestfs-actions.pod:6957
19645 " guestfs_vglvuuids (guestfs_h *g,\n"
19646 " const char *vgname);\n"
19652 #: ../src/guestfs-actions.pod:6961 ../fish/guestfish-actions.pod:4681
19654 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19655 "volumes created in this volume group."
19660 #: ../src/guestfs-actions.pod:6964
19662 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
19663 "associate logical volumes and volume groups."
19668 #: ../src/guestfs-actions.pod:6967
19669 msgid "See also C<guestfs_vgpvuuids>."
19674 #: ../src/guestfs-actions.pod:6975
19675 msgid "guestfs_vgpvuuids"
19680 #: ../src/guestfs-actions.pod:6977
19684 " guestfs_vgpvuuids (guestfs_h *g,\n"
19685 " const char *vgname);\n"
19691 #: ../src/guestfs-actions.pod:6981 ../fish/guestfish-actions.pod:4693
19693 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19694 "volumes that this volume group resides on."
19699 #: ../src/guestfs-actions.pod:6984
19701 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
19702 "associate physical volumes and volume groups."
19707 #: ../src/guestfs-actions.pod:6987
19708 msgid "See also C<guestfs_vglvuuids>."
19713 #: ../src/guestfs-actions.pod:6995
19714 msgid "guestfs_vgremove"
19719 #: ../src/guestfs-actions.pod:6997
19723 " guestfs_vgremove (guestfs_h *g,\n"
19724 " const char *vgname);\n"
19730 #: ../src/guestfs-actions.pod:7001 ../fish/guestfish-actions.pod:4705
19731 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19736 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4707
19738 "This also forcibly removes all logical volumes in the volume group (if any)."
19743 #: ../src/guestfs-actions.pod:7010
19744 msgid "guestfs_vgrename"
19749 #: ../src/guestfs-actions.pod:7012
19753 " guestfs_vgrename (guestfs_h *g,\n"
19754 " const char *volgroup,\n"
19755 " const char *newvolgroup);\n"
19761 #: ../src/guestfs-actions.pod:7017 ../fish/guestfish-actions.pod:4714
19762 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19767 #: ../src/guestfs-actions.pod:7023
19768 msgid "guestfs_vgs"
19773 #: ../src/guestfs-actions.pod:7025
19777 " guestfs_vgs (guestfs_h *g);\n"
19783 #: ../src/guestfs-actions.pod:7028 ../fish/guestfish-actions.pod:4720
19785 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19791 #: ../src/guestfs-actions.pod:7031 ../fish/guestfish-actions.pod:4723
19793 "This returns a list of just the volume group names that were detected (eg. "
19799 #: ../src/guestfs-actions.pod:7034
19800 msgid "See also C<guestfs_vgs_full>."
19805 #: ../src/guestfs-actions.pod:7042
19806 msgid "guestfs_vgs_full"
19811 #: ../src/guestfs-actions.pod:7044
19814 " struct guestfs_lvm_vg_list *\n"
19815 " guestfs_vgs_full (guestfs_h *g);\n"
19821 #: ../src/guestfs-actions.pod:7047 ../fish/guestfish-actions.pod:4732
19823 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19824 "> command. The \"full\" version includes all fields."
19829 #: ../src/guestfs-actions.pod:7050
19831 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
19832 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
19837 #: ../src/guestfs-actions.pod:7056
19838 msgid "guestfs_vgscan"
19843 #: ../src/guestfs-actions.pod:7058
19847 " guestfs_vgscan (guestfs_h *g);\n"
19853 #: ../src/guestfs-actions.pod:7061 ../fish/guestfish-actions.pod:4739
19855 "This rescans all block devices and rebuilds the list of LVM physical "
19856 "volumes, volume groups and logical volumes."
19861 #: ../src/guestfs-actions.pod:7068
19862 msgid "guestfs_vguuid"
19867 #: ../src/guestfs-actions.pod:7070
19871 " guestfs_vguuid (guestfs_h *g,\n"
19872 " const char *vgname);\n"
19878 #: ../src/guestfs-actions.pod:7074 ../fish/guestfish-actions.pod:4746
19879 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19884 #: ../src/guestfs-actions.pod:7081
19885 msgid "guestfs_wait_ready"
19890 #: ../src/guestfs-actions.pod:7083
19894 " guestfs_wait_ready (guestfs_h *g);\n"
19900 #: ../src/guestfs-actions.pod:7086
19901 msgid "This function is a no op."
19906 #: ../src/guestfs-actions.pod:7088
19908 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19909 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19910 "is no longer necessary because C<guestfs_launch> now does the waiting."
19915 #: ../src/guestfs-actions.pod:7093
19917 "If you see any calls to this function in code then you can just remove them, "
19918 "unless you want to retain compatibility with older versions of the API."
19923 #: ../src/guestfs-actions.pod:7101
19924 msgid "guestfs_wc_c"
19929 #: ../src/guestfs-actions.pod:7103
19933 " guestfs_wc_c (guestfs_h *g,\n"
19934 " const char *path);\n"
19940 #: ../src/guestfs-actions.pod:7107 ../fish/guestfish-actions.pod:4752
19942 "This command counts the characters in a file, using the C<wc -c> external "
19948 #: ../src/guestfs-actions.pod:7114
19949 msgid "guestfs_wc_l"
19954 #: ../src/guestfs-actions.pod:7116
19958 " guestfs_wc_l (guestfs_h *g,\n"
19959 " const char *path);\n"
19965 #: ../src/guestfs-actions.pod:7120 ../fish/guestfish-actions.pod:4759
19967 "This command counts the lines in a file, using the C<wc -l> external command."
19972 #: ../src/guestfs-actions.pod:7127
19973 msgid "guestfs_wc_w"
19978 #: ../src/guestfs-actions.pod:7129
19982 " guestfs_wc_w (guestfs_h *g,\n"
19983 " const char *path);\n"
19989 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4766
19991 "This command counts the words in a file, using the C<wc -w> external command."
19996 #: ../src/guestfs-actions.pod:7140
19997 msgid "guestfs_write"
20002 #: ../src/guestfs-actions.pod:7142
20006 " guestfs_write (guestfs_h *g,\n"
20007 " const char *path,\n"
20008 " const char *content,\n"
20009 " size_t content_size);\n"
20015 #: ../src/guestfs-actions.pod:7148 ../fish/guestfish-actions.pod:4773
20017 "This call creates a file called C<path>. The content of the file is the "
20018 "string C<content> (which can contain any 8 bit data)."
20023 #: ../src/guestfs-actions.pod:7158
20024 msgid "guestfs_write_file"
20029 #: ../src/guestfs-actions.pod:7160
20033 " guestfs_write_file (guestfs_h *g,\n"
20034 " const char *path,\n"
20035 " const char *content,\n"
20042 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4783
20044 "This call creates a file called C<path>. The contents of the file is the "
20045 "string C<content> (which can contain any 8 bit data), with length C<size>."
20050 #: ../src/guestfs-actions.pod:7170 ../fish/guestfish-actions.pod:4787
20052 "As a special case, if C<size> is C<0> then the length is calculated using "
20053 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
20058 #: ../src/guestfs-actions.pod:7174 ../fish/guestfish-actions.pod:4791
20060 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
20061 "I<not> work, even if the length is specified."
20066 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4797
20068 "This function is deprecated. In new code, use the C<write> call instead."
20073 #: ../src/guestfs-actions.pod:7191
20074 msgid "guestfs_zegrep"
20079 #: ../src/guestfs-actions.pod:7193
20083 " guestfs_zegrep (guestfs_h *g,\n"
20084 " const char *regex,\n"
20085 " const char *path);\n"
20091 #: ../src/guestfs-actions.pod:7198 ../fish/guestfish-actions.pod:4808
20093 "This calls the external C<zegrep> program and returns the matching lines."
20098 #: ../src/guestfs-actions.pod:7210
20099 msgid "guestfs_zegrepi"
20104 #: ../src/guestfs-actions.pod:7212
20108 " guestfs_zegrepi (guestfs_h *g,\n"
20109 " const char *regex,\n"
20110 " const char *path);\n"
20116 #: ../src/guestfs-actions.pod:7217 ../fish/guestfish-actions.pod:4818
20118 "This calls the external C<zegrep -i> program and returns the matching lines."
20123 #: ../src/guestfs-actions.pod:7229
20124 msgid "guestfs_zero"
20129 #: ../src/guestfs-actions.pod:7231
20133 " guestfs_zero (guestfs_h *g,\n"
20134 " const char *device);\n"
20140 #: ../src/guestfs-actions.pod:7235 ../fish/guestfish-actions.pod:4828
20141 msgid "This command writes zeroes over the first few blocks of C<device>."
20146 #: ../src/guestfs-actions.pod:7237 ../fish/guestfish-actions.pod:4830
20148 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
20149 "securely wipe the device). It should be sufficient to remove any partition "
20150 "tables, filesystem superblocks and so on."
20155 #: ../src/guestfs-actions.pod:7241
20156 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
20161 #: ../src/guestfs-actions.pod:7252
20162 msgid "guestfs_zero_device"
20167 #: ../src/guestfs-actions.pod:7254
20171 " guestfs_zero_device (guestfs_h *g,\n"
20172 " const char *device);\n"
20178 #: ../src/guestfs-actions.pod:7258
20180 "This command writes zeroes over the entire C<device>. Compare with "
20181 "C<guestfs_zero> which just zeroes the first few blocks of a device."
20186 #: ../src/guestfs-actions.pod:7272
20187 msgid "(Added in 1.3.1)"
20192 #: ../src/guestfs-actions.pod:7274
20193 msgid "guestfs_zerofree"
20198 #: ../src/guestfs-actions.pod:7276
20202 " guestfs_zerofree (guestfs_h *g,\n"
20203 " const char *device);\n"
20209 #: ../src/guestfs-actions.pod:7280 ../fish/guestfish-actions.pod:4851
20211 "This runs the I<zerofree> program on C<device>. This program claims to zero "
20212 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
20213 "possible to compress the filesystem more effectively."
20218 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4856
20219 msgid "You should B<not> run this program if the filesystem is mounted."
20224 #: ../src/guestfs-actions.pod:7288 ../fish/guestfish-actions.pod:4859
20226 "It is possible that using this program can damage the filesystem or data on "
20232 #: ../src/guestfs-actions.pod:7295
20233 msgid "guestfs_zfgrep"
20238 #: ../src/guestfs-actions.pod:7297
20242 " guestfs_zfgrep (guestfs_h *g,\n"
20243 " const char *pattern,\n"
20244 " const char *path);\n"
20250 #: ../src/guestfs-actions.pod:7302 ../fish/guestfish-actions.pod:4866
20252 "This calls the external C<zfgrep> program and returns the matching lines."
20257 #: ../src/guestfs-actions.pod:7314
20258 msgid "guestfs_zfgrepi"
20263 #: ../src/guestfs-actions.pod:7316
20267 " guestfs_zfgrepi (guestfs_h *g,\n"
20268 " const char *pattern,\n"
20269 " const char *path);\n"
20275 #: ../src/guestfs-actions.pod:7321 ../fish/guestfish-actions.pod:4876
20277 "This calls the external C<zfgrep -i> program and returns the matching lines."
20282 #: ../src/guestfs-actions.pod:7333
20283 msgid "guestfs_zfile"
20288 #: ../src/guestfs-actions.pod:7335
20292 " guestfs_zfile (guestfs_h *g,\n"
20293 " const char *meth,\n"
20294 " const char *path);\n"
20300 #: ../src/guestfs-actions.pod:7340 ../fish/guestfish-actions.pod:4886
20302 "This command runs C<file> after first decompressing C<path> using C<method>."
20307 #: ../src/guestfs-actions.pod:7343 ../fish/guestfish-actions.pod:4889
20308 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
20313 #: ../src/guestfs-actions.pod:7345
20315 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
20321 #: ../src/guestfs-actions.pod:7351 ../fish/guestfish-actions.pod:4894
20323 "This function is deprecated. In new code, use the C<file> call instead."
20328 #: ../src/guestfs-actions.pod:7360
20329 msgid "guestfs_zgrep"
20334 #: ../src/guestfs-actions.pod:7362
20338 " guestfs_zgrep (guestfs_h *g,\n"
20339 " const char *regex,\n"
20340 " const char *path);\n"
20346 #: ../src/guestfs-actions.pod:7367 ../fish/guestfish-actions.pod:4905
20348 "This calls the external C<zgrep> program and returns the matching lines."
20353 #: ../src/guestfs-actions.pod:7379
20354 msgid "guestfs_zgrepi"
20359 #: ../src/guestfs-actions.pod:7381
20363 " guestfs_zgrepi (guestfs_h *g,\n"
20364 " const char *regex,\n"
20365 " const char *path);\n"
20371 #: ../src/guestfs-actions.pod:7386 ../fish/guestfish-actions.pod:4915
20373 "This calls the external C<zgrep -i> program and returns the matching lines."
20378 #: ../src/guestfs-availability.pod:3
20384 #: ../src/guestfs-availability.pod:5
20386 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
20387 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
20388 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
20389 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
20390 "L</guestfs_aug_save> L</guestfs_aug_set>"
20395 #: ../src/guestfs-availability.pod:21
20401 #: ../src/guestfs-availability.pod:23
20403 "The following functions: L</guestfs_inotify_add_watch> L</"
20404 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
20405 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
20410 #: ../src/guestfs-availability.pod:31
20411 msgid "B<linuxfsuuid>"
20416 #: ../src/guestfs-availability.pod:33
20418 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
20419 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
20424 #: ../src/guestfs-availability.pod:40
20425 msgid "B<linuxmodules>"
20430 #: ../src/guestfs-availability.pod:42
20431 msgid "The following functions: L</guestfs_modprobe>"
20436 #: ../src/guestfs-availability.pod:45
20437 msgid "B<linuxxattrs>"
20442 #: ../src/guestfs-availability.pod:47
20444 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
20445 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
20446 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
20447 "guestfs_setxattr>"
20452 #: ../src/guestfs-availability.pod:58
20458 #: ../src/guestfs-availability.pod:60
20460 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
20461 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
20462 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
20467 #: ../src/guestfs-availability.pod:69
20473 #: ../src/guestfs-availability.pod:71
20475 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
20476 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
20477 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
20478 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
20479 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
20480 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
20481 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
20486 #: ../src/guestfs-availability.pod:94
20492 #: ../src/guestfs-availability.pod:96
20494 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
20495 "guestfs_mknod_b> L</guestfs_mknod_c>"
20500 #: ../src/guestfs-availability.pod:102
20506 #: ../src/guestfs-availability.pod:104
20507 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
20512 #: ../src/guestfs-availability.pod:107
20513 msgid "B<ntfsprogs>"
20518 #: ../src/guestfs-availability.pod:109
20520 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
20525 #: ../src/guestfs-availability.pod:113
20526 msgid "B<realpath>"
20531 #: ../src/guestfs-availability.pod:115
20532 msgid "The following functions: L</guestfs_realpath>"
20537 #: ../src/guestfs-availability.pod:118
20543 #: ../src/guestfs-availability.pod:120
20545 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
20546 "guestfs_scrub_freespace>"
20551 #: ../src/guestfs-availability.pod:125
20557 #: ../src/guestfs-availability.pod:127
20558 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
20563 #: ../src/guestfs-availability.pod:131
20569 #: ../src/guestfs-availability.pod:133
20570 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
20575 #: ../src/guestfs-availability.pod:137
20576 msgid "B<zerofree>"
20581 #: ../src/guestfs-availability.pod:139
20582 msgid "The following functions: L</guestfs_zerofree>"
20587 #: ../src/guestfs-structs.pod:1
20588 msgid "guestfs_int_bool"
20593 #: ../src/guestfs-structs.pod:3
20596 " struct guestfs_int_bool {\n"
20605 #: ../src/guestfs-structs.pod:8
20608 " struct guestfs_int_bool_list {\n"
20609 " uint32_t len; /* Number of elements in list. */\n"
20610 " struct guestfs_int_bool *val; /* Elements. */\n"
20617 #: ../src/guestfs-structs.pod:13
20620 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
20621 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
20627 #: ../src/guestfs-structs.pod:16
20628 msgid "guestfs_lvm_pv"
20633 #: ../src/guestfs-structs.pod:18
20636 " struct guestfs_lvm_pv {\n"
20637 " char *pv_name;\n"
20638 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20639 " char pv_uuid[32];\n"
20641 " uint64_t pv_size;\n"
20642 " uint64_t dev_size;\n"
20643 " uint64_t pv_free;\n"
20644 " uint64_t pv_used;\n"
20645 " char *pv_attr;\n"
20646 " int64_t pv_pe_count;\n"
20647 " int64_t pv_pe_alloc_count;\n"
20648 " char *pv_tags;\n"
20649 " uint64_t pe_start;\n"
20650 " int64_t pv_mda_count;\n"
20651 " uint64_t pv_mda_free;\n"
20658 #: ../src/guestfs-structs.pod:36
20661 " struct guestfs_lvm_pv_list {\n"
20662 " uint32_t len; /* Number of elements in list. */\n"
20663 " struct guestfs_lvm_pv *val; /* Elements. */\n"
20670 #: ../src/guestfs-structs.pod:41
20673 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
20674 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
20680 #: ../src/guestfs-structs.pod:44
20681 msgid "guestfs_lvm_vg"
20686 #: ../src/guestfs-structs.pod:46
20689 " struct guestfs_lvm_vg {\n"
20690 " char *vg_name;\n"
20691 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20692 " char vg_uuid[32];\n"
20694 " char *vg_attr;\n"
20695 " uint64_t vg_size;\n"
20696 " uint64_t vg_free;\n"
20697 " char *vg_sysid;\n"
20698 " uint64_t vg_extent_size;\n"
20699 " int64_t vg_extent_count;\n"
20700 " int64_t vg_free_count;\n"
20701 " int64_t max_lv;\n"
20702 " int64_t max_pv;\n"
20703 " int64_t pv_count;\n"
20704 " int64_t lv_count;\n"
20705 " int64_t snap_count;\n"
20706 " int64_t vg_seqno;\n"
20707 " char *vg_tags;\n"
20708 " int64_t vg_mda_count;\n"
20709 " uint64_t vg_mda_free;\n"
20716 #: ../src/guestfs-structs.pod:69
20719 " struct guestfs_lvm_vg_list {\n"
20720 " uint32_t len; /* Number of elements in list. */\n"
20721 " struct guestfs_lvm_vg *val; /* Elements. */\n"
20728 #: ../src/guestfs-structs.pod:74
20731 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
20732 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
20738 #: ../src/guestfs-structs.pod:77
20739 msgid "guestfs_lvm_lv"
20744 #: ../src/guestfs-structs.pod:79
20747 " struct guestfs_lvm_lv {\n"
20748 " char *lv_name;\n"
20749 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
20750 " char lv_uuid[32];\n"
20751 " char *lv_attr;\n"
20752 " int64_t lv_major;\n"
20753 " int64_t lv_minor;\n"
20754 " int64_t lv_kernel_major;\n"
20755 " int64_t lv_kernel_minor;\n"
20756 " uint64_t lv_size;\n"
20757 " int64_t seg_count;\n"
20759 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20760 " float snap_percent;\n"
20761 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
20762 " float copy_percent;\n"
20763 " char *move_pv;\n"
20764 " char *lv_tags;\n"
20765 " char *mirror_log;\n"
20766 " char *modules;\n"
20773 #: ../src/guestfs-structs.pod:101
20776 " struct guestfs_lvm_lv_list {\n"
20777 " uint32_t len; /* Number of elements in list. */\n"
20778 " struct guestfs_lvm_lv *val; /* Elements. */\n"
20785 #: ../src/guestfs-structs.pod:106
20788 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
20789 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
20795 #: ../src/guestfs-structs.pod:111
20798 " struct guestfs_stat {\n"
20802 " int64_t nlink;\n"
20807 " int64_t blksize;\n"
20808 " int64_t blocks;\n"
20809 " int64_t atime;\n"
20810 " int64_t mtime;\n"
20811 " int64_t ctime;\n"
20818 #: ../src/guestfs-structs.pod:127
20821 " struct guestfs_stat_list {\n"
20822 " uint32_t len; /* Number of elements in list. */\n"
20823 " struct guestfs_stat *val; /* Elements. */\n"
20830 #: ../src/guestfs-structs.pod:132
20833 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
20834 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
20840 #: ../src/guestfs-structs.pod:137
20843 " struct guestfs_statvfs {\n"
20844 " int64_t bsize;\n"
20845 " int64_t frsize;\n"
20846 " int64_t blocks;\n"
20847 " int64_t bfree;\n"
20848 " int64_t bavail;\n"
20849 " int64_t files;\n"
20850 " int64_t ffree;\n"
20851 " int64_t favail;\n"
20854 " int64_t namemax;\n"
20861 #: ../src/guestfs-structs.pod:151
20864 " struct guestfs_statvfs_list {\n"
20865 " uint32_t len; /* Number of elements in list. */\n"
20866 " struct guestfs_statvfs *val; /* Elements. */\n"
20873 #: ../src/guestfs-structs.pod:156
20876 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
20877 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20883 #: ../src/guestfs-structs.pod:159
20884 msgid "guestfs_dirent"
20889 #: ../src/guestfs-structs.pod:161
20892 " struct guestfs_dirent {\n"
20902 #: ../src/guestfs-structs.pod:167
20905 " struct guestfs_dirent_list {\n"
20906 " uint32_t len; /* Number of elements in list. */\n"
20907 " struct guestfs_dirent *val; /* Elements. */\n"
20914 #: ../src/guestfs-structs.pod:172
20917 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20918 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20924 #: ../src/guestfs-structs.pod:177
20927 " struct guestfs_version {\n"
20928 " int64_t major;\n"
20929 " int64_t minor;\n"
20930 " int64_t release;\n"
20938 #: ../src/guestfs-structs.pod:184
20941 " struct guestfs_version_list {\n"
20942 " uint32_t len; /* Number of elements in list. */\n"
20943 " struct guestfs_version *val; /* Elements. */\n"
20950 #: ../src/guestfs-structs.pod:189
20953 " void guestfs_free_version (struct guestfs_free_version *);\n"
20954 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20960 #: ../src/guestfs-structs.pod:192
20961 msgid "guestfs_xattr"
20966 #: ../src/guestfs-structs.pod:194
20969 " struct guestfs_xattr {\n"
20970 " char *attrname;\n"
20971 " /* The next two fields describe a byte array. */\n"
20972 " uint32_t attrval_len;\n"
20973 " char *attrval;\n"
20980 #: ../src/guestfs-structs.pod:201
20983 " struct guestfs_xattr_list {\n"
20984 " uint32_t len; /* Number of elements in list. */\n"
20985 " struct guestfs_xattr *val; /* Elements. */\n"
20992 #: ../src/guestfs-structs.pod:206
20995 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20996 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
21002 #: ../src/guestfs-structs.pod:209
21003 msgid "guestfs_inotify_event"
21008 #: ../src/guestfs-structs.pod:211
21011 " struct guestfs_inotify_event {\n"
21012 " int64_t in_wd;\n"
21013 " uint32_t in_mask;\n"
21014 " uint32_t in_cookie;\n"
21015 " char *in_name;\n"
21022 #: ../src/guestfs-structs.pod:218
21025 " struct guestfs_inotify_event_list {\n"
21026 " uint32_t len; /* Number of elements in list. */\n"
21027 " struct guestfs_inotify_event *val; /* Elements. */\n"
21034 #: ../src/guestfs-structs.pod:223
21037 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
21038 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
21044 #: ../src/guestfs-structs.pod:226
21045 msgid "guestfs_partition"
21050 #: ../src/guestfs-structs.pod:228
21053 " struct guestfs_partition {\n"
21054 " int32_t part_num;\n"
21055 " uint64_t part_start;\n"
21056 " uint64_t part_end;\n"
21057 " uint64_t part_size;\n"
21064 #: ../src/guestfs-structs.pod:235
21067 " struct guestfs_partition_list {\n"
21068 " uint32_t len; /* Number of elements in list. */\n"
21069 " struct guestfs_partition *val; /* Elements. */\n"
21076 #: ../src/guestfs-structs.pod:240
21079 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
21080 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
21086 #: ../src/guestfs-structs.pod:243
21087 msgid "guestfs_application"
21092 #: ../src/guestfs-structs.pod:245
21095 " struct guestfs_application {\n"
21096 " char *app_name;\n"
21097 " char *app_display_name;\n"
21098 " int32_t app_epoch;\n"
21099 " char *app_version;\n"
21100 " char *app_release;\n"
21101 " char *app_install_path;\n"
21102 " char *app_trans_path;\n"
21103 " char *app_publisher;\n"
21104 " char *app_url;\n"
21105 " char *app_source_package;\n"
21106 " char *app_summary;\n"
21107 " char *app_description;\n"
21114 #: ../src/guestfs-structs.pod:260
21117 " struct guestfs_application_list {\n"
21118 " uint32_t len; /* Number of elements in list. */\n"
21119 " struct guestfs_application *val; /* Elements. */\n"
21126 #: ../src/guestfs-structs.pod:265
21129 " void guestfs_free_application (struct guestfs_free_application *);\n"
21130 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
21136 #: ../fish/guestfish.pod:5
21137 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
21142 #: ../fish/guestfish.pod:9
21145 " guestfish [--options] [commands]\n"
21151 #: ../fish/guestfish.pod:11
21160 #: ../fish/guestfish.pod:13
21163 " guestfish [--ro|--rw] -a disk.img\n"
21169 #: ../fish/guestfish.pod:15
21172 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
21178 #: ../fish/guestfish.pod:17
21181 " guestfish -d libvirt-domain\n"
21187 #: ../fish/guestfish.pod:19
21190 " guestfish [--ro|--rw] -a disk.img -i\n"
21196 #: ../fish/guestfish.pod:21
21199 " guestfish -d libvirt-domain -i\n"
21205 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
21206 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
21212 #: ../fish/guestfish.pod:25
21214 "Using guestfish in read/write mode on live virtual machines can be "
21215 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
21216 "option to use guestfish safely if the disk image or virtual machine might be "
21222 #: ../fish/guestfish.pod:32
21224 "Guestfish is a shell and command-line tool for examining and modifying "
21225 "virtual machine filesystems. It uses libguestfs and exposes all of the "
21226 "functionality of the guestfs API, see L<guestfs(3)>."
21231 #: ../fish/guestfish.pod:36
21233 "Guestfish gives you structured access to the libguestfs API, from shell "
21234 "scripts or the command line or interactively. If you want to rescue a "
21235 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
21241 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942
21242 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
21243 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
21249 #: ../fish/guestfish.pod:43
21250 msgid "As an interactive shell"
21255 #: ../fish/guestfish.pod:45
21264 #: ../fish/guestfish.pod:47
21267 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
21268 " editing virtual machine filesystems.\n"
21274 #: ../fish/guestfish.pod:50
21277 " Type: 'help' for a list of commands\n"
21278 " 'man' to read the manual\n"
21279 " 'quit' to quit the shell\n"
21285 #: ../fish/guestfish.pod:54
21288 " ><fs> add-ro disk.img\n"
21290 " ><fs> list-filesystems\n"
21291 " /dev/sda1: ext4\n"
21292 " /dev/vg_guest/lv_root: ext4\n"
21293 " /dev/vg_guest/lv_swap: swap\n"
21294 " ><fs> mount /dev/vg_guest/lv_root /\n"
21295 " ><fs> cat /etc/fstab\n"
21297 " # Created by anaconda\n"
21305 #: ../fish/guestfish.pod:67
21306 msgid "From shell scripts"
21311 #: ../fish/guestfish.pod:69
21312 msgid "Create a new C</etc/motd> file in a guest or disk image:"
21317 #: ../fish/guestfish.pod:71
21320 " guestfish <<_EOF_\n"
21323 " mount /dev/vg_guest/lv_root /\n"
21324 " write /etc/motd \"Welcome, new users\"\n"
21331 #: ../fish/guestfish.pod:78
21332 msgid "List the LVM logical volumes in a disk image:"
21337 #: ../fish/guestfish.pod:80
21340 " guestfish -a disk.img --ro <<_EOF_\n"
21349 #: ../fish/guestfish.pod:85
21350 msgid "List all the filesystems in a disk image:"
21355 #: ../fish/guestfish.pod:87
21358 " guestfish -a disk.img --ro <<_EOF_\n"
21360 " list-filesystems\n"
21367 #: ../fish/guestfish.pod:92
21368 msgid "On one command line"
21373 #: ../fish/guestfish.pod:94
21374 msgid "Update C</etc/resolv.conf> in a guest:"
21379 #: ../fish/guestfish.pod:96
21383 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
21384 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
21390 #: ../fish/guestfish.pod:100
21391 msgid "Edit C</boot/grub/grub.conf> interactively:"
21396 #: ../fish/guestfish.pod:102
21399 " guestfish --rw --add disk.img \\\n"
21400 " --mount /dev/vg_guest/lv_root \\\n"
21401 " --mount /dev/sda1:/boot \\\n"
21402 " edit /boot/grub/grub.conf\n"
21408 #: ../fish/guestfish.pod:107
21409 msgid "Mount disks automatically"
21414 #: ../fish/guestfish.pod:109
21416 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
21421 #: ../fish/guestfish.pod:112
21424 " guestfish --ro -a disk.img -i cat /etc/group\n"
21430 #: ../fish/guestfish.pod:114
21433 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
21439 #: ../fish/guestfish.pod:116
21440 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
21445 #: ../fish/guestfish.pod:118
21448 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
21454 #: ../fish/guestfish.pod:120
21455 msgid "As a script interpreter"
21460 #: ../fish/guestfish.pod:122
21461 msgid "Create a 100MB disk containing an ext2-formatted partition:"
21466 #: ../fish/guestfish.pod:124
21469 " #!/usr/bin/guestfish -f\n"
21470 " sparse test1.img 100M\n"
21472 " part-disk /dev/sda mbr\n"
21473 " mkfs ext2 /dev/sda1\n"
21479 #: ../fish/guestfish.pod:130
21480 msgid "Start with a prepared disk"
21485 #: ../fish/guestfish.pod:132
21487 "An alternate way to create a 100MB disk called C<test1.img> containing a "
21488 "single ext2-formatted partition:"
21493 #: ../fish/guestfish.pod:135
21496 " guestfish -N fs\n"
21502 #: ../fish/guestfish.pod:137
21503 msgid "To list what is available do:"
21508 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
21511 " guestfish -N help | less\n"
21517 #: ../fish/guestfish.pod:141
21518 msgid "Remote control"
21523 #: ../fish/guestfish.pod:143
21526 " eval \"`guestfish --listen`\"\n"
21527 " guestfish --remote add-ro disk.img\n"
21528 " guestfish --remote run\n"
21529 " guestfish --remote lvs\n"
21535 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
21536 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
21537 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
21538 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
21539 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
21545 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
21546 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104
21547 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
21548 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
21549 #: ../tools/virt-list-partitions.pl:62
21555 #: ../fish/guestfish.pod:154
21556 msgid "Displays general help on options."
21561 #: ../fish/guestfish.pod:156
21567 #: ../fish/guestfish.pod:158
21568 msgid "B<--cmd-help>"
21573 #: ../fish/guestfish.pod:160
21574 msgid "Lists all available guestfish commands."
21579 #: ../fish/guestfish.pod:162
21585 #: ../fish/guestfish.pod:164
21586 msgid "B<--cmd-help cmd>"
21591 #: ../fish/guestfish.pod:166
21592 msgid "Displays detailed help on a single command C<cmd>."
21597 #: ../fish/guestfish.pod:168
21598 msgid "B<-a image>"
21603 #: ../fish/guestfish.pod:170
21604 msgid "B<--add image>"
21609 #: ../fish/guestfish.pod:172
21610 msgid "Add a block device or virtual machine image to the shell."
21615 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
21617 "The format of the disk image is auto-detected. To override this and force a "
21618 "particular format use the I<--format=..> option."
21623 #: ../fish/guestfish.pod:177
21625 "Using this flag is mostly equivalent to using the C<add> command, with "
21626 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
21627 "the I<--format:...> flag was given."
21632 #: ../fish/guestfish.pod:181
21638 #: ../fish/guestfish.pod:183
21639 msgid "B<--connect URI>"
21644 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
21646 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21647 "URI to use. The default is to use the default libvirt connection."
21652 #: ../fish/guestfish.pod:189
21658 #: ../fish/guestfish.pod:191
21660 "If using the I<--listen> option and a csh-like shell, use this option. See "
21661 "section L</REMOTE CONTROL AND CSH> below."
21666 #: ../fish/guestfish.pod:194
21667 msgid "B<-d libvirt-domain>"
21672 #: ../fish/guestfish.pod:196
21673 msgid "B<--domain libvirt-domain>"
21678 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
21680 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21681 "used, then any libvirt domain can be used. However in write mode, only "
21682 "libvirt domains which are shut down can be named here."
21687 #: ../fish/guestfish.pod:202
21689 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21690 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21691 "if the I<--format:...> flag was given."
21696 #: ../fish/guestfish.pod:206
21702 #: ../fish/guestfish.pod:208
21703 msgid "B<--no-dest-paths>"
21708 #: ../fish/guestfish.pod:210
21710 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21711 "to hit the tab key to complete paths on the guest filesystem, but this "
21712 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21713 "allow this feature to be disabled."
21718 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
21719 msgid "B<--echo-keys>"
21724 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
21726 "When prompting for keys and passphrases, guestfish normally turns echoing "
21727 "off so you cannot see what you are typing. If you are not worried about "
21728 "Tempest attacks and there is no one else in the room you can specify this "
21729 "flag to see what you are typing."
21734 #: ../fish/guestfish.pod:222
21740 #: ../fish/guestfish.pod:224
21741 msgid "B<--file file>"
21746 #: ../fish/guestfish.pod:226
21747 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21752 #: ../fish/guestfish.pod:229
21755 " #!/usr/bin/guestfish -f\n"
21761 #: ../fish/guestfish.pod:231
21762 msgid "B<--format=raw|qcow2|..>"
21767 #: ../fish/guestfish.pod:233
21768 msgid "B<--format>"
21773 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
21775 "The default for the I<-a> option is to auto-detect the format of the disk "
21776 "image. Using this forces the disk format for I<-a> options which follow on "
21777 "the command line. Using I<--format> with no argument switches back to auto-"
21778 "detection for subsequent I<-a> options."
21783 #: ../fish/guestfish.pod:242
21786 " guestfish --format=raw -a disk.img\n"
21792 #: ../fish/guestfish.pod:244
21793 msgid "forces raw format (no auto-detection) for C<disk.img>."
21798 #: ../fish/guestfish.pod:246
21801 " guestfish --format=raw -a disk.img --format -a another.img\n"
21807 #: ../fish/guestfish.pod:248
21809 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
21810 "detection for C<another.img>."
21815 #: ../fish/guestfish.pod:251
21817 "If you have untrusted raw-format guest disk images, you should use this "
21818 "option to specify the disk format. This avoids a possible security problem "
21819 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21824 #: ../fish/guestfish.pod:256
21830 #: ../fish/guestfish.pod:258
21831 msgid "B<--inspector>"
21836 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
21838 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21839 "system and mount filesystems as they would be mounted on the real virtual "
21845 #: ../fish/guestfish.pod:264
21846 msgid "Typical usage is either:"
21851 #: ../fish/guestfish.pod:266
21854 " guestfish -d myguest -i\n"
21860 #: ../fish/guestfish.pod:268
21861 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21866 #: ../fish/guestfish.pod:270
21869 " guestfish --ro -d myguest -i\n"
21875 #: ../fish/guestfish.pod:272
21876 msgid "(for active domains, readonly), or specify the block device directly:"
21881 #: ../fish/guestfish.pod:274
21884 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21890 #: ../fish/guestfish.pod:276
21892 "Note that the command line syntax changed slightly over older versions of "
21893 "guestfish. You can still use the old syntax:"
21898 #: ../fish/guestfish.pod:279
21901 " guestfish [--ro] -i disk.img\n"
21907 #: ../fish/guestfish.pod:281
21910 " guestfish [--ro] -i libvirt-domain\n"
21916 #: ../fish/guestfish.pod:283
21918 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21919 "then using other commands to mount the filesystems that were found."
21924 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21925 msgid "B<--keys-from-stdin>"
21930 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21932 "Read key or passphrase parameters from stdin. The default is to try to read "
21933 "passphrases from the user by opening C</dev/tty>."
21938 #: ../fish/guestfish.pod:292
21939 msgid "B<--listen>"
21944 #: ../fish/guestfish.pod:294
21946 "Fork into the background and listen for remote commands. See section L</"
21947 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21951 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
21956 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
21958 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
21959 "ATTACHING TO RUNNING DAEMONS>)."
21963 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
21964 msgid "B<-m dev[:mountpoint[:options]]>"
21968 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
21969 msgid "B<--mount dev[:mountpoint[:options]]>"
21974 #: ../fish/guestfish.pod:306
21975 msgid "Mount the named partition or logical volume on the given mountpoint."
21980 #: ../fish/guestfish.pod:308
21981 msgid "If the mountpoint is omitted, it defaults to C</>."
21986 #: ../fish/guestfish.pod:310
21987 msgid "You have to mount something on C</> before most commands will work."
21992 #: ../fish/guestfish.pod:312
21994 "If any I<-m> or I<--mount> options are given, the guest is automatically "
22000 #: ../fish/guestfish.pod:315
22002 "If you don't know what filesystems a disk image contains, you can either run "
22003 "guestfish without this option, then list the partitions, filesystems and LVs "
22004 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
22005 "commands), or you can use the L<virt-filesystems(1)> program."
22009 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
22011 "The third (and rarely used) part of the mount parameter is the list of mount "
22012 "options used to mount the underlying filesystem. If this is not given, then "
22013 "the mount options are either the empty string or C<ro> (the latter if the "
22014 "I<--ro> flag is used). By specifying the mount options, you override this "
22015 "default choice. Probably the only time you would use this is to enable ACLs "
22016 "and/or extended attributes if the filesystem can support them:"
22020 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
22023 " -m /dev/sda1:/:acl,user_xattr\n"
22028 #: ../fish/guestfish.pod:331
22029 msgid "Using this flag is equivalent to using the C<mount-options> command."
22034 #: ../fish/guestfish.pod:333
22040 #: ../fish/guestfish.pod:335
22041 msgid "B<--no-sync>"
22046 #: ../fish/guestfish.pod:337
22048 "Disable autosync. This is enabled by default. See the discussion of "
22049 "autosync in the L<guestfs(3)> manpage."
22054 #: ../fish/guestfish.pod:340
22060 #: ../fish/guestfish.pod:342
22061 msgid "B<--new type>"
22066 #: ../fish/guestfish.pod:344
22072 #: ../fish/guestfish.pod:346
22074 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
22075 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
22076 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
22082 #: ../fish/guestfish.pod:351
22083 msgid "B<--progress-bars>"
22088 #: ../fish/guestfish.pod:353
22089 msgid "Enable progress bars, even when guestfish is used non-interactively."
22094 #: ../fish/guestfish.pod:355
22096 "Progress bars are enabled by default when guestfish is used as an "
22097 "interactive shell."
22102 #: ../fish/guestfish.pod:358
22103 msgid "B<--no-progress-bars>"
22108 #: ../fish/guestfish.pod:360
22109 msgid "Disable progress bars."
22114 #: ../fish/guestfish.pod:362
22115 msgid "B<--remote[=pid]>"
22120 #: ../fish/guestfish.pod:364
22122 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
22123 "CONTROL GUESTFISH OVER A SOCKET> below."
22128 #: ../fish/guestfish.pod:367
22134 #: ../fish/guestfish.pod:369
22140 #: ../fish/guestfish.pod:371
22142 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22143 "mounts are done read-only."
22148 #: ../fish/guestfish.pod:374
22150 "The option must always be used if the disk image or virtual machine might be "
22151 "running, and is generally recommended in cases where you don't need write "
22152 "access to the disk."
22157 #: ../fish/guestfish.pod:378
22159 "Note that prepared disk images created with I<-N> are not affected by this "
22160 "option. Also commands like C<add> are not affected - you have to specify "
22161 "the C<readonly:true> option explicitly if you need it."
22166 #: ../fish/guestfish.pod:382
22167 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
22172 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
22173 msgid "B<--selinux>"
22178 #: ../fish/guestfish.pod:386
22179 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
22184 #: ../fish/guestfish.pod:388
22190 #: ../fish/guestfish.pod:390
22191 msgid "B<--verbose>"
22196 #: ../fish/guestfish.pod:392
22198 "Enable very verbose messages. This is particularly useful if you find a bug."
22203 #: ../fish/guestfish.pod:395
22209 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:88
22210 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
22211 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
22212 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
22213 msgid "B<--version>"
22218 #: ../fish/guestfish.pod:399
22219 msgid "Display the guestfish / libguestfs version number and exit."
22224 #: ../fish/guestfish.pod:401
22230 #: ../fish/guestfish.pod:403
22235 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
22237 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
22238 "mounts are done read-write."
22242 #: ../fish/guestfish.pod:408
22243 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
22248 #: ../fish/guestfish.pod:410
22254 #: ../fish/guestfish.pod:412
22255 msgid "Echo each command before executing it."
22260 #: ../fish/guestfish.pod:416
22261 msgid "COMMANDS ON COMMAND LINE"
22266 #: ../fish/guestfish.pod:418
22268 "Any additional (non-option) arguments are treated as commands to execute."
22273 #: ../fish/guestfish.pod:421
22275 "Commands to execute should be separated by a colon (C<:>), where the colon "
22276 "is a separate parameter. Thus:"
22281 #: ../fish/guestfish.pod:424
22284 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
22290 #: ../fish/guestfish.pod:426
22292 "If there are no additional arguments, then we enter a shell, either an "
22293 "interactive shell with a prompt (if the input is a terminal) or a non-"
22294 "interactive shell."
22299 #: ../fish/guestfish.pod:430
22301 "In either command line mode or non-interactive shell, the first command that "
22302 "gives an error causes the whole shell to exit. In interactive mode (with a "
22303 "prompt) if a command fails, you can continue to enter commands."
22308 #: ../fish/guestfish.pod:435
22309 msgid "USING launch (OR run)"
22314 #: ../fish/guestfish.pod:437
22316 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
22317 "then launch it, then mount any disks you need, and finally issue actions/"
22318 "commands. So the general order of the day is:"
22323 #: ../fish/guestfish.pod:445
22324 msgid "add or -a/--add"
22329 #: ../fish/guestfish.pod:449
22330 msgid "launch (aka run)"
22335 #: ../fish/guestfish.pod:453
22336 msgid "mount or -m/--mount"
22341 #: ../fish/guestfish.pod:457
22342 msgid "any other commands"
22347 #: ../fish/guestfish.pod:461
22349 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
22350 "guest before mounting or performing any other commands."
22355 #: ../fish/guestfish.pod:464
22357 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
22358 "I<--new> options were given then C<run> is done automatically, simply "
22359 "because guestfish can't perform the action you asked for without doing this."
22364 #: ../fish/guestfish.pod:469
22365 msgid "OPENING DISKS FOR READ AND WRITE"
22369 #: ../fish/guestfish.pod:471
22371 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
22372 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
22373 "I<-i> and I<-m> open disk images read-only or for writing."
22377 #: ../fish/guestfish.pod:476
22379 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
22380 "opening disk images supplied on the command line for write. To open a disk "
22381 "image read-only you have to do I<-a image --ro>."
22386 #: ../fish/guestfish.pod:480
22388 "This matters: If you accidentally open a live VM disk image writable then "
22389 "you will cause irreversible disk corruption."
22393 #: ../fish/guestfish.pod:483
22395 "By libguestfs 1.10 we intend to change the default the other way. Disk "
22396 "images will be opened read-only. You will have to either specify "
22397 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
22398 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
22399 "access for disk images specified by those other command line options."
22403 #: ../fish/guestfish.pod:490
22405 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
22406 "which does nothing (it is already the default). However it is highly "
22407 "recommended that you use this option to indicate that you need write access, "
22408 "and prepare your scripts for the day when this option will be required for "
22414 #: ../fish/guestfish.pod:496
22416 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
22417 "other libguestfs program apart from guestfish and guestmount."
22422 #: ../fish/guestfish.pod:499
22428 #: ../fish/guestfish.pod:501
22430 "You can quote ordinary parameters using either single or double quotes. For "
22436 #: ../fish/guestfish.pod:504
22439 " add \"file with a space.img\"\n"
22445 #: ../fish/guestfish.pod:506
22448 " rm '/file name'\n"
22454 #: ../fish/guestfish.pod:508
22463 #: ../fish/guestfish.pod:510
22465 "A few commands require a list of strings to be passed. For these, use a "
22466 "whitespace-separated list, enclosed in quotes. Strings containing "
22467 "whitespace to be passed through must be enclosed in single quotes. A "
22468 "literal single quote must be escaped with a backslash."
22473 #: ../fish/guestfish.pod:515
22476 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
22477 " command \"/bin/echo 'foo bar'\"\n"
22478 " command \"/bin/echo \\'foo\\'\"\n"
22484 #: ../fish/guestfish.pod:519
22485 msgid "OPTIONAL ARGUMENTS"
22490 #: ../fish/guestfish.pod:521
22492 "Some commands take optional arguments. These arguments appear in this "
22493 "documentation as C<[argname:..]>. You can use them as in these examples:"
22498 #: ../fish/guestfish.pod:525
22501 " add-drive-opts filename\n"
22507 #: ../fish/guestfish.pod:527
22510 " add-drive-opts filename readonly:true\n"
22516 #: ../fish/guestfish.pod:529
22519 " add-drive-opts filename format:qcow2 readonly:false\n"
22525 #: ../fish/guestfish.pod:531
22527 "Each optional argument can appear at most once. All optional arguments must "
22528 "appear after the required ones."
22533 #: ../fish/guestfish.pod:534
22539 #: ../fish/guestfish.pod:536
22541 "This section applies to all commands which can take integers as parameters."
22546 #: ../fish/guestfish.pod:539
22547 msgid "SIZE SUFFIX"
22552 #: ../fish/guestfish.pod:541
22554 "When the command takes a parameter measured in bytes, you can use one of the "
22555 "following suffixes to specify kilobytes, megabytes and larger sizes:"
22560 #: ../fish/guestfish.pod:547
22561 msgid "B<k> or B<K> or B<KiB>"
22566 #: ../fish/guestfish.pod:549
22567 msgid "The size in kilobytes (multiplied by 1024)."
22572 #: ../fish/guestfish.pod:551
22578 #: ../fish/guestfish.pod:553
22579 msgid "The size in SI 1000 byte units."
22584 #: ../fish/guestfish.pod:555
22585 msgid "B<M> or B<MiB>"
22590 #: ../fish/guestfish.pod:557
22591 msgid "The size in megabytes (multiplied by 1048576)."
22596 #: ../fish/guestfish.pod:559
22602 #: ../fish/guestfish.pod:561
22603 msgid "The size in SI 1000000 byte units."
22608 #: ../fish/guestfish.pod:563
22609 msgid "B<G> or B<GiB>"
22614 #: ../fish/guestfish.pod:565
22615 msgid "The size in gigabytes (multiplied by 2**30)."
22620 #: ../fish/guestfish.pod:567
22626 #: ../fish/guestfish.pod:569
22627 msgid "The size in SI 10**9 byte units."
22632 #: ../fish/guestfish.pod:571
22633 msgid "B<T> or B<TiB>"
22638 #: ../fish/guestfish.pod:573
22639 msgid "The size in terabytes (multiplied by 2**40)."
22644 #: ../fish/guestfish.pod:575
22650 #: ../fish/guestfish.pod:577
22651 msgid "The size in SI 10**12 byte units."
22656 #: ../fish/guestfish.pod:579
22657 msgid "B<P> or B<PiB>"
22662 #: ../fish/guestfish.pod:581
22663 msgid "The size in petabytes (multiplied by 2**50)."
22668 #: ../fish/guestfish.pod:583
22674 #: ../fish/guestfish.pod:585
22675 msgid "The size in SI 10**15 byte units."
22680 #: ../fish/guestfish.pod:587
22681 msgid "B<E> or B<EiB>"
22686 #: ../fish/guestfish.pod:589
22687 msgid "The size in exabytes (multiplied by 2**60)."
22692 #: ../fish/guestfish.pod:591
22698 #: ../fish/guestfish.pod:593
22699 msgid "The size in SI 10**18 byte units."
22704 #: ../fish/guestfish.pod:595
22705 msgid "B<Z> or B<ZiB>"
22710 #: ../fish/guestfish.pod:597
22711 msgid "The size in zettabytes (multiplied by 2**70)."
22716 #: ../fish/guestfish.pod:599
22722 #: ../fish/guestfish.pod:601
22723 msgid "The size in SI 10**21 byte units."
22728 #: ../fish/guestfish.pod:603
22729 msgid "B<Y> or B<YiB>"
22734 #: ../fish/guestfish.pod:605
22735 msgid "The size in yottabytes (multiplied by 2**80)."
22740 #: ../fish/guestfish.pod:607
22746 #: ../fish/guestfish.pod:609
22747 msgid "The size in SI 10**24 byte units."
22752 #: ../fish/guestfish.pod:615
22755 " truncate-size /file 1G\n"
22761 #: ../fish/guestfish.pod:617
22762 msgid "would truncate the file to 1 gigabyte."
22767 #: ../fish/guestfish.pod:619
22769 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22770 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22771 "suffix will probably not do what you expect."
22776 #: ../fish/guestfish.pod:623
22777 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22782 #: ../fish/guestfish.pod:625
22784 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22785 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22790 #: ../fish/guestfish.pod:628
22793 " 1234 decimal number 1234\n"
22794 " 02322 octal number, equivalent to decimal 1234\n"
22795 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22801 #: ../fish/guestfish.pod:632
22803 "When using the C<chmod> command, you almost always want to specify an octal "
22804 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22805 "L<chmod(1)> program):"
22810 #: ../fish/guestfish.pod:636
22813 " chmod 0777 /public # OK\n"
22814 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22820 #: ../fish/guestfish.pod:639
22822 "Commands that return numbers usually print them in decimal, but some "
22823 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22824 "octal, preceeded by C<0>)."
22829 #: ../fish/guestfish.pod:643
22830 msgid "WILDCARDS AND GLOBBING"
22835 #: ../fish/guestfish.pod:645
22837 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22838 "(globbing) by default. So for example the following will not do what you "
22844 #: ../fish/guestfish.pod:649
22853 #: ../fish/guestfish.pod:651
22855 "Assuming you don't have a directory called literally C</home/*> then the "
22856 "above command will return an error."
22861 #: ../fish/guestfish.pod:654
22862 msgid "To perform wildcard expansion, use the C<glob> command."
22867 #: ../fish/guestfish.pod:656
22870 " glob rm-rf /home/*\n"
22876 #: ../fish/guestfish.pod:658
22878 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
22879 "many times), equivalent to:"
22884 #: ../fish/guestfish.pod:661
22887 " rm-rf /home/jim\n"
22888 " rm-rf /home/joe\n"
22889 " rm-rf /home/mary\n"
22895 #: ../fish/guestfish.pod:665
22896 msgid "C<glob> only works on simple guest paths and not on device names."
22901 #: ../fish/guestfish.pod:667
22903 "If you have several parameters, each containing a wildcard, then glob will "
22904 "perform a Cartesian product."
22909 #: ../fish/guestfish.pod:670
22915 #: ../fish/guestfish.pod:672
22917 "Any line which starts with a I<#> character is treated as a comment and "
22918 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22919 "a command. For example:"
22924 #: ../fish/guestfish.pod:676
22927 " # this is a comment\n"
22928 " # this is a comment\n"
22929 " foo # NOT a comment\n"
22935 #: ../fish/guestfish.pod:680
22936 msgid "Blank lines are also ignored."
22941 #: ../fish/guestfish.pod:682
22942 msgid "RUNNING COMMANDS LOCALLY"
22947 #: ../fish/guestfish.pod:684
22949 "Any line which starts with a I<!> character is treated as a command sent to "
22950 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22955 #: ../fish/guestfish.pod:688
22959 " tgz-out /remote local/remote-data.tar.gz\n"
22965 #: ../fish/guestfish.pod:691
22967 "will create a directory C<local> on the host, and then export the contents "
22968 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22969 "(See C<tgz-out>)."
22974 #: ../fish/guestfish.pod:695
22976 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22977 "effect, due to the way that subprocesses work in Unix."
22981 #: ../fish/guestfish.pod:698
22982 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
22986 #: ../fish/guestfish.pod:700
22988 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
22989 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
22990 "and executed as guestfish commands."
22994 #: ../fish/guestfish.pod:704
22996 "Thus you can use shell script to construct arbitrary guestfish commands "
22997 "which are then parsed by guestfish."
23001 #: ../fish/guestfish.pod:707
23003 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
23004 "through C</foo.100>) using guestfish commands alone. However this is simple "
23005 "if we use a shell script to create the guestfish commands for us:"
23009 #: ../fish/guestfish.pod:712
23012 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
23017 #: ../fish/guestfish.pod:714
23018 msgid "or with names like C</foo.001>:"
23022 #: ../fish/guestfish.pod:716
23025 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
23030 #: ../fish/guestfish.pod:718
23032 "When using guestfish interactively it can be helpful to just run the shell "
23033 "script first (ie. remove the initial C<E<lt>> character so it is just an "
23034 "ordinary I<!> local command), see what guestfish commands it would run, and "
23035 "when you are happy with those prepend the C<E<lt>> character to run the "
23036 "guestfish commands for real."
23041 #: ../fish/guestfish.pod:724
23047 #: ../fish/guestfish.pod:726
23049 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
23050 "command (a guestfish command) to the second command (any host command). For "
23056 #: ../fish/guestfish.pod:730
23059 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
23065 #: ../fish/guestfish.pod:732
23067 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
23068 "program). The above command would list all accounts in the guest filesystem "
23069 "which have UID 0, ie. root accounts including backdoors. Other examples:"
23074 #: ../fish/guestfish.pod:737
23077 " hexdump /bin/ls | head\n"
23078 " list-devices | tail -1\n"
23079 " tgz-out / - | tar ztf -\n"
23085 #: ../fish/guestfish.pod:741
23087 "The space before the pipe symbol is required, any space after the pipe "
23088 "symbol is optional. Everything after the pipe symbol is just passed "
23089 "straight to the host shell, so it can contain redirections, globs and "
23090 "anything else that makes sense on the host side."
23095 #: ../fish/guestfish.pod:746
23097 "To use a literal argument which begins with a pipe symbol, you have to quote "
23103 #: ../fish/guestfish.pod:749
23112 #: ../fish/guestfish.pod:751
23113 msgid "HOME DIRECTORIES"
23118 #: ../fish/guestfish.pod:753
23120 "If a parameter starts with the character C<~> then the tilde may be expanded "
23121 "as a home directory path (either C<~> for the current user's home directory, "
23122 "or C<~user> for another user)."
23127 #: ../fish/guestfish.pod:757
23129 "Note that home directory expansion happens for users known I<on the host>, "
23130 "not in the guest filesystem."
23135 #: ../fish/guestfish.pod:760
23137 "To use a literal argument which begins with a tilde, you have to quote it, "
23143 #: ../fish/guestfish.pod:763
23152 #: ../fish/guestfish.pod:767
23154 "Libguestfs has some support for Linux guests encrypted according to the "
23155 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
23156 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
23157 "LUKS is supported."
23162 #: ../fish/guestfish.pod:772
23163 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
23168 #: ../fish/guestfish.pod:774
23171 " ><fs> vfs-type /dev/sda2\n"
23178 #: ../fish/guestfish.pod:777
23180 "Then open those devices using L</luks-open>. This creates a device-mapper "
23181 "device called C</dev/mapper/luksdev>."
23186 #: ../fish/guestfish.pod:780
23189 " ><fs> luks-open /dev/sda2 luksdev\n"
23190 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
23196 #: ../fish/guestfish.pod:783
23198 "Finally you have to tell LVM to scan for volume groups on the newly created "
23204 #: ../fish/guestfish.pod:786
23208 " vg-activate-all true\n"
23214 #: ../fish/guestfish.pod:789
23215 msgid "The logical volume(s) can now be mounted in the usual way."
23220 #: ../fish/guestfish.pod:791
23222 "Before closing a LUKS device you must unmount any logical volumes on it and "
23223 "deactivate the volume groups by calling C<vg-activate false VG> on each "
23224 "one. Then you can close the mapper device:"
23229 #: ../fish/guestfish.pod:795
23232 " vg-activate false /dev/VG\n"
23233 " luks-close /dev/mapper/luksdev\n"
23239 #: ../fish/guestfish.pod:798
23240 msgid "WINDOWS PATHS"
23245 #: ../fish/guestfish.pod:800
23247 "If a path is prefixed with C<win:> then you can use Windows-style paths "
23248 "(with some limitations). The following commands are equivalent:"
23253 #: ../fish/guestfish.pod:803
23256 " file /WINDOWS/system32/config/system.LOG\n"
23262 #: ../fish/guestfish.pod:805
23265 " file win:/windows/system32/config/system.log\n"
23271 #: ../fish/guestfish.pod:807
23274 " file win:\\windows\\system32\\config\\system.log\n"
23280 #: ../fish/guestfish.pod:809
23283 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
23289 #: ../fish/guestfish.pod:811
23291 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
23292 "handles case insensitivity like Windows would. This only works in argument "
23293 "positions that expect a path."
23298 #: ../fish/guestfish.pod:815
23299 msgid "UPLOADING AND DOWNLOADING FILES"
23304 #: ../fish/guestfish.pod:817
23306 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
23307 "others which upload from or download to a local file, you can use the "
23308 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
23313 #: ../fish/guestfish.pod:821
23322 #: ../fish/guestfish.pod:823
23324 "reads stdin and creates from that a file C</foo> in the disk image, and:"
23329 #: ../fish/guestfish.pod:826
23332 " tar-out /etc - | tar tf -\n"
23338 #: ../fish/guestfish.pod:828
23340 "writes the tarball to stdout and then pipes that into the external \"tar\" "
23341 "command (see L</PIPES>)."
23346 #: ../fish/guestfish.pod:831
23348 "When using C<-> to read from stdin, the input is read up to the end of "
23349 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
23350 "some arbitrary end marker:"
23355 #: ../fish/guestfish.pod:835
23358 " upload -<<END /foo\n"
23368 #: ../fish/guestfish.pod:841
23370 "Any string of characters can be used instead of C<END>. The end marker must "
23371 "appear on a line of its own, without any preceeding or following characters "
23372 "(not even spaces)."
23377 #: ../fish/guestfish.pod:845
23379 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
23380 "upload local files (so-called \"FileIn\" parameters in the generator)."
23385 #: ../fish/guestfish.pod:848
23386 msgid "EXIT ON ERROR BEHAVIOUR"
23391 #: ../fish/guestfish.pod:850
23393 "By default, guestfish will ignore any errors when in interactive mode (ie. "
23394 "taking commands from a human over a tty), and will exit on the first error "
23395 "in non-interactive mode (scripts, commands given on the command line)."
23400 #: ../fish/guestfish.pod:855
23402 "If you prefix a command with a I<-> character, then that command will not "
23403 "cause guestfish to exit, even if that (one) command returns an error."
23408 #: ../fish/guestfish.pod:859
23409 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
23414 #: ../fish/guestfish.pod:861
23416 "Guestfish can be remote-controlled over a socket. This is useful "
23417 "particularly in shell scripts where you want to make several different "
23418 "changes to a filesystem, but you don't want the overhead of starting up a "
23419 "guestfish process each time."
23424 #: ../fish/guestfish.pod:866
23425 msgid "Start a guestfish server process using:"
23430 #: ../fish/guestfish.pod:868
23433 " eval \"`guestfish --listen`\"\n"
23439 #: ../fish/guestfish.pod:870
23440 msgid "and then send it commands by doing:"
23445 #: ../fish/guestfish.pod:872
23448 " guestfish --remote cmd [...]\n"
23454 #: ../fish/guestfish.pod:874
23455 msgid "To cause the server to exit, send it the exit command:"
23460 #: ../fish/guestfish.pod:876
23463 " guestfish --remote exit\n"
23469 #: ../fish/guestfish.pod:878
23471 "Note that the server will normally exit if there is an error in a command. "
23472 "You can change this in the usual way. See section L</EXIT ON ERROR "
23478 #: ../fish/guestfish.pod:882
23479 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
23484 #: ../fish/guestfish.pod:884
23486 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
23487 "is how the I<--remote> option knows where to send the commands. You can "
23488 "have several guestfish listener processes running using:"
23493 #: ../fish/guestfish.pod:888
23496 " eval \"`guestfish --listen`\"\n"
23497 " pid1=$GUESTFISH_PID\n"
23498 " eval \"`guestfish --listen`\"\n"
23499 " pid2=$GUESTFISH_PID\n"
23501 " guestfish --remote=$pid1 cmd\n"
23502 " guestfish --remote=$pid2 cmd\n"
23508 #: ../fish/guestfish.pod:896
23509 msgid "REMOTE CONTROL AND CSH"
23514 #: ../fish/guestfish.pod:898
23516 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
23522 #: ../fish/guestfish.pod:901
23525 " eval \"`guestfish --listen --csh`\"\n"
23531 #: ../fish/guestfish.pod:903
23532 msgid "REMOTE CONTROL DETAILS"
23537 #: ../fish/guestfish.pod:905
23539 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
23540 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
23541 "and C<$PID> is the process ID of the server."
23546 #: ../fish/guestfish.pod:909
23547 msgid "Guestfish client and server versions must match exactly."
23552 #: ../fish/guestfish.pod:911
23553 msgid "PREPARED DISK IMAGES"
23558 #: ../fish/guestfish.pod:913
23560 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
23561 "preformatted disk images that guestfish can make for you to save typing. "
23562 "This is particularly useful for testing purposes. This option is used "
23563 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
23564 "can be mixed with I<-a>)."
23569 #: ../fish/guestfish.pod:919
23571 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
23572 "the second and so on. Existing files in the current directory are "
23578 #: ../fish/guestfish.pod:923
23580 "The type briefly describes how the disk should be sized, partitioned, how "
23581 "filesystem(s) should be created, and how content should be added. "
23582 "Optionally the type can be followed by extra parameters, separated by C<:> "
23583 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
23584 "allocated disk, containing a single partition, with the partition formatted "
23585 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
23591 #: ../fish/guestfish.pod:931
23592 msgid "To list the available types and any extra parameters they take, run:"
23597 #: ../fish/guestfish.pod:935
23599 "Note that the prepared filesystem is not mounted. You would usually have to "
23600 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
23605 #: ../fish/guestfish.pod:939
23607 "If any I<-N> or I<--new> options are given, the guest is automatically "
23613 #: ../fish/guestfish.pod:944
23614 msgid "Create a 100MB disk with an ext4-formatted partition:"
23619 #: ../fish/guestfish.pod:946
23622 " guestfish -N fs:ext4\n"
23628 #: ../fish/guestfish.pod:948
23629 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
23634 #: ../fish/guestfish.pod:950
23637 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
23643 #: ../fish/guestfish.pod:952
23644 msgid "Create a blank 200MB disk:"
23649 #: ../fish/guestfish.pod:954
23652 " guestfish -N disk:200M\n"
23658 #: ../fish/guestfish.pod:956
23659 msgid "PROGRESS BARS"
23664 #: ../fish/guestfish.pod:958
23666 "Some (not all) long-running commands send progress notification messages as "
23667 "they are running. Guestfish turns these messages into progress bars."
23672 #: ../fish/guestfish.pod:962
23674 "When a command that supports progress bars takes longer than two seconds to "
23675 "run, and if progress bars are enabled, then you will see one appearing below "
23681 #: ../fish/guestfish.pod:966
23684 " ><fs> copy-size /large-file /another-file 2048M\n"
23685 " / 10% [#####-----------------------------------------] 00:30\n"
23691 #: ../fish/guestfish.pod:969
23693 "The spinner on the left hand side moves round once for every progress "
23694 "notification received from the backend. This is a (reasonably) golden "
23695 "assurance that the command is \"doing something\" even if the progress bar "
23696 "is not moving, because the command is able to send the progress "
23697 "notifications. When the bar reaches 100% and the command finishes, the "
23698 "spinner disappears."
23703 #: ../fish/guestfish.pod:976
23705 "Progress bars are enabled by default when guestfish is used interactively. "
23706 "You can enable them even for non-interactive modes using I<--progress-bars>, "
23707 "and you can disable them completely using I<--no-progress-bars>."
23712 #: ../fish/guestfish.pod:981
23713 msgid "GUESTFISH COMMANDS"
23718 #: ../fish/guestfish.pod:983
23720 "The commands in this section are guestfish convenience commands, in other "
23721 "words, they are not part of the L<guestfs(3)> API."
23726 #: ../fish/guestfish.pod:986
23732 #: ../fish/guestfish.pod:988
23742 #: ../fish/guestfish.pod:991
23743 msgid "Without any parameter, this provides general help."
23748 #: ../fish/guestfish.pod:993
23749 msgid "With a C<cmd> parameter, this displays detailed help for that command."
23754 #: ../fish/guestfish.pod:995
23755 msgid "quit | exit"
23760 #: ../fish/guestfish.pod:997
23761 msgid "This exits guestfish. You can also use C<^D> key."
23766 #: ../fish/guestfish.pod:999
23767 msgid "@FISH_COMMANDS@"
23772 #: ../fish/guestfish.pod:1001
23778 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:83
23784 #: ../fish/guestfish.pod:1007
23786 "guestfish returns 0 if the commands completed without error, or 1 if there "
23792 #: ../fish/guestfish.pod:1014
23798 #: ../fish/guestfish.pod:1016
23800 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23806 #: ../fish/guestfish.pod:1019
23807 msgid "GUESTFISH_PID"
23812 #: ../fish/guestfish.pod:1021
23814 "Used with the I<--remote> option to specify the remote guestfish process to "
23815 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23820 #: ../fish/guestfish.pod:1025
23826 #: ../fish/guestfish.pod:1027
23828 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23829 "not specified, the external L<hexedit(1)> program is used."
23834 #: ../fish/guestfish.pod:1031
23840 #: ../fish/guestfish.pod:1033
23842 "If compiled with GNU readline support, various files in the home directory "
23843 "can be used. See L</FILES>."
23848 #: ../fish/guestfish.pod:1042
23850 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23851 "effect as using the B<-v> option."
23856 #: ../fish/guestfish.pod:1054
23858 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23859 "the discussion of paths in L<guestfs(3)>."
23864 #: ../fish/guestfish.pod:1065
23865 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
23870 #: ../fish/guestfish.pod:1067
23876 #: ../fish/guestfish.pod:1069
23878 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
23884 #: ../fish/guestfish.pod:1085 ../test-tool/libguestfs-test-tool.pod:88
23885 #: ../fuse/guestmount.pod:252
23890 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
23891 msgid "$HOME/.libguestfs-tools.rc"
23895 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
23896 msgid "/etc/libguestfs-tools.conf"
23900 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
23902 "This configuration file controls the default read-only or read-write mode "
23903 "(I<--ro> or I<--rw>)."
23907 #: ../fish/guestfish.pod:1096
23908 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
23913 #: ../fish/guestfish.pod:1098
23914 msgid "$HOME/.guestfish"
23919 #: ../fish/guestfish.pod:1100
23921 "If compiled with GNU readline support, then the command history is saved in "
23927 #: ../fish/guestfish.pod:1103
23928 msgid "$HOME/.inputrc"
23933 #: ../fish/guestfish.pod:1105
23934 msgid "/etc/inputrc"
23939 #: ../fish/guestfish.pod:1107
23941 "If compiled with GNU readline support, then these files can be used to "
23942 "configure readline. For further information, please see L<readline(3)/"
23943 "INITIALIZATION FILE>."
23948 #: ../fish/guestfish.pod:1111
23949 msgid "To write rules which only apply to guestfish, use:"
23954 #: ../fish/guestfish.pod:1113
23965 #: ../fish/guestfish.pod:1117
23967 "Variables that you can set in inputrc that change the behaviour of guestfish "
23968 "in useful ways include:"
23973 #: ../fish/guestfish.pod:1122
23974 msgid "completion-ignore-case (default: on)"
23979 #: ../fish/guestfish.pod:1124
23981 "By default, guestfish will ignore case when tab-completing paths on the "
23987 #: ../fish/guestfish.pod:1127
23990 " set completion-ignore-case off\n"
23996 #: ../fish/guestfish.pod:1129
23997 msgid "to make guestfish case sensitive."
24002 #: ../fish/guestfish.pod:1133
24008 #: ../fish/guestfish.pod:1135
24009 msgid "test2.img (etc)"
24014 #: ../fish/guestfish.pod:1137
24016 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
24017 "will be created in the file C<test1.img> in the current directory. The "
24018 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
24019 "the same name will be overwritten."
24023 #: ../fish/guestfish.pod:1146
24025 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
24026 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
24027 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
24028 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
24029 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
24030 ">, L<hexedit(1)>."
24034 #: ../fish/guestfish.pod:1173
24035 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
24040 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:124
24041 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:372
24042 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518
24043 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
24044 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
24046 "This program is free software; you can redistribute it and/or modify it "
24047 "under the terms of the GNU General Public License as published by the Free "
24048 "Software Foundation; either version 2 of the License, or (at your option) "
24049 "any later version."
24054 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:129
24055 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:377
24056 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523
24057 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
24058 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
24060 "This program is distributed in the hope that it will be useful, but WITHOUT "
24061 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
24062 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
24068 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:134
24069 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:382
24070 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528
24071 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
24072 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
24074 "You should have received a copy of the GNU General Public License along with "
24075 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
24076 "Ave, Cambridge, MA 02139, USA."
24081 #: ../fish/guestfish-actions.pod:1
24087 #: ../fish/guestfish-actions.pod:3
24090 " add-cdrom filename\n"
24096 #: ../fish/guestfish-actions.pod:15
24098 "This call checks for the existence of C<filename>. This stops you from "
24099 "specifying other types of drive which are supported by qemu such as C<nbd:> "
24100 "and C<http:> URLs. To specify those, use the general L</config> call "
24106 #: ../fish/guestfish-actions.pod:22
24108 "If you just want to add an ISO file (often you use this as an efficient way "
24109 "to transfer large files into the guest), then you should probably use L</add-"
24110 "drive-ro> instead."
24115 #: ../fish/guestfish-actions.pod:35
24121 #: ../fish/guestfish-actions.pod:37
24126 #: ../fish/guestfish-actions.pod:39
24129 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
24135 #: ../fish/guestfish-actions.pod:41
24137 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
24138 "It works by connecting to libvirt, requesting the domain and domain XML from "
24139 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
24144 #: ../fish/guestfish-actions.pod:71
24146 "The other optional parameters are passed directly through to L</add-drive-"
24152 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
24153 #: ../fish/guestfish-actions.pod:2981
24155 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
24160 #: ../fish/guestfish-actions.pod:76
24166 #: ../fish/guestfish-actions.pod:78
24169 " add-drive filename\n"
24175 #: ../fish/guestfish-actions.pod:80
24177 "This function is the equivalent of calling L</add-drive-opts> with no "
24178 "optional parameters, so the disk is added writable, with the format being "
24179 "detected automatically."
24184 #: ../fish/guestfish-actions.pod:84
24186 "Automatic detection of the format opens you up to a potential security hole "
24187 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24188 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24189 "you should think about replacing calls to this function with calls to L</add-"
24190 "drive-opts>, and specifying the format."
24195 #: ../fish/guestfish-actions.pod:91
24196 msgid "add-drive-opts"
24201 #: ../fish/guestfish-actions.pod:93
24207 #: ../fish/guestfish-actions.pod:95
24210 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
24216 #: ../fish/guestfish-actions.pod:122
24218 "This forces the image format. If you omit this (or use L</add-drive> or L</"
24219 "add-drive-ro>) then the format is automatically detected. Possible formats "
24220 "include C<raw> and C<qcow2>."
24225 #: ../fish/guestfish-actions.pod:133
24227 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
24228 "add-drive-with-if> call (q.v.)"
24233 #: ../fish/guestfish-actions.pod:140
24234 msgid "add-drive-ro"
24239 #: ../fish/guestfish-actions.pod:142
24245 #: ../fish/guestfish-actions.pod:144
24248 " add-drive-ro filename\n"
24254 #: ../fish/guestfish-actions.pod:146
24256 "This function is the equivalent of calling L</add-drive-opts> with the "
24257 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
24258 "is added read-only, with the format being detected automatically."
24263 #: ../fish/guestfish-actions.pod:151
24264 msgid "add-drive-ro-with-if"
24269 #: ../fish/guestfish-actions.pod:153
24272 " add-drive-ro-with-if filename iface\n"
24278 #: ../fish/guestfish-actions.pod:155
24280 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
24281 "interface emulation to use at run time."
24286 #: ../fish/guestfish-actions.pod:165
24287 msgid "add-drive-with-if"
24292 #: ../fish/guestfish-actions.pod:167
24295 " add-drive-with-if filename iface\n"
24301 #: ../fish/guestfish-actions.pod:169
24303 "This is the same as L</add-drive> but it allows you to specify the QEMU "
24304 "interface emulation to use at run time."
24309 #: ../fish/guestfish-actions.pod:179
24315 #: ../fish/guestfish-actions.pod:181
24318 " aug-clear augpath\n"
24324 #: ../fish/guestfish-actions.pod:186
24330 #: ../fish/guestfish-actions.pod:188
24339 #: ../fish/guestfish-actions.pod:190
24341 "Close the current Augeas handle and free up any resources used by it. After "
24342 "calling this, you have to call L</aug-init> again before you can use any "
24343 "other Augeas functions."
24348 #: ../fish/guestfish-actions.pod:195
24349 msgid "aug-defnode"
24354 #: ../fish/guestfish-actions.pod:197
24357 " aug-defnode name expr val\n"
24363 #: ../fish/guestfish-actions.pod:202
24365 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24366 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
24367 "containing that single node."
24372 #: ../fish/guestfish-actions.pod:210
24378 #: ../fish/guestfish-actions.pod:212
24381 " aug-defvar name expr\n"
24387 #: ../fish/guestfish-actions.pod:221
24393 #: ../fish/guestfish-actions.pod:223
24396 " aug-get augpath\n"
24402 #: ../fish/guestfish-actions.pod:228
24408 #: ../fish/guestfish-actions.pod:230
24411 " aug-init root flags\n"
24417 #: ../fish/guestfish-actions.pod:236
24418 msgid "You must call this before using any other L</aug-*> commands."
24423 #: ../fish/guestfish-actions.pod:271
24424 msgid "Do not load the tree in L</aug-init>."
24429 #: ../fish/guestfish-actions.pod:275
24430 msgid "To close the handle, you can call L</aug-close>."
24435 #: ../fish/guestfish-actions.pod:279
24441 #: ../fish/guestfish-actions.pod:281
24444 " aug-insert augpath label true|false\n"
24450 #: ../fish/guestfish-actions.pod:291
24456 #: ../fish/guestfish-actions.pod:293
24465 #: ../fish/guestfish-actions.pod:300
24471 #: ../fish/guestfish-actions.pod:302
24474 " aug-ls augpath\n"
24480 #: ../fish/guestfish-actions.pod:304
24482 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
24483 "resulting nodes into alphabetical order."
24488 #: ../fish/guestfish-actions.pod:307
24494 #: ../fish/guestfish-actions.pod:309
24497 " aug-match augpath\n"
24503 #: ../fish/guestfish-actions.pod:315
24509 #: ../fish/guestfish-actions.pod:317
24512 " aug-mv src dest\n"
24518 #: ../fish/guestfish-actions.pod:322
24524 #: ../fish/guestfish-actions.pod:324
24527 " aug-rm augpath\n"
24533 #: ../fish/guestfish-actions.pod:330
24539 #: ../fish/guestfish-actions.pod:332
24548 #: ../fish/guestfish-actions.pod:336
24550 "The flags which were passed to L</aug-init> affect exactly how files are "
24556 #: ../fish/guestfish-actions.pod:339
24562 #: ../fish/guestfish-actions.pod:341
24565 " aug-set augpath val\n"
24571 #: ../fish/guestfish-actions.pod:345
24573 "In the Augeas API, it is possible to clear a node by setting the value to "
24574 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24575 "this call. Instead you must use the L</aug-clear> call."
24580 #: ../fish/guestfish-actions.pod:350
24586 #: ../fish/guestfish-actions.pod:352
24589 " available 'groups ...'\n"
24595 #: ../fish/guestfish-actions.pod:358
24597 "The libguestfs groups, and the functions that those groups correspond to, "
24598 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24599 "runtime by calling L</available-all-groups>."
24604 #: ../fish/guestfish-actions.pod:382
24605 msgid "You must call L</launch> before calling this function."
24610 #: ../fish/guestfish-actions.pod:404
24612 "This call was added in version C<1.0.80>. In previous versions of "
24613 "libguestfs all you could do would be to speculatively execute a command to "
24614 "find out if the daemon implemented it. See also L</version>."
24619 #: ../fish/guestfish-actions.pod:411
24620 msgid "available-all-groups"
24625 #: ../fish/guestfish-actions.pod:413
24628 " available-all-groups\n"
24634 #: ../fish/guestfish-actions.pod:415
24636 "This command returns a list of all optional groups that this daemon knows "
24637 "about. Note this returns both supported and unsupported groups. To find "
24638 "out which ones the daemon can actually support you have to call L</"
24639 "available> on each member of the returned list."
24644 #: ../fish/guestfish-actions.pod:421
24645 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
24650 #: ../fish/guestfish-actions.pod:423
24656 #: ../fish/guestfish-actions.pod:425
24659 " base64-in (base64file|-) filename\n"
24665 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
24666 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
24667 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
24668 #: ../fish/guestfish-actions.pod:4379 ../fish/guestfish-actions.pod:4391
24669 #: ../fish/guestfish-actions.pod:4402 ../fish/guestfish-actions.pod:4413
24670 #: ../fish/guestfish-actions.pod:4465 ../fish/guestfish-actions.pod:4474
24671 #: ../fish/guestfish-actions.pod:4528 ../fish/guestfish-actions.pod:4551
24672 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
24677 #: ../fish/guestfish-actions.pod:432
24683 #: ../fish/guestfish-actions.pod:434
24686 " base64-out filename (base64file|-)\n"
24692 #: ../fish/guestfish-actions.pod:441
24693 msgid "blockdev-flushbufs"
24698 #: ../fish/guestfish-actions.pod:443
24701 " blockdev-flushbufs device\n"
24707 #: ../fish/guestfish-actions.pod:450
24708 msgid "blockdev-getbsz"
24713 #: ../fish/guestfish-actions.pod:452
24716 " blockdev-getbsz device\n"
24722 #: ../fish/guestfish-actions.pod:461
24723 msgid "blockdev-getro"
24728 #: ../fish/guestfish-actions.pod:463
24731 " blockdev-getro device\n"
24737 #: ../fish/guestfish-actions.pod:470
24738 msgid "blockdev-getsize64"
24743 #: ../fish/guestfish-actions.pod:472
24746 " blockdev-getsize64 device\n"
24752 #: ../fish/guestfish-actions.pod:476
24753 msgid "See also L</blockdev-getsz>."
24758 #: ../fish/guestfish-actions.pod:480
24759 msgid "blockdev-getss"
24764 #: ../fish/guestfish-actions.pod:482
24767 " blockdev-getss device\n"
24773 #: ../fish/guestfish-actions.pod:487
24775 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
24780 #: ../fish/guestfish-actions.pod:492
24781 msgid "blockdev-getsz"
24786 #: ../fish/guestfish-actions.pod:494
24789 " blockdev-getsz device\n"
24795 #: ../fish/guestfish-actions.pod:499
24797 "See also L</blockdev-getss> for the real sector size of the device, and L</"
24798 "blockdev-getsize64> for the more useful I<size in bytes>."
24803 #: ../fish/guestfish-actions.pod:505
24804 msgid "blockdev-rereadpt"
24809 #: ../fish/guestfish-actions.pod:507
24812 " blockdev-rereadpt device\n"
24818 #: ../fish/guestfish-actions.pod:513
24819 msgid "blockdev-setbsz"
24824 #: ../fish/guestfish-actions.pod:515
24827 " blockdev-setbsz device blocksize\n"
24833 #: ../fish/guestfish-actions.pod:524
24834 msgid "blockdev-setro"
24839 #: ../fish/guestfish-actions.pod:526
24842 " blockdev-setro device\n"
24848 #: ../fish/guestfish-actions.pod:532
24849 msgid "blockdev-setrw"
24854 #: ../fish/guestfish-actions.pod:534
24857 " blockdev-setrw device\n"
24863 #: ../fish/guestfish-actions.pod:540
24864 msgid "case-sensitive-path"
24869 #: ../fish/guestfish-actions.pod:542
24872 " case-sensitive-path path\n"
24878 #: ../fish/guestfish-actions.pod:566
24880 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
24881 "WINDOWS/system32\"> (the exact return value would depend on details of how "
24882 "the directories were originally created under Windows)."
24887 #: ../fish/guestfish-actions.pod:574
24888 msgid "See also L</realpath>."
24893 #: ../fish/guestfish-actions.pod:576
24899 #: ../fish/guestfish-actions.pod:578
24908 #: ../fish/guestfish-actions.pod:582
24910 "Note that this function cannot correctly handle binary files (specifically, "
24911 "files containing C<\\0> character which is treated as end of string). For "
24912 "those you need to use the L</read-file> or L</download> functions which have "
24913 "a more complex interface."
24918 #: ../fish/guestfish-actions.pod:590
24924 #: ../fish/guestfish-actions.pod:592
24927 " checksum csumtype path\n"
24933 #: ../fish/guestfish-actions.pod:635
24934 msgid "To get the checksum for a device, use L</checksum-device>."
24939 #: ../fish/guestfish-actions.pod:637
24940 msgid "To get the checksums for many files, use L</checksums-out>."
24945 #: ../fish/guestfish-actions.pod:639
24946 msgid "checksum-device"
24951 #: ../fish/guestfish-actions.pod:641
24954 " checksum-device csumtype device\n"
24960 #: ../fish/guestfish-actions.pod:643
24962 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
24963 "device named C<device>. For the types of checksums supported see the L</"
24964 "checksum> command."
24969 #: ../fish/guestfish-actions.pod:647
24970 msgid "checksums-out"
24975 #: ../fish/guestfish-actions.pod:649
24978 " checksums-out csumtype directory (sumsfile|-)\n"
24984 #: ../fish/guestfish-actions.pod:665
24990 #: ../fish/guestfish-actions.pod:667
24993 " chmod mode path\n"
24999 #: ../fish/guestfish-actions.pod:678
25005 #: ../fish/guestfish-actions.pod:680
25008 " chown owner group path\n"
25014 #: ../fish/guestfish-actions.pod:688
25020 #: ../fish/guestfish-actions.pod:690
25023 " command 'arguments ...'\n"
25029 #: ../fish/guestfish-actions.pod:697
25031 "The single parameter is an argv-style list of arguments. The first element "
25032 "is the name of the program to run. Subsequent elements are parameters. The "
25033 "list must be non-empty (ie. must contain a program name). Note that the "
25034 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
25039 #: ../fish/guestfish-actions.pod:725
25040 msgid "command-lines"
25045 #: ../fish/guestfish-actions.pod:727
25048 " command-lines 'arguments ...'\n"
25054 #: ../fish/guestfish-actions.pod:729
25056 "This is the same as L</command>, but splits the result into a list of lines."
25061 #: ../fish/guestfish-actions.pod:732
25062 msgid "See also: L</sh-lines>"
25067 #: ../fish/guestfish-actions.pod:737
25073 #: ../fish/guestfish-actions.pod:739
25076 " config qemuparam qemuvalue\n"
25082 #: ../fish/guestfish-actions.pod:750
25088 #: ../fish/guestfish-actions.pod:752
25091 " copy-size src dest size\n"
25097 #: ../fish/guestfish-actions.pod:760
25103 #: ../fish/guestfish-actions.pod:762
25112 #: ../fish/guestfish-actions.pod:767
25118 #: ../fish/guestfish-actions.pod:769
25127 #: ../fish/guestfish-actions.pod:774
25133 #: ../fish/guestfish-actions.pod:776
25142 #: ../fish/guestfish-actions.pod:783
25144 "If the destination is a device, it must be as large or larger than the "
25145 "source file or device, otherwise the copy will fail. This command cannot do "
25146 "partial copies (see L</copy-size>)."
25151 #: ../fish/guestfish-actions.pod:787
25157 #: ../fish/guestfish-actions.pod:789
25166 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
25168 "This command is mostly useful for interactive sessions. It is I<not> "
25169 "intended that you try to parse the output string. Use L</statvfs> from "
25175 #: ../fish/guestfish-actions.pod:797
25181 #: ../fish/guestfish-actions.pod:799
25190 #: ../fish/guestfish-actions.pod:808
25196 #: ../fish/guestfish-actions.pod:810
25205 #: ../fish/guestfish-actions.pod:816
25207 "Another way to get the same information is to enable verbose messages with "
25208 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
25209 "before running the program."
25214 #: ../fish/guestfish-actions.pod:821
25220 #: ../fish/guestfish-actions.pod:823
25223 " download remotefilename (filename|-)\n"
25229 #: ../fish/guestfish-actions.pod:830
25230 msgid "See also L</upload>, L</cat>."
25235 #: ../fish/guestfish-actions.pod:834
25236 msgid "download-offset"
25241 #: ../fish/guestfish-actions.pod:836
25244 " download-offset remotefilename (filename|-) offset size\n"
25250 #: ../fish/guestfish-actions.pod:844
25252 "Note that there is no limit on the amount of data that can be downloaded "
25253 "with this call, unlike with L</pread>, and this call always reads the full "
25254 "amount unless an error occurs."
25259 #: ../fish/guestfish-actions.pod:849
25260 msgid "See also L</download>, L</pread>."
25265 #: ../fish/guestfish-actions.pod:853
25266 msgid "drop-caches"
25271 #: ../fish/guestfish-actions.pod:855
25274 " drop-caches whattodrop\n"
25280 #: ../fish/guestfish-actions.pod:867
25286 #: ../fish/guestfish-actions.pod:869
25295 #: ../fish/guestfish-actions.pod:881
25301 #: ../fish/guestfish-actions.pod:883
25304 " e2fsck-f device\n"
25310 #: ../fish/guestfish-actions.pod:889
25312 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
25313 "should use L</fsck>."
25318 #: ../fish/guestfish-actions.pod:892
25319 msgid "echo-daemon"
25324 #: ../fish/guestfish-actions.pod:894
25327 " echo-daemon 'words ...'\n"
25333 #: ../fish/guestfish-actions.pod:901
25334 msgid "See also L</ping-daemon>."
25339 #: ../fish/guestfish-actions.pod:903
25345 #: ../fish/guestfish-actions.pod:905
25348 " egrep regex path\n"
25354 #: ../fish/guestfish-actions.pod:913
25360 #: ../fish/guestfish-actions.pod:915
25363 " egrepi regex path\n"
25369 #: ../fish/guestfish-actions.pod:923
25375 #: ../fish/guestfish-actions.pod:925
25378 " equal file1 file2\n"
25384 #: ../fish/guestfish-actions.pod:932
25390 #: ../fish/guestfish-actions.pod:934
25399 #: ../fish/guestfish-actions.pod:939
25400 msgid "See also L</is-file>, L</is-dir>, L</stat>."
25405 #: ../fish/guestfish-actions.pod:941
25411 #: ../fish/guestfish-actions.pod:943
25414 " fallocate path len\n"
25420 #: ../fish/guestfish-actions.pod:960
25421 msgid "fallocate64"
25426 #: ../fish/guestfish-actions.pod:962
25429 " fallocate64 path len\n"
25435 #: ../fish/guestfish-actions.pod:968
25437 "Note that this call allocates disk blocks for the file. To create a sparse "
25438 "file use L</truncate-size> instead."
25443 #: ../fish/guestfish-actions.pod:971
25445 "The deprecated call L</fallocate> does the same, but owing to an oversight "
25446 "it only allowed 30 bit lengths to be specified, effectively limiting the "
25447 "maximum size of files created through that call to 1GB."
25452 #: ../fish/guestfish-actions.pod:980
25458 #: ../fish/guestfish-actions.pod:982
25461 " fgrep pattern path\n"
25467 #: ../fish/guestfish-actions.pod:990
25473 #: ../fish/guestfish-actions.pod:992
25476 " fgrepi pattern path\n"
25482 #: ../fish/guestfish-actions.pod:1000
25488 #: ../fish/guestfish-actions.pod:1002
25497 #: ../fish/guestfish-actions.pod:1014
25499 "This command can also be used on C</dev/> devices (and partitions, LV "
25500 "names). You can for example use this to determine if a device contains a "
25501 "filesystem, although it's usually better to use L</vfs-type>."
25506 #: ../fish/guestfish-actions.pod:1024
25507 msgid "file-architecture"
25512 #: ../fish/guestfish-actions.pod:1026
25515 " file-architecture filename\n"
25521 #: ../fish/guestfish-actions.pod:1129
25527 #: ../fish/guestfish-actions.pod:1131
25536 #: ../fish/guestfish-actions.pod:1135
25538 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
25539 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
25544 #: ../fish/guestfish-actions.pod:1139
25550 #: ../fish/guestfish-actions.pod:1141
25553 " fill c len path\n"
25559 #: ../fish/guestfish-actions.pod:1147
25561 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
25562 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
25563 "L</fill-pattern>."
25568 #: ../fish/guestfish-actions.pod:1152
25569 msgid "fill-pattern"
25574 #: ../fish/guestfish-actions.pod:1154
25577 " fill-pattern pattern len path\n"
25583 #: ../fish/guestfish-actions.pod:1156
25585 "This function is like L</fill> except that it creates a new file of length "
25586 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
25587 "is truncated if necessary to ensure the length of the file is exactly C<len> "
25593 #: ../fish/guestfish-actions.pod:1161
25599 #: ../fish/guestfish-actions.pod:1163
25602 " find directory\n"
25608 #: ../fish/guestfish-actions.pod:1177
25609 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
25614 #: ../fish/guestfish-actions.pod:1190
25615 msgid "See also L</find0>."
25620 #: ../fish/guestfish-actions.pod:1195
25626 #: ../fish/guestfish-actions.pod:1197
25629 " find0 directory (files|-)\n"
25635 #: ../fish/guestfish-actions.pod:1203
25637 "This command works the same way as L</find> with the following exceptions:"
25642 #: ../fish/guestfish-actions.pod:1230
25643 msgid "findfs-label"
25648 #: ../fish/guestfish-actions.pod:1232
25651 " findfs-label label\n"
25657 #: ../fish/guestfish-actions.pod:1238
25658 msgid "To find the label of a filesystem, use L</vfs-label>."
25663 #: ../fish/guestfish-actions.pod:1240
25664 msgid "findfs-uuid"
25669 #: ../fish/guestfish-actions.pod:1242
25672 " findfs-uuid uuid\n"
25678 #: ../fish/guestfish-actions.pod:1248
25679 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
25684 #: ../fish/guestfish-actions.pod:1250
25690 #: ../fish/guestfish-actions.pod:1252
25693 " fsck fstype device\n"
25699 #: ../fish/guestfish-actions.pod:1282
25705 #: ../fish/guestfish-actions.pod:1284
25713 #: ../fish/guestfish-actions.pod:1291
25714 msgid "get-attach-method"
25718 #: ../fish/guestfish-actions.pod:1293
25721 " get-attach-method\n"
25726 #: ../fish/guestfish-actions.pod:1295
25727 msgid "Return the current attach method. See L</set-attach-method>."
25732 #: ../fish/guestfish-actions.pod:1297
25733 msgid "get-autosync"
25738 #: ../fish/guestfish-actions.pod:1299
25747 #: ../fish/guestfish-actions.pod:1303
25753 #: ../fish/guestfish-actions.pod:1305
25762 #: ../fish/guestfish-actions.pod:1309
25763 msgid "get-e2label"
25768 #: ../fish/guestfish-actions.pod:1311
25771 " get-e2label device\n"
25777 #: ../fish/guestfish-actions.pod:1323
25783 #: ../fish/guestfish-actions.pod:1325
25786 " get-e2uuid device\n"
25792 #: ../fish/guestfish-actions.pod:1337
25793 msgid "get-memsize"
25798 #: ../fish/guestfish-actions.pod:1339
25807 #: ../fish/guestfish-actions.pod:1344
25809 "If L</set-memsize> was not called on this handle, and if "
25810 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
25811 "value for memsize."
25816 #: ../fish/guestfish-actions.pod:1351
25817 msgid "get-network"
25822 #: ../fish/guestfish-actions.pod:1353
25831 #: ../fish/guestfish-actions.pod:1357
25837 #: ../fish/guestfish-actions.pod:1359
25846 #: ../fish/guestfish-actions.pod:1366
25852 #: ../fish/guestfish-actions.pod:1368
25858 #: ../fish/guestfish-actions.pod:1370
25867 #: ../fish/guestfish-actions.pod:1377
25873 #: ../fish/guestfish-actions.pod:1379
25882 #: ../fish/guestfish-actions.pod:1386
25883 msgid "get-recovery-proc"
25888 #: ../fish/guestfish-actions.pod:1388
25891 " get-recovery-proc\n"
25897 #: ../fish/guestfish-actions.pod:1392
25898 msgid "get-selinux"
25903 #: ../fish/guestfish-actions.pod:1394
25912 #: ../fish/guestfish-actions.pod:1396
25914 "This returns the current setting of the selinux flag which is passed to the "
25915 "appliance at boot time. See L</set-selinux>."
25920 #: ../fish/guestfish-actions.pod:1402
25926 #: ../fish/guestfish-actions.pod:1404
25935 #: ../fish/guestfish-actions.pod:1411
25941 #: ../fish/guestfish-actions.pod:1413
25950 #: ../fish/guestfish-actions.pod:1417
25956 #: ../fish/guestfish-actions.pod:1419
25965 #: ../fish/guestfish-actions.pod:1421
25967 "Return the current umask. By default the umask is C<022> unless it has been "
25968 "set by calling L</umask>."
25973 #: ../fish/guestfish-actions.pod:1424
25974 msgid "get-verbose"
25979 #: ../fish/guestfish-actions.pod:1426
25988 #: ../fish/guestfish-actions.pod:1430
25994 #: ../fish/guestfish-actions.pod:1432
26003 #: ../fish/guestfish-actions.pod:1436
26004 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
26009 #: ../fish/guestfish-actions.pod:1439
26015 #: ../fish/guestfish-actions.pod:1441
26018 " getxattr path name\n"
26024 #: ../fish/guestfish-actions.pod:1443
26026 "Get a single extended attribute from file C<path> named C<name>. This call "
26027 "follows symlinks. If you want to lookup an extended attribute for the "
26028 "symlink itself, use L</lgetxattr>."
26033 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2387
26035 "Normally it is better to get all extended attributes from a file in one go "
26036 "by calling L</getxattrs>. However some Linux filesystem implementations are "
26037 "buggy and do not provide a way to list out attributes. For these "
26038 "filesystems (notably ntfs-3g) you have to know the names of the extended "
26039 "attributes you want in advance and call this function."
26044 #: ../fish/guestfish-actions.pod:1457
26045 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
26050 #: ../fish/guestfish-actions.pod:1459
26056 #: ../fish/guestfish-actions.pod:1461
26059 " getxattrs path\n"
26065 #: ../fish/guestfish-actions.pod:1469
26066 msgid "See also: L</lgetxattrs>, L<attr(5)>."
26071 #: ../fish/guestfish-actions.pod:1471
26072 msgid "glob-expand"
26077 #: ../fish/guestfish-actions.pod:1473
26080 " glob-expand pattern\n"
26086 #: ../fish/guestfish-actions.pod:1486
26092 #: ../fish/guestfish-actions.pod:1488
26095 " grep regex path\n"
26101 #: ../fish/guestfish-actions.pod:1496
26107 #: ../fish/guestfish-actions.pod:1498
26110 " grepi regex path\n"
26116 #: ../fish/guestfish-actions.pod:1506
26117 msgid "grub-install"
26122 #: ../fish/guestfish-actions.pod:1508
26125 " grub-install root device\n"
26131 #: ../fish/guestfish-actions.pod:1524
26137 #: ../fish/guestfish-actions.pod:1526
26146 #: ../fish/guestfish-actions.pod:1534
26152 #: ../fish/guestfish-actions.pod:1536
26155 " head-n nrlines path\n"
26161 #: ../fish/guestfish-actions.pod:1549
26167 #: ../fish/guestfish-actions.pod:1551
26176 #: ../fish/guestfish-actions.pod:1559
26182 #: ../fish/guestfish-actions.pod:1561
26185 " initrd-cat initrdpath filename\n"
26191 #: ../fish/guestfish-actions.pod:1573
26192 msgid "See also L</initrd-list>."
26197 #: ../fish/guestfish-actions.pod:1578
26198 msgid "initrd-list"
26203 #: ../fish/guestfish-actions.pod:1580
26206 " initrd-list path\n"
26212 #: ../fish/guestfish-actions.pod:1592
26213 msgid "inotify-add-watch"
26218 #: ../fish/guestfish-actions.pod:1594
26221 " inotify-add-watch path mask\n"
26227 #: ../fish/guestfish-actions.pod:1606
26228 msgid "inotify-close"
26233 #: ../fish/guestfish-actions.pod:1608
26242 #: ../fish/guestfish-actions.pod:1614
26243 msgid "inotify-files"
26248 #: ../fish/guestfish-actions.pod:1616
26257 #: ../fish/guestfish-actions.pod:1618
26259 "This function is a helpful wrapper around L</inotify-read> which just "
26260 "returns a list of pathnames of objects that were touched. The returned "
26261 "pathnames are sorted and deduplicated."
26266 #: ../fish/guestfish-actions.pod:1622
26267 msgid "inotify-init"
26272 #: ../fish/guestfish-actions.pod:1624
26275 " inotify-init maxevents\n"
26281 #: ../fish/guestfish-actions.pod:1630
26283 "C<maxevents> is the maximum number of events which will be queued up between "
26284 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
26285 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
26286 "default was 16384 events. Beyond this limit, the kernel throws away events, "
26287 "but records the fact that it threw them away by setting a flag "
26288 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
26293 #: ../fish/guestfish-actions.pod:1640
26295 "Before any events are generated, you have to add some watches to the "
26296 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
26297 "L</inotify-watch-all>."
26302 #: ../fish/guestfish-actions.pod:1646
26304 "Queued up events should be read periodically by calling L</inotify-read> (or "
26305 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
26306 "If you don't read the events out often enough then you risk the internal "
26307 "queue overflowing."
26312 #: ../fish/guestfish-actions.pod:1653
26314 "The handle should be closed after use by calling L</inotify-close>. This "
26315 "also removes any watches automatically."
26320 #: ../fish/guestfish-actions.pod:1662
26321 msgid "inotify-read"
26326 #: ../fish/guestfish-actions.pod:1664
26335 #: ../fish/guestfish-actions.pod:1677
26336 msgid "inotify-rm-watch"
26341 #: ../fish/guestfish-actions.pod:1679
26344 " inotify-rm-watch wd\n"
26350 #: ../fish/guestfish-actions.pod:1681
26351 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
26356 #: ../fish/guestfish-actions.pod:1684
26357 msgid "inspect-get-arch"
26362 #: ../fish/guestfish-actions.pod:1686
26365 " inspect-get-arch root\n"
26371 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
26372 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1800
26373 #: ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1849
26374 #: ../fish/guestfish-actions.pod:1870 ../fish/guestfish-actions.pod:1885
26375 #: ../fish/guestfish-actions.pod:1912 ../fish/guestfish-actions.pod:1934
26376 #: ../fish/guestfish-actions.pod:1958 ../fish/guestfish-actions.pod:1975
26377 #: ../fish/guestfish-actions.pod:2018 ../fish/guestfish-actions.pod:2053
26378 #: ../fish/guestfish-actions.pod:2069 ../fish/guestfish-actions.pod:2082
26379 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2110
26381 "This function should only be called with a root device string as returned by "
26387 #: ../fish/guestfish-actions.pod:1691
26389 "This returns the architecture of the inspected operating system. The "
26390 "possible return values are listed under L</file-architecture>."
26395 #: ../fish/guestfish-actions.pod:1700
26396 msgid "inspect-get-distro"
26401 #: ../fish/guestfish-actions.pod:1702
26404 " inspect-get-distro root\n"
26410 #: ../fish/guestfish-actions.pod:1778
26411 msgid "inspect-get-filesystems"
26416 #: ../fish/guestfish-actions.pod:1780
26419 " inspect-get-filesystems root\n"
26425 #: ../fish/guestfish-actions.pod:1793
26427 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26428 "get-mountpoints>."
26432 #: ../fish/guestfish-actions.pod:1796
26433 msgid "inspect-get-format"
26437 #: ../fish/guestfish-actions.pod:1798
26440 " inspect-get-format root\n"
26446 #: ../fish/guestfish-actions.pod:1830
26447 msgid "inspect-get-hostname"
26452 #: ../fish/guestfish-actions.pod:1832
26455 " inspect-get-hostname root\n"
26461 #: ../fish/guestfish-actions.pod:1845
26462 msgid "inspect-get-major-version"
26467 #: ../fish/guestfish-actions.pod:1847
26470 " inspect-get-major-version root\n"
26476 #: ../fish/guestfish-actions.pod:1866
26477 msgid "inspect-get-minor-version"
26482 #: ../fish/guestfish-actions.pod:1868
26485 " inspect-get-minor-version root\n"
26491 #: ../fish/guestfish-actions.pod:1878
26493 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26494 "get-major-version>."
26499 #: ../fish/guestfish-actions.pod:1881
26500 msgid "inspect-get-mountpoints"
26505 #: ../fish/guestfish-actions.pod:1883
26508 " inspect-get-mountpoints root\n"
26514 #: ../fish/guestfish-actions.pod:1905
26516 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26517 "get-filesystems>."
26522 #: ../fish/guestfish-actions.pod:1908
26523 msgid "inspect-get-package-format"
26528 #: ../fish/guestfish-actions.pod:1910
26531 " inspect-get-package-format root\n"
26537 #: ../fish/guestfish-actions.pod:1915
26539 "This function and L</inspect-get-package-management> return the package "
26540 "format and package management tool used by the inspected operating system. "
26541 "For example for Fedora these functions would return C<rpm> (package format) "
26542 "and C<yum> (package management)."
26547 #: ../fish/guestfish-actions.pod:1930
26548 msgid "inspect-get-package-management"
26553 #: ../fish/guestfish-actions.pod:1932
26556 " inspect-get-package-management root\n"
26562 #: ../fish/guestfish-actions.pod:1937
26564 "L</inspect-get-package-format> and this function return the package format "
26565 "and package management tool used by the inspected operating system. For "
26566 "example for Fedora these functions would return C<rpm> (package format) and "
26567 "C<yum> (package management)."
26572 #: ../fish/guestfish-actions.pod:1954
26573 msgid "inspect-get-product-name"
26578 #: ../fish/guestfish-actions.pod:1956
26581 " inspect-get-product-name root\n"
26586 #: ../fish/guestfish-actions.pod:1971
26587 msgid "inspect-get-product-variant"
26591 #: ../fish/guestfish-actions.pod:1973
26594 " inspect-get-product-variant root\n"
26599 #: ../fish/guestfish-actions.pod:1997
26601 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
26602 "get-product-name>, L</inspect-get-major-version>."
26607 #: ../fish/guestfish-actions.pod:2001
26608 msgid "inspect-get-roots"
26613 #: ../fish/guestfish-actions.pod:2003
26616 " inspect-get-roots\n"
26622 #: ../fish/guestfish-actions.pod:2005
26624 "This function is a convenient way to get the list of root devices, as "
26625 "returned from a previous call to L</inspect-os>, but without redoing the "
26626 "whole inspection process."
26631 #: ../fish/guestfish-actions.pod:2009
26633 "This returns an empty list if either no root devices were found or the "
26634 "caller has not called L</inspect-os>."
26639 #: ../fish/guestfish-actions.pod:2014
26640 msgid "inspect-get-type"
26645 #: ../fish/guestfish-actions.pod:2016
26648 " inspect-get-type root\n"
26654 #: ../fish/guestfish-actions.pod:2049
26655 msgid "inspect-get-windows-systemroot"
26660 #: ../fish/guestfish-actions.pod:2051
26663 " inspect-get-windows-systemroot root\n"
26668 #: ../fish/guestfish-actions.pod:2065
26669 msgid "inspect-is-live"
26673 #: ../fish/guestfish-actions.pod:2067
26676 " inspect-is-live root\n"
26681 #: ../fish/guestfish-actions.pod:2072
26683 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26684 "then this returns true if a live image was detected on the disk."
26688 #: ../fish/guestfish-actions.pod:2078
26689 msgid "inspect-is-multipart"
26693 #: ../fish/guestfish-actions.pod:2080
26696 " inspect-is-multipart root\n"
26701 #: ../fish/guestfish-actions.pod:2085
26703 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26704 "then this returns true if the disk is part of a set."
26708 #: ../fish/guestfish-actions.pod:2091
26709 msgid "inspect-is-netinst"
26713 #: ../fish/guestfish-actions.pod:2093
26716 " inspect-is-netinst root\n"
26721 #: ../fish/guestfish-actions.pod:2098
26723 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
26724 "then this returns true if the disk is a network installer, ie. not a self-"
26725 "contained install CD but one which is likely to require network access to "
26726 "complete the install."
26731 #: ../fish/guestfish-actions.pod:2106
26732 msgid "inspect-list-applications"
26737 #: ../fish/guestfish-actions.pod:2108
26740 " inspect-list-applications root\n"
26746 #: ../fish/guestfish-actions.pod:2115
26748 "I<Note:> This call works differently from other parts of the inspection "
26749 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
26750 "then mount up the disks, before calling this. Listing applications is a "
26751 "significantly more difficult operation which requires access to the full "
26752 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
26753 "are just returning data cached in the libguestfs handle, this call actually "
26754 "reads parts of the mounted filesystems during the call."
26759 #: ../fish/guestfish-actions.pod:2205
26765 #: ../fish/guestfish-actions.pod:2207
26774 #: ../fish/guestfish-actions.pod:2222
26776 "You can pass the root string(s) returned to other L</inspect-get-*> "
26777 "functions in order to query further information about each operating system, "
26778 "such as the name and version."
26783 #: ../fish/guestfish-actions.pod:2227
26785 "This function uses other libguestfs features such as L</mount-ro> and L</"
26786 "umount-all> in order to mount and unmount filesystems and look at the "
26787 "contents. This should be called with no disks currently mounted. The "
26788 "function may also use Augeas, so any existing Augeas handle will be closed."
26793 #: ../fish/guestfish-actions.pod:2239 ../fish/guestfish-actions.pod:2415
26794 #: ../fish/guestfish-actions.pod:2461
26795 msgid "See also L</list-filesystems>."
26800 #: ../fish/guestfish-actions.pod:2241
26801 msgid "is-blockdev"
26806 #: ../fish/guestfish-actions.pod:2243
26809 " is-blockdev path\n"
26815 #: ../fish/guestfish-actions.pod:2248 ../fish/guestfish-actions.pod:2266
26816 #: ../fish/guestfish-actions.pod:2285 ../fish/guestfish-actions.pod:2294
26817 #: ../fish/guestfish-actions.pod:2304 ../fish/guestfish-actions.pod:2338
26818 #: ../fish/guestfish-actions.pod:2347
26819 msgid "See also L</stat>."
26824 #: ../fish/guestfish-actions.pod:2250
26830 #: ../fish/guestfish-actions.pod:2252
26839 #: ../fish/guestfish-actions.pod:2259
26845 #: ../fish/guestfish-actions.pod:2261
26848 " is-chardev path\n"
26854 #: ../fish/guestfish-actions.pod:2268
26860 #: ../fish/guestfish-actions.pod:2270
26869 #: ../fish/guestfish-actions.pod:2277
26875 #: ../fish/guestfish-actions.pod:2279
26884 #: ../fish/guestfish-actions.pod:2287
26890 #: ../fish/guestfish-actions.pod:2289
26899 #: ../fish/guestfish-actions.pod:2296
26905 #: ../fish/guestfish-actions.pod:2298
26914 #: ../fish/guestfish-actions.pod:2306
26915 msgid "is-launching"
26920 #: ../fish/guestfish-actions.pod:2308
26929 #: ../fish/guestfish-actions.pod:2315
26935 #: ../fish/guestfish-actions.pod:2317
26944 #: ../fish/guestfish-actions.pod:2322
26950 #: ../fish/guestfish-actions.pod:2324
26959 #: ../fish/guestfish-actions.pod:2331
26965 #: ../fish/guestfish-actions.pod:2333
26968 " is-socket path\n"
26974 #: ../fish/guestfish-actions.pod:2340
26980 #: ../fish/guestfish-actions.pod:2342
26983 " is-symlink path\n"
26989 #: ../fish/guestfish-actions.pod:2349
26990 msgid "kill-subprocess"
26995 #: ../fish/guestfish-actions.pod:2351
26998 " kill-subprocess\n"
27004 #: ../fish/guestfish-actions.pod:2355
27010 #: ../fish/guestfish-actions.pod:2357
27016 #: ../fish/guestfish-actions.pod:2359
27025 #: ../fish/guestfish-actions.pod:2367
27031 #: ../fish/guestfish-actions.pod:2369
27034 " lchown owner group path\n"
27040 #: ../fish/guestfish-actions.pod:2371
27042 "Change the file owner to C<owner> and group to C<group>. This is like L</"
27043 "chown> but if C<path> is a symlink then the link itself is changed, not the "
27049 #: ../fish/guestfish-actions.pod:2379
27055 #: ../fish/guestfish-actions.pod:2381
27058 " lgetxattr path name\n"
27064 #: ../fish/guestfish-actions.pod:2397
27065 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
27070 #: ../fish/guestfish-actions.pod:2399
27076 #: ../fish/guestfish-actions.pod:2401
27079 " lgetxattrs path\n"
27085 #: ../fish/guestfish-actions.pod:2403
27087 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
27088 "it returns the extended attributes of the link itself."
27093 #: ../fish/guestfish-actions.pod:2407
27094 msgid "list-devices"
27099 #: ../fish/guestfish-actions.pod:2409
27108 #: ../fish/guestfish-actions.pod:2417
27109 msgid "list-filesystems"
27114 #: ../fish/guestfish-actions.pod:2419
27117 " list-filesystems\n"
27123 #: ../fish/guestfish-actions.pod:2438
27125 "This command runs other libguestfs commands, which might include L</mount> "
27126 "and L</umount>, and therefore you should use this soon after launch and only "
27127 "when nothing is mounted."
27132 #: ../fish/guestfish-actions.pod:2442
27134 "Not all of the filesystems returned will be mountable. In particular, swap "
27135 "partitions are returned in the list. Also this command does not check that "
27136 "each filesystem found is valid and mountable, and some filesystems might be "
27137 "mountable but require special options. Filesystems may not all belong to a "
27138 "single logical operating system (use L</inspect-os> to look for OSes)."
27143 #: ../fish/guestfish-actions.pod:2450
27144 msgid "list-partitions"
27149 #: ../fish/guestfish-actions.pod:2452
27152 " list-partitions\n"
27158 #: ../fish/guestfish-actions.pod:2458
27160 "This does not return logical volumes. For that you will need to call L</"
27166 #: ../fish/guestfish-actions.pod:2463
27172 #: ../fish/guestfish-actions.pod:2465
27181 #: ../fish/guestfish-actions.pod:2473
27187 #: ../fish/guestfish-actions.pod:2475
27190 " ln target linkname\n"
27196 #: ../fish/guestfish-actions.pod:2479
27202 #: ../fish/guestfish-actions.pod:2481
27205 " ln-f target linkname\n"
27211 #: ../fish/guestfish-actions.pod:2486
27217 #: ../fish/guestfish-actions.pod:2488
27220 " ln-s target linkname\n"
27226 #: ../fish/guestfish-actions.pod:2492
27232 #: ../fish/guestfish-actions.pod:2494
27235 " ln-sf target linkname\n"
27241 #: ../fish/guestfish-actions.pod:2499
27242 msgid "lremovexattr"
27247 #: ../fish/guestfish-actions.pod:2501
27250 " lremovexattr xattr path\n"
27256 #: ../fish/guestfish-actions.pod:2503
27258 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
27259 "it removes an extended attribute of the link itself."
27264 #: ../fish/guestfish-actions.pod:2507
27270 #: ../fish/guestfish-actions.pod:2509
27279 #: ../fish/guestfish-actions.pod:2515
27281 "This command is mostly useful for interactive sessions. Programs should "
27282 "probably use L</readdir> instead."
27287 #: ../fish/guestfish-actions.pod:2518
27293 #: ../fish/guestfish-actions.pod:2520
27296 " lsetxattr xattr val vallen path\n"
27302 #: ../fish/guestfish-actions.pod:2522
27304 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
27305 "sets an extended attribute of the link itself."
27310 #: ../fish/guestfish-actions.pod:2526
27316 #: ../fish/guestfish-actions.pod:2528
27325 #: ../fish/guestfish-actions.pod:2532
27327 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
27328 "the link is stat-ed, not the file it refers to."
27333 #: ../fish/guestfish-actions.pod:2538
27339 #: ../fish/guestfish-actions.pod:2540
27342 " lstatlist path 'names ...'\n"
27348 #: ../fish/guestfish-actions.pod:2542
27350 "This call allows you to perform the L</lstat> operation on multiple files, "
27351 "where all files are in the directory C<path>. C<names> is the list of files "
27352 "from this directory."
27357 #: ../fish/guestfish-actions.pod:2551
27359 "This call is intended for programs that want to efficiently list a directory "
27360 "contents without making many round-trips. See also L</lxattrlist> for a "
27361 "similarly efficient call for getting extended attributes. Very long "
27362 "directory listings might cause the protocol message size to be exceeded, "
27363 "causing this call to fail. The caller must split up such requests into "
27364 "smaller groups of names."
27369 #: ../fish/guestfish-actions.pod:2559
27370 msgid "luks-add-key"
27375 #: ../fish/guestfish-actions.pod:2561
27378 " luks-add-key device keyslot\n"
27384 #: ../fish/guestfish-actions.pod:2568
27386 "Note that if C<keyslot> already contains a key, then this command will "
27387 "fail. You have to use L</luks-kill-slot> first to remove that key."
27392 #: ../fish/guestfish-actions.pod:2572 ../fish/guestfish-actions.pod:2594
27393 #: ../fish/guestfish-actions.pod:2607 ../fish/guestfish-actions.pod:2621
27394 #: ../fish/guestfish-actions.pod:2644 ../fish/guestfish-actions.pod:2654
27396 "This command has one or more key or passphrase parameters. Guestfish will "
27397 "prompt for these separately."
27402 #: ../fish/guestfish-actions.pod:2575
27408 #: ../fish/guestfish-actions.pod:2577
27411 " luks-close device\n"
27417 #: ../fish/guestfish-actions.pod:2579
27419 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
27420 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
27421 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
27427 #: ../fish/guestfish-actions.pod:2585
27428 msgid "luks-format"
27433 #: ../fish/guestfish-actions.pod:2587
27436 " luks-format device keyslot\n"
27442 #: ../fish/guestfish-actions.pod:2600
27443 msgid "luks-format-cipher"
27448 #: ../fish/guestfish-actions.pod:2602
27451 " luks-format-cipher device keyslot cipher\n"
27457 #: ../fish/guestfish-actions.pod:2604
27459 "This command is the same as L</luks-format> but it also allows you to set "
27460 "the C<cipher> used."
27465 #: ../fish/guestfish-actions.pod:2613
27466 msgid "luks-kill-slot"
27471 #: ../fish/guestfish-actions.pod:2615
27474 " luks-kill-slot device keyslot\n"
27480 #: ../fish/guestfish-actions.pod:2624
27486 #: ../fish/guestfish-actions.pod:2626
27489 " luks-open device mapname\n"
27495 #: ../fish/guestfish-actions.pod:2640
27497 "If this block device contains LVM volume groups, then calling L</vgscan> "
27498 "followed by L</vg-activate-all> will make them visible."
27503 #: ../fish/guestfish-actions.pod:2647
27504 msgid "luks-open-ro"
27509 #: ../fish/guestfish-actions.pod:2649
27512 " luks-open-ro device mapname\n"
27518 #: ../fish/guestfish-actions.pod:2651
27520 "This is the same as L</luks-open> except that a read-only mapping is created."
27525 #: ../fish/guestfish-actions.pod:2657
27531 #: ../fish/guestfish-actions.pod:2659
27534 " lvcreate logvol volgroup mbytes\n"
27540 #: ../fish/guestfish-actions.pod:2664
27541 msgid "lvm-canonical-lv-name"
27546 #: ../fish/guestfish-actions.pod:2666
27549 " lvm-canonical-lv-name lvname\n"
27555 #: ../fish/guestfish-actions.pod:2675
27556 msgid "See also L</is-lv>."
27561 #: ../fish/guestfish-actions.pod:2677
27562 msgid "lvm-clear-filter"
27567 #: ../fish/guestfish-actions.pod:2679
27570 " lvm-clear-filter\n"
27576 #: ../fish/guestfish-actions.pod:2681
27578 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
27584 #: ../fish/guestfish-actions.pod:2687
27585 msgid "lvm-remove-all"
27590 #: ../fish/guestfish-actions.pod:2689
27593 " lvm-remove-all\n"
27599 #: ../fish/guestfish-actions.pod:2697
27600 msgid "lvm-set-filter"
27605 #: ../fish/guestfish-actions.pod:2699
27608 " lvm-set-filter 'devices ...'\n"
27614 #: ../fish/guestfish-actions.pod:2724
27620 #: ../fish/guestfish-actions.pod:2726
27623 " lvremove device\n"
27629 #: ../fish/guestfish-actions.pod:2734
27635 #: ../fish/guestfish-actions.pod:2736
27638 " lvrename logvol newlogvol\n"
27644 #: ../fish/guestfish-actions.pod:2740
27650 #: ../fish/guestfish-actions.pod:2742
27653 " lvresize device mbytes\n"
27659 #: ../fish/guestfish-actions.pod:2748
27660 msgid "lvresize-free"
27665 #: ../fish/guestfish-actions.pod:2750
27668 " lvresize-free lv percent\n"
27674 #: ../fish/guestfish-actions.pod:2758
27680 #: ../fish/guestfish-actions.pod:2760
27689 #: ../fish/guestfish-actions.pod:2768
27690 msgid "See also L</lvs-full>, L</list-filesystems>."
27695 #: ../fish/guestfish-actions.pod:2770
27701 #: ../fish/guestfish-actions.pod:2772
27710 #: ../fish/guestfish-actions.pod:2777
27716 #: ../fish/guestfish-actions.pod:2779
27725 #: ../fish/guestfish-actions.pod:2783
27731 #: ../fish/guestfish-actions.pod:2785
27734 " lxattrlist path 'names ...'\n"
27740 #: ../fish/guestfish-actions.pod:2801
27742 "This call is intended for programs that want to efficiently list a directory "
27743 "contents without making many round-trips. See also L</lstatlist> for a "
27744 "similarly efficient call for getting standard stats. Very long directory "
27745 "listings might cause the protocol message size to be exceeded, causing this "
27746 "call to fail. The caller must split up such requests into smaller groups of "
27752 #: ../fish/guestfish-actions.pod:2809
27758 #: ../fish/guestfish-actions.pod:2811
27767 #: ../fish/guestfish-actions.pod:2815
27773 #: ../fish/guestfish-actions.pod:2817
27776 " mkdir-mode path mode\n"
27782 #: ../fish/guestfish-actions.pod:2826
27783 msgid "See also L</mkdir>, L</umask>"
27788 #: ../fish/guestfish-actions.pod:2828
27794 #: ../fish/guestfish-actions.pod:2830
27803 #: ../fish/guestfish-actions.pod:2835
27809 #: ../fish/guestfish-actions.pod:2837
27812 " mkdtemp template\n"
27818 #: ../fish/guestfish-actions.pod:2858
27824 #: ../fish/guestfish-actions.pod:2860
27827 " mke2fs-J fstype blocksize device journal\n"
27833 #: ../fish/guestfish-actions.pod:2868
27834 msgid "See also L</mke2journal>."
27839 #: ../fish/guestfish-actions.pod:2870
27845 #: ../fish/guestfish-actions.pod:2872
27848 " mke2fs-JL fstype blocksize device label\n"
27854 #: ../fish/guestfish-actions.pod:2877
27855 msgid "See also L</mke2journal-L>."
27860 #: ../fish/guestfish-actions.pod:2879
27866 #: ../fish/guestfish-actions.pod:2881
27869 " mke2fs-JU fstype blocksize device uuid\n"
27875 #: ../fish/guestfish-actions.pod:2886
27876 msgid "See also L</mke2journal-U>."
27881 #: ../fish/guestfish-actions.pod:2888
27882 msgid "mke2journal"
27887 #: ../fish/guestfish-actions.pod:2890
27890 " mke2journal blocksize device\n"
27896 #: ../fish/guestfish-actions.pod:2897
27897 msgid "mke2journal-L"
27902 #: ../fish/guestfish-actions.pod:2899
27905 " mke2journal-L blocksize label device\n"
27911 #: ../fish/guestfish-actions.pod:2903
27912 msgid "mke2journal-U"
27917 #: ../fish/guestfish-actions.pod:2905
27920 " mke2journal-U blocksize uuid device\n"
27926 #: ../fish/guestfish-actions.pod:2909
27932 #: ../fish/guestfish-actions.pod:2911
27935 " mkfifo mode path\n"
27941 #: ../fish/guestfish-actions.pod:2913
27943 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
27944 "is just a convenient wrapper around L</mknod>."
27949 #: ../fish/guestfish-actions.pod:2919
27955 #: ../fish/guestfish-actions.pod:2921
27958 " mkfs fstype device\n"
27964 #: ../fish/guestfish-actions.pod:2927
27970 #: ../fish/guestfish-actions.pod:2929
27973 " mkfs-b fstype blocksize device\n"
27979 #: ../fish/guestfish-actions.pod:2931
27981 "This call is similar to L</mkfs>, but it allows you to control the block "
27982 "size of the resulting filesystem. Supported block sizes depend on the "
27983 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
27988 #: ../fish/guestfish-actions.pod:2946
27993 #: ../fish/guestfish-actions.pod:2948
27996 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
28002 #: ../fish/guestfish-actions.pod:2983
28003 msgid "mkmountpoint"
28008 #: ../fish/guestfish-actions.pod:2985
28011 " mkmountpoint exemptpath\n"
28017 #: ../fish/guestfish-actions.pod:2987
28019 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
28020 "to create extra mountpoints before mounting the first filesystem."
28025 #: ../fish/guestfish-actions.pod:3011
28027 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
28028 "unexpected errors if you try to mix these calls. It is safest to manually "
28029 "unmount filesystems and remove mountpoints after use."
28034 #: ../fish/guestfish-actions.pod:3015
28036 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
28037 "for this to work for manual mountpoints, you must ensure that the innermost "
28038 "mountpoints have the longest pathnames, as in the example code above."
28042 #: ../fish/guestfish-actions.pod:3022
28044 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
28045 "L</umount-all> to be called when the handle is closed which can also trigger "
28051 #: ../fish/guestfish-actions.pod:3026
28057 #: ../fish/guestfish-actions.pod:3028
28060 " mknod mode devmajor devminor path\n"
28066 #: ../fish/guestfish-actions.pod:3038
28068 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
28069 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
28070 "regular file). These constants are available in the standard Linux header "
28071 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
28072 "wrappers around this command which bitwise OR in the appropriate constant "
28078 #: ../fish/guestfish-actions.pod:3048
28084 #: ../fish/guestfish-actions.pod:3050
28087 " mknod-b mode devmajor devminor path\n"
28093 #: ../fish/guestfish-actions.pod:3052
28095 "This call creates a block device node called C<path> with mode C<mode> and "
28096 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28097 "wrapper around L</mknod>."
28102 #: ../fish/guestfish-actions.pod:3058
28108 #: ../fish/guestfish-actions.pod:3060
28111 " mknod-c mode devmajor devminor path\n"
28117 #: ../fish/guestfish-actions.pod:3062
28119 "This call creates a char device node called C<path> with mode C<mode> and "
28120 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
28121 "wrapper around L</mknod>."
28126 #: ../fish/guestfish-actions.pod:3068
28132 #: ../fish/guestfish-actions.pod:3070
28141 #: ../fish/guestfish-actions.pod:3074
28147 #: ../fish/guestfish-actions.pod:3076
28150 " mkswap-L label device\n"
28156 #: ../fish/guestfish-actions.pod:3084
28162 #: ../fish/guestfish-actions.pod:3086
28165 " mkswap-U uuid device\n"
28171 #: ../fish/guestfish-actions.pod:3090
28172 msgid "mkswap-file"
28177 #: ../fish/guestfish-actions.pod:3092
28180 " mkswap-file path\n"
28186 #: ../fish/guestfish-actions.pod:3096
28188 "This command just writes a swap file signature to an existing file. To "
28189 "create the file itself, use something like L</fallocate>."
28194 #: ../fish/guestfish-actions.pod:3099
28200 #: ../fish/guestfish-actions.pod:3101
28203 " modprobe modulename\n"
28209 #: ../fish/guestfish-actions.pod:3108
28215 #: ../fish/guestfish-actions.pod:3110
28218 " mount device mountpoint\n"
28224 #: ../fish/guestfish-actions.pod:3126
28226 "B<Important note:> When you use this call, the filesystem options C<sync> "
28227 "and C<noatime> are set implicitly. This was originally done because we "
28228 "thought it would improve reliability, but it turns out that I<-o sync> has a "
28229 "very large negative performance impact and negligible effect on "
28230 "reliability. Therefore we recommend that you avoid using L</mount> in any "
28231 "code that needs performance, and instead use L</mount-options> (use an empty "
28232 "string for the first parameter if you don't want any options)."
28237 #: ../fish/guestfish-actions.pod:3136
28243 #: ../fish/guestfish-actions.pod:3138
28246 " mount-loop file mountpoint\n"
28252 #: ../fish/guestfish-actions.pod:3144
28253 msgid "mount-options"
28258 #: ../fish/guestfish-actions.pod:3146
28261 " mount-options options device mountpoint\n"
28267 #: ../fish/guestfish-actions.pod:3148
28269 "This is the same as the L</mount> command, but it allows you to set the "
28270 "mount options as for the L<mount(8)> I<-o> flag."
28275 #: ../fish/guestfish-actions.pod:3156
28281 #: ../fish/guestfish-actions.pod:3158
28284 " mount-ro device mountpoint\n"
28290 #: ../fish/guestfish-actions.pod:3160
28292 "This is the same as the L</mount> command, but it mounts the filesystem with "
28293 "the read-only (I<-o ro>) flag."
28298 #: ../fish/guestfish-actions.pod:3163
28304 #: ../fish/guestfish-actions.pod:3165
28307 " mount-vfs options vfstype device mountpoint\n"
28313 #: ../fish/guestfish-actions.pod:3167
28315 "This is the same as the L</mount> command, but it allows you to set both the "
28316 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
28321 #: ../fish/guestfish-actions.pod:3171
28322 msgid "mountpoints"
28327 #: ../fish/guestfish-actions.pod:3173
28336 #: ../fish/guestfish-actions.pod:3175
28338 "This call is similar to L</mounts>. That call returns a list of devices. "
28339 "This one returns a hash table (map) of device name to directory where the "
28340 "device is mounted."
28345 #: ../fish/guestfish-actions.pod:3179
28351 #: ../fish/guestfish-actions.pod:3181
28360 #: ../fish/guestfish-actions.pod:3188
28361 msgid "See also: L</mountpoints>"
28366 #: ../fish/guestfish-actions.pod:3190
28372 #: ../fish/guestfish-actions.pod:3192
28381 #: ../fish/guestfish-actions.pod:3197
28382 msgid "ntfs-3g-probe"
28387 #: ../fish/guestfish-actions.pod:3199
28390 " ntfs-3g-probe true|false device\n"
28396 #: ../fish/guestfish-actions.pod:3213
28402 #: ../fish/guestfish-actions.pod:3215
28405 " ntfsresize device\n"
28411 #: ../fish/guestfish-actions.pod:3221
28412 msgid "ntfsresize-size"
28417 #: ../fish/guestfish-actions.pod:3223
28420 " ntfsresize-size device size\n"
28426 #: ../fish/guestfish-actions.pod:3225
28428 "This command is the same as L</ntfsresize> except that it allows you to "
28429 "specify the new size (in bytes) explicitly."
28434 #: ../fish/guestfish-actions.pod:3228
28440 #: ../fish/guestfish-actions.pod:3230
28443 " part-add device prlogex startsect endsect\n"
28449 #: ../fish/guestfish-actions.pod:3232
28451 "This command adds a partition to C<device>. If there is no partition table "
28452 "on the device, call L</part-init> first."
28457 #: ../fish/guestfish-actions.pod:3244
28459 "Creating a partition which covers the whole disk is not so easy. Use L</"
28460 "part-disk> to do that."
28465 #: ../fish/guestfish-actions.pod:3247
28471 #: ../fish/guestfish-actions.pod:3249
28474 " part-del device partnum\n"
28480 #: ../fish/guestfish-actions.pod:3257
28486 #: ../fish/guestfish-actions.pod:3259
28489 " part-disk device parttype\n"
28495 #: ../fish/guestfish-actions.pod:3261
28497 "This command is simply a combination of L</part-init> followed by L</part-"
28498 "add> to create a single primary partition covering the whole disk."
28503 #: ../fish/guestfish-actions.pod:3265
28505 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28506 "possible values are described in L</part-init>."
28511 #: ../fish/guestfish-actions.pod:3271
28512 msgid "part-get-bootable"
28517 #: ../fish/guestfish-actions.pod:3273
28520 " part-get-bootable device partnum\n"
28526 #: ../fish/guestfish-actions.pod:3278
28527 msgid "See also L</part-set-bootable>."
28532 #: ../fish/guestfish-actions.pod:3280
28533 msgid "part-get-mbr-id"
28538 #: ../fish/guestfish-actions.pod:3282
28541 " part-get-mbr-id device partnum\n"
28547 #: ../fish/guestfish-actions.pod:3287 ../fish/guestfish-actions.pod:3425
28549 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28550 "undefined results for other partition table types (see L</part-get-"
28556 #: ../fish/guestfish-actions.pod:3291
28557 msgid "part-get-parttype"
28562 #: ../fish/guestfish-actions.pod:3293
28565 " part-get-parttype device\n"
28571 #: ../fish/guestfish-actions.pod:3298
28573 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28574 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28575 "possible, although unusual. See L</part-init> for a full list."
28580 #: ../fish/guestfish-actions.pod:3303
28586 #: ../fish/guestfish-actions.pod:3305
28589 " part-init device parttype\n"
28595 #: ../fish/guestfish-actions.pod:3311
28597 "Initially there are no partitions. Following this, you should call L</part-"
28598 "add> for each partition required."
28603 #: ../fish/guestfish-actions.pod:3374
28609 #: ../fish/guestfish-actions.pod:3376
28612 " part-list device\n"
28618 #: ../fish/guestfish-actions.pod:3391
28620 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28621 "the device's sector size, see L</blockdev-getss>."
28626 #: ../fish/guestfish-actions.pod:3404
28627 msgid "part-set-bootable"
28632 #: ../fish/guestfish-actions.pod:3406
28635 " part-set-bootable device partnum true|false\n"
28641 #: ../fish/guestfish-actions.pod:3415
28642 msgid "part-set-mbr-id"
28647 #: ../fish/guestfish-actions.pod:3417
28650 " part-set-mbr-id device partnum idbyte\n"
28656 #: ../fish/guestfish-actions.pod:3429
28657 msgid "part-set-name"
28662 #: ../fish/guestfish-actions.pod:3431
28665 " part-set-name device partnum name\n"
28671 #: ../fish/guestfish-actions.pod:3439
28672 msgid "part-to-dev"
28677 #: ../fish/guestfish-actions.pod:3441
28680 " part-to-dev partition\n"
28686 #: ../fish/guestfish-actions.pod:3447
28688 "The named partition must exist, for example as a string returned from L</"
28689 "list-partitions>."
28694 #: ../fish/guestfish-actions.pod:3450
28695 msgid "ping-daemon"
28700 #: ../fish/guestfish-actions.pod:3452
28709 #: ../fish/guestfish-actions.pod:3459
28715 #: ../fish/guestfish-actions.pod:3461
28718 " pread path count offset\n"
28724 #: ../fish/guestfish-actions.pod:3469
28725 msgid "See also L</pwrite>, L</pread-device>."
28730 #: ../fish/guestfish-actions.pod:3474
28731 msgid "pread-device"
28736 #: ../fish/guestfish-actions.pod:3476
28739 " pread-device device count offset\n"
28745 #: ../fish/guestfish-actions.pod:3484
28746 msgid "See also L</pread>."
28751 #: ../fish/guestfish-actions.pod:3489
28757 #: ../fish/guestfish-actions.pod:3491
28760 " pvcreate device\n"
28766 #: ../fish/guestfish-actions.pod:3497
28772 #: ../fish/guestfish-actions.pod:3499
28775 " pvremove device\n"
28781 #: ../fish/guestfish-actions.pod:3508
28787 #: ../fish/guestfish-actions.pod:3510
28790 " pvresize device\n"
28796 #: ../fish/guestfish-actions.pod:3515
28797 msgid "pvresize-size"
28802 #: ../fish/guestfish-actions.pod:3517
28805 " pvresize-size device size\n"
28811 #: ../fish/guestfish-actions.pod:3519
28813 "This command is the same as L</pvresize> except that it allows you to "
28814 "specify the new size (in bytes) explicitly."
28819 #: ../fish/guestfish-actions.pod:3522
28825 #: ../fish/guestfish-actions.pod:3524
28834 #: ../fish/guestfish-actions.pod:3532
28835 msgid "See also L</pvs-full>."
28840 #: ../fish/guestfish-actions.pod:3534
28846 #: ../fish/guestfish-actions.pod:3536
28855 #: ../fish/guestfish-actions.pod:3541
28861 #: ../fish/guestfish-actions.pod:3543
28870 #: ../fish/guestfish-actions.pod:3547
28876 #: ../fish/guestfish-actions.pod:3549
28879 " pwrite path content offset\n"
28885 #: ../fish/guestfish-actions.pod:3560
28886 msgid "See also L</pread>, L</pwrite-device>."
28891 #: ../fish/guestfish-actions.pod:3565
28892 msgid "pwrite-device"
28897 #: ../fish/guestfish-actions.pod:3567
28900 " pwrite-device device content offset\n"
28906 #: ../fish/guestfish-actions.pod:3577
28907 msgid "See also L</pwrite>."
28912 #: ../fish/guestfish-actions.pod:3582
28918 #: ../fish/guestfish-actions.pod:3584
28921 " read-file path\n"
28927 #: ../fish/guestfish-actions.pod:3589
28929 "Unlike L</cat>, this function can correctly handle files that contain "
28930 "embedded ASCII NUL characters. However unlike L</download>, this function "
28931 "is limited in the total size of file that can be handled."
28936 #: ../fish/guestfish-actions.pod:3597
28942 #: ../fish/guestfish-actions.pod:3599
28945 " read-lines path\n"
28951 #: ../fish/guestfish-actions.pod:3606
28953 "Note that this function cannot correctly handle binary files (specifically, "
28954 "files containing C<\\0> character which is treated as end of line). For "
28955 "those you need to use the L</read-file> function which has a more complex "
28961 #: ../fish/guestfish-actions.pod:3611
28967 #: ../fish/guestfish-actions.pod:3613
28976 #: ../fish/guestfish-actions.pod:3665
28978 "This function is primarily intended for use by programs. To get a simple "
28979 "list of names, use L</ls>. To get a printable directory for human "
28980 "consumption, use L</ll>."
28985 #: ../fish/guestfish-actions.pod:3669
28991 #: ../fish/guestfish-actions.pod:3671
29000 #: ../fish/guestfish-actions.pod:3675
29001 msgid "readlinklist"
29006 #: ../fish/guestfish-actions.pod:3677
29009 " readlinklist path 'names ...'\n"
29015 #: ../fish/guestfish-actions.pod:3701
29021 #: ../fish/guestfish-actions.pod:3703
29030 #: ../fish/guestfish-actions.pod:3708
29031 msgid "removexattr"
29036 #: ../fish/guestfish-actions.pod:3710
29039 " removexattr xattr path\n"
29045 #: ../fish/guestfish-actions.pod:3715
29046 msgid "See also: L</lremovexattr>, L<attr(5)>."
29051 #: ../fish/guestfish-actions.pod:3717
29057 #: ../fish/guestfish-actions.pod:3719
29060 " resize2fs device\n"
29066 #: ../fish/guestfish-actions.pod:3724
29068 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
29069 "before calling this command. For unknown reasons C<resize2fs> sometimes "
29070 "gives an error about this and sometimes not. In any case, it is always safe "
29071 "to call L</e2fsck-f> before calling this function."
29075 #: ../fish/guestfish-actions.pod:3730
29076 msgid "resize2fs-M"
29080 #: ../fish/guestfish-actions.pod:3732
29083 " resize2fs-M device\n"
29088 #: ../fish/guestfish-actions.pod:3734
29090 "This command is the same as L</resize2fs>, but the filesystem is resized to "
29091 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
29096 #: ../fish/guestfish-actions.pod:3738
29098 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
29099 "and read the C<Block size> and C<Block count> values. These two numbers, "
29100 "multiplied together, give the resulting size of the minimal filesystem in "
29106 #: ../fish/guestfish-actions.pod:3743
29107 msgid "resize2fs-size"
29112 #: ../fish/guestfish-actions.pod:3745
29115 " resize2fs-size device size\n"
29121 #: ../fish/guestfish-actions.pod:3747
29123 "This command is the same as L</resize2fs> except that it allows you to "
29124 "specify the new size (in bytes) explicitly."
29129 #: ../fish/guestfish-actions.pod:3750
29135 #: ../fish/guestfish-actions.pod:3752
29144 #: ../fish/guestfish-actions.pod:3756
29150 #: ../fish/guestfish-actions.pod:3758
29159 #: ../fish/guestfish-actions.pod:3764
29165 #: ../fish/guestfish-actions.pod:3766
29174 #: ../fish/guestfish-actions.pod:3770
29175 msgid "rmmountpoint"
29180 #: ../fish/guestfish-actions.pod:3772
29183 " rmmountpoint exemptpath\n"
29189 #: ../fish/guestfish-actions.pod:3774
29191 "This calls removes a mountpoint that was previously created with L</"
29192 "mkmountpoint>. See L</mkmountpoint> for full details."
29197 #: ../fish/guestfish-actions.pod:3778
29198 msgid "scrub-device"
29203 #: ../fish/guestfish-actions.pod:3780
29206 " scrub-device device\n"
29212 #: ../fish/guestfish-actions.pod:3791
29218 #: ../fish/guestfish-actions.pod:3793
29221 " scrub-file file\n"
29227 #: ../fish/guestfish-actions.pod:3803
29228 msgid "scrub-freespace"
29233 #: ../fish/guestfish-actions.pod:3805
29236 " scrub-freespace dir\n"
29242 #: ../fish/guestfish-actions.pod:3807
29244 "This command creates the directory C<dir> and then fills it with files until "
29245 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
29246 "deletes them. The intention is to scrub any free space on the partition "
29247 "containing C<dir>."
29252 #: ../fish/guestfish-actions.pod:3816
29258 #: ../fish/guestfish-actions.pod:3818
29264 #: ../fish/guestfish-actions.pod:3820
29267 " set-append append\n"
29272 #: ../fish/guestfish-actions.pod:3831
29273 msgid "set-attach-method"
29277 #: ../fish/guestfish-actions.pod:3833
29278 msgid "attach-method"
29282 #: ../fish/guestfish-actions.pod:3835
29285 " set-attach-method attachmethod\n"
29291 #: ../fish/guestfish-actions.pod:3857
29292 msgid "set-autosync"
29297 #: ../fish/guestfish-actions.pod:3859
29303 #: ../fish/guestfish-actions.pod:3861
29306 " set-autosync true|false\n"
29312 #: ../fish/guestfish-actions.pod:3871
29318 #: ../fish/guestfish-actions.pod:3873
29324 #: ../fish/guestfish-actions.pod:3875
29327 " set-direct true|false\n"
29333 #: ../fish/guestfish-actions.pod:3881
29335 "One consequence of this is that log messages aren't caught by the library "
29336 "and handled by L</set-log-message-callback>, but go straight to stdout."
29341 #: ../fish/guestfish-actions.pod:3890
29342 msgid "set-e2label"
29347 #: ../fish/guestfish-actions.pod:3892
29350 " set-e2label device label\n"
29356 #: ../fish/guestfish-actions.pod:3898
29358 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
29359 "label on a filesystem."
29364 #: ../fish/guestfish-actions.pod:3901
29370 #: ../fish/guestfish-actions.pod:3903
29373 " set-e2uuid device uuid\n"
29379 #: ../fish/guestfish-actions.pod:3910
29381 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
29382 "UUID of a filesystem."
29387 #: ../fish/guestfish-actions.pod:3913
29388 msgid "set-memsize"
29393 #: ../fish/guestfish-actions.pod:3915
29399 #: ../fish/guestfish-actions.pod:3917
29402 " set-memsize memsize\n"
29408 #: ../fish/guestfish-actions.pod:3919
29410 "This sets the memory size in megabytes allocated to the qemu subprocess. "
29411 "This only has any effect if called before L</launch>."
29416 #: ../fish/guestfish-actions.pod:3930
29417 msgid "set-network"
29422 #: ../fish/guestfish-actions.pod:3932
29428 #: ../fish/guestfish-actions.pod:3934
29431 " set-network true|false\n"
29437 #: ../fish/guestfish-actions.pod:3942
29439 "You must call this before calling L</launch>, otherwise it has no effect."
29444 #: ../fish/guestfish-actions.pod:3945
29450 #: ../fish/guestfish-actions.pod:3947
29456 #: ../fish/guestfish-actions.pod:3949
29459 " set-path searchpath\n"
29465 #: ../fish/guestfish-actions.pod:3958
29471 #: ../fish/guestfish-actions.pod:3960
29477 #: ../fish/guestfish-actions.pod:3962
29486 #: ../fish/guestfish-actions.pod:3982
29487 msgid "set-recovery-proc"
29492 #: ../fish/guestfish-actions.pod:3984
29493 msgid "recovery-proc"
29498 #: ../fish/guestfish-actions.pod:3986
29501 " set-recovery-proc true|false\n"
29507 #: ../fish/guestfish-actions.pod:3988
29509 "If this is called with the parameter C<false> then L</launch> does not "
29510 "create a recovery process. The purpose of the recovery process is to stop "
29511 "runaway qemu processes in the case where the main program aborts abruptly."
29516 #: ../fish/guestfish-actions.pod:3993
29518 "This only has any effect if called before L</launch>, and the default is "
29524 #: ../fish/guestfish-actions.pod:4002
29525 msgid "set-selinux"
29530 #: ../fish/guestfish-actions.pod:4004
29536 #: ../fish/guestfish-actions.pod:4006
29539 " set-selinux true|false\n"
29545 #: ../fish/guestfish-actions.pod:4017
29551 #: ../fish/guestfish-actions.pod:4019
29557 #: ../fish/guestfish-actions.pod:4021
29560 " set-trace true|false\n"
29565 #: ../fish/guestfish-actions.pod:4033
29567 "Trace messages are normally sent to C<stderr>, unless you register a "
29568 "callback to send them somewhere else (see L</set-event-callback>)."
29573 #: ../fish/guestfish-actions.pod:4037
29574 msgid "set-verbose"
29579 #: ../fish/guestfish-actions.pod:4039
29585 #: ../fish/guestfish-actions.pod:4041
29588 " set-verbose true|false\n"
29593 #: ../fish/guestfish-actions.pod:4048
29595 "Verbose messages are normally sent to C<stderr>, unless you register a "
29596 "callback to send them somewhere else (see L</set-event-callback>)."
29601 #: ../fish/guestfish-actions.pod:4052
29607 #: ../fish/guestfish-actions.pod:4054
29610 " setcon context\n"
29616 #: ../fish/guestfish-actions.pod:4061
29622 #: ../fish/guestfish-actions.pod:4063
29625 " setxattr xattr val vallen path\n"
29631 #: ../fish/guestfish-actions.pod:4069
29632 msgid "See also: L</lsetxattr>, L<attr(5)>."
29637 #: ../fish/guestfish-actions.pod:4071
29643 #: ../fish/guestfish-actions.pod:4073
29646 " sfdisk device cyls heads sectors 'lines ...'\n"
29652 #: ../fish/guestfish-actions.pod:4095
29653 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
29658 #: ../fish/guestfish-actions.pod:4101
29664 #: ../fish/guestfish-actions.pod:4103
29667 " sfdiskM device 'lines ...'\n"
29673 #: ../fish/guestfish-actions.pod:4105
29675 "This is a simplified interface to the L</sfdisk> command, where partition "
29676 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
29677 "you don't need to specify the cyls, heads and sectors parameters which were "
29678 "rarely if ever used anyway."
29683 #: ../fish/guestfish-actions.pod:4111
29684 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
29689 #: ../fish/guestfish-actions.pod:4117
29695 #: ../fish/guestfish-actions.pod:4119
29698 " sfdisk-N device partnum cyls heads sectors line\n"
29704 #: ../fish/guestfish-actions.pod:4124
29706 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
29707 "cyls/heads/sectors parameters."
29712 #: ../fish/guestfish-actions.pod:4127
29713 msgid "See also: L</part-add>"
29718 #: ../fish/guestfish-actions.pod:4132
29719 msgid "sfdisk-disk-geometry"
29724 #: ../fish/guestfish-actions.pod:4134
29727 " sfdisk-disk-geometry device\n"
29733 #: ../fish/guestfish-actions.pod:4136
29735 "This displays the disk geometry of C<device> read from the partition table. "
29736 "Especially in the case where the underlying block device has been resized, "
29737 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
29738 "kernel-geometry>)."
29743 #: ../fish/guestfish-actions.pod:4144
29744 msgid "sfdisk-kernel-geometry"
29749 #: ../fish/guestfish-actions.pod:4146
29752 " sfdisk-kernel-geometry device\n"
29758 #: ../fish/guestfish-actions.pod:4153
29764 #: ../fish/guestfish-actions.pod:4155
29767 " sfdisk-l device\n"
29773 #: ../fish/guestfish-actions.pod:4161
29774 msgid "See also: L</part-list>"
29779 #: ../fish/guestfish-actions.pod:4163
29785 #: ../fish/guestfish-actions.pod:4165
29794 #: ../fish/guestfish-actions.pod:4170
29795 msgid "This is like L</command>, but passes the command to:"
29800 #: ../fish/guestfish-actions.pod:4178
29801 msgid "All the provisos about L</command> apply to this call."
29806 #: ../fish/guestfish-actions.pod:4180
29812 #: ../fish/guestfish-actions.pod:4182
29815 " sh-lines command\n"
29821 #: ../fish/guestfish-actions.pod:4184
29822 msgid "This is the same as L</sh>, but splits the result into a list of lines."
29827 #: ../fish/guestfish-actions.pod:4187
29828 msgid "See also: L</command-lines>"
29833 #: ../fish/guestfish-actions.pod:4189
29839 #: ../fish/guestfish-actions.pod:4191
29848 #: ../fish/guestfish-actions.pod:4195
29854 #: ../fish/guestfish-actions.pod:4197
29863 #: ../fish/guestfish-actions.pod:4203
29869 #: ../fish/guestfish-actions.pod:4205
29878 #: ../fish/guestfish-actions.pod:4213
29884 #: ../fish/guestfish-actions.pod:4215
29893 #: ../fish/guestfish-actions.pod:4223
29899 #: ../fish/guestfish-actions.pod:4225
29902 " strings-e encoding path\n"
29908 #: ../fish/guestfish-actions.pod:4227
29910 "This is like the L</strings> command, but allows you to specify the encoding "
29911 "of strings that are looked for in the source file C<path>."
29916 #: ../fish/guestfish-actions.pod:4237
29918 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29919 "ISO-8859-X (this is what L</strings> uses)."
29924 #: ../fish/guestfish-actions.pod:4269
29925 msgid "swapoff-device"
29930 #: ../fish/guestfish-actions.pod:4271
29933 " swapoff-device device\n"
29939 #: ../fish/guestfish-actions.pod:4273
29941 "This command disables the libguestfs appliance swap device or partition "
29942 "named C<device>. See L</swapon-device>."
29947 #: ../fish/guestfish-actions.pod:4277
29948 msgid "swapoff-file"
29953 #: ../fish/guestfish-actions.pod:4279
29956 " swapoff-file file\n"
29962 #: ../fish/guestfish-actions.pod:4283
29963 msgid "swapoff-label"
29968 #: ../fish/guestfish-actions.pod:4285
29971 " swapoff-label label\n"
29977 #: ../fish/guestfish-actions.pod:4290
29978 msgid "swapoff-uuid"
29983 #: ../fish/guestfish-actions.pod:4292
29986 " swapoff-uuid uuid\n"
29992 #: ../fish/guestfish-actions.pod:4297
29993 msgid "swapon-device"
29998 #: ../fish/guestfish-actions.pod:4299
30001 " swapon-device device\n"
30007 #: ../fish/guestfish-actions.pod:4301
30009 "This command enables the libguestfs appliance to use the swap device or "
30010 "partition named C<device>. The increased memory is made available for all "
30011 "commands, for example those run using L</command> or L</sh>."
30016 #: ../fish/guestfish-actions.pod:4313
30017 msgid "swapon-file"
30022 #: ../fish/guestfish-actions.pod:4315
30025 " swapon-file file\n"
30031 #: ../fish/guestfish-actions.pod:4317
30033 "This command enables swap to a file. See L</swapon-device> for other notes."
30038 #: ../fish/guestfish-actions.pod:4320
30039 msgid "swapon-label"
30044 #: ../fish/guestfish-actions.pod:4322
30047 " swapon-label label\n"
30053 #: ../fish/guestfish-actions.pod:4324
30055 "This command enables swap to a labeled swap partition. See L</swapon-"
30056 "device> for other notes."
30061 #: ../fish/guestfish-actions.pod:4327
30062 msgid "swapon-uuid"
30067 #: ../fish/guestfish-actions.pod:4329
30070 " swapon-uuid uuid\n"
30076 #: ../fish/guestfish-actions.pod:4331
30078 "This command enables swap to a swap partition with the given UUID. See L</"
30079 "swapon-device> for other notes."
30084 #: ../fish/guestfish-actions.pod:4334
30090 #: ../fish/guestfish-actions.pod:4336
30099 #: ../fish/guestfish-actions.pod:4344
30105 #: ../fish/guestfish-actions.pod:4346
30114 #: ../fish/guestfish-actions.pod:4354
30120 #: ../fish/guestfish-actions.pod:4356
30123 " tail-n nrlines path\n"
30129 #: ../fish/guestfish-actions.pod:4369
30135 #: ../fish/guestfish-actions.pod:4371
30138 " tar-in (tarfile|-) directory\n"
30144 #: ../fish/guestfish-actions.pod:4376
30145 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
30150 #: ../fish/guestfish-actions.pod:4381
30156 #: ../fish/guestfish-actions.pod:4383
30159 " tar-out directory (tarfile|-)\n"
30165 #: ../fish/guestfish-actions.pod:4388
30166 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
30171 #: ../fish/guestfish-actions.pod:4393
30177 #: ../fish/guestfish-actions.pod:4395
30180 " tgz-in (tarball|-) directory\n"
30186 #: ../fish/guestfish-actions.pod:4400
30187 msgid "To upload an uncompressed tarball, use L</tar-in>."
30192 #: ../fish/guestfish-actions.pod:4404
30198 #: ../fish/guestfish-actions.pod:4406
30201 " tgz-out directory (tarball|-)\n"
30207 #: ../fish/guestfish-actions.pod:4411
30208 msgid "To download an uncompressed tarball, use L</tar-out>."
30213 #: ../fish/guestfish-actions.pod:4415
30219 #: ../fish/guestfish-actions.pod:4417
30228 #: ../fish/guestfish-actions.pod:4426
30234 #: ../fish/guestfish-actions.pod:4428
30243 #: ../fish/guestfish-actions.pod:4433
30244 msgid "truncate-size"
30249 #: ../fish/guestfish-actions.pod:4435
30252 " truncate-size path size\n"
30258 #: ../fish/guestfish-actions.pod:4440
30260 "If the current file size is less than C<size> then the file is extended to "
30261 "the required size with zero bytes. This creates a sparse file (ie. disk "
30262 "blocks are not allocated for the file until you write to it). To create a "
30263 "non-sparse file of zeroes, use L</fallocate64> instead."
30268 #: ../fish/guestfish-actions.pod:4446
30274 #: ../fish/guestfish-actions.pod:4448
30277 " tune2fs-l device\n"
30283 #: ../fish/guestfish-actions.pod:4458
30289 #: ../fish/guestfish-actions.pod:4460
30292 " txz-in (tarball|-) directory\n"
30298 #: ../fish/guestfish-actions.pod:4467
30304 #: ../fish/guestfish-actions.pod:4469
30307 " txz-out directory (tarball|-)\n"
30313 #: ../fish/guestfish-actions.pod:4476
30319 #: ../fish/guestfish-actions.pod:4478
30328 #: ../fish/guestfish-actions.pod:4492
30329 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
30334 #: ../fish/guestfish-actions.pod:4497
30340 #: ../fish/guestfish-actions.pod:4499
30346 #: ../fish/guestfish-actions.pod:4501
30349 " umount pathordevice\n"
30355 #: ../fish/guestfish-actions.pod:4507
30361 #: ../fish/guestfish-actions.pod:4509
30362 msgid "unmount-all"
30367 #: ../fish/guestfish-actions.pod:4511
30376 #: ../fish/guestfish-actions.pod:4517
30382 #: ../fish/guestfish-actions.pod:4519
30385 " upload (filename|-) remotefilename\n"
30391 #: ../fish/guestfish-actions.pod:4526
30392 msgid "See also L</download>."
30397 #: ../fish/guestfish-actions.pod:4530
30398 msgid "upload-offset"
30403 #: ../fish/guestfish-actions.pod:4532
30406 " upload-offset (filename|-) remotefilename offset\n"
30412 #: ../fish/guestfish-actions.pod:4544
30414 "Note that there is no limit on the amount of data that can be uploaded with "
30415 "this call, unlike with L</pwrite>, and this call always writes the full "
30416 "amount unless an error occurs."
30421 #: ../fish/guestfish-actions.pod:4549
30422 msgid "See also L</upload>, L</pwrite>."
30427 #: ../fish/guestfish-actions.pod:4553
30433 #: ../fish/guestfish-actions.pod:4555
30436 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
30442 #: ../fish/guestfish-actions.pod:4574
30448 #: ../fish/guestfish-actions.pod:4576
30457 #: ../fish/guestfish-actions.pod:4603
30459 "I<Note:> Don't use this call to test for availability of features. In "
30460 "enterprise distributions we backport features from later versions into "
30461 "earlier versions, making this an unreliable way to test for features. Use "
30462 "L</available> instead."
30467 #: ../fish/guestfish-actions.pod:4609
30473 #: ../fish/guestfish-actions.pod:4611
30476 " vfs-label device\n"
30482 #: ../fish/guestfish-actions.pod:4618
30483 msgid "To find a filesystem from the label, use L</findfs-label>."
30488 #: ../fish/guestfish-actions.pod:4620
30494 #: ../fish/guestfish-actions.pod:4622
30497 " vfs-type device\n"
30503 #: ../fish/guestfish-actions.pod:4632
30509 #: ../fish/guestfish-actions.pod:4634
30512 " vfs-uuid device\n"
30518 #: ../fish/guestfish-actions.pod:4641
30519 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
30524 #: ../fish/guestfish-actions.pod:4643
30525 msgid "vg-activate"
30530 #: ../fish/guestfish-actions.pod:4645
30533 " vg-activate true|false 'volgroups ...'\n"
30539 #: ../fish/guestfish-actions.pod:4658
30540 msgid "vg-activate-all"
30545 #: ../fish/guestfish-actions.pod:4660
30548 " vg-activate-all true|false\n"
30554 #: ../fish/guestfish-actions.pod:4670
30560 #: ../fish/guestfish-actions.pod:4672
30563 " vgcreate volgroup 'physvols ...'\n"
30569 #: ../fish/guestfish-actions.pod:4677
30575 #: ../fish/guestfish-actions.pod:4679
30578 " vglvuuids vgname\n"
30584 #: ../fish/guestfish-actions.pod:4684
30586 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
30587 "logical volumes and volume groups."
30592 #: ../fish/guestfish-actions.pod:4687
30593 msgid "See also L</vgpvuuids>."
30598 #: ../fish/guestfish-actions.pod:4689
30604 #: ../fish/guestfish-actions.pod:4691
30607 " vgpvuuids vgname\n"
30613 #: ../fish/guestfish-actions.pod:4696
30615 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
30616 "physical volumes and volume groups."
30621 #: ../fish/guestfish-actions.pod:4699
30622 msgid "See also L</vglvuuids>."
30627 #: ../fish/guestfish-actions.pod:4701
30633 #: ../fish/guestfish-actions.pod:4703
30636 " vgremove vgname\n"
30642 #: ../fish/guestfish-actions.pod:4710
30648 #: ../fish/guestfish-actions.pod:4712
30651 " vgrename volgroup newvolgroup\n"
30657 #: ../fish/guestfish-actions.pod:4716
30663 #: ../fish/guestfish-actions.pod:4718
30672 #: ../fish/guestfish-actions.pod:4726
30673 msgid "See also L</vgs-full>."
30678 #: ../fish/guestfish-actions.pod:4728
30684 #: ../fish/guestfish-actions.pod:4730
30693 #: ../fish/guestfish-actions.pod:4735
30699 #: ../fish/guestfish-actions.pod:4737
30708 #: ../fish/guestfish-actions.pod:4742
30714 #: ../fish/guestfish-actions.pod:4744
30723 #: ../fish/guestfish-actions.pod:4748
30729 #: ../fish/guestfish-actions.pod:4750
30738 #: ../fish/guestfish-actions.pod:4755
30744 #: ../fish/guestfish-actions.pod:4757
30753 #: ../fish/guestfish-actions.pod:4762
30759 #: ../fish/guestfish-actions.pod:4764
30768 #: ../fish/guestfish-actions.pod:4769
30774 #: ../fish/guestfish-actions.pod:4771
30777 " write path content\n"
30783 #: ../fish/guestfish-actions.pod:4779
30789 #: ../fish/guestfish-actions.pod:4781
30792 " write-file path content size\n"
30798 #: ../fish/guestfish-actions.pod:4804
30804 #: ../fish/guestfish-actions.pod:4806
30807 " zegrep regex path\n"
30813 #: ../fish/guestfish-actions.pod:4814
30819 #: ../fish/guestfish-actions.pod:4816
30822 " zegrepi regex path\n"
30828 #: ../fish/guestfish-actions.pod:4824
30834 #: ../fish/guestfish-actions.pod:4826
30843 #: ../fish/guestfish-actions.pod:4834
30844 msgid "See also: L</zero-device>, L</scrub-device>."
30849 #: ../fish/guestfish-actions.pod:4836
30850 msgid "zero-device"
30855 #: ../fish/guestfish-actions.pod:4838
30858 " zero-device device\n"
30864 #: ../fish/guestfish-actions.pod:4840
30866 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
30867 "which just zeroes the first few blocks of a device."
30872 #: ../fish/guestfish-actions.pod:4847
30878 #: ../fish/guestfish-actions.pod:4849
30881 " zerofree device\n"
30887 #: ../fish/guestfish-actions.pod:4862
30893 #: ../fish/guestfish-actions.pod:4864
30896 " zfgrep pattern path\n"
30902 #: ../fish/guestfish-actions.pod:4872
30908 #: ../fish/guestfish-actions.pod:4874
30911 " zfgrepi pattern path\n"
30917 #: ../fish/guestfish-actions.pod:4882
30923 #: ../fish/guestfish-actions.pod:4884
30926 " zfile meth path\n"
30932 #: ../fish/guestfish-actions.pod:4891
30934 "Since 1.0.63, use L</file> instead which can now process compressed files."
30939 #: ../fish/guestfish-actions.pod:4901
30945 #: ../fish/guestfish-actions.pod:4903
30948 " zgrep regex path\n"
30954 #: ../fish/guestfish-actions.pod:4911
30960 #: ../fish/guestfish-actions.pod:4913
30963 " zgrepi regex path\n"
30969 #: ../fish/guestfish-commands.pod:1
30975 #: ../fish/guestfish-commands.pod:3
30981 #: ../fish/guestfish-commands.pod:5
30984 " alloc filename size\n"
30990 #: ../fish/guestfish-commands.pod:7
30992 "This creates an empty (zeroed) file of the given size, and then adds so it "
30993 "can be further examined."
30998 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
30999 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
31004 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
31005 msgid "Size can be specified using standard suffixes, eg. C<1M>."
31010 #: ../fish/guestfish-commands.pod:14
31012 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
31013 "image, see L</PREPARED DISK IMAGES>."
31018 #: ../fish/guestfish-commands.pod:17
31024 #: ../fish/guestfish-commands.pod:19
31027 " copy-in local [local ...] /remotedir\n"
31033 #: ../fish/guestfish-commands.pod:21
31035 "C<copy-in> copies local files or directories recursively into the disk "
31036 "image, placing them in the directory called C</remotedir> (which must "
31037 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
31038 "other commands as necessary."
31043 #: ../fish/guestfish-commands.pod:26
31045 "Multiple local files and directories can be specified, but the last "
31046 "parameter must always be a remote directory. Wildcards cannot be used."
31051 #: ../fish/guestfish-commands.pod:30
31057 #: ../fish/guestfish-commands.pod:32
31060 " copy-out remote [remote ...] localdir\n"
31066 #: ../fish/guestfish-commands.pod:34
31068 "C<copy-out> copies remote files or directories recursively out of the disk "
31069 "image, placing them on the host disk in a local directory called C<localdir> "
31070 "(which must exist). This guestfish meta-command turns into a sequence of L</"
31071 "download>, L</tar-out> and other commands as necessary."
31076 #: ../fish/guestfish-commands.pod:40
31078 "Multiple remote files and directories can be specified, but the last "
31079 "parameter must always be a local directory. To download to the current "
31080 "directory, use C<.> as in:"
31085 #: ../fish/guestfish-commands.pod:44
31088 " copy-out /home .\n"
31094 #: ../fish/guestfish-commands.pod:46
31096 "Wildcards cannot be used in the ordinary command, but you can use them with "
31097 "the help of L</glob> like this:"
31102 #: ../fish/guestfish-commands.pod:49
31105 " glob copy-out /home/* .\n"
31111 #: ../fish/guestfish-commands.pod:51
31117 #: ../fish/guestfish-commands.pod:53
31120 " echo [params ...]\n"
31126 #: ../fish/guestfish-commands.pod:55
31127 msgid "This echos the parameters to the terminal."
31132 #: ../fish/guestfish-commands.pod:57
31138 #: ../fish/guestfish-commands.pod:59
31144 #: ../fish/guestfish-commands.pod:61
31150 #: ../fish/guestfish-commands.pod:63
31159 #: ../fish/guestfish-commands.pod:65
31161 "This is used to edit a file. It downloads the file, edits it locally using "
31162 "your editor, then uploads the result."
31167 #: ../fish/guestfish-commands.pod:68
31169 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
31170 "or C<emacs> you will get those corresponding editors."
31175 #: ../fish/guestfish-commands.pod:72
31181 #: ../fish/guestfish-commands.pod:74
31184 " glob command args...\n"
31190 #: ../fish/guestfish-commands.pod:76
31192 "Expand wildcards in any paths in the args list, and run C<command> "
31193 "repeatedly on each matching path."
31198 #: ../fish/guestfish-commands.pod:79
31199 msgid "See L</WILDCARDS AND GLOBBING>."
31204 #: ../fish/guestfish-commands.pod:81
31210 #: ../fish/guestfish-commands.pod:83
31213 " hexedit <filename|device>\n"
31214 " hexedit <filename|device> <max>\n"
31215 " hexedit <filename|device> <start> <max>\n"
31221 #: ../fish/guestfish-commands.pod:87
31223 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
31229 #: ../fish/guestfish-commands.pod:90
31231 "This command works by downloading potentially the whole file or device, "
31232 "editing it locally, then uploading it. If the file or device is large, you "
31233 "have to specify which part you wish to edit by using C<max> and/or C<start> "
31234 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
31235 "usual modifiers allowed such as C<1M> (1 megabyte)."
31240 #: ../fish/guestfish-commands.pod:97
31241 msgid "For example to edit the first few sectors of a disk you might do:"
31246 #: ../fish/guestfish-commands.pod:100
31249 " hexedit /dev/sda 1M\n"
31255 #: ../fish/guestfish-commands.pod:102
31257 "which would allow you to edit anywhere within the first megabyte of the disk."
31262 #: ../fish/guestfish-commands.pod:105
31263 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
31268 #: ../fish/guestfish-commands.pod:107
31271 " hexedit /dev/sda1 0x400 0x400\n"
31277 #: ../fish/guestfish-commands.pod:109
31278 msgid "(assuming the superblock is in the standard location)."
31283 #: ../fish/guestfish-commands.pod:111
31285 "This command requires the external L<hexedit(1)> program. You can specify "
31286 "another program to use by setting the C<HEXEDITOR> environment variable."
31291 #: ../fish/guestfish-commands.pod:115
31292 msgid "See also L</hexdump>."
31297 #: ../fish/guestfish-commands.pod:117
31303 #: ../fish/guestfish-commands.pod:119
31312 #: ../fish/guestfish-commands.pod:121
31314 "Change the local directory, ie. the current directory of guestfish itself."
31319 #: ../fish/guestfish-commands.pod:124
31320 msgid "Note that C<!cd> won't do what you might expect."
31325 #: ../fish/guestfish-commands.pod:126
31331 #: ../fish/guestfish-commands.pod:128
31337 #: ../fish/guestfish-commands.pod:130
31346 #: ../fish/guestfish-commands.pod:132
31347 msgid "Opens the manual page for guestfish."
31352 #: ../fish/guestfish-commands.pod:134
31358 #: ../fish/guestfish-commands.pod:136
31364 #: ../fish/guestfish-commands.pod:138
31373 #: ../fish/guestfish-commands.pod:140
31382 #: ../fish/guestfish-commands.pod:142
31383 msgid "This is used to view a file."
31388 #: ../fish/guestfish-commands.pod:144
31390 "The default viewer is C<$PAGER>. However if you use the alternate command "
31391 "C<less> you will get the C<less> command specifically."
31396 #: ../fish/guestfish-commands.pod:147
31402 #: ../fish/guestfish-commands.pod:149
31411 #: ../fish/guestfish-commands.pod:151
31413 "Close and reopen the libguestfs handle. It is not necessary to use this "
31414 "normally, because the handle is closed properly when guestfish exits. "
31415 "However this is occasionally useful for testing."
31420 #: ../fish/guestfish-commands.pod:155
31426 #: ../fish/guestfish-commands.pod:157
31429 " sparse filename size\n"
31435 #: ../fish/guestfish-commands.pod:159
31437 "This creates an empty sparse file of the given size, and then adds so it can "
31438 "be further examined."
31443 #: ../fish/guestfish-commands.pod:162
31445 "In all respects it works the same as the L</alloc> command, except that the "
31446 "image file is allocated sparsely, which means that disk blocks are not "
31447 "assigned to the file until they are needed. Sparse disk files only use "
31448 "space when written to, but they are slower and there is a danger you could "
31449 "run out of real disk space during a write operation."
31454 #: ../fish/guestfish-commands.pod:172
31460 #: ../fish/guestfish-commands.pod:174
31469 #: ../fish/guestfish-commands.pod:176
31471 "This command returns a list of the optional groups known to the daemon, and "
31472 "indicates which ones are supported by this build of the libguestfs appliance."
31477 #: ../fish/guestfish-commands.pod:180
31478 msgid "See also L<guestfs(3)/AVAILABILITY>."
31483 #: ../fish/guestfish-commands.pod:182
31489 #: ../fish/guestfish-commands.pod:184
31492 " time command args...\n"
31498 #: ../fish/guestfish-commands.pod:186
31500 "Run the command as usual, but print the elapsed time afterwards. This can "
31501 "be useful for benchmarking operations."
31506 #: ../test-tool/libguestfs-test-tool.pod:5
31507 msgid "libguestfs-test-tool - End user tests for libguestfs"
31512 #: ../test-tool/libguestfs-test-tool.pod:9
31515 " libguestfs-test-tool [--options]\n"
31521 #: ../test-tool/libguestfs-test-tool.pod:13
31523 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
31524 "and developers, to allow them to check basic libguestfs functionality is "
31525 "working. This is needed because libguestfs occasionally breaks for reasons "
31526 "beyond our control: usually because of changes in the underlying qemu or "
31527 "kernel packages, or the host environment."
31532 #: ../test-tool/libguestfs-test-tool.pod:20
31533 msgid "If you suspect a problem in libguestfs, then just run:"
31538 #: ../test-tool/libguestfs-test-tool.pod:22
31541 " libguestfs-test-tool\n"
31547 #: ../test-tool/libguestfs-test-tool.pod:24
31548 msgid "It will print lots of diagnostic messages."
31553 #: ../test-tool/libguestfs-test-tool.pod:26
31554 msgid "If it runs to completion successfully, you will see this near the end:"
31559 #: ../test-tool/libguestfs-test-tool.pod:28
31562 " ===== TEST FINISHED OK =====\n"
31568 #: ../test-tool/libguestfs-test-tool.pod:30
31569 msgid "and the test tool will exit with code 0."
31574 #: ../test-tool/libguestfs-test-tool.pod:32
31576 "If it fails (and/or exits with non-zero error code), please paste the "
31577 "B<complete, unedited> output of the test tool into a bug report. More "
31578 "information about reporting bugs can be found on the L<http://libguestfs.org/"
31584 #: ../test-tool/libguestfs-test-tool.pod:41
31590 #: ../test-tool/libguestfs-test-tool.pod:43
31591 msgid "Display short usage information and exit."
31596 #: ../test-tool/libguestfs-test-tool.pod:45
31597 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
31602 #: ../test-tool/libguestfs-test-tool.pod:47
31604 "Pass an alternate name for the helper program. libguestfs-test-tool will "
31605 "normally look in the C<$libexec> directory that was configured when the tool "
31611 #: ../test-tool/libguestfs-test-tool.pod:51
31612 msgid "I<--qemu qemu_binary>"
31617 #: ../test-tool/libguestfs-test-tool.pod:53
31619 "If you have downloaded another qemu binary, point this option at the full "
31620 "path of the binary to try it."
31625 #: ../test-tool/libguestfs-test-tool.pod:56
31626 msgid "I<--qemudir qemu_source_dir>"
31631 #: ../test-tool/libguestfs-test-tool.pod:58
31633 "If you have compiled qemu from source, point this option at the source "
31634 "directory to try it."
31639 #: ../test-tool/libguestfs-test-tool.pod:61
31640 msgid "I<--timeout N>"
31645 #: ../test-tool/libguestfs-test-tool.pod:63
31647 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
31648 "does not usually need to be adjusted unless your machine is very slow."
31653 #: ../test-tool/libguestfs-test-tool.pod:69
31654 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
31659 #: ../test-tool/libguestfs-test-tool.pod:71
31661 "If you have compiled another version of qemu from source and would like to "
31662 "try that, then you can use the I<--qemudir> option to point to the qemu "
31663 "source directory."
31668 #: ../test-tool/libguestfs-test-tool.pod:75
31670 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
31671 "option to point to the binary."
31676 #: ../test-tool/libguestfs-test-tool.pod:78
31678 "When using an alternate qemu with libguestfs, usually you would need to "
31679 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
31680 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
31681 "use either of the I<--qemudir> or I<--qemu> options."
31686 #: ../test-tool/libguestfs-test-tool.pod:85
31688 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
31689 "I<1> if there was an error."
31694 #: ../test-tool/libguestfs-test-tool.pod:92
31695 msgid "/usr/libexec/libguestfs-test-tool-helper"
31700 #: ../test-tool/libguestfs-test-tool.pod:94
31702 "This helper program is run inside the appliance and provides additional "
31708 #: ../test-tool/libguestfs-test-tool.pod:97
31709 msgid "/usr/bin/mkisofs"
31714 #: ../test-tool/libguestfs-test-tool.pod:99
31716 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
31717 "which is used as part of the tests."
31722 #: ../test-tool/libguestfs-test-tool.pod:106
31724 "For the full list of environment variables which may affect libguestfs, "
31725 "please see the L<guestfs(3)> manual page."
31730 #: ../test-tool/libguestfs-test-tool.pod:111
31731 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
31736 #: ../test-tool/libguestfs-test-tool.pod:121
31737 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
31742 #: ../fuse/guestmount.pod:5
31744 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
31749 #: ../fuse/guestmount.pod:9
31752 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
31758 #: ../fuse/guestmount.pod:11
31761 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
31767 #: ../fuse/guestmount.pod:13
31770 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
31776 #: ../fuse/guestmount.pod:17
31778 "You must I<not> use C<guestmount> in read-write mode on live virtual "
31779 "machines. If you do this, you risk disk corruption in the VM."
31784 #: ../fuse/guestmount.pod:22
31786 "The guestmount program can be used to mount virtual machine filesystems and "
31787 "other disk images on the host. It uses libguestfs for access to the guest "
31788 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
31789 "a mountable device."
31794 #: ../fuse/guestmount.pod:27
31796 "Along with other options, you have to give at least one device (I<-a> "
31797 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
31798 "option) or use the I<-i> inspection option. How this works is better "
31799 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
31805 #: ../fuse/guestmount.pod:33
31807 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
31808 "by you, and the filesystem will not be visible to any other users unless you "
31809 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
31810 "the filesystem, use the C<fusermount -u> command."
31815 #: ../fuse/guestmount.pod:41
31817 "For a typical Windows guest which has its main filesystem on the first "
31823 #: ../fuse/guestmount.pod:44
31826 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
31832 #: ../fuse/guestmount.pod:46
31834 "For a typical Linux guest which has a /boot filesystem on the first "
31835 "partition, and the root filesystem on a logical volume:"
31840 #: ../fuse/guestmount.pod:49
31843 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
31849 #: ../fuse/guestmount.pod:51
31850 msgid "To get libguestfs to detect guest mountpoints for you:"
31855 #: ../fuse/guestmount.pod:53
31858 " guestmount -a guest.img -i --ro /mnt\n"
31864 #: ../fuse/guestmount.pod:55
31865 msgid "For a libvirt guest called \"Guest\" you could do:"
31870 #: ../fuse/guestmount.pod:57
31873 " guestmount -d Guest -i --ro /mnt\n"
31879 #: ../fuse/guestmount.pod:59
31881 "If you don't know what filesystems are contained in a guest or disk image, "
31882 "use L<virt-filesystems(1)> first:"
31887 #: ../fuse/guestmount.pod:62
31890 " virt-filesystems MyGuest\n"
31896 #: ../fuse/guestmount.pod:64
31898 "If you want to trace the libguestfs calls but without excessive debugging "
31899 "information, we recommend:"
31904 #: ../fuse/guestmount.pod:67
31907 " guestmount [...] --trace /mnt\n"
31913 #: ../fuse/guestmount.pod:69
31914 msgid "If you want to debug the program, we recommend:"
31919 #: ../fuse/guestmount.pod:71
31922 " guestmount [...] --trace --verbose /mnt\n"
31928 #: ../fuse/guestmount.pod:77
31929 msgid "B<-a image> | B<--add image>"
31934 #: ../fuse/guestmount.pod:79
31935 msgid "Add a block device or virtual machine image."
31940 #: ../fuse/guestmount.pod:84
31941 msgid "B<-c URI> | B<--connect URI>"
31946 #: ../fuse/guestmount.pod:90
31947 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
31952 #: ../fuse/guestmount.pod:96
31953 msgid "B<--dir-cache-timeout N>"
31958 #: ../fuse/guestmount.pod:98
31960 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
31961 "seconds. The readdir cache [actually, there are several semi-independent "
31962 "caches] is populated after a readdir(2) call with the stat and extended "
31963 "attributes of the files in the directory, in anticipation that they will be "
31964 "requested soon after."
31969 #: ../fuse/guestmount.pod:104
31971 "There is also a different attribute cache implemented by FUSE (see the FUSE "
31972 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
31973 "requests, only cache existing ones."
31978 #: ../fuse/guestmount.pod:115
31979 msgid "B<--format=raw|qcow2|..> | B<--format>"
31984 #: ../fuse/guestmount.pod:122
31986 "If you have untrusted raw-format guest disk images, you should use this "
31987 "option to specify the disk format. This avoids a possible security problem "
31988 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
31989 "guestfs_add_drive_opts>."
31994 #: ../fuse/guestmount.pod:127
31995 msgid "B<--fuse-help>"
32000 #: ../fuse/guestmount.pod:129
32001 msgid "Display help on special FUSE options (see I<-o> below)."
32006 #: ../fuse/guestmount.pod:133
32007 msgid "Display brief help and exit."
32012 #: ../fuse/guestmount.pod:135
32013 msgid "B<-i> | B<--inspector>"
32018 #: ../fuse/guestmount.pod:155
32020 "Mount the named partition or logical volume on the given mountpoint B<in the "
32021 "guest> (this has nothing to do with mountpoints in the host)."
32026 #: ../fuse/guestmount.pod:158
32028 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
32029 "something on C</>."
32034 #: ../fuse/guestmount.pod:171
32035 msgid "B<-n> | B<--no-sync>"
32040 #: ../fuse/guestmount.pod:173
32042 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
32043 "unmounted. If you specify this option, then we don't attempt to sync the "
32044 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
32049 #: ../fuse/guestmount.pod:178
32050 msgid "B<-o option> | B<--option option>"
32055 #: ../fuse/guestmount.pod:180
32056 msgid "Pass extra options to FUSE."
32061 #: ../fuse/guestmount.pod:182
32063 "To get a list of all the extra options supported by FUSE, use the command "
32064 "below. Note that only the FUSE I<-o> options can be passed, and only some "
32065 "of them are a good idea."
32070 #: ../fuse/guestmount.pod:186
32073 " guestmount --fuse-help\n"
32079 #: ../fuse/guestmount.pod:188
32080 msgid "Some potentially useful FUSE options:"
32085 #: ../fuse/guestmount.pod:192
32086 msgid "B<-o allow_other>"
32091 #: ../fuse/guestmount.pod:194
32092 msgid "Allow other users to see the filesystem."
32097 #: ../fuse/guestmount.pod:196
32098 msgid "B<-o attr_timeout=N>"
32103 #: ../fuse/guestmount.pod:198
32104 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
32109 #: ../fuse/guestmount.pod:200
32110 msgid "B<-o kernel_cache>"
32115 #: ../fuse/guestmount.pod:202
32117 "Allow the kernel to cache files (reduces the number of reads that have to go "
32118 "through the L<guestfs(3)> API). This is generally a good idea if you can "
32119 "afford the extra memory usage."
32124 #: ../fuse/guestmount.pod:206
32125 msgid "B<-o uid=N> B<-o gid=N>"
32130 #: ../fuse/guestmount.pod:208
32132 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
32133 "the chosen values."
32138 #: ../fuse/guestmount.pod:213
32139 msgid "B<-r> | B<--ro>"
32144 #: ../fuse/guestmount.pod:215
32146 "Add devices and mount everything read-only. Also disallow writes and make "
32147 "the disk appear read-only to FUSE."
32152 #: ../fuse/guestmount.pod:218
32154 "This is highly recommended if you are not going to edit the guest disk. If "
32155 "the guest is running and this option is I<not> supplied, then there is a "
32156 "strong risk of disk corruption in the guest. We try to prevent this from "
32157 "happening, but it is not always possible."
32162 #: ../fuse/guestmount.pod:223
32163 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32168 #: ../fuse/guestmount.pod:227
32169 msgid "Enable SELinux support for the guest."
32174 #: ../fuse/guestmount.pod:229
32175 msgid "B<-v> | B<--verbose>"
32180 #: ../fuse/guestmount.pod:231
32181 msgid "Enable verbose messages from underlying libguestfs."
32186 #: ../fuse/guestmount.pod:233
32187 msgid "B<-V> | B<--version>"
32192 #: ../fuse/guestmount.pod:235
32193 msgid "Display the program version and exit."
32198 #: ../fuse/guestmount.pod:237
32199 msgid "B<-w> | B<--rw>"
32203 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
32204 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
32209 #: ../fuse/guestmount.pod:244
32210 msgid "B<-x> | B<--trace>"
32215 #: ../fuse/guestmount.pod:246
32216 msgid "Trace libguestfs calls and entry into each FUSE function."
32221 #: ../fuse/guestmount.pod:248
32222 msgid "This also stops the daemon from forking into the background."
32227 #: ../fuse/guestmount.pod:269
32229 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
32230 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
32236 #: ../tools/virt-edit.pl:34
32237 msgid "virt-edit - Edit a file in a virtual machine"
32242 #: ../tools/virt-edit.pl:38
32245 " virt-edit [--options] domname file\n"
32251 #: ../tools/virt-edit.pl:40
32254 " virt-edit [--options] disk.img [disk.img ...] file\n"
32260 #: ../tools/virt-edit.pl:42
32263 " virt-edit [domname|disk.img] file -e 'expr'\n"
32269 #: ../tools/virt-edit.pl:46
32271 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
32272 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
32273 "doing this, but doesn't catch all cases."
32278 #: ../tools/virt-edit.pl:52
32280 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
32281 "the named virtual machine (or disk image)."
32286 #: ../tools/virt-edit.pl:55
32288 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
32289 "you should look at the L<guestfish(1)> tool."
32294 #: ../tools/virt-edit.pl:60
32295 msgid "Edit the named files interactively:"
32300 #: ../tools/virt-edit.pl:62
32303 " virt-edit mydomain /boot/grub/grub.conf\n"
32309 #: ../tools/virt-edit.pl:64
32312 " virt-edit mydomain /etc/passwd\n"
32318 #: ../tools/virt-edit.pl:66
32320 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
32321 "below). To change the init default level to 5:"
32326 #: ../tools/virt-edit.pl:70
32329 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
32335 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106
32336 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
32337 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
32338 msgid "Display brief help."
32343 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114
32344 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
32345 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
32346 #: ../tools/virt-list-partitions.pl:72
32347 msgid "Display version number and exit."
32352 #: ../tools/virt-edit.pl:96
32353 msgid "B<--backup extension> | B<-b extension>"
32358 #: ../tools/virt-edit.pl:98
32360 "Create a backup of the original file I<in the guest disk image>. The backup "
32361 "has the original filename with C<extension> added."
32366 #: ../tools/virt-edit.pl:101
32368 "Usually the first character of C<extension> would be a dot C<.> so you would "
32374 #: ../tools/virt-edit.pl:104
32377 " virt-edit -b .orig [etc]\n"
32383 #: ../tools/virt-edit.pl:106
32384 msgid "By default, no backup file is made."
32389 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128
32390 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
32391 #: ../tools/virt-list-partitions.pl:78
32392 msgid "B<--connect URI> | B<-c URI>"
32397 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130
32398 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
32399 #: ../tools/virt-list-partitions.pl:80
32401 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
32402 "to the default libvirt hypervisor."
32407 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133
32408 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
32409 #: ../tools/virt-list-partitions.pl:83
32411 "If you specify guest block devices directly, then libvirt is not used at all."
32416 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140
32417 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
32418 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
32419 msgid "B<--format> raw"
32424 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142
32425 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
32426 #: ../tools/virt-list-partitions.pl:92
32428 "Specify the format of disk images given on the command line. If this is "
32429 "omitted then the format is autodetected from the content of the disk image."
32434 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146
32435 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
32436 #: ../tools/virt-list-partitions.pl:96
32438 "If disk images are requested from libvirt, then this program asks libvirt "
32439 "for this information. In this case, the value of the format parameter is "
32445 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150
32446 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
32447 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
32448 #: ../tools/virt-list-partitions.pl:100
32450 "If working with untrusted raw-format guest disk images, you should ensure "
32451 "the format is always specified."
32456 #: ../tools/virt-edit.pl:141
32457 msgid "B<--expr EXPR> | B<-e EXPR>"
32462 #: ../tools/virt-edit.pl:143
32464 "Instead of launching the external editor, non-interactively apply the Perl "
32465 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
32471 #: ../tools/virt-edit.pl:147
32473 "Be careful to properly quote the expression to prevent it from being altered "
32479 #: ../tools/virt-edit.pl:268
32480 msgid "NON-INTERACTIVE EDITING"
32485 #: ../tools/virt-edit.pl:270
32487 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
32488 "administrator can interactively edit the file."
32493 #: ../tools/virt-edit.pl:273
32495 "There are two ways also to use C<virt-edit> from scripts in order to make "
32496 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
32497 "like this, it's less error-prone to write scripts directly using the "
32498 "libguestfs API and Augeas for configuration file editing.)"
32503 #: ../tools/virt-edit.pl:279
32505 "The first method is to temporarily set C<$EDITOR> to any script or program "
32506 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
32507 "update C<tmpfile> in place however it likes."
32512 #: ../tools/virt-edit.pl:283
32514 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
32515 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
32516 "instances of C<foo> with C<bar> in a file:"
32521 #: ../tools/virt-edit.pl:287
32524 " virt-edit domname filename -e 's/foo/bar/'\n"
32530 #: ../tools/virt-edit.pl:289
32532 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
32533 "For example to delete root's password you could do:"
32538 #: ../tools/virt-edit.pl:292
32541 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
32547 #: ../tools/virt-edit.pl:294
32549 "What really happens is that the snippet is evaluated as a Perl expression "
32550 "for each line of the file. The line, including the final C<\\n>, is passed "
32551 "in C<$_> and the expression should update C<$_> or leave it unchanged."
32556 #: ../tools/virt-edit.pl:299
32558 "To delete a line, set C<$_> to the empty string. For example, to delete the "
32559 "C<apache> user account from the password file you can do:"
32564 #: ../tools/virt-edit.pl:302
32567 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
32573 #: ../tools/virt-edit.pl:304
32575 "To insert a line, prepend or append it to C<$_>. However appending lines to "
32576 "the end of the file is rather difficult this way since there is no concept "
32577 "of \"last line of the file\" - your expression just doesn't get called "
32578 "again. You might want to use the first method (setting C<$EDITOR>) if you "
32584 #: ../tools/virt-edit.pl:310
32586 "The variable C<$lineno> contains the current line number. As is "
32587 "traditional, the first line in the file is number C<1>."
32592 #: ../tools/virt-edit.pl:313
32594 "The return value from the expression is ignored, but the expression may call "
32595 "C<die> in order to abort the whole program, leaving the original file "
32601 #: ../tools/virt-edit.pl:317
32603 "Remember when matching the end of a line that C<$_> may contain the final C<"
32604 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
32605 "newline then neither of these. Thus to match or substitute some text at the "
32606 "end of a line, use this regular expression:"
32611 #: ../tools/virt-edit.pl:322
32614 " /some text(\\r?\\n)?$/\n"
32620 #: ../tools/virt-edit.pl:324
32622 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
32623 "$_> itself (since that would remove all newlines from the file):"
32628 #: ../tools/virt-edit.pl:328
32631 " my $m = $_; chomp $m; $m =~ /some text$/\n"
32637 #: ../tools/virt-edit.pl:334
32643 #: ../tools/virt-edit.pl:336
32645 "If set, this string is used as the editor. It may contain arguments, eg. C<"
32651 #: ../tools/virt-edit.pl:339
32652 msgid "If not set, C<vi> is used."
32657 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559
32658 #: ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182
32659 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
32660 #: ../tools/virt-list-partitions.pl:250
32661 msgid "SHELL QUOTING"
32666 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567
32667 #: ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184
32668 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
32669 #: ../tools/virt-list-partitions.pl:252
32671 "Libvirt guest names can contain arbitrary characters, some of which have "
32672 "meaning to the shell such as C<#> and space. You may need to quote or "
32673 "escape these characters on the command line. See the shell manual page L<sh"
32674 "(1)> for details."
32678 #: ../tools/virt-edit.pl:352
32680 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
32681 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
32682 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
32687 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598
32688 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202
32689 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
32690 #: ../tools/virt-list-partitions.pl:269
32696 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600
32697 #: ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204
32698 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
32699 #: ../tools/virt-list-partitions.pl:271
32700 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
32705 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
32706 msgid "Copyright (C) 2009-2010 Red Hat Inc."
32711 #: ../tools/virt-win-reg.pl:37
32713 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
32718 #: ../tools/virt-win-reg.pl:41
32721 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
32727 #: ../tools/virt-win-reg.pl:43
32730 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
32736 #: ../tools/virt-win-reg.pl:45
32739 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
32745 #: ../tools/virt-win-reg.pl:47
32748 " virt-win-reg --merge domname [input.reg ...]\n"
32754 #: ../tools/virt-win-reg.pl:49
32757 " virt-win-reg [--options] disk.img ... # instead of domname\n"
32763 #: ../tools/virt-win-reg.pl:53
32765 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
32766 "virtual machines. If you do this, you I<will> get irreversible disk "
32767 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
32768 "but doesn't catch all cases."
32773 #: ../tools/virt-win-reg.pl:58
32775 "Modifying the Windows Registry is an inherently risky operation. The format "
32776 "is deliberately obscure and undocumented, and Registry changes can leave the "
32777 "system unbootable. Therefore when using the C<--merge> option, make sure "
32778 "you have a reliable backup first."
32783 #: ../tools/virt-win-reg.pl:65
32785 "This program can export and merge Windows Registry entries from a Windows "
32791 #: ../tools/virt-win-reg.pl:68
32793 "The first parameter is the libvirt guest name or the raw disk image of a "
32799 #: ../tools/virt-win-reg.pl:71
32801 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
32802 "exported (recursively). For example:"
32807 #: ../tools/virt-win-reg.pl:74
32810 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
32816 #: ../tools/virt-win-reg.pl:76
32818 "You can also display single values from within registry keys, for example:"
32823 #: ../tools/virt-win-reg.pl:79
32826 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
32827 " $ virt-win-reg Windows7 $cvkey ProductName\n"
32828 " Windows 7 Enterprise\n"
32834 #: ../tools/virt-win-reg.pl:83
32836 "With C<--merge>, you can merge a textual regedit file into the Windows "
32842 #: ../tools/virt-win-reg.pl:86
32845 " $ virt-win-reg --merge Windows7 changes.reg\n"
32851 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
32857 #: ../tools/virt-win-reg.pl:90
32859 "This program is only meant for simple access to the registry. If you want "
32860 "to do complicated things with the registry, we suggest you download the "
32861 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
32862 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
32863 "L<hivexregedit(1)>."
32868 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
32874 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
32875 msgid "Enable debugging messages."
32880 #: ../tools/virt-win-reg.pl:157
32886 #: ../tools/virt-win-reg.pl:159
32888 "In merge mode, this merges a textual regedit file into the Windows Registry "
32889 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
32890 "displays or exports Registry entries instead."
32895 #: ../tools/virt-win-reg.pl:163
32897 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
32898 "result in disk corruption. However exporting (without this flag) is always "
32904 #: ../tools/virt-win-reg.pl:171
32905 msgid "B<--encoding> UTF-16LE|ASCII"
32910 #: ../tools/virt-win-reg.pl:173
32912 "When merging (only), you may need to specify the encoding for strings to be "
32913 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
32914 "(3)/ENCODING STRINGS>."
32919 #: ../tools/virt-win-reg.pl:177
32921 "The default is to use UTF-16LE, which should work with recent versions of "
32927 #: ../tools/virt-win-reg.pl:402
32928 msgid "SUPPORTED SYSTEMS"
32933 #: ../tools/virt-win-reg.pl:404
32935 "The program currently supports Windows NT-derived guests starting with "
32936 "Windows XP through to at least Windows 7."
32941 #: ../tools/virt-win-reg.pl:407
32943 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
32944 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
32945 "and C<HKEY_USERS\\.DEFAULT>."
32950 #: ../tools/virt-win-reg.pl:411
32952 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
32958 #: ../tools/virt-win-reg.pl:414
32960 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
32966 #: ../tools/virt-win-reg.pl:417
32972 #: ../tools/virt-win-reg.pl:419
32974 "C<virt-win-reg> expects that regedit files have already been reencoded in "
32975 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
32976 "style line endings. Since Windows regedit files are often in UTF-16LE with "
32977 "Windows-style line endings, you may need to reencode the whole file before "
32978 "or after processing."
32983 #: ../tools/virt-win-reg.pl:425
32985 "To reencode a file from Windows format to Linux (before processing it with "
32986 "the C<--merge> option), you would do something like this:"
32991 #: ../tools/virt-win-reg.pl:428
32994 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
33000 #: ../tools/virt-win-reg.pl:430
33002 "To go in the opposite direction, after exporting and before sending the file "
33003 "to a Windows user, do something like this:"
33008 #: ../tools/virt-win-reg.pl:433
33011 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
33017 #: ../tools/virt-win-reg.pl:435
33018 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
33023 #: ../tools/virt-win-reg.pl:437
33025 "If you are unsure about the current encoding, use the L<file(1)> command. "
33026 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
33027 "style (CRLF) line endings, like this:"
33032 #: ../tools/virt-win-reg.pl:441
33035 " $ file software.reg\n"
33036 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
33037 " with CRLF line terminators\n"
33043 #: ../tools/virt-win-reg.pl:445
33044 msgid "This file would need conversion before you could C<--merge> it."
33049 #: ../tools/virt-win-reg.pl:447
33050 msgid "CurrentControlSet etc."
33055 #: ../tools/virt-win-reg.pl:449
33057 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
33058 "Registry at the level of the hive file, and therefore you cannot modify "
33064 #: ../tools/virt-win-reg.pl:453
33066 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
33067 "circumstances it might refer to another control set. The way to find out is "
33068 "to look at the C<HKLM\\SYSTEM\\Select> key:"
33073 #: ../tools/virt-win-reg.pl:457
33076 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
33077 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
33078 " \"Current\"=dword:00000001\n"
33079 " \"Default\"=dword:00000001\n"
33080 " \"Failed\"=dword:00000000\n"
33081 " \"LastKnownGood\"=dword:00000002\n"
33087 #: ../tools/virt-win-reg.pl:464
33088 msgid "\"Current\" is the one which Windows will choose when it boots."
33093 #: ../tools/virt-win-reg.pl:466
33095 "Similarly, other C<Current...> keys in the path may need to be replaced."
33100 #: ../tools/virt-win-reg.pl:469
33101 msgid "WINDOWS TIPS"
33106 #: ../tools/virt-win-reg.pl:471
33108 "Note that some of these tips modify the guest disk image. The guest I<must> "
33109 "be shut off, else you will get disk corruption."
33114 #: ../tools/virt-win-reg.pl:474
33115 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
33120 #: ../tools/virt-win-reg.pl:476
33122 "Prepare a DOS batch script, VBScript or executable. Upload this using "
33123 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
33124 "is uploaded into C<C:\\>:"
33129 #: ../tools/virt-win-reg.pl:480
33132 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
33138 #: ../tools/virt-win-reg.pl:482
33139 msgid "Prepare a regedit file containing the registry change:"
33144 #: ../tools/virt-win-reg.pl:484
33147 " cat > test.reg <<'EOF'\n"
33148 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
33149 " \"Test\"=\"c:\\\\test.bat\"\n"
33156 #: ../tools/virt-win-reg.pl:489
33158 "In this example we use the key C<RunOnce> which means that the script will "
33159 "run precisely once when the first user logs in. If you want it to run every "
33160 "time a user logs in, replace C<RunOnce> with C<Run>."
33165 #: ../tools/virt-win-reg.pl:493
33166 msgid "Now update the registry:"
33171 #: ../tools/virt-win-reg.pl:495
33174 " virt-win-reg --merge WindowsGuest test.reg\n"
33180 #: ../tools/virt-win-reg.pl:497
33181 msgid "INSTALLING A SERVICE"
33186 #: ../tools/virt-win-reg.pl:499
33188 "This section assumes you are familiar with Windows services, and you either "
33189 "have a program which handles the Windows Service Control Protocol directly "
33190 "or you want to run any program using a service wrapper like SrvAny or the "
33196 #: ../tools/virt-win-reg.pl:504
33198 "First upload the program and optionally the service wrapper. In this case "
33199 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
33204 #: ../tools/virt-win-reg.pl:508
33207 " guestfish -i -d WindowsGuest <<EOF\n"
33208 " upload rhsrvany.exe /rhsrvany.exe\n"
33209 " upload test.exe /test.exe\n"
33216 #: ../tools/virt-win-reg.pl:513
33218 "Prepare a regedit file containing the registry changes. In this example, "
33219 "the first registry change is needed for the service itself or the service "
33220 "wrapper (if used). The second registry change is only needed because I am "
33221 "using the RHSrvAny service wrapper."
33226 #: ../tools/virt-win-reg.pl:518
33229 " cat > service.reg <<'EOF'\n"
33230 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
33231 " \"Type\"=dword:00000010\n"
33232 " \"Start\"=dword:00000002\n"
33233 " \"ErrorControl\"=dword:00000001\n"
33234 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
33235 " \"DisplayName\"=\"RHSrvAny\"\n"
33236 " \"ObjectName\"=\"NetworkService\"\n"
33242 #: ../tools/virt-win-reg.pl:527
33245 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
33246 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
33247 " \"PWD\"=\"c:\\\\Temp\"\n"
33254 #: ../tools/virt-win-reg.pl:538
33256 "For use of C<ControlSet001> see the section above in this manual page. You "
33257 "may need to adjust this according to the control set that is in use by the "
33263 #: ../tools/virt-win-reg.pl:544
33265 "C<\"ObjectName\"> controls the privileges that the service will have. An "
33266 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
33267 "privileged account."
33272 #: ../tools/virt-win-reg.pl:550
33274 "For the meaning of the magic numbers, see this Microsoft KB article: "
33275 "L<http://support.microsoft.com/kb/103000>."
33280 #: ../tools/virt-win-reg.pl:555
33281 msgid "Update the registry:"
33286 #: ../tools/virt-win-reg.pl:557
33289 " virt-win-reg --merge WindowsGuest service.reg\n"
33295 #: ../tools/virt-win-reg.pl:561
33297 "Be careful when passing parameters containing C<\\> (backslash) in the "
33298 "shell. Usually you will have to use 'single quotes' or double backslashes "
33299 "(but not both) to protect them from the shell."
33304 #: ../tools/virt-win-reg.pl:565
33305 msgid "Paths and value names are case-insensitive."
33310 #: ../tools/virt-win-reg.pl:574
33312 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
33313 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
33314 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33319 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
33321 "When reporting bugs, please enable debugging and capture the I<complete> "
33327 #: ../tools/virt-win-reg.pl:592
33330 " export LIBGUESTFS_DEBUG=1\n"
33331 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
33337 #: ../tools/virt-win-reg.pl:595
33339 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
33345 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516
33346 #: ../tools/virt-make-fs.pl:570
33347 msgid "Copyright (C) 2010 Red Hat Inc."
33352 #: ../tools/virt-resize.pl:42
33353 msgid "virt-resize - Resize a virtual machine disk"
33358 #: ../tools/virt-resize.pl:46
33361 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
33362 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
33363 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
33369 #: ../tools/virt-resize.pl:52
33371 "Virt-resize is a tool which can resize a virtual machine disk, making it "
33372 "larger or smaller overall, and resizing or deleting any partitions contained "
33378 #: ../tools/virt-resize.pl:56
33380 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
33381 "not> be used on live virtual machines - for consistent results, shut the "
33382 "virtual machine down before resizing it."
33387 #: ../tools/virt-resize.pl:60
33389 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
33390 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
33395 #: ../tools/virt-resize.pl:66
33397 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
33398 "fill the extra 5GB of space."
33402 #: ../tools/virt-resize.pl:69
33405 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
33406 " virt-filesystems --long -h --all -a olddisk\n"
33407 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
33408 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
33414 #: ../tools/virt-resize.pl:74
33416 "As above, but make the /boot partition 200MB bigger, while giving the "
33417 "remaining space to /dev/sda2:"
33422 #: ../tools/virt-resize.pl:77
33425 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
33431 #: ../tools/virt-resize.pl:79
33432 msgid "As above, but the output format will be uncompressed qcow2:"
33437 #: ../tools/virt-resize.pl:81
33440 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
33441 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
33447 #: ../tools/virt-resize.pl:84
33448 msgid "DETAILED USAGE"
33453 #: ../tools/virt-resize.pl:86
33454 msgid "EXPANDING A VIRTUAL MACHINE DISK"
33459 #: ../tools/virt-resize.pl:90
33460 msgid "1. Shut down the virtual machine"
33465 #: ../tools/virt-resize.pl:92
33466 msgid "2. Locate input disk image"
33471 #: ../tools/virt-resize.pl:94
33473 "Locate the input disk image (ie. the file or device on the host containing "
33474 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
33475 "dumpxml> like this to find the disk image name:"
33480 #: ../tools/virt-resize.pl:98
33483 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
33484 " Found 1 nodes:\n"
33486 " <source dev=\"/dev/vg/lv_guest\" />\n"
33492 #: ../tools/virt-resize.pl:103
33493 msgid "3. Look at current sizing"
33498 #: ../tools/virt-resize.pl:105
33499 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
33504 #: ../tools/virt-resize.pl:108
33507 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
33508 " Name Type Size Parent\n"
33509 " /dev/sda1 partition 101M /dev/sda\n"
33510 " /dev/sda2 partition 7.9G /dev/sda\n"
33511 " /dev/sda device 8.0G -\n"
33517 #: ../tools/virt-resize.pl:114
33519 "(This example is a virtual machine with an 8 GB disk which we would like to "
33520 "expand up to 10 GB)."
33525 #: ../tools/virt-resize.pl:117
33526 msgid "4. Create output disk"
33531 #: ../tools/virt-resize.pl:119
33533 "Virt-resize cannot do in-place disk modifications. You have to have space "
33534 "to store the resized output disk."
33539 #: ../tools/virt-resize.pl:122
33541 "To store the resized disk image in a file, create a file of a suitable size:"
33546 #: ../tools/virt-resize.pl:125
33549 " # rm -f outdisk\n"
33550 " # truncate -s 10G outdisk\n"
33556 #: ../tools/virt-resize.pl:128
33557 msgid "Or use L<lvcreate(1)> to create a logical volume:"
33562 #: ../tools/virt-resize.pl:130
33565 " # lvcreate -L 10G -n lv_name vg_name\n"
33571 #: ../tools/virt-resize.pl:132
33572 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
33577 #: ../tools/virt-resize.pl:134
33580 " # virsh pool-list\n"
33581 " # virsh vol-create-as poolname newvol 10G\n"
33587 #: ../tools/virt-resize.pl:137
33593 #: ../tools/virt-resize.pl:139
33595 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
33596 "file) and the output disk. The output disk is the one created in the "
33602 #: ../tools/virt-resize.pl:143
33605 " # virt-resize indisk outdisk\n"
33611 #: ../tools/virt-resize.pl:145
33613 "This command just copies disk image C<indisk> to disk image C<outdisk> "
33614 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
33615 "larger, then an extra, empty partition is created at the end of the disk "
33616 "covering the extra space. If C<outdisk> is smaller, then it will give an "
33622 #: ../tools/virt-resize.pl:151
33624 "More realistically you'd want to expand existing partitions in the disk "
33625 "image by passing extra options (for the full list see the L</OPTIONS> "
33631 #: ../tools/virt-resize.pl:155
33633 "L</--expand> is the most useful option. It expands the named partition "
33634 "within the disk to fill any extra space:"
33639 #: ../tools/virt-resize.pl:158
33642 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
33648 #: ../tools/virt-resize.pl:160
33650 "(In this case, an extra partition is I<not> created at the end of the disk, "
33651 "because there will be no unused space)."
33656 #: ../tools/virt-resize.pl:163
33658 "L</--resize> is the other commonly used option. The following would "
33659 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
33660 "rest of the available space:"
33665 #: ../tools/virt-resize.pl:167
33668 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
33669 " indisk outdisk\n"
33675 #: ../tools/virt-resize.pl:170
33677 "If the expanded partition in the image contains a filesystem or LVM PV, then "
33678 "if virt-resize knows how, it will resize the contents, the equivalent of "
33679 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
33680 ">. However virt-resize does not know how to resize some filesystems, so you "
33681 "would have to online resize them after booting the guest."
33686 #: ../tools/virt-resize.pl:177
33687 msgid "Other options are covered below."
33692 #: ../tools/virt-resize.pl:179
33698 #: ../tools/virt-resize.pl:181
33699 msgid "Thoroughly test the new disk image I<before> discarding the old one."
33704 #: ../tools/virt-resize.pl:183
33705 msgid "If you are using libvirt, edit the XML to point at the new disk:"
33710 #: ../tools/virt-resize.pl:185
33713 " # virsh edit guestname\n"
33719 #: ../tools/virt-resize.pl:187
33721 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
33722 "html#elementsDisks>"
33727 #: ../tools/virt-resize.pl:190
33728 msgid "Then start up the domain with the new, resized disk:"
33733 #: ../tools/virt-resize.pl:192
33736 " # virsh start guestname\n"
33742 #: ../tools/virt-resize.pl:194
33744 "and check that it still works. See also the L</NOTES> section below for "
33745 "additional information."
33750 #: ../tools/virt-resize.pl:197
33751 msgid "7. Resize LVs etc inside the guest"
33756 #: ../tools/virt-resize.pl:199
33757 msgid "(This can also be done offline using L<guestfish(1)>)"
33762 #: ../tools/virt-resize.pl:201
33764 "Once the guest has booted you should see the new space available, at least "
33765 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
33766 "may need to resize LVs inside PVs, and also resize filesystem types that "
33767 "virt-resize does not know how to expand."
33772 #: ../tools/virt-resize.pl:208
33773 msgid "SHRINKING A VIRTUAL MACHINE DISK"
33778 #: ../tools/virt-resize.pl:210
33780 "Shrinking is somewhat more complex than expanding, and only an overview is "
33786 #: ../tools/virt-resize.pl:213
33788 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
33789 "filesystems). The user has to shrink content before passing the disk image "
33790 "to virt-resize, and virt-resize will check that the content has been shrunk "
33796 #: ../tools/virt-resize.pl:218
33797 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
33802 #: ../tools/virt-resize.pl:220
33804 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
33805 "steps 3 and 4 above to allocate a new disk image."
33810 #: ../tools/virt-resize.pl:223
33812 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
33817 #: ../tools/virt-resize.pl:226
33818 msgid "IGNORING OR DELETING PARTITIONS"
33823 #: ../tools/virt-resize.pl:228
33825 "virt-resize also gives a convenient way to ignore or delete partitions when "
33826 "copying from the input disk to the output disk. Ignoring a partition speeds "
33827 "up the copy where you don't care about the existing contents of a "
33828 "partition. Deleting a partition removes it completely, but note that it "
33829 "also renumbers any partitions after the one which is deleted, which can "
33830 "leave some guests unbootable."
33835 #: ../tools/virt-resize.pl:235
33836 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
33841 #: ../tools/virt-resize.pl:237
33843 "If the input disk is in qcow2 format, then you may prefer that the output is "
33844 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
33845 "the fly. The output format is simply determined by the format of the empty "
33846 "output container that you provide. Thus to create qcow2 output, use:"
33851 #: ../tools/virt-resize.pl:243
33854 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
33860 #: ../tools/virt-resize.pl:245
33861 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
33866 #: ../tools/virt-resize.pl:247
33867 msgid "Similarly, to get non-sparse raw output use:"
33872 #: ../tools/virt-resize.pl:249
33875 " fallocate -l size outdisk\n"
33881 #: ../tools/virt-resize.pl:251
33883 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
33884 "dev/zero of=outdisk bs=1M count=..>)"
33889 #: ../tools/virt-resize.pl:264
33890 msgid "Display help."
33895 #: ../tools/virt-resize.pl:278
33896 msgid "B<--resize part=size>"
33901 #: ../tools/virt-resize.pl:280
33903 "Resize the named partition (expanding or shrinking it) so that it has the "
33909 #: ../tools/virt-resize.pl:283
33911 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
33912 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
33913 "Exabytes; or as a percentage of the current size; or as a relative number or "
33914 "percentage. For example:"
33919 #: ../tools/virt-resize.pl:288
33922 " --resize /dev/sda2=10G\n"
33928 #: ../tools/virt-resize.pl:290
33931 " --resize /dev/sda4=90%\n"
33937 #: ../tools/virt-resize.pl:292
33940 " --resize /dev/sda2=+1G\n"
33946 #: ../tools/virt-resize.pl:294
33949 " --resize /dev/sda2=-200M\n"
33955 #: ../tools/virt-resize.pl:296
33958 " --resize /dev/sda1=+128K\n"
33964 #: ../tools/virt-resize.pl:298
33967 " --resize /dev/sda1=+10%\n"
33973 #: ../tools/virt-resize.pl:300
33976 " --resize /dev/sda1=-10%\n"
33982 #: ../tools/virt-resize.pl:302
33984 "You can increase the size of any partition. Virt-resize will expand the "
33985 "direct content of the partition if it knows how (see C<--expand> below)."
33990 #: ../tools/virt-resize.pl:306
33992 "You can only I<decrease> the size of partitions that contain filesystems or "
33993 "PVs which have already been shrunk. Virt-resize will check this has been "
33994 "done before proceeding, or else will print an error (see also C<--resize-"
34000 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
34001 #: ../tools/virt-resize.pl:420
34002 msgid "You can give this option multiple times."
34007 #: ../tools/virt-resize.pl:317
34008 msgid "B<--resize-force part=size>"
34013 #: ../tools/virt-resize.pl:319
34015 "This is the same as C<--resize> except that it will let you decrease the "
34016 "size of any partition. Generally this means you will lose any data which "
34017 "was at the end of the partition you shrink, but you may not care about that "
34018 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
34019 "as a swap partition)."
34024 #: ../tools/virt-resize.pl:325
34025 msgid "See also the C<--ignore> option."
34030 #: ../tools/virt-resize.pl:331
34031 msgid "B<--expand part>"
34036 #: ../tools/virt-resize.pl:333
34038 "Expand the named partition so it uses up all extra space (space left over "
34039 "after any other resize changes that you request have been done)."
34044 #: ../tools/virt-resize.pl:336
34046 "If virt-resize knows how, it will expand the direct content of the "
34047 "partition. For example, if the partition is an LVM PV, it will expand the "
34048 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
34049 "content it doesn't know about alone."
34054 #: ../tools/virt-resize.pl:341
34055 msgid "Currently virt-resize can resize:"
34060 #: ../tools/virt-resize.pl:347
34062 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
34068 #: ../tools/virt-resize.pl:352
34070 "NTFS filesystems contained directly in a partition, if libguestfs was "
34071 "compiled with support for NTFS."
34076 #: ../tools/virt-resize.pl:355
34078 "The filesystem must have been shut down consistently last time it was used. "
34079 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
34080 "consistency check, so at the first boot after resizing Windows will check "
34086 #: ../tools/virt-resize.pl:362
34088 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
34089 "inside the PV, but see the C<--LV-expand> option. The user could also "
34090 "resize LVs as desired after boot."
34095 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
34096 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
34101 #: ../tools/virt-resize.pl:374
34102 msgid "B<--shrink part>"
34107 #: ../tools/virt-resize.pl:376
34109 "Shrink the named partition until the overall disk image fits in the "
34110 "destination. The named partition B<must> contain a filesystem or PV which "
34111 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
34112 "online tools). Virt-resize will check this and give an error if it has not "
34118 #: ../tools/virt-resize.pl:382
34120 "The amount by which the overall disk must be shrunk (after carrying out all "
34121 "other operations requested by the user) is called the \"deficit\". For "
34122 "example, a straight copy (assume no other operations) from a 5GB disk image "
34123 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
34124 "would give an error unless the user specified a partition to shrink and that "
34125 "partition had more than a gigabyte of free space."
34130 #: ../tools/virt-resize.pl:396
34131 msgid "B<--ignore part>"
34136 #: ../tools/virt-resize.pl:398
34138 "Ignore the named partition. Effectively this means the partition is "
34139 "allocated on the destination disk, but the content is not copied across from "
34140 "the source disk. The content of the partition will be blank (all zero "
34146 #: ../tools/virt-resize.pl:409
34147 msgid "B<--delete part>"
34152 #: ../tools/virt-resize.pl:411
34154 "Delete the named partition. It would be more accurate to describe this as "
34155 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
34156 "the original disk image is left intact."
34161 #: ../tools/virt-resize.pl:415
34163 "Note that when you delete a partition, then anything contained in the "
34164 "partition is also deleted. Furthermore, this causes any partitions that "
34165 "come after to be I<renumbered>, which can easily make your guest unbootable."
34170 #: ../tools/virt-resize.pl:426
34171 msgid "B<--LV-expand logvol>"
34176 #: ../tools/virt-resize.pl:428
34178 "This takes the logical volume and, as a final step, expands it to fill all "
34179 "the space available in its volume group. A typical usage, assuming a Linux "
34180 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
34181 "lv_root> would be:"
34186 #: ../tools/virt-resize.pl:433
34189 " virt-resize indisk outdisk \\\n"
34190 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
34196 #: ../tools/virt-resize.pl:436
34198 "This would first expand the partition (and PV), and then expand the root "
34199 "device to fill the extra space in the PV."
34204 #: ../tools/virt-resize.pl:439
34206 "The contents of the LV are also resized if virt-resize knows how to do "
34207 "that. You can stop virt-resize from trying to expand the content by using "
34208 "the option C<--no-expand-content>."
34213 #: ../tools/virt-resize.pl:443
34214 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
34219 #: ../tools/virt-resize.pl:446
34221 "You can give this option multiple times, I<but> it doesn't make sense to do "
34222 "this unless the logical volumes you specify are all in different volume "
34228 #: ../tools/virt-resize.pl:454
34229 msgid "B<--no-copy-boot-loader>"
34234 #: ../tools/virt-resize.pl:456
34236 "By default, virt-resize copies over some sectors at the start of the disk "
34237 "(up to the beginning of the first partition). Commonly these sectors "
34238 "contain the Master Boot Record (MBR) and the boot loader, and are required "
34239 "in order for the guest to boot correctly."
34244 #: ../tools/virt-resize.pl:461
34246 "If you specify this flag, then this initial copy is not done. You may need "
34247 "to reinstall the boot loader in this case."
34252 #: ../tools/virt-resize.pl:469
34253 msgid "B<--no-extra-partition>"
34258 #: ../tools/virt-resize.pl:471
34260 "By default, virt-resize creates an extra partition if there is any extra, "
34261 "unused space after all resizing has happened. Use this option to prevent "
34262 "the extra partition from being created. If you do this then the extra space "
34263 "will be inaccessible until you run fdisk, parted, or some other partitioning "
34264 "tool in the guest."
34269 #: ../tools/virt-resize.pl:477
34271 "Note that if the surplus space is smaller than 10 MB, no extra partition "
34277 #: ../tools/virt-resize.pl:484
34278 msgid "B<--no-expand-content>"
34283 #: ../tools/virt-resize.pl:486
34285 "By default, virt-resize will try to expand the direct contents of "
34286 "partitions, if it knows how (see C<--expand> option above)."
34291 #: ../tools/virt-resize.pl:489
34293 "If you give the C<--no-expand-content> option then virt-resize will not "
34299 #: ../tools/virt-resize.pl:496
34300 msgid "B<-d> | B<--debug>"
34305 #: ../tools/virt-resize.pl:504
34306 msgid "B<-n> | B<--dryrun>"
34311 #: ../tools/virt-resize.pl:506
34312 msgid "Print a summary of what would be done, but don't do anything."
34317 #: ../tools/virt-resize.pl:512
34318 msgid "B<-q> | B<--quiet>"
34323 #: ../tools/virt-resize.pl:514
34324 msgid "Don't print the summary."
34329 #: ../tools/virt-resize.pl:522
34331 "Specify the format of the input disk image. If this flag is not given then "
34332 "it is auto-detected from the image itself."
34337 #: ../tools/virt-resize.pl:528
34339 "Note that this option I<does not> affect the output format. See L</QCOW2 "
34340 "AND NON-SPARSE RAW FORMATS>."
34345 #: ../tools/virt-resize.pl:535
34346 msgid "B<--output-format> raw"
34351 #: ../tools/virt-resize.pl:537
34353 "Specify the format of the output disk image. If this flag is not given then "
34354 "it is auto-detected from the image itself."
34359 #: ../tools/virt-resize.pl:543
34361 "Note that you still need to create the output disk with the right format. "
34362 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
34367 #: ../tools/virt-resize.pl:1425
34373 #: ../tools/virt-resize.pl:1427
34374 msgid "\"Partition 1 does not end on cylinder boundary.\""
34379 #: ../tools/virt-resize.pl:1429
34381 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
34382 "means the partitions will not be aligned to the ancient CHS geometry. "
34383 "However CHS geometry is meaningless for disks manufactured since the early "
34384 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
34385 "cylinders is not required by any modern operating system."
34390 #: ../tools/virt-resize.pl:1436
34391 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
34396 #: ../tools/virt-resize.pl:1438
34398 "In Windows Vista and later versions, Microsoft switched to using a separate "
34399 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
34400 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
34401 "the boot partition. Doing so seems to break the guest completely. However "
34402 "expanding the second partition (ie. C: drive) should work."
34407 #: ../tools/virt-resize.pl:1445
34409 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
34410 "NTFS partitions have been expanded. This is just a safety check and (unless "
34411 "it find errors) is nothing to worry about."
34416 #: ../tools/virt-resize.pl:1449
34417 msgid "GUEST BOOT STUCK AT \"GRUB\""
34422 #: ../tools/virt-resize.pl:1451
34424 "If a Linux guest does not boot after resizing, and the boot is stuck after "
34425 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
34426 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
34427 "although we think is to do with partition alignment."
34432 #: ../tools/virt-resize.pl:1456
34435 " guestfish -i -a newdisk\n"
34436 " ><fs> cat /boot/grub/device.map\n"
34437 " # check the contents of this file are sensible or\n"
34438 " # edit the file if necessary\n"
34439 " ><fs> grub-install / /dev/vda\n"
34446 #: ../tools/virt-resize.pl:1463
34448 "For more flexible guest reconfiguration, including if you need to specify "
34449 "other parameters to grub-install, use L<virt-rescue(1)>."
34454 #: ../tools/virt-resize.pl:1466
34455 msgid "ALTERNATIVE TOOLS"
34460 #: ../tools/virt-resize.pl:1468
34462 "There are several proprietary tools for resizing partitions. We won't "
34463 "mention any here."
34468 #: ../tools/virt-resize.pl:1471
34470 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
34471 "operations on disk images. They can resize and move partitions, but I don't "
34472 "think they can do anything with the contents, and they certainly don't "
34478 #: ../tools/virt-resize.pl:1476
34480 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
34481 "but at a much lower level. You will probably end up hand-calculating sector "
34482 "offsets, which is something that virt-resize was designed to avoid. If you "
34483 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
34489 #: ../tools/virt-resize.pl:1491
34491 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
34492 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
34493 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
34494 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
34495 "libguestfs.org/>."
34500 #: ../tools/virt-list-filesystems.pl:32
34502 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
34507 #: ../tools/virt-list-filesystems.pl:36
34510 " virt-list-filesystems [--options] domname\n"
34516 #: ../tools/virt-list-filesystems.pl:38
34519 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
34525 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
34527 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
34533 #: ../tools/virt-list-filesystems.pl:45
34535 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
34536 "are contained in a virtual machine or disk image."
34541 #: ../tools/virt-list-filesystems.pl:49
34543 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
34544 "functionality. For more complex cases you should look at the L<guestfish(1)"
34550 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
34551 msgid "B<-l> | B<--long>"
34556 #: ../tools/virt-list-filesystems.pl:108
34558 "With this option, C<virt-list-filesystems> displays the type of each "
34559 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
34564 #: ../tools/virt-list-filesystems.pl:115
34565 msgid "B<-a> | B<--all>"
34570 #: ../tools/virt-list-filesystems.pl:117
34572 "Normally we only show mountable filesystems. If this option is given then "
34573 "swap devices are shown too."
34578 #: ../tools/virt-list-filesystems.pl:191
34580 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
34581 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
34582 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34587 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
34588 msgid "Copyright (C) 2009 Red Hat Inc."
34593 #: ../tools/virt-tar.pl:33
34594 msgid "virt-tar - Extract or upload files to a virtual machine"
34599 #: ../tools/virt-tar.pl:37
34602 " virt-tar [--options] -x domname directory tarball\n"
34608 #: ../tools/virt-tar.pl:39
34611 " virt-tar [--options] -u domname tarball directory\n"
34617 #: ../tools/virt-tar.pl:41
34620 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
34626 #: ../tools/virt-tar.pl:43
34629 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
34634 #: ../tools/virt-tar.pl:47
34636 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
34637 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
34642 #: ../tools/virt-tar.pl:52
34643 msgid "Download C</home> from the VM into a local tarball:"
34648 #: ../tools/virt-tar.pl:54
34651 " virt-tar -x domname /home home.tar\n"
34657 #: ../tools/virt-tar.pl:56
34660 " virt-tar -zx domname /home home.tar.gz\n"
34666 #: ../tools/virt-tar.pl:58
34667 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
34672 #: ../tools/virt-tar.pl:60
34675 " virt-tar -u domname uploadstuff.tar /tmp\n"
34681 #: ../tools/virt-tar.pl:62
34684 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
34690 #: ../tools/virt-tar.pl:66
34692 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
34693 "virtual machines. If you do this, you risk disk corruption in the VM. "
34694 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
34699 #: ../tools/virt-tar.pl:71
34701 "You can use C<-x> (extract) on live virtual machines, but you might get "
34702 "inconsistent results or errors if there is filesystem activity inside the "
34703 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
34704 "work, but the only way to guarantee consistent results is if the virtual "
34705 "machine is shut down."
34710 #: ../tools/virt-tar.pl:79
34712 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
34713 "parts of a guest filesystem. There are many possibilities: making backups, "
34714 "uploading data files, snooping on guest activity, fixing or customizing "
34720 #: ../tools/virt-tar.pl:84
34722 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
34723 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
34724 "should look at the L<guestfish(1)> tool."
34729 #: ../tools/virt-tar.pl:88
34731 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
34732 "its contents (recursively) from the virtual machine into a local tarball. "
34733 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
34734 "virtual machine. You cannot use these two options together."
34739 #: ../tools/virt-tar.pl:94
34741 "In addition, you may need to use the C<-z> (gZip) option to enable "
34742 "compression. When uploading, you have to specify C<-z> if the upload file "
34743 "is compressed because virt-tar won't detect this on its own."
34748 #: ../tools/virt-tar.pl:98
34750 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
34751 "example it cannot do PKZip files or bzip2 compression. If you want that "
34752 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
34753 "the L<libguestfs(3)> API)."
34758 #: ../tools/virt-tar.pl:156
34759 msgid "B<-x> | B<--extract> | B<--download>"
34764 #: ../tools/virt-tar.pl:158
34765 msgid "B<-u> | B<--upload>"
34770 #: ../tools/virt-tar.pl:160
34772 "Use C<-x> to extract (download) a directory from a virtual machine to a "
34778 #: ../tools/virt-tar.pl:163
34780 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
34781 "Please read the L</WARNING> section above before using this option."
34786 #: ../tools/virt-tar.pl:167
34787 msgid "You must specify exactly one of these options."
34792 #: ../tools/virt-tar.pl:173
34793 msgid "B<-z> | B<--gzip>"
34798 #: ../tools/virt-tar.pl:175
34799 msgid "Specify that the input or output tarball is gzip-compressed."
34803 #: ../tools/virt-tar.pl:288
34805 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
34806 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
34807 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
34813 #: ../tools/virt-make-fs.pl:37
34814 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
34819 #: ../tools/virt-make-fs.pl:41
34822 " virt-make-fs [--options] input.tar output.img\n"
34828 #: ../tools/virt-make-fs.pl:43
34831 " virt-make-fs [--options] input.tar.gz output.img\n"
34837 #: ../tools/virt-make-fs.pl:45
34840 " virt-make-fs [--options] directory output.img\n"
34846 #: ../tools/virt-make-fs.pl:49
34848 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
34849 "archive or some files in a directory. It is similar to tools like L<mkisofs"
34850 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
34851 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
34852 "you want to attach these filesystems to existing virtual machines (eg. to "
34853 "import large amounts of read-only data to a VM)."
34858 #: ../tools/virt-make-fs.pl:57
34859 msgid "Basic usage is:"
34864 #: ../tools/virt-make-fs.pl:59
34867 " virt-make-fs input output\n"
34873 #: ../tools/virt-make-fs.pl:61
34875 "where C<input> is either a directory containing files that you want to add, "
34876 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
34877 "C<output> is a disk image. The input type is detected automatically. The "
34878 "output disk image defaults to a raw ext2 image unless you specify extra "
34879 "flags (see L</OPTIONS> below)."
34884 #: ../tools/virt-make-fs.pl:67
34885 msgid "EXTRA SPACE"
34890 #: ../tools/virt-make-fs.pl:69
34892 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
34893 "the files that it contains, but might have extra space. Depending on how "
34894 "you are going to use the output, you might think this extra space is wasted "
34895 "and want to minimize it, or you might want to leave space so that more files "
34896 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
34897 "but you can use the C<--size> flag to leave space in the filesystem if you "
34903 #: ../tools/virt-make-fs.pl:77
34905 "An alternative way to leave extra space but not make the output image any "
34906 "bigger is to use an alternative disk image format (instead of the default "
34907 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
34908 "image format (check your hypervisor supports this before using it). This "
34909 "allows you to choose a large C<--size> but the extra space won't actually be "
34910 "allocated in the image until you try to store something in it."
34914 #: ../tools/virt-make-fs.pl:85
34916 "Don't forget that you can also use local commands including L<resize2fs(8)> "
34917 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
34918 "to build another image from scratch."
34923 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
34924 #: ../tools/virt-make-fs.pl:142
34930 #: ../tools/virt-make-fs.pl:91
34933 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
34939 #: ../tools/virt-make-fs.pl:93
34940 msgid "FILESYSTEM TYPE"
34945 #: ../tools/virt-make-fs.pl:95
34947 "The default filesystem type is C<ext2>. Just about any filesystem type that "
34948 "libguestfs supports can be used (but I<not> read-only formats like "
34949 "ISO9660). Here are some of the more common choices:"
34954 #: ../tools/virt-make-fs.pl:101
34960 #: ../tools/virt-make-fs.pl:103
34962 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
34963 "you are not going to use the filesystem in a way that requires the journal, "
34964 "then this is just wasted overhead."
34969 #: ../tools/virt-make-fs.pl:107
34970 msgid "I<ntfs> or I<vfat>"
34975 #: ../tools/virt-make-fs.pl:109
34976 msgid "Useful if exporting data to a Windows guest."
34981 #: ../tools/virt-make-fs.pl:111
34983 "I<Note for vfat>: The tar archive or local directory must only contain files "
34984 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
34985 "program running within libguestfs is unable to change the ownership of non-"
34986 "root files, since vfat itself does not support this."
34991 #: ../tools/virt-make-fs.pl:116
34997 #: ../tools/virt-make-fs.pl:118
34999 "Lower overhead than C<ext2>, but certain limitations on filename length and "
35000 "total filesystem size."
35005 #: ../tools/virt-make-fs.pl:125
35008 " virt-make-fs --type=minix input minixfs.img\n"
35014 #: ../tools/virt-make-fs.pl:127
35015 msgid "TO PARTITION OR NOT TO PARTITION"
35020 #: ../tools/virt-make-fs.pl:129
35021 msgid "Optionally virt-make-fs can add a partition table to the output disk."
35026 #: ../tools/virt-make-fs.pl:131
35028 "Adding a partition can make the disk image more compatible with certain "
35029 "virtualized operating systems which don't expect to see a filesystem "
35030 "directly located on a block device (Linux doesn't care and will happily "
35031 "handle both types)."
35036 #: ../tools/virt-make-fs.pl:136
35038 "On the other hand, if you have a partition table then the output image is no "
35039 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
35040 "directly on a partitioned disk image. (However libguestfs tools such as "
35041 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
35046 #: ../tools/virt-make-fs.pl:144
35047 msgid "Add an MBR partition:"
35052 #: ../tools/virt-make-fs.pl:146
35055 " virt-make-fs --partition -- input disk.img\n"
35061 #: ../tools/virt-make-fs.pl:148
35063 "If the output disk image could be terabyte-sized or larger, it's better to "
35064 "use an EFI/GPT-compatible partition table:"
35069 #: ../tools/virt-make-fs.pl:151
35072 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
35078 #: ../tools/virt-make-fs.pl:179
35079 msgid "Enable debugging information."
35084 #: ../tools/virt-make-fs.pl:185
35085 msgid "B<--size=E<lt>NE<gt>>"
35090 #: ../tools/virt-make-fs.pl:187
35091 msgid "B<--size=+E<lt>NE<gt>>"
35096 #: ../tools/virt-make-fs.pl:189
35097 msgid "B<-s E<lt>NE<gt>>"
35102 #: ../tools/virt-make-fs.pl:191
35103 msgid "B<-s +E<lt>NE<gt>>"
35108 #: ../tools/virt-make-fs.pl:193
35110 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
35115 #: ../tools/virt-make-fs.pl:196
35117 "If this option is I<not> given, then the output image will be just large "
35118 "enough to contain all the files, with not much wasted space."
35123 #: ../tools/virt-make-fs.pl:199
35125 "To choose a fixed size output disk, specify an absolute number followed by b/"
35126 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35127 "Petabytes or Exabytes. This must be large enough to contain all the input "
35128 "files, else you will get an error."
35133 #: ../tools/virt-make-fs.pl:204
35135 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
35136 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
35137 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
35138 "the input files, and (approximately) an extra 200 MB free space."
35143 #: ../tools/virt-make-fs.pl:210
35145 "Note that virt-make-fs estimates free space, and therefore will not produce "
35146 "filesystems containing precisely the free space requested. (It is much more "
35147 "expensive and time-consuming to produce a filesystem which has precisely the "
35148 "desired free space)."
35153 #: ../tools/virt-make-fs.pl:219
35154 msgid "B<--format=E<lt>fmtE<gt>>"
35159 #: ../tools/virt-make-fs.pl:221
35160 msgid "B<-F E<lt>fmtE<gt>>"
35165 #: ../tools/virt-make-fs.pl:223
35166 msgid "Choose the output disk image format."
35171 #: ../tools/virt-make-fs.pl:225
35172 msgid "The default is C<raw> (raw disk image)."
35177 #: ../tools/virt-make-fs.pl:227
35179 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
35180 "that would really make sense here is C<qcow2>."
35185 #: ../tools/virt-make-fs.pl:234
35186 msgid "B<--type=E<lt>fsE<gt>>"
35191 #: ../tools/virt-make-fs.pl:236
35192 msgid "B<-t E<lt>fsE<gt>>"
35197 #: ../tools/virt-make-fs.pl:238
35198 msgid "Choose the output filesystem type."
35203 #: ../tools/virt-make-fs.pl:240
35204 msgid "The default is C<ext2>."
35209 #: ../tools/virt-make-fs.pl:242
35211 "Any filesystem which is supported read-write by libguestfs can be used here."
35216 #: ../tools/virt-make-fs.pl:249
35217 msgid "B<--partition>"
35222 #: ../tools/virt-make-fs.pl:251
35223 msgid "B<--partition=E<lt>parttypeE<gt>>"
35228 #: ../tools/virt-make-fs.pl:253
35230 "If specified, this flag adds an MBR partition table to the output disk image."
35235 #: ../tools/virt-make-fs.pl:256
35237 "You can change the partition table type, eg. C<--partition=gpt> for large "
35243 #: ../tools/virt-make-fs.pl:259
35245 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
35246 "might consider the next parameter to be the partition type. For example:"
35251 #: ../tools/virt-make-fs.pl:263
35254 " virt-make-fs --partition input.tar ...\n"
35260 #: ../tools/virt-make-fs.pl:265
35262 "would cause virt-make-fs to think you wanted to use a partition type of "
35263 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
35264 "dash) between options and the input file argument:"
35269 #: ../tools/virt-make-fs.pl:269
35272 " virt-make-fs --partition -- input.tar ...\n"
35277 #: ../tools/virt-make-fs.pl:541
35279 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
35280 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
35281 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
35286 #: ../tools/virt-make-fs.pl:558
35289 " export LIBGUESTFS_DEBUG=1\n"
35290 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
35296 #: ../tools/virt-make-fs.pl:561
35298 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
35304 #: ../tools/virt-list-partitions.pl:32
35306 "virt-list-partitions - List partitions in a virtual machine or disk image"
35311 #: ../tools/virt-list-partitions.pl:36
35314 " virt-list-partitions [--options] domname\n"
35320 #: ../tools/virt-list-partitions.pl:38
35323 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35329 #: ../tools/virt-list-partitions.pl:45
35331 "C<virt-list-partitions> is a command line tool to list the partitions that "
35332 "are contained in a virtual machine or disk image. It is mainly useful as a "
35333 "first step to using L<virt-resize(1)>."
35338 #: ../tools/virt-list-partitions.pl:50
35340 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35341 "functionality. For more complex cases you should look at the L<guestfish(1)"
35347 #: ../tools/virt-list-partitions.pl:107
35348 msgid "B<-h> | B<--human-readable>"
35353 #: ../tools/virt-list-partitions.pl:109
35354 msgid "Show sizes in human-readable form (eg. \"1G\")."
35359 #: ../tools/virt-list-partitions.pl:117
35361 "With this option, C<virt-list-partitions> displays the type and size of each "
35362 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35367 #: ../tools/virt-list-partitions.pl:124
35368 msgid "B<-t> | B<--total>"
35373 #: ../tools/virt-list-partitions.pl:126
35375 "Display the total size of each block device (as a separate row or rows)."
35380 #: ../tools/virt-list-partitions.pl:259
35382 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
35383 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
35384 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."