1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-03-08 15:34+0000\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
22 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
23 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
24 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../tools/virt-list-partitions.pl:30
32 #: ../src/guestfs.pod:5
33 msgid "guestfs - Library for accessing and modifying virtual machine images"
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
41 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
42 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
43 #: ../tools/virt-list-partitions.pl:34
49 #: ../src/guestfs.pod:9
52 " #include <guestfs.h>\n"
58 #: ../src/guestfs.pod:11
61 " guestfs_h *g = guestfs_create ();\n"
62 " guestfs_add_drive (g, \"guest.img\");\n"
63 " guestfs_launch (g);\n"
64 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
65 " guestfs_touch (g, \"/hello\");\n"
66 " guestfs_umount (g, \"/\");\n"
67 " guestfs_close (g);\n"
73 #: ../src/guestfs.pod:19
76 " cc prog.c -o prog -lguestfs\n"
78 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
84 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
85 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
86 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
87 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
88 #: ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47
89 #: ../tools/virt-list-partitions.pl:40
95 #: ../src/guestfs.pod:25
97 "Libguestfs is a library for accessing and modifying guest disk images. "
98 "Amongst the things this is good for: making batch configuration changes to "
99 "guests, getting disk used/free statistics (see also: virt-df), migrating "
100 "between virtualization systems (see also: virt-p2v), performing partial "
101 "backups, performing partial guest clones, cloning guests and changing "
102 "registry/UUID/hostname info, and much else besides."
107 #: ../src/guestfs.pod:33
109 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
110 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
111 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
117 #: ../src/guestfs.pod:38
119 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
120 "what filesystem is in each LV, etc.). It can also run commands in the "
121 "context of the guest. Also you can access filesystems over FUSE."
126 #: ../src/guestfs.pod:43
128 "Libguestfs is a library that can be linked with C and C++ management "
129 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
130 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
136 #: ../src/guestfs.pod:48
138 "You don't need to be root to use libguestfs, although obviously you do need "
139 "enough permissions to access the disk images."
144 #: ../src/guestfs.pod:51
146 "Libguestfs is a large API because it can do many things. For a gentle "
147 "introduction, please read the L</API OVERVIEW> section next."
152 #: ../src/guestfs.pod:54
154 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
166 #: ../src/guestfs.pod:59
168 "This section provides a gentler overview of the libguestfs API. We also try "
169 "to group API calls together, where that may not be obvious from reading "
170 "about the individual calls in the main section of this manual."
175 #: ../src/guestfs.pod:64
181 #: ../src/guestfs.pod:66
183 "Before you can use libguestfs calls, you have to create a handle. Then you "
184 "must add at least one disk image to the handle, followed by launching the "
185 "handle, then performing whatever operations you want, and finally closing "
186 "the handle. By convention we use the single letter C<g> for the name of the "
187 "handle variable, although of course you can use any name you want."
192 #: ../src/guestfs.pod:73
193 msgid "The general structure of all libguestfs-using programs looks like this:"
198 #: ../src/guestfs.pod:76
201 " guestfs_h *g = guestfs_create ();\n"
207 #: ../src/guestfs.pod:78
210 " /* Call guestfs_add_drive additional times if there are\n"
211 " * multiple disk images.\n"
213 " guestfs_add_drive (g, \"guest.img\");\n"
219 #: ../src/guestfs.pod:83
222 " /* Most manipulation calls won't work until you've launched\n"
223 " * the handle 'g'. You have to do this _after_ adding drives\n"
224 " * and _before_ other commands.\n"
226 " guestfs_launch (g);\n"
232 #: ../src/guestfs.pod:89
235 " /* Now you can examine what partitions, LVs etc are available.\n"
237 " char **partitions = guestfs_list_partitions (g);\n"
238 " char **logvols = guestfs_lvs (g);\n"
244 #: ../src/guestfs.pod:94
247 " /* To access a filesystem in the image, you must mount it.\n"
249 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
255 #: ../src/guestfs.pod:98
258 " /* Now you can perform filesystem actions on the guest\n"
261 " guestfs_touch (g, \"/hello\");\n"
267 #: ../src/guestfs.pod:103
270 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
271 " * it is done automatically when you close the handle. See\n"
272 " * discussion of autosync in this page.\n"
274 " guestfs_sync (g);\n"
280 #: ../src/guestfs.pod:109
283 " /* Close the handle 'g'. */\n"
284 " guestfs_close (g);\n"
290 #: ../src/guestfs.pod:112
292 "The code above doesn't include any error checking. In real code you should "
293 "check return values carefully for errors. In general all functions that "
294 "return integers return C<-1> on error, and all functions that return "
295 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
296 "how to handle errors, and consult the documentation for each function call "
297 "below to see precisely how they return error indications. See L<guestfs-"
298 "examples(3)> for fully worked examples."
303 #: ../src/guestfs.pod:121
309 #: ../src/guestfs.pod:123
311 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
312 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
313 "actual block device, or simply an empty file of zeroes that you have created "
314 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
320 #: ../src/guestfs.pod:129
322 "The call you should use in modern code for adding drives is L</"
323 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
324 "specifying that the format is raw, do:"
329 #: ../src/guestfs.pod:133
332 " guestfs_add_drive_opts (g, filename,\n"
333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
340 #: ../src/guestfs.pod:137
341 msgid "You can add a disk read-only using:"
346 #: ../src/guestfs.pod:139
349 " guestfs_add_drive_opts (g, filename,\n"
350 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
351 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
358 #: ../src/guestfs.pod:144
360 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
361 "libguestfs won't modify the file."
366 #: ../src/guestfs.pod:147
368 "Be extremely cautious if the disk image is in use, eg. if it is being used "
369 "by a virtual machine. Adding it read-write will almost certainly cause disk "
370 "corruption, but adding it read-only is safe."
375 #: ../src/guestfs.pod:151
377 "You must add at least one disk image, and you may add multiple disk images. "
378 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
379 "first one you added), C</dev/sdb> (for the second one you added), etc."
384 #: ../src/guestfs.pod:156
386 "Once L</guestfs_launch> has been called you cannot add any more images. You "
387 "can call L</guestfs_list_devices> to get a list of the device names, in the "
388 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
393 #: ../src/guestfs.pod:161
398 #: ../src/guestfs.pod:163
400 "Before you can read or write files, create directories and so on in a disk "
401 "image that contains filesystems, you have to mount those filesystems using "
402 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
403 "a disk image contains (for example) one partition with a filesystem on that "
404 "partition, then you can mount it directly:"
408 #: ../src/guestfs.pod:170
411 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
416 #: ../src/guestfs.pod:172
418 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
419 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
420 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
421 "that these are libguestfs virtual devices, and are nothing to do with host "
426 #: ../src/guestfs.pod:178
428 "If you are given a disk image and you don't know what it contains then you "
429 "have to find out. Libguestfs can do that too: use L</"
430 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
431 "LVs, and either try mounting each to see what is mountable, or else examine "
432 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
433 "filesystems, use L</guestfs_list_filesystems>."
437 #: ../src/guestfs.pod:186
439 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
440 "L</INSPECTION> below). But you might find it easier to look at higher level "
441 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
445 #: ../src/guestfs.pod:191
447 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
448 "several other variations of the C<guestfs_mount_*> call."
453 #: ../src/guestfs.pod:194
454 msgid "FILESYSTEM ACCESS AND MODIFICATION"
459 #: ../src/guestfs.pod:196
461 "The majority of the libguestfs API consists of fairly low-level calls for "
462 "accessing and modifying the files, directories, symlinks etc on mounted "
463 "filesystems. There are over a hundred such calls which you can find listed "
464 "in detail below in this man page, and we don't even pretend to cover them "
465 "all in this overview."
470 #: ../src/guestfs.pod:202
472 "Specify filenames as full paths, starting with C<\"/\"> and including the "
478 #: ../src/guestfs.pod:205
480 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
481 "the file called C<\"etc/passwd\"> then you could do:"
486 #: ../src/guestfs.pod:208
489 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
495 #: ../src/guestfs.pod:210
497 "This would return C<data> as a newly allocated buffer containing the full "
498 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
499 "or C<NULL> if there was an error."
504 #: ../src/guestfs.pod:214
506 "As another example, to create a top-level directory on that filesystem "
507 "called C<\"var\"> you would do:"
512 #: ../src/guestfs.pod:217
515 " guestfs_mkdir (g, \"/var\");\n"
521 #: ../src/guestfs.pod:219
522 msgid "To create a symlink you could do:"
527 #: ../src/guestfs.pod:221
530 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
531 " \"/etc/rc3.d/S30portmap\");\n"
537 #: ../src/guestfs.pod:224
539 "Libguestfs will reject attempts to use relative paths and there is no "
540 "concept of a current working directory."
545 #: ../src/guestfs.pod:227
547 "Libguestfs can return errors in many situations: for example if the "
548 "filesystem isn't writable, or if a file or directory that you requested "
549 "doesn't exist. If you are using the C API (documented here) you have to "
550 "check for those error conditions after each call. (Other language bindings "
551 "turn these errors into exceptions)."
556 #: ../src/guestfs.pod:233
558 "File writes are affected by the per-handle umask, set by calling L</"
559 "guestfs_umask> and defaulting to 022. See L</UMASK>."
564 #: ../src/guestfs.pod:236
570 #: ../src/guestfs.pod:238
572 "Libguestfs contains API calls to read, create and modify partition tables on "
578 #: ../src/guestfs.pod:241
580 "In the common case where you want to create a single partition covering the "
581 "whole disk, you should use the L</guestfs_part_disk> call:"
586 #: ../src/guestfs.pod:245
589 " const char *parttype = \"mbr\";\n"
590 " if (disk_is_larger_than_2TB)\n"
591 " parttype = \"gpt\";\n"
592 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
598 #: ../src/guestfs.pod:250
600 "Obviously this effectively wipes anything that was on that disk image before."
605 #: ../src/guestfs.pod:253
611 #: ../src/guestfs.pod:255
613 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
614 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
615 "you familiarize yourself with the concepts of physical volumes, volume "
616 "groups and logical volumes."
621 #: ../src/guestfs.pod:260
623 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
624 "tldp.org/HOWTO/LVM-HOWTO/>."
629 #: ../src/guestfs.pod:263
634 #: ../src/guestfs.pod:265
636 "Use L</guestfs_cat> to download small, text only files. This call is "
637 "limited to files which are less than 2 MB and which cannot contain any ASCII "
638 "NUL (C<\\0>) characters. However the API is very simple to use."
643 #: ../src/guestfs.pod:269
645 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
646 "bit data, since it returns a (pointer, size) pair. However it is still "
647 "limited to \"small\" files, less than 2 MB."
652 #: ../src/guestfs.pod:273
654 "L</guestfs_download> can be used to download any file, with no limits on "
655 "content or size (even files larger than 4 GB)."
660 #: ../src/guestfs.pod:276
662 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
667 #: ../src/guestfs.pod:279
673 #: ../src/guestfs.pod:281
675 "It's often the case that you want to write a file or files to the disk image."
680 #: ../src/guestfs.pod:284
682 "To write a small file with fixed content, use L</guestfs_write>. To create "
683 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
684 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
685 "of other functions for creating test files, for example L</guestfs_fill> and "
686 "L</guestfs_fill_pattern>."
691 #: ../src/guestfs.pod:290
693 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
694 "file content or size (even files larger than 4 GB)."
699 #: ../src/guestfs.pod:293
701 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
706 #: ../src/guestfs.pod:295
708 "However the fastest way to upload I<large numbers of arbitrary files> is to "
709 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
710 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
711 "in a predictable way (eg. adding it last after all other drives) then you "
712 "can get the device name from L</guestfs_list_devices> and mount it directly "
713 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
714 "portable between kernel versions, and they don't support labels or UUIDs. "
715 "If you want to pre-build an image or you need to mount it using a label or "
716 "UUID, use an ISO image instead."
721 #: ../src/guestfs.pod:306
727 #: ../src/guestfs.pod:308
729 "There are various different commands for copying between files and devices "
730 "and in and out of the guest filesystem. These are summarised in the table "
736 #: ../src/guestfs.pod:314
737 msgid "B<file> to B<file>"
742 #: ../src/guestfs.pod:316
744 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
745 "directories recursively."
750 #: ../src/guestfs.pod:319
751 msgid "B<file or device> to B<file or device>"
756 #: ../src/guestfs.pod:321
758 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
759 "devices in the guest."
764 #: ../src/guestfs.pod:324
765 msgid "Example: duplicate the contents of an LV:"
770 #: ../src/guestfs.pod:326
773 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
779 #: ../src/guestfs.pod:328
781 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
782 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
783 "guestfs_copy_size>."
788 #: ../src/guestfs.pod:332
789 msgid "B<file on the host> to B<file or device>"
794 #: ../src/guestfs.pod:334
795 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
800 #: ../src/guestfs.pod:336
801 msgid "B<file or device> to B<file on the host>"
806 #: ../src/guestfs.pod:338
807 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
812 #: ../src/guestfs.pod:342
813 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
818 #: ../src/guestfs.pod:344
820 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
821 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
822 "appears you can only upload and download to files. However many Un*x-like "
823 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
824 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
825 "and arbitrary file descriptor N."
830 #: ../src/guestfs.pod:352
831 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
835 #: ../src/guestfs.pod:355
838 " guestfs_download (g, filename, \"/dev/stdout\");\n"
844 #: ../src/guestfs.pod:357
845 msgid "and you can write tar output to a pipe C<fd> by doing:"
849 #: ../src/guestfs.pod:359
853 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
854 " guestfs_tar_out (g, \"/\", devfd);\n"
860 #: ../src/guestfs.pod:363
861 msgid "LISTING FILES"
866 #: ../src/guestfs.pod:365
868 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
869 "L<guestfish(1)>-equivalent command C<ll>)."
874 #: ../src/guestfs.pod:368
876 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
877 "programs, as a flat list of strings."
882 #: ../src/guestfs.pod:371
884 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
885 "directory, plus additional information about each one. It is more "
886 "equivalent to using the L<readdir(3)> call on a local filesystem."
891 #: ../src/guestfs.pod:375
893 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
898 #: ../src/guestfs.pod:378
899 msgid "RUNNING COMMANDS"
904 #: ../src/guestfs.pod:380
906 "Although libguestfs is primarily an API for manipulating files inside guest "
907 "images, we also provide some limited facilities for running commands inside "
913 #: ../src/guestfs.pod:384
914 msgid "There are many limitations to this:"
919 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
920 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
921 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1011
922 #: ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024
923 #: ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059
924 #: ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089
925 #: ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101
926 #: ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592
927 #: ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711
928 #: ../src/guestfs.pod:2063 ../src/guestfs.pod:2069 ../src/guestfs.pod:2074
929 #: ../src/guestfs.pod:2080 ../src/guestfs.pod:2534 ../src/guestfs.pod:2538
930 #: ../src/guestfs.pod:2542 ../src/guestfs.pod:2546
931 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
932 #: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577
933 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
934 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
935 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
936 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
937 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
938 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
939 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
940 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
941 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
942 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427
943 #: ../fish/guestfish.pod:431 ../fish/guestfish.pod:435
944 #: ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13
945 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373
946 #: ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388
947 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065
948 #: ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073
949 #: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085
950 #: ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093
951 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
952 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201
953 #: ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210
954 #: ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257
955 #: ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266
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:1204 ../src/guestfs.pod:1335
1104 #: ../src/guestfs.pod:2108
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:1208 ../src/guestfs.pod:1339
1126 #: ../src/guestfs.pod:2133
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:1345
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:720
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
1302 #: ../src/guestfs.pod:552
1304 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1305 "contains operating systems. (These APIs used to be in a separate Perl-only "
1306 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1307 "frequently used part of this library has been rewritten in C and moved into "
1313 #: ../src/guestfs.pod:558
1315 "Add all disks belonging to the unknown virtual machine and call L</"
1316 "guestfs_launch> in the usual way."
1321 #: ../src/guestfs.pod:561
1323 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1324 "and certain heuristics, and returns a list of operating systems that were "
1325 "found. An empty list means none were found. A single element is the root "
1326 "filesystem of the operating system. For dual- or multi-boot guests, "
1327 "multiple roots can be returned, each one corresponding to a separate "
1328 "operating system. (Multi-boot virtual machines are extremely rare in the "
1329 "world of virtualization, but since this scenario can happen, we have built "
1330 "libguestfs to deal with it.)"
1335 #: ../src/guestfs.pod:570
1337 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1338 "to get additional details about that operating system. For example, call L</"
1339 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1340 "Windows and Linux-based operating systems respectively."
1345 #: ../src/guestfs.pod:576
1347 "Un*x-like and Linux-based operating systems usually consist of several "
1348 "filesystems which are mounted at boot time (for example, a separate boot "
1349 "partition mounted on C</boot>). The inspection rules are able to detect how "
1350 "filesystems correspond to mount points. Call "
1351 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1352 "hash table like this example:"
1357 #: ../src/guestfs.pod:583
1360 " /boot => /dev/sda1\n"
1361 " / => /dev/vg_guest/lv_root\n"
1362 " /usr => /dev/vg_guest/lv_usr\n"
1368 #: ../src/guestfs.pod:587
1370 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1371 "filesystems as suggested."
1376 #: ../src/guestfs.pod:590
1378 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1379 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1384 #: ../src/guestfs.pod:594
1386 "Inspection currently only works for some common operating systems. "
1387 "Contributors are welcome to send patches for other operating systems that we "
1388 "currently cannot detect."
1393 #: ../src/guestfs.pod:598
1395 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1396 "for more details. The L</guestfs_inspect_os> function just ignores any "
1397 "encrypted devices."
1402 #: ../src/guestfs.pod:602
1404 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1405 "inspection and caches the results in the guest handle. Subsequent calls to "
1406 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1407 "read the disks. If you change the content of the guest disks, you can redo "
1408 "inspection by calling L</guestfs_inspect_os> again. (L</"
1409 "guestfs_inspect_list_applications> works a little differently from the other "
1410 "calls and does read the disks. See documentation for that function for "
1416 #: ../src/guestfs.pod:611
1417 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1422 #: ../src/guestfs.pod:613
1424 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1425 "ntfs-3g.org/> driver."
1430 #: ../src/guestfs.pod:616
1431 msgid "DRIVE LETTERS AND PATHS"
1436 #: ../src/guestfs.pod:618
1438 "DOS and Windows still use drive letters, and the filesystems are always "
1439 "treated as case insensitive by Windows itself, and therefore you might find "
1440 "a Windows configuration file referring to a path like C<c:\\windows"
1441 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1442 "might be referred to as C</WINDOWS/System32>."
1447 #: ../src/guestfs.pod:624
1449 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1450 "libguestfs to read the appropriate Windows Registry and configuration files, "
1451 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1457 #: ../src/guestfs.pod:629
1459 "Replacing backslash characters with forward slash characters is also outside "
1460 "the scope of libguestfs, but something that you can easily do."
1465 #: ../src/guestfs.pod:632
1467 "Where we can help is in resolving the case insensitivity of paths. For "
1468 "this, call L</guestfs_case_sensitive_path>."
1473 #: ../src/guestfs.pod:635
1474 msgid "ACCESSING THE WINDOWS REGISTRY"
1479 #: ../src/guestfs.pod:637
1481 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1482 "files, through the library C<hivex> which is part of the libguestfs project "
1483 "although ships as a separate tarball. You have to locate and download the "
1484 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1485 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1486 "reg(1)> for more help on this issue."
1491 #: ../src/guestfs.pod:645
1492 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1497 #: ../src/guestfs.pod:647
1499 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1500 "provide something which looks like a Linux symlink. The way it tries to do "
1501 "the rewriting is described here:"
1506 #: ../src/guestfs.pod:651
1508 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1514 #: ../src/guestfs.pod:653
1516 "The essential problem is that ntfs-3g simply does not have enough "
1517 "information to do a correct job. NTFS links can contain drive letters and "
1518 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1519 "It is almost certainly the case that libguestfs callers should ignore what "
1520 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1525 #: ../src/guestfs.pod:660
1527 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1528 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1529 "attribute, and read the raw reparse data from that (you can find the format "
1530 "documented in various places around the web)."
1535 #: ../src/guestfs.pod:665
1536 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1541 #: ../src/guestfs.pod:667
1543 "There are other useful extended attributes that can be read from ntfs-3g "
1544 "filesystems (using L</guestfs_getxattr>). See:"
1549 #: ../src/guestfs.pod:670
1551 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1556 #: ../src/guestfs.pod:672
1557 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1562 #: ../src/guestfs.pod:674
1564 "Although we don't want to discourage you from using the C API, we will "
1565 "mention here that the same API is also available in other languages."
1569 #: ../src/guestfs.pod:677
1571 "The API is broadly identical in all supported languages. This means that "
1572 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1573 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1574 "OCaml. In other words, a straightforward, predictable isomorphism between "
1580 #: ../src/guestfs.pod:683
1582 "Error messages are automatically transformed into exceptions if the language "
1588 #: ../src/guestfs.pod:686
1590 "We don't try to \"object orientify\" parts of the API in OO languages, "
1591 "although contributors are welcome to write higher level APIs above what we "
1592 "provide in their favourite languages if they wish."
1597 #: ../src/guestfs.pod:692
1603 #: ../src/guestfs.pod:694
1605 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1606 "identical to the C API. C++ classes and exceptions are not used."
1611 #: ../src/guestfs.pod:698
1617 #: ../src/guestfs.pod:700
1619 "The C# bindings are highly experimental. Please read the warnings at the "
1620 "top of C<csharp/Libguestfs.cs>."
1625 #: ../src/guestfs.pod:703
1631 #: ../src/guestfs.pod:705
1633 "This is the only language binding that is working but incomplete. Only "
1634 "calls which return simple integers have been bound in Haskell, and we are "
1635 "looking for help to complete this binding."
1640 #: ../src/guestfs.pod:709
1646 #: ../src/guestfs.pod:711
1648 "Full documentation is contained in the Javadoc which is distributed with "
1654 #: ../src/guestfs.pod:714
1659 #: ../src/guestfs.pod:716
1660 msgid "See L<guestfs-ocaml(3)>."
1665 #: ../src/guestfs.pod:718
1670 #: ../src/guestfs.pod:720
1671 msgid "See L<Sys::Guestfs(3)>."
1676 #: ../src/guestfs.pod:722
1682 #: ../src/guestfs.pod:724
1684 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1685 "the php-libguestfs package for your distribution."
1690 #: ../src/guestfs.pod:727
1691 msgid "The PHP binding only works correctly on 64 bit machines."
1696 #: ../src/guestfs.pod:729
1701 #: ../src/guestfs.pod:731
1702 msgid "See L<guestfs-python(3)>."
1707 #: ../src/guestfs.pod:733
1712 #: ../src/guestfs.pod:735
1713 msgid "See L<guestfs-ruby(3)>."
1718 #: ../src/guestfs.pod:737
1719 msgid "B<shell scripts>"
1723 #: ../src/guestfs.pod:739
1724 msgid "See L<guestfish(1)>."
1729 #: ../src/guestfs.pod:743
1730 msgid "LIBGUESTFS GOTCHAS"
1735 #: ../src/guestfs.pod:745
1737 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1738 "system [...] that works in the way it is documented but is counterintuitive "
1739 "and almost invites mistakes.\""
1744 #: ../src/guestfs.pod:749
1746 "Since we developed libguestfs and the associated tools, there are several "
1747 "things we would have designed differently, but are now stuck with for "
1748 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1749 "release, you can expect these to change. Beware of them."
1754 #: ../src/guestfs.pod:757
1755 msgid "Autosync / forgetting to sync."
1760 #: ../src/guestfs.pod:759
1762 "When modifying a filesystem from C or another language, you B<must> unmount "
1763 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1764 "libguestfs handle. You can also call:"
1769 #: ../src/guestfs.pod:763
1772 " guestfs_set_autosync (g, 1);\n"
1778 #: ../src/guestfs.pod:765
1780 "to have the unmount/sync done automatically for you when the handle 'g' is "
1781 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1786 #: ../src/guestfs.pod:769
1788 "If you forget to do this, then it is entirely possible that your changes "
1789 "won't be written out, or will be partially written, or (very rarely) that "
1790 "you'll get disk corruption."
1795 #: ../src/guestfs.pod:773
1797 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1798 "guestfish scripts that forget to sync will work just fine, which can make "
1799 "this very puzzling if you are trying to debug a problem."
1804 #: ../src/guestfs.pod:777
1806 "Update: Autosync is enabled by default for all API users starting from "
1807 "libguestfs 1.5.24."
1812 #: ../src/guestfs.pod:780
1813 msgid "Mount option C<-o sync> should not be the default."
1818 #: ../src/guestfs.pod:782
1820 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1821 "However C<-o sync> does not add any reliability benefit, but does have a "
1822 "very large performance impact."
1827 #: ../src/guestfs.pod:786
1829 "The work around is to use L</guestfs_mount_options> and set the mount "
1830 "options that you actually want to use."
1835 #: ../src/guestfs.pod:789
1836 msgid "Read-only should be the default."
1841 #: ../src/guestfs.pod:791
1843 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1844 "specify I<--rw> if you want to make changes to the image."
1849 #: ../src/guestfs.pod:794
1850 msgid "This would reduce the potential to corrupt live VM images."
1855 #: ../src/guestfs.pod:796
1857 "Note that many filesystems change the disk when you just mount and unmount, "
1858 "even if you didn't perform any writes. You need to use L</"
1859 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1864 #: ../src/guestfs.pod:800
1865 msgid "guestfish command line is hard to use."
1870 #: ../src/guestfs.pod:802
1872 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1873 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1874 "exist, so it fails. In earlier versions of guestfish the error message was "
1875 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1876 "we should have used C<guestfish -c command> to run commands."
1881 #: ../src/guestfs.pod:809
1882 msgid "guestfish megabyte modifiers don't work right on all commands"
1887 #: ../src/guestfs.pod:811
1889 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1890 "other modifiers). What guestfish actually does is to multiply the number "
1891 "part by the modifier part and pass the result to the C API. However this "
1892 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1893 "expecting some other unit (eg. megabytes)."
1898 #: ../src/guestfs.pod:818
1899 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1904 #: ../src/guestfs.pod:820
1907 " lvcreate LV VG 100M\n"
1913 #: ../src/guestfs.pod:822
1915 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1916 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1917 "megabytes * megabytes) logical volume. The error message you get from this "
1918 "is also a little obscure."
1923 #: ../src/guestfs.pod:827
1925 "This could be fixed in the generator by specially marking parameters and "
1926 "return values which take bytes or other units."
1931 #: ../src/guestfs.pod:830
1932 msgid "Ambiguity between devices and paths"
1937 #: ../src/guestfs.pod:832
1939 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1940 "sdb2>) and a similar pathname. A file might just happen to be called "
1941 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1946 #: ../src/guestfs.pod:837
1948 "In the current API we usually resolve this ambiguity by having two separate "
1949 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1950 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1951 "detecting if the path supplied begins with C</dev/>."
1956 #: ../src/guestfs.pod:843
1958 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1959 "make paths/devices into structured names. One way to do this would be to "
1960 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1961 "aspect of grub. Another way would be to use a structured type, equivalent "
1962 "to this OCaml type:"
1967 #: ../src/guestfs.pod:849
1970 " type path = Path of string | Device of int | Partition of int * int\n"
1976 #: ../src/guestfs.pod:851
1977 msgid "which would allow you to pass arguments like:"
1982 #: ../src/guestfs.pod:853
1985 " Path \"/foo/bar\"\n"
1986 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1987 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1988 " Path \"/dev/sdb2\" (* not a device *)\n"
1994 #: ../src/guestfs.pod:858
1996 "As you can see there are still problems to resolve even with this "
1997 "representation. Also consider how it might work in guestfish."
2002 #: ../src/guestfs.pod:863
2003 msgid "PROTOCOL LIMITS"
2008 #: ../src/guestfs.pod:865
2010 "Internally libguestfs uses a message-based protocol to pass API calls and "
2011 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2012 "plenty more detail about this). The maximum message size used by the "
2013 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2014 "aware of this limit. The API calls which may be affected are individually "
2015 "documented, with a link back to this section of the documentation."
2020 #: ../src/guestfs.pod:873
2022 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2023 "a simple string. Because this string is at some point internally encoded as "
2024 "a message, the maximum size that it can return is slightly under 4 MB. If "
2025 "the requested file is larger than this then you will get an error."
2030 #: ../src/guestfs.pod:879
2032 "In order to transfer large files into and out of the guest filesystem, you "
2033 "need to use particular calls that support this. The sections L</UPLOADING> "
2034 "and L</DOWNLOADING> document how to do this."
2039 #: ../src/guestfs.pod:883
2041 "You might also consider mounting the disk image using our FUSE filesystem "
2042 "support (L<guestmount(1)>)."
2047 #: ../src/guestfs.pod:886
2048 msgid "KEYS AND PASSPHRASES"
2053 #: ../src/guestfs.pod:888
2055 "Certain libguestfs calls take a parameter that contains sensitive key "
2056 "material, passed in as a C string."
2061 #: ../src/guestfs.pod:891
2063 "In the future we would hope to change the libguestfs implementation so that "
2064 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2065 "swap. However this is I<not> done at the moment, because of the complexity "
2066 "of such an implementation."
2071 #: ../src/guestfs.pod:896
2073 "Therefore you should be aware that any key parameter you pass to libguestfs "
2074 "might end up being written out to the swap partition. If this is a concern, "
2075 "scrub the swap partition or don't use libguestfs on encrypted devices."
2080 #: ../src/guestfs.pod:901
2081 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2086 #: ../src/guestfs.pod:903
2088 "All high-level libguestfs actions are synchronous. If you want to use "
2089 "libguestfs asynchronously then you must create a thread."
2094 #: ../src/guestfs.pod:906
2096 "Only use the handle from a single thread. Either use the handle exclusively "
2097 "from one thread, or provide your own mutex so that two threads cannot issue "
2098 "calls on the same handle at the same time."
2103 #: ../src/guestfs.pod:910
2105 "See the graphical program guestfs-browser for one possible architecture for "
2106 "multithreaded programs using libvirt and libguestfs."
2111 #: ../src/guestfs.pod:913
2117 #: ../src/guestfs.pod:915
2119 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
2125 #: ../src/guestfs.pod:918
2127 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2128 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2133 #: ../src/guestfs.pod:921
2135 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2136 "to change the directories that libguestfs will search in. The value is a "
2137 "colon-separated list of paths. The current directory is I<not> searched "
2138 "unless the path contains an empty element or C<.>. For example "
2139 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2140 "then C</usr/lib/guestfs>."
2145 #: ../src/guestfs.pod:928
2146 msgid "QEMU WRAPPERS"
2151 #: ../src/guestfs.pod:930
2153 "If you want to compile your own qemu, run qemu from a non-standard location, "
2154 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2160 #: ../src/guestfs.pod:934
2162 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2163 "last command in the shell script (so that qemu replaces the shell and "
2164 "becomes the direct child of the libguestfs-using program). If you don't do "
2165 "this, then the qemu process won't be cleaned up correctly."
2170 #: ../src/guestfs.pod:939
2172 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2178 #: ../src/guestfs.pod:942
2182 " qemudir=/home/rjones/d/qemu\n"
2183 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2189 #: ../src/guestfs.pod:946
2191 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2192 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2198 #: ../src/guestfs.pod:950
2201 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2207 #: ../src/guestfs.pod:952
2209 "Note that libguestfs also calls qemu with the -help and -version options in "
2210 "order to determine features."
2215 #: ../src/guestfs.pod:955
2216 msgid "ABI GUARANTEE"
2221 #: ../src/guestfs.pod:957
2223 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2224 "actions as outlined in this section. Although we will deprecate some "
2225 "actions, for example if they get replaced by newer calls, we will keep the "
2226 "old actions forever. This allows you the developer to program in confidence "
2227 "against the libguestfs API."
2232 #: ../src/guestfs.pod:963
2233 msgid "BLOCK DEVICE NAMING"
2238 #: ../src/guestfs.pod:965
2240 "In the kernel there is now quite a profusion of schemata for naming block "
2241 "devices (in this context, by I<block device> I mean a physical or virtual "
2242 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2243 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2244 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2245 "for the old IDE driver (particularly for SATA devices) those devices also "
2246 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2247 "paravirtualized drivers. This has created several different naming systems, "
2248 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2253 #: ../src/guestfs.pod:977
2255 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2256 "Linux kernel to access block devices. We can run a variety of appliances "
2257 "based on a variety of Linux kernels."
2262 #: ../src/guestfs.pod:981
2264 "This causes a problem for libguestfs because many API calls use device or "
2265 "partition names. Working scripts and the recipe (example) scripts that we "
2266 "make available over the internet could fail if the naming scheme changes."
2271 #: ../src/guestfs.pod:986
2273 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2274 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2275 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2276 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2281 #: ../src/guestfs.pod:992
2283 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2284 "L</guestfs_list_partitions> and similar calls return the true names of the "
2285 "devices and partitions as known to the appliance."
2290 #: ../src/guestfs.pod:997
2291 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2296 #: ../src/guestfs.pod:999
2298 "Usually this translation is transparent. However in some (very rare) cases "
2299 "you may need to know the exact algorithm. Such cases include where you use "
2300 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2301 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2306 #: ../src/guestfs.pod:1005
2308 "The algorithm is applied only to I<parameters> which are known to be either "
2309 "device or partition names. Return values from functions such as L</"
2310 "guestfs_list_devices> are never changed."
2315 #: ../src/guestfs.pod:1013
2316 msgid "Is the string a parameter which is a device or partition name?"
2321 #: ../src/guestfs.pod:1017
2322 msgid "Does the string begin with C</dev/sd>?"
2327 #: ../src/guestfs.pod:1021
2329 "Does the named device exist? If so, we use that device. However if I<not> "
2330 "then we continue with this algorithm."
2335 #: ../src/guestfs.pod:1026
2336 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2341 #: ../src/guestfs.pod:1028
2342 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2347 #: ../src/guestfs.pod:1030
2348 msgid "If that named device exists, use it. If not, continue."
2353 #: ../src/guestfs.pod:1034
2354 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2359 #: ../src/guestfs.pod:1036
2360 msgid "If that named device exists, use it. If not, return an error."
2365 #: ../src/guestfs.pod:1040
2366 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2371 #: ../src/guestfs.pod:1042
2373 "Although the standard naming scheme and automatic translation is useful for "
2374 "simple programs and guestfish scripts, for larger programs it is best not to "
2375 "rely on this mechanism."
2380 #: ../src/guestfs.pod:1046
2382 "Where possible for maximum future portability programs using libguestfs "
2383 "should use these future-proof techniques:"
2388 #: ../src/guestfs.pod:1053
2390 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2391 "device names, and then use those names directly."
2396 #: ../src/guestfs.pod:1056
2398 "Since those device names exist by definition, they will never be translated."
2403 #: ../src/guestfs.pod:1061
2405 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2406 "filesystem labels."
2411 #: ../src/guestfs.pod:1066
2417 #: ../src/guestfs.pod:1068
2419 "This section discusses security implications of using libguestfs, "
2420 "particularly with untrusted or malicious guests or disk images."
2425 #: ../src/guestfs.pod:1071
2426 msgid "GENERAL SECURITY CONSIDERATIONS"
2431 #: ../src/guestfs.pod:1073
2433 "Be careful with any files or data that you download from a guest (by "
2434 "\"download\" we mean not just the L</guestfs_download> command but any "
2435 "command that reads files, filenames, directories or anything else from a "
2436 "disk image). An attacker could manipulate the data to fool your program "
2437 "into doing the wrong thing. Consider cases such as:"
2442 #: ../src/guestfs.pod:1083
2443 msgid "the data (file etc) not being present"
2448 #: ../src/guestfs.pod:1087
2449 msgid "being present but empty"
2454 #: ../src/guestfs.pod:1091
2455 msgid "being much larger than normal"
2460 #: ../src/guestfs.pod:1095
2461 msgid "containing arbitrary 8 bit data"
2466 #: ../src/guestfs.pod:1099
2467 msgid "being in an unexpected character encoding"
2472 #: ../src/guestfs.pod:1103
2473 msgid "containing homoglyphs."
2478 #: ../src/guestfs.pod:1107
2479 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2484 #: ../src/guestfs.pod:1109
2486 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2487 "(VFS) module can sometimes be escalated into exploits by deliberately "
2488 "creating a malicious, malformed filesystem. These exploits are very severe "
2489 "for two reasons. Firstly there are very many filesystem drivers in the "
2490 "kernel, and many of them are infrequently used and not much developer "
2491 "attention has been paid to the code. Linux userspace helps potential "
2492 "crackers by detecting the filesystem type and automatically choosing the "
2493 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2494 "the administrator. Secondly, a kernel-level exploit is like a local root "
2495 "exploit (worse in some ways), giving immediate and total access to the "
2496 "system right down to the hardware level."
2501 #: ../src/guestfs.pod:1122
2503 "That explains why you should never mount a filesystem from an untrusted "
2504 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2505 "inside a qemu virtual machine, usually running as a non-root user. The "
2506 "attacker would need to write a filesystem which first exploited the kernel, "
2507 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2508 "the libguestfs protocol, and finally to be as serious as the host kernel "
2509 "exploit it would need to escalate its privileges to root. This multi-step "
2510 "escalation, performed by a static piece of data, is thought to be extremely "
2511 "hard to do, although we never say 'never' about security issues."
2516 #: ../src/guestfs.pod:1133
2518 "In any case callers can reduce the attack surface by forcing the filesystem "
2519 "type when mounting (use L</guestfs_mount_vfs>)."
2524 #: ../src/guestfs.pod:1136
2525 msgid "PROTOCOL SECURITY"
2530 #: ../src/guestfs.pod:1138
2532 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2533 "defined upper message size. However a program that uses libguestfs must "
2534 "also take care - for example you can write a program that downloads a binary "
2535 "from a disk image and executes it locally, and no amount of protocol "
2536 "security will save you from the consequences."
2541 #: ../src/guestfs.pod:1144
2542 msgid "INSPECTION SECURITY"
2547 #: ../src/guestfs.pod:1146
2549 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2550 "directly from the guest, and these could contain any 8 bit data. Callers "
2551 "should be careful to escape these before printing them to a structured file "
2552 "(for example, use HTML escaping if creating a web page)."
2557 #: ../src/guestfs.pod:1152
2559 "Guest configuration may be altered in unusual ways by the administrator of "
2560 "the virtual machine, and may not reflect reality (particularly for untrusted "
2561 "or actively malicious guests). For example we parse the hostname from "
2562 "configuration files like C</etc/sysconfig/network> that we find in the "
2563 "guest, but the guest administrator can easily manipulate these files to "
2564 "provide the wrong hostname."
2569 #: ../src/guestfs.pod:1160
2571 "The inspection API parses guest configuration using two external libraries: "
2572 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2573 "designed to be robust in the face of malicious data, although denial of "
2574 "service attacks are still possible, for example with oversized configuration "
2580 #: ../src/guestfs.pod:1166
2581 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2586 #: ../src/guestfs.pod:1168
2588 "Be very cautious about running commands from the guest. By running a "
2589 "command in the guest, you are giving CPU time to a binary that you do not "
2590 "control, under the same user account as the library, albeit wrapped in qemu "
2591 "virtualization. More information and alternatives can be found in the "
2592 "section L</RUNNING COMMANDS>."
2597 #: ../src/guestfs.pod:1174
2598 msgid "CVE-2010-3851"
2603 #: ../src/guestfs.pod:1176
2604 msgid "https://bugzilla.redhat.com/642934"
2609 #: ../src/guestfs.pod:1178
2611 "This security bug concerns the automatic disk format detection that qemu "
2612 "does on disk images."
2617 #: ../src/guestfs.pod:1181
2619 "A raw disk image is just the raw bytes, there is no header. Other disk "
2620 "images like qcow2 contain a special header. Qemu deals with this by looking "
2621 "for one of the known headers, and if none is found then assuming the disk "
2622 "image must be raw."
2627 #: ../src/guestfs.pod:1186
2629 "This allows a guest which has been given a raw disk image to write some "
2630 "other header. At next boot (or when the disk image is accessed by "
2631 "libguestfs) qemu would do autodetection and think the disk image format was, "
2632 "say, qcow2 based on the header written by the guest."
2637 #: ../src/guestfs.pod:1191
2639 "This in itself would not be a problem, but qcow2 offers many features, one "
2640 "of which is to allow a disk image to refer to another image (called the "
2641 "\"backing disk\"). It does this by placing the path to the backing disk "
2642 "into the qcow2 header. This path is not validated and could point to any "
2643 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2644 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2645 "control of the attacker."
2650 #: ../src/guestfs.pod:1199
2652 "In libguestfs this is rather hard to exploit except under two circumstances:"
2657 #: ../src/guestfs.pod:1206
2658 msgid "You have enabled the network or have opened the disk in write mode."
2663 #: ../src/guestfs.pod:1210
2665 "You are also running untrusted code from the guest (see L</RUNNING "
2671 #: ../src/guestfs.pod:1215
2673 "The way to avoid this is to specify the expected disk format when adding "
2674 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2675 "should always do this if the disk is raw format, and it's a good idea for "
2681 #: ../src/guestfs.pod:1220
2683 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2684 "format is fetched from libvirt and passed through."
2689 #: ../src/guestfs.pod:1223
2691 "For libguestfs tools, use the I<--format> command line parameter as "
2697 #: ../src/guestfs.pod:1226
2698 msgid "CONNECTION MANAGEMENT"
2703 #: ../src/guestfs.pod:1228
2709 #: ../src/guestfs.pod:1230
2711 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2712 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2713 "handle and release all resources used."
2718 #: ../src/guestfs.pod:1234
2720 "For information on using multiple handles and threads, see the section L</"
2721 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2726 #: ../src/guestfs.pod:1237
2727 msgid "guestfs_create"
2732 #: ../src/guestfs.pod:1239
2735 " guestfs_h *guestfs_create (void);\n"
2741 #: ../src/guestfs.pod:1241
2742 msgid "Create a connection handle."
2747 #: ../src/guestfs.pod:1243
2749 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2750 "on the handle at least once."
2755 #: ../src/guestfs.pod:1246
2757 "This function returns a non-NULL pointer to a handle on success or NULL on "
2763 #: ../src/guestfs.pod:1249
2764 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2769 #: ../src/guestfs.pod:1251
2771 "You may also want to configure error handling for the handle. See L</ERROR "
2772 "HANDLING> section below."
2777 #: ../src/guestfs.pod:1254
2778 msgid "guestfs_close"
2783 #: ../src/guestfs.pod:1256
2786 " void guestfs_close (guestfs_h *g);\n"
2792 #: ../src/guestfs.pod:1258
2793 msgid "This closes the connection handle and frees up all resources used."
2798 #: ../src/guestfs.pod:1260
2799 msgid "ERROR HANDLING"
2804 #: ../src/guestfs.pod:1262
2806 "API functions can return errors. For example, almost all functions that "
2807 "return C<int> will return C<-1> to indicate an error."
2812 #: ../src/guestfs.pod:1265
2814 "Additional information is available for errors: an error message string and "
2815 "optionally an error number (errno) if the thing that failed was a system "
2821 #: ../src/guestfs.pod:1269
2823 "You can get at the additional information about the last error on the handle "
2824 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2825 "up an error handler with L</guestfs_set_error_handler>."
2830 #: ../src/guestfs.pod:1274
2832 "When the handle is created, a default error handler is installed which "
2833 "prints the error message string to C<stderr>. For small short-running "
2834 "command line programs it is sufficient to do:"
2839 #: ../src/guestfs.pod:1278
2842 " if (guestfs_launch (g) == -1)\n"
2843 " exit (EXIT_FAILURE);\n"
2849 #: ../src/guestfs.pod:1281
2851 "since the default error handler will ensure that an error message has been "
2852 "printed to C<stderr> before the program exits."
2857 #: ../src/guestfs.pod:1284
2859 "For other programs the caller will almost certainly want to install an "
2860 "alternate error handler or do error handling in-line like this:"
2865 #: ../src/guestfs.pod:1287
2868 " g = guestfs_create ();\n"
2874 #: ../src/guestfs.pod:1289
2877 " /* This disables the default behaviour of printing errors\n"
2879 " guestfs_set_error_handler (g, NULL, NULL);\n"
2885 #: ../src/guestfs.pod:1293
2888 " if (guestfs_launch (g) == -1) {\n"
2889 " /* Examine the error message and print it etc. */\n"
2890 " char *msg = guestfs_last_error (g);\n"
2891 " int errnum = guestfs_last_errno (g);\n"
2892 " fprintf (stderr, \"%s\\n\", msg);\n"
2900 #: ../src/guestfs.pod:1301
2902 "Out of memory errors are handled differently. The default action is to call "
2903 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2904 "guestfs_set_out_of_memory_handler>."
2909 #: ../src/guestfs.pod:1305
2911 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2912 "because there is no handle if this happens there is no way to get additional "
2913 "error information. However L</guestfs_create> is supposed to be a "
2914 "lightweight operation which can only fail because of insufficient memory (it "
2915 "returns NULL in this case)."
2920 #: ../src/guestfs.pod:1311
2921 msgid "guestfs_last_error"
2926 #: ../src/guestfs.pod:1313
2929 " const char *guestfs_last_error (guestfs_h *g);\n"
2935 #: ../src/guestfs.pod:1315
2937 "This returns the last error message that happened on C<g>. If there has not "
2938 "been an error since the handle was created, then this returns C<NULL>."
2943 #: ../src/guestfs.pod:1319
2945 "The lifetime of the returned string is until the next error occurs, or L</"
2946 "guestfs_close> is called."
2951 #: ../src/guestfs.pod:1322
2952 msgid "guestfs_last_errno"
2957 #: ../src/guestfs.pod:1324
2960 " int guestfs_last_errno (guestfs_h *g);\n"
2966 #: ../src/guestfs.pod:1326
2967 msgid "This returns the last error number (errno) that happened on C<g>."
2972 #: ../src/guestfs.pod:1328
2973 msgid "If successful, an errno integer not equal to zero is returned."
2978 #: ../src/guestfs.pod:1330
2980 "If no error, this returns 0. This call can return 0 in three situations:"
2985 #: ../src/guestfs.pod:1337
2986 msgid "There has not been any error on the handle."
2991 #: ../src/guestfs.pod:1341
2993 "There has been an error but the errno was meaningless. This corresponds to "
2994 "the case where the error did not come from a failed system call, but for "
2995 "some other reason."
3000 #: ../src/guestfs.pod:1347
3002 "There was an error from a failed system call, but for some reason the errno "
3003 "was not captured and returned. This usually indicates a bug in libguestfs."
3008 #: ../src/guestfs.pod:1353
3010 "Libguestfs tries to convert the errno from inside the applicance into a "
3011 "corresponding errno for the caller (not entirely trivial: the appliance "
3012 "might be running a completely different operating system from the library "
3013 "and error numbers are not standardized across Un*xen). If this could not be "
3014 "done, then the error is translated to C<EINVAL>. In practice this should "
3015 "only happen in very rare circumstances."
3020 #: ../src/guestfs.pod:1361
3021 msgid "guestfs_set_error_handler"
3026 #: ../src/guestfs.pod:1363
3029 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3031 " const char *msg);\n"
3032 " void guestfs_set_error_handler (guestfs_h *g,\n"
3033 " guestfs_error_handler_cb cb,\n"
3040 #: ../src/guestfs.pod:1370
3042 "The callback C<cb> will be called if there is an error. The parameters "
3043 "passed to the callback are an opaque data pointer and the error message "
3049 #: ../src/guestfs.pod:1374
3051 "C<errno> is not passed to the callback. To get that the callback must call "
3052 "L</guestfs_last_errno>."
3057 #: ../src/guestfs.pod:1377
3059 "Note that the message string C<msg> is freed as soon as the callback "
3060 "function returns, so if you want to stash it somewhere you must make your "
3066 #: ../src/guestfs.pod:1381
3067 msgid "The default handler prints messages on C<stderr>."
3072 #: ../src/guestfs.pod:1383
3073 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3078 #: ../src/guestfs.pod:1385
3079 msgid "guestfs_get_error_handler"
3084 #: ../src/guestfs.pod:1387
3087 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3088 " void **opaque_rtn);\n"
3094 #: ../src/guestfs.pod:1390
3095 msgid "Returns the current error handler callback."
3100 #: ../src/guestfs.pod:1392
3101 msgid "guestfs_set_out_of_memory_handler"
3106 #: ../src/guestfs.pod:1394
3109 " typedef void (*guestfs_abort_cb) (void);\n"
3110 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3111 " guestfs_abort_cb);\n"
3117 #: ../src/guestfs.pod:1398
3119 "The callback C<cb> will be called if there is an out of memory situation. "
3120 "I<Note this callback must not return>."
3125 #: ../src/guestfs.pod:1401
3126 msgid "The default is to call L<abort(3)>."
3131 #: ../src/guestfs.pod:1403
3133 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3138 #: ../src/guestfs.pod:1406
3139 msgid "guestfs_get_out_of_memory_handler"
3144 #: ../src/guestfs.pod:1408
3147 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3153 #: ../src/guestfs.pod:1410
3154 msgid "This returns the current out of memory handler."
3159 #: ../src/guestfs.pod:1412
3165 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:958
3171 #: ../src/guestfs.pod:1416
3177 #: ../src/guestfs.pod:1418
3183 #: ../src/guestfs.pod:1420
3184 msgid "AVAILABILITY"
3189 #: ../src/guestfs.pod:1422
3190 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3195 #: ../src/guestfs.pod:1424
3197 "Using L</guestfs_available> you can test availability of the following "
3198 "groups of functions. This test queries the appliance to see if the "
3199 "appliance you are currently using supports the functionality."
3204 #: ../src/guestfs.pod:1429
3205 msgid "@AVAILABILITY@"
3210 #: ../src/guestfs.pod:1431
3211 msgid "GUESTFISH supported COMMAND"
3216 #: ../src/guestfs.pod:1433
3218 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3219 "prints out the available groups and whether they are supported by this build "
3220 "of libguestfs. Note however that you have to do C<run> first."
3225 #: ../src/guestfs.pod:1438
3226 msgid "SINGLE CALLS AT COMPILE TIME"
3231 #: ../src/guestfs.pod:1440
3233 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3234 "function, such as:"
3239 #: ../src/guestfs.pod:1443
3242 " #define LIBGUESTFS_HAVE_DD 1\n"
3248 #: ../src/guestfs.pod:1445
3249 msgid "if L</guestfs_dd> is available."
3254 #: ../src/guestfs.pod:1447
3256 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3257 "function is available at compile time, we recommended using build tools such "
3258 "as autoconf or cmake. For example in autotools you could use:"
3263 #: ../src/guestfs.pod:1452
3266 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3267 " AC_CHECK_FUNCS([guestfs_dd])\n"
3273 #: ../src/guestfs.pod:1455
3275 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3281 #: ../src/guestfs.pod:1458
3282 msgid "SINGLE CALLS AT RUN TIME"
3287 #: ../src/guestfs.pod:1460
3289 "Testing at compile time doesn't guarantee that a function really exists in "
3290 "the library. The reason is that you might be dynamically linked against a "
3291 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3292 "This situation unfortunately results in a segmentation fault, which is a "
3293 "shortcoming of the C dynamic linking system itself."
3298 #: ../src/guestfs.pod:1467
3300 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3301 "in this example program (note that you still need the compile time check as "
3307 #: ../src/guestfs.pod:1471
3310 " #include <stdio.h>\n"
3311 " #include <stdlib.h>\n"
3312 " #include <unistd.h>\n"
3313 " #include <dlfcn.h>\n"
3314 " #include <guestfs.h>\n"
3320 #: ../src/guestfs.pod:1477
3325 " #ifdef LIBGUESTFS_HAVE_DD\n"
3327 " int has_function;\n"
3333 #: ../src/guestfs.pod:1483
3336 " /* Test if the function guestfs_dd is really available. */\n"
3337 " dl = dlopen (NULL, RTLD_LAZY);\n"
3339 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3340 " exit (EXIT_FAILURE);\n"
3342 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3349 #: ../src/guestfs.pod:1492
3352 " if (!has_function)\n"
3353 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3355 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3356 " /* Now it's safe to call\n"
3357 " guestfs_dd (g, \"foo\", \"bar\");\n"
3361 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3369 #: ../src/guestfs.pod:1505
3371 "You may think the above is an awful lot of hassle, and it is. There are "
3372 "other ways outside of the C linking system to ensure that this kind of "
3373 "incompatibility never arises, such as using package versioning:"
3378 #: ../src/guestfs.pod:1510
3381 " Requires: libguestfs >= 1.0.80\n"
3387 #: ../src/guestfs.pod:1512
3388 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3393 #: ../src/guestfs.pod:1514
3395 "A recent feature of the API is the introduction of calls which take optional "
3396 "arguments. In C these are declared 3 ways. The main way is as a call which "
3397 "takes variable arguments (ie. C<...>), as in this example:"
3402 #: ../src/guestfs.pod:1519
3405 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3411 #: ../src/guestfs.pod:1521
3413 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3414 "call with no optional arguments specified:"
3419 #: ../src/guestfs.pod:1524
3422 " guestfs_add_drive_opts (g, filename, -1);\n"
3428 #: ../src/guestfs.pod:1526
3429 msgid "With a single optional argument:"
3434 #: ../src/guestfs.pod:1528
3437 " guestfs_add_drive_opts (g, filename,\n"
3438 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3445 #: ../src/guestfs.pod:1532
3451 #: ../src/guestfs.pod:1534
3454 " guestfs_add_drive_opts (g, filename,\n"
3455 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3456 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3463 #: ../src/guestfs.pod:1539
3465 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3471 #: ../src/guestfs.pod:1542
3472 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3477 #: ../src/guestfs.pod:1544
3479 "The second variant has the same name with the suffix C<_va>, which works the "
3480 "same way but takes a C<va_list>. See the C manual for details. For the "
3481 "example function, this is declared:"
3486 #: ../src/guestfs.pod:1548
3489 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3496 #: ../src/guestfs.pod:1551
3497 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3502 #: ../src/guestfs.pod:1553
3504 "The third variant is useful where you need to construct these calls. You "
3505 "pass in a structure where you fill in the optional fields. The structure "
3506 "has a bitmask as the first element which you must set to indicate which "
3507 "fields you have filled in. For our example function the structure and call "
3513 #: ../src/guestfs.pod:1559
3516 " struct guestfs_add_drive_opts_argv {\n"
3517 " uint64_t bitmask;\n"
3519 " const char *format;\n"
3522 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3523 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3529 #: ../src/guestfs.pod:1568
3530 msgid "You could call it like this:"
3535 #: ../src/guestfs.pod:1570
3538 " struct guestfs_add_drive_opts_argv optargs = {\n"
3539 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3540 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3542 " .format = \"qcow2\"\n"
3549 #: ../src/guestfs.pod:1577
3552 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3558 #: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11
3559 #: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9
3560 #: ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532
3566 #: ../src/guestfs.pod:1585
3567 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3572 #: ../src/guestfs.pod:1590
3573 msgid "You do not need to fill in all fields of the structure."
3578 #: ../src/guestfs.pod:1594
3580 "There must be a one-to-one correspondence between fields of the structure "
3581 "that are filled in, and bits set in the bitmask."
3586 #: ../src/guestfs.pod:1599
3587 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3592 #: ../src/guestfs.pod:1601
3594 "In other languages, optional arguments are expressed in the way that is "
3595 "natural for that language. We refer you to the language-specific "
3596 "documentation for more details on that."
3601 #: ../src/guestfs.pod:1605
3602 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3607 #: ../src/guestfs.pod:1607
3608 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3613 #: ../src/guestfs.pod:1609
3615 "The child process generates events in some situations. Current events "
3616 "include: receiving a log message, the child process exits."
3621 #: ../src/guestfs.pod:1612
3623 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3629 #: ../src/guestfs.pod:1615
3631 "Only I<one callback of each type> can be registered for each handle. "
3632 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3633 "that type. Cancel all callbacks of this type by calling this function with "
3634 "C<cb> set to C<NULL>."
3639 #: ../src/guestfs.pod:1620
3640 msgid "guestfs_set_log_message_callback"
3645 #: ../src/guestfs.pod:1622
3648 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3649 " char *buf, int len);\n"
3650 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3651 " guestfs_log_message_cb cb,\n"
3658 #: ../src/guestfs.pod:1628
3660 "The callback function C<cb> will be called whenever qemu or the guest writes "
3661 "anything to the console."
3666 #: ../src/guestfs.pod:1631
3667 msgid "Use this function to capture kernel messages and similar."
3672 #: ../src/guestfs.pod:1633
3674 "Normally there is no log message handler, and log messages are just "
3680 #: ../src/guestfs.pod:1636
3681 msgid "guestfs_set_subprocess_quit_callback"
3686 #: ../src/guestfs.pod:1638
3689 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3690 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3691 " guestfs_subprocess_quit_cb cb,\n"
3698 #: ../src/guestfs.pod:1643
3700 "The callback function C<cb> will be called when the child process quits, "
3701 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3702 "corresponds to a transition from any state to the CONFIG state)."
3707 #: ../src/guestfs.pod:1648
3708 msgid "guestfs_set_launch_done_callback"
3713 #: ../src/guestfs.pod:1650
3716 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3717 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3718 " guestfs_launch_done_cb cb,\n"
3725 #: ../src/guestfs.pod:1655
3727 "The callback function C<cb> will be called when the child process becomes "
3728 "ready first time after it has been launched. (This corresponds to a "
3729 "transition from LAUNCHING to the READY state)."
3734 #: ../src/guestfs.pod:1659
3735 msgid "guestfs_set_close_callback"
3740 #: ../src/guestfs.pod:1661
3743 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3744 " void guestfs_set_close_callback (guestfs_h *g,\n"
3745 " guestfs_close_cb cb,\n"
3752 #: ../src/guestfs.pod:1666
3754 "The callback function C<cb> will be called while the handle is being closed "
3755 "(synchronously from L</guestfs_close>)."
3760 #: ../src/guestfs.pod:1669
3762 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3763 "handles that are open when the program exits. This means that this callback "
3764 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3765 "problems in higher-level languages (eg. if your HLL interpreter has already "
3766 "been cleaned up by the time this is called, and if your callback then jumps "
3767 "into some HLL function)."
3772 #: ../src/guestfs.pod:1677
3773 msgid "guestfs_set_progress_callback"
3778 #: ../src/guestfs.pod:1679
3781 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3782 " int proc_nr, int serial,\n"
3783 " uint64_t position, uint64_t total);\n"
3784 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3785 " guestfs_progress_cb cb,\n"
3792 #: ../src/guestfs.pod:1686
3794 "Some long-running operations can generate progress messages. If this "
3795 "callback is registered, then it will be called each time a progress message "
3796 "is generated (usually two seconds after the operation started, and three "
3797 "times per second thereafter until it completes, although the frequency may "
3798 "change in future versions)."
3803 #: ../src/guestfs.pod:1692
3805 "The callback receives two numbers: C<position> and C<total>. The units of "
3806 "C<total> are not defined, although for some operations C<total> may relate "
3807 "in some way to the amount of data to be transferred (eg. in bytes or "
3808 "megabytes), and C<position> may be the portion which has been transferred."
3813 #: ../src/guestfs.pod:1698
3814 msgid "The only defined and stable parts of the API are:"
3819 #: ../src/guestfs.pod:1704
3821 "The callback can display to the user some type of progress bar or indicator "
3822 "which shows the ratio of C<position>:C<total>."
3827 #: ../src/guestfs.pod:1709
3828 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3833 #: ../src/guestfs.pod:1713
3835 "If any progress notification is sent during a call, then a final progress "
3836 "notification is always sent when C<position> = C<total>."
3841 #: ../src/guestfs.pod:1716
3843 "This is to simplify caller code, so callers can easily set the progress "
3844 "indicator to \"100%\" at the end of the operation, without requiring special "
3845 "code to detect this case."
3850 #: ../src/guestfs.pod:1722
3852 "The callback also receives the procedure number and serial number of the "
3853 "call. These are only useful for debugging protocol issues, and the callback "
3854 "can normally ignore them. The callback may want to print these numbers in "
3855 "error messages or debugging messages."
3860 #: ../src/guestfs.pod:1727
3861 msgid "PRIVATE DATA AREA"
3866 #: ../src/guestfs.pod:1729
3868 "You can attach named pieces of private data to the libguestfs handle, and "
3869 "fetch them by name for the lifetime of the handle. This is called the "
3870 "private data area and is only available from the C API."
3875 #: ../src/guestfs.pod:1733
3876 msgid "To attach a named piece of data, use the following call:"
3881 #: ../src/guestfs.pod:1735
3884 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3890 #: ../src/guestfs.pod:1737
3892 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3893 "pointer (which can be C<NULL>). Any previous item with the same name is "
3899 #: ../src/guestfs.pod:1741
3901 "You can use any C<key> you want, but names beginning with an underscore "
3902 "character are reserved for internal libguestfs purposes (for implementing "
3903 "language bindings). It is recommended to prefix the name with some unique "
3904 "string to avoid collisions with other users."
3909 #: ../src/guestfs.pod:1746
3910 msgid "To retrieve the pointer, use:"
3915 #: ../src/guestfs.pod:1748
3918 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3924 #: ../src/guestfs.pod:1750
3926 "This function returns C<NULL> if either no data is found associated with "
3927 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3933 #: ../src/guestfs.pod:1754
3935 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3936 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3937 "all. In particular, libguestfs does I<not> try to free the data when the "
3938 "handle is closed. If the data must be freed, then the caller must either "
3939 "free it before calling L</guestfs_close> or must set up a close callback to "
3940 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3941 "can be registered for a handle)."
3946 #: ../src/guestfs.pod:1762
3948 "The private data area is implemented using a hash table, and should be "
3949 "reasonably efficient for moderate numbers of keys."
3954 #: ../src/guestfs.pod:1765 ../src/guestfs.pod:1770
3960 #: ../src/guestfs.pod:1767
3962 "<!-- old anchor for the next section --> <a name="
3963 "\"state_machine_and_low_level_event_api\"/>"
3968 #: ../src/guestfs.pod:1772
3969 msgid "ARCHITECTURE"
3974 #: ../src/guestfs.pod:1774
3976 "Internally, libguestfs is implemented by running an appliance (a special "
3977 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3978 "process of the main program."
3983 #: ../src/guestfs.pod:1778
3986 " ___________________\n"
3988 " | main program |\n"
3990 " | | child process / appliance\n"
3991 " | | __________________________\n"
3993 " +-------------------+ RPC | +-----------------+ |\n"
3994 " | libguestfs <--------------------> guestfsd | |\n"
3995 " | | | +-----------------+ |\n"
3996 " \\___________________/ | | Linux kernel | |\n"
3997 " | +--^--------------+ |\n"
3998 " \\_________|________________/\n"
4004 " \\______________/\n"
4010 #: ../src/guestfs.pod:1798
4012 "The library, linked to the main program, creates the child process and hence "
4013 "the appliance in the L</guestfs_launch> function."
4018 #: ../src/guestfs.pod:1801
4020 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4021 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4022 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4023 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4024 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4025 "attached to the qemu process which translates device access by the "
4026 "appliance's Linux kernel into accesses to the image."
4031 #: ../src/guestfs.pod:1810
4033 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4034 "Although the disk image you are attached to might also be used by some "
4035 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4036 "care if both libguestfs's qemu process and your virtual machine are trying "
4037 "to update the disk image at the same time, since these usually results in "
4038 "massive disk corruption)."
4043 #: ../src/guestfs.pod:1817
4044 msgid "STATE MACHINE"
4049 #: ../src/guestfs.pod:1819
4050 msgid "libguestfs uses a state machine to model the child process:"
4055 #: ../src/guestfs.pod:1821
4067 " / | \\ \\ guestfs_launch\n"
4068 " / | _\\__V______\n"
4070 " / | | LAUNCHING |\n"
4071 " / | \\___________/\n"
4073 " / | guestfs_launch\n"
4075 " ______ / __|____V\n"
4076 " / \\ ------> / \\\n"
4077 " | BUSY | | READY |\n"
4078 " \\______/ <------ \\________/\n"
4084 #: ../src/guestfs.pod:1843
4086 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4087 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4088 "(3) alternating between READY and BUSY as commands are issued to, and "
4089 "carried out by, the child process."
4094 #: ../src/guestfs.pod:1848
4096 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4097 "asynchronously at any time (eg. due to some internal error), and that causes "
4098 "the state to transition back to CONFIG."
4103 #: ../src/guestfs.pod:1852
4105 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4106 "issued when in the CONFIG state."
4111 #: ../src/guestfs.pod:1855
4113 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4114 "L</guestfs_launch> blocks until the child process is READY to accept "
4115 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4116 "moves the state from CONFIG to LAUNCHING while it is running."
4121 #: ../src/guestfs.pod:1861
4123 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4124 "state. These API calls block waiting for the command to be carried out (ie. "
4125 "the state to transition to BUSY and then back to READY). There are no non-"
4126 "blocking versions, and no way to issue more than one command per handle at "
4132 #: ../src/guestfs.pod:1867
4134 "Finally, the child process sends asynchronous messages back to the main "
4135 "program, such as kernel log messages. You can register a callback to "
4136 "receive these messages."
4141 #: ../src/guestfs.pod:1871
4147 #: ../src/guestfs.pod:1873
4148 msgid "COMMUNICATION PROTOCOL"
4153 #: ../src/guestfs.pod:1875
4155 "Don't rely on using this protocol directly. This section documents how it "
4156 "currently works, but it may change at any time."
4161 #: ../src/guestfs.pod:1878
4163 "The protocol used to talk between the library and the daemon running inside "
4164 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4165 "1014, RFC 1832, RFC 4506)."
4170 #: ../src/guestfs.pod:1882
4172 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4173 "this file is automatically generated)."
4178 #: ../src/guestfs.pod:1885
4180 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4181 "and C<FileOut> parameters, which are handled with very simple request/reply "
4182 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4183 "parameters, which use the same request and reply messages, but they may also "
4184 "be followed by files sent using a chunked encoding."
4189 #: ../src/guestfs.pod:1892
4190 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4195 #: ../src/guestfs.pod:1894
4196 msgid "For ordinary functions, the request message is:"
4201 #: ../src/guestfs.pod:1896
4204 " total length (header + arguments,\n"
4205 " but not including the length word itself)\n"
4206 " struct guestfs_message_header (encoded as XDR)\n"
4207 " struct guestfs_<foo>_args (encoded as XDR)\n"
4213 #: ../src/guestfs.pod:1901
4215 "The total length field allows the daemon to allocate a fixed size buffer "
4216 "into which it slurps the rest of the message. As a result, the total length "
4217 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4218 "effective size of any request is limited to somewhere under this size."
4223 #: ../src/guestfs.pod:1907
4225 "Note also that many functions don't take any arguments, in which case the "
4226 "C<guestfs_I<foo>_args> is completely omitted."
4231 #: ../src/guestfs.pod:1910
4233 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4234 "receiver knows what type of args structure to expect, or none at all."
4239 #: ../src/guestfs.pod:1914
4241 "For functions that take optional arguments, the optional arguments are "
4242 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4243 "arguments. A bitmask in the header indicates which optional arguments are "
4244 "meaningful. The bitmask is also checked to see if it contains bits set "
4245 "which the daemon does not know about (eg. if more optional arguments were "
4246 "added in a later version of the library), and this causes the call to be "
4252 #: ../src/guestfs.pod:1922
4253 msgid "The reply message for ordinary functions is:"
4258 #: ../src/guestfs.pod:1924
4261 " total length (header + ret,\n"
4262 " but not including the length word itself)\n"
4263 " struct guestfs_message_header (encoded as XDR)\n"
4264 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4270 #: ../src/guestfs.pod:1929
4272 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4273 "functions that return no formal return values."
4278 #: ../src/guestfs.pod:1932
4280 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4285 #: ../src/guestfs.pod:1935
4287 "In the case of an error, a flag is set in the header, and the reply message "
4288 "is slightly changed:"
4293 #: ../src/guestfs.pod:1938
4296 " total length (header + error,\n"
4297 " but not including the length word itself)\n"
4298 " struct guestfs_message_header (encoded as XDR)\n"
4299 " struct guestfs_message_error (encoded as XDR)\n"
4305 #: ../src/guestfs.pod:1943
4307 "The C<guestfs_message_error> structure contains the error message as a "
4313 #: ../src/guestfs.pod:1946
4314 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4319 #: ../src/guestfs.pod:1948
4321 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4322 "The normal request message is sent (see above). However this is followed by "
4323 "a sequence of file chunks."
4328 #: ../src/guestfs.pod:1952
4331 " total length (header + arguments,\n"
4332 " but not including the length word itself,\n"
4333 " and not including the chunks)\n"
4334 " struct guestfs_message_header (encoded as XDR)\n"
4335 " struct guestfs_<foo>_args (encoded as XDR)\n"
4336 " sequence of chunks for FileIn param #0\n"
4337 " sequence of chunks for FileIn param #1 etc.\n"
4343 #: ../src/guestfs.pod:1960
4344 msgid "The \"sequence of chunks\" is:"
4349 #: ../src/guestfs.pod:1962
4352 " length of chunk (not including length word itself)\n"
4353 " struct guestfs_chunk (encoded as XDR)\n"
4354 " length of chunk\n"
4355 " struct guestfs_chunk (encoded as XDR)\n"
4357 " length of chunk\n"
4358 " struct guestfs_chunk (with data.data_len == 0)\n"
4364 #: ../src/guestfs.pod:1970
4366 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4367 "is set in the final chunk to indicate either successful completion or early "
4373 #: ../src/guestfs.pod:1974
4375 "At time of writing there are no functions that have more than one FileIn "
4376 "parameter. However this is (theoretically) supported, by sending the "
4377 "sequence of chunks for each FileIn parameter one after another (from left to "
4383 #: ../src/guestfs.pod:1979
4385 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4386 "transfer. The library does this by sending a chunk with a special flag set "
4387 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4388 "RPC, does I<not> send any reply, and goes back to reading the next request."
4393 #: ../src/guestfs.pod:1985
4395 "The daemon may also cancel. It does this by writing a special word "
4396 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4397 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4398 "cancel chunk). The special word is chosen so that even if cancellation "
4399 "happens right at the end of the transfer (after the library has finished "
4400 "writing and has started listening for the reply), the \"spurious\" cancel "
4401 "flag will not be confused with the reply message."
4406 #: ../src/guestfs.pod:1994
4408 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4409 "limit), and also files where the size is not known in advance (eg. from "
4410 "pipes or sockets). However the chunks are rather small "
4411 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4412 "to keep much in memory."
4417 #: ../src/guestfs.pod:2000
4418 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4423 #: ../src/guestfs.pod:2002
4425 "The protocol for FileOut parameters is exactly the same as for FileIn "
4426 "parameters, but with the roles of daemon and library reversed."
4431 #: ../src/guestfs.pod:2005
4434 " total length (header + ret,\n"
4435 " but not including the length word itself,\n"
4436 " and not including the chunks)\n"
4437 " struct guestfs_message_header (encoded as XDR)\n"
4438 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4439 " sequence of chunks for FileOut param #0\n"
4440 " sequence of chunks for FileOut param #1 etc.\n"
4446 #: ../src/guestfs.pod:2013
4447 msgid "INITIAL MESSAGE"
4452 #: ../src/guestfs.pod:2015
4454 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4455 "which indicates that the guest and daemon is alive. This is what L</"
4456 "guestfs_launch> waits for."
4461 #: ../src/guestfs.pod:2019
4462 msgid "PROGRESS NOTIFICATION MESSAGES"
4467 #: ../src/guestfs.pod:2021
4469 "The daemon may send progress notification messages at any time. These are "
4470 "distinguished by the normal length word being replaced by "
4471 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4476 #: ../src/guestfs.pod:2025
4478 "The library turns them into progress callbacks (see "
4479 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
4480 "discards them if not."
4485 #: ../src/guestfs.pod:2029
4487 "The daemon self-limits the frequency of progress messages it sends (see "
4488 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4494 #: ../src/guestfs.pod:2033
4495 msgid "LIBGUESTFS VERSION NUMBERS"
4500 #: ../src/guestfs.pod:2035
4502 "Since April 2010, libguestfs has started to make separate development and "
4503 "stable releases, along with corresponding branches in our git repository. "
4504 "These separate releases can be identified by version number:"
4509 #: ../src/guestfs.pod:2040
4512 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4513 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4519 " | `-------- sub-version\n"
4521 " `------ always '1' because we don't change the ABI\n"
4527 #: ../src/guestfs.pod:2051
4528 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4533 #: ../src/guestfs.pod:2053
4535 "As time passes we cherry pick fixes from the development branch and backport "
4536 "those into the stable branch, the effect being that the stable branch should "
4537 "get more stable and less buggy over time. So the stable releases are ideal "
4538 "for people who don't need new features but would just like the software to "
4544 #: ../src/guestfs.pod:2059
4545 msgid "Our criteria for backporting changes are:"
4550 #: ../src/guestfs.pod:2065
4552 "Documentation changes which don't affect any code are backported unless the "
4553 "documentation refers to a future feature which is not in stable."
4558 #: ../src/guestfs.pod:2071
4560 "Bug fixes which are not controversial, fix obvious problems, and have been "
4561 "well tested are backported."
4566 #: ../src/guestfs.pod:2076
4568 "Simple rearrangements of code which shouldn't affect how it works get "
4569 "backported. This is so that the code in the two branches doesn't get too "
4570 "far out of step, allowing us to backport future fixes more easily."
4575 #: ../src/guestfs.pod:2082
4577 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4578 "exceptional case: the new feature is required in order to implement an "
4579 "important bug fix."
4584 #: ../src/guestfs.pod:2088
4586 "A new stable branch starts when we think the new features in development are "
4587 "substantial and compelling enough over the current stable branch to warrant "
4588 "it. When that happens we create new stable and development versions 1.N.0 "
4589 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4590 "stable at this point, but by backporting fixes from development, that branch "
4591 "will stabilize over time."
4595 #: ../src/guestfs.pod:2096
4596 msgid "EXTENDING LIBGUESTFS"
4600 #: ../src/guestfs.pod:2098
4601 msgid "ADDING A NEW API ACTION"
4605 #: ../src/guestfs.pod:2100
4607 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4608 "documentation) are generated, and this makes it easy to extend the "
4613 #: ../src/guestfs.pod:2104
4614 msgid "To add a new API action there are two changes:"
4618 #: ../src/guestfs.pod:2110
4620 "You need to add a description of the call (name, parameters, return type, "
4621 "tests, documentation) to C<generator/generator_actions.ml>."
4625 #: ../src/guestfs.pod:2113
4627 "There are two sorts of API action, depending on whether the call goes "
4628 "through to the daemon in the appliance, or is serviced entirely by the "
4629 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4630 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4631 "an example of the latter, since a trace flag is maintained in the handle and "
4632 "all tracing is done on the library side."
4636 #: ../src/guestfs.pod:2121
4638 "Most new actions are of the first type, and get added to the "
4639 "C<daemon_functions> list. Each function has a unique procedure number used "
4640 "in the RPC protocol which is assigned to that action when we publish "
4641 "libguestfs and cannot be reused. Take the latest procedure number and "
4646 #: ../src/guestfs.pod:2127
4648 "For library-only actions of the second type, add to the "
4649 "C<non_daemon_functions> list. Since these functions are serviced by the "
4650 "library and do not travel over the RPC mechanism to the daemon, these "
4651 "functions do not need a procedure number, and so the procedure number is set "
4656 #: ../src/guestfs.pod:2135
4657 msgid "Implement the action (in C):"
4661 #: ../src/guestfs.pod:2137
4663 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4664 "C<daemon/> directory."
4668 #: ../src/guestfs.pod:2140
4670 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4671 "(note: double underscore) in the C<src/> directory."
4675 #: ../src/guestfs.pod:2143
4676 msgid "In either case, use another function as an example of what to do."
4680 #: ../src/guestfs.pod:2147
4681 msgid "After making these changes, use C<make> to compile."
4685 #: ../src/guestfs.pod:2149
4687 "Note that you don't need to implement the RPC, language bindings, manual "
4688 "pages or anything else. It's all automatically generated from the OCaml "
4693 #: ../src/guestfs.pod:2153
4694 msgid "ADDING TESTS FOR AN API ACTION"
4698 #: ../src/guestfs.pod:2155
4700 "You can supply zero or as many tests as you want per API call. The tests "
4701 "can either be added as part of the API description (C<generator/"
4702 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4703 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4704 "slower, so if possible use the first method."
4708 #: ../src/guestfs.pod:2161
4710 "The following describes the test environment used when you add an API test "
4711 "in C<generator_actions.ml>."
4715 #: ../src/guestfs.pod:2164
4716 msgid "The test environment has 4 block devices:"
4720 #: ../src/guestfs.pod:2168
4721 msgid "C</dev/sda> 500MB"
4725 #: ../src/guestfs.pod:2170
4726 msgid "General block device for testing."
4730 #: ../src/guestfs.pod:2172
4731 msgid "C</dev/sdb> 50MB"
4735 #: ../src/guestfs.pod:2174
4737 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4742 #: ../src/guestfs.pod:2177
4743 msgid "C</dev/sdc> 10MB"
4747 #: ../src/guestfs.pod:2179
4748 msgid "Used in a few tests where two block devices are needed."
4752 #: ../src/guestfs.pod:2181
4757 #: ../src/guestfs.pod:2183
4758 msgid "ISO with fixed content (see C<images/test.iso>)."
4762 #: ../src/guestfs.pod:2187
4764 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4765 "appliance and block devices are reused between tests. So don't try testing "
4766 "L</guestfs_kill_subprocess> :-x"
4770 #: ../src/guestfs.pod:2191
4772 "Each test starts with an initial scenario, selected using one of the "
4773 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4774 "initialize the disks mentioned above in a particular way as documented in "
4775 "C<generator_types.ml>. You should not assume anything about the previous "
4776 "contents of other disks that are not initialized."
4780 #: ../src/guestfs.pod:2197
4782 "You can add a prerequisite clause to any individual test. This is a run-"
4783 "time check, which, if it fails, causes the test to be skipped. Useful if "
4784 "testing a command which might not work on all variations of libguestfs "
4785 "builds. A test that has prerequisite of C<Always> means to run "
4790 #: ../src/guestfs.pod:2203
4792 "In addition, packagers can skip individual tests by setting environment "
4793 "variables before running C<make check>."
4797 #: ../src/guestfs.pod:2206
4800 " SKIP_TEST_<CMD>_<NUM>=1\n"
4805 #: ../src/guestfs.pod:2208
4806 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4810 #: ../src/guestfs.pod:2210
4815 #: ../src/guestfs.pod:2212
4818 " SKIP_TEST_<CMD>=1\n"
4823 #: ../src/guestfs.pod:2214
4824 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4828 #: ../src/guestfs.pod:2216
4829 msgid "Packagers can run only certain tests by setting for example:"
4833 #: ../src/guestfs.pod:2218
4836 " TEST_ONLY=\"vfs_type zerofree\"\n"
4841 #: ../src/guestfs.pod:2220
4843 "See C<capitests/tests.c> for more details of how these environment variables "
4848 #: ../src/guestfs.pod:2223
4849 msgid "DEBUGGING NEW API ACTIONS"
4853 #: ../src/guestfs.pod:2225
4854 msgid "Test new actions work before submitting them."
4858 #: ../src/guestfs.pod:2227
4859 msgid "You can use guestfish to try out new commands."
4863 #: ../src/guestfs.pod:2229
4865 "Debugging the daemon is a problem because it runs inside a minimal "
4866 "environment. However you can fprintf messages in the daemon to stderr, and "
4867 "they will show up if you use C<guestfish -v>."
4871 #: ../src/guestfs.pod:2233
4872 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4876 #: ../src/guestfs.pod:2235
4878 "Our C source code generally adheres to some basic code-formatting "
4879 "conventions. The existing code base is not totally consistent on this "
4880 "front, but we do prefer that contributed code be formatted similarly. In "
4881 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4882 "indentation level, and other than that, follow the K&R style."
4886 #: ../src/guestfs.pod:2241
4888 "If you use Emacs, add the following to one of one of your start-up files (e."
4889 "g., ~/.emacs), to help ensure that you get indentation right:"
4893 #: ../src/guestfs.pod:2244
4896 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4897 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4898 " (add-hook 'find-file-hook\n"
4899 " '(lambda () (if (and buffer-file-name\n"
4900 " (string-match \"/libguestfs\\\\>\"\n"
4901 " (buffer-file-name))\n"
4902 " (not (string-equal mode-name \"Change Log\"))\n"
4903 " (not (string-equal mode-name \"Makefile\")))\n"
4904 " (setq indent-tabs-mode nil))))\n"
4909 #: ../src/guestfs.pod:2254
4912 " ;;; When editing C sources in libguestfs, use this style.\n"
4913 " (defun libguestfs-c-mode ()\n"
4914 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4916 " (c-set-style \"K&R\")\n"
4917 " (setq c-indent-level 2)\n"
4918 " (setq c-basic-offset 2))\n"
4919 " (add-hook 'c-mode-hook\n"
4920 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4921 " (buffer-file-name))\n"
4922 " (libguestfs-c-mode))))\n"
4927 #: ../src/guestfs.pod:2266
4928 msgid "Enable warnings when compiling (and fix any problems this finds):"
4932 #: ../src/guestfs.pod:2269
4935 " ./configure --enable-gcc-warnings\n"
4940 #: ../src/guestfs.pod:2271
4941 msgid "Useful targets are:"
4945 #: ../src/guestfs.pod:2273
4948 " make syntax-check # checks the syntax of the C code\n"
4949 " make check # runs the test suite\n"
4954 #: ../src/guestfs.pod:2276
4955 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4959 #: ../src/guestfs.pod:2278
4961 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4962 "which are used to do shell quoting."
4966 #: ../src/guestfs.pod:2283
4971 #: ../src/guestfs.pod:2285
4973 "Simple shell quoted string. Any spaces or other shell characters are "
4978 #: ../src/guestfs.pod:2288
4983 #: ../src/guestfs.pod:2290
4985 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4991 #: ../src/guestfs.pod:2295 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4992 msgid "For example:"
4996 #: ../src/guestfs.pod:2297
4999 " asprintf (&cmd, \"cat %R\", path);\n"
5004 #: ../src/guestfs.pod:2299
5005 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5009 #: ../src/guestfs.pod:2301
5011 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5012 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5013 "they are not passed via the shell (instead, straight to exec). You probably "
5014 "want to use the C<sysroot_path()> function however."
5018 #: ../src/guestfs.pod:2307
5019 msgid "SUBMITTING YOUR NEW API ACTIONS"
5023 #: ../src/guestfs.pod:2309
5025 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5026 "libguestfs> and CC to L<rjones@redhat.com>."
5030 #: ../src/guestfs.pod:2313
5031 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5035 #: ../src/guestfs.pod:2315
5036 msgid "We support i18n (gettext anyhow) in the library."
5040 #: ../src/guestfs.pod:2317
5042 "However many messages come from the daemon, and we don't translate those at "
5043 "the moment. One reason is that the appliance generally has all locale files "
5044 "removed from it, because they take up a lot of space. So we'd have to readd "
5045 "some of those, as well as copying our PO files into the appliance."
5049 #: ../src/guestfs.pod:2323
5051 "Debugging messages are never translated, since they are intended for the "
5056 #: ../src/guestfs.pod:2326
5057 msgid "SOURCE CODE SUBDIRECTORIES"
5061 #: ../src/guestfs.pod:2330
5062 msgid "C<appliance>"
5066 #: ../src/guestfs.pod:2332
5067 msgid "The libguestfs appliance, build scripts and so on."
5071 #: ../src/guestfs.pod:2334
5072 msgid "C<capitests>"
5076 #: ../src/guestfs.pod:2336
5077 msgid "Automated tests of the C API."
5081 #: ../src/guestfs.pod:2338
5086 #: ../src/guestfs.pod:2340
5088 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5093 #: ../src/guestfs.pod:2343
5098 #: ../src/guestfs.pod:2345
5099 msgid "Outside contributions, experimental parts."
5103 #: ../src/guestfs.pod:2347
5108 #: ../src/guestfs.pod:2349
5110 "The daemon that runs inside the libguestfs appliance and carries out actions."
5114 #: ../src/guestfs.pod:2352
5119 #: ../src/guestfs.pod:2354
5120 msgid "L<virt-df(1)> command and documentation."
5124 #: ../src/guestfs.pod:2356
5129 #: ../src/guestfs.pod:2358
5130 msgid "C API example code."
5134 #: ../src/guestfs.pod:2360
5139 #: ../src/guestfs.pod:2362
5140 msgid "L<guestfish(1)>, the command-line shell."
5144 #: ../src/guestfs.pod:2364
5149 #: ../src/guestfs.pod:2366
5151 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5155 #: ../src/guestfs.pod:2368
5156 msgid "C<generator>"
5160 #: ../src/guestfs.pod:2370
5162 "The crucially important generator, used to automatically generate large "
5163 "amounts of boilerplate C code for things like RPC and bindings."
5167 #: ../src/guestfs.pod:2373
5172 #: ../src/guestfs.pod:2375
5173 msgid "Files used by the test suite."
5177 #: ../src/guestfs.pod:2377
5178 msgid "Some \"phony\" guest images which we test against."
5182 #: ../src/guestfs.pod:2379
5183 msgid "C<inspector>"
5187 #: ../src/guestfs.pod:2381
5188 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5192 #: ../src/guestfs.pod:2383
5197 #: ../src/guestfs.pod:2385
5198 msgid "M4 macros used by autoconf."
5202 #: ../src/guestfs.pod:2387
5207 #: ../src/guestfs.pod:2389
5208 msgid "Translations of simple gettext strings."
5212 #: ../src/guestfs.pod:2391
5217 #: ../src/guestfs.pod:2393
5219 "The build infrastructure and PO files for translations of manpages and POD "
5220 "files. Eventually this will be combined with the C<po> directory, but that "
5221 "is rather complicated."
5225 #: ../src/guestfs.pod:2397
5226 msgid "C<regressions>"
5230 #: ../src/guestfs.pod:2399
5231 msgid "Regression tests."
5235 #: ../src/guestfs.pod:2401
5240 #: ../src/guestfs.pod:2403
5241 msgid "L<virt-rescue(1)> command and documentation."
5245 #: ../src/guestfs.pod:2405
5250 #: ../src/guestfs.pod:2407
5251 msgid "Source code to the C library."
5255 #: ../src/guestfs.pod:2409
5260 #: ../src/guestfs.pod:2411
5261 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5265 #: ../src/guestfs.pod:2413
5266 msgid "C<test-tool>"
5270 #: ../src/guestfs.pod:2415
5272 "Test tool for end users to test if their qemu/kernel combination will work "
5277 #: ../src/guestfs.pod:2418
5282 #: ../src/guestfs.pod:2420
5287 #: ../src/guestfs.pod:2422
5292 #: ../src/guestfs.pod:2424
5297 #: ../src/guestfs.pod:2426
5302 #: ../src/guestfs.pod:2428
5307 #: ../src/guestfs.pod:2430
5312 #: ../src/guestfs.pod:2432
5317 #: ../src/guestfs.pod:2434
5318 msgid "Language bindings."
5323 #: ../src/guestfs.pod:2438 ../fish/guestfish.pod:965
5324 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5325 msgid "ENVIRONMENT VARIABLES"
5330 #: ../src/guestfs.pod:2442 ../fish/guestfish.pod:991
5331 msgid "LIBGUESTFS_APPEND"
5336 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:993
5337 msgid "Pass additional options to the guest kernel."
5342 #: ../src/guestfs.pod:2446 ../fish/guestfish.pod:995
5343 msgid "LIBGUESTFS_DEBUG"
5348 #: ../src/guestfs.pod:2448
5350 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5351 "effect as calling C<guestfs_set_verbose (g, 1)>."
5356 #: ../src/guestfs.pod:2451 ../fish/guestfish.pod:1000
5357 msgid "LIBGUESTFS_MEMSIZE"
5362 #: ../src/guestfs.pod:2453 ../fish/guestfish.pod:1002
5364 "Set the memory allocated to the qemu process, in megabytes. For example:"
5369 #: ../src/guestfs.pod:2456 ../fish/guestfish.pod:1005
5372 " LIBGUESTFS_MEMSIZE=700\n"
5378 #: ../src/guestfs.pod:2458 ../fish/guestfish.pod:1007
5379 msgid "LIBGUESTFS_PATH"
5384 #: ../src/guestfs.pod:2460
5386 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
5387 "the discussion of paths in section PATH above."
5392 #: ../src/guestfs.pod:2463 ../fish/guestfish.pod:1012
5393 msgid "LIBGUESTFS_QEMU"
5398 #: ../src/guestfs.pod:2465 ../fish/guestfish.pod:1014
5400 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5401 "which was found at compile time by the configure script is used."
5406 #: ../src/guestfs.pod:2469
5407 msgid "See also L</QEMU WRAPPERS> above."
5412 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1018
5413 msgid "LIBGUESTFS_TRACE"
5418 #: ../src/guestfs.pod:2473
5420 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5421 "effect as calling C<guestfs_set_trace (g, 1)>."
5426 #: ../src/guestfs.pod:2476 ../fish/guestfish.pod:1027
5432 #: ../src/guestfs.pod:2478 ../fish/guestfish.pod:1029
5433 msgid "Location of temporary directory, defaults to C</tmp>."
5438 #: ../src/guestfs.pod:2480 ../fish/guestfish.pod:1031
5440 "If libguestfs was compiled to use the supermin appliance then the real "
5441 "appliance is cached in this directory, shared between all handles belonging "
5442 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5443 "use in case C</tmp> is not large enough."
5448 #: ../src/guestfs.pod:2488 ../fish/guestfish.pod:1089
5449 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
5450 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572
5451 #: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189
5452 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:539
5453 #: ../tools/virt-list-partitions.pl:257
5459 #: ../src/guestfs.pod:2490
5461 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5462 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
5463 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
5464 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
5465 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
5466 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5471 #: ../src/guestfs.pod:2513
5473 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5474 "(8)>, L<disktype(1)>."
5479 #: ../src/guestfs.pod:2520 ../tools/virt-win-reg.pl:587
5480 #: ../tools/virt-make-fs.pl:553
5486 #: ../src/guestfs.pod:2522
5487 msgid "To get a list of bugs against libguestfs use this link:"
5492 #: ../src/guestfs.pod:2524
5494 "L<https://bugzilla.redhat.com/buglist.cgi?"
5495 "component=libguestfs&product=Virtualization+Tools>"
5500 #: ../src/guestfs.pod:2526
5501 msgid "To report a new bug against libguestfs use this link:"
5506 #: ../src/guestfs.pod:2528
5508 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5509 "component=libguestfs&product=Virtualization+Tools>"
5514 #: ../src/guestfs.pod:2530
5515 msgid "When reporting a bug, please check:"
5520 #: ../src/guestfs.pod:2536
5521 msgid "That the bug hasn't been reported already."
5526 #: ../src/guestfs.pod:2540
5527 msgid "That you are testing a recent version."
5532 #: ../src/guestfs.pod:2544
5533 msgid "Describe the bug accurately, and give a way to reproduce it."
5538 #: ../src/guestfs.pod:2548
5540 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5546 #: ../src/guestfs.pod:2553 ../fish/guestfish.pod:1108
5547 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
5553 #: ../src/guestfs.pod:2555 ../fish/guestfish.pod:1110
5554 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
5555 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5560 #: ../src/guestfs.pod:2557 ../fish/guestfish.pod:1112
5561 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
5562 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:602
5563 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206
5564 #: ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:568
5565 #: ../tools/virt-list-partitions.pl:273
5571 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1114
5572 #: ../fuse/guestmount.pod:250
5573 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
5578 #: ../src/guestfs.pod:2562
5580 "This library is free software; you can redistribute it and/or modify it "
5581 "under the terms of the GNU Lesser General Public License as published by the "
5582 "Free Software Foundation; either version 2 of the License, or (at your "
5583 "option) any later version."
5588 #: ../src/guestfs.pod:2567
5590 "This library is distributed in the hope that it will be useful, but WITHOUT "
5591 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5592 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5598 #: ../src/guestfs.pod:2572
5600 "You should have received a copy of the GNU Lesser General Public License "
5601 "along with this library; if not, write to the Free Software Foundation, "
5602 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5607 #: ../src/guestfs-actions.pod:1
5608 msgid "guestfs_add_cdrom"
5613 #: ../src/guestfs-actions.pod:3
5617 " guestfs_add_cdrom (guestfs_h *g,\n"
5618 " const char *filename);\n"
5624 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5625 msgid "This function adds a virtual CD-ROM disk image to the guest."
5630 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5631 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5636 #: ../src/guestfs-actions.pod:17
5638 "This call checks for the existence of C<filename>. This stops you from "
5639 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5640 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5646 #: ../src/guestfs-actions.pod:24
5648 "If you just want to add an ISO file (often you use this as an efficient way "
5649 "to transfer large files into the guest), then you should probably use "
5650 "C<guestfs_add_drive_ro> instead."
5655 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
5656 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
5657 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
5658 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
5659 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
5660 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
5661 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
5662 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
5663 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
5664 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
5665 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
5666 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
5667 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
5668 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
5669 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
5670 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
5671 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
5672 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
5673 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
5674 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2243
5675 #: ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448
5676 #: ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3226
5677 #: ../src/guestfs-actions.pod:3241 ../src/guestfs-actions.pod:3261
5678 #: ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3430
5679 #: ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3457
5680 #: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3508
5681 #: ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3600
5682 #: ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3640
5683 #: ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3695
5684 #: ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3733
5685 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3780
5686 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3832
5687 #: ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3860
5688 #: ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3970
5689 #: ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4003
5690 #: ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4072
5691 #: ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4106
5692 #: ../src/guestfs-actions.pod:4120 ../src/guestfs-actions.pod:4134
5693 #: ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:4166
5694 #: ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4232
5695 #: ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4336
5696 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4374
5697 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4403
5698 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4431
5699 #: ../src/guestfs-actions.pod:4446 ../src/guestfs-actions.pod:4481
5700 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4516
5701 #: ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4547
5702 #: ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4633
5703 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4675
5704 #: ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4710
5705 #: ../src/guestfs-actions.pod:4844 ../src/guestfs-actions.pod:4901
5706 #: ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:4941
5707 #: ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:5039
5708 #: ../src/guestfs-actions.pod:5056 ../src/guestfs-actions.pod:5069
5709 #: ../src/guestfs-actions.pod:5083 ../src/guestfs-actions.pod:5372
5710 #: ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5405
5711 #: ../src/guestfs-actions.pod:5417 ../src/guestfs-actions.pod:5431
5712 #: ../src/guestfs-actions.pod:5443 ../src/guestfs-actions.pod:5457
5713 #: ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:5494
5714 #: ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5532
5715 #: ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5573
5716 #: ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5610
5717 #: ../src/guestfs-actions.pod:5631 ../src/guestfs-actions.pod:5650
5718 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5695
5719 #: ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:5738
5720 #: ../src/guestfs-actions.pod:5762 ../src/guestfs-actions.pod:5777
5721 #: ../src/guestfs-actions.pod:5792 ../src/guestfs-actions.pod:5811
5722 #: ../src/guestfs-actions.pod:5848 ../src/guestfs-actions.pod:5871
5723 #: ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6005
5724 #: ../src/guestfs-actions.pod:6126 ../src/guestfs-actions.pod:6138
5725 #: ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6164
5726 #: ../src/guestfs-actions.pod:6186 ../src/guestfs-actions.pod:6199
5727 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6225
5728 #: ../src/guestfs-actions.pod:6240 ../src/guestfs-actions.pod:6299
5729 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6332
5730 #: ../src/guestfs-actions.pod:6348 ../src/guestfs-actions.pod:6365
5731 #: ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6398
5732 #: ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6448
5733 #: ../src/guestfs-actions.pod:6489 ../src/guestfs-actions.pod:6502
5734 #: ../src/guestfs-actions.pod:6520 ../src/guestfs-actions.pod:6554
5735 #: ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6709
5736 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741
5737 #: ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6809
5738 #: ../src/guestfs-actions.pod:6854 ../src/guestfs-actions.pod:6887
5739 #: ../src/guestfs-actions.pod:6941 ../src/guestfs-actions.pod:6967
5740 #: ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7052
5741 #: ../src/guestfs-actions.pod:7081
5742 msgid "This function returns 0 on success or -1 on error."
5747 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
5748 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
5749 #: ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
5751 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5757 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
5758 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
5759 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
5760 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:6975
5761 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:31
5762 #: ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168
5763 #: ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1306
5764 #: ../fish/guestfish-actions.pod:1320 ../fish/guestfish-actions.pod:2820
5765 #: ../fish/guestfish-actions.pod:4624 ../fish/guestfish-actions.pod:4721
5767 "Deprecated functions will not be removed from the API, but the fact that "
5768 "they are deprecated indicates that there are problems with correct use of "
5774 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
5775 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
5776 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
5777 #: ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3243
5778 #: ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:5552
5779 #: ../src/guestfs-actions.pod:5669 ../src/guestfs-actions.pod:5779
5780 #: ../src/guestfs-actions.pod:6242 ../src/guestfs-actions.pod:6367
5781 #: ../src/guestfs-actions.pod:6889
5782 msgid "(Added in 0.3)"
5787 #: ../src/guestfs-actions.pod:41
5788 msgid "guestfs_add_domain"
5793 #: ../src/guestfs-actions.pod:43
5797 " guestfs_add_domain (guestfs_h *g,\n"
5798 " const char *dom,\n"
5805 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
5806 #: ../src/guestfs-actions.pod:4205
5808 "You may supply a list of optional arguments to this call. Use zero or more "
5809 "of the following pairs of parameters, and terminate the list with C<-1> on "
5810 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5815 #: ../src/guestfs-actions.pod:53
5818 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5819 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5820 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5826 #: ../src/guestfs-actions.pod:57
5828 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5829 "It works by connecting to libvirt, requesting the domain and domain XML from "
5830 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5836 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5838 "The number of disks added is returned. This operation is atomic: if an "
5839 "error is returned, then no disks are added."
5844 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5846 "This function does some minimal checks to make sure the libvirt domain is "
5847 "not running (unless C<readonly> is true). In a future version we will try "
5848 "to acquire the libvirt lock on each disk."
5853 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5855 "Disks must be accessible locally. This often means that adding disks from a "
5856 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5857 "unless those disks are accessible via the same device path locally too."
5861 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5863 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5864 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5865 "libvirt URI (or one set through an environment variable, see the libvirt "
5866 "documentation for full details)."
5871 #: ../src/guestfs-actions.pod:80
5873 "The other optional parameters are passed directly through to "
5874 "C<guestfs_add_drive_opts>."
5879 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336
5880 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
5881 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
5882 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
5883 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
5884 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
5885 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
5886 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662
5887 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4619
5888 #: ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:5153
5889 #: ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:6475
5890 #: ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6913
5891 #: ../src/guestfs-actions.pod:6926
5892 msgid "On error this function returns -1."
5897 #: ../src/guestfs-actions.pod:85
5898 msgid "(Added in 1.7.4)"
5903 #: ../src/guestfs-actions.pod:87
5904 msgid "guestfs_add_domain_va"
5909 #: ../src/guestfs-actions.pod:89
5913 " guestfs_add_domain_va (guestfs_h *g,\n"
5914 " const char *dom,\n"
5921 #: ../src/guestfs-actions.pod:94
5922 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5927 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
5928 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
5929 #: ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:4258
5930 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5935 #: ../src/guestfs-actions.pod:98
5936 msgid "guestfs_add_domain_argv"
5941 #: ../src/guestfs-actions.pod:100
5945 " guestfs_add_domain_argv (guestfs_h *g,\n"
5946 " const char *dom,\n"
5947 " const struct guestfs_add_domain_argv *optargs);\n"
5953 #: ../src/guestfs-actions.pod:105
5954 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5959 #: ../src/guestfs-actions.pod:109
5960 msgid "guestfs_add_drive"
5965 #: ../src/guestfs-actions.pod:111
5969 " guestfs_add_drive (guestfs_h *g,\n"
5970 " const char *filename);\n"
5976 #: ../src/guestfs-actions.pod:115
5978 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5979 "optional parameters, so the disk is added writable, with the format being "
5980 "detected automatically."
5985 #: ../src/guestfs-actions.pod:119
5987 "Automatic detection of the format opens you up to a potential security hole "
5988 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5989 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5990 "you should think about replacing calls to this function with calls to "
5991 "C<guestfs_add_drive_opts>, and specifying the format."
5996 #: ../src/guestfs-actions.pod:130
5997 msgid "guestfs_add_drive_opts"
6002 #: ../src/guestfs-actions.pod:132
6006 " guestfs_add_drive_opts (guestfs_h *g,\n"
6007 " const char *filename,\n"
6014 #: ../src/guestfs-actions.pod:142
6017 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6018 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6019 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6025 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
6027 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6028 "The first time you call this function, the disk appears as C</dev/sda>, the "
6029 "second time as C</dev/sdb>, and so on."
6034 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
6036 "You don't necessarily need to be root when using libguestfs. However you "
6037 "obviously do need sufficient permissions to access the filename for whatever "
6038 "operations you want to perform (ie. read access if you just want to read the "
6039 "image or write access if you want to modify the image)."
6044 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
6045 msgid "This call checks that C<filename> exists."
6050 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4215
6051 #: ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2831
6052 msgid "The optional arguments are:"
6057 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
6063 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
6065 "If true then the image is treated as read-only. Writes are still allowed, "
6066 "but they are stored in a temporary snapshot overlay which is discarded at "
6067 "the end. The disk that you add is not modified."
6072 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
6078 #: ../src/guestfs-actions.pod:171
6080 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6081 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6082 "Possible formats include C<raw> and C<qcow2>."
6087 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
6089 "Automatic detection of the format opens you up to a potential security hole "
6090 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6091 "RHBZ#642934. Specifying the format closes this security hole."
6096 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
6102 #: ../src/guestfs-actions.pod:182
6104 "This rarely-used option lets you emulate the behaviour of the deprecated "
6105 "C<guestfs_add_drive_with_if> call (q.v.)"
6110 #: ../src/guestfs-actions.pod:189
6111 msgid "(Added in 1.5.23)"
6116 #: ../src/guestfs-actions.pod:191
6117 msgid "guestfs_add_drive_opts_va"
6122 #: ../src/guestfs-actions.pod:193
6126 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6127 " const char *filename,\n"
6134 #: ../src/guestfs-actions.pod:198
6135 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6140 #: ../src/guestfs-actions.pod:202
6141 msgid "guestfs_add_drive_opts_argv"
6146 #: ../src/guestfs-actions.pod:204
6150 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6151 " const char *filename,\n"
6152 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6158 #: ../src/guestfs-actions.pod:209
6159 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6164 #: ../src/guestfs-actions.pod:213
6165 msgid "guestfs_add_drive_ro"
6170 #: ../src/guestfs-actions.pod:215
6174 " guestfs_add_drive_ro (guestfs_h *g,\n"
6175 " const char *filename);\n"
6181 #: ../src/guestfs-actions.pod:219
6183 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6184 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6185 "disk is added read-only, with the format being detected automatically."
6190 #: ../src/guestfs-actions.pod:226
6191 msgid "(Added in 1.0.38)"
6196 #: ../src/guestfs-actions.pod:228
6197 msgid "guestfs_add_drive_ro_with_if"
6202 #: ../src/guestfs-actions.pod:230
6206 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6207 " const char *filename,\n"
6208 " const char *iface);\n"
6214 #: ../src/guestfs-actions.pod:235
6216 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6217 "QEMU interface emulation to use at run time."
6222 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
6223 #: ../src/guestfs-actions.pod:2333
6224 msgid "(Added in 1.0.84)"
6229 #: ../src/guestfs-actions.pod:249
6230 msgid "guestfs_add_drive_with_if"
6235 #: ../src/guestfs-actions.pod:251
6239 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6240 " const char *filename,\n"
6241 " const char *iface);\n"
6247 #: ../src/guestfs-actions.pod:256
6249 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6250 "QEMU interface emulation to use at run time."
6255 #: ../src/guestfs-actions.pod:270
6256 msgid "guestfs_aug_clear"
6261 #: ../src/guestfs-actions.pod:272
6265 " guestfs_aug_clear (guestfs_h *g,\n"
6266 " const char *augpath);\n"
6272 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
6274 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6275 "L<augtool(1)> C<clear> command."
6280 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
6281 msgid "(Added in 1.3.4)"
6286 #: ../src/guestfs-actions.pod:283
6287 msgid "guestfs_aug_close"
6292 #: ../src/guestfs-actions.pod:285
6296 " guestfs_aug_close (guestfs_h *g);\n"
6302 #: ../src/guestfs-actions.pod:288
6304 "Close the current Augeas handle and free up any resources used by it. After "
6305 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6306 "any other Augeas functions."
6311 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
6312 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
6313 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
6314 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
6315 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
6316 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
6317 #: ../src/guestfs-actions.pod:5230
6318 msgid "(Added in 0.7)"
6323 #: ../src/guestfs-actions.pod:297
6324 msgid "guestfs_aug_defnode"
6329 #: ../src/guestfs-actions.pod:299
6332 " struct guestfs_int_bool *\n"
6333 " guestfs_aug_defnode (guestfs_h *g,\n"
6334 " const char *name,\n"
6335 " const char *expr,\n"
6336 " const char *val);\n"
6342 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
6344 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6349 #: ../src/guestfs-actions.pod:308
6351 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6352 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6353 "containing that single node."
6358 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
6360 "On success this returns a pair containing the number of nodes in the "
6361 "nodeset, and a boolean flag if a node was created."
6366 #: ../src/guestfs-actions.pod:316
6368 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6369 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6374 #: ../src/guestfs-actions.pod:322
6375 msgid "guestfs_aug_defvar"
6380 #: ../src/guestfs-actions.pod:324
6384 " guestfs_aug_defvar (guestfs_h *g,\n"
6385 " const char *name,\n"
6386 " const char *expr);\n"
6392 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
6394 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6395 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6400 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
6402 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6403 "evaluates to something which is not a nodeset."
6408 #: ../src/guestfs-actions.pod:340
6409 msgid "guestfs_aug_get"
6414 #: ../src/guestfs-actions.pod:342
6418 " guestfs_aug_get (guestfs_h *g,\n"
6419 " const char *augpath);\n"
6425 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
6427 "Look up the value associated with C<path>. If C<path> matches exactly one "
6428 "node, the C<value> is returned."
6433 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
6434 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
6435 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
6436 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
6437 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
6438 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
6439 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
6440 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
6441 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2298
6442 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586
6443 #: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2748
6444 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2803
6445 #: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2888
6446 #: ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3752
6447 #: ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4032
6448 #: ../src/guestfs-actions.pod:4765 ../src/guestfs-actions.pod:4958
6449 #: ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5306
6450 #: ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5918
6451 #: ../src/guestfs-actions.pod:5934 ../src/guestfs-actions.pod:5951
6452 #: ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6649
6453 #: ../src/guestfs-actions.pod:6668 ../src/guestfs-actions.pod:6686
6454 #: ../src/guestfs-actions.pod:6866 ../src/guestfs-actions.pod:7138
6456 "This function returns a string, or NULL on error. I<The caller must free "
6457 "the returned string after use>."
6462 #: ../src/guestfs-actions.pod:354
6463 msgid "guestfs_aug_init"
6468 #: ../src/guestfs-actions.pod:356
6472 " guestfs_aug_init (guestfs_h *g,\n"
6473 " const char *root,\n"
6480 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
6482 "Create a new Augeas handle for editing configuration files. If there was "
6483 "any previous Augeas handle associated with this guestfs session, then it is "
6489 #: ../src/guestfs-actions.pod:365
6490 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6495 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
6497 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6502 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
6504 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6505 "logical I<or> of the following integers:"
6510 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
6511 msgid "C<AUG_SAVE_BACKUP> = 1"
6516 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
6517 msgid "Keep the original file with a C<.augsave> extension."
6522 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
6523 msgid "C<AUG_SAVE_NEWFILE> = 2"
6528 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
6530 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6531 "original. Overrides C<AUG_SAVE_BACKUP>."
6536 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
6537 msgid "C<AUG_TYPE_CHECK> = 4"
6542 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
6543 msgid "Typecheck lenses (can be expensive)."
6548 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
6549 msgid "C<AUG_NO_STDINC> = 8"
6554 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
6555 msgid "Do not use standard load path for modules."
6560 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
6561 msgid "C<AUG_SAVE_NOOP> = 16"
6566 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
6567 msgid "Make save a no-op, just record what would have been changed."
6572 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
6573 msgid "C<AUG_NO_LOAD> = 32"
6578 #: ../src/guestfs-actions.pod:400
6579 msgid "Do not load the tree in C<guestfs_aug_init>."
6584 #: ../src/guestfs-actions.pod:404
6585 msgid "To close the handle, you can call C<guestfs_aug_close>."
6590 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
6591 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6596 #: ../src/guestfs-actions.pod:412
6597 msgid "guestfs_aug_insert"
6602 #: ../src/guestfs-actions.pod:414
6606 " guestfs_aug_insert (guestfs_h *g,\n"
6607 " const char *augpath,\n"
6608 " const char *label,\n"
6615 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
6617 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6618 "or after C<path> (depending on the boolean flag C<before>)."
6623 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
6625 "C<path> must match exactly one existing node in the tree, and C<label> must "
6626 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6631 #: ../src/guestfs-actions.pod:432
6632 msgid "guestfs_aug_load"
6637 #: ../src/guestfs-actions.pod:434
6641 " guestfs_aug_load (guestfs_h *g);\n"
6647 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
6648 msgid "Load files into the tree."
6653 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
6654 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6659 #: ../src/guestfs-actions.pod:446
6660 msgid "guestfs_aug_ls"
6665 #: ../src/guestfs-actions.pod:448
6669 " guestfs_aug_ls (guestfs_h *g,\n"
6670 " const char *augpath);\n"
6676 #: ../src/guestfs-actions.pod:452
6678 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6679 "sorting the resulting nodes into alphabetical order."
6684 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
6685 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
6686 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
6687 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
6688 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2178
6689 #: ../src/guestfs-actions.pod:2194 ../src/guestfs-actions.pod:2213
6690 #: ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2280
6691 #: ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:2400
6692 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2822
6693 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3322
6694 #: ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:3489
6695 #: ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:4580
6696 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5226
6697 #: ../src/guestfs-actions.pod:5340 ../src/guestfs-actions.pod:5991
6698 #: ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6107
6699 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6277
6700 #: ../src/guestfs-actions.pod:6759 ../src/guestfs-actions.pod:6779
6701 #: ../src/guestfs-actions.pod:6826 ../src/guestfs-actions.pod:6991
6702 #: ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7095
6703 #: ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7160
6704 #: ../src/guestfs-actions.pod:7179
6706 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6707 ">), or NULL if there was an error. I<The caller must free the strings and "
6708 "the array after use>."
6713 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
6714 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
6715 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3146
6716 #: ../src/guestfs-actions.pod:3735 ../src/guestfs-actions.pod:3785
6717 #: ../src/guestfs-actions.pod:3972 ../src/guestfs-actions.pod:4005
6718 #: ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4584
6719 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5419
6720 #: ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5445
6721 #: ../src/guestfs-actions.pod:5853 ../src/guestfs-actions.pod:6491
6722 #: ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6743
6723 #: ../src/guestfs-actions.pod:6979
6724 msgid "(Added in 0.8)"
6729 #: ../src/guestfs-actions.pod:461
6730 msgid "guestfs_aug_match"
6735 #: ../src/guestfs-actions.pod:463
6739 " guestfs_aug_match (guestfs_h *g,\n"
6740 " const char *augpath);\n"
6746 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
6748 "Returns a list of paths which match the path expression C<path>. The "
6749 "returned paths are sufficiently qualified so that they match exactly one "
6750 "node in the current tree."
6755 #: ../src/guestfs-actions.pod:477
6756 msgid "guestfs_aug_mv"
6761 #: ../src/guestfs-actions.pod:479
6765 " guestfs_aug_mv (guestfs_h *g,\n"
6766 " const char *src,\n"
6767 " const char *dest);\n"
6773 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
6775 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6776 "C<dest> is overwritten if it exists."
6781 #: ../src/guestfs-actions.pod:491
6782 msgid "guestfs_aug_rm"
6787 #: ../src/guestfs-actions.pod:493
6791 " guestfs_aug_rm (guestfs_h *g,\n"
6792 " const char *augpath);\n"
6798 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
6799 msgid "Remove C<path> and all of its children."
6804 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
6805 msgid "On success this returns the number of entries which were removed."
6810 #: ../src/guestfs-actions.pod:505
6811 msgid "guestfs_aug_save"
6816 #: ../src/guestfs-actions.pod:507
6820 " guestfs_aug_save (guestfs_h *g);\n"
6826 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
6827 msgid "This writes all pending changes to disk."
6832 #: ../src/guestfs-actions.pod:512
6834 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6840 #: ../src/guestfs-actions.pod:519
6841 msgid "guestfs_aug_set"
6846 #: ../src/guestfs-actions.pod:521
6850 " guestfs_aug_set (guestfs_h *g,\n"
6851 " const char *augpath,\n"
6852 " const char *val);\n"
6858 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
6859 msgid "Set the value associated with C<path> to C<val>."
6864 #: ../src/guestfs-actions.pod:528
6866 "In the Augeas API, it is possible to clear a node by setting the value to "
6867 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6868 "this call. Instead you must use the C<guestfs_aug_clear> call."
6873 #: ../src/guestfs-actions.pod:537
6874 msgid "guestfs_available"
6879 #: ../src/guestfs-actions.pod:539
6883 " guestfs_available (guestfs_h *g,\n"
6884 " char *const *groups);\n"
6890 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
6892 "This command is used to check the availability of some groups of "
6893 "functionality in the appliance, which not all builds of the libguestfs "
6894 "appliance will be able to provide."
6899 #: ../src/guestfs-actions.pod:547
6901 "The libguestfs groups, and the functions that those groups correspond to, "
6902 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6903 "runtime by calling C<guestfs_available_all_groups>."
6908 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
6910 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6911 "\"]> would check for the availability of the Linux inotify functions and "
6912 "Augeas (configuration file editing) functions."
6917 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
6918 msgid "The command returns no error if I<all> requested groups are available."
6923 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
6925 "It fails with an error if one or more of the requested groups is unavailable "
6931 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
6933 "If an unknown group name is included in the list of groups then an error is "
6939 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
6945 #: ../src/guestfs-actions.pod:571
6946 msgid "You must call C<guestfs_launch> before calling this function."
6951 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
6953 "The reason is because we don't know what groups are supported by the "
6954 "appliance/daemon until it is running and can be queried."
6959 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
6961 "If a group of functions is available, this does not necessarily mean that "
6962 "they will work. You still have to check for errors when calling individual "
6963 "API functions even if they are available."
6968 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6970 "It is usually the job of distro packagers to build complete functionality "
6971 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6972 "with all requirements satisfied, will support everything."
6977 #: ../src/guestfs-actions.pod:593
6979 "This call was added in version C<1.0.80>. In previous versions of "
6980 "libguestfs all you could do would be to speculatively execute a command to "
6981 "find out if the daemon implemented it. See also C<guestfs_version>."
6986 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6987 msgid "(Added in 1.0.80)"
6992 #: ../src/guestfs-actions.pod:604
6993 msgid "guestfs_available_all_groups"
6998 #: ../src/guestfs-actions.pod:606
7002 " guestfs_available_all_groups (guestfs_h *g);\n"
7008 #: ../src/guestfs-actions.pod:609
7010 "This command returns a list of all optional groups that this daemon knows "
7011 "about. Note this returns both supported and unsupported groups. To find "
7012 "out which ones the daemon can actually support you have to call "
7013 "C<guestfs_available> on each member of the returned list."
7018 #: ../src/guestfs-actions.pod:615
7019 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7024 #: ../src/guestfs-actions.pod:621
7025 msgid "(Added in 1.3.15)"
7030 #: ../src/guestfs-actions.pod:623
7031 msgid "guestfs_base64_in"
7036 #: ../src/guestfs-actions.pod:625
7040 " guestfs_base64_in (guestfs_h *g,\n"
7041 " const char *base64file,\n"
7042 " const char *filename);\n"
7048 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
7050 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7055 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
7056 msgid "(Added in 1.3.5)"
7061 #: ../src/guestfs-actions.pod:637
7062 msgid "guestfs_base64_out"
7067 #: ../src/guestfs-actions.pod:639
7071 " guestfs_base64_out (guestfs_h *g,\n"
7072 " const char *filename,\n"
7073 " const char *base64file);\n"
7079 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
7081 "This command downloads the contents of C<filename>, writing it out to local "
7082 "file C<base64file> encoded as base64."
7087 #: ../src/guestfs-actions.pod:651
7088 msgid "guestfs_blockdev_flushbufs"
7093 #: ../src/guestfs-actions.pod:653
7097 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7098 " const char *device);\n"
7104 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
7106 "This tells the kernel to flush internal buffers associated with C<device>."
7111 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
7112 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
7113 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
7114 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
7115 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
7116 #: ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:452
7117 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:471
7118 #: ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:496
7119 #: ../fish/guestfish-actions.pod:504 ../fish/guestfish-actions.pod:515
7120 #: ../fish/guestfish-actions.pod:523 ../fish/guestfish-actions.pod:531
7121 msgid "This uses the L<blockdev(8)> command."
7126 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
7127 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
7128 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
7129 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
7130 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
7131 msgid "(Added in 0.9.3)"
7136 #: ../src/guestfs-actions.pod:666
7137 msgid "guestfs_blockdev_getbsz"
7142 #: ../src/guestfs-actions.pod:668
7146 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7147 " const char *device);\n"
7153 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
7154 msgid "This returns the block size of a device."
7159 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
7160 #: ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
7162 "(Note this is different from both I<size in blocks> and I<filesystem block "
7168 #: ../src/guestfs-actions.pod:683
7169 msgid "guestfs_blockdev_getro"
7174 #: ../src/guestfs-actions.pod:685
7178 " guestfs_blockdev_getro (guestfs_h *g,\n"
7179 " const char *device);\n"
7185 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
7187 "Returns a boolean indicating if the block device is read-only (true if read-"
7188 "only, false if not)."
7193 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
7194 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
7195 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
7196 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
7197 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
7198 #: ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3068
7199 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3097
7200 #: ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3128
7201 #: ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3158
7202 #: ../src/guestfs-actions.pod:3171 ../src/guestfs-actions.pod:3185
7203 #: ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3215
7204 #: ../src/guestfs-actions.pod:4729
7205 msgid "This function returns a C truth value on success or -1 on error."
7210 #: ../src/guestfs-actions.pod:698
7211 msgid "guestfs_blockdev_getsize64"
7216 #: ../src/guestfs-actions.pod:700
7220 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7221 " const char *device);\n"
7227 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
7228 msgid "This returns the size of the device in bytes."
7233 #: ../src/guestfs-actions.pod:706
7234 msgid "See also C<guestfs_blockdev_getsz>."
7239 #: ../src/guestfs-actions.pod:714
7240 msgid "guestfs_blockdev_getss"
7245 #: ../src/guestfs-actions.pod:716
7249 " guestfs_blockdev_getss (guestfs_h *g,\n"
7250 " const char *device);\n"
7256 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
7258 "This returns the size of sectors on a block device. Usually 512, but can be "
7259 "larger for modern devices."
7264 #: ../src/guestfs-actions.pod:723
7266 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7272 #: ../src/guestfs-actions.pod:732
7273 msgid "guestfs_blockdev_getsz"
7278 #: ../src/guestfs-actions.pod:734
7282 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7283 " const char *device);\n"
7289 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
7291 "This returns the size of the device in units of 512-byte sectors (even if "
7292 "the sectorsize isn't 512 bytes ... weird)."
7297 #: ../src/guestfs-actions.pod:741
7299 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7300 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7305 #: ../src/guestfs-actions.pod:751
7306 msgid "guestfs_blockdev_rereadpt"
7311 #: ../src/guestfs-actions.pod:753
7315 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7316 " const char *device);\n"
7322 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
7323 msgid "Reread the partition table on C<device>."
7328 #: ../src/guestfs-actions.pod:765
7329 msgid "guestfs_blockdev_setbsz"
7334 #: ../src/guestfs-actions.pod:767
7338 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7339 " const char *device,\n"
7340 " int blocksize);\n"
7346 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
7347 msgid "This sets the block size of a device."
7352 #: ../src/guestfs-actions.pod:783
7353 msgid "guestfs_blockdev_setro"
7358 #: ../src/guestfs-actions.pod:785
7362 " guestfs_blockdev_setro (guestfs_h *g,\n"
7363 " const char *device);\n"
7369 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
7370 msgid "Sets the block device named C<device> to read-only."
7375 #: ../src/guestfs-actions.pod:797
7376 msgid "guestfs_blockdev_setrw"
7381 #: ../src/guestfs-actions.pod:799
7385 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7386 " const char *device);\n"
7392 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
7393 msgid "Sets the block device named C<device> to read-write."
7398 #: ../src/guestfs-actions.pod:811
7399 msgid "guestfs_case_sensitive_path"
7404 #: ../src/guestfs-actions.pod:813
7408 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7409 " const char *path);\n"
7415 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
7417 "This can be used to resolve case insensitive paths on a filesystem which is "
7418 "case sensitive. The use case is to resolve paths which you have read from "
7419 "Windows configuration files or the Windows Registry, to the true path."
7424 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
7426 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7427 "(and probably others), which is that although the underlying filesystem is "
7428 "case-insensitive, the driver exports the filesystem to Linux as case-"
7434 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
7436 "One consequence of this is that special directories such as C<c:\\windows> "
7437 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7438 "precise details of how they were created. In Windows itself this would not "
7444 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
7446 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7452 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
7454 "This function resolves the true case of each element in the path and returns "
7455 "the case-sensitive path."
7460 #: ../src/guestfs-actions.pod:839
7462 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7463 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7464 "how the directories were originally created under Windows)."
7469 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
7470 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7475 #: ../src/guestfs-actions.pod:847
7476 msgid "See also C<guestfs_realpath>."
7481 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6671
7482 msgid "(Added in 1.0.75)"
7487 #: ../src/guestfs-actions.pod:854
7493 #: ../src/guestfs-actions.pod:856
7497 " guestfs_cat (guestfs_h *g,\n"
7498 " const char *path);\n"
7504 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5216
7505 #: ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3468
7506 msgid "Return the contents of the file named C<path>."
7511 #: ../src/guestfs-actions.pod:862
7513 "Note that this function cannot correctly handle binary files (specifically, "
7514 "files containing C<\\0> character which is treated as end of string). For "
7515 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7516 "functions which have a more complex interface."
7521 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
7522 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
7523 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
7524 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
7525 #: ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2217
7526 #: ../src/guestfs-actions.pod:2260 ../src/guestfs-actions.pod:2284
7527 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2330
7528 #: ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5024
7529 #: ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5181
7530 #: ../src/guestfs-actions.pod:5205 ../src/guestfs-actions.pod:6056
7531 #: ../src/guestfs-actions.pod:6111 ../src/guestfs-actions.pod:6257
7532 #: ../src/guestfs-actions.pod:6281 ../src/guestfs-actions.pod:6943
7533 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6995
7534 #: ../src/guestfs-actions.pod:7014 ../src/guestfs-actions.pod:7099
7535 #: ../src/guestfs-actions.pod:7118 ../src/guestfs-actions.pod:7164
7536 #: ../src/guestfs-actions.pod:7183 ../fish/guestfish-actions.pod:580
7537 #: ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727
7538 #: ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913
7539 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990
7540 #: ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1480
7541 #: ../fish/guestfish-actions.pod:1490 ../fish/guestfish-actions.pod:1518
7542 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1543
7543 #: ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:3338
7544 #: ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3429
7545 #: ../fish/guestfish-actions.pod:3446 ../fish/guestfish-actions.pod:3461
7546 #: ../fish/guestfish-actions.pod:4044 ../fish/guestfish-actions.pod:4090
7547 #: ../fish/guestfish-actions.pod:4175 ../fish/guestfish-actions.pod:4190
7548 #: ../fish/guestfish-actions.pod:4600 ../fish/guestfish-actions.pod:4618
7549 #: ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4645
7550 #: ../fish/guestfish-actions.pod:4693 ../fish/guestfish-actions.pod:4703
7551 #: ../fish/guestfish-actions.pod:4732 ../fish/guestfish-actions.pod:4742
7553 "Because of the message protocol, there is a transfer limit of somewhere "
7554 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7559 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3326
7560 #: ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3405
7561 #: ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3898
7562 #: ../src/guestfs-actions.pod:3912 ../src/guestfs-actions.pod:5104
7563 #: ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:6830
7564 #: ../src/guestfs-actions.pod:6844
7565 msgid "(Added in 0.4)"
7570 #: ../src/guestfs-actions.pod:875
7571 msgid "guestfs_checksum"
7576 #: ../src/guestfs-actions.pod:877
7580 " guestfs_checksum (guestfs_h *g,\n"
7581 " const char *csumtype,\n"
7582 " const char *path);\n"
7588 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
7590 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7595 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
7597 "The type of checksum to compute is given by the C<csumtype> parameter which "
7598 "must have one of the following values:"
7603 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
7609 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
7611 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7617 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
7623 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
7624 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7629 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
7635 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
7636 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7641 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
7647 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
7648 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7653 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
7659 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
7660 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7665 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
7671 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
7672 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7677 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
7683 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
7684 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7689 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
7690 msgid "The checksum is returned as a printable string."
7695 #: ../src/guestfs-actions.pod:923
7696 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7701 #: ../src/guestfs-actions.pod:925
7702 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7707 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
7708 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3070
7709 #: ../src/guestfs-actions.pod:3099 ../src/guestfs-actions.pod:3160
7710 #: ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:6527
7711 msgid "(Added in 1.0.2)"
7716 #: ../src/guestfs-actions.pod:932
7717 msgid "guestfs_checksum_device"
7722 #: ../src/guestfs-actions.pod:934
7726 " guestfs_checksum_device (guestfs_h *g,\n"
7727 " const char *csumtype,\n"
7728 " const char *device);\n"
7734 #: ../src/guestfs-actions.pod:939
7736 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7737 "device named C<device>. For the types of checksums supported see the "
7738 "C<guestfs_checksum> command."
7743 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4635
7744 #: ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4731
7745 #: ../src/guestfs-actions.pod:4749 ../src/guestfs-actions.pod:4925
7746 #: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6450
7747 #: ../src/guestfs-actions.pod:6856
7748 msgid "(Added in 1.3.2)"
7753 #: ../src/guestfs-actions.pod:948
7754 msgid "guestfs_checksums_out"
7759 #: ../src/guestfs-actions.pod:950
7763 " guestfs_checksums_out (guestfs_h *g,\n"
7764 " const char *csumtype,\n"
7765 " const char *directory,\n"
7766 " const char *sumsfile);\n"
7772 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
7774 "This command computes the checksums of all regular files in C<directory> and "
7775 "then emits a list of those checksums to the local output file C<sumsfile>."
7780 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
7782 "This can be used for verifying the integrity of a virtual machine. However "
7783 "to be properly secure you should pay attention to the output of the checksum "
7784 "command (it uses the ones from GNU coreutils). In particular when the "
7785 "filename is not printable, coreutils uses a special backslash syntax. For "
7786 "more information, see the GNU coreutils info file."
7791 #: ../src/guestfs-actions.pod:970
7792 msgid "(Added in 1.3.7)"
7797 #: ../src/guestfs-actions.pod:972
7798 msgid "guestfs_chmod"
7803 #: ../src/guestfs-actions.pod:974
7807 " guestfs_chmod (guestfs_h *g,\n"
7809 " const char *path);\n"
7815 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
7817 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7823 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
7825 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7826 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7832 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4149
7833 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4353
7834 #: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:669
7835 #: ../fish/guestfish-actions.pod:2795 ../fish/guestfish-actions.pod:2913
7836 #: ../fish/guestfish-actions.pod:2923 ../fish/guestfish-actions.pod:2933
7837 msgid "The mode actually set is affected by the umask."
7842 #: ../src/guestfs-actions.pod:992
7843 msgid "guestfs_chown"
7848 #: ../src/guestfs-actions.pod:994
7852 " guestfs_chown (guestfs_h *g,\n"
7855 " const char *path);\n"
7861 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
7862 msgid "Change the file owner to C<owner> and group to C<group>."
7867 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3257
7868 #: ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2253
7870 "Only numeric uid and gid are supported. If you want to use names, you will "
7871 "need to locate and parse the password file yourself (Augeas support makes "
7872 "this relatively easy)."
7877 #: ../src/guestfs-actions.pod:1010
7878 msgid "guestfs_command"
7883 #: ../src/guestfs-actions.pod:1012
7887 " guestfs_command (guestfs_h *g,\n"
7888 " char *const *arguments);\n"
7894 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
7896 "This call runs a command from the guest filesystem. The filesystem must be "
7897 "mounted, and must contain a compatible operating system (ie. something "
7898 "Linux, with the same or compatible processor architecture)."
7903 #: ../src/guestfs-actions.pod:1021
7905 "The single parameter is an argv-style list of arguments. The first element "
7906 "is the name of the program to run. Subsequent elements are parameters. The "
7907 "list must be non-empty (ie. must contain a program name). Note that the "
7908 "command runs directly, and is I<not> invoked via the shell (see "
7914 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
7915 msgid "The return value is anything printed to I<stdout> by the command."
7920 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
7922 "If the command returns a non-zero exit status, then this function returns an "
7923 "error message. The error message string is the content of I<stderr> from "
7929 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
7931 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7932 "bin>. If you require a program from another location, you should provide "
7933 "the full path in the first parameter."
7938 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
7940 "Shared libraries and data files required by the program must be available on "
7941 "filesystems which are mounted in the correct places. It is the caller's "
7942 "responsibility to ensure all filesystems that are needed are mounted at the "
7948 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
7949 #: ../src/guestfs-actions.pod:1535
7950 msgid "(Added in 0.9.1)"
7955 #: ../src/guestfs-actions.pod:1054
7956 msgid "guestfs_command_lines"
7961 #: ../src/guestfs-actions.pod:1056
7965 " guestfs_command_lines (guestfs_h *g,\n"
7966 " char *const *arguments);\n"
7972 #: ../src/guestfs-actions.pod:1060
7974 "This is the same as C<guestfs_command>, but splits the result into a list of "
7980 #: ../src/guestfs-actions.pod:1063
7981 msgid "See also: C<guestfs_sh_lines>"
7986 #: ../src/guestfs-actions.pod:1074
7987 msgid "guestfs_config"
7992 #: ../src/guestfs-actions.pod:1076
7996 " guestfs_config (guestfs_h *g,\n"
7997 " const char *qemuparam,\n"
7998 " const char *qemuvalue);\n"
8004 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
8006 "This can be used to add arbitrary qemu command line parameters of the form "
8007 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8008 "setting some parameters which would interfere with parameters that we use."
8013 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
8014 msgid "The first character of C<param> string must be a C<-> (dash)."
8019 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
8020 msgid "C<value> can be NULL."
8025 #: ../src/guestfs-actions.pod:1094
8026 msgid "guestfs_copy_size"
8031 #: ../src/guestfs-actions.pod:1096
8035 " guestfs_copy_size (guestfs_h *g,\n"
8036 " const char *src,\n"
8037 " const char *dest,\n"
8044 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
8046 "This command copies exactly C<size> bytes from one source device or file "
8047 "C<src> to another destination device or file C<dest>."
8052 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
8054 "Note this will fail if the source is too short or if the destination is not "
8060 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
8061 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
8062 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6522
8063 #: ../src/guestfs-actions.pod:6556 ../src/guestfs-actions.pod:7035
8064 #: ../src/guestfs-actions.pod:7054
8066 "This long-running command can generate progress notification messages so "
8067 "that the caller can display a progress bar or indicator. To receive these "
8068 "messages, the caller must register a progress callback. See L<guestfs(3)/"
8069 "guestfs_set_progress_callback>."
8074 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3925
8075 #: ../src/guestfs-actions.pod:5131 ../src/guestfs-actions.pod:6763
8076 #: ../src/guestfs-actions.pod:6783 ../src/guestfs-actions.pod:6869
8077 msgid "(Added in 1.0.87)"
8082 #: ../src/guestfs-actions.pod:1117
8088 #: ../src/guestfs-actions.pod:1119
8092 " guestfs_cp (guestfs_h *g,\n"
8093 " const char *src,\n"
8094 " const char *dest);\n"
8100 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
8102 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8103 "destination filename or destination directory."
8108 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
8109 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
8110 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4598
8111 #: ../src/guestfs-actions.pod:4975
8112 msgid "(Added in 1.0.18)"
8117 #: ../src/guestfs-actions.pod:1131
8118 msgid "guestfs_cp_a"
8123 #: ../src/guestfs-actions.pod:1133
8127 " guestfs_cp_a (guestfs_h *g,\n"
8128 " const char *src,\n"
8129 " const char *dest);\n"
8135 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
8137 "This copies a file or directory from C<src> to C<dest> recursively using the "
8143 #: ../src/guestfs-actions.pod:1145
8149 #: ../src/guestfs-actions.pod:1147
8153 " guestfs_dd (guestfs_h *g,\n"
8154 " const char *src,\n"
8155 " const char *dest);\n"
8161 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
8163 "This command copies from one source device or file C<src> to another "
8164 "destination device or file C<dest>. Normally you would use this to copy to "
8165 "or from a device or partition, for example to duplicate a filesystem."
8170 #: ../src/guestfs-actions.pod:1157
8172 "If the destination is a device, it must be as large or larger than the "
8173 "source file or device, otherwise the copy will fail. This command cannot do "
8174 "partial copies (see C<guestfs_copy_size>)."
8179 #: ../src/guestfs-actions.pod:1165
8185 #: ../src/guestfs-actions.pod:1167
8189 " guestfs_df (guestfs_h *g);\n"
8195 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
8196 msgid "This command runs the C<df> command to report disk space used."
8201 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
8203 "This command is mostly useful for interactive sessions. It is I<not> "
8204 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8210 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
8211 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2263
8212 #: ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2355
8213 #: ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4498
8214 #: ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:6284
8215 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:6915
8216 #: ../src/guestfs-actions.pod:6928
8217 msgid "(Added in 1.0.54)"
8222 #: ../src/guestfs-actions.pod:1181
8223 msgid "guestfs_df_h"
8228 #: ../src/guestfs-actions.pod:1183
8232 " guestfs_df_h (guestfs_h *g);\n"
8238 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
8240 "This command runs the C<df -h> command to report disk space used in human-"
8246 #: ../src/guestfs-actions.pod:1198
8247 msgid "guestfs_dmesg"
8252 #: ../src/guestfs-actions.pod:1200
8256 " guestfs_dmesg (guestfs_h *g);\n"
8262 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
8264 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8265 "This is sometimes useful for extended debugging of problems."
8270 #: ../src/guestfs-actions.pod:1207
8272 "Another way to get the same information is to enable verbose messages with "
8273 "C<guestfs_set_verbose> or by setting the environment variable "
8274 "C<LIBGUESTFS_DEBUG=1> before running the program."
8279 #: ../src/guestfs-actions.pod:1217
8280 msgid "guestfs_download"
8285 #: ../src/guestfs-actions.pod:1219
8289 " guestfs_download (guestfs_h *g,\n"
8290 " const char *remotefilename,\n"
8291 " const char *filename);\n"
8297 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
8298 #: ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
8300 "Download file C<remotefilename> and save it as C<filename> on the local "
8306 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6516
8307 #: ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4348
8308 msgid "C<filename> can also be a named pipe."
8313 #: ../src/guestfs-actions.pod:1229
8314 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8319 #: ../src/guestfs-actions.pod:1240
8320 msgid "guestfs_download_offset"
8325 #: ../src/guestfs-actions.pod:1242
8329 " guestfs_download_offset (guestfs_h *g,\n"
8330 " const char *remotefilename,\n"
8331 " const char *filename,\n"
8332 " int64_t offset,\n"
8339 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
8341 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8342 "region must be within the file or device)."
8347 #: ../src/guestfs-actions.pod:1255
8349 "Note that there is no limit on the amount of data that can be downloaded "
8350 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8351 "full amount unless an error occurs."
8356 #: ../src/guestfs-actions.pod:1260
8357 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8362 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6561
8363 msgid "(Added in 1.5.17)"
8368 #: ../src/guestfs-actions.pod:1271
8369 msgid "guestfs_drop_caches"
8374 #: ../src/guestfs-actions.pod:1273
8378 " guestfs_drop_caches (guestfs_h *g,\n"
8379 " int whattodrop);\n"
8385 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
8387 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8388 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8389 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8394 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
8395 msgid "Setting C<whattodrop> to 3 should drop everything."
8400 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
8402 "This automatically calls L<sync(2)> before the operation, so that the "
8403 "maximum guest memory is freed."
8408 #: ../src/guestfs-actions.pod:1291
8414 #: ../src/guestfs-actions.pod:1293
8418 " guestfs_du (guestfs_h *g,\n"
8419 " const char *path);\n"
8425 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
8427 "This command runs the C<du -s> command to estimate file space usage for "
8433 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
8435 "C<path> can be a file or a directory. If C<path> is a directory then the "
8436 "estimate includes the contents of the directory and all subdirectories "
8442 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
8444 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8449 #: ../src/guestfs-actions.pod:1311
8450 msgid "guestfs_e2fsck_f"
8455 #: ../src/guestfs-actions.pod:1313
8459 " guestfs_e2fsck_f (guestfs_h *g,\n"
8460 " const char *device);\n"
8466 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
8468 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8469 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8475 #: ../src/guestfs-actions.pod:1321
8477 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8478 "Normally you should use C<guestfs_fsck>."
8483 #: ../src/guestfs-actions.pod:1326
8484 msgid "(Added in 1.0.29)"
8489 #: ../src/guestfs-actions.pod:1328
8490 msgid "guestfs_echo_daemon"
8495 #: ../src/guestfs-actions.pod:1330
8499 " guestfs_echo_daemon (guestfs_h *g,\n"
8500 " char *const *words);\n"
8506 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
8508 "This command concatenates the list of C<words> passed with single spaces "
8509 "between them and returns the resulting string."
8514 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
8515 msgid "You can use this command to test the connection through to the daemon."
8520 #: ../src/guestfs-actions.pod:1339
8521 msgid "See also C<guestfs_ping_daemon>."
8526 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
8527 #: ../src/guestfs-actions.pod:5764
8528 msgid "(Added in 1.0.69)"
8533 #: ../src/guestfs-actions.pod:1346
8534 msgid "guestfs_egrep"
8539 #: ../src/guestfs-actions.pod:1348
8543 " guestfs_egrep (guestfs_h *g,\n"
8544 " const char *regex,\n"
8545 " const char *path);\n"
8551 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
8553 "This calls the external C<egrep> program and returns the matching lines."
8558 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
8559 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
8560 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2201
8561 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2376
8562 #: ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2404
8563 #: ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:2472
8564 #: ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3418
8565 #: ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3445
8566 #: ../src/guestfs-actions.pod:3459 ../src/guestfs-actions.pod:4433
8567 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5358
8568 #: ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6140
8569 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6166
8570 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6201
8571 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6227
8572 #: ../src/guestfs-actions.pod:6998 ../src/guestfs-actions.pod:7017
8573 #: ../src/guestfs-actions.pod:7102 ../src/guestfs-actions.pod:7121
8574 #: ../src/guestfs-actions.pod:7167 ../src/guestfs-actions.pod:7186
8575 msgid "(Added in 1.0.66)"
8580 #: ../src/guestfs-actions.pod:1365
8581 msgid "guestfs_egrepi"
8586 #: ../src/guestfs-actions.pod:1367
8590 " guestfs_egrepi (guestfs_h *g,\n"
8591 " const char *regex,\n"
8592 " const char *path);\n"
8598 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
8600 "This calls the external C<egrep -i> program and returns the matching lines."
8605 #: ../src/guestfs-actions.pod:1384
8606 msgid "guestfs_equal"
8611 #: ../src/guestfs-actions.pod:1386
8615 " guestfs_equal (guestfs_h *g,\n"
8616 " const char *file1,\n"
8617 " const char *file2);\n"
8623 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
8625 "This compares the two files C<file1> and C<file2> and returns true if their "
8626 "content is exactly equal, or false otherwise."
8631 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
8632 msgid "The external L<cmp(1)> program is used for the comparison."
8637 #: ../src/guestfs-actions.pod:1400
8638 msgid "guestfs_exists"
8643 #: ../src/guestfs-actions.pod:1402
8647 " guestfs_exists (guestfs_h *g,\n"
8648 " const char *path);\n"
8654 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
8656 "This returns C<true> if and only if there is a file, directory (or anything) "
8657 "with the given C<path> name."
8662 #: ../src/guestfs-actions.pod:1409
8663 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8668 #: ../src/guestfs-actions.pod:1415
8669 msgid "guestfs_fallocate"
8674 #: ../src/guestfs-actions.pod:1417
8678 " guestfs_fallocate (guestfs_h *g,\n"
8679 " const char *path,\n"
8686 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
8687 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
8689 "This command preallocates a file (containing zero bytes) named C<path> of "
8690 "size C<len> bytes. If the file exists already, it is overwritten."
8695 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
8697 "Do not confuse this with the guestfish-specific C<alloc> command which "
8698 "allocates a file in the host and attaches it as a device."
8703 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:946
8705 "This function is deprecated. In new code, use the C<fallocate64> call "
8711 #: ../src/guestfs-actions.pod:1441
8712 msgid "guestfs_fallocate64"
8717 #: ../src/guestfs-actions.pod:1443
8721 " guestfs_fallocate64 (guestfs_h *g,\n"
8722 " const char *path,\n"
8729 #: ../src/guestfs-actions.pod:1452
8731 "Note that this call allocates disk blocks for the file. To create a sparse "
8732 "file use C<guestfs_truncate_size> instead."
8737 #: ../src/guestfs-actions.pod:1455
8739 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8740 "oversight it only allowed 30 bit lengths to be specified, effectively "
8741 "limiting the maximum size of files created through that call to 1GB."
8746 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
8748 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8749 "commands which create a file in the host and attach it as a device."
8754 #: ../src/guestfs-actions.pod:1466
8755 msgid "(Added in 1.3.17)"
8760 #: ../src/guestfs-actions.pod:1468
8761 msgid "guestfs_fgrep"
8766 #: ../src/guestfs-actions.pod:1470
8770 " guestfs_fgrep (guestfs_h *g,\n"
8771 " const char *pattern,\n"
8772 " const char *path);\n"
8778 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
8780 "This calls the external C<fgrep> program and returns the matching lines."
8785 #: ../src/guestfs-actions.pod:1487
8786 msgid "guestfs_fgrepi"
8791 #: ../src/guestfs-actions.pod:1489
8795 " guestfs_fgrepi (guestfs_h *g,\n"
8796 " const char *pattern,\n"
8797 " const char *path);\n"
8803 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
8805 "This calls the external C<fgrep -i> program and returns the matching lines."
8810 #: ../src/guestfs-actions.pod:1506
8811 msgid "guestfs_file"
8816 #: ../src/guestfs-actions.pod:1508
8820 " guestfs_file (guestfs_h *g,\n"
8821 " const char *path);\n"
8827 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
8829 "This call uses the standard L<file(1)> command to determine the type or "
8830 "contents of the file."
8835 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
8837 "This call will also transparently look inside various types of compressed "
8843 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
8845 "The exact command which runs is C<file -zb path>. Note in particular that "
8846 "the filename is not prepended to the output (the C<-b> option)."
8851 #: ../src/guestfs-actions.pod:1522
8853 "This command can also be used on C</dev/> devices (and partitions, LV "
8854 "names). You can for example use this to determine if a device contains a "
8855 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8860 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
8862 "If the C<path> does not begin with C</dev/> then this command only works for "
8863 "the content of regular files. For other file types (directory, symbolic "
8864 "link etc) it will just return the string C<directory> etc."
8869 #: ../src/guestfs-actions.pod:1537
8870 msgid "guestfs_file_architecture"
8875 #: ../src/guestfs-actions.pod:1539
8879 " guestfs_file_architecture (guestfs_h *g,\n"
8880 " const char *filename);\n"
8886 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
8888 "This detects the architecture of the binary C<filename>, and returns it if "
8894 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
8895 msgid "Currently defined architectures are:"
8900 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1028
8906 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
8908 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8909 "irrespective of the precise processor requirements of the binary."
8914 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1033
8920 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
8921 msgid "64 bit x86-64."
8926 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
8932 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
8933 msgid "32 bit SPARC."
8938 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
8944 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
8945 msgid "64 bit SPARC V9 and above."
8950 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
8956 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
8957 msgid "Intel Itanium."
8962 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
8968 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
8969 msgid "32 bit Power PC."
8974 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
8980 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
8981 msgid "64 bit Power PC."
8986 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1059
8987 msgid "Libguestfs may return other architecture strings in future."
8992 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
8993 msgid "The function works on at least the following types of files:"
8998 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1067
8999 msgid "many types of Un*x and Linux binary"
9004 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1071
9005 msgid "many types of Un*x and Linux shared library"
9010 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1075
9011 msgid "Windows Win32 and Win64 binaries"
9016 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1079
9017 msgid "Windows Win32 and Win64 DLLs"
9022 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
9023 msgid "Win32 binaries and DLLs return C<i386>."
9028 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
9029 msgid "Win64 binaries and DLLs return C<x86_64>."
9034 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1087
9035 msgid "Linux kernel modules"
9040 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1091
9041 msgid "Linux new-style initrd images"
9046 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1095
9047 msgid "some non-x86 Linux vmlinuz kernels"
9052 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1099
9053 msgid "What it can't do currently:"
9058 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1105
9059 msgid "static libraries (libfoo.a)"
9064 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1109
9065 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9070 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1113
9071 msgid "x86 Linux vmlinuz kernels"
9076 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
9078 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9079 "compressed code, and are horribly hard to unpack. If you want to find the "
9080 "architecture of a kernel, use the architecture of the associated initrd or "
9081 "kernel module(s) instead."
9086 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
9087 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2508
9088 #: ../src/guestfs-actions.pod:2589 ../src/guestfs-actions.pod:2615
9089 #: ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2685
9090 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2806
9091 #: ../src/guestfs-actions.pod:2868 ../src/guestfs-actions.pod:3041
9092 #: ../src/guestfs-actions.pod:3173
9093 msgid "(Added in 1.5.3)"
9098 #: ../src/guestfs-actions.pod:1649
9099 msgid "guestfs_filesize"
9104 #: ../src/guestfs-actions.pod:1651
9108 " guestfs_filesize (guestfs_h *g,\n"
9109 " const char *file);\n"
9115 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1126
9116 msgid "This command returns the size of C<file> in bytes."
9121 #: ../src/guestfs-actions.pod:1657
9123 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9124 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9125 "devices, use C<guestfs_blockdev_getsize64>."
9130 #: ../src/guestfs-actions.pod:1663
9131 msgid "(Added in 1.0.82)"
9136 #: ../src/guestfs-actions.pod:1665
9137 msgid "guestfs_fill"
9142 #: ../src/guestfs-actions.pod:1667
9146 " guestfs_fill (guestfs_h *g,\n"
9149 " const char *path);\n"
9155 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1136
9157 "This command creates a new file called C<path>. The initial content of the "
9158 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9164 #: ../src/guestfs-actions.pod:1677
9166 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9167 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9168 "bytes use C<guestfs_fill_pattern>."
9173 #: ../src/guestfs-actions.pod:1689
9174 msgid "(Added in 1.0.79)"
9179 #: ../src/guestfs-actions.pod:1691
9180 msgid "guestfs_fill_pattern"
9185 #: ../src/guestfs-actions.pod:1693
9189 " guestfs_fill_pattern (guestfs_h *g,\n"
9190 " const char *pattern,\n"
9192 " const char *path);\n"
9198 #: ../src/guestfs-actions.pod:1699
9200 "This function is like C<guestfs_fill> except that it creates a new file of "
9201 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9202 "pattern is truncated if necessary to ensure the length of the file is "
9203 "exactly C<len> bytes."
9208 #: ../src/guestfs-actions.pod:1711
9209 msgid "(Added in 1.3.12)"
9214 #: ../src/guestfs-actions.pod:1713
9215 msgid "guestfs_find"
9220 #: ../src/guestfs-actions.pod:1715
9224 " guestfs_find (guestfs_h *g,\n"
9225 " const char *directory);\n"
9231 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1158
9233 "This command lists out all files and directories, recursively, starting at "
9234 "C<directory>. It is essentially equivalent to running the shell command "
9235 "C<find directory -print> but some post-processing happens on the output, "
9241 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
9243 "This returns a list of strings I<without any prefix>. Thus if the directory "
9249 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1166
9260 #: ../src/guestfs-actions.pod:1731
9262 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9267 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1173
9279 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
9280 msgid "If C<directory> is not a directory, then this command returns an error."
9285 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1181
9286 msgid "The returned list is sorted."
9291 #: ../src/guestfs-actions.pod:1744
9292 msgid "See also C<guestfs_find0>."
9297 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3862
9298 #: ../src/guestfs-actions.pod:5393
9299 msgid "(Added in 1.0.27)"
9304 #: ../src/guestfs-actions.pod:1755
9305 msgid "guestfs_find0"
9310 #: ../src/guestfs-actions.pod:1757
9314 " guestfs_find0 (guestfs_h *g,\n"
9315 " const char *directory,\n"
9316 " const char *files);\n"
9322 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1192
9324 "This command lists out all files and directories, recursively, starting at "
9325 "C<directory>, placing the resulting list in the external file called "
9331 #: ../src/guestfs-actions.pod:1766
9333 "This command works the same way as C<guestfs_find> with the following "
9339 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1203
9340 msgid "The resulting list is written to an external file."
9345 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1207
9347 "Items (filenames) in the result are separated by C<\\0> characters. See "
9348 "L<find(1)> option I<-print0>."
9353 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1212
9354 msgid "This command is not limited in the number of names that it can return."
9359 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1217
9360 msgid "The result list is not sorted."
9365 #: ../src/guestfs-actions.pod:1793
9366 msgid "(Added in 1.0.74)"
9371 #: ../src/guestfs-actions.pod:1795
9372 msgid "guestfs_findfs_label"
9377 #: ../src/guestfs-actions.pod:1797
9381 " guestfs_findfs_label (guestfs_h *g,\n"
9382 " const char *label);\n"
9388 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1227
9390 "This command searches the filesystems and returns the one which has the "
9391 "given label. An error is returned if no such filesystem can be found."
9396 #: ../src/guestfs-actions.pod:1805
9397 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9402 #: ../src/guestfs-actions.pod:1812
9403 msgid "guestfs_findfs_uuid"
9408 #: ../src/guestfs-actions.pod:1814
9412 " guestfs_findfs_uuid (guestfs_h *g,\n"
9413 " const char *uuid);\n"
9419 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1237
9421 "This command searches the filesystems and returns the one which has the "
9422 "given UUID. An error is returned if no such filesystem can be found."
9427 #: ../src/guestfs-actions.pod:1822
9428 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9433 #: ../src/guestfs-actions.pod:1829
9434 msgid "guestfs_fsck"
9439 #: ../src/guestfs-actions.pod:1831
9443 " guestfs_fsck (guestfs_h *g,\n"
9444 " const char *fstype,\n"
9445 " const char *device);\n"
9451 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
9453 "This runs the filesystem checker (fsck) on C<device> which should have "
9454 "filesystem type C<fstype>."
9459 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1250
9461 "The returned integer is the status. See L<fsck(8)> for the list of status "
9462 "codes from C<fsck>."
9467 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1259
9468 msgid "Multiple status codes can be summed together."
9473 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1263
9475 "A non-zero return code can mean \"success\", for example if errors have been "
9476 "corrected on the filesystem."
9481 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1268
9482 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9487 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1273
9489 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9494 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:7040
9495 msgid "(Added in 1.0.16)"
9500 #: ../src/guestfs-actions.pod:1868
9501 msgid "guestfs_get_append"
9506 #: ../src/guestfs-actions.pod:1870
9510 " guestfs_get_append (guestfs_h *g);\n"
9516 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
9518 "Return the additional kernel options which are added to the guest kernel "
9524 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1282
9525 msgid "If C<NULL> then no options are added."
9530 #: ../src/guestfs-actions.pod:1878
9532 "This function returns a string which may be NULL. There is no way to return "
9533 "an error from this function. The string is owned by the guest handle and "
9534 "must I<not> be freed."
9539 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:5071
9540 #: ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5902
9541 #: ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5937
9542 #: ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:6711
9543 #: ../src/guestfs-actions.pod:6729 ../src/guestfs-actions.pod:7083
9544 msgid "(Added in 1.0.26)"
9549 #: ../src/guestfs-actions.pod:1884
9550 msgid "guestfs_get_autosync"
9555 #: ../src/guestfs-actions.pod:1886
9559 " guestfs_get_autosync (guestfs_h *g);\n"
9565 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
9566 msgid "Get the autosync flag."
9571 #: ../src/guestfs-actions.pod:1895
9572 msgid "guestfs_get_direct"
9577 #: ../src/guestfs-actions.pod:1897
9581 " guestfs_get_direct (guestfs_h *g);\n"
9587 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1294
9588 msgid "Return the direct appliance mode flag."
9593 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5575
9594 msgid "(Added in 1.0.72)"
9599 #: ../src/guestfs-actions.pod:1906
9600 msgid "guestfs_get_e2label"
9605 #: ../src/guestfs-actions.pod:1908
9609 " guestfs_get_e2label (guestfs_h *g,\n"
9610 " const char *device);\n"
9616 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1300
9618 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9623 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1303
9625 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9630 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
9631 #: ../src/guestfs-actions.pod:5593 ../src/guestfs-actions.pod:5612
9632 msgid "(Added in 1.0.15)"
9637 #: ../src/guestfs-actions.pod:1927
9638 msgid "guestfs_get_e2uuid"
9643 #: ../src/guestfs-actions.pod:1929
9647 " guestfs_get_e2uuid (guestfs_h *g,\n"
9648 " const char *device);\n"
9654 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1314
9656 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9661 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1317
9663 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9668 #: ../src/guestfs-actions.pod:1948
9669 msgid "guestfs_get_memsize"
9674 #: ../src/guestfs-actions.pod:1950
9678 " guestfs_get_memsize (guestfs_h *g);\n"
9684 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1328
9686 "This gets the memory size in megabytes allocated to the qemu subprocess."
9691 #: ../src/guestfs-actions.pod:1956
9693 "If C<guestfs_set_memsize> was not called on this handle, and if "
9694 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9695 "value for memsize."
9700 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
9701 #: ../src/guestfs-actions.pod:5628 ../src/guestfs-actions.pod:5735
9702 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1386
9703 #: ../fish/guestfish-actions.pod:3755 ../fish/guestfish-actions.pod:3842
9705 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9710 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4153
9711 #: ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4357
9712 #: ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4388
9713 #: ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4418
9714 #: ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5633
9715 #: ../src/guestfs-actions.pod:5876 ../src/guestfs-actions.pod:6477
9716 msgid "(Added in 1.0.55)"
9721 #: ../src/guestfs-actions.pod:1967
9722 msgid "guestfs_get_network"
9727 #: ../src/guestfs-actions.pod:1969
9731 " guestfs_get_network (guestfs_h *g);\n"
9737 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1342
9738 msgid "This returns the enable network flag."
9743 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5652
9744 msgid "(Added in 1.5.4)"
9749 #: ../src/guestfs-actions.pod:1978
9750 msgid "guestfs_get_path"
9755 #: ../src/guestfs-actions.pod:1980
9759 " guestfs_get_path (guestfs_h *g);\n"
9765 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1348
9766 msgid "Return the current search path."
9771 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
9773 "This is always non-NULL. If it wasn't set already, then this will return "
9779 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
9781 "This function returns a string, or NULL on error. The string is owned by "
9782 "the guest handle and must I<not> be freed."
9787 #: ../src/guestfs-actions.pod:1993
9788 msgid "guestfs_get_pid"
9793 #: ../src/guestfs-actions.pod:1995
9797 " guestfs_get_pid (guestfs_h *g);\n"
9803 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
9805 "Return the process ID of the qemu subprocess. If there is no qemu "
9806 "subprocess, then this will return an error."
9811 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1362
9812 msgid "This is an internal call used for debugging and testing."
9817 #: ../src/guestfs-actions.pod:2005
9818 msgid "(Added in 1.0.56)"
9823 #: ../src/guestfs-actions.pod:2007
9824 msgid "guestfs_get_qemu"
9829 #: ../src/guestfs-actions.pod:2009
9833 " guestfs_get_qemu (guestfs_h *g);\n"
9839 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1368
9840 msgid "Return the current qemu binary."
9845 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
9847 "This is always non-NULL. If it wasn't set already, then this will return "
9848 "the default qemu binary name."
9853 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5697
9854 msgid "(Added in 1.0.6)"
9859 #: ../src/guestfs-actions.pod:2022
9860 msgid "guestfs_get_recovery_proc"
9865 #: ../src/guestfs-actions.pod:2024
9869 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9875 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9876 msgid "Return the recovery process enabled flag."
9881 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3263
9882 #: ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3960
9883 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:5001
9884 #: ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5721
9885 #: ../src/guestfs-actions.pod:6380 ../src/guestfs-actions.pod:6400
9886 #: ../src/guestfs-actions.pod:6592
9887 msgid "(Added in 1.0.77)"
9892 #: ../src/guestfs-actions.pod:2033
9893 msgid "guestfs_get_selinux"
9898 #: ../src/guestfs-actions.pod:2035
9902 " guestfs_get_selinux (guestfs_h *g);\n"
9908 #: ../src/guestfs-actions.pod:2038
9910 "This returns the current setting of the selinux flag which is passed to the "
9911 "appliance at boot time. See C<guestfs_set_selinux>."
9916 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
9917 #: ../src/guestfs-actions.pod:5740 ../src/guestfs-actions.pod:5794
9918 msgid "(Added in 1.0.67)"
9923 #: ../src/guestfs-actions.pod:2048
9924 msgid "guestfs_get_state"
9929 #: ../src/guestfs-actions.pod:2050
9933 " guestfs_get_state (guestfs_h *g);\n"
9939 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1393
9941 "This returns the current state as an opaque integer. This is only useful "
9942 "for printing debug and internal error messages."
9947 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3066
9948 #: ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3156
9949 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:1396
9950 #: ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2153
9951 #: ../fish/guestfish-actions.pod:2191 ../fish/guestfish-actions.pod:2207
9952 msgid "For more information on states, see L<guestfs(3)>."
9957 #: ../src/guestfs-actions.pod:2062
9958 msgid "guestfs_get_trace"
9963 #: ../src/guestfs-actions.pod:2064
9967 " guestfs_get_trace (guestfs_h *g);\n"
9973 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1402
9974 msgid "Return the command trace flag."
9979 #: ../src/guestfs-actions.pod:2073
9980 msgid "guestfs_get_umask"
9985 #: ../src/guestfs-actions.pod:2075
9989 " guestfs_get_umask (guestfs_h *g);\n"
9995 #: ../src/guestfs-actions.pod:2078
9997 "Return the current umask. By default the umask is C<022> unless it has been "
9998 "set by calling C<guestfs_umask>."
10003 #: ../src/guestfs-actions.pod:2085
10004 msgid "guestfs_get_verbose"
10009 #: ../src/guestfs-actions.pod:2087
10013 " guestfs_get_verbose (guestfs_h *g);\n"
10019 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
10020 msgid "This returns the verbose messages flag."
10025 #: ../src/guestfs-actions.pod:2096
10026 msgid "guestfs_getcon"
10031 #: ../src/guestfs-actions.pod:2098
10035 " guestfs_getcon (guestfs_h *g);\n"
10041 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1421
10042 msgid "This gets the SELinux security context of the daemon."
10047 #: ../src/guestfs-actions.pod:2103
10049 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10054 #: ../src/guestfs-actions.pod:2111
10055 msgid "guestfs_getxattr"
10060 #: ../src/guestfs-actions.pod:2113
10064 " guestfs_getxattr (guestfs_h *g,\n"
10065 " const char *path,\n"
10066 " const char *name,\n"
10067 " size_t *size_r);\n"
10073 #: ../src/guestfs-actions.pod:2119
10075 "Get a single extended attribute from file C<path> named C<name>. This call "
10076 "follows symlinks. If you want to lookup an extended attribute for the "
10077 "symlink itself, use C<guestfs_lgetxattr>."
10082 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:3277
10084 "Normally it is better to get all extended attributes from a file in one go "
10085 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10086 "implementations are buggy and do not provide a way to list out attributes. "
10087 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10088 "extended attributes you want in advance and call this function."
10093 #: ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:3284
10094 #: ../fish/guestfish-actions.pod:1441 ../fish/guestfish-actions.pod:2272
10096 "Extended attribute values are blobs of binary data. If there is no extended "
10097 "attribute named C<name>, this returns an error."
10102 #: ../src/guestfs-actions.pod:2133
10103 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10108 #: ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:2326
10109 #: ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:4994
10110 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5201
10112 "This function returns a buffer, or NULL on error. The size of the returned "
10113 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10118 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:3293
10119 msgid "(Added in 1.7.24)"
10124 #: ../src/guestfs-actions.pod:2141
10125 msgid "guestfs_getxattrs"
10130 #: ../src/guestfs-actions.pod:2143
10133 " struct guestfs_xattr_list *\n"
10134 " guestfs_getxattrs (guestfs_h *g,\n"
10135 " const char *path);\n"
10141 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
10143 "This call lists the extended attributes of the file or directory C<path>."
10148 #: ../src/guestfs-actions.pod:2150 ../fish/guestfish-actions.pod:1453
10150 "At the system call level, this is a combination of the L<listxattr(2)> and "
10151 "L<getxattr(2)> calls."
10156 #: ../src/guestfs-actions.pod:2153
10157 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10162 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3305
10163 #: ../src/guestfs-actions.pod:3956
10165 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10166 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10171 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3309
10172 #: ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3510
10173 #: ../src/guestfs-actions.pod:5374 ../src/guestfs-actions.pod:5813
10174 #: ../src/guestfs-actions.pod:7148
10175 msgid "(Added in 1.0.59)"
10180 #: ../src/guestfs-actions.pod:2161
10181 msgid "guestfs_glob_expand"
10186 #: ../src/guestfs-actions.pod:2163
10190 " guestfs_glob_expand (guestfs_h *g,\n"
10191 " const char *pattern);\n"
10197 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1462
10199 "This command searches for all the pathnames matching C<pattern> according to "
10200 "the wildcard expansion rules used by the shell."
10205 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
10207 "If no paths match, then this returns an empty list (note: not an error)."
10212 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1469
10214 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10215 "GLOB_BRACE>. See that manual page for more details."
10220 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:5978
10221 #: ../src/guestfs-actions.pod:5995
10222 msgid "(Added in 1.0.50)"
10227 #: ../src/guestfs-actions.pod:2184
10228 msgid "guestfs_grep"
10233 #: ../src/guestfs-actions.pod:2186
10237 " guestfs_grep (guestfs_h *g,\n"
10238 " const char *regex,\n"
10239 " const char *path);\n"
10245 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1477
10246 msgid "This calls the external C<grep> program and returns the matching lines."
10251 #: ../src/guestfs-actions.pod:2203
10252 msgid "guestfs_grepi"
10257 #: ../src/guestfs-actions.pod:2205
10261 " guestfs_grepi (guestfs_h *g,\n"
10262 " const char *regex,\n"
10263 " const char *path);\n"
10269 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1487
10271 "This calls the external C<grep -i> program and returns the matching lines."
10276 #: ../src/guestfs-actions.pod:2222
10277 msgid "guestfs_grub_install"
10282 #: ../src/guestfs-actions.pod:2224
10286 " guestfs_grub_install (guestfs_h *g,\n"
10287 " const char *root,\n"
10288 " const char *device);\n"
10294 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
10296 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10297 "the root directory being C<root>."
10302 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1500
10304 "Note: If grub-install reports the error \"No suitable drive was found in the "
10305 "generated device map.\" it may be that you need to create a C</boot/grub/"
10306 "device.map> file first that contains the mapping between grub device names "
10307 "and Linux device names. It is usually sufficient to create a file "
10313 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1507
10316 " (hd0) /dev/vda\n"
10322 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
10323 msgid "replacing C</dev/vda> with the name of the installation device."
10328 #: ../src/guestfs-actions.pod:2245
10329 msgid "(Added in 1.0.17)"
10334 #: ../src/guestfs-actions.pod:2247
10335 msgid "guestfs_head"
10340 #: ../src/guestfs-actions.pod:2249
10344 " guestfs_head (guestfs_h *g,\n"
10345 " const char *path);\n"
10351 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1515
10353 "This command returns up to the first 10 lines of a file as a list of strings."
10358 #: ../src/guestfs-actions.pod:2265
10359 msgid "guestfs_head_n"
10364 #: ../src/guestfs-actions.pod:2267
10368 " guestfs_head_n (guestfs_h *g,\n"
10370 " const char *path);\n"
10376 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
10378 "If the parameter C<nrlines> is a positive number, this returns the first "
10379 "C<nrlines> lines of the file C<path>."
10384 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1528
10386 "If the parameter C<nrlines> is a negative number, this returns lines from "
10387 "the file C<path>, excluding the last C<nrlines> lines."
10392 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6275
10393 #: ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:4188
10394 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10399 #: ../src/guestfs-actions.pod:2289
10400 msgid "guestfs_hexdump"
10405 #: ../src/guestfs-actions.pod:2291
10409 " guestfs_hexdump (guestfs_h *g,\n"
10410 " const char *path);\n"
10416 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1540
10418 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10419 "readable, canonical hex dump of the file."
10424 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6059
10425 #: ../src/guestfs-actions.pod:6114
10426 msgid "(Added in 1.0.22)"
10431 #: ../src/guestfs-actions.pod:2306
10432 msgid "guestfs_initrd_cat"
10437 #: ../src/guestfs-actions.pod:2308
10441 " guestfs_initrd_cat (guestfs_h *g,\n"
10442 " const char *initrdpath,\n"
10443 " const char *filename,\n"
10444 " size_t *size_r);\n"
10450 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1550
10452 "This command unpacks the file C<filename> from the initrd file called "
10453 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10459 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1554
10461 "For example, in guestfish you could use the following command to examine the "
10462 "boot script (usually called C</init>) contained in a Linux initrd or "
10468 #: ../src/guestfs-actions.pod:2322 ../fish/guestfish-actions.pod:1558
10471 " initrd-cat /boot/initrd-<version>.img init\n"
10477 #: ../src/guestfs-actions.pod:2324
10478 msgid "See also C<guestfs_initrd_list>."
10483 #: ../src/guestfs-actions.pod:2335
10484 msgid "guestfs_initrd_list"
10489 #: ../src/guestfs-actions.pod:2337
10493 " guestfs_initrd_list (guestfs_h *g,\n"
10494 " const char *path);\n"
10500 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1569
10501 msgid "This command lists out files contained in an initrd."
10506 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
10508 "The files are listed without any initial C</> character. The files are "
10509 "listed in the order they appear (not necessarily alphabetical). Directory "
10510 "names are listed as separate items."
10515 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1575
10517 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10518 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10524 #: ../src/guestfs-actions.pod:2357
10525 msgid "guestfs_inotify_add_watch"
10530 #: ../src/guestfs-actions.pod:2359
10534 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10535 " const char *path,\n"
10542 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1583
10543 msgid "Watch C<path> for the events listed in C<mask>."
10548 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
10550 "Note that if C<path> is a directory then events within that directory are "
10551 "watched, but this does I<not> happen recursively (in subdirectories)."
10556 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1589
10558 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10559 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10564 #: ../src/guestfs-actions.pod:2378
10565 msgid "guestfs_inotify_close"
10570 #: ../src/guestfs-actions.pod:2380
10574 " guestfs_inotify_close (guestfs_h *g);\n"
10580 #: ../src/guestfs-actions.pod:2383 ../fish/guestfish-actions.pod:1597
10582 "This closes the inotify handle which was previously opened by inotify_init. "
10583 "It removes all watches, throws away any pending events, and deallocates all "
10589 #: ../src/guestfs-actions.pod:2391
10590 msgid "guestfs_inotify_files"
10595 #: ../src/guestfs-actions.pod:2393
10599 " guestfs_inotify_files (guestfs_h *g);\n"
10605 #: ../src/guestfs-actions.pod:2396
10607 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10608 "returns a list of pathnames of objects that were touched. The returned "
10609 "pathnames are sorted and deduplicated."
10614 #: ../src/guestfs-actions.pod:2406
10615 msgid "guestfs_inotify_init"
10620 #: ../src/guestfs-actions.pod:2408
10624 " guestfs_inotify_init (guestfs_h *g,\n"
10625 " int maxevents);\n"
10631 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1613
10633 "This command creates a new inotify handle. The inotify subsystem can be "
10634 "used to notify events which happen to objects in the guest filesystem."
10639 #: ../src/guestfs-actions.pod:2416
10641 "C<maxevents> is the maximum number of events which will be queued up between "
10642 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10643 "passed as C<0>, then the kernel (or previously set) default is used. For "
10644 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10645 "throws away events, but records the fact that it threw them away by setting "
10646 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10647 "C<guestfs_inotify_read>)."
10652 #: ../src/guestfs-actions.pod:2426
10654 "Before any events are generated, you have to add some watches to the "
10655 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10656 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10661 #: ../src/guestfs-actions.pod:2432
10663 "Queued up events should be read periodically by calling "
10664 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10665 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10666 "often enough then you risk the internal queue overflowing."
10671 #: ../src/guestfs-actions.pod:2439
10673 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10674 "This also removes any watches automatically."
10679 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1644
10681 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10682 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10683 "that there is one global inotify handle per libguestfs instance."
10688 #: ../src/guestfs-actions.pod:2452
10689 msgid "guestfs_inotify_read"
10694 #: ../src/guestfs-actions.pod:2454
10697 " struct guestfs_inotify_event_list *\n"
10698 " guestfs_inotify_read (guestfs_h *g);\n"
10704 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
10706 "Return the complete queue of events that have happened since the previous "
10712 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1656
10713 msgid "If no events have happened, this returns an empty list."
10718 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
10720 "I<Note>: In order to make sure that all events have been read, you must call "
10721 "this function repeatedly until it returns an empty list. The reason is that "
10722 "the call will read events up to the maximum appliance-to-host message size "
10723 "and leave remaining events in the queue."
10728 #: ../src/guestfs-actions.pod:2468
10730 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10731 "there was an error. I<The caller must call "
10732 "C<guestfs_free_inotify_event_list> after use>."
10737 #: ../src/guestfs-actions.pod:2474
10738 msgid "guestfs_inotify_rm_watch"
10743 #: ../src/guestfs-actions.pod:2476
10747 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10754 #: ../src/guestfs-actions.pod:2480
10756 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10761 #: ../src/guestfs-actions.pod:2487
10762 msgid "guestfs_inspect_get_arch"
10767 #: ../src/guestfs-actions.pod:2489
10771 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10772 " const char *root);\n"
10778 #: ../src/guestfs-actions.pod:2493 ../src/guestfs-actions.pod:2516
10779 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2623
10780 #: ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2672
10781 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2730
10782 #: ../src/guestfs-actions.pod:2759 ../src/guestfs-actions.pod:2790
10783 #: ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2876
10784 #: ../src/guestfs-actions.pod:2899
10786 "This function should only be called with a root device string as returned by "
10787 "C<guestfs_inspect_os>."
10792 #: ../src/guestfs-actions.pod:2496
10794 "This returns the architecture of the inspected operating system. The "
10795 "possible return values are listed under C<guestfs_file_architecture>."
10800 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1682
10802 "If the architecture could not be determined, then the string C<unknown> is "
10808 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2584
10809 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2660
10810 #: ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2777
10811 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:2820
10812 #: ../src/guestfs-actions.pod:2863 ../src/guestfs-actions.pod:2886
10813 #: ../src/guestfs-actions.pod:2992 ../src/guestfs-actions.pod:3033
10814 #: ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1759
10815 #: ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1813
10816 #: ../fish/guestfish-actions.pod:1877 ../fish/guestfish-actions.pod:1901
10817 #: ../fish/guestfish-actions.pod:1918 ../fish/guestfish-actions.pod:1931
10818 #: ../fish/guestfish-actions.pod:1966 ../fish/guestfish-actions.pod:1982
10819 #: ../fish/guestfish-actions.pod:2081 ../fish/guestfish-actions.pod:2115
10820 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10825 #: ../src/guestfs-actions.pod:2510
10826 msgid "guestfs_inspect_get_distro"
10831 #: ../src/guestfs-actions.pod:2512
10835 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10836 " const char *root);\n"
10842 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
10844 "This returns the distro (distribution) of the inspected operating system."
10849 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1697
10850 msgid "Currently defined distros are:"
10855 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1701
10856 msgid "\"archlinux\""
10861 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
10862 msgid "Arch Linux."
10867 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
10873 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
10879 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
10885 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
10891 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
10897 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
10903 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
10904 msgid "\"linuxmint\""
10909 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
10910 msgid "Linux Mint."
10915 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
10916 msgid "\"mandriva\""
10921 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
10927 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
10933 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
10939 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
10945 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
10951 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
10952 msgid "\"redhat-based\""
10957 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
10958 msgid "Some Red Hat-derived distro."
10963 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
10969 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
10970 msgid "Red Hat Enterprise Linux and some derivatives."
10975 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
10981 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
10987 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2854
10988 #: ../fish/guestfish-actions.pod:1745 ../fish/guestfish-actions.pod:1957
10989 msgid "\"unknown\""
10994 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1747
10995 msgid "The distro could not be determined."
11000 #: ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:2846
11001 #: ../fish/guestfish-actions.pod:1749 ../fish/guestfish-actions.pod:1949
11002 msgid "\"windows\""
11007 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1751
11009 "Windows does not have distributions. This string is returned if the OS type "
11015 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2860
11016 #: ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1963
11018 "Future versions of libguestfs may return other strings here. The caller "
11019 "should be prepared to handle any string."
11024 #: ../src/guestfs-actions.pod:2591
11025 msgid "guestfs_inspect_get_filesystems"
11030 #: ../src/guestfs-actions.pod:2593
11034 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11035 " const char *root);\n"
11041 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1768
11043 "This returns a list of all the filesystems that we think are associated with "
11044 "this operating system. This includes the root filesystem, other ordinary "
11045 "filesystems, and non-mounted devices like swap partitions."
11050 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1773
11052 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11053 "to be shared between operating systems."
11058 #: ../src/guestfs-actions.pod:2608
11060 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11061 "C<guestfs_inspect_get_mountpoints>."
11066 #: ../src/guestfs-actions.pod:2617
11067 msgid "guestfs_inspect_get_hostname"
11072 #: ../src/guestfs-actions.pod:2619
11076 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11077 " const char *root);\n"
11083 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
11085 "This function returns the hostname of the operating system as found by "
11086 "inspection of the guest's configuration files."
11091 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1789
11093 "If the hostname could not be determined, then the string C<unknown> is "
11099 #: ../src/guestfs-actions.pod:2637
11100 msgid "(Added in 1.7.9)"
11105 #: ../src/guestfs-actions.pod:2639
11106 msgid "guestfs_inspect_get_major_version"
11111 #: ../src/guestfs-actions.pod:2641
11115 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11116 " const char *root);\n"
11122 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
11124 "This returns the major version number of the inspected operating system."
11129 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1804
11131 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11132 "popular public names used by the operating system. Notably the operating "
11133 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11134 "1). You can find out the real versions corresponding to releases of Windows "
11135 "by consulting Wikipedia or MSDN."
11140 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2678
11141 #: ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1825
11142 msgid "If the version could not be determined, then C<0> is returned."
11147 #: ../src/guestfs-actions.pod:2666
11148 msgid "guestfs_inspect_get_minor_version"
11153 #: ../src/guestfs-actions.pod:2668
11157 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11158 " const char *root);\n"
11164 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1822
11166 "This returns the minor version number of the inspected operating system."
11171 #: ../src/guestfs-actions.pod:2680
11173 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11174 "C<guestfs_inspect_get_major_version>."
11179 #: ../src/guestfs-actions.pod:2687
11180 msgid "guestfs_inspect_get_mountpoints"
11185 #: ../src/guestfs-actions.pod:2689
11189 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11190 " const char *root);\n"
11195 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
11197 "This returns a hash of where we think the filesystems associated with this "
11198 "operating system should be mounted. Callers should note that this is at "
11199 "best an educated guess made by reading configuration files such as C</etc/"
11200 "fstab>. I<In particular note> that this may return filesystems which are "
11201 "non-existent or not mountable and callers should be prepared to handle or "
11202 "ignore failures if they try to mount them."
11207 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1846
11209 "Each element in the returned hashtable has a key which is the path of the "
11210 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11211 "mounted there (eg. C</dev/sda1>)."
11216 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1851
11218 "Non-mounted devices such as swap devices are I<not> returned in this list."
11223 #: ../src/guestfs-actions.pod:2713
11225 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11226 "C<guestfs_inspect_get_filesystems>."
11231 #: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:3362
11232 #: ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:6416
11234 "This function returns a NULL-terminated array of strings, or NULL if there "
11235 "was an error. The array of strings will always have length C<2n+1>, where "
11236 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11237 "caller must free the strings and the array after use>."
11242 #: ../src/guestfs-actions.pod:2724
11243 msgid "guestfs_inspect_get_package_format"
11248 #: ../src/guestfs-actions.pod:2726
11252 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11253 " const char *root);\n"
11259 #: ../src/guestfs-actions.pod:2733
11261 "This function and C<guestfs_inspect_get_package_management> return the "
11262 "package format and package management tool used by the inspected operating "
11263 "system. For example for Fedora these functions would return C<rpm> (package "
11264 "format) and C<yum> (package management)."
11269 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1870
11271 "This returns the string C<unknown> if we could not determine the package "
11272 "format I<or> if the operating system does not have a real packaging system "
11278 #: ../src/guestfs-actions.pod:2743 ../fish/guestfish-actions.pod:1874
11280 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11281 "Future versions of libguestfs may return other strings."
11286 #: ../src/guestfs-actions.pod:2751 ../src/guestfs-actions.pod:2782
11287 msgid "(Added in 1.7.5)"
11292 #: ../src/guestfs-actions.pod:2753
11293 msgid "guestfs_inspect_get_package_management"
11298 #: ../src/guestfs-actions.pod:2755
11302 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11303 " const char *root);\n"
11309 #: ../src/guestfs-actions.pod:2762
11311 "C<guestfs_inspect_get_package_format> and this function return the package "
11312 "format and package management tool used by the inspected operating system. "
11313 "For example for Fedora these functions would return C<rpm> (package format) "
11314 "and C<yum> (package management)."
11319 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1892
11321 "This returns the string C<unknown> if we could not determine the package "
11322 "management tool I<or> if the operating system does not have a real packaging "
11323 "system (eg. Windows)."
11328 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1896
11330 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11331 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11332 "libguestfs may return other strings."
11337 #: ../src/guestfs-actions.pod:2784
11338 msgid "guestfs_inspect_get_product_name"
11343 #: ../src/guestfs-actions.pod:2786
11347 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11348 " const char *root);\n"
11354 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1910
11356 "This returns the product name of the inspected operating system. The "
11357 "product name is generally some freeform string which can be displayed to the "
11358 "user, but should not be parsed by programs."
11363 #: ../src/guestfs-actions.pod:2798 ../fish/guestfish-actions.pod:1915
11365 "If the product name could not be determined, then the string C<unknown> is "
11371 #: ../src/guestfs-actions.pod:2808
11372 msgid "guestfs_inspect_get_roots"
11377 #: ../src/guestfs-actions.pod:2810
11381 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11387 #: ../src/guestfs-actions.pod:2813
11389 "This function is a convenient way to get the list of root devices, as "
11390 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11391 "the whole inspection process."
11396 #: ../src/guestfs-actions.pod:2817
11398 "This returns an empty list if either no root devices were found or the "
11399 "caller has not called C<guestfs_inspect_os>."
11404 #: ../src/guestfs-actions.pod:2826
11405 msgid "(Added in 1.7.3)"
11410 #: ../src/guestfs-actions.pod:2828
11411 msgid "guestfs_inspect_get_type"
11416 #: ../src/guestfs-actions.pod:2830
11420 " guestfs_inspect_get_type (guestfs_h *g,\n"
11421 " const char *root);\n"
11427 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1940
11429 "This returns the type of the inspected operating system. Currently defined "
11435 #: ../src/guestfs-actions.pod:2842 ../fish/guestfish-actions.pod:1945
11441 #: ../src/guestfs-actions.pod:2844 ../fish/guestfish-actions.pod:1947
11442 msgid "Any Linux-based operating system."
11447 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1951
11448 msgid "Any Microsoft Windows operating system."
11453 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1953
11454 msgid "\"freebsd\""
11459 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1955
11465 #: ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1959
11466 msgid "The operating system type could not be determined."
11471 #: ../src/guestfs-actions.pod:2870
11472 msgid "guestfs_inspect_get_windows_systemroot"
11477 #: ../src/guestfs-actions.pod:2872
11481 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11482 " const char *root);\n"
11488 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1975
11490 "This returns the Windows systemroot of the inspected guest. The systemroot "
11491 "is a directory path such as C</WINDOWS>."
11496 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1978
11498 "This call assumes that the guest is Windows and that the systemroot could be "
11499 "determined by inspection. If this is not the case then an error is returned."
11504 #: ../src/guestfs-actions.pod:2891
11505 msgid "(Added in 1.5.25)"
11510 #: ../src/guestfs-actions.pod:2893
11511 msgid "guestfs_inspect_list_applications"
11516 #: ../src/guestfs-actions.pod:2895
11519 " struct guestfs_application_list *\n"
11520 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11521 " const char *root);\n"
11527 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1991
11528 msgid "Return the list of applications installed in the operating system."
11533 #: ../src/guestfs-actions.pod:2904
11535 "I<Note:> This call works differently from other parts of the inspection "
11536 "API. You have to call C<guestfs_inspect_os>, then "
11537 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11538 "this. Listing applications is a significantly more difficult operation "
11539 "which requires access to the full filesystem. Also note that unlike the "
11540 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11541 "the libguestfs handle, this call actually reads parts of the mounted "
11542 "filesystems during the call."
11547 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2003
11549 "This returns an empty list if the inspection code was not able to determine "
11550 "the list of applications."
11555 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2006
11556 msgid "The application structure contains the following fields:"
11561 #: ../src/guestfs-actions.pod:2921 ../fish/guestfish-actions.pod:2010
11562 msgid "C<app_name>"
11567 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
11569 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11570 "guests, this is the package name."
11575 #: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2015
11576 msgid "C<app_display_name>"
11581 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
11583 "The display name of the application, sometimes localized to the install "
11584 "language of the guest operating system."
11589 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2020
11591 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11592 "to display something can use C<app_name> instead."
11597 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2023
11598 msgid "C<app_epoch>"
11603 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
11605 "For package managers which use epochs, this contains the epoch of the "
11606 "package (an integer). If unavailable, this is returned as C<0>."
11611 #: ../src/guestfs-actions.pod:2939 ../fish/guestfish-actions.pod:2028
11612 msgid "C<app_version>"
11617 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
11619 "The version string of the application or package. If unavailable this is "
11620 "returned as an empty string C<\"\">."
11625 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2033
11626 msgid "C<app_release>"
11631 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2035
11633 "The release string of the application or package, for package managers that "
11634 "use this. If unavailable this is returned as an empty string C<\"\">."
11639 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2039
11640 msgid "C<app_install_path>"
11645 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2041
11647 "The installation path of the application (on operating systems such as "
11648 "Windows which use installation paths). This path is in the format used by "
11649 "the guest operating system, it is not a libguestfs path."
11654 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2046
11655 msgid "If unavailable this is returned as an empty string C<\"\">."
11660 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2048
11661 msgid "C<app_trans_path>"
11666 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
11668 "The install path translated into a libguestfs path. If unavailable this is "
11669 "returned as an empty string C<\"\">."
11674 #: ../src/guestfs-actions.pod:2964 ../fish/guestfish-actions.pod:2053
11675 msgid "C<app_publisher>"
11680 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2055
11682 "The name of the publisher of the application, for package managers that use "
11683 "this. If unavailable this is returned as an empty string C<\"\">."
11688 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2059
11694 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
11696 "The URL (eg. upstream URL) of the application. If unavailable this is "
11697 "returned as an empty string C<\"\">."
11702 #: ../src/guestfs-actions.pod:2975 ../fish/guestfish-actions.pod:2064
11703 msgid "C<app_source_package>"
11708 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
11710 "For packaging systems which support this, the name of the source package. "
11711 "If unavailable this is returned as an empty string C<\"\">."
11716 #: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2069
11717 msgid "C<app_summary>"
11722 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
11724 "A short (usually one line) description of the application or package. If "
11725 "unavailable this is returned as an empty string C<\"\">."
11730 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2074
11731 msgid "C<app_description>"
11736 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2076
11738 "A longer description of the application or package. If unavailable this is "
11739 "returned as an empty string C<\"\">."
11744 #: ../src/guestfs-actions.pod:2994
11746 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11747 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11753 #: ../src/guestfs-actions.pod:2998
11754 msgid "(Added in 1.7.8)"
11759 #: ../src/guestfs-actions.pod:3000
11760 msgid "guestfs_inspect_os"
11765 #: ../src/guestfs-actions.pod:3002
11769 " guestfs_inspect_os (guestfs_h *g);\n"
11775 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2087
11777 "This function uses other libguestfs functions and certain heuristics to "
11778 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11779 "for operating systems."
11784 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2091
11785 msgid "The list returned is empty if no operating systems were found."
11790 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2093
11792 "If one operating system was found, then this returns a list with a single "
11793 "element, which is the name of the root filesystem of this operating system. "
11794 "It is also possible for this function to return a list containing more than "
11795 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11796 "element being the root filesystem of one of the operating systems."
11801 #: ../src/guestfs-actions.pod:3018
11803 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11804 "functions in order to query further information about each operating system, "
11805 "such as the name and version."
11810 #: ../src/guestfs-actions.pod:3023
11812 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11813 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11814 "the contents. This should be called with no disks currently mounted. The "
11815 "function may also use Augeas, so any existing Augeas handle will be closed."
11820 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2111
11822 "This function cannot decrypt encrypted disks. The caller must do that first "
11823 "(supplying the necessary keys) if the disk is encrypted."
11828 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3320
11829 #: ../src/guestfs-actions.pod:3382
11830 msgid "See also C<guestfs_list_filesystems>."
11835 #: ../src/guestfs-actions.pod:3043
11836 msgid "guestfs_is_blockdev"
11841 #: ../src/guestfs-actions.pod:3045
11845 " guestfs_is_blockdev (guestfs_h *g,\n"
11846 " const char *path);\n"
11852 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2123
11854 "This returns C<true> if and only if there is a block device with the given "
11860 #: ../src/guestfs-actions.pod:3052 ../src/guestfs-actions.pod:3081
11861 #: ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3126
11862 #: ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3198
11863 #: ../src/guestfs-actions.pod:3213
11864 msgid "See also C<guestfs_stat>."
11869 #: ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3085
11870 #: ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3202
11871 #: ../src/guestfs-actions.pod:3217
11872 msgid "(Added in 1.5.10)"
11877 #: ../src/guestfs-actions.pod:3058
11878 msgid "guestfs_is_busy"
11883 #: ../src/guestfs-actions.pod:3060
11887 " guestfs_is_busy (guestfs_h *g);\n"
11893 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2132
11895 "This returns true iff this handle is busy processing a command (in the "
11901 #: ../src/guestfs-actions.pod:3072
11902 msgid "guestfs_is_chardev"
11907 #: ../src/guestfs-actions.pod:3074
11911 " guestfs_is_chardev (guestfs_h *g,\n"
11912 " const char *path);\n"
11918 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2141
11920 "This returns C<true> if and only if there is a character device with the "
11921 "given C<path> name."
11926 #: ../src/guestfs-actions.pod:3087
11927 msgid "guestfs_is_config"
11932 #: ../src/guestfs-actions.pod:3089
11936 " guestfs_is_config (guestfs_h *g);\n"
11942 #: ../src/guestfs-actions.pod:3092 ../fish/guestfish-actions.pod:2150
11944 "This returns true iff this handle is being configured (in the C<CONFIG> "
11950 #: ../src/guestfs-actions.pod:3101
11951 msgid "guestfs_is_dir"
11956 #: ../src/guestfs-actions.pod:3103
11960 " guestfs_is_dir (guestfs_h *g,\n"
11961 " const char *path);\n"
11967 #: ../src/guestfs-actions.pod:3107 ../fish/guestfish-actions.pod:2159
11969 "This returns C<true> if and only if there is a directory with the given "
11970 "C<path> name. Note that it returns false for other objects like files."
11975 #: ../src/guestfs-actions.pod:3117
11976 msgid "guestfs_is_fifo"
11981 #: ../src/guestfs-actions.pod:3119
11985 " guestfs_is_fifo (guestfs_h *g,\n"
11986 " const char *path);\n"
11992 #: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2169
11994 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11995 "given C<path> name."
12000 #: ../src/guestfs-actions.pod:3132
12001 msgid "guestfs_is_file"
12006 #: ../src/guestfs-actions.pod:3134
12010 " guestfs_is_file (guestfs_h *g,\n"
12011 " const char *path);\n"
12017 #: ../src/guestfs-actions.pod:3138 ../fish/guestfish-actions.pod:2178
12019 "This returns C<true> if and only if there is a regular file with the given "
12020 "C<path> name. Note that it returns false for other objects like directories."
12025 #: ../src/guestfs-actions.pod:3148
12026 msgid "guestfs_is_launching"
12031 #: ../src/guestfs-actions.pod:3150
12035 " guestfs_is_launching (guestfs_h *g);\n"
12041 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2188
12043 "This returns true iff this handle is launching the subprocess (in the "
12044 "C<LAUNCHING> state)."
12049 #: ../src/guestfs-actions.pod:3162
12050 msgid "guestfs_is_lv"
12055 #: ../src/guestfs-actions.pod:3164
12059 " guestfs_is_lv (guestfs_h *g,\n"
12060 " const char *device);\n"
12066 #: ../src/guestfs-actions.pod:3168 ../fish/guestfish-actions.pod:2197
12068 "This command tests whether C<device> is a logical volume, and returns true "
12069 "iff this is the case."
12074 #: ../src/guestfs-actions.pod:3175
12075 msgid "guestfs_is_ready"
12080 #: ../src/guestfs-actions.pod:3177
12084 " guestfs_is_ready (guestfs_h *g);\n"
12090 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2204
12092 "This returns true iff this handle is ready to accept commands (in the "
12098 #: ../src/guestfs-actions.pod:3189
12099 msgid "guestfs_is_socket"
12104 #: ../src/guestfs-actions.pod:3191
12108 " guestfs_is_socket (guestfs_h *g,\n"
12109 " const char *path);\n"
12115 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2213
12117 "This returns C<true> if and only if there is a Unix domain socket with the "
12118 "given C<path> name."
12123 #: ../src/guestfs-actions.pod:3204
12124 msgid "guestfs_is_symlink"
12129 #: ../src/guestfs-actions.pod:3206
12133 " guestfs_is_symlink (guestfs_h *g,\n"
12134 " const char *path);\n"
12140 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2222
12142 "This returns C<true> if and only if there is a symbolic link with the given "
12148 #: ../src/guestfs-actions.pod:3219
12149 msgid "guestfs_kill_subprocess"
12154 #: ../src/guestfs-actions.pod:3221
12158 " guestfs_kill_subprocess (guestfs_h *g);\n"
12164 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2231
12165 msgid "This kills the qemu subprocess. You should never need to call this."
12170 #: ../src/guestfs-actions.pod:3230
12171 msgid "guestfs_launch"
12176 #: ../src/guestfs-actions.pod:3232
12180 " guestfs_launch (guestfs_h *g);\n"
12186 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2239
12188 "Internally libguestfs is implemented by running a virtual machine using "
12194 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2242
12196 "You should call this after configuring the handle (eg. adding drives) but "
12197 "before performing any actions."
12202 #: ../src/guestfs-actions.pod:3245
12203 msgid "guestfs_lchown"
12208 #: ../src/guestfs-actions.pod:3247
12212 " guestfs_lchown (guestfs_h *g,\n"
12215 " const char *path);\n"
12221 #: ../src/guestfs-actions.pod:3253
12223 "Change the file owner to C<owner> and group to C<group>. This is like "
12224 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12225 "changed, not the target."
12230 #: ../src/guestfs-actions.pod:3265
12231 msgid "guestfs_lgetxattr"
12236 #: ../src/guestfs-actions.pod:3267
12240 " guestfs_lgetxattr (guestfs_h *g,\n"
12241 " const char *path,\n"
12242 " const char *name,\n"
12243 " size_t *size_r);\n"
12249 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2261
12251 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12252 "is a symlink, then this call returns an extended attribute from the symlink."
12257 #: ../src/guestfs-actions.pod:3287
12258 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12263 #: ../src/guestfs-actions.pod:3295
12264 msgid "guestfs_lgetxattrs"
12269 #: ../src/guestfs-actions.pod:3297
12272 " struct guestfs_xattr_list *\n"
12273 " guestfs_lgetxattrs (guestfs_h *g,\n"
12274 " const char *path);\n"
12280 #: ../src/guestfs-actions.pod:3301
12282 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12283 "then it returns the extended attributes of the link itself."
12288 #: ../src/guestfs-actions.pod:3311
12289 msgid "guestfs_list_devices"
12294 #: ../src/guestfs-actions.pod:3313
12298 " guestfs_list_devices (guestfs_h *g);\n"
12304 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2289
12305 msgid "List all the block devices."
12310 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2291
12311 msgid "The full block device names are returned, eg. C</dev/sda>."
12316 #: ../src/guestfs-actions.pod:3328
12317 msgid "guestfs_list_filesystems"
12322 #: ../src/guestfs-actions.pod:3330
12326 " guestfs_list_filesystems (guestfs_h *g);\n"
12332 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2299
12334 "This inspection command looks for filesystems on partitions, block devices "
12335 "and logical volumes, returning a list of devices containing filesystems and "
12341 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2303
12343 "The return value is a hash, where the keys are the devices containing "
12344 "filesystems, and the values are the filesystem types. For example:"
12349 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2307
12352 " \"/dev/sda1\" => \"ntfs\"\n"
12353 " \"/dev/sda2\" => \"ext2\"\n"
12354 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12355 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12361 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2312
12363 "The value can have the special value \"unknown\", meaning the content of the "
12364 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12369 #: ../src/guestfs-actions.pod:3350
12371 "This command runs other libguestfs commands, which might include "
12372 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12373 "soon after launch and only when nothing is mounted."
12378 #: ../src/guestfs-actions.pod:3354
12380 "Not all of the filesystems returned will be mountable. In particular, swap "
12381 "partitions are returned in the list. Also this command does not check that "
12382 "each filesystem found is valid and mountable, and some filesystems might be "
12383 "mountable but require special options. Filesystems may not all belong to a "
12384 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12389 #: ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:4961
12390 msgid "(Added in 1.5.15)"
12395 #: ../src/guestfs-actions.pod:3370
12396 msgid "guestfs_list_partitions"
12401 #: ../src/guestfs-actions.pod:3372
12405 " guestfs_list_partitions (guestfs_h *g);\n"
12411 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2332
12412 msgid "List all the partitions detected on all block devices."
12417 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2334
12418 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12423 #: ../src/guestfs-actions.pod:3379
12425 "This does not return logical volumes. For that you will need to call "
12431 #: ../src/guestfs-actions.pod:3390
12437 #: ../src/guestfs-actions.pod:3392
12441 " guestfs_ll (guestfs_h *g,\n"
12442 " const char *directory);\n"
12448 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2345
12450 "List the files in C<directory> (relative to the root directory, there is no "
12451 "cwd) in the format of 'ls -la'."
12456 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:2348
12458 "This command is mostly useful for interactive sessions. It is I<not> "
12459 "intended that you try to parse the output string."
12464 #: ../src/guestfs-actions.pod:3407
12470 #: ../src/guestfs-actions.pod:3409
12474 " guestfs_ln (guestfs_h *g,\n"
12475 " const char *target,\n"
12476 " const char *linkname);\n"
12482 #: ../src/guestfs-actions.pod:3414 ../fish/guestfish-actions.pod:2355
12483 msgid "This command creates a hard link using the C<ln> command."
12488 #: ../src/guestfs-actions.pod:3420
12489 msgid "guestfs_ln_f"
12494 #: ../src/guestfs-actions.pod:3422
12498 " guestfs_ln_f (guestfs_h *g,\n"
12499 " const char *target,\n"
12500 " const char *linkname);\n"
12506 #: ../src/guestfs-actions.pod:3427 ../fish/guestfish-actions.pod:2361
12508 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12509 "option removes the link (C<linkname>) if it exists already."
12514 #: ../src/guestfs-actions.pod:3434
12515 msgid "guestfs_ln_s"
12520 #: ../src/guestfs-actions.pod:3436
12524 " guestfs_ln_s (guestfs_h *g,\n"
12525 " const char *target,\n"
12526 " const char *linkname);\n"
12532 #: ../src/guestfs-actions.pod:3441 ../fish/guestfish-actions.pod:2368
12533 msgid "This command creates a symbolic link using the C<ln -s> command."
12538 #: ../src/guestfs-actions.pod:3447
12539 msgid "guestfs_ln_sf"
12544 #: ../src/guestfs-actions.pod:3449
12548 " guestfs_ln_sf (guestfs_h *g,\n"
12549 " const char *target,\n"
12550 " const char *linkname);\n"
12556 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2374
12558 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12559 "option removes the link (C<linkname>) if it exists already."
12564 #: ../src/guestfs-actions.pod:3461
12565 msgid "guestfs_lremovexattr"
12570 #: ../src/guestfs-actions.pod:3463
12574 " guestfs_lremovexattr (guestfs_h *g,\n"
12575 " const char *xattr,\n"
12576 " const char *path);\n"
12582 #: ../src/guestfs-actions.pod:3468
12584 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12585 "link, then it removes an extended attribute of the link itself."
12590 #: ../src/guestfs-actions.pod:3476
12596 #: ../src/guestfs-actions.pod:3478
12600 " guestfs_ls (guestfs_h *g,\n"
12601 " const char *directory);\n"
12607 #: ../src/guestfs-actions.pod:3482 ../fish/guestfish-actions.pod:2389
12609 "List the files in C<directory> (relative to the root directory, there is no "
12610 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12615 #: ../src/guestfs-actions.pod:3486
12617 "This command is mostly useful for interactive sessions. Programs should "
12618 "probably use C<guestfs_readdir> instead."
12623 #: ../src/guestfs-actions.pod:3495
12624 msgid "guestfs_lsetxattr"
12629 #: ../src/guestfs-actions.pod:3497
12633 " guestfs_lsetxattr (guestfs_h *g,\n"
12634 " const char *xattr,\n"
12635 " const char *val,\n"
12637 " const char *path);\n"
12643 #: ../src/guestfs-actions.pod:3504
12645 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12646 "then it sets an extended attribute of the link itself."
12651 #: ../src/guestfs-actions.pod:3512
12652 msgid "guestfs_lstat"
12657 #: ../src/guestfs-actions.pod:3514
12660 " struct guestfs_stat *\n"
12661 " guestfs_lstat (guestfs_h *g,\n"
12662 " const char *path);\n"
12668 #: ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:6015
12669 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:4023
12670 msgid "Returns file information for the given C<path>."
12675 #: ../src/guestfs-actions.pod:3520
12677 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12678 "link, then the link is stat-ed, not the file it refers to."
12683 #: ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:2414
12684 msgid "This is the same as the C<lstat(2)> system call."
12689 #: ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:6019
12691 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12692 "error. I<The caller must call C<guestfs_free_stat> after use>."
12697 #: ../src/guestfs-actions.pod:3530 ../src/guestfs-actions.pod:6023
12698 #: ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6422
12699 msgid "(Added in 0.9.2)"
12704 #: ../src/guestfs-actions.pod:3532
12705 msgid "guestfs_lstatlist"
12710 #: ../src/guestfs-actions.pod:3534
12713 " struct guestfs_stat_list *\n"
12714 " guestfs_lstatlist (guestfs_h *g,\n"
12715 " const char *path,\n"
12716 " char *const *names);\n"
12722 #: ../src/guestfs-actions.pod:3539
12724 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12725 "files, where all files are in the directory C<path>. C<names> is the list "
12726 "of files from this directory."
12731 #: ../src/guestfs-actions.pod:3543 ../fish/guestfish-actions.pod:2424
12733 "On return you get a list of stat structs, with a one-to-one correspondence "
12734 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12735 "then the C<ino> field of that structure is set to C<-1>."
12740 #: ../src/guestfs-actions.pod:3548
12742 "This call is intended for programs that want to efficiently list a directory "
12743 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12744 "for a similarly efficient call for getting extended attributes. Very long "
12745 "directory listings might cause the protocol message size to be exceeded, "
12746 "causing this call to fail. The caller must split up such requests into "
12747 "smaller groups of names."
12752 #: ../src/guestfs-actions.pod:3556
12754 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12755 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12760 #: ../src/guestfs-actions.pod:3562
12761 msgid "guestfs_luks_add_key"
12766 #: ../src/guestfs-actions.pod:3564
12770 " guestfs_luks_add_key (guestfs_h *g,\n"
12771 " const char *device,\n"
12772 " const char *key,\n"
12773 " const char *newkey,\n"
12780 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2441
12782 "This command adds a new key on LUKS device C<device>. C<key> is any "
12783 "existing key, and is used to access the device. C<newkey> is the new key to "
12784 "add. C<keyslot> is the key slot that will be replaced."
12789 #: ../src/guestfs-actions.pod:3576
12791 "Note that if C<keyslot> already contains a key, then this command will "
12792 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12797 #: ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3622
12798 #: ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3665
12799 #: ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:3716
12801 "This function takes a key or passphrase parameter which could contain "
12802 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12808 #: ../src/guestfs-actions.pod:3586 ../src/guestfs-actions.pod:3626
12809 #: ../src/guestfs-actions.pod:3649 ../src/guestfs-actions.pod:3669
12810 msgid "(Added in 1.5.2)"
12815 #: ../src/guestfs-actions.pod:3588
12816 msgid "guestfs_luks_close"
12821 #: ../src/guestfs-actions.pod:3590
12825 " guestfs_luks_close (guestfs_h *g,\n"
12826 " const char *device);\n"
12832 #: ../src/guestfs-actions.pod:3594
12834 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12835 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12836 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12837 "underlying block device."
12842 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3701
12843 #: ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:3770
12844 #: ../src/guestfs-actions.pod:3818
12845 msgid "(Added in 1.5.1)"
12850 #: ../src/guestfs-actions.pod:3604
12851 msgid "guestfs_luks_format"
12856 #: ../src/guestfs-actions.pod:3606
12860 " guestfs_luks_format (guestfs_h *g,\n"
12861 " const char *device,\n"
12862 " const char *key,\n"
12869 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2467
12871 "This command erases existing data on C<device> and formats the device as a "
12872 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12873 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12878 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642
12879 #: ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:4712
12880 #: ../src/guestfs-actions.pod:5475 ../src/guestfs-actions.pod:5850
12881 #: ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5899
12882 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:2475
12883 #: ../fish/guestfish-actions.pod:2488 ../fish/guestfish-actions.pod:2572
12884 #: ../fish/guestfish-actions.pod:3135 ../fish/guestfish-actions.pod:3642
12885 #: ../fish/guestfish-actions.pod:3922 ../fish/guestfish-actions.pod:3938
12886 #: ../fish/guestfish-actions.pod:3953 ../fish/guestfish-actions.pod:4668
12888 "B<This command is dangerous. Without careful use you can easily destroy all "
12894 #: ../src/guestfs-actions.pod:3628
12895 msgid "guestfs_luks_format_cipher"
12900 #: ../src/guestfs-actions.pod:3630
12904 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12905 " const char *device,\n"
12906 " const char *key,\n"
12908 " const char *cipher);\n"
12914 #: ../src/guestfs-actions.pod:3637
12916 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12917 "set the C<cipher> used."
12922 #: ../src/guestfs-actions.pod:3651
12923 msgid "guestfs_luks_kill_slot"
12928 #: ../src/guestfs-actions.pod:3653
12932 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12933 " const char *device,\n"
12934 " const char *key,\n"
12941 #: ../src/guestfs-actions.pod:3659 ../fish/guestfish-actions.pod:2495
12943 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12944 "device C<device>. C<key> must be one of the I<other> keys."
12949 #: ../src/guestfs-actions.pod:3671
12950 msgid "guestfs_luks_open"
12955 #: ../src/guestfs-actions.pod:3673
12959 " guestfs_luks_open (guestfs_h *g,\n"
12960 " const char *device,\n"
12961 " const char *key,\n"
12962 " const char *mapname);\n"
12968 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2506
12970 "This command opens a block device which has been encrypted according to the "
12971 "Linux Unified Key Setup (LUKS) standard."
12976 #: ../src/guestfs-actions.pod:3682 ../fish/guestfish-actions.pod:2509
12977 msgid "C<device> is the encrypted block device or partition."
12982 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
12984 "The caller must supply one of the keys associated with the LUKS block "
12985 "device, in the C<key> parameter."
12990 #: ../src/guestfs-actions.pod:3687 ../fish/guestfish-actions.pod:2514
12992 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12993 "writes to this block device are decrypted from and encrypted to the "
12994 "underlying C<device> respectively."
12999 #: ../src/guestfs-actions.pod:3691
13001 "If this block device contains LVM volume groups, then calling "
13002 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13008 #: ../src/guestfs-actions.pod:3703
13009 msgid "guestfs_luks_open_ro"
13014 #: ../src/guestfs-actions.pod:3705
13018 " guestfs_luks_open_ro (guestfs_h *g,\n"
13019 " const char *device,\n"
13020 " const char *key,\n"
13021 " const char *mapname);\n"
13027 #: ../src/guestfs-actions.pod:3711
13029 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13035 #: ../src/guestfs-actions.pod:3722
13036 msgid "guestfs_lvcreate"
13041 #: ../src/guestfs-actions.pod:3724
13045 " guestfs_lvcreate (guestfs_h *g,\n"
13046 " const char *logvol,\n"
13047 " const char *volgroup,\n"
13054 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2539
13056 "This creates an LVM logical volume called C<logvol> on the volume group "
13057 "C<volgroup>, with C<size> megabytes."
13062 #: ../src/guestfs-actions.pod:3737
13063 msgid "guestfs_lvm_canonical_lv_name"
13068 #: ../src/guestfs-actions.pod:3739
13072 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13073 " const char *lvname);\n"
13079 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2546
13081 "This converts alternative naming schemes for LVs that you might find to the "
13082 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13088 #: ../src/guestfs-actions.pod:3747 ../fish/guestfish-actions.pod:2550
13090 "This command returns an error if the C<lvname> parameter does not refer to a "
13096 #: ../src/guestfs-actions.pod:3750
13097 msgid "See also C<guestfs_is_lv>."
13102 #: ../src/guestfs-actions.pod:3755
13103 msgid "(Added in 1.5.24)"
13108 #: ../src/guestfs-actions.pod:3757
13109 msgid "guestfs_lvm_clear_filter"
13114 #: ../src/guestfs-actions.pod:3759
13118 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13124 #: ../src/guestfs-actions.pod:3762
13126 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13127 "see every block device."
13132 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3807
13133 #: ../fish/guestfish-actions.pod:2562 ../fish/guestfish-actions.pod:2593
13135 "This command also clears the LVM cache and performs a volume group scan."
13140 #: ../src/guestfs-actions.pod:3772
13141 msgid "guestfs_lvm_remove_all"
13146 #: ../src/guestfs-actions.pod:3774
13150 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13156 #: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2569
13158 "This command removes all LVM logical volumes, volume groups and physical "
13164 #: ../src/guestfs-actions.pod:3787
13165 msgid "guestfs_lvm_set_filter"
13170 #: ../src/guestfs-actions.pod:3789
13174 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13175 " char *const *devices);\n"
13181 #: ../src/guestfs-actions.pod:3793 ../fish/guestfish-actions.pod:2579
13183 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13184 "block devices in the list C<devices>, and will ignore all other attached "
13190 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2583
13192 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13193 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13194 "there are two types of duplication possible: either cloned PVs/VGs which "
13195 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13196 "same name. In normal operation you cannot create this situation, but you "
13197 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13198 "inside the LVM metadata."
13203 #: ../src/guestfs-actions.pod:3810 ../fish/guestfish-actions.pod:2596
13204 msgid "You can filter whole block devices or individual partitions."
13209 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
13211 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13212 "filesystem), even if you are not filtering out that VG."
13217 #: ../src/guestfs-actions.pod:3820
13218 msgid "guestfs_lvremove"
13223 #: ../src/guestfs-actions.pod:3822
13227 " guestfs_lvremove (guestfs_h *g,\n"
13228 " const char *device);\n"
13234 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2606
13236 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13237 "LV, such as C</dev/VG/LV>."
13242 #: ../src/guestfs-actions.pod:3829 ../fish/guestfish-actions.pod:2609
13244 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13250 #: ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:5058
13251 #: ../src/guestfs-actions.pod:6798
13252 msgid "(Added in 1.0.13)"
13257 #: ../src/guestfs-actions.pod:3836
13258 msgid "guestfs_lvrename"
13263 #: ../src/guestfs-actions.pod:3838
13267 " guestfs_lvrename (guestfs_h *g,\n"
13268 " const char *logvol,\n"
13269 " const char *newlogvol);\n"
13275 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2616
13276 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13281 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:6811
13282 msgid "(Added in 1.0.83)"
13287 #: ../src/guestfs-actions.pod:3849
13288 msgid "guestfs_lvresize"
13293 #: ../src/guestfs-actions.pod:3851
13297 " guestfs_lvresize (guestfs_h *g,\n"
13298 " const char *device,\n"
13305 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2622
13307 "This resizes (expands or shrinks) an existing LVM logical volume to "
13308 "C<mbytes>. When reducing, data in the reduced part is lost."
13313 #: ../src/guestfs-actions.pod:3864
13314 msgid "guestfs_lvresize_free"
13319 #: ../src/guestfs-actions.pod:3866
13323 " guestfs_lvresize_free (guestfs_h *g,\n"
13324 " const char *lv,\n"
13331 #: ../src/guestfs-actions.pod:3871 ../fish/guestfish-actions.pod:2630
13333 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13334 "remaining free space in the volume group. Commonly you would call this with "
13335 "pc = 100 which expands the logical volume as much as possible, using all "
13336 "remaining free space in the volume group."
13341 #: ../src/guestfs-actions.pod:3879
13342 msgid "(Added in 1.3.3)"
13347 #: ../src/guestfs-actions.pod:3881
13348 msgid "guestfs_lvs"
13353 #: ../src/guestfs-actions.pod:3883
13357 " guestfs_lvs (guestfs_h *g);\n"
13363 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2640
13365 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13371 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2643
13373 "This returns a list of the logical volume device names (eg. C</dev/"
13374 "VolGroup00/LogVol00>)."
13379 #: ../src/guestfs-actions.pod:3892
13380 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13385 #: ../src/guestfs-actions.pod:3900
13386 msgid "guestfs_lvs_full"
13391 #: ../src/guestfs-actions.pod:3902
13394 " struct guestfs_lvm_lv_list *\n"
13395 " guestfs_lvs_full (guestfs_h *g);\n"
13401 #: ../src/guestfs-actions.pod:3905 ../fish/guestfish-actions.pod:2652
13403 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13404 "(8)> command. The \"full\" version includes all fields."
13409 #: ../src/guestfs-actions.pod:3908
13411 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13412 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13417 #: ../src/guestfs-actions.pod:3914
13418 msgid "guestfs_lvuuid"
13423 #: ../src/guestfs-actions.pod:3916
13427 " guestfs_lvuuid (guestfs_h *g,\n"
13428 " const char *device);\n"
13434 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2659
13435 msgid "This command returns the UUID of the LVM LV C<device>."
13440 #: ../src/guestfs-actions.pod:3927
13441 msgid "guestfs_lxattrlist"
13446 #: ../src/guestfs-actions.pod:3929
13449 " struct guestfs_xattr_list *\n"
13450 " guestfs_lxattrlist (guestfs_h *g,\n"
13451 " const char *path,\n"
13452 " char *const *names);\n"
13458 #: ../src/guestfs-actions.pod:3934 ../fish/guestfish-actions.pod:2665
13460 "This call allows you to get the extended attributes of multiple files, where "
13461 "all files are in the directory C<path>. C<names> is the list of files from "
13467 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2669
13469 "On return you get a flat list of xattr structs which must be interpreted "
13470 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13471 "C<attrval> in this struct is zero-length to indicate there was an error "
13472 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13473 "number (the number of following attributes for this file, which could be C<"
13474 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13475 "for the first named file. This repeats for the second and subsequent files."
13480 #: ../src/guestfs-actions.pod:3948
13482 "This call is intended for programs that want to efficiently list a directory "
13483 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13484 "a similarly efficient call for getting standard stats. Very long directory "
13485 "listings might cause the protocol message size to be exceeded, causing this "
13486 "call to fail. The caller must split up such requests into smaller groups of "
13492 #: ../src/guestfs-actions.pod:3962
13493 msgid "guestfs_mkdir"
13498 #: ../src/guestfs-actions.pod:3964
13502 " guestfs_mkdir (guestfs_h *g,\n"
13503 " const char *path);\n"
13509 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2691
13510 msgid "Create a directory named C<path>."
13515 #: ../src/guestfs-actions.pod:3974
13516 msgid "guestfs_mkdir_mode"
13521 #: ../src/guestfs-actions.pod:3976
13525 " guestfs_mkdir_mode (guestfs_h *g,\n"
13526 " const char *path,\n"
13533 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2697
13535 "This command creates a directory, setting the initial permissions of the "
13536 "directory to C<mode>."
13541 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2700
13543 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13544 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13550 #: ../src/guestfs-actions.pod:3988
13551 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13556 #: ../src/guestfs-actions.pod:3994
13557 msgid "guestfs_mkdir_p"
13562 #: ../src/guestfs-actions.pod:3996
13566 " guestfs_mkdir_p (guestfs_h *g,\n"
13567 " const char *path);\n"
13573 #: ../src/guestfs-actions.pod:4000 ../fish/guestfish-actions.pod:2710
13575 "Create a directory named C<path>, creating any parent directories as "
13576 "necessary. This is like the C<mkdir -p> shell command."
13581 #: ../src/guestfs-actions.pod:4007
13582 msgid "guestfs_mkdtemp"
13587 #: ../src/guestfs-actions.pod:4009
13591 " guestfs_mkdtemp (guestfs_h *g,\n"
13592 " const char *template);\n"
13598 #: ../src/guestfs-actions.pod:4013 ../fish/guestfish-actions.pod:2717
13600 "This command creates a temporary directory. The C<template> parameter "
13601 "should be a full pathname for the temporary directory name with the final "
13602 "six characters being \"XXXXXX\"."
13607 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2722
13609 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13610 "being suitable for Windows filesystems."
13615 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2725
13616 msgid "The name of the temporary directory that was created is returned."
13621 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2728
13622 msgid "The temporary directory is created with mode 0700 and is owned by root."
13627 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2731
13629 "The caller is responsible for deleting the temporary directory and its "
13630 "contents after use."
13635 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2734
13636 msgid "See also: L<mkdtemp(3)>"
13641 #: ../src/guestfs-actions.pod:4037
13642 msgid "guestfs_mke2fs_J"
13647 #: ../src/guestfs-actions.pod:4039
13651 " guestfs_mke2fs_J (guestfs_h *g,\n"
13652 " const char *fstype,\n"
13653 " int blocksize,\n"
13654 " const char *device,\n"
13655 " const char *journal);\n"
13661 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2740
13663 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13664 "C<journal>. It is equivalent to the command:"
13669 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2744
13672 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13678 #: ../src/guestfs-actions.pod:4052
13679 msgid "See also C<guestfs_mke2journal>."
13684 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4074
13685 #: ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4108
13686 #: ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4136
13687 #: ../src/guestfs-actions.pod:4195 ../src/guestfs-actions.pod:4448
13688 msgid "(Added in 1.0.68)"
13693 #: ../src/guestfs-actions.pod:4058
13694 msgid "guestfs_mke2fs_JL"
13699 #: ../src/guestfs-actions.pod:4060
13703 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13704 " const char *fstype,\n"
13705 " int blocksize,\n"
13706 " const char *device,\n"
13707 " const char *label);\n"
13713 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2752
13715 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13716 "the journal labeled C<label>."
13721 #: ../src/guestfs-actions.pod:4070
13722 msgid "See also C<guestfs_mke2journal_L>."
13727 #: ../src/guestfs-actions.pod:4076
13728 msgid "guestfs_mke2fs_JU"
13733 #: ../src/guestfs-actions.pod:4078
13737 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13738 " const char *fstype,\n"
13739 " int blocksize,\n"
13740 " const char *device,\n"
13741 " const char *uuid);\n"
13747 #: ../src/guestfs-actions.pod:4085 ../fish/guestfish-actions.pod:2761
13749 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13750 "the journal with UUID C<uuid>."
13755 #: ../src/guestfs-actions.pod:4088
13756 msgid "See also C<guestfs_mke2journal_U>."
13761 #: ../src/guestfs-actions.pod:4094
13762 msgid "guestfs_mke2journal"
13767 #: ../src/guestfs-actions.pod:4096
13771 " guestfs_mke2journal (guestfs_h *g,\n"
13772 " int blocksize,\n"
13773 " const char *device);\n"
13779 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2770
13781 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13787 #: ../src/guestfs-actions.pod:4104 ../fish/guestfish-actions.pod:2773
13790 " mke2fs -O journal_dev -b blocksize device\n"
13796 #: ../src/guestfs-actions.pod:4110
13797 msgid "guestfs_mke2journal_L"
13802 #: ../src/guestfs-actions.pod:4112
13806 " guestfs_mke2journal_L (guestfs_h *g,\n"
13807 " int blocksize,\n"
13808 " const char *label,\n"
13809 " const char *device);\n"
13815 #: ../src/guestfs-actions.pod:4118 ../fish/guestfish-actions.pod:2779
13816 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13821 #: ../src/guestfs-actions.pod:4124
13822 msgid "guestfs_mke2journal_U"
13827 #: ../src/guestfs-actions.pod:4126
13831 " guestfs_mke2journal_U (guestfs_h *g,\n"
13832 " int blocksize,\n"
13833 " const char *uuid,\n"
13834 " const char *device);\n"
13840 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2785
13841 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13846 #: ../src/guestfs-actions.pod:4138
13847 msgid "guestfs_mkfifo"
13852 #: ../src/guestfs-actions.pod:4140
13856 " guestfs_mkfifo (guestfs_h *g,\n"
13858 " const char *path);\n"
13864 #: ../src/guestfs-actions.pod:4145
13866 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13867 "is just a convenient wrapper around C<guestfs_mknod>."
13872 #: ../src/guestfs-actions.pod:4155
13873 msgid "guestfs_mkfs"
13878 #: ../src/guestfs-actions.pod:4157
13882 " guestfs_mkfs (guestfs_h *g,\n"
13883 " const char *fstype,\n"
13884 " const char *device);\n"
13890 #: ../src/guestfs-actions.pod:4162 ../fish/guestfish-actions.pod:2801
13892 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13893 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13898 #: ../src/guestfs-actions.pod:4170
13899 msgid "guestfs_mkfs_b"
13904 #: ../src/guestfs-actions.pod:4172
13908 " guestfs_mkfs_b (guestfs_h *g,\n"
13909 " const char *fstype,\n"
13910 " int blocksize,\n"
13911 " const char *device);\n"
13917 #: ../src/guestfs-actions.pod:4178
13919 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13920 "block size of the resulting filesystem. Supported block sizes depend on the "
13921 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13926 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4225
13927 #: ../fish/guestfish-actions.pod:2814 ../fish/guestfish-actions.pod:2841
13929 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13935 #: ../src/guestfs-actions.pod:4188 ../fish/guestfish-actions.pod:2817
13937 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13942 #: ../src/guestfs-actions.pod:4197
13943 msgid "guestfs_mkfs_opts"
13948 #: ../src/guestfs-actions.pod:4199
13952 " guestfs_mkfs_opts (guestfs_h *g,\n"
13953 " const char *fstype,\n"
13954 " const char *device,\n"
13961 #: ../src/guestfs-actions.pod:4210
13964 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13970 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2828
13972 "This function creates a filesystem on C<device>. The filesystem type is "
13973 "C<fstype>, for example C<ext3>."
13978 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2835
13979 msgid "C<blocksize>"
13984 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2837
13986 "The filesystem block size. Supported block sizes depend on the filesystem "
13987 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13992 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2844
13993 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13997 #: ../src/guestfs-actions.pod:4234
13998 msgid "(Added in 1.7.19)"
14003 #: ../src/guestfs-actions.pod:4236
14004 msgid "guestfs_mkfs_opts_va"
14009 #: ../src/guestfs-actions.pod:4238
14013 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14014 " const char *fstype,\n"
14015 " const char *device,\n"
14016 " va_list args);\n"
14022 #: ../src/guestfs-actions.pod:4244
14023 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14028 #: ../src/guestfs-actions.pod:4248
14029 msgid "guestfs_mkfs_opts_argv"
14034 #: ../src/guestfs-actions.pod:4250
14038 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14039 " const char *fstype,\n"
14040 " const char *device,\n"
14041 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14047 #: ../src/guestfs-actions.pod:4256
14048 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14053 #: ../src/guestfs-actions.pod:4260
14054 msgid "guestfs_mkmountpoint"
14059 #: ../src/guestfs-actions.pod:4262
14063 " guestfs_mkmountpoint (guestfs_h *g,\n"
14064 " const char *exemptpath);\n"
14070 #: ../src/guestfs-actions.pod:4266
14072 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14073 "that can be used to create extra mountpoints before mounting the first "
14079 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2858
14081 "These calls are I<only> necessary in some very limited circumstances, mainly "
14082 "the case where you want to mount a mix of unrelated and/or read-only "
14083 "filesystems together."
14088 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2862
14090 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14091 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14092 "inside that. You can unpack this as follows in guestfish:"
14097 #: ../src/guestfs-actions.pod:4279 ../fish/guestfish-actions.pod:2867
14100 " add-ro Fedora-11-i686-Live.iso\n"
14102 " mkmountpoint /cd\n"
14103 " mkmountpoint /sqsh\n"
14104 " mkmountpoint /ext3fs\n"
14105 " mount /dev/sda /cd\n"
14106 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14107 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14113 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2876
14114 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14119 #: ../src/guestfs-actions.pod:4290
14121 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14122 "may get unexpected errors if you try to mix these calls. It is safest to "
14123 "manually unmount filesystems and remove mountpoints after use."
14128 #: ../src/guestfs-actions.pod:4294
14130 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14131 "first, so for this to work for manual mountpoints, you must ensure that the "
14132 "innermost mountpoints have the longest pathnames, as in the example code "
14138 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2887
14140 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14145 #: ../src/guestfs-actions.pod:4301
14147 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14148 "means that C<guestfs_umount_all> is called when the handle is closed which "
14149 "can also trigger these issues."
14154 #: ../src/guestfs-actions.pod:4307 ../src/guestfs-actions.pod:4566
14155 #: ../src/guestfs-actions.pod:5459
14156 msgid "(Added in 1.0.62)"
14161 #: ../src/guestfs-actions.pod:4309
14162 msgid "guestfs_mknod"
14167 #: ../src/guestfs-actions.pod:4311
14171 " guestfs_mknod (guestfs_h *g,\n"
14175 " const char *path);\n"
14181 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2897
14183 "This call creates block or character special devices, or named pipes (FIFOs)."
14188 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2900
14190 "The C<mode> parameter should be the mode, using the standard constants. "
14191 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14192 "used when creating block and character special devices."
14197 #: ../src/guestfs-actions.pod:4326
14199 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14200 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14201 "regular file). These constants are available in the standard Linux header "
14202 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14203 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14204 "the appropriate constant for you."
14209 #: ../src/guestfs-actions.pod:4340
14210 msgid "guestfs_mknod_b"
14215 #: ../src/guestfs-actions.pod:4342
14219 " guestfs_mknod_b (guestfs_h *g,\n"
14223 " const char *path);\n"
14229 #: ../src/guestfs-actions.pod:4349
14231 "This call creates a block device node called C<path> with mode C<mode> and "
14232 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14233 "wrapper around C<guestfs_mknod>."
14238 #: ../src/guestfs-actions.pod:4359
14239 msgid "guestfs_mknod_c"
14244 #: ../src/guestfs-actions.pod:4361
14248 " guestfs_mknod_c (guestfs_h *g,\n"
14252 " const char *path);\n"
14258 #: ../src/guestfs-actions.pod:4368
14260 "This call creates a char device node called C<path> with mode C<mode> and "
14261 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14262 "wrapper around C<guestfs_mknod>."
14267 #: ../src/guestfs-actions.pod:4378
14268 msgid "guestfs_mkswap"
14273 #: ../src/guestfs-actions.pod:4380
14277 " guestfs_mkswap (guestfs_h *g,\n"
14278 " const char *device);\n"
14284 #: ../src/guestfs-actions.pod:4384 ../fish/guestfish-actions.pod:2939
14285 msgid "Create a swap partition on C<device>."
14290 #: ../src/guestfs-actions.pod:4390
14291 msgid "guestfs_mkswap_L"
14296 #: ../src/guestfs-actions.pod:4392
14300 " guestfs_mkswap_L (guestfs_h *g,\n"
14301 " const char *label,\n"
14302 " const char *device);\n"
14308 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2945
14309 msgid "Create a swap partition on C<device> with label C<label>."
14314 #: ../src/guestfs-actions.pod:4399 ../fish/guestfish-actions.pod:2947
14316 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14317 "sda>), just to a partition. This appears to be a limitation of the kernel "
14323 #: ../src/guestfs-actions.pod:4407
14324 msgid "guestfs_mkswap_U"
14329 #: ../src/guestfs-actions.pod:4409
14333 " guestfs_mkswap_U (guestfs_h *g,\n"
14334 " const char *uuid,\n"
14335 " const char *device);\n"
14341 #: ../src/guestfs-actions.pod:4414 ../fish/guestfish-actions.pod:2955
14342 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14347 #: ../src/guestfs-actions.pod:4420
14348 msgid "guestfs_mkswap_file"
14353 #: ../src/guestfs-actions.pod:4422
14357 " guestfs_mkswap_file (guestfs_h *g,\n"
14358 " const char *path);\n"
14364 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:2961
14365 msgid "Create a swap file."
14370 #: ../src/guestfs-actions.pod:4428
14372 "This command just writes a swap file signature to an existing file. To "
14373 "create the file itself, use something like C<guestfs_fallocate>."
14378 #: ../src/guestfs-actions.pod:4435
14379 msgid "guestfs_modprobe"
14384 #: ../src/guestfs-actions.pod:4437
14388 " guestfs_modprobe (guestfs_h *g,\n"
14389 " const char *modulename);\n"
14395 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2970
14396 msgid "This loads a kernel module in the appliance."
14401 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2972
14403 "The kernel module must have been whitelisted when libguestfs was built (see "
14404 "C<appliance/kmod.whitelist.in> in the source)."
14409 #: ../src/guestfs-actions.pod:4450
14410 msgid "guestfs_mount"
14415 #: ../src/guestfs-actions.pod:4452
14419 " guestfs_mount (guestfs_h *g,\n"
14420 " const char *device,\n"
14421 " const char *mountpoint);\n"
14427 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:2979
14429 "Mount a guest disk at a position in the filesystem. Block devices are named "
14430 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14431 "those block devices contain partitions, they will have the usual names (eg. "
14432 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14437 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2985
14439 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14440 "mounted on C</> before others can be mounted. Other filesystems can only be "
14441 "mounted on directories which already exist."
14446 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:2990
14448 "The mounted filesystem is writable, if we have sufficient permissions on the "
14449 "underlying device."
14454 #: ../src/guestfs-actions.pod:4471
14456 "B<Important note:> When you use this call, the filesystem options C<sync> "
14457 "and C<noatime> are set implicitly. This was originally done because we "
14458 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14459 "very large negative performance impact and negligible effect on "
14460 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14461 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14462 "(use an empty string for the first parameter if you don't want any options)."
14467 #: ../src/guestfs-actions.pod:4485
14468 msgid "guestfs_mount_loop"
14473 #: ../src/guestfs-actions.pod:4487
14477 " guestfs_mount_loop (guestfs_h *g,\n"
14478 " const char *file,\n"
14479 " const char *mountpoint);\n"
14485 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:3007
14487 "This command lets you mount C<file> (a filesystem image in a file) on a "
14488 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14494 #: ../src/guestfs-actions.pod:4500
14495 msgid "guestfs_mount_options"
14500 #: ../src/guestfs-actions.pod:4502
14504 " guestfs_mount_options (guestfs_h *g,\n"
14505 " const char *options,\n"
14506 " const char *device,\n"
14507 " const char *mountpoint);\n"
14513 #: ../src/guestfs-actions.pod:4508
14515 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14516 "the mount options as for the L<mount(8)> I<-o> flag."
14521 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3019
14523 "If the C<options> parameter is an empty string, then no options are passed "
14524 "(all options default to whatever the filesystem uses)."
14529 #: ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4532
14530 #: ../src/guestfs-actions.pod:4549
14531 msgid "(Added in 1.0.10)"
14536 #: ../src/guestfs-actions.pod:4520
14537 msgid "guestfs_mount_ro"
14542 #: ../src/guestfs-actions.pod:4522
14546 " guestfs_mount_ro (guestfs_h *g,\n"
14547 " const char *device,\n"
14548 " const char *mountpoint);\n"
14554 #: ../src/guestfs-actions.pod:4527
14556 "This is the same as the C<guestfs_mount> command, but it mounts the "
14557 "filesystem with the read-only (I<-o ro>) flag."
14562 #: ../src/guestfs-actions.pod:4534
14563 msgid "guestfs_mount_vfs"
14568 #: ../src/guestfs-actions.pod:4536
14572 " guestfs_mount_vfs (guestfs_h *g,\n"
14573 " const char *options,\n"
14574 " const char *vfstype,\n"
14575 " const char *device,\n"
14576 " const char *mountpoint);\n"
14582 #: ../src/guestfs-actions.pod:4543
14584 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14585 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14591 #: ../src/guestfs-actions.pod:4551
14592 msgid "guestfs_mountpoints"
14597 #: ../src/guestfs-actions.pod:4553
14601 " guestfs_mountpoints (guestfs_h *g);\n"
14607 #: ../src/guestfs-actions.pod:4556
14609 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14610 "devices. This one returns a hash table (map) of device name to directory "
14611 "where the device is mounted."
14616 #: ../src/guestfs-actions.pod:4568
14617 msgid "guestfs_mounts"
14622 #: ../src/guestfs-actions.pod:4570
14626 " guestfs_mounts (guestfs_h *g);\n"
14632 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3050
14634 "This returns the list of currently mounted filesystems. It returns the list "
14635 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14640 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3053
14641 msgid "Some internal mounts are not shown."
14646 #: ../src/guestfs-actions.pod:4578
14647 msgid "See also: C<guestfs_mountpoints>"
14652 #: ../src/guestfs-actions.pod:4586
14658 #: ../src/guestfs-actions.pod:4588
14662 " guestfs_mv (guestfs_h *g,\n"
14663 " const char *src,\n"
14664 " const char *dest);\n"
14670 #: ../src/guestfs-actions.pod:4593 ../fish/guestfish-actions.pod:3061
14672 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14673 "destination filename or destination directory."
14678 #: ../src/guestfs-actions.pod:4600
14679 msgid "guestfs_ntfs_3g_probe"
14684 #: ../src/guestfs-actions.pod:4602
14688 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14690 " const char *device);\n"
14696 #: ../src/guestfs-actions.pod:4607 ../fish/guestfish-actions.pod:3068
14698 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14699 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14700 "write, and some cannot be mounted at all)."
14705 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3072
14707 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14708 "can be mounted read-write. Set it to false if you want to test if the "
14709 "volume can be mounted read-only."
14714 #: ../src/guestfs-actions.pod:4615 ../fish/guestfish-actions.pod:3076
14716 "The return value is an integer which C<0> if the operation would succeed, or "
14717 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14722 #: ../src/guestfs-actions.pod:4621
14723 msgid "(Added in 1.0.43)"
14728 #: ../src/guestfs-actions.pod:4623
14729 msgid "guestfs_ntfsresize"
14734 #: ../src/guestfs-actions.pod:4625
14738 " guestfs_ntfsresize (guestfs_h *g,\n"
14739 " const char *device);\n"
14745 #: ../src/guestfs-actions.pod:4629 ../fish/guestfish-actions.pod:3084
14747 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14748 "size of the underlying device. See also L<ntfsresize(8)>."
14753 #: ../src/guestfs-actions.pod:4637
14754 msgid "guestfs_ntfsresize_size"
14759 #: ../src/guestfs-actions.pod:4639
14763 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14764 " const char *device,\n"
14765 " int64_t size);\n"
14771 #: ../src/guestfs-actions.pod:4644
14773 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14774 "to specify the new size (in bytes) explicitly."
14779 #: ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:5085
14780 #: ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5407
14781 #: ../src/guestfs-actions.pod:6946
14782 msgid "(Added in 1.3.14)"
14787 #: ../src/guestfs-actions.pod:4651
14788 msgid "guestfs_part_add"
14793 #: ../src/guestfs-actions.pod:4653
14797 " guestfs_part_add (guestfs_h *g,\n"
14798 " const char *device,\n"
14799 " const char *prlogex,\n"
14800 " int64_t startsect,\n"
14801 " int64_t endsect);\n"
14807 #: ../src/guestfs-actions.pod:4660
14809 "This command adds a partition to C<device>. If there is no partition table "
14810 "on the device, call C<guestfs_part_init> first."
14815 #: ../src/guestfs-actions.pod:4663 ../fish/guestfish-actions.pod:3102
14817 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14818 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14819 "C<logical>) and C<e> (or C<extended>) partition types."
14824 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3107
14826 "C<startsect> and C<endsect> are the start and end of the partition in "
14827 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14828 "from the end of the disk (C<-1> is the last sector)."
14833 #: ../src/guestfs-actions.pod:4672
14835 "Creating a partition which covers the whole disk is not so easy. Use "
14836 "C<guestfs_part_disk> to do that."
14841 #: ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4715
14842 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4846
14843 #: ../src/guestfs-actions.pod:4884 ../src/guestfs-actions.pod:4903
14844 #: ../src/guestfs-actions.pod:4943
14845 msgid "(Added in 1.0.78)"
14850 #: ../src/guestfs-actions.pod:4679
14851 msgid "guestfs_part_del"
14856 #: ../src/guestfs-actions.pod:4681
14860 " guestfs_part_del (guestfs_h *g,\n"
14861 " const char *device,\n"
14868 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3118
14869 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14874 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3120
14876 "Note that in the case of MBR partitioning, deleting an extended partition "
14877 "also deletes any logical partitions it contains."
14882 #: ../src/guestfs-actions.pod:4696
14883 msgid "guestfs_part_disk"
14888 #: ../src/guestfs-actions.pod:4698
14892 " guestfs_part_disk (guestfs_h *g,\n"
14893 " const char *device,\n"
14894 " const char *parttype);\n"
14900 #: ../src/guestfs-actions.pod:4703
14902 "This command is simply a combination of C<guestfs_part_init> followed by "
14903 "C<guestfs_part_add> to create a single primary partition covering the whole "
14909 #: ../src/guestfs-actions.pod:4707
14911 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14912 "possible values are described in C<guestfs_part_init>."
14917 #: ../src/guestfs-actions.pod:4717
14918 msgid "guestfs_part_get_bootable"
14923 #: ../src/guestfs-actions.pod:4719
14927 " guestfs_part_get_bootable (guestfs_h *g,\n"
14928 " const char *device,\n"
14935 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3142
14937 "This command returns true if the partition C<partnum> on C<device> has the "
14938 "bootable flag set."
14943 #: ../src/guestfs-actions.pod:4727
14944 msgid "See also C<guestfs_part_set_bootable>."
14949 #: ../src/guestfs-actions.pod:4733
14950 msgid "guestfs_part_get_mbr_id"
14955 #: ../src/guestfs-actions.pod:4735
14959 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14960 " const char *device,\n"
14967 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3151
14969 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14970 "partition C<partnum>."
14975 #: ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4919
14977 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14978 "undefined results for other partition table types (see "
14979 "C<guestfs_part_get_parttype>)."
14984 #: ../src/guestfs-actions.pod:4751
14985 msgid "guestfs_part_get_parttype"
14990 #: ../src/guestfs-actions.pod:4753
14994 " guestfs_part_get_parttype (guestfs_h *g,\n"
14995 " const char *device);\n"
15001 #: ../src/guestfs-actions.pod:4757 ../fish/guestfish-actions.pod:3162
15003 "This command examines the partition table on C<device> and returns the "
15004 "partition table type (format) being used."
15009 #: ../src/guestfs-actions.pod:4760
15011 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15012 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15013 "possible, although unusual. See C<guestfs_part_init> for a full list."
15018 #: ../src/guestfs-actions.pod:4770
15019 msgid "guestfs_part_init"
15024 #: ../src/guestfs-actions.pod:4772
15028 " guestfs_part_init (guestfs_h *g,\n"
15029 " const char *device,\n"
15030 " const char *parttype);\n"
15036 #: ../src/guestfs-actions.pod:4777 ../fish/guestfish-actions.pod:3174
15038 "This creates an empty partition table on C<device> of one of the partition "
15039 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15040 "(for large disks)."
15045 #: ../src/guestfs-actions.pod:4781
15047 "Initially there are no partitions. Following this, you should call "
15048 "C<guestfs_part_add> for each partition required."
15053 #: ../src/guestfs-actions.pod:4784 ../fish/guestfish-actions.pod:3181
15054 msgid "Possible values for C<parttype> are:"
15059 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3185
15060 msgid "B<efi> | B<gpt>"
15065 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3187
15066 msgid "Intel EFI / GPT partition table."
15071 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3189
15073 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15074 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15075 "the C<mbr> format."
15080 #: ../src/guestfs-actions.pod:4796 ../fish/guestfish-actions.pod:3193
15081 msgid "B<mbr> | B<msdos>"
15086 #: ../src/guestfs-actions.pod:4798 ../fish/guestfish-actions.pod:3195
15088 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15089 "Windows. This partition type will B<only> work for device sizes up to 2 "
15090 "TB. For large disks we recommend using C<gpt>."
15095 #: ../src/guestfs-actions.pod:4805 ../fish/guestfish-actions.pod:3202
15097 "Other partition table types that may work but are not supported include:"
15102 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3207
15108 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3209
15109 msgid "AIX disk labels."
15114 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3211
15115 msgid "B<amiga> | B<rdb>"
15120 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
15121 msgid "Amiga \"Rigid Disk Block\" format."
15126 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3215
15132 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3217
15133 msgid "BSD disk labels."
15138 #: ../src/guestfs-actions.pod:4822 ../fish/guestfish-actions.pod:3219
15144 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3221
15145 msgid "DASD, used on IBM mainframes."
15150 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3223
15156 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3225
15157 msgid "MIPS/SGI volumes."
15162 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3227
15168 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3229
15169 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15174 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3231
15180 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3233
15181 msgid "NEC PC-98 format, common in Japan apparently."
15186 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3235
15192 #: ../src/guestfs-actions.pod:4840 ../fish/guestfish-actions.pod:3237
15193 msgid "Sun disk labels."
15198 #: ../src/guestfs-actions.pod:4848
15199 msgid "guestfs_part_list"
15204 #: ../src/guestfs-actions.pod:4850
15207 " struct guestfs_partition_list *\n"
15208 " guestfs_part_list (guestfs_h *g,\n"
15209 " const char *device);\n"
15215 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3245
15217 "This command parses the partition table on C<device> and returns the list of "
15218 "partitions found."
15223 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3248
15224 msgid "The fields in the returned structure are:"
15229 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3252
15230 msgid "B<part_num>"
15235 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3254
15236 msgid "Partition number, counting from 1."
15241 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3256
15242 msgid "B<part_start>"
15247 #: ../src/guestfs-actions.pod:4867
15249 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15250 "the device's sector size, see C<guestfs_blockdev_getss>."
15255 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3261
15256 msgid "B<part_end>"
15261 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3263
15262 msgid "End of the partition in bytes."
15267 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3265
15268 msgid "B<part_size>"
15273 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3267
15274 msgid "Size of the partition in bytes."
15279 #: ../src/guestfs-actions.pod:4880
15281 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15282 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15288 #: ../src/guestfs-actions.pod:4886
15289 msgid "guestfs_part_set_bootable"
15294 #: ../src/guestfs-actions.pod:4888
15298 " guestfs_part_set_bootable (guestfs_h *g,\n"
15299 " const char *device,\n"
15301 " int bootable);\n"
15307 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3275
15309 "This sets the bootable flag on partition numbered C<partnum> on device "
15310 "C<device>. Note that partitions are numbered from 1."
15315 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3278
15317 "The bootable flag is used by some operating systems (notably Windows) to "
15318 "determine which partition to boot from. It is by no means universally "
15324 #: ../src/guestfs-actions.pod:4905
15325 msgid "guestfs_part_set_mbr_id"
15330 #: ../src/guestfs-actions.pod:4907
15334 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15335 " const char *device,\n"
15343 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3286
15345 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15346 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15347 "documentation are in fact hexadecimal numbers, but usually documented "
15348 "without any leading \"0x\" which might be confusing."
15353 #: ../src/guestfs-actions.pod:4927
15354 msgid "guestfs_part_set_name"
15359 #: ../src/guestfs-actions.pod:4929
15363 " guestfs_part_set_name (guestfs_h *g,\n"
15364 " const char *device,\n"
15366 " const char *name);\n"
15372 #: ../src/guestfs-actions.pod:4935 ../fish/guestfish-actions.pod:3300
15374 "This sets the partition name on partition numbered C<partnum> on device "
15375 "C<device>. Note that partitions are numbered from 1."
15380 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3303
15382 "The partition name can only be set on certain types of partition table. "
15383 "This works on C<gpt> but not on C<mbr> partitions."
15388 #: ../src/guestfs-actions.pod:4945
15389 msgid "guestfs_part_to_dev"
15394 #: ../src/guestfs-actions.pod:4947
15398 " guestfs_part_to_dev (guestfs_h *g,\n"
15399 " const char *partition);\n"
15405 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3310
15407 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15408 "partition number, returning the device name (eg. \"/dev/sdb\")."
15413 #: ../src/guestfs-actions.pod:4955
15415 "The named partition must exist, for example as a string returned from "
15416 "C<guestfs_list_partitions>."
15421 #: ../src/guestfs-actions.pod:4963
15422 msgid "guestfs_ping_daemon"
15427 #: ../src/guestfs-actions.pod:4965
15431 " guestfs_ping_daemon (guestfs_h *g);\n"
15437 #: ../src/guestfs-actions.pod:4968 ../fish/guestfish-actions.pod:3321
15439 "This is a test probe into the guestfs daemon running inside the qemu "
15440 "subprocess. Calling this function checks that the daemon responds to the "
15441 "ping message, without affecting the daemon or attached block device(s) in "
15447 #: ../src/guestfs-actions.pod:4977
15448 msgid "guestfs_pread"
15453 #: ../src/guestfs-actions.pod:4979
15457 " guestfs_pread (guestfs_h *g,\n"
15458 " const char *path,\n"
15460 " int64_t offset,\n"
15461 " size_t *size_r);\n"
15467 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3330
15469 "This command lets you read part of a file. It reads C<count> bytes of the "
15470 "file, starting at C<offset>, from file C<path>."
15475 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5015
15476 #: ../fish/guestfish-actions.pod:3333 ../fish/guestfish-actions.pod:3348
15478 "This may read fewer bytes than requested. For further details see the "
15479 "L<pread(2)> system call."
15484 #: ../src/guestfs-actions.pod:4992
15485 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15490 #: ../src/guestfs-actions.pod:5003
15491 msgid "guestfs_pread_device"
15496 #: ../src/guestfs-actions.pod:5005
15500 " guestfs_pread_device (guestfs_h *g,\n"
15501 " const char *device,\n"
15503 " int64_t offset,\n"
15504 " size_t *size_r);\n"
15510 #: ../src/guestfs-actions.pod:5012 ../fish/guestfish-actions.pod:3345
15512 "This command lets you read part of a file. It reads C<count> bytes of "
15513 "C<device>, starting at C<offset>."
15518 #: ../src/guestfs-actions.pod:5018
15519 msgid "See also C<guestfs_pread>."
15524 #: ../src/guestfs-actions.pod:5027
15525 msgid "(Added in 1.5.21)"
15530 #: ../src/guestfs-actions.pod:5029
15531 msgid "guestfs_pvcreate"
15536 #: ../src/guestfs-actions.pod:5031
15540 " guestfs_pvcreate (guestfs_h *g,\n"
15541 " const char *device);\n"
15547 #: ../src/guestfs-actions.pod:5035 ../fish/guestfish-actions.pod:3360
15549 "This creates an LVM physical volume on the named C<device>, where C<device> "
15550 "should usually be a partition name such as C</dev/sda1>."
15555 #: ../src/guestfs-actions.pod:5043
15556 msgid "guestfs_pvremove"
15561 #: ../src/guestfs-actions.pod:5045
15565 " guestfs_pvremove (guestfs_h *g,\n"
15566 " const char *device);\n"
15572 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3368
15574 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15580 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3371
15582 "The implementation uses the C<pvremove> command which refuses to wipe "
15583 "physical volumes that contain any volume groups, so you have to remove those "
15589 #: ../src/guestfs-actions.pod:5060
15590 msgid "guestfs_pvresize"
15595 #: ../src/guestfs-actions.pod:5062
15599 " guestfs_pvresize (guestfs_h *g,\n"
15600 " const char *device);\n"
15606 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3379
15608 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15609 "the new size of the underlying device."
15614 #: ../src/guestfs-actions.pod:5073
15615 msgid "guestfs_pvresize_size"
15620 #: ../src/guestfs-actions.pod:5075
15624 " guestfs_pvresize_size (guestfs_h *g,\n"
15625 " const char *device,\n"
15626 " int64_t size);\n"
15632 #: ../src/guestfs-actions.pod:5080
15634 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15635 "specify the new size (in bytes) explicitly."
15640 #: ../src/guestfs-actions.pod:5087
15641 msgid "guestfs_pvs"
15646 #: ../src/guestfs-actions.pod:5089
15650 " guestfs_pvs (guestfs_h *g);\n"
15656 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3393
15658 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15664 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3396
15666 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15672 #: ../src/guestfs-actions.pod:5098
15673 msgid "See also C<guestfs_pvs_full>."
15678 #: ../src/guestfs-actions.pod:5106
15679 msgid "guestfs_pvs_full"
15684 #: ../src/guestfs-actions.pod:5108
15687 " struct guestfs_lvm_pv_list *\n"
15688 " guestfs_pvs_full (guestfs_h *g);\n"
15694 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3405
15696 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15697 "(8)> command. The \"full\" version includes all fields."
15702 #: ../src/guestfs-actions.pod:5114
15704 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15705 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15710 #: ../src/guestfs-actions.pod:5120
15711 msgid "guestfs_pvuuid"
15716 #: ../src/guestfs-actions.pod:5122
15720 " guestfs_pvuuid (guestfs_h *g,\n"
15721 " const char *device);\n"
15727 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3412
15728 msgid "This command returns the UUID of the LVM PV C<device>."
15733 #: ../src/guestfs-actions.pod:5133
15734 msgid "guestfs_pwrite"
15739 #: ../src/guestfs-actions.pod:5135
15743 " guestfs_pwrite (guestfs_h *g,\n"
15744 " const char *path,\n"
15745 " const char *content,\n"
15746 " size_t content_size,\n"
15747 " int64_t offset);\n"
15753 #: ../src/guestfs-actions.pod:5142 ../fish/guestfish-actions.pod:3418
15755 "This command writes to part of a file. It writes the data buffer C<content> "
15756 "to the file C<path> starting at offset C<offset>."
15761 #: ../src/guestfs-actions.pod:5145 ../fish/guestfish-actions.pod:3421
15763 "This command implements the L<pwrite(2)> system call, and like that system "
15764 "call it may not write the full data requested. The return value is the "
15765 "number of bytes that were actually written to the file. This could even be "
15766 "0, although short writes are unlikely for regular files in ordinary "
15772 #: ../src/guestfs-actions.pod:5151
15773 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15778 #: ../src/guestfs-actions.pod:5160
15779 msgid "guestfs_pwrite_device"
15784 #: ../src/guestfs-actions.pod:5162
15788 " guestfs_pwrite_device (guestfs_h *g,\n"
15789 " const char *device,\n"
15790 " const char *content,\n"
15791 " size_t content_size,\n"
15792 " int64_t offset);\n"
15798 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3436
15800 "This command writes to part of a device. It writes the data buffer "
15801 "C<content> to C<device> starting at offset C<offset>."
15806 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3439
15808 "This command implements the L<pwrite(2)> system call, and like that system "
15809 "call it may not write the full data requested (although short writes to disk "
15810 "devices and partitions are probably impossible with standard Linux kernels)."
15815 #: ../src/guestfs-actions.pod:5177
15816 msgid "See also C<guestfs_pwrite>."
15821 #: ../src/guestfs-actions.pod:5184
15822 msgid "(Added in 1.5.20)"
15827 #: ../src/guestfs-actions.pod:5186
15828 msgid "guestfs_read_file"
15833 #: ../src/guestfs-actions.pod:5188
15837 " guestfs_read_file (guestfs_h *g,\n"
15838 " const char *path,\n"
15839 " size_t *size_r);\n"
15845 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3453
15846 msgid "This calls returns the contents of the file C<path> as a buffer."
15851 #: ../src/guestfs-actions.pod:5196
15853 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15854 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15855 "function is limited in the total size of file that can be handled."
15860 #: ../src/guestfs-actions.pod:5208
15861 msgid "(Added in 1.0.63)"
15866 #: ../src/guestfs-actions.pod:5210
15867 msgid "guestfs_read_lines"
15872 #: ../src/guestfs-actions.pod:5212
15876 " guestfs_read_lines (guestfs_h *g,\n"
15877 " const char *path);\n"
15883 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3470
15885 "The file contents are returned as a list of lines. Trailing C<LF> and "
15886 "C<CRLF> character sequences are I<not> returned."
15891 #: ../src/guestfs-actions.pod:5221
15893 "Note that this function cannot correctly handle binary files (specifically, "
15894 "files containing C<\\0> character which is treated as end of line). For "
15895 "those you need to use the C<guestfs_read_file> function which has a more "
15896 "complex interface."
15901 #: ../src/guestfs-actions.pod:5232
15902 msgid "guestfs_readdir"
15907 #: ../src/guestfs-actions.pod:5234
15910 " struct guestfs_dirent_list *\n"
15911 " guestfs_readdir (guestfs_h *g,\n"
15912 " const char *dir);\n"
15918 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3482
15919 msgid "This returns the list of directory entries in directory C<dir>."
15924 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3484
15926 "All entries in the directory are returned, including C<.> and C<..>. The "
15927 "entries are I<not> sorted, but returned in the same order as the underlying "
15933 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3488
15935 "Also this call returns basic file type information about each file. The "
15936 "C<ftyp> field will contain one of the following characters:"
15941 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3493
15947 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3495
15948 msgid "Block special"
15953 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3497
15959 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
15960 msgid "Char special"
15965 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3501
15971 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3503
15977 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3505
15983 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3507
15984 msgid "FIFO (named pipe)"
15989 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3509
15995 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3511
15996 msgid "Symbolic link"
16001 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3513
16007 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
16008 msgid "Regular file"
16013 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
16019 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3519
16025 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
16031 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3523
16032 msgid "Unknown file type"
16037 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3525
16043 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3527
16045 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16050 #: ../src/guestfs-actions.pod:5288
16052 "This function is primarily intended for use by programs. To get a simple "
16053 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16054 "consumption, use C<guestfs_ll>."
16059 #: ../src/guestfs-actions.pod:5292
16061 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16062 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16067 #: ../src/guestfs-actions.pod:5298
16068 msgid "guestfs_readlink"
16073 #: ../src/guestfs-actions.pod:5300
16077 " guestfs_readlink (guestfs_h *g,\n"
16078 " const char *path);\n"
16084 #: ../src/guestfs-actions.pod:5304 ../fish/guestfish-actions.pod:3540
16085 msgid "This command reads the target of a symbolic link."
16090 #: ../src/guestfs-actions.pod:5311
16091 msgid "guestfs_readlinklist"
16096 #: ../src/guestfs-actions.pod:5313
16100 " guestfs_readlinklist (guestfs_h *g,\n"
16101 " const char *path,\n"
16102 " char *const *names);\n"
16108 #: ../src/guestfs-actions.pod:5318 ../fish/guestfish-actions.pod:3546
16110 "This call allows you to do a C<readlink> operation on multiple files, where "
16111 "all files are in the directory C<path>. C<names> is the list of files from "
16117 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3550
16119 "On return you get a list of strings, with a one-to-one correspondence to the "
16120 "C<names> list. Each string is the value of the symbolic link."
16125 #: ../src/guestfs-actions.pod:5326 ../fish/guestfish-actions.pod:3554
16127 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16128 "result string is the empty string C<\"\">. However the whole operation is "
16129 "completed even if there were C<readlink(2)> errors, and so you can call this "
16130 "function with names where you don't know if they are symbolic links already "
16131 "(albeit slightly less efficient)."
16136 #: ../src/guestfs-actions.pod:5333 ../fish/guestfish-actions.pod:3561
16138 "This call is intended for programs that want to efficiently list a directory "
16139 "contents without making many round-trips. Very long directory listings "
16140 "might cause the protocol message size to be exceeded, causing this call to "
16141 "fail. The caller must split up such requests into smaller groups of names."
16146 #: ../src/guestfs-actions.pod:5346
16147 msgid "guestfs_realpath"
16152 #: ../src/guestfs-actions.pod:5348
16156 " guestfs_realpath (guestfs_h *g,\n"
16157 " const char *path);\n"
16163 #: ../src/guestfs-actions.pod:5352 ../fish/guestfish-actions.pod:3572
16165 "Return the canonicalized absolute pathname of C<path>. The returned path "
16166 "has no C<.>, C<..> or symbolic link path elements."
16171 #: ../src/guestfs-actions.pod:5360
16172 msgid "guestfs_removexattr"
16177 #: ../src/guestfs-actions.pod:5362
16181 " guestfs_removexattr (guestfs_h *g,\n"
16182 " const char *xattr,\n"
16183 " const char *path);\n"
16189 #: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3579
16191 "This call removes the extended attribute named C<xattr> of the file C<path>."
16196 #: ../src/guestfs-actions.pod:5370
16197 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16202 #: ../src/guestfs-actions.pod:5376
16203 msgid "guestfs_resize2fs"
16208 #: ../src/guestfs-actions.pod:5378
16212 " guestfs_resize2fs (guestfs_h *g,\n"
16213 " const char *device);\n"
16219 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3588
16221 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16222 "underlying device."
16227 #: ../src/guestfs-actions.pod:5385
16229 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16230 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16231 "sometimes gives an error about this and sometimes not. In any case, it is "
16232 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16237 #: ../src/guestfs-actions.pod:5395
16238 msgid "guestfs_resize2fs_size"
16243 #: ../src/guestfs-actions.pod:5397
16247 " guestfs_resize2fs_size (guestfs_h *g,\n"
16248 " const char *device,\n"
16249 " int64_t size);\n"
16255 #: ../src/guestfs-actions.pod:5402
16257 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16258 "to specify the new size (in bytes) explicitly."
16263 #: ../src/guestfs-actions.pod:5409
16269 #: ../src/guestfs-actions.pod:5411
16273 " guestfs_rm (guestfs_h *g,\n"
16274 " const char *path);\n"
16280 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3608
16281 msgid "Remove the single file C<path>."
16286 #: ../src/guestfs-actions.pod:5421
16287 msgid "guestfs_rm_rf"
16292 #: ../src/guestfs-actions.pod:5423
16296 " guestfs_rm_rf (guestfs_h *g,\n"
16297 " const char *path);\n"
16303 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3614
16305 "Remove the file or directory C<path>, recursively removing the contents if "
16306 "its a directory. This is like the C<rm -rf> shell command."
16311 #: ../src/guestfs-actions.pod:5435
16312 msgid "guestfs_rmdir"
16317 #: ../src/guestfs-actions.pod:5437
16321 " guestfs_rmdir (guestfs_h *g,\n"
16322 " const char *path);\n"
16328 #: ../src/guestfs-actions.pod:5441 ../fish/guestfish-actions.pod:3622
16329 msgid "Remove the single directory C<path>."
16334 #: ../src/guestfs-actions.pod:5447
16335 msgid "guestfs_rmmountpoint"
16340 #: ../src/guestfs-actions.pod:5449
16344 " guestfs_rmmountpoint (guestfs_h *g,\n"
16345 " const char *exemptpath);\n"
16351 #: ../src/guestfs-actions.pod:5453
16353 "This calls removes a mountpoint that was previously created with "
16354 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16359 #: ../src/guestfs-actions.pod:5461
16360 msgid "guestfs_scrub_device"
16365 #: ../src/guestfs-actions.pod:5463
16369 " guestfs_scrub_device (guestfs_h *g,\n"
16370 " const char *device);\n"
16376 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3636
16378 "This command writes patterns over C<device> to make data retrieval more "
16384 #: ../src/guestfs-actions.pod:5470 ../src/guestfs-actions.pod:5491
16385 #: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:3639
16386 #: ../fish/guestfish-actions.pod:3654 ../fish/guestfish-actions.pod:3667
16388 "It is an interface to the L<scrub(1)> program. See that manual page for "
16394 #: ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5496
16395 #: ../src/guestfs-actions.pod:5515
16396 msgid "(Added in 1.0.52)"
16401 #: ../src/guestfs-actions.pod:5480
16402 msgid "guestfs_scrub_file"
16407 #: ../src/guestfs-actions.pod:5482
16411 " guestfs_scrub_file (guestfs_h *g,\n"
16412 " const char *file);\n"
16418 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3649
16420 "This command writes patterns over a file to make data retrieval more "
16426 #: ../src/guestfs-actions.pod:5489 ../fish/guestfish-actions.pod:3652
16427 msgid "The file is I<removed> after scrubbing."
16432 #: ../src/guestfs-actions.pod:5498
16433 msgid "guestfs_scrub_freespace"
16438 #: ../src/guestfs-actions.pod:5500
16442 " guestfs_scrub_freespace (guestfs_h *g,\n"
16443 " const char *dir);\n"
16449 #: ../src/guestfs-actions.pod:5504
16451 "This command creates the directory C<dir> and then fills it with files until "
16452 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16453 "and deletes them. The intention is to scrub any free space on the partition "
16454 "containing C<dir>."
16459 #: ../src/guestfs-actions.pod:5517
16460 msgid "guestfs_set_append"
16465 #: ../src/guestfs-actions.pod:5519
16469 " guestfs_set_append (guestfs_h *g,\n"
16470 " const char *append);\n"
16476 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3676
16478 "This function is used to add additional options to the guest kernel command "
16484 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3679
16486 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16487 "environment variable."
16492 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3682
16494 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16495 "(libguestfs always adds a few of its own)."
16500 #: ../src/guestfs-actions.pod:5536
16501 msgid "guestfs_set_autosync"
16506 #: ../src/guestfs-actions.pod:5538
16510 " guestfs_set_autosync (guestfs_h *g,\n"
16511 " int autosync);\n"
16517 #: ../src/guestfs-actions.pod:5542
16519 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16520 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
16521 "the handle is closed (also if the program exits without closing handles)."
16526 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3696
16528 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16529 "disabled by default)."
16534 #: ../src/guestfs-actions.pod:5554
16535 msgid "guestfs_set_direct"
16540 #: ../src/guestfs-actions.pod:5556
16544 " guestfs_set_direct (guestfs_h *g,\n"
16551 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3705
16553 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16554 "passed directly through to the appliance once it is launched."
16559 #: ../src/guestfs-actions.pod:5564
16561 "One consequence of this is that log messages aren't caught by the library "
16562 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16568 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3713
16569 msgid "You probably don't want to use this unless you know what you are doing."
16574 #: ../src/guestfs-actions.pod:5571 ../fish/guestfish-actions.pod:3716
16575 msgid "The default is disabled."
16580 #: ../src/guestfs-actions.pod:5577
16581 msgid "guestfs_set_e2label"
16586 #: ../src/guestfs-actions.pod:5579
16590 " guestfs_set_e2label (guestfs_h *g,\n"
16591 " const char *device,\n"
16592 " const char *label);\n"
16598 #: ../src/guestfs-actions.pod:5584 ../fish/guestfish-actions.pod:3722
16600 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16601 "C<label>. Filesystem labels are limited to 16 characters."
16606 #: ../src/guestfs-actions.pod:5588
16608 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16609 "the existing label on a filesystem."
16614 #: ../src/guestfs-actions.pod:5595
16615 msgid "guestfs_set_e2uuid"
16620 #: ../src/guestfs-actions.pod:5597
16624 " guestfs_set_e2uuid (guestfs_h *g,\n"
16625 " const char *device,\n"
16626 " const char *uuid);\n"
16632 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3733
16634 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16635 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16636 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16641 #: ../src/guestfs-actions.pod:5607
16643 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16644 "the existing UUID of a filesystem."
16649 #: ../src/guestfs-actions.pod:5614
16650 msgid "guestfs_set_memsize"
16655 #: ../src/guestfs-actions.pod:5616
16659 " guestfs_set_memsize (guestfs_h *g,\n"
16666 #: ../src/guestfs-actions.pod:5620
16668 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16669 "This only has any effect if called before C<guestfs_launch>."
16674 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3751
16676 "You can also change this by setting the environment variable "
16677 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16682 #: ../src/guestfs-actions.pod:5635
16683 msgid "guestfs_set_network"
16688 #: ../src/guestfs-actions.pod:5637
16692 " guestfs_set_network (guestfs_h *g,\n"
16699 #: ../src/guestfs-actions.pod:5641 ../fish/guestfish-actions.pod:3764
16701 "If C<network> is true, then the network is enabled in the libguestfs "
16702 "appliance. The default is false."
16707 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:3767
16709 "This affects whether commands are able to access the network (see L<guestfs"
16710 "(3)/RUNNING COMMANDS>)."
16715 #: ../src/guestfs-actions.pod:5647
16717 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16723 #: ../src/guestfs-actions.pod:5654
16724 msgid "guestfs_set_path"
16729 #: ../src/guestfs-actions.pod:5656
16733 " guestfs_set_path (guestfs_h *g,\n"
16734 " const char *searchpath);\n"
16740 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3779
16741 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16746 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3781
16748 "The default is C<$libdir/guestfs> unless overridden by setting "
16749 "C<LIBGUESTFS_PATH> environment variable."
16754 #: ../src/guestfs-actions.pod:5665 ../fish/guestfish-actions.pod:3784
16755 msgid "Setting C<path> to C<NULL> restores the default path."
16760 #: ../src/guestfs-actions.pod:5671
16761 msgid "guestfs_set_qemu"
16766 #: ../src/guestfs-actions.pod:5673
16770 " guestfs_set_qemu (guestfs_h *g,\n"
16771 " const char *qemu);\n"
16777 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:3792
16778 msgid "Set the qemu binary that we will use."
16783 #: ../src/guestfs-actions.pod:5679 ../fish/guestfish-actions.pod:3794
16785 "The default is chosen when the library was compiled by the configure script."
16790 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3797
16792 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16798 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3800
16799 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16804 #: ../src/guestfs-actions.pod:5687 ../fish/guestfish-actions.pod:3802
16806 "Note that you should call this function as early as possible after creating "
16807 "the handle. This is because some pre-launch operations depend on testing "
16808 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16809 "don't retest features, and so you might see inconsistent results. Using the "
16810 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16811 "the qemu binary at the same time as the handle is created."
16816 #: ../src/guestfs-actions.pod:5699
16817 msgid "guestfs_set_recovery_proc"
16822 #: ../src/guestfs-actions.pod:5701
16826 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16827 " int recoveryproc);\n"
16833 #: ../src/guestfs-actions.pod:5705
16835 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16836 "not create a recovery process. The purpose of the recovery process is to "
16837 "stop runaway qemu processes in the case where the main program aborts "
16843 #: ../src/guestfs-actions.pod:5710
16845 "This only has any effect if called before C<guestfs_launch>, and the default "
16851 #: ../src/guestfs-actions.pod:5713 ../fish/guestfish-actions.pod:3824
16853 "About the only time when you would want to disable this is if the main "
16854 "process will fork itself into the background (\"daemonize\" itself). In "
16855 "this case the recovery process thinks that the main program has disappeared "
16856 "and so kills qemu, which is not very helpful."
16861 #: ../src/guestfs-actions.pod:5723
16862 msgid "guestfs_set_selinux"
16867 #: ../src/guestfs-actions.pod:5725
16871 " guestfs_set_selinux (guestfs_h *g,\n"
16878 #: ../src/guestfs-actions.pod:5729 ../fish/guestfish-actions.pod:3836
16880 "This sets the selinux flag that is passed to the appliance at boot time. "
16881 "The default is C<selinux=0> (disabled)."
16886 #: ../src/guestfs-actions.pod:5732 ../fish/guestfish-actions.pod:3839
16888 "Note that if SELinux is enabled, it is always in Permissive mode "
16889 "(C<enforcing=0>)."
16894 #: ../src/guestfs-actions.pod:5742
16895 msgid "guestfs_set_trace"
16900 #: ../src/guestfs-actions.pod:5744
16904 " guestfs_set_trace (guestfs_h *g,\n"
16911 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3851
16913 "If the command trace flag is set to 1, then commands are printed on stderr "
16914 "before they are executed in a format which is very similar to the one used "
16915 "by guestfish. In other words, you can run a program with this enabled, and "
16916 "you will get out a script which you can feed to guestfish to perform the "
16917 "same set of actions."
16922 #: ../src/guestfs-actions.pod:5755 ../fish/guestfish-actions.pod:3858
16924 "If you want to trace C API calls into libguestfs (and other libraries) then "
16925 "possibly a better way is to use the external ltrace(1) command."
16930 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3862
16932 "Command traces are disabled unless the environment variable "
16933 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16938 #: ../src/guestfs-actions.pod:5766
16939 msgid "guestfs_set_verbose"
16944 #: ../src/guestfs-actions.pod:5768
16948 " guestfs_set_verbose (guestfs_h *g,\n"
16955 #: ../src/guestfs-actions.pod:5772 ../fish/guestfish-actions.pod:3871
16956 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
16961 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3873
16963 "Verbose messages are disabled unless the environment variable "
16964 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16969 #: ../src/guestfs-actions.pod:5781
16970 msgid "guestfs_setcon"
16975 #: ../src/guestfs-actions.pod:5783
16979 " guestfs_setcon (guestfs_h *g,\n"
16980 " const char *context);\n"
16986 #: ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3880
16988 "This sets the SELinux security context of the daemon to the string "
16994 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3883
16995 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17000 #: ../src/guestfs-actions.pod:5796
17001 msgid "guestfs_setxattr"
17006 #: ../src/guestfs-actions.pod:5798
17010 " guestfs_setxattr (guestfs_h *g,\n"
17011 " const char *xattr,\n"
17012 " const char *val,\n"
17014 " const char *path);\n"
17020 #: ../src/guestfs-actions.pod:5805 ../fish/guestfish-actions.pod:3889
17022 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17023 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17028 #: ../src/guestfs-actions.pod:5809
17029 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17034 #: ../src/guestfs-actions.pod:5815
17035 msgid "guestfs_sfdisk"
17040 #: ../src/guestfs-actions.pod:5817
17044 " guestfs_sfdisk (guestfs_h *g,\n"
17045 " const char *device,\n"
17049 " char *const *lines);\n"
17055 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3899
17057 "This is a direct interface to the L<sfdisk(8)> program for creating "
17058 "partitions on block devices."
17063 #: ../src/guestfs-actions.pod:5828 ../fish/guestfish-actions.pod:3902
17064 msgid "C<device> should be a block device, for example C</dev/sda>."
17069 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3904
17071 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17072 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17073 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17074 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17075 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17076 "the kernel) cannot work out the right geometry and you will need to tell it."
17081 #: ../src/guestfs-actions.pod:5838 ../fish/guestfish-actions.pod:3912
17083 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17084 "refer to the L<sfdisk(8)> manpage."
17089 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3915
17091 "To create a single partition occupying the whole disk, you would pass "
17092 "C<lines> as a single element list, when the single element being the string "
17098 #: ../src/guestfs-actions.pod:5845
17100 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17105 #: ../src/guestfs-actions.pod:5855
17106 msgid "guestfs_sfdiskM"
17111 #: ../src/guestfs-actions.pod:5857
17115 " guestfs_sfdiskM (guestfs_h *g,\n"
17116 " const char *device,\n"
17117 " char *const *lines);\n"
17123 #: ../src/guestfs-actions.pod:5862
17125 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17126 "partition sizes are specified in megabytes only (rounded to the nearest "
17127 "cylinder) and you don't need to specify the cyls, heads and sectors "
17128 "parameters which were rarely if ever used anyway."
17133 #: ../src/guestfs-actions.pod:5868
17135 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17136 "C<guestfs_part_disk>"
17141 #: ../src/guestfs-actions.pod:5878
17142 msgid "guestfs_sfdisk_N"
17147 #: ../src/guestfs-actions.pod:5880
17151 " guestfs_sfdisk_N (guestfs_h *g,\n"
17152 " const char *device,\n"
17157 " const char *line);\n"
17163 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3945
17165 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17166 "(note: C<n> counts from 1)."
17171 #: ../src/guestfs-actions.pod:5892
17173 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17174 "for the cyls/heads/sectors parameters."
17179 #: ../src/guestfs-actions.pod:5895
17180 msgid "See also: C<guestfs_part_add>"
17185 #: ../src/guestfs-actions.pod:5904
17186 msgid "guestfs_sfdisk_disk_geometry"
17191 #: ../src/guestfs-actions.pod:5906
17195 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17196 " const char *device);\n"
17202 #: ../src/guestfs-actions.pod:5910
17204 "This displays the disk geometry of C<device> read from the partition table. "
17205 "Especially in the case where the underlying block device has been resized, "
17206 "this can be different from the kernel's idea of the geometry (see "
17207 "C<guestfs_sfdisk_kernel_geometry>)."
17212 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:5931
17213 #: ../fish/guestfish-actions.pod:3965 ../fish/guestfish-actions.pod:3974
17214 msgid "The result is in human-readable format, and not designed to be parsed."
17219 #: ../src/guestfs-actions.pod:5923
17220 msgid "guestfs_sfdisk_kernel_geometry"
17225 #: ../src/guestfs-actions.pod:5925
17229 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17230 " const char *device);\n"
17236 #: ../src/guestfs-actions.pod:5929 ../fish/guestfish-actions.pod:3972
17237 msgid "This displays the kernel's idea of the geometry of C<device>."
17242 #: ../src/guestfs-actions.pod:5939
17243 msgid "guestfs_sfdisk_l"
17248 #: ../src/guestfs-actions.pod:5941
17252 " guestfs_sfdisk_l (guestfs_h *g,\n"
17253 " const char *device);\n"
17259 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:3981
17261 "This displays the partition table on C<device>, in the human-readable output "
17262 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17267 #: ../src/guestfs-actions.pod:5949
17268 msgid "See also: C<guestfs_part_list>"
17273 #: ../src/guestfs-actions.pod:5956
17279 #: ../src/guestfs-actions.pod:5958
17283 " guestfs_sh (guestfs_h *g,\n"
17284 " const char *command);\n"
17290 #: ../src/guestfs-actions.pod:5962 ../fish/guestfish-actions.pod:3991
17292 "This call runs a command from the guest filesystem via the guest's C</bin/"
17298 #: ../src/guestfs-actions.pod:5965
17299 msgid "This is like C<guestfs_command>, but passes the command to:"
17304 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:3996
17307 " /bin/sh -c \"command\"\n"
17313 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:3998
17315 "Depending on the guest's shell, this usually results in wildcards being "
17316 "expanded, shell expressions being interpolated and so on."
17321 #: ../src/guestfs-actions.pod:5973
17322 msgid "All the provisos about C<guestfs_command> apply to this call."
17327 #: ../src/guestfs-actions.pod:5980
17328 msgid "guestfs_sh_lines"
17333 #: ../src/guestfs-actions.pod:5982
17337 " guestfs_sh_lines (guestfs_h *g,\n"
17338 " const char *command);\n"
17344 #: ../src/guestfs-actions.pod:5986
17346 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17352 #: ../src/guestfs-actions.pod:5989
17353 msgid "See also: C<guestfs_command_lines>"
17358 #: ../src/guestfs-actions.pod:5997
17359 msgid "guestfs_sleep"
17364 #: ../src/guestfs-actions.pod:5999
17368 " guestfs_sleep (guestfs_h *g,\n"
17375 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4017
17376 msgid "Sleep for C<secs> seconds."
17381 #: ../src/guestfs-actions.pod:6007
17382 msgid "(Added in 1.0.41)"
17387 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-structs.pod:109
17388 msgid "guestfs_stat"
17393 #: ../src/guestfs-actions.pod:6011
17396 " struct guestfs_stat *\n"
17397 " guestfs_stat (guestfs_h *g,\n"
17398 " const char *path);\n"
17404 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4025
17405 msgid "This is the same as the C<stat(2)> system call."
17410 #: ../src/guestfs-actions.pod:6025 ../src/guestfs-structs.pod:135
17411 msgid "guestfs_statvfs"
17416 #: ../src/guestfs-actions.pod:6027
17419 " struct guestfs_statvfs *\n"
17420 " guestfs_statvfs (guestfs_h *g,\n"
17421 " const char *path);\n"
17427 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4031
17429 "Returns file system statistics for any mounted file system. C<path> should "
17430 "be a file or directory in the mounted file system (typically it is the mount "
17431 "point itself, but it doesn't need to be)."
17436 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4035
17437 msgid "This is the same as the C<statvfs(2)> system call."
17442 #: ../src/guestfs-actions.pod:6037
17444 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17445 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17450 #: ../src/guestfs-actions.pod:6043
17451 msgid "guestfs_strings"
17456 #: ../src/guestfs-actions.pod:6045
17460 " guestfs_strings (guestfs_h *g,\n"
17461 " const char *path);\n"
17467 #: ../src/guestfs-actions.pod:6049 ../fish/guestfish-actions.pod:4041
17469 "This runs the L<strings(1)> command on a file and returns the list of "
17470 "printable strings found."
17475 #: ../src/guestfs-actions.pod:6061
17476 msgid "guestfs_strings_e"
17481 #: ../src/guestfs-actions.pod:6063
17485 " guestfs_strings_e (guestfs_h *g,\n"
17486 " const char *encoding,\n"
17487 " const char *path);\n"
17493 #: ../src/guestfs-actions.pod:6068
17495 "This is like the C<guestfs_strings> command, but allows you to specify the "
17496 "encoding of strings that are looked for in the source file C<path>."
17501 #: ../src/guestfs-actions.pod:6072 ../fish/guestfish-actions.pod:4055
17502 msgid "Allowed encodings are:"
17507 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4059
17513 #: ../src/guestfs-actions.pod:6078
17515 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17516 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17521 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4064
17527 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4066
17528 msgid "Single 8-bit-byte characters."
17533 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4068
17539 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
17540 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17545 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4073
17546 msgid "l (lower case letter L)"
17551 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4075
17553 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17554 "examining binaries in Windows guests."
17559 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4078
17565 #: ../src/guestfs-actions.pod:6097 ../fish/guestfish-actions.pod:4080
17566 msgid "32-bit big endian such as UCS-4BE."
17571 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4082
17577 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4084
17578 msgid "32-bit little endian such as UCS-4LE."
17583 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4088
17584 msgid "The returned strings are transcoded to UTF-8."
17589 #: ../src/guestfs-actions.pod:6116
17590 msgid "guestfs_swapoff_device"
17595 #: ../src/guestfs-actions.pod:6118
17599 " guestfs_swapoff_device (guestfs_h *g,\n"
17600 " const char *device);\n"
17606 #: ../src/guestfs-actions.pod:6122
17608 "This command disables the libguestfs appliance swap device or partition "
17609 "named C<device>. See C<guestfs_swapon_device>."
17614 #: ../src/guestfs-actions.pod:6130
17615 msgid "guestfs_swapoff_file"
17620 #: ../src/guestfs-actions.pod:6132
17624 " guestfs_swapoff_file (guestfs_h *g,\n"
17625 " const char *file);\n"
17631 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4105
17632 msgid "This command disables the libguestfs appliance swap on file."
17637 #: ../src/guestfs-actions.pod:6142
17638 msgid "guestfs_swapoff_label"
17643 #: ../src/guestfs-actions.pod:6144
17647 " guestfs_swapoff_label (guestfs_h *g,\n"
17648 " const char *label);\n"
17654 #: ../src/guestfs-actions.pod:6148 ../fish/guestfish-actions.pod:4111
17656 "This command disables the libguestfs appliance swap on labeled swap "
17662 #: ../src/guestfs-actions.pod:6155
17663 msgid "guestfs_swapoff_uuid"
17668 #: ../src/guestfs-actions.pod:6157
17672 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17673 " const char *uuid);\n"
17679 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4118
17681 "This command disables the libguestfs appliance swap partition with the given "
17687 #: ../src/guestfs-actions.pod:6168
17688 msgid "guestfs_swapon_device"
17693 #: ../src/guestfs-actions.pod:6170
17697 " guestfs_swapon_device (guestfs_h *g,\n"
17698 " const char *device);\n"
17704 #: ../src/guestfs-actions.pod:6174
17706 "This command enables the libguestfs appliance to use the swap device or "
17707 "partition named C<device>. The increased memory is made available for all "
17708 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17713 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4130
17715 "Note that you should not swap to existing guest swap partitions unless you "
17716 "know what you are doing. They may contain hibernation information, or other "
17717 "information that the guest doesn't want you to trash. You also risk leaking "
17718 "information about the host to the guest this way. Instead, attach a new "
17719 "host device to the guest and swap on that."
17724 #: ../src/guestfs-actions.pod:6190
17725 msgid "guestfs_swapon_file"
17730 #: ../src/guestfs-actions.pod:6192
17734 " guestfs_swapon_file (guestfs_h *g,\n"
17735 " const char *file);\n"
17741 #: ../src/guestfs-actions.pod:6196
17743 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17749 #: ../src/guestfs-actions.pod:6203
17750 msgid "guestfs_swapon_label"
17755 #: ../src/guestfs-actions.pod:6205
17759 " guestfs_swapon_label (guestfs_h *g,\n"
17760 " const char *label);\n"
17766 #: ../src/guestfs-actions.pod:6209
17768 "This command enables swap to a labeled swap partition. See "
17769 "C<guestfs_swapon_device> for other notes."
17774 #: ../src/guestfs-actions.pod:6216
17775 msgid "guestfs_swapon_uuid"
17780 #: ../src/guestfs-actions.pod:6218
17784 " guestfs_swapon_uuid (guestfs_h *g,\n"
17785 " const char *uuid);\n"
17791 #: ../src/guestfs-actions.pod:6222
17793 "This command enables swap to a swap partition with the given UUID. See "
17794 "C<guestfs_swapon_device> for other notes."
17799 #: ../src/guestfs-actions.pod:6229
17800 msgid "guestfs_sync"
17805 #: ../src/guestfs-actions.pod:6231
17809 " guestfs_sync (guestfs_h *g);\n"
17815 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4162
17817 "This syncs the disk, so that any writes are flushed through to the "
17818 "underlying disk image."
17823 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4165
17825 "You should always call this if you have modified a disk image, before "
17826 "closing the handle."
17831 #: ../src/guestfs-actions.pod:6244
17832 msgid "guestfs_tail"
17837 #: ../src/guestfs-actions.pod:6246
17841 " guestfs_tail (guestfs_h *g,\n"
17842 " const char *path);\n"
17848 #: ../src/guestfs-actions.pod:6250 ../fish/guestfish-actions.pod:4172
17850 "This command returns up to the last 10 lines of a file as a list of strings."
17855 #: ../src/guestfs-actions.pod:6262
17856 msgid "guestfs_tail_n"
17861 #: ../src/guestfs-actions.pod:6264
17865 " guestfs_tail_n (guestfs_h *g,\n"
17867 " const char *path);\n"
17873 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4182
17875 "If the parameter C<nrlines> is a positive number, this returns the last "
17876 "C<nrlines> lines of the file C<path>."
17881 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4185
17883 "If the parameter C<nrlines> is a negative number, this returns lines from "
17884 "the file C<path>, starting with the C<-nrlines>th line."
17889 #: ../src/guestfs-actions.pod:6286
17890 msgid "guestfs_tar_in"
17895 #: ../src/guestfs-actions.pod:6288
17899 " guestfs_tar_in (guestfs_h *g,\n"
17900 " const char *tarfile,\n"
17901 " const char *directory);\n"
17907 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4197
17909 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17910 "tar file) into C<directory>."
17915 #: ../src/guestfs-actions.pod:6296
17917 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17922 #: ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6318
17923 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6350
17924 msgid "(Added in 1.0.3)"
17929 #: ../src/guestfs-actions.pod:6303
17930 msgid "guestfs_tar_out"
17935 #: ../src/guestfs-actions.pod:6305
17939 " guestfs_tar_out (guestfs_h *g,\n"
17940 " const char *directory,\n"
17941 " const char *tarfile);\n"
17947 #: ../src/guestfs-actions.pod:6310 ../fish/guestfish-actions.pod:4209
17949 "This command packs the contents of C<directory> and downloads it to local "
17955 #: ../src/guestfs-actions.pod:6313
17957 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17958 "C<guestfs_txz_out>."
17963 #: ../src/guestfs-actions.pod:6320
17964 msgid "guestfs_tgz_in"
17969 #: ../src/guestfs-actions.pod:6322
17973 " guestfs_tgz_in (guestfs_h *g,\n"
17974 " const char *tarball,\n"
17975 " const char *directory);\n"
17981 #: ../src/guestfs-actions.pod:6327 ../fish/guestfish-actions.pod:4221
17983 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17984 "tar file) into C<directory>."
17989 #: ../src/guestfs-actions.pod:6330
17990 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17995 #: ../src/guestfs-actions.pod:6336
17996 msgid "guestfs_tgz_out"
18001 #: ../src/guestfs-actions.pod:6338
18005 " guestfs_tgz_out (guestfs_h *g,\n"
18006 " const char *directory,\n"
18007 " const char *tarball);\n"
18013 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4232
18015 "This command packs the contents of C<directory> and downloads it to local "
18021 #: ../src/guestfs-actions.pod:6346
18022 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18027 #: ../src/guestfs-actions.pod:6352
18028 msgid "guestfs_touch"
18033 #: ../src/guestfs-actions.pod:6354
18037 " guestfs_touch (guestfs_h *g,\n"
18038 " const char *path);\n"
18044 #: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4243
18046 "Touch acts like the L<touch(1)> command. It can be used to update the "
18047 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18053 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4247
18055 "This command only works on regular files, and will fail on other file types "
18056 "such as directories, symbolic links, block special etc."
18061 #: ../src/guestfs-actions.pod:6369
18062 msgid "guestfs_truncate"
18067 #: ../src/guestfs-actions.pod:6371
18071 " guestfs_truncate (guestfs_h *g,\n"
18072 " const char *path);\n"
18078 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4254
18080 "This command truncates C<path> to a zero-length file. The file must exist "
18086 #: ../src/guestfs-actions.pod:6382
18087 msgid "guestfs_truncate_size"
18092 #: ../src/guestfs-actions.pod:6384
18096 " guestfs_truncate_size (guestfs_h *g,\n"
18097 " const char *path,\n"
18098 " int64_t size);\n"
18104 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4261
18106 "This command truncates C<path> to size C<size> bytes. The file must exist "
18112 #: ../src/guestfs-actions.pod:6392
18114 "If the current file size is less than C<size> then the file is extended to "
18115 "the required size with zero bytes. This creates a sparse file (ie. disk "
18116 "blocks are not allocated for the file until you write to it). To create a "
18117 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18122 #: ../src/guestfs-actions.pod:6402
18123 msgid "guestfs_tune2fs_l"
18128 #: ../src/guestfs-actions.pod:6404
18132 " guestfs_tune2fs_l (guestfs_h *g,\n"
18133 " const char *device);\n"
18139 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4274
18141 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18147 #: ../src/guestfs-actions.pod:6411 ../fish/guestfish-actions.pod:4277
18149 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18150 "for more details. The list of fields returned isn't clearly defined, and "
18151 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18152 "and the filesystem itself."
18157 #: ../src/guestfs-actions.pod:6424
18158 msgid "guestfs_txz_in"
18163 #: ../src/guestfs-actions.pod:6426
18167 " guestfs_txz_in (guestfs_h *g,\n"
18168 " const char *tarball,\n"
18169 " const char *directory);\n"
18175 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4286
18177 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18178 "tar file) into C<directory>."
18183 #: ../src/guestfs-actions.pod:6438
18184 msgid "guestfs_txz_out"
18189 #: ../src/guestfs-actions.pod:6440
18193 " guestfs_txz_out (guestfs_h *g,\n"
18194 " const char *directory,\n"
18195 " const char *tarball);\n"
18201 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4295
18203 "This command packs the contents of C<directory> and downloads it to local "
18204 "file C<tarball> (as an xz compressed tar archive)."
18209 #: ../src/guestfs-actions.pod:6452
18210 msgid "guestfs_umask"
18215 #: ../src/guestfs-actions.pod:6454
18219 " guestfs_umask (guestfs_h *g,\n"
18226 #: ../src/guestfs-actions.pod:6458 ../fish/guestfish-actions.pod:4304
18228 "This function sets the mask used for creating new files and device nodes to "
18234 #: ../src/guestfs-actions.pod:6461 ../fish/guestfish-actions.pod:4307
18236 "Typical umask values would be C<022> which creates new files with "
18237 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18238 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18243 #: ../src/guestfs-actions.pod:6466 ../fish/guestfish-actions.pod:4312
18245 "The default umask is C<022>. This is important because it means that "
18246 "directories and device nodes will be created with C<0644> or C<0755> mode "
18247 "even if you specify C<0777>."
18252 #: ../src/guestfs-actions.pod:6470
18254 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18255 "C<guestfs_mkdir>."
18260 #: ../src/guestfs-actions.pod:6473 ../fish/guestfish-actions.pod:4319
18261 msgid "This call returns the previous umask."
18266 #: ../src/guestfs-actions.pod:6479
18267 msgid "guestfs_umount"
18272 #: ../src/guestfs-actions.pod:6481
18276 " guestfs_umount (guestfs_h *g,\n"
18277 " const char *pathordevice);\n"
18283 #: ../src/guestfs-actions.pod:6485 ../fish/guestfish-actions.pod:4327
18285 "This unmounts the given filesystem. The filesystem may be specified either "
18286 "by its mountpoint (path) or the device which contains the filesystem."
18291 #: ../src/guestfs-actions.pod:6493
18292 msgid "guestfs_umount_all"
18297 #: ../src/guestfs-actions.pod:6495
18301 " guestfs_umount_all (guestfs_h *g);\n"
18307 #: ../src/guestfs-actions.pod:6498 ../fish/guestfish-actions.pod:4337
18308 msgid "This unmounts all mounted filesystems."
18313 #: ../src/guestfs-actions.pod:6500 ../fish/guestfish-actions.pod:4339
18314 msgid "Some internal mounts are not unmounted by this call."
18319 #: ../src/guestfs-actions.pod:6506
18320 msgid "guestfs_upload"
18325 #: ../src/guestfs-actions.pod:6508
18329 " guestfs_upload (guestfs_h *g,\n"
18330 " const char *filename,\n"
18331 " const char *remotefilename);\n"
18337 #: ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6537
18338 #: ../fish/guestfish-actions.pod:4345 ../fish/guestfish-actions.pod:4358
18339 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18344 #: ../src/guestfs-actions.pod:6518
18345 msgid "See also C<guestfs_download>."
18350 #: ../src/guestfs-actions.pod:6529
18351 msgid "guestfs_upload_offset"
18356 #: ../src/guestfs-actions.pod:6531
18360 " guestfs_upload_offset (guestfs_h *g,\n"
18361 " const char *filename,\n"
18362 " const char *remotefilename,\n"
18363 " int64_t offset);\n"
18369 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4361
18371 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18372 "The intention is to overwrite parts of existing files or devices, although "
18373 "if a non-existant file is specified then it is created with a \"hole\" "
18374 "before C<offset>. The size of the data written is implicit in the size of "
18375 "the source C<filename>."
18380 #: ../src/guestfs-actions.pod:6547
18382 "Note that there is no limit on the amount of data that can be uploaded with "
18383 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18384 "full amount unless an error occurs."
18389 #: ../src/guestfs-actions.pod:6552
18390 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18395 #: ../src/guestfs-actions.pod:6563
18396 msgid "guestfs_utimens"
18401 #: ../src/guestfs-actions.pod:6565
18405 " guestfs_utimens (guestfs_h *g,\n"
18406 " const char *path,\n"
18407 " int64_t atsecs,\n"
18408 " int64_t atnsecs,\n"
18409 " int64_t mtsecs,\n"
18410 " int64_t mtnsecs);\n"
18416 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4381
18417 msgid "This command sets the timestamps of a file with nanosecond precision."
18422 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4384
18424 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18430 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4387
18432 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18433 "nanoseconds from the epoch."
18438 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4390
18440 "If the C<*nsecs> field contains the special value C<-1> then the "
18441 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18442 "ignored in this case)."
18447 #: ../src/guestfs-actions.pod:6586 ../fish/guestfish-actions.pod:4394
18449 "If the C<*nsecs> field contains the special value C<-2> then the "
18450 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18456 #: ../src/guestfs-actions.pod:6594 ../src/guestfs-structs.pod:175
18457 msgid "guestfs_version"
18462 #: ../src/guestfs-actions.pod:6596
18465 " struct guestfs_version *\n"
18466 " guestfs_version (guestfs_h *g);\n"
18472 #: ../src/guestfs-actions.pod:6599 ../fish/guestfish-actions.pod:4402
18474 "Return the libguestfs version number that the program is linked against."
18479 #: ../src/guestfs-actions.pod:6602 ../fish/guestfish-actions.pod:4405
18481 "Note that because of dynamic linking this is not necessarily the version of "
18482 "libguestfs that you compiled against. You can compile the program, and then "
18483 "at runtime dynamically link against a completely different C<libguestfs.so> "
18489 #: ../src/guestfs-actions.pod:6607 ../fish/guestfish-actions.pod:4410
18491 "This call was added in version C<1.0.58>. In previous versions of "
18492 "libguestfs there was no way to get the version number. From C code you can "
18493 "use dynamic linker functions to find out if this symbol exists (if it "
18494 "doesn't, then it's an earlier version)."
18499 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
18501 "The call returns a structure with four elements. The first three (C<major>, "
18502 "C<minor> and C<release>) are numbers and correspond to the usual version "
18503 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18504 "but may be used for distro-specific information."
18509 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4422
18511 "To construct the original version string: C<$major.$minor.$release$extra>"
18516 #: ../src/guestfs-actions.pod:6622 ../fish/guestfish-actions.pod:4425
18517 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18522 #: ../src/guestfs-actions.pod:6624
18524 "I<Note:> Don't use this call to test for availability of features. In "
18525 "enterprise distributions we backport features from later versions into "
18526 "earlier versions, making this an unreliable way to test for features. Use "
18527 "C<guestfs_available> instead."
18532 #: ../src/guestfs-actions.pod:6630
18534 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18535 "error. I<The caller must call C<guestfs_free_version> after use>."
18540 #: ../src/guestfs-actions.pod:6634
18541 msgid "(Added in 1.0.58)"
18546 #: ../src/guestfs-actions.pod:6636
18547 msgid "guestfs_vfs_label"
18552 #: ../src/guestfs-actions.pod:6638
18556 " guestfs_vfs_label (guestfs_h *g,\n"
18557 " const char *device);\n"
18563 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4437
18564 msgid "This returns the filesystem label of the filesystem on C<device>."
18569 #: ../src/guestfs-actions.pod:6645 ../fish/guestfish-actions.pod:4440
18570 msgid "If the filesystem is unlabeled, this returns the empty string."
18575 #: ../src/guestfs-actions.pod:6647
18576 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18581 #: ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:6689
18582 msgid "(Added in 1.3.18)"
18587 #: ../src/guestfs-actions.pod:6654
18588 msgid "guestfs_vfs_type"
18593 #: ../src/guestfs-actions.pod:6656
18597 " guestfs_vfs_type (guestfs_h *g,\n"
18598 " const char *device);\n"
18604 #: ../src/guestfs-actions.pod:6660 ../fish/guestfish-actions.pod:4448
18606 "This command gets the filesystem type corresponding to the filesystem on "
18612 #: ../src/guestfs-actions.pod:6663 ../fish/guestfish-actions.pod:4451
18614 "For most filesystems, the result is the name of the Linux VFS module which "
18615 "would be used to mount this filesystem if you mounted it without specifying "
18616 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18621 #: ../src/guestfs-actions.pod:6673
18622 msgid "guestfs_vfs_uuid"
18627 #: ../src/guestfs-actions.pod:6675
18631 " guestfs_vfs_uuid (guestfs_h *g,\n"
18632 " const char *device);\n"
18638 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4460
18639 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18644 #: ../src/guestfs-actions.pod:6682 ../fish/guestfish-actions.pod:4463
18645 msgid "If the filesystem does not have a UUID, this returns the empty string."
18650 #: ../src/guestfs-actions.pod:6684
18651 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18656 #: ../src/guestfs-actions.pod:6691
18657 msgid "guestfs_vg_activate"
18662 #: ../src/guestfs-actions.pod:6693
18666 " guestfs_vg_activate (guestfs_h *g,\n"
18668 " char *const *volgroups);\n"
18674 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4471
18676 "This command activates or (if C<activate> is false) deactivates all logical "
18677 "volumes in the listed volume groups C<volgroups>. If activated, then they "
18678 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
18679 "deactivated, then those devices disappear."
18684 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4477
18685 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18690 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4479
18692 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18693 "activated or deactivated."
18698 #: ../src/guestfs-actions.pod:6713
18699 msgid "guestfs_vg_activate_all"
18704 #: ../src/guestfs-actions.pod:6715
18708 " guestfs_vg_activate_all (guestfs_h *g,\n"
18709 " int activate);\n"
18715 #: ../src/guestfs-actions.pod:6719 ../fish/guestfish-actions.pod:4486
18717 "This command activates or (if C<activate> is false) deactivates all logical "
18718 "volumes in all volume groups. If activated, then they are made known to the "
18719 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
18720 "those devices disappear."
18725 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4492
18726 msgid "This command is the same as running C<vgchange -a y|n>"
18731 #: ../src/guestfs-actions.pod:6731
18732 msgid "guestfs_vgcreate"
18737 #: ../src/guestfs-actions.pod:6733
18741 " guestfs_vgcreate (guestfs_h *g,\n"
18742 " const char *volgroup,\n"
18743 " char *const *physvols);\n"
18749 #: ../src/guestfs-actions.pod:6738 ../fish/guestfish-actions.pod:4498
18751 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18752 "of physical volumes C<physvols>."
18757 #: ../src/guestfs-actions.pod:6745
18758 msgid "guestfs_vglvuuids"
18763 #: ../src/guestfs-actions.pod:6747
18767 " guestfs_vglvuuids (guestfs_h *g,\n"
18768 " const char *vgname);\n"
18774 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4505
18776 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18777 "volumes created in this volume group."
18782 #: ../src/guestfs-actions.pod:6754
18784 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18785 "associate logical volumes and volume groups."
18790 #: ../src/guestfs-actions.pod:6757
18791 msgid "See also C<guestfs_vgpvuuids>."
18796 #: ../src/guestfs-actions.pod:6765
18797 msgid "guestfs_vgpvuuids"
18802 #: ../src/guestfs-actions.pod:6767
18806 " guestfs_vgpvuuids (guestfs_h *g,\n"
18807 " const char *vgname);\n"
18813 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4517
18815 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18816 "volumes that this volume group resides on."
18821 #: ../src/guestfs-actions.pod:6774
18823 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18824 "associate physical volumes and volume groups."
18829 #: ../src/guestfs-actions.pod:6777
18830 msgid "See also C<guestfs_vglvuuids>."
18835 #: ../src/guestfs-actions.pod:6785
18836 msgid "guestfs_vgremove"
18841 #: ../src/guestfs-actions.pod:6787
18845 " guestfs_vgremove (guestfs_h *g,\n"
18846 " const char *vgname);\n"
18852 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4529
18853 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18858 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4531
18860 "This also forcibly removes all logical volumes in the volume group (if any)."
18865 #: ../src/guestfs-actions.pod:6800
18866 msgid "guestfs_vgrename"
18871 #: ../src/guestfs-actions.pod:6802
18875 " guestfs_vgrename (guestfs_h *g,\n"
18876 " const char *volgroup,\n"
18877 " const char *newvolgroup);\n"
18883 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4538
18884 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18889 #: ../src/guestfs-actions.pod:6813
18890 msgid "guestfs_vgs"
18895 #: ../src/guestfs-actions.pod:6815
18899 " guestfs_vgs (guestfs_h *g);\n"
18905 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4544
18907 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18913 #: ../src/guestfs-actions.pod:6821 ../fish/guestfish-actions.pod:4547
18915 "This returns a list of just the volume group names that were detected (eg. "
18921 #: ../src/guestfs-actions.pod:6824
18922 msgid "See also C<guestfs_vgs_full>."
18927 #: ../src/guestfs-actions.pod:6832
18928 msgid "guestfs_vgs_full"
18933 #: ../src/guestfs-actions.pod:6834
18936 " struct guestfs_lvm_vg_list *\n"
18937 " guestfs_vgs_full (guestfs_h *g);\n"
18943 #: ../src/guestfs-actions.pod:6837 ../fish/guestfish-actions.pod:4556
18945 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18946 "> command. The \"full\" version includes all fields."
18951 #: ../src/guestfs-actions.pod:6840
18953 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18954 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18959 #: ../src/guestfs-actions.pod:6846
18960 msgid "guestfs_vgscan"
18965 #: ../src/guestfs-actions.pod:6848
18969 " guestfs_vgscan (guestfs_h *g);\n"
18975 #: ../src/guestfs-actions.pod:6851 ../fish/guestfish-actions.pod:4563
18977 "This rescans all block devices and rebuilds the list of LVM physical "
18978 "volumes, volume groups and logical volumes."
18983 #: ../src/guestfs-actions.pod:6858
18984 msgid "guestfs_vguuid"
18989 #: ../src/guestfs-actions.pod:6860
18993 " guestfs_vguuid (guestfs_h *g,\n"
18994 " const char *vgname);\n"
19000 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4570
19001 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19006 #: ../src/guestfs-actions.pod:6871
19007 msgid "guestfs_wait_ready"
19012 #: ../src/guestfs-actions.pod:6873
19016 " guestfs_wait_ready (guestfs_h *g);\n"
19022 #: ../src/guestfs-actions.pod:6876
19023 msgid "This function is a no op."
19028 #: ../src/guestfs-actions.pod:6878
19030 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19031 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19032 "is no longer necessary because C<guestfs_launch> now does the waiting."
19037 #: ../src/guestfs-actions.pod:6883
19039 "If you see any calls to this function in code then you can just remove them, "
19040 "unless you want to retain compatibility with older versions of the API."
19045 #: ../src/guestfs-actions.pod:6891
19046 msgid "guestfs_wc_c"
19051 #: ../src/guestfs-actions.pod:6893
19055 " guestfs_wc_c (guestfs_h *g,\n"
19056 " const char *path);\n"
19062 #: ../src/guestfs-actions.pod:6897 ../fish/guestfish-actions.pod:4576
19064 "This command counts the characters in a file, using the C<wc -c> external "
19070 #: ../src/guestfs-actions.pod:6904
19071 msgid "guestfs_wc_l"
19076 #: ../src/guestfs-actions.pod:6906
19080 " guestfs_wc_l (guestfs_h *g,\n"
19081 " const char *path);\n"
19087 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4583
19089 "This command counts the lines in a file, using the C<wc -l> external command."
19094 #: ../src/guestfs-actions.pod:6917
19095 msgid "guestfs_wc_w"
19100 #: ../src/guestfs-actions.pod:6919
19104 " guestfs_wc_w (guestfs_h *g,\n"
19105 " const char *path);\n"
19111 #: ../src/guestfs-actions.pod:6923 ../fish/guestfish-actions.pod:4590
19113 "This command counts the words in a file, using the C<wc -w> external command."
19118 #: ../src/guestfs-actions.pod:6930
19119 msgid "guestfs_write"
19124 #: ../src/guestfs-actions.pod:6932
19128 " guestfs_write (guestfs_h *g,\n"
19129 " const char *path,\n"
19130 " const char *content,\n"
19131 " size_t content_size);\n"
19137 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4597
19139 "This call creates a file called C<path>. The content of the file is the "
19140 "string C<content> (which can contain any 8 bit data)."
19145 #: ../src/guestfs-actions.pod:6948
19146 msgid "guestfs_write_file"
19151 #: ../src/guestfs-actions.pod:6950
19155 " guestfs_write_file (guestfs_h *g,\n"
19156 " const char *path,\n"
19157 " const char *content,\n"
19164 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4607
19166 "This call creates a file called C<path>. The contents of the file is the "
19167 "string C<content> (which can contain any 8 bit data), with length C<size>."
19172 #: ../src/guestfs-actions.pod:6960 ../fish/guestfish-actions.pod:4611
19174 "As a special case, if C<size> is C<0> then the length is calculated using "
19175 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19180 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4615
19182 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19183 "I<not> work, even if the length is specified."
19188 #: ../src/guestfs-actions.pod:6972 ../fish/guestfish-actions.pod:4621
19190 "This function is deprecated. In new code, use the C<write> call instead."
19195 #: ../src/guestfs-actions.pod:6981
19196 msgid "guestfs_zegrep"
19201 #: ../src/guestfs-actions.pod:6983
19205 " guestfs_zegrep (guestfs_h *g,\n"
19206 " const char *regex,\n"
19207 " const char *path);\n"
19213 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4632
19215 "This calls the external C<zegrep> program and returns the matching lines."
19220 #: ../src/guestfs-actions.pod:7000
19221 msgid "guestfs_zegrepi"
19226 #: ../src/guestfs-actions.pod:7002
19230 " guestfs_zegrepi (guestfs_h *g,\n"
19231 " const char *regex,\n"
19232 " const char *path);\n"
19238 #: ../src/guestfs-actions.pod:7007 ../fish/guestfish-actions.pod:4642
19240 "This calls the external C<zegrep -i> program and returns the matching lines."
19245 #: ../src/guestfs-actions.pod:7019
19246 msgid "guestfs_zero"
19251 #: ../src/guestfs-actions.pod:7021
19255 " guestfs_zero (guestfs_h *g,\n"
19256 " const char *device);\n"
19262 #: ../src/guestfs-actions.pod:7025 ../fish/guestfish-actions.pod:4652
19263 msgid "This command writes zeroes over the first few blocks of C<device>."
19268 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4654
19270 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19271 "securely wipe the device). It should be sufficient to remove any partition "
19272 "tables, filesystem superblocks and so on."
19277 #: ../src/guestfs-actions.pod:7031
19278 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
19283 #: ../src/guestfs-actions.pod:7042
19284 msgid "guestfs_zero_device"
19289 #: ../src/guestfs-actions.pod:7044
19293 " guestfs_zero_device (guestfs_h *g,\n"
19294 " const char *device);\n"
19300 #: ../src/guestfs-actions.pod:7048
19302 "This command writes zeroes over the entire C<device>. Compare with "
19303 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19308 #: ../src/guestfs-actions.pod:7062
19309 msgid "(Added in 1.3.1)"
19314 #: ../src/guestfs-actions.pod:7064
19315 msgid "guestfs_zerofree"
19320 #: ../src/guestfs-actions.pod:7066
19324 " guestfs_zerofree (guestfs_h *g,\n"
19325 " const char *device);\n"
19331 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4675
19333 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19334 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19335 "possible to compress the filesystem more effectively."
19340 #: ../src/guestfs-actions.pod:7075 ../fish/guestfish-actions.pod:4680
19341 msgid "You should B<not> run this program if the filesystem is mounted."
19346 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4683
19348 "It is possible that using this program can damage the filesystem or data on "
19354 #: ../src/guestfs-actions.pod:7085
19355 msgid "guestfs_zfgrep"
19360 #: ../src/guestfs-actions.pod:7087
19364 " guestfs_zfgrep (guestfs_h *g,\n"
19365 " const char *pattern,\n"
19366 " const char *path);\n"
19372 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4690
19374 "This calls the external C<zfgrep> program and returns the matching lines."
19379 #: ../src/guestfs-actions.pod:7104
19380 msgid "guestfs_zfgrepi"
19385 #: ../src/guestfs-actions.pod:7106
19389 " guestfs_zfgrepi (guestfs_h *g,\n"
19390 " const char *pattern,\n"
19391 " const char *path);\n"
19397 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4700
19399 "This calls the external C<zfgrep -i> program and returns the matching lines."
19404 #: ../src/guestfs-actions.pod:7123
19405 msgid "guestfs_zfile"
19410 #: ../src/guestfs-actions.pod:7125
19414 " guestfs_zfile (guestfs_h *g,\n"
19415 " const char *meth,\n"
19416 " const char *path);\n"
19422 #: ../src/guestfs-actions.pod:7130 ../fish/guestfish-actions.pod:4710
19424 "This command runs C<file> after first decompressing C<path> using C<method>."
19429 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4713
19430 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19435 #: ../src/guestfs-actions.pod:7135
19437 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19443 #: ../src/guestfs-actions.pod:7141 ../fish/guestfish-actions.pod:4718
19445 "This function is deprecated. In new code, use the C<file> call instead."
19450 #: ../src/guestfs-actions.pod:7150
19451 msgid "guestfs_zgrep"
19456 #: ../src/guestfs-actions.pod:7152
19460 " guestfs_zgrep (guestfs_h *g,\n"
19461 " const char *regex,\n"
19462 " const char *path);\n"
19468 #: ../src/guestfs-actions.pod:7157 ../fish/guestfish-actions.pod:4729
19470 "This calls the external C<zgrep> program and returns the matching lines."
19475 #: ../src/guestfs-actions.pod:7169
19476 msgid "guestfs_zgrepi"
19481 #: ../src/guestfs-actions.pod:7171
19485 " guestfs_zgrepi (guestfs_h *g,\n"
19486 " const char *regex,\n"
19487 " const char *path);\n"
19493 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4739
19495 "This calls the external C<zgrep -i> program and returns the matching lines."
19500 #: ../src/guestfs-availability.pod:3
19506 #: ../src/guestfs-availability.pod:5
19508 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
19509 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
19510 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
19511 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
19512 "L</guestfs_aug_save> L</guestfs_aug_set>"
19517 #: ../src/guestfs-availability.pod:21
19523 #: ../src/guestfs-availability.pod:23
19525 "The following functions: L</guestfs_inotify_add_watch> L</"
19526 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19527 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19532 #: ../src/guestfs-availability.pod:31
19533 msgid "B<linuxfsuuid>"
19538 #: ../src/guestfs-availability.pod:33
19540 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19541 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19546 #: ../src/guestfs-availability.pod:40
19547 msgid "B<linuxmodules>"
19552 #: ../src/guestfs-availability.pod:42
19553 msgid "The following functions: L</guestfs_modprobe>"
19558 #: ../src/guestfs-availability.pod:45
19559 msgid "B<linuxxattrs>"
19564 #: ../src/guestfs-availability.pod:47
19566 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19567 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19568 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19569 "guestfs_setxattr>"
19574 #: ../src/guestfs-availability.pod:58
19580 #: ../src/guestfs-availability.pod:60
19582 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19583 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19584 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19589 #: ../src/guestfs-availability.pod:69
19595 #: ../src/guestfs-availability.pod:71
19597 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19598 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19599 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19600 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19601 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19602 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19603 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19608 #: ../src/guestfs-availability.pod:94
19614 #: ../src/guestfs-availability.pod:96
19616 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19617 "guestfs_mknod_b> L</guestfs_mknod_c>"
19622 #: ../src/guestfs-availability.pod:102
19628 #: ../src/guestfs-availability.pod:104
19629 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19634 #: ../src/guestfs-availability.pod:107
19635 msgid "B<ntfsprogs>"
19640 #: ../src/guestfs-availability.pod:109
19642 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
19647 #: ../src/guestfs-availability.pod:113
19648 msgid "B<realpath>"
19653 #: ../src/guestfs-availability.pod:115
19654 msgid "The following functions: L</guestfs_realpath>"
19659 #: ../src/guestfs-availability.pod:118
19665 #: ../src/guestfs-availability.pod:120
19667 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19668 "guestfs_scrub_freespace>"
19673 #: ../src/guestfs-availability.pod:125
19679 #: ../src/guestfs-availability.pod:127
19680 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19685 #: ../src/guestfs-availability.pod:131
19691 #: ../src/guestfs-availability.pod:133
19692 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19697 #: ../src/guestfs-availability.pod:137
19698 msgid "B<zerofree>"
19703 #: ../src/guestfs-availability.pod:139
19704 msgid "The following functions: L</guestfs_zerofree>"
19709 #: ../src/guestfs-structs.pod:1
19710 msgid "guestfs_int_bool"
19715 #: ../src/guestfs-structs.pod:3
19718 " struct guestfs_int_bool {\n"
19727 #: ../src/guestfs-structs.pod:8
19730 " struct guestfs_int_bool_list {\n"
19731 " uint32_t len; /* Number of elements in list. */\n"
19732 " struct guestfs_int_bool *val; /* Elements. */\n"
19739 #: ../src/guestfs-structs.pod:13
19742 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19743 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19749 #: ../src/guestfs-structs.pod:16
19750 msgid "guestfs_lvm_pv"
19755 #: ../src/guestfs-structs.pod:18
19758 " struct guestfs_lvm_pv {\n"
19759 " char *pv_name;\n"
19760 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19761 " char pv_uuid[32];\n"
19763 " uint64_t pv_size;\n"
19764 " uint64_t dev_size;\n"
19765 " uint64_t pv_free;\n"
19766 " uint64_t pv_used;\n"
19767 " char *pv_attr;\n"
19768 " int64_t pv_pe_count;\n"
19769 " int64_t pv_pe_alloc_count;\n"
19770 " char *pv_tags;\n"
19771 " uint64_t pe_start;\n"
19772 " int64_t pv_mda_count;\n"
19773 " uint64_t pv_mda_free;\n"
19780 #: ../src/guestfs-structs.pod:36
19783 " struct guestfs_lvm_pv_list {\n"
19784 " uint32_t len; /* Number of elements in list. */\n"
19785 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19792 #: ../src/guestfs-structs.pod:41
19795 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19796 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19802 #: ../src/guestfs-structs.pod:44
19803 msgid "guestfs_lvm_vg"
19808 #: ../src/guestfs-structs.pod:46
19811 " struct guestfs_lvm_vg {\n"
19812 " char *vg_name;\n"
19813 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19814 " char vg_uuid[32];\n"
19816 " char *vg_attr;\n"
19817 " uint64_t vg_size;\n"
19818 " uint64_t vg_free;\n"
19819 " char *vg_sysid;\n"
19820 " uint64_t vg_extent_size;\n"
19821 " int64_t vg_extent_count;\n"
19822 " int64_t vg_free_count;\n"
19823 " int64_t max_lv;\n"
19824 " int64_t max_pv;\n"
19825 " int64_t pv_count;\n"
19826 " int64_t lv_count;\n"
19827 " int64_t snap_count;\n"
19828 " int64_t vg_seqno;\n"
19829 " char *vg_tags;\n"
19830 " int64_t vg_mda_count;\n"
19831 " uint64_t vg_mda_free;\n"
19838 #: ../src/guestfs-structs.pod:69
19841 " struct guestfs_lvm_vg_list {\n"
19842 " uint32_t len; /* Number of elements in list. */\n"
19843 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19850 #: ../src/guestfs-structs.pod:74
19853 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19854 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19860 #: ../src/guestfs-structs.pod:77
19861 msgid "guestfs_lvm_lv"
19866 #: ../src/guestfs-structs.pod:79
19869 " struct guestfs_lvm_lv {\n"
19870 " char *lv_name;\n"
19871 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19872 " char lv_uuid[32];\n"
19873 " char *lv_attr;\n"
19874 " int64_t lv_major;\n"
19875 " int64_t lv_minor;\n"
19876 " int64_t lv_kernel_major;\n"
19877 " int64_t lv_kernel_minor;\n"
19878 " uint64_t lv_size;\n"
19879 " int64_t seg_count;\n"
19881 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19882 " float snap_percent;\n"
19883 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19884 " float copy_percent;\n"
19885 " char *move_pv;\n"
19886 " char *lv_tags;\n"
19887 " char *mirror_log;\n"
19888 " char *modules;\n"
19895 #: ../src/guestfs-structs.pod:101
19898 " struct guestfs_lvm_lv_list {\n"
19899 " uint32_t len; /* Number of elements in list. */\n"
19900 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19907 #: ../src/guestfs-structs.pod:106
19910 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19911 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19917 #: ../src/guestfs-structs.pod:111
19920 " struct guestfs_stat {\n"
19924 " int64_t nlink;\n"
19929 " int64_t blksize;\n"
19930 " int64_t blocks;\n"
19931 " int64_t atime;\n"
19932 " int64_t mtime;\n"
19933 " int64_t ctime;\n"
19940 #: ../src/guestfs-structs.pod:127
19943 " struct guestfs_stat_list {\n"
19944 " uint32_t len; /* Number of elements in list. */\n"
19945 " struct guestfs_stat *val; /* Elements. */\n"
19952 #: ../src/guestfs-structs.pod:132
19955 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19956 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19962 #: ../src/guestfs-structs.pod:137
19965 " struct guestfs_statvfs {\n"
19966 " int64_t bsize;\n"
19967 " int64_t frsize;\n"
19968 " int64_t blocks;\n"
19969 " int64_t bfree;\n"
19970 " int64_t bavail;\n"
19971 " int64_t files;\n"
19972 " int64_t ffree;\n"
19973 " int64_t favail;\n"
19976 " int64_t namemax;\n"
19983 #: ../src/guestfs-structs.pod:151
19986 " struct guestfs_statvfs_list {\n"
19987 " uint32_t len; /* Number of elements in list. */\n"
19988 " struct guestfs_statvfs *val; /* Elements. */\n"
19995 #: ../src/guestfs-structs.pod:156
19998 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19999 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20005 #: ../src/guestfs-structs.pod:159
20006 msgid "guestfs_dirent"
20011 #: ../src/guestfs-structs.pod:161
20014 " struct guestfs_dirent {\n"
20024 #: ../src/guestfs-structs.pod:167
20027 " struct guestfs_dirent_list {\n"
20028 " uint32_t len; /* Number of elements in list. */\n"
20029 " struct guestfs_dirent *val; /* Elements. */\n"
20036 #: ../src/guestfs-structs.pod:172
20039 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20040 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20046 #: ../src/guestfs-structs.pod:177
20049 " struct guestfs_version {\n"
20050 " int64_t major;\n"
20051 " int64_t minor;\n"
20052 " int64_t release;\n"
20060 #: ../src/guestfs-structs.pod:184
20063 " struct guestfs_version_list {\n"
20064 " uint32_t len; /* Number of elements in list. */\n"
20065 " struct guestfs_version *val; /* Elements. */\n"
20072 #: ../src/guestfs-structs.pod:189
20075 " void guestfs_free_version (struct guestfs_free_version *);\n"
20076 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20082 #: ../src/guestfs-structs.pod:192
20083 msgid "guestfs_xattr"
20088 #: ../src/guestfs-structs.pod:194
20091 " struct guestfs_xattr {\n"
20092 " char *attrname;\n"
20093 " /* The next two fields describe a byte array. */\n"
20094 " uint32_t attrval_len;\n"
20095 " char *attrval;\n"
20102 #: ../src/guestfs-structs.pod:201
20105 " struct guestfs_xattr_list {\n"
20106 " uint32_t len; /* Number of elements in list. */\n"
20107 " struct guestfs_xattr *val; /* Elements. */\n"
20114 #: ../src/guestfs-structs.pod:206
20117 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20118 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
20124 #: ../src/guestfs-structs.pod:209
20125 msgid "guestfs_inotify_event"
20130 #: ../src/guestfs-structs.pod:211
20133 " struct guestfs_inotify_event {\n"
20134 " int64_t in_wd;\n"
20135 " uint32_t in_mask;\n"
20136 " uint32_t in_cookie;\n"
20137 " char *in_name;\n"
20144 #: ../src/guestfs-structs.pod:218
20147 " struct guestfs_inotify_event_list {\n"
20148 " uint32_t len; /* Number of elements in list. */\n"
20149 " struct guestfs_inotify_event *val; /* Elements. */\n"
20156 #: ../src/guestfs-structs.pod:223
20159 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20160 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20166 #: ../src/guestfs-structs.pod:226
20167 msgid "guestfs_partition"
20172 #: ../src/guestfs-structs.pod:228
20175 " struct guestfs_partition {\n"
20176 " int32_t part_num;\n"
20177 " uint64_t part_start;\n"
20178 " uint64_t part_end;\n"
20179 " uint64_t part_size;\n"
20186 #: ../src/guestfs-structs.pod:235
20189 " struct guestfs_partition_list {\n"
20190 " uint32_t len; /* Number of elements in list. */\n"
20191 " struct guestfs_partition *val; /* Elements. */\n"
20198 #: ../src/guestfs-structs.pod:240
20201 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
20202 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
20208 #: ../src/guestfs-structs.pod:243
20209 msgid "guestfs_application"
20214 #: ../src/guestfs-structs.pod:245
20217 " struct guestfs_application {\n"
20218 " char *app_name;\n"
20219 " char *app_display_name;\n"
20220 " int32_t app_epoch;\n"
20221 " char *app_version;\n"
20222 " char *app_release;\n"
20223 " char *app_install_path;\n"
20224 " char *app_trans_path;\n"
20225 " char *app_publisher;\n"
20226 " char *app_url;\n"
20227 " char *app_source_package;\n"
20228 " char *app_summary;\n"
20229 " char *app_description;\n"
20236 #: ../src/guestfs-structs.pod:260
20239 " struct guestfs_application_list {\n"
20240 " uint32_t len; /* Number of elements in list. */\n"
20241 " struct guestfs_application *val; /* Elements. */\n"
20248 #: ../src/guestfs-structs.pod:265
20251 " void guestfs_free_application (struct guestfs_free_application *);\n"
20252 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
20258 #: ../fish/guestfish.pod:5
20259 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20264 #: ../fish/guestfish.pod:9
20267 " guestfish [--options] [commands]\n"
20273 #: ../fish/guestfish.pod:11
20282 #: ../fish/guestfish.pod:13
20285 " guestfish [--ro|--rw] -a disk.img\n"
20291 #: ../fish/guestfish.pod:15
20294 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20300 #: ../fish/guestfish.pod:17
20303 " guestfish -d libvirt-domain\n"
20309 #: ../fish/guestfish.pod:19
20312 " guestfish [--ro|--rw] -a disk.img -i\n"
20318 #: ../fish/guestfish.pod:21
20321 " guestfish -d libvirt-domain -i\n"
20327 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
20328 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
20334 #: ../fish/guestfish.pod:25
20336 "Using guestfish in read/write mode on live virtual machines can be "
20337 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20338 "option to use guestfish safely if the disk image or virtual machine might be "
20344 #: ../fish/guestfish.pod:32
20346 "Guestfish is a shell and command-line tool for examining and modifying "
20347 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20348 "functionality of the guestfs API, see L<guestfs(3)>."
20353 #: ../fish/guestfish.pod:36
20355 "Guestfish gives you structured access to the libguestfs API, from shell "
20356 "scripts or the command line or interactively. If you want to rescue a "
20357 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20363 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:897
20364 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
20365 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
20371 #: ../fish/guestfish.pod:43
20372 msgid "As an interactive shell"
20377 #: ../fish/guestfish.pod:45
20386 #: ../fish/guestfish.pod:47
20389 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20390 " editing virtual machine filesystems.\n"
20396 #: ../fish/guestfish.pod:50
20399 " Type: 'help' for a list of commands\n"
20400 " 'man' to read the manual\n"
20401 " 'quit' to quit the shell\n"
20407 #: ../fish/guestfish.pod:54
20410 " ><fs> add-ro disk.img\n"
20412 " ><fs> list-filesystems\n"
20413 " /dev/sda1: ext4\n"
20414 " /dev/vg_guest/lv_root: ext4\n"
20415 " /dev/vg_guest/lv_swap: swap\n"
20416 " ><fs> mount /dev/vg_guest/lv_root /\n"
20417 " ><fs> cat /etc/fstab\n"
20419 " # Created by anaconda\n"
20427 #: ../fish/guestfish.pod:67
20428 msgid "From shell scripts"
20433 #: ../fish/guestfish.pod:69
20434 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20439 #: ../fish/guestfish.pod:71
20442 " guestfish <<_EOF_\n"
20445 " mount /dev/vg_guest/lv_root /\n"
20446 " write /etc/motd \"Welcome, new users\"\n"
20453 #: ../fish/guestfish.pod:78
20454 msgid "List the LVM logical volumes in a disk image:"
20459 #: ../fish/guestfish.pod:80
20462 " guestfish -a disk.img --ro <<_EOF_\n"
20471 #: ../fish/guestfish.pod:85
20472 msgid "List all the filesystems in a disk image:"
20477 #: ../fish/guestfish.pod:87
20480 " guestfish -a disk.img --ro <<_EOF_\n"
20482 " list-filesystems\n"
20489 #: ../fish/guestfish.pod:92
20490 msgid "On one command line"
20495 #: ../fish/guestfish.pod:94
20496 msgid "Update C</etc/resolv.conf> in a guest:"
20501 #: ../fish/guestfish.pod:96
20505 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20506 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20512 #: ../fish/guestfish.pod:100
20513 msgid "Edit C</boot/grub/grub.conf> interactively:"
20518 #: ../fish/guestfish.pod:102
20521 " guestfish --rw --add disk.img \\\n"
20522 " --mount /dev/vg_guest/lv_root \\\n"
20523 " --mount /dev/sda1:/boot \\\n"
20524 " edit /boot/grub/grub.conf\n"
20530 #: ../fish/guestfish.pod:107
20531 msgid "Mount disks automatically"
20536 #: ../fish/guestfish.pod:109
20538 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20543 #: ../fish/guestfish.pod:112
20546 " guestfish --ro -a disk.img -i cat /etc/group\n"
20552 #: ../fish/guestfish.pod:114
20555 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20561 #: ../fish/guestfish.pod:116
20562 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20567 #: ../fish/guestfish.pod:118
20570 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20576 #: ../fish/guestfish.pod:120
20577 msgid "As a script interpreter"
20582 #: ../fish/guestfish.pod:122
20583 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20588 #: ../fish/guestfish.pod:124
20591 " #!/usr/bin/guestfish -f\n"
20592 " sparse test1.img 100M\n"
20594 " part-disk /dev/sda mbr\n"
20595 " mkfs ext2 /dev/sda1\n"
20601 #: ../fish/guestfish.pod:130
20602 msgid "Start with a prepared disk"
20607 #: ../fish/guestfish.pod:132
20609 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20610 "single ext2-formatted partition:"
20615 #: ../fish/guestfish.pod:135
20618 " guestfish -N fs\n"
20624 #: ../fish/guestfish.pod:137
20625 msgid "To list what is available do:"
20630 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
20633 " guestfish -N help | less\n"
20639 #: ../fish/guestfish.pod:141
20640 msgid "Remote control"
20645 #: ../fish/guestfish.pod:143
20648 " eval \"`guestfish --listen`\"\n"
20649 " guestfish --remote add-ro disk.img\n"
20650 " guestfish --remote run\n"
20651 " guestfish --remote lvs\n"
20657 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20658 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
20659 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
20660 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
20661 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20667 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
20668 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104
20669 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
20670 #: ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161
20671 #: ../tools/virt-list-partitions.pl:62
20677 #: ../fish/guestfish.pod:154
20678 msgid "Displays general help on options."
20683 #: ../fish/guestfish.pod:156
20689 #: ../fish/guestfish.pod:158
20690 msgid "B<--cmd-help>"
20695 #: ../fish/guestfish.pod:160
20696 msgid "Lists all available guestfish commands."
20701 #: ../fish/guestfish.pod:162
20707 #: ../fish/guestfish.pod:164
20708 msgid "B<--cmd-help cmd>"
20713 #: ../fish/guestfish.pod:166
20714 msgid "Displays detailed help on a single command C<cmd>."
20719 #: ../fish/guestfish.pod:168
20720 msgid "B<-a image>"
20725 #: ../fish/guestfish.pod:170
20726 msgid "B<--add image>"
20731 #: ../fish/guestfish.pod:172
20732 msgid "Add a block device or virtual machine image to the shell."
20737 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
20739 "The format of the disk image is auto-detected. To override this and force a "
20740 "particular format use the I<--format=..> option."
20745 #: ../fish/guestfish.pod:177
20747 "Using this flag is mostly equivalent to using the C<add> command, with "
20748 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20749 "the I<--format:...> flag was given."
20754 #: ../fish/guestfish.pod:181
20760 #: ../fish/guestfish.pod:183
20761 msgid "B<--connect URI>"
20766 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
20768 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20769 "URI to use. The default is to use the default libvirt connection."
20774 #: ../fish/guestfish.pod:189
20780 #: ../fish/guestfish.pod:191
20782 "If using the I<--listen> option and a csh-like shell, use this option. See "
20783 "section L</REMOTE CONTROL AND CSH> below."
20788 #: ../fish/guestfish.pod:194
20789 msgid "B<-d libvirt-domain>"
20794 #: ../fish/guestfish.pod:196
20795 msgid "B<--domain libvirt-domain>"
20800 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
20802 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20803 "used, then any libvirt domain can be used. However in write mode, only "
20804 "libvirt domains which are shut down can be named here."
20809 #: ../fish/guestfish.pod:202
20811 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20812 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20813 "if the I<--format:...> flag was given."
20818 #: ../fish/guestfish.pod:206
20824 #: ../fish/guestfish.pod:208
20825 msgid "B<--no-dest-paths>"
20830 #: ../fish/guestfish.pod:210
20832 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20833 "to hit the tab key to complete paths on the guest filesystem, but this "
20834 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20835 "allow this feature to be disabled."
20840 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
20841 msgid "B<--echo-keys>"
20846 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
20848 "When prompting for keys and passphrases, guestfish normally turns echoing "
20849 "off so you cannot see what you are typing. If you are not worried about "
20850 "Tempest attacks and there is no one else in the room you can specify this "
20851 "flag to see what you are typing."
20856 #: ../fish/guestfish.pod:222
20862 #: ../fish/guestfish.pod:224
20863 msgid "B<--file file>"
20868 #: ../fish/guestfish.pod:226
20869 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20874 #: ../fish/guestfish.pod:229
20877 " #!/usr/bin/guestfish -f\n"
20883 #: ../fish/guestfish.pod:231
20884 msgid "B<--format=raw|qcow2|..>"
20889 #: ../fish/guestfish.pod:233
20890 msgid "B<--format>"
20895 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
20897 "The default for the I<-a> option is to auto-detect the format of the disk "
20898 "image. Using this forces the disk format for I<-a> options which follow on "
20899 "the command line. Using I<--format> with no argument switches back to auto-"
20900 "detection for subsequent I<-a> options."
20905 #: ../fish/guestfish.pod:242
20908 " guestfish --format=raw -a disk.img\n"
20914 #: ../fish/guestfish.pod:244
20915 msgid "forces raw format (no auto-detection) for C<disk.img>."
20920 #: ../fish/guestfish.pod:246
20923 " guestfish --format=raw -a disk.img --format -a another.img\n"
20929 #: ../fish/guestfish.pod:248
20931 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20932 "detection for C<another.img>."
20937 #: ../fish/guestfish.pod:251
20939 "If you have untrusted raw-format guest disk images, you should use this "
20940 "option to specify the disk format. This avoids a possible security problem "
20941 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20946 #: ../fish/guestfish.pod:256
20952 #: ../fish/guestfish.pod:258
20953 msgid "B<--inspector>"
20958 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
20960 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20961 "system and mount filesystems as they would be mounted on the real virtual "
20967 #: ../fish/guestfish.pod:264
20968 msgid "Typical usage is either:"
20973 #: ../fish/guestfish.pod:266
20976 " guestfish -d myguest -i\n"
20982 #: ../fish/guestfish.pod:268
20983 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20988 #: ../fish/guestfish.pod:270
20991 " guestfish --ro -d myguest -i\n"
20997 #: ../fish/guestfish.pod:272
20998 msgid "(for active domains, readonly), or specify the block device directly:"
21003 #: ../fish/guestfish.pod:274
21006 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21012 #: ../fish/guestfish.pod:276
21014 "Note that the command line syntax changed slightly over older versions of "
21015 "guestfish. You can still use the old syntax:"
21020 #: ../fish/guestfish.pod:279
21023 " guestfish [--ro] -i disk.img\n"
21029 #: ../fish/guestfish.pod:281
21032 " guestfish [--ro] -i libvirt-domain\n"
21038 #: ../fish/guestfish.pod:283
21040 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21041 "then using other commands to mount the filesystems that were found."
21046 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21047 msgid "B<--keys-from-stdin>"
21052 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21054 "Read key or passphrase parameters from stdin. The default is to try to read "
21055 "passphrases from the user by opening C</dev/tty>."
21060 #: ../fish/guestfish.pod:292
21061 msgid "B<--listen>"
21066 #: ../fish/guestfish.pod:294
21068 "Fork into the background and listen for remote commands. See section L</"
21069 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21074 #: ../fish/guestfish.pod:297
21075 msgid "B<-m dev[:mountpoint]>"
21080 #: ../fish/guestfish.pod:299
21081 msgid "B<--mount dev[:mountpoint]>"
21086 #: ../fish/guestfish.pod:301
21087 msgid "Mount the named partition or logical volume on the given mountpoint."
21092 #: ../fish/guestfish.pod:303
21093 msgid "If the mountpoint is omitted, it defaults to C</>."
21098 #: ../fish/guestfish.pod:305
21099 msgid "You have to mount something on C</> before most commands will work."
21104 #: ../fish/guestfish.pod:307
21106 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21112 #: ../fish/guestfish.pod:310
21114 "If you don't know what filesystems a disk image contains, you can either run "
21115 "guestfish without this option, then list the partitions, filesystems and LVs "
21116 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21117 "commands), or you can use the L<virt-filesystems(1)> program."
21122 #: ../fish/guestfish.pod:316
21124 "Using this flag is mostly equivalent to using the C<mount-options> command "
21125 "or the C<mount-ro> command if the I<--ro> flag was given."
21130 #: ../fish/guestfish.pod:319
21136 #: ../fish/guestfish.pod:321
21137 msgid "B<--no-sync>"
21142 #: ../fish/guestfish.pod:323
21144 "Disable autosync. This is enabled by default. See the discussion of "
21145 "autosync in the L<guestfs(3)> manpage."
21150 #: ../fish/guestfish.pod:326
21156 #: ../fish/guestfish.pod:328
21157 msgid "B<--new type>"
21162 #: ../fish/guestfish.pod:330
21168 #: ../fish/guestfish.pod:332
21170 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
21171 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
21172 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
21178 #: ../fish/guestfish.pod:337
21179 msgid "B<--progress-bars>"
21184 #: ../fish/guestfish.pod:339
21185 msgid "Enable progress bars, even when guestfish is used non-interactively."
21190 #: ../fish/guestfish.pod:341
21192 "Progress bars are enabled by default when guestfish is used as an "
21193 "interactive shell."
21198 #: ../fish/guestfish.pod:344
21199 msgid "B<--no-progress-bars>"
21204 #: ../fish/guestfish.pod:346
21205 msgid "Disable progress bars."
21210 #: ../fish/guestfish.pod:348
21211 msgid "B<--remote[=pid]>"
21216 #: ../fish/guestfish.pod:350
21218 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
21219 "CONTROL GUESTFISH OVER A SOCKET> below."
21224 #: ../fish/guestfish.pod:353
21230 #: ../fish/guestfish.pod:355
21236 #: ../fish/guestfish.pod:357
21238 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21239 "mounts are done read-only."
21244 #: ../fish/guestfish.pod:360
21246 "The option must always be used if the disk image or virtual machine might be "
21247 "running, and is generally recommended in cases where you don't need write "
21248 "access to the disk."
21253 #: ../fish/guestfish.pod:364
21255 "Note that prepared disk images created with I<-N> are not affected by this "
21256 "option. Also commands like C<add> are not affected - you have to specify "
21257 "the C<readonly:true> option explicitly if you need it."
21262 #: ../fish/guestfish.pod:368
21263 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21268 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
21269 msgid "B<--selinux>"
21274 #: ../fish/guestfish.pod:372
21275 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21280 #: ../fish/guestfish.pod:374
21286 #: ../fish/guestfish.pod:376
21287 msgid "B<--verbose>"
21292 #: ../fish/guestfish.pod:378
21294 "Enable very verbose messages. This is particularly useful if you find a bug."
21299 #: ../fish/guestfish.pod:381
21305 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:88
21306 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
21307 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114
21308 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
21309 msgid "B<--version>"
21314 #: ../fish/guestfish.pod:385
21315 msgid "Display the guestfish / libguestfs version number and exit."
21320 #: ../fish/guestfish.pod:387
21326 #: ../fish/guestfish.pod:389
21332 #: ../fish/guestfish.pod:391
21334 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
21340 #: ../fish/guestfish.pod:394
21346 #: ../fish/guestfish.pod:396
21347 msgid "Echo each command before executing it."
21352 #: ../fish/guestfish.pod:400
21353 msgid "COMMANDS ON COMMAND LINE"
21358 #: ../fish/guestfish.pod:402
21360 "Any additional (non-option) arguments are treated as commands to execute."
21365 #: ../fish/guestfish.pod:405
21367 "Commands to execute should be separated by a colon (C<:>), where the colon "
21368 "is a separate parameter. Thus:"
21373 #: ../fish/guestfish.pod:408
21376 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21382 #: ../fish/guestfish.pod:410
21384 "If there are no additional arguments, then we enter a shell, either an "
21385 "interactive shell with a prompt (if the input is a terminal) or a non-"
21386 "interactive shell."
21391 #: ../fish/guestfish.pod:414
21393 "In either command line mode or non-interactive shell, the first command that "
21394 "gives an error causes the whole shell to exit. In interactive mode (with a "
21395 "prompt) if a command fails, you can continue to enter commands."
21400 #: ../fish/guestfish.pod:419
21401 msgid "USING launch (OR run)"
21406 #: ../fish/guestfish.pod:421
21408 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21409 "then launch it, then mount any disks you need, and finally issue actions/"
21410 "commands. So the general order of the day is:"
21415 #: ../fish/guestfish.pod:429
21416 msgid "add or -a/--add"
21421 #: ../fish/guestfish.pod:433
21422 msgid "launch (aka run)"
21427 #: ../fish/guestfish.pod:437
21428 msgid "mount or -m/--mount"
21433 #: ../fish/guestfish.pod:441
21434 msgid "any other commands"
21439 #: ../fish/guestfish.pod:445
21441 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21442 "guest before mounting or performing any other commands."
21447 #: ../fish/guestfish.pod:448
21449 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21450 "I<--new> options were given then C<run> is done automatically, simply "
21451 "because guestfish can't perform the action you asked for without doing this."
21456 #: ../fish/guestfish.pod:453
21457 msgid "OPENING DISKS FOR READ AND WRITE"
21462 #: ../fish/guestfish.pod:455
21464 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
21465 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
21466 "open disk images read-only or for writing."
21471 #: ../fish/guestfish.pod:459
21473 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
21474 "disk images supplied on the command line for write. To open a disk image "
21475 "read-only you have to do I<-a image --ro>."
21480 #: ../fish/guestfish.pod:463
21482 "This matters: If you accidentally open a live VM disk image writable then "
21483 "you will cause irreversible disk corruption."
21487 #: ../fish/guestfish.pod:466
21489 "By libguestfs 1.10 we intend to change the default the other way. Disk "
21490 "images will be opened read-only. You will have to either specify "
21491 "I<guestfish --rw> or change a configuration file in order to get write "
21492 "access for disk images specified by those other command line options."
21497 #: ../fish/guestfish.pod:471
21499 "This version of guestfish has a I<--rw> option which does nothing (it is "
21500 "already the default). However it is highly recommended that you use this "
21501 "option to indicate that guestfish needs write access, and to prepare your "
21502 "scripts for the day when this option will be required for write access."
21507 #: ../fish/guestfish.pod:477
21509 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21510 "other libguestfs program apart from guestfish and guestmount."
21515 #: ../fish/guestfish.pod:480
21521 #: ../fish/guestfish.pod:482
21523 "You can quote ordinary parameters using either single or double quotes. For "
21529 #: ../fish/guestfish.pod:485
21532 " add \"file with a space.img\"\n"
21538 #: ../fish/guestfish.pod:487
21541 " rm '/file name'\n"
21547 #: ../fish/guestfish.pod:489
21556 #: ../fish/guestfish.pod:491
21558 "A few commands require a list of strings to be passed. For these, use a "
21559 "whitespace-separated list, enclosed in quotes. Strings containing "
21560 "whitespace to be passed through must be enclosed in single quotes. A "
21561 "literal single quote must be escaped with a backslash."
21566 #: ../fish/guestfish.pod:496
21569 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21570 " command \"/bin/echo 'foo bar'\"\n"
21571 " command \"/bin/echo \\'foo\\'\"\n"
21577 #: ../fish/guestfish.pod:500
21578 msgid "OPTIONAL ARGUMENTS"
21583 #: ../fish/guestfish.pod:502
21585 "Some commands take optional arguments. These arguments appear in this "
21586 "documentation as C<[argname:..]>. You can use them as in these examples:"
21591 #: ../fish/guestfish.pod:506
21594 " add-drive-opts filename\n"
21600 #: ../fish/guestfish.pod:508
21603 " add-drive-opts filename readonly:true\n"
21609 #: ../fish/guestfish.pod:510
21612 " add-drive-opts filename format:qcow2 readonly:false\n"
21618 #: ../fish/guestfish.pod:512
21620 "Each optional argument can appear at most once. All optional arguments must "
21621 "appear after the required ones."
21626 #: ../fish/guestfish.pod:515
21632 #: ../fish/guestfish.pod:517
21634 "This section applies to all commands which can take integers as parameters."
21639 #: ../fish/guestfish.pod:520
21640 msgid "SIZE SUFFIX"
21645 #: ../fish/guestfish.pod:522
21647 "When the command takes a parameter measured in bytes, you can use one of the "
21648 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21653 #: ../fish/guestfish.pod:528
21654 msgid "B<k> or B<K> or B<KiB>"
21659 #: ../fish/guestfish.pod:530
21660 msgid "The size in kilobytes (multiplied by 1024)."
21665 #: ../fish/guestfish.pod:532
21671 #: ../fish/guestfish.pod:534
21672 msgid "The size in SI 1000 byte units."
21677 #: ../fish/guestfish.pod:536
21678 msgid "B<M> or B<MiB>"
21683 #: ../fish/guestfish.pod:538
21684 msgid "The size in megabytes (multiplied by 1048576)."
21689 #: ../fish/guestfish.pod:540
21695 #: ../fish/guestfish.pod:542
21696 msgid "The size in SI 1000000 byte units."
21701 #: ../fish/guestfish.pod:544
21702 msgid "B<G> or B<GiB>"
21707 #: ../fish/guestfish.pod:546
21708 msgid "The size in gigabytes (multiplied by 2**30)."
21713 #: ../fish/guestfish.pod:548
21719 #: ../fish/guestfish.pod:550
21720 msgid "The size in SI 10**9 byte units."
21725 #: ../fish/guestfish.pod:552
21726 msgid "B<T> or B<TiB>"
21731 #: ../fish/guestfish.pod:554
21732 msgid "The size in terabytes (multiplied by 2**40)."
21737 #: ../fish/guestfish.pod:556
21743 #: ../fish/guestfish.pod:558
21744 msgid "The size in SI 10**12 byte units."
21749 #: ../fish/guestfish.pod:560
21750 msgid "B<P> or B<PiB>"
21755 #: ../fish/guestfish.pod:562
21756 msgid "The size in petabytes (multiplied by 2**50)."
21761 #: ../fish/guestfish.pod:564
21767 #: ../fish/guestfish.pod:566
21768 msgid "The size in SI 10**15 byte units."
21773 #: ../fish/guestfish.pod:568
21774 msgid "B<E> or B<EiB>"
21779 #: ../fish/guestfish.pod:570
21780 msgid "The size in exabytes (multiplied by 2**60)."
21785 #: ../fish/guestfish.pod:572
21791 #: ../fish/guestfish.pod:574
21792 msgid "The size in SI 10**18 byte units."
21797 #: ../fish/guestfish.pod:576
21798 msgid "B<Z> or B<ZiB>"
21803 #: ../fish/guestfish.pod:578
21804 msgid "The size in zettabytes (multiplied by 2**70)."
21809 #: ../fish/guestfish.pod:580
21815 #: ../fish/guestfish.pod:582
21816 msgid "The size in SI 10**21 byte units."
21821 #: ../fish/guestfish.pod:584
21822 msgid "B<Y> or B<YiB>"
21827 #: ../fish/guestfish.pod:586
21828 msgid "The size in yottabytes (multiplied by 2**80)."
21833 #: ../fish/guestfish.pod:588
21839 #: ../fish/guestfish.pod:590
21840 msgid "The size in SI 10**24 byte units."
21845 #: ../fish/guestfish.pod:596
21848 " truncate-size /file 1G\n"
21854 #: ../fish/guestfish.pod:598
21855 msgid "would truncate the file to 1 gigabyte."
21860 #: ../fish/guestfish.pod:600
21862 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21863 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21864 "suffix will probably not do what you expect."
21869 #: ../fish/guestfish.pod:604
21870 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21875 #: ../fish/guestfish.pod:606
21877 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21878 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21883 #: ../fish/guestfish.pod:609
21886 " 1234 decimal number 1234\n"
21887 " 02322 octal number, equivalent to decimal 1234\n"
21888 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21894 #: ../fish/guestfish.pod:613
21896 "When using the C<chmod> command, you almost always want to specify an octal "
21897 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21898 "L<chmod(1)> program):"
21903 #: ../fish/guestfish.pod:617
21906 " chmod 0777 /public # OK\n"
21907 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21913 #: ../fish/guestfish.pod:620
21915 "Commands that return numbers usually print them in decimal, but some "
21916 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21917 "octal, preceeded by C<0>)."
21922 #: ../fish/guestfish.pod:624
21923 msgid "WILDCARDS AND GLOBBING"
21928 #: ../fish/guestfish.pod:626
21930 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21931 "(globbing) by default. So for example the following will not do what you "
21937 #: ../fish/guestfish.pod:630
21946 #: ../fish/guestfish.pod:632
21948 "Assuming you don't have a directory called literally C</home/*> then the "
21949 "above command will return an error."
21954 #: ../fish/guestfish.pod:635
21955 msgid "To perform wildcard expansion, use the C<glob> command."
21960 #: ../fish/guestfish.pod:637
21963 " glob rm-rf /home/*\n"
21969 #: ../fish/guestfish.pod:639
21971 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21972 "many times), equivalent to:"
21977 #: ../fish/guestfish.pod:642
21980 " rm-rf /home/jim\n"
21981 " rm-rf /home/joe\n"
21982 " rm-rf /home/mary\n"
21988 #: ../fish/guestfish.pod:646
21989 msgid "C<glob> only works on simple guest paths and not on device names."
21994 #: ../fish/guestfish.pod:648
21996 "If you have several parameters, each containing a wildcard, then glob will "
21997 "perform a Cartesian product."
22002 #: ../fish/guestfish.pod:651
22008 #: ../fish/guestfish.pod:653
22010 "Any line which starts with a I<#> character is treated as a comment and "
22011 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22012 "a command. For example:"
22017 #: ../fish/guestfish.pod:657
22020 " # this is a comment\n"
22021 " # this is a comment\n"
22022 " foo # NOT a comment\n"
22028 #: ../fish/guestfish.pod:661
22029 msgid "Blank lines are also ignored."
22034 #: ../fish/guestfish.pod:663
22035 msgid "RUNNING COMMANDS LOCALLY"
22040 #: ../fish/guestfish.pod:665
22042 "Any line which starts with a I<!> character is treated as a command sent to "
22043 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22048 #: ../fish/guestfish.pod:669
22052 " tgz-out /remote local/remote-data.tar.gz\n"
22058 #: ../fish/guestfish.pod:672
22060 "will create a directory C<local> on the host, and then export the contents "
22061 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22062 "(See C<tgz-out>)."
22067 #: ../fish/guestfish.pod:676
22069 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22070 "effect, due to the way that subprocesses work in Unix."
22075 #: ../fish/guestfish.pod:679
22081 #: ../fish/guestfish.pod:681
22083 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
22084 "command (a guestfish command) to the second command (any host command). For "
22090 #: ../fish/guestfish.pod:685
22093 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
22099 #: ../fish/guestfish.pod:687
22101 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
22102 "program). The above command would list all accounts in the guest filesystem "
22103 "which have UID 0, ie. root accounts including backdoors. Other examples:"
22108 #: ../fish/guestfish.pod:692
22111 " hexdump /bin/ls | head\n"
22112 " list-devices | tail -1\n"
22113 " tgz-out / - | tar ztf -\n"
22119 #: ../fish/guestfish.pod:696
22121 "The space before the pipe symbol is required, any space after the pipe "
22122 "symbol is optional. Everything after the pipe symbol is just passed "
22123 "straight to the host shell, so it can contain redirections, globs and "
22124 "anything else that makes sense on the host side."
22129 #: ../fish/guestfish.pod:701
22131 "To use a literal argument which begins with a pipe symbol, you have to quote "
22137 #: ../fish/guestfish.pod:704
22146 #: ../fish/guestfish.pod:706
22147 msgid "HOME DIRECTORIES"
22152 #: ../fish/guestfish.pod:708
22154 "If a parameter starts with the character C<~> then the tilde may be expanded "
22155 "as a home directory path (either C<~> for the current user's home directory, "
22156 "or C<~user> for another user)."
22161 #: ../fish/guestfish.pod:712
22163 "Note that home directory expansion happens for users known I<on the host>, "
22164 "not in the guest filesystem."
22169 #: ../fish/guestfish.pod:715
22171 "To use a literal argument which begins with a tilde, you have to quote it, "
22177 #: ../fish/guestfish.pod:718
22186 #: ../fish/guestfish.pod:722
22188 "Libguestfs has some support for Linux guests encrypted according to the "
22189 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22190 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22191 "LUKS is supported."
22196 #: ../fish/guestfish.pod:727
22197 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22202 #: ../fish/guestfish.pod:729
22205 " ><fs> vfs-type /dev/sda2\n"
22212 #: ../fish/guestfish.pod:732
22214 "Then open those devices using L</luks-open>. This creates a device-mapper "
22215 "device called C</dev/mapper/luksdev>."
22220 #: ../fish/guestfish.pod:735
22223 " ><fs> luks-open /dev/sda2 luksdev\n"
22224 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22230 #: ../fish/guestfish.pod:738
22232 "Finally you have to tell LVM to scan for volume groups on the newly created "
22238 #: ../fish/guestfish.pod:741
22242 " vg-activate-all true\n"
22248 #: ../fish/guestfish.pod:744
22249 msgid "The logical volume(s) can now be mounted in the usual way."
22254 #: ../fish/guestfish.pod:746
22256 "Before closing a LUKS device you must unmount any logical volumes on it and "
22257 "deactivate the volume groups by calling C<vg-activate false VG> on each "
22258 "one. Then you can close the mapper device:"
22263 #: ../fish/guestfish.pod:750
22266 " vg-activate false /dev/VG\n"
22267 " luks-close /dev/mapper/luksdev\n"
22273 #: ../fish/guestfish.pod:753
22274 msgid "WINDOWS PATHS"
22279 #: ../fish/guestfish.pod:755
22281 "If a path is prefixed with C<win:> then you can use Windows-style paths "
22282 "(with some limitations). The following commands are equivalent:"
22287 #: ../fish/guestfish.pod:758
22290 " file /WINDOWS/system32/config/system.LOG\n"
22296 #: ../fish/guestfish.pod:760
22299 " file win:/windows/system32/config/system.log\n"
22305 #: ../fish/guestfish.pod:762
22308 " file win:\\windows\\system32\\config\\system.log\n"
22314 #: ../fish/guestfish.pod:764
22317 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
22323 #: ../fish/guestfish.pod:766
22325 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
22326 "handles case insensitivity like Windows would. This only works in argument "
22327 "positions that expect a path."
22332 #: ../fish/guestfish.pod:770
22333 msgid "UPLOADING AND DOWNLOADING FILES"
22338 #: ../fish/guestfish.pod:772
22340 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22341 "others which upload from or download to a local file, you can use the "
22342 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22347 #: ../fish/guestfish.pod:776
22356 #: ../fish/guestfish.pod:778
22358 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22363 #: ../fish/guestfish.pod:781
22366 " tar-out /etc - | tar tf -\n"
22372 #: ../fish/guestfish.pod:783
22374 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22375 "command (see L</PIPES>)."
22380 #: ../fish/guestfish.pod:786
22382 "When using C<-> to read from stdin, the input is read up to the end of "
22383 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22384 "some arbitrary end marker:"
22389 #: ../fish/guestfish.pod:790
22392 " upload -<<END /foo\n"
22402 #: ../fish/guestfish.pod:796
22404 "Any string of characters can be used instead of C<END>. The end marker must "
22405 "appear on a line of its own, without any preceeding or following characters "
22406 "(not even spaces)."
22411 #: ../fish/guestfish.pod:800
22413 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22414 "upload local files (so-called \"FileIn\" parameters in the generator)."
22419 #: ../fish/guestfish.pod:803
22420 msgid "EXIT ON ERROR BEHAVIOUR"
22425 #: ../fish/guestfish.pod:805
22427 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22428 "taking commands from a human over a tty), and will exit on the first error "
22429 "in non-interactive mode (scripts, commands given on the command line)."
22434 #: ../fish/guestfish.pod:810
22436 "If you prefix a command with a I<-> character, then that command will not "
22437 "cause guestfish to exit, even if that (one) command returns an error."
22442 #: ../fish/guestfish.pod:814
22443 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22448 #: ../fish/guestfish.pod:816
22450 "Guestfish can be remote-controlled over a socket. This is useful "
22451 "particularly in shell scripts where you want to make several different "
22452 "changes to a filesystem, but you don't want the overhead of starting up a "
22453 "guestfish process each time."
22458 #: ../fish/guestfish.pod:821
22459 msgid "Start a guestfish server process using:"
22464 #: ../fish/guestfish.pod:823
22467 " eval \"`guestfish --listen`\"\n"
22473 #: ../fish/guestfish.pod:825
22474 msgid "and then send it commands by doing:"
22479 #: ../fish/guestfish.pod:827
22482 " guestfish --remote cmd [...]\n"
22488 #: ../fish/guestfish.pod:829
22489 msgid "To cause the server to exit, send it the exit command:"
22494 #: ../fish/guestfish.pod:831
22497 " guestfish --remote exit\n"
22503 #: ../fish/guestfish.pod:833
22505 "Note that the server will normally exit if there is an error in a command. "
22506 "You can change this in the usual way. See section L</EXIT ON ERROR "
22512 #: ../fish/guestfish.pod:837
22513 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22518 #: ../fish/guestfish.pod:839
22520 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22521 "is how the I<--remote> option knows where to send the commands. You can "
22522 "have several guestfish listener processes running using:"
22527 #: ../fish/guestfish.pod:843
22530 " eval \"`guestfish --listen`\"\n"
22531 " pid1=$GUESTFISH_PID\n"
22532 " eval \"`guestfish --listen`\"\n"
22533 " pid2=$GUESTFISH_PID\n"
22535 " guestfish --remote=$pid1 cmd\n"
22536 " guestfish --remote=$pid2 cmd\n"
22542 #: ../fish/guestfish.pod:851
22543 msgid "REMOTE CONTROL AND CSH"
22548 #: ../fish/guestfish.pod:853
22550 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22556 #: ../fish/guestfish.pod:856
22559 " eval \"`guestfish --listen --csh`\"\n"
22565 #: ../fish/guestfish.pod:858
22566 msgid "REMOTE CONTROL DETAILS"
22571 #: ../fish/guestfish.pod:860
22573 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22574 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22575 "and C<$PID> is the process ID of the server."
22580 #: ../fish/guestfish.pod:864
22581 msgid "Guestfish client and server versions must match exactly."
22586 #: ../fish/guestfish.pod:866
22587 msgid "PREPARED DISK IMAGES"
22592 #: ../fish/guestfish.pod:868
22594 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22595 "preformatted disk images that guestfish can make for you to save typing. "
22596 "This is particularly useful for testing purposes. This option is used "
22597 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22598 "can be mixed with I<-a>)."
22603 #: ../fish/guestfish.pod:874
22605 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22606 "the second and so on. Existing files in the current directory are "
22612 #: ../fish/guestfish.pod:878
22614 "The type briefly describes how the disk should be sized, partitioned, how "
22615 "filesystem(s) should be created, and how content should be added. "
22616 "Optionally the type can be followed by extra parameters, separated by C<:> "
22617 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22618 "allocated disk, containing a single partition, with the partition formatted "
22619 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22625 #: ../fish/guestfish.pod:886
22626 msgid "To list the available types and any extra parameters they take, run:"
22631 #: ../fish/guestfish.pod:890
22633 "Note that the prepared filesystem is not mounted. You would usually have to "
22634 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22639 #: ../fish/guestfish.pod:894
22641 "If any I<-N> or I<--new> options are given, the guest is automatically "
22647 #: ../fish/guestfish.pod:899
22648 msgid "Create a 100MB disk with an ext4-formatted partition:"
22653 #: ../fish/guestfish.pod:901
22656 " guestfish -N fs:ext4\n"
22662 #: ../fish/guestfish.pod:903
22663 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22668 #: ../fish/guestfish.pod:905
22671 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22677 #: ../fish/guestfish.pod:907
22678 msgid "Create a blank 200MB disk:"
22683 #: ../fish/guestfish.pod:909
22686 " guestfish -N disk:200M\n"
22692 #: ../fish/guestfish.pod:911
22693 msgid "PROGRESS BARS"
22698 #: ../fish/guestfish.pod:913
22700 "Some (not all) long-running commands send progress notification messages as "
22701 "they are running. Guestfish turns these messages into progress bars."
22706 #: ../fish/guestfish.pod:917
22708 "When a command that supports progress bars takes longer than two seconds to "
22709 "run, and if progress bars are enabled, then you will see one appearing below "
22715 #: ../fish/guestfish.pod:921
22718 " ><fs> copy-size /large-file /another-file 2048M\n"
22719 " / 10% [#####-----------------------------------------] 00:30\n"
22725 #: ../fish/guestfish.pod:924
22727 "The spinner on the left hand side moves round once for every progress "
22728 "notification received from the backend. This is a (reasonably) golden "
22729 "assurance that the command is \"doing something\" even if the progress bar "
22730 "is not moving, because the command is able to send the progress "
22731 "notifications. When the bar reaches 100% and the command finishes, the "
22732 "spinner disappears."
22737 #: ../fish/guestfish.pod:931
22739 "Progress bars are enabled by default when guestfish is used interactively. "
22740 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22741 "and you can disable them completely using I<--no-progress-bars>."
22746 #: ../fish/guestfish.pod:936
22747 msgid "GUESTFISH COMMANDS"
22752 #: ../fish/guestfish.pod:938
22754 "The commands in this section are guestfish convenience commands, in other "
22755 "words, they are not part of the L<guestfs(3)> API."
22760 #: ../fish/guestfish.pod:941
22766 #: ../fish/guestfish.pod:943
22776 #: ../fish/guestfish.pod:946
22777 msgid "Without any parameter, this provides general help."
22782 #: ../fish/guestfish.pod:948
22783 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22788 #: ../fish/guestfish.pod:950
22789 msgid "quit | exit"
22794 #: ../fish/guestfish.pod:952
22795 msgid "This exits guestfish. You can also use C<^D> key."
22800 #: ../fish/guestfish.pod:954
22801 msgid "@FISH_COMMANDS@"
22806 #: ../fish/guestfish.pod:956
22812 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
22818 #: ../fish/guestfish.pod:962
22820 "guestfish returns 0 if the commands completed without error, or 1 if there "
22826 #: ../fish/guestfish.pod:969
22832 #: ../fish/guestfish.pod:971
22834 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22840 #: ../fish/guestfish.pod:974
22841 msgid "GUESTFISH_PID"
22846 #: ../fish/guestfish.pod:976
22848 "Used with the I<--remote> option to specify the remote guestfish process to "
22849 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22854 #: ../fish/guestfish.pod:980
22860 #: ../fish/guestfish.pod:982
22862 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22863 "not specified, the external L<hexedit(1)> program is used."
22868 #: ../fish/guestfish.pod:986
22874 #: ../fish/guestfish.pod:988
22876 "If compiled with GNU readline support, various files in the home directory "
22877 "can be used. See L</FILES>."
22882 #: ../fish/guestfish.pod:997
22884 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22885 "effect as using the B<-v> option."
22890 #: ../fish/guestfish.pod:1009
22892 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22893 "the discussion of paths in L<guestfs(3)>."
22898 #: ../fish/guestfish.pod:1020
22899 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22904 #: ../fish/guestfish.pod:1022
22910 #: ../fish/guestfish.pod:1024
22912 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22918 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
22924 #: ../fish/guestfish.pod:1043
22925 msgid "$HOME/.guestfish"
22930 #: ../fish/guestfish.pod:1045
22932 "If compiled with GNU readline support, then the command history is saved in "
22938 #: ../fish/guestfish.pod:1048
22939 msgid "$HOME/.inputrc"
22944 #: ../fish/guestfish.pod:1050
22945 msgid "/etc/inputrc"
22950 #: ../fish/guestfish.pod:1052
22952 "If compiled with GNU readline support, then these files can be used to "
22953 "configure readline. For further information, please see L<readline(3)/"
22954 "INITIALIZATION FILE>."
22959 #: ../fish/guestfish.pod:1056
22960 msgid "To write rules which only apply to guestfish, use:"
22965 #: ../fish/guestfish.pod:1058
22976 #: ../fish/guestfish.pod:1062
22978 "Variables that you can set in inputrc that change the behaviour of guestfish "
22979 "in useful ways include:"
22984 #: ../fish/guestfish.pod:1067
22985 msgid "completion-ignore-case (default: on)"
22990 #: ../fish/guestfish.pod:1069
22992 "By default, guestfish will ignore case when tab-completing paths on the "
22998 #: ../fish/guestfish.pod:1072
23001 " set completion-ignore-case off\n"
23007 #: ../fish/guestfish.pod:1074
23008 msgid "to make guestfish case sensitive."
23013 #: ../fish/guestfish.pod:1078
23019 #: ../fish/guestfish.pod:1080
23020 msgid "test2.img (etc)"
23025 #: ../fish/guestfish.pod:1082
23027 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
23028 "will be created in the file C<test1.img> in the current directory. The "
23029 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
23030 "the same name will be overwritten."
23035 #: ../fish/guestfish.pod:1091
23037 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
23038 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
23039 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
23040 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
23046 #: ../fish/guestfish.pod:1117 ../test-tool/libguestfs-test-tool.pod:124
23047 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
23048 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512
23049 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
23050 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
23052 "This program is free software; you can redistribute it and/or modify it "
23053 "under the terms of the GNU General Public License as published by the Free "
23054 "Software Foundation; either version 2 of the License, or (at your option) "
23055 "any later version."
23060 #: ../fish/guestfish.pod:1122 ../test-tool/libguestfs-test-tool.pod:129
23061 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
23062 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517
23063 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
23064 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
23066 "This program is distributed in the hope that it will be useful, but WITHOUT "
23067 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
23068 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
23074 #: ../fish/guestfish.pod:1127 ../test-tool/libguestfs-test-tool.pod:134
23075 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
23076 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522
23077 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
23078 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
23080 "You should have received a copy of the GNU General Public License along with "
23081 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
23082 "Ave, Cambridge, MA 02139, USA."
23087 #: ../fish/guestfish-actions.pod:1
23093 #: ../fish/guestfish-actions.pod:3
23096 " add-cdrom filename\n"
23102 #: ../fish/guestfish-actions.pod:15
23104 "This call checks for the existence of C<filename>. This stops you from "
23105 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23106 "and C<http:> URLs. To specify those, use the general L</config> call "
23112 #: ../fish/guestfish-actions.pod:22
23114 "If you just want to add an ISO file (often you use this as an efficient way "
23115 "to transfer large files into the guest), then you should probably use L</add-"
23116 "drive-ro> instead."
23121 #: ../fish/guestfish-actions.pod:35
23127 #: ../fish/guestfish-actions.pod:37
23133 #: ../fish/guestfish-actions.pod:39
23136 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
23142 #: ../fish/guestfish-actions.pod:41
23144 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
23145 "It works by connecting to libvirt, requesting the domain and domain XML from "
23146 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
23151 #: ../fish/guestfish-actions.pod:64
23153 "The other optional parameters are passed directly through to L</add-drive-"
23159 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131
23160 #: ../fish/guestfish-actions.pod:2848
23162 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
23167 #: ../fish/guestfish-actions.pod:69
23173 #: ../fish/guestfish-actions.pod:71
23176 " add-drive filename\n"
23182 #: ../fish/guestfish-actions.pod:73
23184 "This function is the equivalent of calling L</add-drive-opts> with no "
23185 "optional parameters, so the disk is added writable, with the format being "
23186 "detected automatically."
23191 #: ../fish/guestfish-actions.pod:77
23193 "Automatic detection of the format opens you up to a potential security hole "
23194 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
23195 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
23196 "you should think about replacing calls to this function with calls to L</add-"
23197 "drive-opts>, and specifying the format."
23202 #: ../fish/guestfish-actions.pod:84
23203 msgid "add-drive-opts"
23208 #: ../fish/guestfish-actions.pod:86
23214 #: ../fish/guestfish-actions.pod:88
23217 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
23223 #: ../fish/guestfish-actions.pod:115
23225 "This forces the image format. If you omit this (or use L</add-drive> or L</"
23226 "add-drive-ro>) then the format is automatically detected. Possible formats "
23227 "include C<raw> and C<qcow2>."
23232 #: ../fish/guestfish-actions.pod:126
23234 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
23235 "add-drive-with-if> call (q.v.)"
23240 #: ../fish/guestfish-actions.pod:133
23241 msgid "add-drive-ro"
23246 #: ../fish/guestfish-actions.pod:135
23252 #: ../fish/guestfish-actions.pod:137
23255 " add-drive-ro filename\n"
23261 #: ../fish/guestfish-actions.pod:139
23263 "This function is the equivalent of calling L</add-drive-opts> with the "
23264 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
23265 "is added read-only, with the format being detected automatically."
23270 #: ../fish/guestfish-actions.pod:144
23271 msgid "add-drive-ro-with-if"
23276 #: ../fish/guestfish-actions.pod:146
23279 " add-drive-ro-with-if filename iface\n"
23285 #: ../fish/guestfish-actions.pod:148
23287 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
23288 "interface emulation to use at run time."
23293 #: ../fish/guestfish-actions.pod:158
23294 msgid "add-drive-with-if"
23299 #: ../fish/guestfish-actions.pod:160
23302 " add-drive-with-if filename iface\n"
23308 #: ../fish/guestfish-actions.pod:162
23310 "This is the same as L</add-drive> but it allows you to specify the QEMU "
23311 "interface emulation to use at run time."
23316 #: ../fish/guestfish-actions.pod:172
23322 #: ../fish/guestfish-actions.pod:174
23325 " aug-clear augpath\n"
23331 #: ../fish/guestfish-actions.pod:179
23337 #: ../fish/guestfish-actions.pod:181
23346 #: ../fish/guestfish-actions.pod:183
23348 "Close the current Augeas handle and free up any resources used by it. After "
23349 "calling this, you have to call L</aug-init> again before you can use any "
23350 "other Augeas functions."
23355 #: ../fish/guestfish-actions.pod:188
23356 msgid "aug-defnode"
23361 #: ../fish/guestfish-actions.pod:190
23364 " aug-defnode name expr val\n"
23370 #: ../fish/guestfish-actions.pod:195
23372 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
23373 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
23374 "containing that single node."
23379 #: ../fish/guestfish-actions.pod:203
23385 #: ../fish/guestfish-actions.pod:205
23388 " aug-defvar name expr\n"
23394 #: ../fish/guestfish-actions.pod:214
23400 #: ../fish/guestfish-actions.pod:216
23403 " aug-get augpath\n"
23409 #: ../fish/guestfish-actions.pod:221
23415 #: ../fish/guestfish-actions.pod:223
23418 " aug-init root flags\n"
23424 #: ../fish/guestfish-actions.pod:229
23425 msgid "You must call this before using any other L</aug-*> commands."
23430 #: ../fish/guestfish-actions.pod:264
23431 msgid "Do not load the tree in L</aug-init>."
23436 #: ../fish/guestfish-actions.pod:268
23437 msgid "To close the handle, you can call L</aug-close>."
23442 #: ../fish/guestfish-actions.pod:272
23448 #: ../fish/guestfish-actions.pod:274
23451 " aug-insert augpath label true|false\n"
23457 #: ../fish/guestfish-actions.pod:284
23463 #: ../fish/guestfish-actions.pod:286
23472 #: ../fish/guestfish-actions.pod:293
23478 #: ../fish/guestfish-actions.pod:295
23481 " aug-ls augpath\n"
23487 #: ../fish/guestfish-actions.pod:297
23489 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
23490 "resulting nodes into alphabetical order."
23495 #: ../fish/guestfish-actions.pod:300
23501 #: ../fish/guestfish-actions.pod:302
23504 " aug-match augpath\n"
23510 #: ../fish/guestfish-actions.pod:308
23516 #: ../fish/guestfish-actions.pod:310
23519 " aug-mv src dest\n"
23525 #: ../fish/guestfish-actions.pod:315
23531 #: ../fish/guestfish-actions.pod:317
23534 " aug-rm augpath\n"
23540 #: ../fish/guestfish-actions.pod:323
23546 #: ../fish/guestfish-actions.pod:325
23555 #: ../fish/guestfish-actions.pod:329
23557 "The flags which were passed to L</aug-init> affect exactly how files are "
23563 #: ../fish/guestfish-actions.pod:332
23569 #: ../fish/guestfish-actions.pod:334
23572 " aug-set augpath val\n"
23578 #: ../fish/guestfish-actions.pod:338
23580 "In the Augeas API, it is possible to clear a node by setting the value to "
23581 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23582 "this call. Instead you must use the L</aug-clear> call."
23587 #: ../fish/guestfish-actions.pod:343
23593 #: ../fish/guestfish-actions.pod:345
23596 " available 'groups ...'\n"
23602 #: ../fish/guestfish-actions.pod:351
23604 "The libguestfs groups, and the functions that those groups correspond to, "
23605 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23606 "runtime by calling L</available-all-groups>."
23611 #: ../fish/guestfish-actions.pod:375
23612 msgid "You must call L</launch> before calling this function."
23617 #: ../fish/guestfish-actions.pod:397
23619 "This call was added in version C<1.0.80>. In previous versions of "
23620 "libguestfs all you could do would be to speculatively execute a command to "
23621 "find out if the daemon implemented it. See also L</version>."
23626 #: ../fish/guestfish-actions.pod:404
23627 msgid "available-all-groups"
23632 #: ../fish/guestfish-actions.pod:406
23635 " available-all-groups\n"
23641 #: ../fish/guestfish-actions.pod:408
23643 "This command returns a list of all optional groups that this daemon knows "
23644 "about. Note this returns both supported and unsupported groups. To find "
23645 "out which ones the daemon can actually support you have to call L</"
23646 "available> on each member of the returned list."
23651 #: ../fish/guestfish-actions.pod:414
23652 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23657 #: ../fish/guestfish-actions.pod:416
23663 #: ../fish/guestfish-actions.pod:418
23666 " base64-in (base64file|-) filename\n"
23672 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432
23673 #: ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825
23674 #: ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1221
23675 #: ../fish/guestfish-actions.pod:4203 ../fish/guestfish-actions.pod:4215
23676 #: ../fish/guestfish-actions.pod:4226 ../fish/guestfish-actions.pod:4237
23677 #: ../fish/guestfish-actions.pod:4289 ../fish/guestfish-actions.pod:4298
23678 #: ../fish/guestfish-actions.pod:4352 ../fish/guestfish-actions.pod:4375
23679 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23684 #: ../fish/guestfish-actions.pod:425
23690 #: ../fish/guestfish-actions.pod:427
23693 " base64-out filename (base64file|-)\n"
23699 #: ../fish/guestfish-actions.pod:434
23700 msgid "blockdev-flushbufs"
23705 #: ../fish/guestfish-actions.pod:436
23708 " blockdev-flushbufs device\n"
23714 #: ../fish/guestfish-actions.pod:443
23715 msgid "blockdev-getbsz"
23720 #: ../fish/guestfish-actions.pod:445
23723 " blockdev-getbsz device\n"
23729 #: ../fish/guestfish-actions.pod:454
23730 msgid "blockdev-getro"
23735 #: ../fish/guestfish-actions.pod:456
23738 " blockdev-getro device\n"
23744 #: ../fish/guestfish-actions.pod:463
23745 msgid "blockdev-getsize64"
23750 #: ../fish/guestfish-actions.pod:465
23753 " blockdev-getsize64 device\n"
23759 #: ../fish/guestfish-actions.pod:469
23760 msgid "See also L</blockdev-getsz>."
23765 #: ../fish/guestfish-actions.pod:473
23766 msgid "blockdev-getss"
23771 #: ../fish/guestfish-actions.pod:475
23774 " blockdev-getss device\n"
23780 #: ../fish/guestfish-actions.pod:480
23782 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23787 #: ../fish/guestfish-actions.pod:485
23788 msgid "blockdev-getsz"
23793 #: ../fish/guestfish-actions.pod:487
23796 " blockdev-getsz device\n"
23802 #: ../fish/guestfish-actions.pod:492
23804 "See also L</blockdev-getss> for the real sector size of the device, and L</"
23805 "blockdev-getsize64> for the more useful I<size in bytes>."
23810 #: ../fish/guestfish-actions.pod:498
23811 msgid "blockdev-rereadpt"
23816 #: ../fish/guestfish-actions.pod:500
23819 " blockdev-rereadpt device\n"
23825 #: ../fish/guestfish-actions.pod:506
23826 msgid "blockdev-setbsz"
23831 #: ../fish/guestfish-actions.pod:508
23834 " blockdev-setbsz device blocksize\n"
23840 #: ../fish/guestfish-actions.pod:517
23841 msgid "blockdev-setro"
23846 #: ../fish/guestfish-actions.pod:519
23849 " blockdev-setro device\n"
23855 #: ../fish/guestfish-actions.pod:525
23856 msgid "blockdev-setrw"
23861 #: ../fish/guestfish-actions.pod:527
23864 " blockdev-setrw device\n"
23870 #: ../fish/guestfish-actions.pod:533
23871 msgid "case-sensitive-path"
23876 #: ../fish/guestfish-actions.pod:535
23879 " case-sensitive-path path\n"
23885 #: ../fish/guestfish-actions.pod:559
23887 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
23888 "WINDOWS/system32\"> (the exact return value would depend on details of how "
23889 "the directories were originally created under Windows)."
23894 #: ../fish/guestfish-actions.pod:567
23895 msgid "See also L</realpath>."
23900 #: ../fish/guestfish-actions.pod:569
23906 #: ../fish/guestfish-actions.pod:571
23915 #: ../fish/guestfish-actions.pod:575
23917 "Note that this function cannot correctly handle binary files (specifically, "
23918 "files containing C<\\0> character which is treated as end of string). For "
23919 "those you need to use the L</read-file> or L</download> functions which have "
23920 "a more complex interface."
23925 #: ../fish/guestfish-actions.pod:583
23931 #: ../fish/guestfish-actions.pod:585
23934 " checksum csumtype path\n"
23940 #: ../fish/guestfish-actions.pod:628
23941 msgid "To get the checksum for a device, use L</checksum-device>."
23946 #: ../fish/guestfish-actions.pod:630
23947 msgid "To get the checksums for many files, use L</checksums-out>."
23952 #: ../fish/guestfish-actions.pod:632
23953 msgid "checksum-device"
23958 #: ../fish/guestfish-actions.pod:634
23961 " checksum-device csumtype device\n"
23967 #: ../fish/guestfish-actions.pod:636
23969 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23970 "device named C<device>. For the types of checksums supported see the L</"
23971 "checksum> command."
23976 #: ../fish/guestfish-actions.pod:640
23977 msgid "checksums-out"
23982 #: ../fish/guestfish-actions.pod:642
23985 " checksums-out csumtype directory (sumsfile|-)\n"
23991 #: ../fish/guestfish-actions.pod:658
23997 #: ../fish/guestfish-actions.pod:660
24000 " chmod mode path\n"
24006 #: ../fish/guestfish-actions.pod:671
24012 #: ../fish/guestfish-actions.pod:673
24015 " chown owner group path\n"
24021 #: ../fish/guestfish-actions.pod:681
24027 #: ../fish/guestfish-actions.pod:683
24030 " command 'arguments ...'\n"
24036 #: ../fish/guestfish-actions.pod:690
24038 "The single parameter is an argv-style list of arguments. The first element "
24039 "is the name of the program to run. Subsequent elements are parameters. The "
24040 "list must be non-empty (ie. must contain a program name). Note that the "
24041 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
24046 #: ../fish/guestfish-actions.pod:718
24047 msgid "command-lines"
24052 #: ../fish/guestfish-actions.pod:720
24055 " command-lines 'arguments ...'\n"
24061 #: ../fish/guestfish-actions.pod:722
24063 "This is the same as L</command>, but splits the result into a list of lines."
24068 #: ../fish/guestfish-actions.pod:725
24069 msgid "See also: L</sh-lines>"
24074 #: ../fish/guestfish-actions.pod:730
24080 #: ../fish/guestfish-actions.pod:732
24083 " config qemuparam qemuvalue\n"
24089 #: ../fish/guestfish-actions.pod:743
24095 #: ../fish/guestfish-actions.pod:745
24098 " copy-size src dest size\n"
24104 #: ../fish/guestfish-actions.pod:753
24110 #: ../fish/guestfish-actions.pod:755
24119 #: ../fish/guestfish-actions.pod:760
24125 #: ../fish/guestfish-actions.pod:762
24134 #: ../fish/guestfish-actions.pod:767
24140 #: ../fish/guestfish-actions.pod:769
24149 #: ../fish/guestfish-actions.pod:776
24151 "If the destination is a device, it must be as large or larger than the "
24152 "source file or device, otherwise the copy will fail. This command cannot do "
24153 "partial copies (see L</copy-size>)."
24158 #: ../fish/guestfish-actions.pod:780
24164 #: ../fish/guestfish-actions.pod:782
24173 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
24175 "This command is mostly useful for interactive sessions. It is I<not> "
24176 "intended that you try to parse the output string. Use L</statvfs> from "
24182 #: ../fish/guestfish-actions.pod:790
24188 #: ../fish/guestfish-actions.pod:792
24197 #: ../fish/guestfish-actions.pod:801
24203 #: ../fish/guestfish-actions.pod:803
24212 #: ../fish/guestfish-actions.pod:809
24214 "Another way to get the same information is to enable verbose messages with "
24215 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
24216 "before running the program."
24221 #: ../fish/guestfish-actions.pod:814
24227 #: ../fish/guestfish-actions.pod:816
24230 " download remotefilename (filename|-)\n"
24236 #: ../fish/guestfish-actions.pod:823
24237 msgid "See also L</upload>, L</cat>."
24242 #: ../fish/guestfish-actions.pod:827
24243 msgid "download-offset"
24248 #: ../fish/guestfish-actions.pod:829
24251 " download-offset remotefilename (filename|-) offset size\n"
24257 #: ../fish/guestfish-actions.pod:837
24259 "Note that there is no limit on the amount of data that can be downloaded "
24260 "with this call, unlike with L</pread>, and this call always reads the full "
24261 "amount unless an error occurs."
24266 #: ../fish/guestfish-actions.pod:842
24267 msgid "See also L</download>, L</pread>."
24272 #: ../fish/guestfish-actions.pod:846
24273 msgid "drop-caches"
24278 #: ../fish/guestfish-actions.pod:848
24281 " drop-caches whattodrop\n"
24287 #: ../fish/guestfish-actions.pod:860
24293 #: ../fish/guestfish-actions.pod:862
24302 #: ../fish/guestfish-actions.pod:874
24308 #: ../fish/guestfish-actions.pod:876
24311 " e2fsck-f device\n"
24317 #: ../fish/guestfish-actions.pod:882
24319 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
24320 "should use L</fsck>."
24325 #: ../fish/guestfish-actions.pod:885
24326 msgid "echo-daemon"
24331 #: ../fish/guestfish-actions.pod:887
24334 " echo-daemon 'words ...'\n"
24340 #: ../fish/guestfish-actions.pod:894
24341 msgid "See also L</ping-daemon>."
24346 #: ../fish/guestfish-actions.pod:896
24352 #: ../fish/guestfish-actions.pod:898
24355 " egrep regex path\n"
24361 #: ../fish/guestfish-actions.pod:906
24367 #: ../fish/guestfish-actions.pod:908
24370 " egrepi regex path\n"
24376 #: ../fish/guestfish-actions.pod:916
24382 #: ../fish/guestfish-actions.pod:918
24385 " equal file1 file2\n"
24391 #: ../fish/guestfish-actions.pod:925
24397 #: ../fish/guestfish-actions.pod:927
24406 #: ../fish/guestfish-actions.pod:932
24407 msgid "See also L</is-file>, L</is-dir>, L</stat>."
24412 #: ../fish/guestfish-actions.pod:934
24418 #: ../fish/guestfish-actions.pod:936
24421 " fallocate path len\n"
24427 #: ../fish/guestfish-actions.pod:953
24428 msgid "fallocate64"
24433 #: ../fish/guestfish-actions.pod:955
24436 " fallocate64 path len\n"
24442 #: ../fish/guestfish-actions.pod:961
24444 "Note that this call allocates disk blocks for the file. To create a sparse "
24445 "file use L</truncate-size> instead."
24450 #: ../fish/guestfish-actions.pod:964
24452 "The deprecated call L</fallocate> does the same, but owing to an oversight "
24453 "it only allowed 30 bit lengths to be specified, effectively limiting the "
24454 "maximum size of files created through that call to 1GB."
24459 #: ../fish/guestfish-actions.pod:973
24465 #: ../fish/guestfish-actions.pod:975
24468 " fgrep pattern path\n"
24474 #: ../fish/guestfish-actions.pod:983
24480 #: ../fish/guestfish-actions.pod:985
24483 " fgrepi pattern path\n"
24489 #: ../fish/guestfish-actions.pod:993
24495 #: ../fish/guestfish-actions.pod:995
24504 #: ../fish/guestfish-actions.pod:1007
24506 "This command can also be used on C</dev/> devices (and partitions, LV "
24507 "names). You can for example use this to determine if a device contains a "
24508 "filesystem, although it's usually better to use L</vfs-type>."
24513 #: ../fish/guestfish-actions.pod:1017
24514 msgid "file-architecture"
24519 #: ../fish/guestfish-actions.pod:1019
24522 " file-architecture filename\n"
24528 #: ../fish/guestfish-actions.pod:1122
24534 #: ../fish/guestfish-actions.pod:1124
24543 #: ../fish/guestfish-actions.pod:1128
24545 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
24546 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
24551 #: ../fish/guestfish-actions.pod:1132
24557 #: ../fish/guestfish-actions.pod:1134
24560 " fill c len path\n"
24566 #: ../fish/guestfish-actions.pod:1140
24568 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24569 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
24570 "L</fill-pattern>."
24575 #: ../fish/guestfish-actions.pod:1145
24576 msgid "fill-pattern"
24581 #: ../fish/guestfish-actions.pod:1147
24584 " fill-pattern pattern len path\n"
24590 #: ../fish/guestfish-actions.pod:1149
24592 "This function is like L</fill> except that it creates a new file of length "
24593 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
24594 "is truncated if necessary to ensure the length of the file is exactly C<len> "
24600 #: ../fish/guestfish-actions.pod:1154
24606 #: ../fish/guestfish-actions.pod:1156
24609 " find directory\n"
24615 #: ../fish/guestfish-actions.pod:1170
24616 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
24621 #: ../fish/guestfish-actions.pod:1183
24622 msgid "See also L</find0>."
24627 #: ../fish/guestfish-actions.pod:1188
24633 #: ../fish/guestfish-actions.pod:1190
24636 " find0 directory (files|-)\n"
24642 #: ../fish/guestfish-actions.pod:1196
24644 "This command works the same way as L</find> with the following exceptions:"
24649 #: ../fish/guestfish-actions.pod:1223
24650 msgid "findfs-label"
24655 #: ../fish/guestfish-actions.pod:1225
24658 " findfs-label label\n"
24664 #: ../fish/guestfish-actions.pod:1231
24665 msgid "To find the label of a filesystem, use L</vfs-label>."
24670 #: ../fish/guestfish-actions.pod:1233
24671 msgid "findfs-uuid"
24676 #: ../fish/guestfish-actions.pod:1235
24679 " findfs-uuid uuid\n"
24685 #: ../fish/guestfish-actions.pod:1241
24686 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
24691 #: ../fish/guestfish-actions.pod:1243
24697 #: ../fish/guestfish-actions.pod:1245
24700 " fsck fstype device\n"
24706 #: ../fish/guestfish-actions.pod:1275
24712 #: ../fish/guestfish-actions.pod:1277
24721 #: ../fish/guestfish-actions.pod:1284
24722 msgid "get-autosync"
24727 #: ../fish/guestfish-actions.pod:1286
24736 #: ../fish/guestfish-actions.pod:1290
24742 #: ../fish/guestfish-actions.pod:1292
24751 #: ../fish/guestfish-actions.pod:1296
24752 msgid "get-e2label"
24757 #: ../fish/guestfish-actions.pod:1298
24760 " get-e2label device\n"
24766 #: ../fish/guestfish-actions.pod:1310
24772 #: ../fish/guestfish-actions.pod:1312
24775 " get-e2uuid device\n"
24781 #: ../fish/guestfish-actions.pod:1324
24782 msgid "get-memsize"
24787 #: ../fish/guestfish-actions.pod:1326
24796 #: ../fish/guestfish-actions.pod:1331
24798 "If L</set-memsize> was not called on this handle, and if "
24799 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24800 "value for memsize."
24805 #: ../fish/guestfish-actions.pod:1338
24806 msgid "get-network"
24811 #: ../fish/guestfish-actions.pod:1340
24820 #: ../fish/guestfish-actions.pod:1344
24826 #: ../fish/guestfish-actions.pod:1346
24835 #: ../fish/guestfish-actions.pod:1353
24841 #: ../fish/guestfish-actions.pod:1355
24847 #: ../fish/guestfish-actions.pod:1357
24856 #: ../fish/guestfish-actions.pod:1364
24862 #: ../fish/guestfish-actions.pod:1366
24871 #: ../fish/guestfish-actions.pod:1373
24872 msgid "get-recovery-proc"
24877 #: ../fish/guestfish-actions.pod:1375
24880 " get-recovery-proc\n"
24886 #: ../fish/guestfish-actions.pod:1379
24887 msgid "get-selinux"
24892 #: ../fish/guestfish-actions.pod:1381
24901 #: ../fish/guestfish-actions.pod:1383
24903 "This returns the current setting of the selinux flag which is passed to the "
24904 "appliance at boot time. See L</set-selinux>."
24909 #: ../fish/guestfish-actions.pod:1389
24915 #: ../fish/guestfish-actions.pod:1391
24924 #: ../fish/guestfish-actions.pod:1398
24930 #: ../fish/guestfish-actions.pod:1400
24939 #: ../fish/guestfish-actions.pod:1404
24945 #: ../fish/guestfish-actions.pod:1406
24954 #: ../fish/guestfish-actions.pod:1408
24956 "Return the current umask. By default the umask is C<022> unless it has been "
24957 "set by calling L</umask>."
24962 #: ../fish/guestfish-actions.pod:1411
24963 msgid "get-verbose"
24968 #: ../fish/guestfish-actions.pod:1413
24977 #: ../fish/guestfish-actions.pod:1417
24983 #: ../fish/guestfish-actions.pod:1419
24992 #: ../fish/guestfish-actions.pod:1423
24993 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
24998 #: ../fish/guestfish-actions.pod:1426
25004 #: ../fish/guestfish-actions.pod:1428
25007 " getxattr path name\n"
25013 #: ../fish/guestfish-actions.pod:1430
25015 "Get a single extended attribute from file C<path> named C<name>. This call "
25016 "follows symlinks. If you want to lookup an extended attribute for the "
25017 "symlink itself, use L</lgetxattr>."
25022 #: ../fish/guestfish-actions.pod:1434 ../fish/guestfish-actions.pod:2265
25024 "Normally it is better to get all extended attributes from a file in one go "
25025 "by calling L</getxattrs>. However some Linux filesystem implementations are "
25026 "buggy and do not provide a way to list out attributes. For these "
25027 "filesystems (notably ntfs-3g) you have to know the names of the extended "
25028 "attributes you want in advance and call this function."
25033 #: ../fish/guestfish-actions.pod:1444
25034 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
25039 #: ../fish/guestfish-actions.pod:1446
25045 #: ../fish/guestfish-actions.pod:1448
25048 " getxattrs path\n"
25054 #: ../fish/guestfish-actions.pod:1456
25055 msgid "See also: L</lgetxattrs>, L<attr(5)>."
25060 #: ../fish/guestfish-actions.pod:1458
25061 msgid "glob-expand"
25066 #: ../fish/guestfish-actions.pod:1460
25069 " glob-expand pattern\n"
25075 #: ../fish/guestfish-actions.pod:1473
25081 #: ../fish/guestfish-actions.pod:1475
25084 " grep regex path\n"
25090 #: ../fish/guestfish-actions.pod:1483
25096 #: ../fish/guestfish-actions.pod:1485
25099 " grepi regex path\n"
25105 #: ../fish/guestfish-actions.pod:1493
25106 msgid "grub-install"
25111 #: ../fish/guestfish-actions.pod:1495
25114 " grub-install root device\n"
25120 #: ../fish/guestfish-actions.pod:1511
25126 #: ../fish/guestfish-actions.pod:1513
25135 #: ../fish/guestfish-actions.pod:1521
25141 #: ../fish/guestfish-actions.pod:1523
25144 " head-n nrlines path\n"
25150 #: ../fish/guestfish-actions.pod:1536
25156 #: ../fish/guestfish-actions.pod:1538
25165 #: ../fish/guestfish-actions.pod:1546
25171 #: ../fish/guestfish-actions.pod:1548
25174 " initrd-cat initrdpath filename\n"
25180 #: ../fish/guestfish-actions.pod:1560
25181 msgid "See also L</initrd-list>."
25186 #: ../fish/guestfish-actions.pod:1565
25187 msgid "initrd-list"
25192 #: ../fish/guestfish-actions.pod:1567
25195 " initrd-list path\n"
25201 #: ../fish/guestfish-actions.pod:1579
25202 msgid "inotify-add-watch"
25207 #: ../fish/guestfish-actions.pod:1581
25210 " inotify-add-watch path mask\n"
25216 #: ../fish/guestfish-actions.pod:1593
25217 msgid "inotify-close"
25222 #: ../fish/guestfish-actions.pod:1595
25231 #: ../fish/guestfish-actions.pod:1601
25232 msgid "inotify-files"
25237 #: ../fish/guestfish-actions.pod:1603
25246 #: ../fish/guestfish-actions.pod:1605
25248 "This function is a helpful wrapper around L</inotify-read> which just "
25249 "returns a list of pathnames of objects that were touched. The returned "
25250 "pathnames are sorted and deduplicated."
25255 #: ../fish/guestfish-actions.pod:1609
25256 msgid "inotify-init"
25261 #: ../fish/guestfish-actions.pod:1611
25264 " inotify-init maxevents\n"
25270 #: ../fish/guestfish-actions.pod:1617
25272 "C<maxevents> is the maximum number of events which will be queued up between "
25273 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
25274 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
25275 "default was 16384 events. Beyond this limit, the kernel throws away events, "
25276 "but records the fact that it threw them away by setting a flag "
25277 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
25282 #: ../fish/guestfish-actions.pod:1627
25284 "Before any events are generated, you have to add some watches to the "
25285 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
25286 "L</inotify-watch-all>."
25291 #: ../fish/guestfish-actions.pod:1633
25293 "Queued up events should be read periodically by calling L</inotify-read> (or "
25294 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
25295 "If you don't read the events out often enough then you risk the internal "
25296 "queue overflowing."
25301 #: ../fish/guestfish-actions.pod:1640
25303 "The handle should be closed after use by calling L</inotify-close>. This "
25304 "also removes any watches automatically."
25309 #: ../fish/guestfish-actions.pod:1649
25310 msgid "inotify-read"
25315 #: ../fish/guestfish-actions.pod:1651
25324 #: ../fish/guestfish-actions.pod:1664
25325 msgid "inotify-rm-watch"
25330 #: ../fish/guestfish-actions.pod:1666
25333 " inotify-rm-watch wd\n"
25339 #: ../fish/guestfish-actions.pod:1668
25340 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
25345 #: ../fish/guestfish-actions.pod:1671
25346 msgid "inspect-get-arch"
25351 #: ../fish/guestfish-actions.pod:1673
25354 " inspect-get-arch root\n"
25360 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1691
25361 #: ../fish/guestfish-actions.pod:1765 ../fish/guestfish-actions.pod:1783
25362 #: ../fish/guestfish-actions.pod:1798 ../fish/guestfish-actions.pod:1819
25363 #: ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1861
25364 #: ../fish/guestfish-actions.pod:1883 ../fish/guestfish-actions.pod:1907
25365 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:1972
25366 #: ../fish/guestfish-actions.pod:1988
25368 "This function should only be called with a root device string as returned by "
25374 #: ../fish/guestfish-actions.pod:1678
25376 "This returns the architecture of the inspected operating system. The "
25377 "possible return values are listed under L</file-architecture>."
25382 #: ../fish/guestfish-actions.pod:1687
25383 msgid "inspect-get-distro"
25388 #: ../fish/guestfish-actions.pod:1689
25391 " inspect-get-distro root\n"
25397 #: ../fish/guestfish-actions.pod:1761
25398 msgid "inspect-get-filesystems"
25403 #: ../fish/guestfish-actions.pod:1763
25406 " inspect-get-filesystems root\n"
25412 #: ../fish/guestfish-actions.pod:1776
25414 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25415 "get-mountpoints>."
25420 #: ../fish/guestfish-actions.pod:1779
25421 msgid "inspect-get-hostname"
25426 #: ../fish/guestfish-actions.pod:1781
25429 " inspect-get-hostname root\n"
25435 #: ../fish/guestfish-actions.pod:1794
25436 msgid "inspect-get-major-version"
25441 #: ../fish/guestfish-actions.pod:1796
25444 " inspect-get-major-version root\n"
25450 #: ../fish/guestfish-actions.pod:1815
25451 msgid "inspect-get-minor-version"
25456 #: ../fish/guestfish-actions.pod:1817
25459 " inspect-get-minor-version root\n"
25465 #: ../fish/guestfish-actions.pod:1827
25467 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25468 "get-major-version>."
25473 #: ../fish/guestfish-actions.pod:1830
25474 msgid "inspect-get-mountpoints"
25479 #: ../fish/guestfish-actions.pod:1832
25482 " inspect-get-mountpoints root\n"
25488 #: ../fish/guestfish-actions.pod:1854
25490 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25491 "get-filesystems>."
25496 #: ../fish/guestfish-actions.pod:1857
25497 msgid "inspect-get-package-format"
25502 #: ../fish/guestfish-actions.pod:1859
25505 " inspect-get-package-format root\n"
25511 #: ../fish/guestfish-actions.pod:1864
25513 "This function and L</inspect-get-package-management> return the package "
25514 "format and package management tool used by the inspected operating system. "
25515 "For example for Fedora these functions would return C<rpm> (package format) "
25516 "and C<yum> (package management)."
25521 #: ../fish/guestfish-actions.pod:1879
25522 msgid "inspect-get-package-management"
25527 #: ../fish/guestfish-actions.pod:1881
25530 " inspect-get-package-management root\n"
25536 #: ../fish/guestfish-actions.pod:1886
25538 "L</inspect-get-package-format> and this function return the package format "
25539 "and package management tool used by the inspected operating system. For "
25540 "example for Fedora these functions would return C<rpm> (package format) and "
25541 "C<yum> (package management)."
25546 #: ../fish/guestfish-actions.pod:1903
25547 msgid "inspect-get-product-name"
25552 #: ../fish/guestfish-actions.pod:1905
25555 " inspect-get-product-name root\n"
25561 #: ../fish/guestfish-actions.pod:1920
25562 msgid "inspect-get-roots"
25567 #: ../fish/guestfish-actions.pod:1922
25570 " inspect-get-roots\n"
25576 #: ../fish/guestfish-actions.pod:1924
25578 "This function is a convenient way to get the list of root devices, as "
25579 "returned from a previous call to L</inspect-os>, but without redoing the "
25580 "whole inspection process."
25585 #: ../fish/guestfish-actions.pod:1928
25587 "This returns an empty list if either no root devices were found or the "
25588 "caller has not called L</inspect-os>."
25593 #: ../fish/guestfish-actions.pod:1933
25594 msgid "inspect-get-type"
25599 #: ../fish/guestfish-actions.pod:1935
25602 " inspect-get-type root\n"
25608 #: ../fish/guestfish-actions.pod:1968
25609 msgid "inspect-get-windows-systemroot"
25614 #: ../fish/guestfish-actions.pod:1970
25617 " inspect-get-windows-systemroot root\n"
25623 #: ../fish/guestfish-actions.pod:1984
25624 msgid "inspect-list-applications"
25629 #: ../fish/guestfish-actions.pod:1986
25632 " inspect-list-applications root\n"
25638 #: ../fish/guestfish-actions.pod:1993
25640 "I<Note:> This call works differently from other parts of the inspection "
25641 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
25642 "then mount up the disks, before calling this. Listing applications is a "
25643 "significantly more difficult operation which requires access to the full "
25644 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
25645 "are just returning data cached in the libguestfs handle, this call actually "
25646 "reads parts of the mounted filesystems during the call."
25651 #: ../fish/guestfish-actions.pod:2083
25657 #: ../fish/guestfish-actions.pod:2085
25666 #: ../fish/guestfish-actions.pod:2100
25668 "You can pass the root string(s) returned to other L</inspect-get-*> "
25669 "functions in order to query further information about each operating system, "
25670 "such as the name and version."
25675 #: ../fish/guestfish-actions.pod:2105
25677 "This function uses other libguestfs features such as L</mount-ro> and L</"
25678 "umount-all> in order to mount and unmount filesystems and look at the "
25679 "contents. This should be called with no disks currently mounted. The "
25680 "function may also use Augeas, so any existing Augeas handle will be closed."
25685 #: ../fish/guestfish-actions.pod:2117 ../fish/guestfish-actions.pod:2293
25686 #: ../fish/guestfish-actions.pod:2339
25687 msgid "See also L</list-filesystems>."
25692 #: ../fish/guestfish-actions.pod:2119
25693 msgid "is-blockdev"
25698 #: ../fish/guestfish-actions.pod:2121
25701 " is-blockdev path\n"
25707 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2144
25708 #: ../fish/guestfish-actions.pod:2163 ../fish/guestfish-actions.pod:2172
25709 #: ../fish/guestfish-actions.pod:2182 ../fish/guestfish-actions.pod:2216
25710 #: ../fish/guestfish-actions.pod:2225
25711 msgid "See also L</stat>."
25716 #: ../fish/guestfish-actions.pod:2128
25722 #: ../fish/guestfish-actions.pod:2130
25731 #: ../fish/guestfish-actions.pod:2137
25737 #: ../fish/guestfish-actions.pod:2139
25740 " is-chardev path\n"
25746 #: ../fish/guestfish-actions.pod:2146
25752 #: ../fish/guestfish-actions.pod:2148
25761 #: ../fish/guestfish-actions.pod:2155
25767 #: ../fish/guestfish-actions.pod:2157
25776 #: ../fish/guestfish-actions.pod:2165
25782 #: ../fish/guestfish-actions.pod:2167
25791 #: ../fish/guestfish-actions.pod:2174
25797 #: ../fish/guestfish-actions.pod:2176
25806 #: ../fish/guestfish-actions.pod:2184
25807 msgid "is-launching"
25812 #: ../fish/guestfish-actions.pod:2186
25821 #: ../fish/guestfish-actions.pod:2193
25827 #: ../fish/guestfish-actions.pod:2195
25836 #: ../fish/guestfish-actions.pod:2200
25842 #: ../fish/guestfish-actions.pod:2202
25851 #: ../fish/guestfish-actions.pod:2209
25857 #: ../fish/guestfish-actions.pod:2211
25860 " is-socket path\n"
25866 #: ../fish/guestfish-actions.pod:2218
25872 #: ../fish/guestfish-actions.pod:2220
25875 " is-symlink path\n"
25881 #: ../fish/guestfish-actions.pod:2227
25882 msgid "kill-subprocess"
25887 #: ../fish/guestfish-actions.pod:2229
25890 " kill-subprocess\n"
25896 #: ../fish/guestfish-actions.pod:2233
25902 #: ../fish/guestfish-actions.pod:2235
25908 #: ../fish/guestfish-actions.pod:2237
25917 #: ../fish/guestfish-actions.pod:2245
25923 #: ../fish/guestfish-actions.pod:2247
25926 " lchown owner group path\n"
25932 #: ../fish/guestfish-actions.pod:2249
25934 "Change the file owner to C<owner> and group to C<group>. This is like L</"
25935 "chown> but if C<path> is a symlink then the link itself is changed, not the "
25941 #: ../fish/guestfish-actions.pod:2257
25947 #: ../fish/guestfish-actions.pod:2259
25950 " lgetxattr path name\n"
25956 #: ../fish/guestfish-actions.pod:2275
25957 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25962 #: ../fish/guestfish-actions.pod:2277
25968 #: ../fish/guestfish-actions.pod:2279
25971 " lgetxattrs path\n"
25977 #: ../fish/guestfish-actions.pod:2281
25979 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25980 "it returns the extended attributes of the link itself."
25985 #: ../fish/guestfish-actions.pod:2285
25986 msgid "list-devices"
25991 #: ../fish/guestfish-actions.pod:2287
26000 #: ../fish/guestfish-actions.pod:2295
26001 msgid "list-filesystems"
26006 #: ../fish/guestfish-actions.pod:2297
26009 " list-filesystems\n"
26015 #: ../fish/guestfish-actions.pod:2316
26017 "This command runs other libguestfs commands, which might include L</mount> "
26018 "and L</umount>, and therefore you should use this soon after launch and only "
26019 "when nothing is mounted."
26024 #: ../fish/guestfish-actions.pod:2320
26026 "Not all of the filesystems returned will be mountable. In particular, swap "
26027 "partitions are returned in the list. Also this command does not check that "
26028 "each filesystem found is valid and mountable, and some filesystems might be "
26029 "mountable but require special options. Filesystems may not all belong to a "
26030 "single logical operating system (use L</inspect-os> to look for OSes)."
26035 #: ../fish/guestfish-actions.pod:2328
26036 msgid "list-partitions"
26041 #: ../fish/guestfish-actions.pod:2330
26044 " list-partitions\n"
26050 #: ../fish/guestfish-actions.pod:2336
26052 "This does not return logical volumes. For that you will need to call L</"
26058 #: ../fish/guestfish-actions.pod:2341
26064 #: ../fish/guestfish-actions.pod:2343
26073 #: ../fish/guestfish-actions.pod:2351
26079 #: ../fish/guestfish-actions.pod:2353
26082 " ln target linkname\n"
26088 #: ../fish/guestfish-actions.pod:2357
26094 #: ../fish/guestfish-actions.pod:2359
26097 " ln-f target linkname\n"
26103 #: ../fish/guestfish-actions.pod:2364
26109 #: ../fish/guestfish-actions.pod:2366
26112 " ln-s target linkname\n"
26118 #: ../fish/guestfish-actions.pod:2370
26124 #: ../fish/guestfish-actions.pod:2372
26127 " ln-sf target linkname\n"
26133 #: ../fish/guestfish-actions.pod:2377
26134 msgid "lremovexattr"
26139 #: ../fish/guestfish-actions.pod:2379
26142 " lremovexattr xattr path\n"
26148 #: ../fish/guestfish-actions.pod:2381
26150 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
26151 "it removes an extended attribute of the link itself."
26156 #: ../fish/guestfish-actions.pod:2385
26162 #: ../fish/guestfish-actions.pod:2387
26171 #: ../fish/guestfish-actions.pod:2393
26173 "This command is mostly useful for interactive sessions. Programs should "
26174 "probably use L</readdir> instead."
26179 #: ../fish/guestfish-actions.pod:2396
26185 #: ../fish/guestfish-actions.pod:2398
26188 " lsetxattr xattr val vallen path\n"
26194 #: ../fish/guestfish-actions.pod:2400
26196 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
26197 "sets an extended attribute of the link itself."
26202 #: ../fish/guestfish-actions.pod:2404
26208 #: ../fish/guestfish-actions.pod:2406
26217 #: ../fish/guestfish-actions.pod:2410
26219 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
26220 "the link is stat-ed, not the file it refers to."
26225 #: ../fish/guestfish-actions.pod:2416
26231 #: ../fish/guestfish-actions.pod:2418
26234 " lstatlist path 'names ...'\n"
26240 #: ../fish/guestfish-actions.pod:2420
26242 "This call allows you to perform the L</lstat> operation on multiple files, "
26243 "where all files are in the directory C<path>. C<names> is the list of files "
26244 "from this directory."
26249 #: ../fish/guestfish-actions.pod:2429
26251 "This call is intended for programs that want to efficiently list a directory "
26252 "contents without making many round-trips. See also L</lxattrlist> for a "
26253 "similarly efficient call for getting extended attributes. Very long "
26254 "directory listings might cause the protocol message size to be exceeded, "
26255 "causing this call to fail. The caller must split up such requests into "
26256 "smaller groups of names."
26261 #: ../fish/guestfish-actions.pod:2437
26262 msgid "luks-add-key"
26267 #: ../fish/guestfish-actions.pod:2439
26270 " luks-add-key device keyslot\n"
26276 #: ../fish/guestfish-actions.pod:2446
26278 "Note that if C<keyslot> already contains a key, then this command will "
26279 "fail. You have to use L</luks-kill-slot> first to remove that key."
26284 #: ../fish/guestfish-actions.pod:2450 ../fish/guestfish-actions.pod:2472
26285 #: ../fish/guestfish-actions.pod:2485 ../fish/guestfish-actions.pod:2499
26286 #: ../fish/guestfish-actions.pod:2522 ../fish/guestfish-actions.pod:2532
26288 "This command has one or more key or passphrase parameters. Guestfish will "
26289 "prompt for these separately."
26294 #: ../fish/guestfish-actions.pod:2453
26300 #: ../fish/guestfish-actions.pod:2455
26303 " luks-close device\n"
26309 #: ../fish/guestfish-actions.pod:2457
26311 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
26312 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
26313 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
26319 #: ../fish/guestfish-actions.pod:2463
26320 msgid "luks-format"
26325 #: ../fish/guestfish-actions.pod:2465
26328 " luks-format device keyslot\n"
26334 #: ../fish/guestfish-actions.pod:2478
26335 msgid "luks-format-cipher"
26340 #: ../fish/guestfish-actions.pod:2480
26343 " luks-format-cipher device keyslot cipher\n"
26349 #: ../fish/guestfish-actions.pod:2482
26351 "This command is the same as L</luks-format> but it also allows you to set "
26352 "the C<cipher> used."
26357 #: ../fish/guestfish-actions.pod:2491
26358 msgid "luks-kill-slot"
26363 #: ../fish/guestfish-actions.pod:2493
26366 " luks-kill-slot device keyslot\n"
26372 #: ../fish/guestfish-actions.pod:2502
26378 #: ../fish/guestfish-actions.pod:2504
26381 " luks-open device mapname\n"
26387 #: ../fish/guestfish-actions.pod:2518
26389 "If this block device contains LVM volume groups, then calling L</vgscan> "
26390 "followed by L</vg-activate-all> will make them visible."
26395 #: ../fish/guestfish-actions.pod:2525
26396 msgid "luks-open-ro"
26401 #: ../fish/guestfish-actions.pod:2527
26404 " luks-open-ro device mapname\n"
26410 #: ../fish/guestfish-actions.pod:2529
26412 "This is the same as L</luks-open> except that a read-only mapping is created."
26417 #: ../fish/guestfish-actions.pod:2535
26423 #: ../fish/guestfish-actions.pod:2537
26426 " lvcreate logvol volgroup mbytes\n"
26432 #: ../fish/guestfish-actions.pod:2542
26433 msgid "lvm-canonical-lv-name"
26438 #: ../fish/guestfish-actions.pod:2544
26441 " lvm-canonical-lv-name lvname\n"
26447 #: ../fish/guestfish-actions.pod:2553
26448 msgid "See also L</is-lv>."
26453 #: ../fish/guestfish-actions.pod:2555
26454 msgid "lvm-clear-filter"
26459 #: ../fish/guestfish-actions.pod:2557
26462 " lvm-clear-filter\n"
26468 #: ../fish/guestfish-actions.pod:2559
26470 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
26476 #: ../fish/guestfish-actions.pod:2565
26477 msgid "lvm-remove-all"
26482 #: ../fish/guestfish-actions.pod:2567
26485 " lvm-remove-all\n"
26491 #: ../fish/guestfish-actions.pod:2575
26492 msgid "lvm-set-filter"
26497 #: ../fish/guestfish-actions.pod:2577
26500 " lvm-set-filter 'devices ...'\n"
26506 #: ../fish/guestfish-actions.pod:2602
26512 #: ../fish/guestfish-actions.pod:2604
26515 " lvremove device\n"
26521 #: ../fish/guestfish-actions.pod:2612
26527 #: ../fish/guestfish-actions.pod:2614
26530 " lvrename logvol newlogvol\n"
26536 #: ../fish/guestfish-actions.pod:2618
26542 #: ../fish/guestfish-actions.pod:2620
26545 " lvresize device mbytes\n"
26551 #: ../fish/guestfish-actions.pod:2626
26552 msgid "lvresize-free"
26557 #: ../fish/guestfish-actions.pod:2628
26560 " lvresize-free lv percent\n"
26566 #: ../fish/guestfish-actions.pod:2636
26572 #: ../fish/guestfish-actions.pod:2638
26581 #: ../fish/guestfish-actions.pod:2646
26582 msgid "See also L</lvs-full>, L</list-filesystems>."
26587 #: ../fish/guestfish-actions.pod:2648
26593 #: ../fish/guestfish-actions.pod:2650
26602 #: ../fish/guestfish-actions.pod:2655
26608 #: ../fish/guestfish-actions.pod:2657
26617 #: ../fish/guestfish-actions.pod:2661
26623 #: ../fish/guestfish-actions.pod:2663
26626 " lxattrlist path 'names ...'\n"
26632 #: ../fish/guestfish-actions.pod:2679
26634 "This call is intended for programs that want to efficiently list a directory "
26635 "contents without making many round-trips. See also L</lstatlist> for a "
26636 "similarly efficient call for getting standard stats. Very long directory "
26637 "listings might cause the protocol message size to be exceeded, causing this "
26638 "call to fail. The caller must split up such requests into smaller groups of "
26644 #: ../fish/guestfish-actions.pod:2687
26650 #: ../fish/guestfish-actions.pod:2689
26659 #: ../fish/guestfish-actions.pod:2693
26665 #: ../fish/guestfish-actions.pod:2695
26668 " mkdir-mode path mode\n"
26674 #: ../fish/guestfish-actions.pod:2704
26675 msgid "See also L</mkdir>, L</umask>"
26680 #: ../fish/guestfish-actions.pod:2706
26686 #: ../fish/guestfish-actions.pod:2708
26695 #: ../fish/guestfish-actions.pod:2713
26701 #: ../fish/guestfish-actions.pod:2715
26704 " mkdtemp template\n"
26710 #: ../fish/guestfish-actions.pod:2736
26716 #: ../fish/guestfish-actions.pod:2738
26719 " mke2fs-J fstype blocksize device journal\n"
26725 #: ../fish/guestfish-actions.pod:2746
26726 msgid "See also L</mke2journal>."
26731 #: ../fish/guestfish-actions.pod:2748
26737 #: ../fish/guestfish-actions.pod:2750
26740 " mke2fs-JL fstype blocksize device label\n"
26746 #: ../fish/guestfish-actions.pod:2755
26747 msgid "See also L</mke2journal-L>."
26752 #: ../fish/guestfish-actions.pod:2757
26758 #: ../fish/guestfish-actions.pod:2759
26761 " mke2fs-JU fstype blocksize device uuid\n"
26767 #: ../fish/guestfish-actions.pod:2764
26768 msgid "See also L</mke2journal-U>."
26773 #: ../fish/guestfish-actions.pod:2766
26774 msgid "mke2journal"
26779 #: ../fish/guestfish-actions.pod:2768
26782 " mke2journal blocksize device\n"
26788 #: ../fish/guestfish-actions.pod:2775
26789 msgid "mke2journal-L"
26794 #: ../fish/guestfish-actions.pod:2777
26797 " mke2journal-L blocksize label device\n"
26803 #: ../fish/guestfish-actions.pod:2781
26804 msgid "mke2journal-U"
26809 #: ../fish/guestfish-actions.pod:2783
26812 " mke2journal-U blocksize uuid device\n"
26818 #: ../fish/guestfish-actions.pod:2787
26824 #: ../fish/guestfish-actions.pod:2789
26827 " mkfifo mode path\n"
26833 #: ../fish/guestfish-actions.pod:2791
26835 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26836 "is just a convenient wrapper around L</mknod>."
26841 #: ../fish/guestfish-actions.pod:2797
26847 #: ../fish/guestfish-actions.pod:2799
26850 " mkfs fstype device\n"
26856 #: ../fish/guestfish-actions.pod:2805
26862 #: ../fish/guestfish-actions.pod:2807
26865 " mkfs-b fstype blocksize device\n"
26871 #: ../fish/guestfish-actions.pod:2809
26873 "This call is similar to L</mkfs>, but it allows you to control the block "
26874 "size of the resulting filesystem. Supported block sizes depend on the "
26875 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26880 #: ../fish/guestfish-actions.pod:2824
26886 #: ../fish/guestfish-actions.pod:2826
26889 " mkfs-opts fstype device [blocksize:..]\n"
26895 #: ../fish/guestfish-actions.pod:2850
26896 msgid "mkmountpoint"
26901 #: ../fish/guestfish-actions.pod:2852
26904 " mkmountpoint exemptpath\n"
26910 #: ../fish/guestfish-actions.pod:2854
26912 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
26913 "to create extra mountpoints before mounting the first filesystem."
26918 #: ../fish/guestfish-actions.pod:2878
26920 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26921 "unexpected errors if you try to mix these calls. It is safest to manually "
26922 "unmount filesystems and remove mountpoints after use."
26927 #: ../fish/guestfish-actions.pod:2882
26929 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26930 "for this to work for manual mountpoints, you must ensure that the innermost "
26931 "mountpoints have the longest pathnames, as in the example code above."
26936 #: ../fish/guestfish-actions.pod:2889
26938 "Autosync [see L</set-autosync>, this is set by default on handles] means "
26939 "that L</umount-all> is called when the handle is closed which can also "
26940 "trigger these issues."
26945 #: ../fish/guestfish-actions.pod:2893
26951 #: ../fish/guestfish-actions.pod:2895
26954 " mknod mode devmajor devminor path\n"
26960 #: ../fish/guestfish-actions.pod:2905
26962 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26963 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26964 "regular file). These constants are available in the standard Linux header "
26965 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26966 "wrappers around this command which bitwise OR in the appropriate constant "
26972 #: ../fish/guestfish-actions.pod:2915
26978 #: ../fish/guestfish-actions.pod:2917
26981 " mknod-b mode devmajor devminor path\n"
26987 #: ../fish/guestfish-actions.pod:2919
26989 "This call creates a block device node called C<path> with mode C<mode> and "
26990 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26991 "wrapper around L</mknod>."
26996 #: ../fish/guestfish-actions.pod:2925
27002 #: ../fish/guestfish-actions.pod:2927
27005 " mknod-c mode devmajor devminor path\n"
27011 #: ../fish/guestfish-actions.pod:2929
27013 "This call creates a char device node called C<path> with mode C<mode> and "
27014 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27015 "wrapper around L</mknod>."
27020 #: ../fish/guestfish-actions.pod:2935
27026 #: ../fish/guestfish-actions.pod:2937
27035 #: ../fish/guestfish-actions.pod:2941
27041 #: ../fish/guestfish-actions.pod:2943
27044 " mkswap-L label device\n"
27050 #: ../fish/guestfish-actions.pod:2951
27056 #: ../fish/guestfish-actions.pod:2953
27059 " mkswap-U uuid device\n"
27065 #: ../fish/guestfish-actions.pod:2957
27066 msgid "mkswap-file"
27071 #: ../fish/guestfish-actions.pod:2959
27074 " mkswap-file path\n"
27080 #: ../fish/guestfish-actions.pod:2963
27082 "This command just writes a swap file signature to an existing file. To "
27083 "create the file itself, use something like L</fallocate>."
27088 #: ../fish/guestfish-actions.pod:2966
27094 #: ../fish/guestfish-actions.pod:2968
27097 " modprobe modulename\n"
27103 #: ../fish/guestfish-actions.pod:2975
27109 #: ../fish/guestfish-actions.pod:2977
27112 " mount device mountpoint\n"
27118 #: ../fish/guestfish-actions.pod:2993
27120 "B<Important note:> When you use this call, the filesystem options C<sync> "
27121 "and C<noatime> are set implicitly. This was originally done because we "
27122 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27123 "very large negative performance impact and negligible effect on "
27124 "reliability. Therefore we recommend that you avoid using L</mount> in any "
27125 "code that needs performance, and instead use L</mount-options> (use an empty "
27126 "string for the first parameter if you don't want any options)."
27131 #: ../fish/guestfish-actions.pod:3003
27137 #: ../fish/guestfish-actions.pod:3005
27140 " mount-loop file mountpoint\n"
27146 #: ../fish/guestfish-actions.pod:3011
27147 msgid "mount-options"
27152 #: ../fish/guestfish-actions.pod:3013
27155 " mount-options options device mountpoint\n"
27161 #: ../fish/guestfish-actions.pod:3015
27163 "This is the same as the L</mount> command, but it allows you to set the "
27164 "mount options as for the L<mount(8)> I<-o> flag."
27169 #: ../fish/guestfish-actions.pod:3023
27175 #: ../fish/guestfish-actions.pod:3025
27178 " mount-ro device mountpoint\n"
27184 #: ../fish/guestfish-actions.pod:3027
27186 "This is the same as the L</mount> command, but it mounts the filesystem with "
27187 "the read-only (I<-o ro>) flag."
27192 #: ../fish/guestfish-actions.pod:3030
27198 #: ../fish/guestfish-actions.pod:3032
27201 " mount-vfs options vfstype device mountpoint\n"
27207 #: ../fish/guestfish-actions.pod:3034
27209 "This is the same as the L</mount> command, but it allows you to set both the "
27210 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
27215 #: ../fish/guestfish-actions.pod:3038
27216 msgid "mountpoints"
27221 #: ../fish/guestfish-actions.pod:3040
27230 #: ../fish/guestfish-actions.pod:3042
27232 "This call is similar to L</mounts>. That call returns a list of devices. "
27233 "This one returns a hash table (map) of device name to directory where the "
27234 "device is mounted."
27239 #: ../fish/guestfish-actions.pod:3046
27245 #: ../fish/guestfish-actions.pod:3048
27254 #: ../fish/guestfish-actions.pod:3055
27255 msgid "See also: L</mountpoints>"
27260 #: ../fish/guestfish-actions.pod:3057
27266 #: ../fish/guestfish-actions.pod:3059
27275 #: ../fish/guestfish-actions.pod:3064
27276 msgid "ntfs-3g-probe"
27281 #: ../fish/guestfish-actions.pod:3066
27284 " ntfs-3g-probe true|false device\n"
27290 #: ../fish/guestfish-actions.pod:3080
27296 #: ../fish/guestfish-actions.pod:3082
27299 " ntfsresize device\n"
27305 #: ../fish/guestfish-actions.pod:3088
27306 msgid "ntfsresize-size"
27311 #: ../fish/guestfish-actions.pod:3090
27314 " ntfsresize-size device size\n"
27320 #: ../fish/guestfish-actions.pod:3092
27322 "This command is the same as L</ntfsresize> except that it allows you to "
27323 "specify the new size (in bytes) explicitly."
27328 #: ../fish/guestfish-actions.pod:3095
27334 #: ../fish/guestfish-actions.pod:3097
27337 " part-add device prlogex startsect endsect\n"
27343 #: ../fish/guestfish-actions.pod:3099
27345 "This command adds a partition to C<device>. If there is no partition table "
27346 "on the device, call L</part-init> first."
27351 #: ../fish/guestfish-actions.pod:3111
27353 "Creating a partition which covers the whole disk is not so easy. Use L</"
27354 "part-disk> to do that."
27359 #: ../fish/guestfish-actions.pod:3114
27365 #: ../fish/guestfish-actions.pod:3116
27368 " part-del device partnum\n"
27374 #: ../fish/guestfish-actions.pod:3124
27380 #: ../fish/guestfish-actions.pod:3126
27383 " part-disk device parttype\n"
27389 #: ../fish/guestfish-actions.pod:3128
27391 "This command is simply a combination of L</part-init> followed by L</part-"
27392 "add> to create a single primary partition covering the whole disk."
27397 #: ../fish/guestfish-actions.pod:3132
27399 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27400 "possible values are described in L</part-init>."
27405 #: ../fish/guestfish-actions.pod:3138
27406 msgid "part-get-bootable"
27411 #: ../fish/guestfish-actions.pod:3140
27414 " part-get-bootable device partnum\n"
27420 #: ../fish/guestfish-actions.pod:3145
27421 msgid "See also L</part-set-bootable>."
27426 #: ../fish/guestfish-actions.pod:3147
27427 msgid "part-get-mbr-id"
27432 #: ../fish/guestfish-actions.pod:3149
27435 " part-get-mbr-id device partnum\n"
27441 #: ../fish/guestfish-actions.pod:3154 ../fish/guestfish-actions.pod:3292
27443 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27444 "undefined results for other partition table types (see L</part-get-"
27450 #: ../fish/guestfish-actions.pod:3158
27451 msgid "part-get-parttype"
27456 #: ../fish/guestfish-actions.pod:3160
27459 " part-get-parttype device\n"
27465 #: ../fish/guestfish-actions.pod:3165
27467 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27468 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27469 "possible, although unusual. See L</part-init> for a full list."
27474 #: ../fish/guestfish-actions.pod:3170
27480 #: ../fish/guestfish-actions.pod:3172
27483 " part-init device parttype\n"
27489 #: ../fish/guestfish-actions.pod:3178
27491 "Initially there are no partitions. Following this, you should call L</part-"
27492 "add> for each partition required."
27497 #: ../fish/guestfish-actions.pod:3241
27503 #: ../fish/guestfish-actions.pod:3243
27506 " part-list device\n"
27512 #: ../fish/guestfish-actions.pod:3258
27514 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27515 "the device's sector size, see L</blockdev-getss>."
27520 #: ../fish/guestfish-actions.pod:3271
27521 msgid "part-set-bootable"
27526 #: ../fish/guestfish-actions.pod:3273
27529 " part-set-bootable device partnum true|false\n"
27535 #: ../fish/guestfish-actions.pod:3282
27536 msgid "part-set-mbr-id"
27541 #: ../fish/guestfish-actions.pod:3284
27544 " part-set-mbr-id device partnum idbyte\n"
27550 #: ../fish/guestfish-actions.pod:3296
27551 msgid "part-set-name"
27556 #: ../fish/guestfish-actions.pod:3298
27559 " part-set-name device partnum name\n"
27565 #: ../fish/guestfish-actions.pod:3306
27566 msgid "part-to-dev"
27571 #: ../fish/guestfish-actions.pod:3308
27574 " part-to-dev partition\n"
27580 #: ../fish/guestfish-actions.pod:3314
27582 "The named partition must exist, for example as a string returned from L</"
27583 "list-partitions>."
27588 #: ../fish/guestfish-actions.pod:3317
27589 msgid "ping-daemon"
27594 #: ../fish/guestfish-actions.pod:3319
27603 #: ../fish/guestfish-actions.pod:3326
27609 #: ../fish/guestfish-actions.pod:3328
27612 " pread path count offset\n"
27618 #: ../fish/guestfish-actions.pod:3336
27619 msgid "See also L</pwrite>, L</pread-device>."
27624 #: ../fish/guestfish-actions.pod:3341
27625 msgid "pread-device"
27630 #: ../fish/guestfish-actions.pod:3343
27633 " pread-device device count offset\n"
27639 #: ../fish/guestfish-actions.pod:3351
27640 msgid "See also L</pread>."
27645 #: ../fish/guestfish-actions.pod:3356
27651 #: ../fish/guestfish-actions.pod:3358
27654 " pvcreate device\n"
27660 #: ../fish/guestfish-actions.pod:3364
27666 #: ../fish/guestfish-actions.pod:3366
27669 " pvremove device\n"
27675 #: ../fish/guestfish-actions.pod:3375
27681 #: ../fish/guestfish-actions.pod:3377
27684 " pvresize device\n"
27690 #: ../fish/guestfish-actions.pod:3382
27691 msgid "pvresize-size"
27696 #: ../fish/guestfish-actions.pod:3384
27699 " pvresize-size device size\n"
27705 #: ../fish/guestfish-actions.pod:3386
27707 "This command is the same as L</pvresize> except that it allows you to "
27708 "specify the new size (in bytes) explicitly."
27713 #: ../fish/guestfish-actions.pod:3389
27719 #: ../fish/guestfish-actions.pod:3391
27728 #: ../fish/guestfish-actions.pod:3399
27729 msgid "See also L</pvs-full>."
27734 #: ../fish/guestfish-actions.pod:3401
27740 #: ../fish/guestfish-actions.pod:3403
27749 #: ../fish/guestfish-actions.pod:3408
27755 #: ../fish/guestfish-actions.pod:3410
27764 #: ../fish/guestfish-actions.pod:3414
27770 #: ../fish/guestfish-actions.pod:3416
27773 " pwrite path content offset\n"
27779 #: ../fish/guestfish-actions.pod:3427
27780 msgid "See also L</pread>, L</pwrite-device>."
27785 #: ../fish/guestfish-actions.pod:3432
27786 msgid "pwrite-device"
27791 #: ../fish/guestfish-actions.pod:3434
27794 " pwrite-device device content offset\n"
27800 #: ../fish/guestfish-actions.pod:3444
27801 msgid "See also L</pwrite>."
27806 #: ../fish/guestfish-actions.pod:3449
27812 #: ../fish/guestfish-actions.pod:3451
27815 " read-file path\n"
27821 #: ../fish/guestfish-actions.pod:3456
27823 "Unlike L</cat>, this function can correctly handle files that contain "
27824 "embedded ASCII NUL characters. However unlike L</download>, this function "
27825 "is limited in the total size of file that can be handled."
27830 #: ../fish/guestfish-actions.pod:3464
27836 #: ../fish/guestfish-actions.pod:3466
27839 " read-lines path\n"
27845 #: ../fish/guestfish-actions.pod:3473
27847 "Note that this function cannot correctly handle binary files (specifically, "
27848 "files containing C<\\0> character which is treated as end of line). For "
27849 "those you need to use the L</read-file> function which has a more complex "
27855 #: ../fish/guestfish-actions.pod:3478
27861 #: ../fish/guestfish-actions.pod:3480
27870 #: ../fish/guestfish-actions.pod:3532
27872 "This function is primarily intended for use by programs. To get a simple "
27873 "list of names, use L</ls>. To get a printable directory for human "
27874 "consumption, use L</ll>."
27879 #: ../fish/guestfish-actions.pod:3536
27885 #: ../fish/guestfish-actions.pod:3538
27894 #: ../fish/guestfish-actions.pod:3542
27895 msgid "readlinklist"
27900 #: ../fish/guestfish-actions.pod:3544
27903 " readlinklist path 'names ...'\n"
27909 #: ../fish/guestfish-actions.pod:3568
27915 #: ../fish/guestfish-actions.pod:3570
27924 #: ../fish/guestfish-actions.pod:3575
27925 msgid "removexattr"
27930 #: ../fish/guestfish-actions.pod:3577
27933 " removexattr xattr path\n"
27939 #: ../fish/guestfish-actions.pod:3582
27940 msgid "See also: L</lremovexattr>, L<attr(5)>."
27945 #: ../fish/guestfish-actions.pod:3584
27951 #: ../fish/guestfish-actions.pod:3586
27954 " resize2fs device\n"
27960 #: ../fish/guestfish-actions.pod:3591
27962 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
27963 "before calling this command. For unknown reasons C<resize2fs> sometimes "
27964 "gives an error about this and sometimes not. In any case, it is always safe "
27965 "to call L</e2fsck-f> before calling this function."
27970 #: ../fish/guestfish-actions.pod:3597
27971 msgid "resize2fs-size"
27976 #: ../fish/guestfish-actions.pod:3599
27979 " resize2fs-size device size\n"
27985 #: ../fish/guestfish-actions.pod:3601
27987 "This command is the same as L</resize2fs> except that it allows you to "
27988 "specify the new size (in bytes) explicitly."
27993 #: ../fish/guestfish-actions.pod:3604
27999 #: ../fish/guestfish-actions.pod:3606
28008 #: ../fish/guestfish-actions.pod:3610
28014 #: ../fish/guestfish-actions.pod:3612
28023 #: ../fish/guestfish-actions.pod:3618
28029 #: ../fish/guestfish-actions.pod:3620
28038 #: ../fish/guestfish-actions.pod:3624
28039 msgid "rmmountpoint"
28044 #: ../fish/guestfish-actions.pod:3626
28047 " rmmountpoint exemptpath\n"
28053 #: ../fish/guestfish-actions.pod:3628
28055 "This calls removes a mountpoint that was previously created with L</"
28056 "mkmountpoint>. See L</mkmountpoint> for full details."
28061 #: ../fish/guestfish-actions.pod:3632
28062 msgid "scrub-device"
28067 #: ../fish/guestfish-actions.pod:3634
28070 " scrub-device device\n"
28076 #: ../fish/guestfish-actions.pod:3645
28082 #: ../fish/guestfish-actions.pod:3647
28085 " scrub-file file\n"
28091 #: ../fish/guestfish-actions.pod:3657
28092 msgid "scrub-freespace"
28097 #: ../fish/guestfish-actions.pod:3659
28100 " scrub-freespace dir\n"
28106 #: ../fish/guestfish-actions.pod:3661
28108 "This command creates the directory C<dir> and then fills it with files until "
28109 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
28110 "deletes them. The intention is to scrub any free space on the partition "
28111 "containing C<dir>."
28116 #: ../fish/guestfish-actions.pod:3670
28122 #: ../fish/guestfish-actions.pod:3672
28128 #: ../fish/guestfish-actions.pod:3674
28131 " set-append append\n"
28137 #: ../fish/guestfish-actions.pod:3685
28138 msgid "set-autosync"
28143 #: ../fish/guestfish-actions.pod:3687
28149 #: ../fish/guestfish-actions.pod:3689
28152 " set-autosync true|false\n"
28158 #: ../fish/guestfish-actions.pod:3691
28160 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
28161 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
28162 "closed (also if the program exits without closing handles)."
28167 #: ../fish/guestfish-actions.pod:3699
28173 #: ../fish/guestfish-actions.pod:3701
28179 #: ../fish/guestfish-actions.pod:3703
28182 " set-direct true|false\n"
28188 #: ../fish/guestfish-actions.pod:3709
28190 "One consequence of this is that log messages aren't caught by the library "
28191 "and handled by L</set-log-message-callback>, but go straight to stdout."
28196 #: ../fish/guestfish-actions.pod:3718
28197 msgid "set-e2label"
28202 #: ../fish/guestfish-actions.pod:3720
28205 " set-e2label device label\n"
28211 #: ../fish/guestfish-actions.pod:3726
28213 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
28214 "label on a filesystem."
28219 #: ../fish/guestfish-actions.pod:3729
28225 #: ../fish/guestfish-actions.pod:3731
28228 " set-e2uuid device uuid\n"
28234 #: ../fish/guestfish-actions.pod:3738
28236 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
28237 "UUID of a filesystem."
28242 #: ../fish/guestfish-actions.pod:3741
28243 msgid "set-memsize"
28248 #: ../fish/guestfish-actions.pod:3743
28254 #: ../fish/guestfish-actions.pod:3745
28257 " set-memsize memsize\n"
28263 #: ../fish/guestfish-actions.pod:3747
28265 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28266 "This only has any effect if called before L</launch>."
28271 #: ../fish/guestfish-actions.pod:3758
28272 msgid "set-network"
28277 #: ../fish/guestfish-actions.pod:3760
28283 #: ../fish/guestfish-actions.pod:3762
28286 " set-network true|false\n"
28292 #: ../fish/guestfish-actions.pod:3770
28294 "You must call this before calling L</launch>, otherwise it has no effect."
28299 #: ../fish/guestfish-actions.pod:3773
28305 #: ../fish/guestfish-actions.pod:3775
28311 #: ../fish/guestfish-actions.pod:3777
28314 " set-path searchpath\n"
28320 #: ../fish/guestfish-actions.pod:3786
28326 #: ../fish/guestfish-actions.pod:3788
28332 #: ../fish/guestfish-actions.pod:3790
28341 #: ../fish/guestfish-actions.pod:3810
28342 msgid "set-recovery-proc"
28347 #: ../fish/guestfish-actions.pod:3812
28348 msgid "recovery-proc"
28353 #: ../fish/guestfish-actions.pod:3814
28356 " set-recovery-proc true|false\n"
28362 #: ../fish/guestfish-actions.pod:3816
28364 "If this is called with the parameter C<false> then L</launch> does not "
28365 "create a recovery process. The purpose of the recovery process is to stop "
28366 "runaway qemu processes in the case where the main program aborts abruptly."
28371 #: ../fish/guestfish-actions.pod:3821
28373 "This only has any effect if called before L</launch>, and the default is "
28379 #: ../fish/guestfish-actions.pod:3830
28380 msgid "set-selinux"
28385 #: ../fish/guestfish-actions.pod:3832
28391 #: ../fish/guestfish-actions.pod:3834
28394 " set-selinux true|false\n"
28400 #: ../fish/guestfish-actions.pod:3845
28406 #: ../fish/guestfish-actions.pod:3847
28412 #: ../fish/guestfish-actions.pod:3849
28415 " set-trace true|false\n"
28421 #: ../fish/guestfish-actions.pod:3865
28422 msgid "set-verbose"
28427 #: ../fish/guestfish-actions.pod:3867
28433 #: ../fish/guestfish-actions.pod:3869
28436 " set-verbose true|false\n"
28442 #: ../fish/guestfish-actions.pod:3876
28448 #: ../fish/guestfish-actions.pod:3878
28451 " setcon context\n"
28457 #: ../fish/guestfish-actions.pod:3885
28463 #: ../fish/guestfish-actions.pod:3887
28466 " setxattr xattr val vallen path\n"
28472 #: ../fish/guestfish-actions.pod:3893
28473 msgid "See also: L</lsetxattr>, L<attr(5)>."
28478 #: ../fish/guestfish-actions.pod:3895
28484 #: ../fish/guestfish-actions.pod:3897
28487 " sfdisk device cyls heads sectors 'lines ...'\n"
28493 #: ../fish/guestfish-actions.pod:3919
28494 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
28499 #: ../fish/guestfish-actions.pod:3925
28505 #: ../fish/guestfish-actions.pod:3927
28508 " sfdiskM device 'lines ...'\n"
28514 #: ../fish/guestfish-actions.pod:3929
28516 "This is a simplified interface to the L</sfdisk> command, where partition "
28517 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
28518 "you don't need to specify the cyls, heads and sectors parameters which were "
28519 "rarely if ever used anyway."
28524 #: ../fish/guestfish-actions.pod:3935
28525 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
28530 #: ../fish/guestfish-actions.pod:3941
28536 #: ../fish/guestfish-actions.pod:3943
28539 " sfdisk-N device partnum cyls heads sectors line\n"
28545 #: ../fish/guestfish-actions.pod:3948
28547 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
28548 "cyls/heads/sectors parameters."
28553 #: ../fish/guestfish-actions.pod:3951
28554 msgid "See also: L</part-add>"
28559 #: ../fish/guestfish-actions.pod:3956
28560 msgid "sfdisk-disk-geometry"
28565 #: ../fish/guestfish-actions.pod:3958
28568 " sfdisk-disk-geometry device\n"
28574 #: ../fish/guestfish-actions.pod:3960
28576 "This displays the disk geometry of C<device> read from the partition table. "
28577 "Especially in the case where the underlying block device has been resized, "
28578 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
28579 "kernel-geometry>)."
28584 #: ../fish/guestfish-actions.pod:3968
28585 msgid "sfdisk-kernel-geometry"
28590 #: ../fish/guestfish-actions.pod:3970
28593 " sfdisk-kernel-geometry device\n"
28599 #: ../fish/guestfish-actions.pod:3977
28605 #: ../fish/guestfish-actions.pod:3979
28608 " sfdisk-l device\n"
28614 #: ../fish/guestfish-actions.pod:3985
28615 msgid "See also: L</part-list>"
28620 #: ../fish/guestfish-actions.pod:3987
28626 #: ../fish/guestfish-actions.pod:3989
28635 #: ../fish/guestfish-actions.pod:3994
28636 msgid "This is like L</command>, but passes the command to:"
28641 #: ../fish/guestfish-actions.pod:4002
28642 msgid "All the provisos about L</command> apply to this call."
28647 #: ../fish/guestfish-actions.pod:4004
28653 #: ../fish/guestfish-actions.pod:4006
28656 " sh-lines command\n"
28662 #: ../fish/guestfish-actions.pod:4008
28663 msgid "This is the same as L</sh>, but splits the result into a list of lines."
28668 #: ../fish/guestfish-actions.pod:4011
28669 msgid "See also: L</command-lines>"
28674 #: ../fish/guestfish-actions.pod:4013
28680 #: ../fish/guestfish-actions.pod:4015
28689 #: ../fish/guestfish-actions.pod:4019
28695 #: ../fish/guestfish-actions.pod:4021
28704 #: ../fish/guestfish-actions.pod:4027
28710 #: ../fish/guestfish-actions.pod:4029
28719 #: ../fish/guestfish-actions.pod:4037
28725 #: ../fish/guestfish-actions.pod:4039
28734 #: ../fish/guestfish-actions.pod:4047
28740 #: ../fish/guestfish-actions.pod:4049
28743 " strings-e encoding path\n"
28749 #: ../fish/guestfish-actions.pod:4051
28751 "This is like the L</strings> command, but allows you to specify the encoding "
28752 "of strings that are looked for in the source file C<path>."
28757 #: ../fish/guestfish-actions.pod:4061
28759 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28760 "ISO-8859-X (this is what L</strings> uses)."
28765 #: ../fish/guestfish-actions.pod:4093
28766 msgid "swapoff-device"
28771 #: ../fish/guestfish-actions.pod:4095
28774 " swapoff-device device\n"
28780 #: ../fish/guestfish-actions.pod:4097
28782 "This command disables the libguestfs appliance swap device or partition "
28783 "named C<device>. See L</swapon-device>."
28788 #: ../fish/guestfish-actions.pod:4101
28789 msgid "swapoff-file"
28794 #: ../fish/guestfish-actions.pod:4103
28797 " swapoff-file file\n"
28803 #: ../fish/guestfish-actions.pod:4107
28804 msgid "swapoff-label"
28809 #: ../fish/guestfish-actions.pod:4109
28812 " swapoff-label label\n"
28818 #: ../fish/guestfish-actions.pod:4114
28819 msgid "swapoff-uuid"
28824 #: ../fish/guestfish-actions.pod:4116
28827 " swapoff-uuid uuid\n"
28833 #: ../fish/guestfish-actions.pod:4121
28834 msgid "swapon-device"
28839 #: ../fish/guestfish-actions.pod:4123
28842 " swapon-device device\n"
28848 #: ../fish/guestfish-actions.pod:4125
28850 "This command enables the libguestfs appliance to use the swap device or "
28851 "partition named C<device>. The increased memory is made available for all "
28852 "commands, for example those run using L</command> or L</sh>."
28857 #: ../fish/guestfish-actions.pod:4137
28858 msgid "swapon-file"
28863 #: ../fish/guestfish-actions.pod:4139
28866 " swapon-file file\n"
28872 #: ../fish/guestfish-actions.pod:4141
28874 "This command enables swap to a file. See L</swapon-device> for other notes."
28879 #: ../fish/guestfish-actions.pod:4144
28880 msgid "swapon-label"
28885 #: ../fish/guestfish-actions.pod:4146
28888 " swapon-label label\n"
28894 #: ../fish/guestfish-actions.pod:4148
28896 "This command enables swap to a labeled swap partition. See L</swapon-"
28897 "device> for other notes."
28902 #: ../fish/guestfish-actions.pod:4151
28903 msgid "swapon-uuid"
28908 #: ../fish/guestfish-actions.pod:4153
28911 " swapon-uuid uuid\n"
28917 #: ../fish/guestfish-actions.pod:4155
28919 "This command enables swap to a swap partition with the given UUID. See L</"
28920 "swapon-device> for other notes."
28925 #: ../fish/guestfish-actions.pod:4158
28931 #: ../fish/guestfish-actions.pod:4160
28940 #: ../fish/guestfish-actions.pod:4168
28946 #: ../fish/guestfish-actions.pod:4170
28955 #: ../fish/guestfish-actions.pod:4178
28961 #: ../fish/guestfish-actions.pod:4180
28964 " tail-n nrlines path\n"
28970 #: ../fish/guestfish-actions.pod:4193
28976 #: ../fish/guestfish-actions.pod:4195
28979 " tar-in (tarfile|-) directory\n"
28985 #: ../fish/guestfish-actions.pod:4200
28986 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
28991 #: ../fish/guestfish-actions.pod:4205
28997 #: ../fish/guestfish-actions.pod:4207
29000 " tar-out directory (tarfile|-)\n"
29006 #: ../fish/guestfish-actions.pod:4212
29007 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
29012 #: ../fish/guestfish-actions.pod:4217
29018 #: ../fish/guestfish-actions.pod:4219
29021 " tgz-in (tarball|-) directory\n"
29027 #: ../fish/guestfish-actions.pod:4224
29028 msgid "To upload an uncompressed tarball, use L</tar-in>."
29033 #: ../fish/guestfish-actions.pod:4228
29039 #: ../fish/guestfish-actions.pod:4230
29042 " tgz-out directory (tarball|-)\n"
29048 #: ../fish/guestfish-actions.pod:4235
29049 msgid "To download an uncompressed tarball, use L</tar-out>."
29054 #: ../fish/guestfish-actions.pod:4239
29060 #: ../fish/guestfish-actions.pod:4241
29069 #: ../fish/guestfish-actions.pod:4250
29075 #: ../fish/guestfish-actions.pod:4252
29084 #: ../fish/guestfish-actions.pod:4257
29085 msgid "truncate-size"
29090 #: ../fish/guestfish-actions.pod:4259
29093 " truncate-size path size\n"
29099 #: ../fish/guestfish-actions.pod:4264
29101 "If the current file size is less than C<size> then the file is extended to "
29102 "the required size with zero bytes. This creates a sparse file (ie. disk "
29103 "blocks are not allocated for the file until you write to it). To create a "
29104 "non-sparse file of zeroes, use L</fallocate64> instead."
29109 #: ../fish/guestfish-actions.pod:4270
29115 #: ../fish/guestfish-actions.pod:4272
29118 " tune2fs-l device\n"
29124 #: ../fish/guestfish-actions.pod:4282
29130 #: ../fish/guestfish-actions.pod:4284
29133 " txz-in (tarball|-) directory\n"
29139 #: ../fish/guestfish-actions.pod:4291
29145 #: ../fish/guestfish-actions.pod:4293
29148 " txz-out directory (tarball|-)\n"
29154 #: ../fish/guestfish-actions.pod:4300
29160 #: ../fish/guestfish-actions.pod:4302
29169 #: ../fish/guestfish-actions.pod:4316
29170 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
29175 #: ../fish/guestfish-actions.pod:4321
29181 #: ../fish/guestfish-actions.pod:4323
29187 #: ../fish/guestfish-actions.pod:4325
29190 " umount pathordevice\n"
29196 #: ../fish/guestfish-actions.pod:4331
29202 #: ../fish/guestfish-actions.pod:4333
29203 msgid "unmount-all"
29208 #: ../fish/guestfish-actions.pod:4335
29217 #: ../fish/guestfish-actions.pod:4341
29223 #: ../fish/guestfish-actions.pod:4343
29226 " upload (filename|-) remotefilename\n"
29232 #: ../fish/guestfish-actions.pod:4350
29233 msgid "See also L</download>."
29238 #: ../fish/guestfish-actions.pod:4354
29239 msgid "upload-offset"
29244 #: ../fish/guestfish-actions.pod:4356
29247 " upload-offset (filename|-) remotefilename offset\n"
29253 #: ../fish/guestfish-actions.pod:4368
29255 "Note that there is no limit on the amount of data that can be uploaded with "
29256 "this call, unlike with L</pwrite>, and this call always writes the full "
29257 "amount unless an error occurs."
29262 #: ../fish/guestfish-actions.pod:4373
29263 msgid "See also L</upload>, L</pwrite>."
29268 #: ../fish/guestfish-actions.pod:4377
29274 #: ../fish/guestfish-actions.pod:4379
29277 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
29283 #: ../fish/guestfish-actions.pod:4398
29289 #: ../fish/guestfish-actions.pod:4400
29298 #: ../fish/guestfish-actions.pod:4427
29300 "I<Note:> Don't use this call to test for availability of features. In "
29301 "enterprise distributions we backport features from later versions into "
29302 "earlier versions, making this an unreliable way to test for features. Use "
29303 "L</available> instead."
29308 #: ../fish/guestfish-actions.pod:4433
29314 #: ../fish/guestfish-actions.pod:4435
29317 " vfs-label device\n"
29323 #: ../fish/guestfish-actions.pod:4442
29324 msgid "To find a filesystem from the label, use L</findfs-label>."
29329 #: ../fish/guestfish-actions.pod:4444
29335 #: ../fish/guestfish-actions.pod:4446
29338 " vfs-type device\n"
29344 #: ../fish/guestfish-actions.pod:4456
29350 #: ../fish/guestfish-actions.pod:4458
29353 " vfs-uuid device\n"
29359 #: ../fish/guestfish-actions.pod:4465
29360 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
29365 #: ../fish/guestfish-actions.pod:4467
29366 msgid "vg-activate"
29371 #: ../fish/guestfish-actions.pod:4469
29374 " vg-activate true|false 'volgroups ...'\n"
29380 #: ../fish/guestfish-actions.pod:4482
29381 msgid "vg-activate-all"
29386 #: ../fish/guestfish-actions.pod:4484
29389 " vg-activate-all true|false\n"
29395 #: ../fish/guestfish-actions.pod:4494
29401 #: ../fish/guestfish-actions.pod:4496
29404 " vgcreate volgroup 'physvols ...'\n"
29410 #: ../fish/guestfish-actions.pod:4501
29416 #: ../fish/guestfish-actions.pod:4503
29419 " vglvuuids vgname\n"
29425 #: ../fish/guestfish-actions.pod:4508
29427 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
29428 "logical volumes and volume groups."
29433 #: ../fish/guestfish-actions.pod:4511
29434 msgid "See also L</vgpvuuids>."
29439 #: ../fish/guestfish-actions.pod:4513
29445 #: ../fish/guestfish-actions.pod:4515
29448 " vgpvuuids vgname\n"
29454 #: ../fish/guestfish-actions.pod:4520
29456 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
29457 "physical volumes and volume groups."
29462 #: ../fish/guestfish-actions.pod:4523
29463 msgid "See also L</vglvuuids>."
29468 #: ../fish/guestfish-actions.pod:4525
29474 #: ../fish/guestfish-actions.pod:4527
29477 " vgremove vgname\n"
29483 #: ../fish/guestfish-actions.pod:4534
29489 #: ../fish/guestfish-actions.pod:4536
29492 " vgrename volgroup newvolgroup\n"
29498 #: ../fish/guestfish-actions.pod:4540
29504 #: ../fish/guestfish-actions.pod:4542
29513 #: ../fish/guestfish-actions.pod:4550
29514 msgid "See also L</vgs-full>."
29519 #: ../fish/guestfish-actions.pod:4552
29525 #: ../fish/guestfish-actions.pod:4554
29534 #: ../fish/guestfish-actions.pod:4559
29540 #: ../fish/guestfish-actions.pod:4561
29549 #: ../fish/guestfish-actions.pod:4566
29555 #: ../fish/guestfish-actions.pod:4568
29564 #: ../fish/guestfish-actions.pod:4572
29570 #: ../fish/guestfish-actions.pod:4574
29579 #: ../fish/guestfish-actions.pod:4579
29585 #: ../fish/guestfish-actions.pod:4581
29594 #: ../fish/guestfish-actions.pod:4586
29600 #: ../fish/guestfish-actions.pod:4588
29609 #: ../fish/guestfish-actions.pod:4593
29615 #: ../fish/guestfish-actions.pod:4595
29618 " write path content\n"
29624 #: ../fish/guestfish-actions.pod:4603
29630 #: ../fish/guestfish-actions.pod:4605
29633 " write-file path content size\n"
29639 #: ../fish/guestfish-actions.pod:4628
29645 #: ../fish/guestfish-actions.pod:4630
29648 " zegrep regex path\n"
29654 #: ../fish/guestfish-actions.pod:4638
29660 #: ../fish/guestfish-actions.pod:4640
29663 " zegrepi regex path\n"
29669 #: ../fish/guestfish-actions.pod:4648
29675 #: ../fish/guestfish-actions.pod:4650
29684 #: ../fish/guestfish-actions.pod:4658
29685 msgid "See also: L</zero-device>, L</scrub-device>."
29690 #: ../fish/guestfish-actions.pod:4660
29691 msgid "zero-device"
29696 #: ../fish/guestfish-actions.pod:4662
29699 " zero-device device\n"
29705 #: ../fish/guestfish-actions.pod:4664
29707 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
29708 "which just zeroes the first few blocks of a device."
29713 #: ../fish/guestfish-actions.pod:4671
29719 #: ../fish/guestfish-actions.pod:4673
29722 " zerofree device\n"
29728 #: ../fish/guestfish-actions.pod:4686
29734 #: ../fish/guestfish-actions.pod:4688
29737 " zfgrep pattern path\n"
29743 #: ../fish/guestfish-actions.pod:4696
29749 #: ../fish/guestfish-actions.pod:4698
29752 " zfgrepi pattern path\n"
29758 #: ../fish/guestfish-actions.pod:4706
29764 #: ../fish/guestfish-actions.pod:4708
29767 " zfile meth path\n"
29773 #: ../fish/guestfish-actions.pod:4715
29775 "Since 1.0.63, use L</file> instead which can now process compressed files."
29780 #: ../fish/guestfish-actions.pod:4725
29786 #: ../fish/guestfish-actions.pod:4727
29789 " zgrep regex path\n"
29795 #: ../fish/guestfish-actions.pod:4735
29801 #: ../fish/guestfish-actions.pod:4737
29804 " zgrepi regex path\n"
29810 #: ../fish/guestfish-commands.pod:1
29816 #: ../fish/guestfish-commands.pod:3
29822 #: ../fish/guestfish-commands.pod:5
29825 " alloc filename size\n"
29831 #: ../fish/guestfish-commands.pod:7
29833 "This creates an empty (zeroed) file of the given size, and then adds so it "
29834 "can be further examined."
29839 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
29840 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
29845 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
29846 msgid "Size can be specified using standard suffixes, eg. C<1M>."
29851 #: ../fish/guestfish-commands.pod:14
29853 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
29854 "image, see L</PREPARED DISK IMAGES>."
29859 #: ../fish/guestfish-commands.pod:17
29865 #: ../fish/guestfish-commands.pod:19
29868 " copy-in local [local ...] /remotedir\n"
29874 #: ../fish/guestfish-commands.pod:21
29876 "C<copy-in> copies local files or directories recursively into the disk "
29877 "image, placing them in the directory called C</remotedir> (which must "
29878 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
29879 "other commands as necessary."
29884 #: ../fish/guestfish-commands.pod:26
29886 "Multiple local files and directories can be specified, but the last "
29887 "parameter must always be a remote directory. Wildcards cannot be used."
29892 #: ../fish/guestfish-commands.pod:30
29898 #: ../fish/guestfish-commands.pod:32
29901 " copy-out remote [remote ...] localdir\n"
29907 #: ../fish/guestfish-commands.pod:34
29909 "C<copy-out> copies remote files or directories recursively out of the disk "
29910 "image, placing them on the host disk in a local directory called C<localdir> "
29911 "(which must exist). This guestfish meta-command turns into a sequence of L</"
29912 "download>, L</tar-out> and other commands as necessary."
29917 #: ../fish/guestfish-commands.pod:40
29919 "Multiple remote files and directories can be specified, but the last "
29920 "parameter must always be a local directory. To download to the current "
29921 "directory, use C<.> as in:"
29926 #: ../fish/guestfish-commands.pod:44
29929 " copy-out /home .\n"
29935 #: ../fish/guestfish-commands.pod:46
29937 "Wildcards cannot be used in the ordinary command, but you can use them with "
29938 "the help of L</glob> like this:"
29943 #: ../fish/guestfish-commands.pod:49
29946 " glob copy-out /home/* .\n"
29952 #: ../fish/guestfish-commands.pod:51
29958 #: ../fish/guestfish-commands.pod:53
29961 " echo [params ...]\n"
29967 #: ../fish/guestfish-commands.pod:55
29968 msgid "This echos the parameters to the terminal."
29973 #: ../fish/guestfish-commands.pod:57
29979 #: ../fish/guestfish-commands.pod:59
29985 #: ../fish/guestfish-commands.pod:61
29991 #: ../fish/guestfish-commands.pod:63
30000 #: ../fish/guestfish-commands.pod:65
30002 "This is used to edit a file. It downloads the file, edits it locally using "
30003 "your editor, then uploads the result."
30008 #: ../fish/guestfish-commands.pod:68
30010 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
30011 "or C<emacs> you will get those corresponding editors."
30016 #: ../fish/guestfish-commands.pod:72
30022 #: ../fish/guestfish-commands.pod:74
30025 " glob command args...\n"
30031 #: ../fish/guestfish-commands.pod:76
30033 "Expand wildcards in any paths in the args list, and run C<command> "
30034 "repeatedly on each matching path."
30039 #: ../fish/guestfish-commands.pod:79
30040 msgid "See L</WILDCARDS AND GLOBBING>."
30045 #: ../fish/guestfish-commands.pod:81
30051 #: ../fish/guestfish-commands.pod:83
30054 " hexedit <filename|device>\n"
30055 " hexedit <filename|device> <max>\n"
30056 " hexedit <filename|device> <start> <max>\n"
30062 #: ../fish/guestfish-commands.pod:87
30064 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
30070 #: ../fish/guestfish-commands.pod:90
30072 "This command works by downloading potentially the whole file or device, "
30073 "editing it locally, then uploading it. If the file or device is large, you "
30074 "have to specify which part you wish to edit by using C<max> and/or C<start> "
30075 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
30076 "usual modifiers allowed such as C<1M> (1 megabyte)."
30081 #: ../fish/guestfish-commands.pod:97
30082 msgid "For example to edit the first few sectors of a disk you might do:"
30087 #: ../fish/guestfish-commands.pod:100
30090 " hexedit /dev/sda 1M\n"
30096 #: ../fish/guestfish-commands.pod:102
30098 "which would allow you to edit anywhere within the first megabyte of the disk."
30103 #: ../fish/guestfish-commands.pod:105
30104 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
30109 #: ../fish/guestfish-commands.pod:107
30112 " hexedit /dev/sda1 0x400 0x400\n"
30118 #: ../fish/guestfish-commands.pod:109
30119 msgid "(assuming the superblock is in the standard location)."
30124 #: ../fish/guestfish-commands.pod:111
30126 "This command requires the external L<hexedit(1)> program. You can specify "
30127 "another program to use by setting the C<HEXEDITOR> environment variable."
30132 #: ../fish/guestfish-commands.pod:115
30133 msgid "See also L</hexdump>."
30138 #: ../fish/guestfish-commands.pod:117
30144 #: ../fish/guestfish-commands.pod:119
30153 #: ../fish/guestfish-commands.pod:121
30155 "Change the local directory, ie. the current directory of guestfish itself."
30160 #: ../fish/guestfish-commands.pod:124
30161 msgid "Note that C<!cd> won't do what you might expect."
30166 #: ../fish/guestfish-commands.pod:126
30172 #: ../fish/guestfish-commands.pod:128
30178 #: ../fish/guestfish-commands.pod:130
30187 #: ../fish/guestfish-commands.pod:132
30188 msgid "Opens the manual page for guestfish."
30193 #: ../fish/guestfish-commands.pod:134
30199 #: ../fish/guestfish-commands.pod:136
30205 #: ../fish/guestfish-commands.pod:138
30214 #: ../fish/guestfish-commands.pod:140
30223 #: ../fish/guestfish-commands.pod:142
30224 msgid "This is used to view a file."
30229 #: ../fish/guestfish-commands.pod:144
30231 "The default viewer is C<$PAGER>. However if you use the alternate command "
30232 "C<less> you will get the C<less> command specifically."
30237 #: ../fish/guestfish-commands.pod:147
30243 #: ../fish/guestfish-commands.pod:149
30252 #: ../fish/guestfish-commands.pod:151
30254 "Close and reopen the libguestfs handle. It is not necessary to use this "
30255 "normally, because the handle is closed properly when guestfish exits. "
30256 "However this is occasionally useful for testing."
30261 #: ../fish/guestfish-commands.pod:155
30267 #: ../fish/guestfish-commands.pod:157
30270 " sparse filename size\n"
30276 #: ../fish/guestfish-commands.pod:159
30278 "This creates an empty sparse file of the given size, and then adds so it can "
30279 "be further examined."
30284 #: ../fish/guestfish-commands.pod:162
30286 "In all respects it works the same as the L</alloc> command, except that the "
30287 "image file is allocated sparsely, which means that disk blocks are not "
30288 "assigned to the file until they are needed. Sparse disk files only use "
30289 "space when written to, but they are slower and there is a danger you could "
30290 "run out of real disk space during a write operation."
30295 #: ../fish/guestfish-commands.pod:172
30301 #: ../fish/guestfish-commands.pod:174
30310 #: ../fish/guestfish-commands.pod:176
30312 "This command returns a list of the optional groups known to the daemon, and "
30313 "indicates which ones are supported by this build of the libguestfs appliance."
30318 #: ../fish/guestfish-commands.pod:180
30319 msgid "See also L<guestfs(3)/AVAILABILITY>."
30324 #: ../fish/guestfish-commands.pod:182
30330 #: ../fish/guestfish-commands.pod:184
30333 " time command args...\n"
30339 #: ../fish/guestfish-commands.pod:186
30341 "Run the command as usual, but print the elapsed time afterwards. This can "
30342 "be useful for benchmarking operations."
30347 #: ../test-tool/libguestfs-test-tool.pod:5
30348 msgid "libguestfs-test-tool - End user tests for libguestfs"
30353 #: ../test-tool/libguestfs-test-tool.pod:9
30356 " libguestfs-test-tool [--options]\n"
30362 #: ../test-tool/libguestfs-test-tool.pod:13
30364 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
30365 "and developers, to allow them to check basic libguestfs functionality is "
30366 "working. This is needed because libguestfs occasionally breaks for reasons "
30367 "beyond our control: usually because of changes in the underlying qemu or "
30368 "kernel packages, or the host environment."
30373 #: ../test-tool/libguestfs-test-tool.pod:20
30374 msgid "If you suspect a problem in libguestfs, then just run:"
30379 #: ../test-tool/libguestfs-test-tool.pod:22
30382 " libguestfs-test-tool\n"
30388 #: ../test-tool/libguestfs-test-tool.pod:24
30389 msgid "It will print lots of diagnostic messages."
30394 #: ../test-tool/libguestfs-test-tool.pod:26
30395 msgid "If it runs to completion successfully, you will see this near the end:"
30400 #: ../test-tool/libguestfs-test-tool.pod:28
30403 " ===== TEST FINISHED OK =====\n"
30409 #: ../test-tool/libguestfs-test-tool.pod:30
30410 msgid "and the test tool will exit with code 0."
30415 #: ../test-tool/libguestfs-test-tool.pod:32
30417 "If it fails (and/or exits with non-zero error code), please paste the "
30418 "B<complete, unedited> output of the test tool into a bug report. More "
30419 "information about reporting bugs can be found on the L<http://libguestfs.org/"
30425 #: ../test-tool/libguestfs-test-tool.pod:41
30431 #: ../test-tool/libguestfs-test-tool.pod:43
30432 msgid "Display short usage information and exit."
30437 #: ../test-tool/libguestfs-test-tool.pod:45
30438 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
30443 #: ../test-tool/libguestfs-test-tool.pod:47
30445 "Pass an alternate name for the helper program. libguestfs-test-tool will "
30446 "normally look in the C<$libexec> directory that was configured when the tool "
30452 #: ../test-tool/libguestfs-test-tool.pod:51
30453 msgid "I<--qemu qemu_binary>"
30458 #: ../test-tool/libguestfs-test-tool.pod:53
30460 "If you have downloaded another qemu binary, point this option at the full "
30461 "path of the binary to try it."
30466 #: ../test-tool/libguestfs-test-tool.pod:56
30467 msgid "I<--qemudir qemu_source_dir>"
30472 #: ../test-tool/libguestfs-test-tool.pod:58
30474 "If you have compiled qemu from source, point this option at the source "
30475 "directory to try it."
30480 #: ../test-tool/libguestfs-test-tool.pod:61
30481 msgid "I<--timeout N>"
30486 #: ../test-tool/libguestfs-test-tool.pod:63
30488 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
30489 "does not usually need to be adjusted unless your machine is very slow."
30494 #: ../test-tool/libguestfs-test-tool.pod:69
30495 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
30500 #: ../test-tool/libguestfs-test-tool.pod:71
30502 "If you have compiled another version of qemu from source and would like to "
30503 "try that, then you can use the I<--qemudir> option to point to the qemu "
30504 "source directory."
30509 #: ../test-tool/libguestfs-test-tool.pod:75
30511 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
30512 "option to point to the binary."
30517 #: ../test-tool/libguestfs-test-tool.pod:78
30519 "When using an alternate qemu with libguestfs, usually you would need to "
30520 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
30521 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
30522 "use either of the I<--qemudir> or I<--qemu> options."
30527 #: ../test-tool/libguestfs-test-tool.pod:85
30529 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
30530 "I<1> if there was an error."
30535 #: ../test-tool/libguestfs-test-tool.pod:92
30536 msgid "/usr/libexec/libguestfs-test-tool-helper"
30541 #: ../test-tool/libguestfs-test-tool.pod:94
30543 "This helper program is run inside the appliance and provides additional "
30549 #: ../test-tool/libguestfs-test-tool.pod:97
30550 msgid "/usr/bin/mkisofs"
30555 #: ../test-tool/libguestfs-test-tool.pod:99
30557 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
30558 "which is used as part of the tests."
30563 #: ../test-tool/libguestfs-test-tool.pod:106
30565 "For the full list of environment variables which may affect libguestfs, "
30566 "please see the L<guestfs(3)> manual page."
30571 #: ../test-tool/libguestfs-test-tool.pod:111
30572 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
30577 #: ../test-tool/libguestfs-test-tool.pod:121
30578 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
30583 #: ../fuse/guestmount.pod:5
30585 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
30590 #: ../fuse/guestmount.pod:9
30593 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
30599 #: ../fuse/guestmount.pod:11
30602 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
30608 #: ../fuse/guestmount.pod:13
30611 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
30617 #: ../fuse/guestmount.pod:17
30619 "You must I<not> use C<guestmount> in read-write mode on live virtual "
30620 "machines. If you do this, you risk disk corruption in the VM."
30625 #: ../fuse/guestmount.pod:22
30627 "The guestmount program can be used to mount virtual machine filesystems and "
30628 "other disk images on the host. It uses libguestfs for access to the guest "
30629 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
30630 "a mountable device."
30635 #: ../fuse/guestmount.pod:27
30637 "Along with other options, you have to give at least one device (I<-a> "
30638 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
30639 "option) or use the I<-i> inspection option. How this works is better "
30640 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
30646 #: ../fuse/guestmount.pod:33
30648 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
30649 "by you, and the filesystem will not be visible to any other users unless you "
30650 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
30651 "the filesystem, use the C<fusermount -u> command."
30656 #: ../fuse/guestmount.pod:41
30658 "For a typical Windows guest which has its main filesystem on the first "
30664 #: ../fuse/guestmount.pod:44
30667 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
30673 #: ../fuse/guestmount.pod:46
30675 "For a typical Linux guest which has a /boot filesystem on the first "
30676 "partition, and the root filesystem on a logical volume:"
30681 #: ../fuse/guestmount.pod:49
30684 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
30690 #: ../fuse/guestmount.pod:51
30691 msgid "To get libguestfs to detect guest mountpoints for you:"
30696 #: ../fuse/guestmount.pod:53
30699 " guestmount -a guest.img -i --ro /mnt\n"
30705 #: ../fuse/guestmount.pod:55
30706 msgid "For a libvirt guest called \"Guest\" you could do:"
30711 #: ../fuse/guestmount.pod:57
30714 " guestmount -d Guest -i --ro /mnt\n"
30720 #: ../fuse/guestmount.pod:59
30722 "If you don't know what filesystems are contained in a guest or disk image, "
30723 "use L<virt-filesystems(1)> first:"
30728 #: ../fuse/guestmount.pod:62
30731 " virt-filesystems MyGuest\n"
30737 #: ../fuse/guestmount.pod:64
30739 "If you want to trace the libguestfs calls but without excessive debugging "
30740 "information, we recommend:"
30745 #: ../fuse/guestmount.pod:67
30748 " guestmount [...] --trace /mnt\n"
30754 #: ../fuse/guestmount.pod:69
30755 msgid "If you want to debug the program, we recommend:"
30760 #: ../fuse/guestmount.pod:71
30763 " guestmount [...] --trace --verbose /mnt\n"
30769 #: ../fuse/guestmount.pod:77
30770 msgid "B<-a image> | B<--add image>"
30775 #: ../fuse/guestmount.pod:79
30776 msgid "Add a block device or virtual machine image."
30781 #: ../fuse/guestmount.pod:84
30782 msgid "B<-c URI> | B<--connect URI>"
30787 #: ../fuse/guestmount.pod:90
30788 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
30793 #: ../fuse/guestmount.pod:96
30794 msgid "B<--dir-cache-timeout N>"
30799 #: ../fuse/guestmount.pod:98
30801 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
30802 "seconds. The readdir cache [actually, there are several semi-independent "
30803 "caches] is populated after a readdir(2) call with the stat and extended "
30804 "attributes of the files in the directory, in anticipation that they will be "
30805 "requested soon after."
30810 #: ../fuse/guestmount.pod:104
30812 "There is also a different attribute cache implemented by FUSE (see the FUSE "
30813 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
30814 "requests, only cache existing ones."
30819 #: ../fuse/guestmount.pod:115
30820 msgid "B<--format=raw|qcow2|..> | B<--format>"
30825 #: ../fuse/guestmount.pod:122
30827 "If you have untrusted raw-format guest disk images, you should use this "
30828 "option to specify the disk format. This avoids a possible security problem "
30829 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
30830 "guestfs_add_drive_opts>."
30835 #: ../fuse/guestmount.pod:127
30836 msgid "B<--fuse-help>"
30841 #: ../fuse/guestmount.pod:129
30842 msgid "Display help on special FUSE options (see I<-o> below)."
30847 #: ../fuse/guestmount.pod:133
30848 msgid "Display brief help and exit."
30853 #: ../fuse/guestmount.pod:135
30854 msgid "B<-i> | B<--inspector>"
30859 #: ../fuse/guestmount.pod:146
30860 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
30865 #: ../fuse/guestmount.pod:148
30867 "Mount the named partition or logical volume on the given mountpoint B<in the "
30868 "guest> (this has nothing to do with mountpoints in the host)."
30873 #: ../fuse/guestmount.pod:151
30875 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
30876 "something on C</>."
30881 #: ../fuse/guestmount.pod:154
30882 msgid "B<-n> | B<--no-sync>"
30887 #: ../fuse/guestmount.pod:156
30889 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
30890 "unmounted. If you specify this option, then we don't attempt to sync the "
30891 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
30896 #: ../fuse/guestmount.pod:161
30897 msgid "B<-o option> | B<--option option>"
30902 #: ../fuse/guestmount.pod:163
30903 msgid "Pass extra options to FUSE."
30908 #: ../fuse/guestmount.pod:165
30910 "To get a list of all the extra options supported by FUSE, use the command "
30911 "below. Note that only the FUSE I<-o> options can be passed, and only some "
30912 "of them are a good idea."
30917 #: ../fuse/guestmount.pod:169
30920 " guestmount --fuse-help\n"
30926 #: ../fuse/guestmount.pod:171
30927 msgid "Some potentially useful FUSE options:"
30932 #: ../fuse/guestmount.pod:175
30933 msgid "B<-o allow_other>"
30938 #: ../fuse/guestmount.pod:177
30939 msgid "Allow other users to see the filesystem."
30944 #: ../fuse/guestmount.pod:179
30945 msgid "B<-o attr_timeout=N>"
30950 #: ../fuse/guestmount.pod:181
30951 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
30956 #: ../fuse/guestmount.pod:183
30957 msgid "B<-o kernel_cache>"
30962 #: ../fuse/guestmount.pod:185
30964 "Allow the kernel to cache files (reduces the number of reads that have to go "
30965 "through the L<guestfs(3)> API). This is generally a good idea if you can "
30966 "afford the extra memory usage."
30971 #: ../fuse/guestmount.pod:189
30972 msgid "B<-o uid=N> B<-o gid=N>"
30977 #: ../fuse/guestmount.pod:191
30979 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
30980 "the chosen values."
30985 #: ../fuse/guestmount.pod:196
30986 msgid "B<-r> | B<--ro>"
30991 #: ../fuse/guestmount.pod:198
30993 "Add devices and mount everything read-only. Also disallow writes and make "
30994 "the disk appear read-only to FUSE."
30999 #: ../fuse/guestmount.pod:201
31001 "This is highly recommended if you are not going to edit the guest disk. If "
31002 "the guest is running and this option is I<not> supplied, then there is a "
31003 "strong risk of disk corruption in the guest. We try to prevent this from "
31004 "happening, but it is not always possible."
31009 #: ../fuse/guestmount.pod:206
31010 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
31015 #: ../fuse/guestmount.pod:210
31016 msgid "Enable SELinux support for the guest."
31021 #: ../fuse/guestmount.pod:212
31022 msgid "B<-v> | B<--verbose>"
31027 #: ../fuse/guestmount.pod:214
31028 msgid "Enable verbose messages from underlying libguestfs."
31033 #: ../fuse/guestmount.pod:216
31034 msgid "B<-V> | B<--version>"
31039 #: ../fuse/guestmount.pod:218
31040 msgid "Display the program version and exit."
31045 #: ../fuse/guestmount.pod:220
31046 msgid "B<-w> | B<--rw>"
31051 #: ../fuse/guestmount.pod:222
31053 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
31054 "FOR READ AND WRITE>."
31059 #: ../fuse/guestmount.pod:225
31060 msgid "B<-x> | B<--trace>"
31065 #: ../fuse/guestmount.pod:227
31066 msgid "Trace libguestfs calls and entry into each FUSE function."
31071 #: ../fuse/guestmount.pod:229
31072 msgid "This also stops the daemon from forking into the background."
31077 #: ../fuse/guestmount.pod:235
31079 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
31080 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
31085 #: ../tools/virt-edit.pl:34
31086 msgid "virt-edit - Edit a file in a virtual machine"
31090 #: ../tools/virt-edit.pl:38
31093 " virt-edit [--options] domname file\n"
31098 #: ../tools/virt-edit.pl:40
31101 " virt-edit [--options] disk.img [disk.img ...] file\n"
31106 #: ../tools/virt-edit.pl:42
31109 " virt-edit [domname|disk.img] file -e 'expr'\n"
31114 #: ../tools/virt-edit.pl:46
31116 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
31117 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
31118 "doing this, but doesn't catch all cases."
31122 #: ../tools/virt-edit.pl:52
31124 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
31125 "the named virtual machine (or disk image)."
31129 #: ../tools/virt-edit.pl:55
31131 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
31132 "you should look at the L<guestfish(1)> tool."
31136 #: ../tools/virt-edit.pl:60
31137 msgid "Edit the named files interactively:"
31141 #: ../tools/virt-edit.pl:62
31144 " virt-edit mydomain /boot/grub/grub.conf\n"
31149 #: ../tools/virt-edit.pl:64
31152 " virt-edit mydomain /etc/passwd\n"
31157 #: ../tools/virt-edit.pl:66
31159 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
31160 "below). To change the init default level to 5:"
31164 #: ../tools/virt-edit.pl:70
31167 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
31172 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106
31173 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
31174 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
31175 msgid "Display brief help."
31179 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114
31180 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
31181 #: ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171
31182 #: ../tools/virt-list-partitions.pl:72
31183 msgid "Display version number and exit."
31187 #: ../tools/virt-edit.pl:96
31188 msgid "B<--backup extension> | B<-b extension>"
31192 #: ../tools/virt-edit.pl:98
31194 "Create a backup of the original file I<in the guest disk image>. The backup "
31195 "has the original filename with C<extension> added."
31199 #: ../tools/virt-edit.pl:101
31201 "Usually the first character of C<extension> would be a dot C<.> so you would "
31206 #: ../tools/virt-edit.pl:104
31209 " virt-edit -b .orig [etc]\n"
31214 #: ../tools/virt-edit.pl:106
31215 msgid "By default, no backup file is made."
31219 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128
31220 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
31221 #: ../tools/virt-list-partitions.pl:78
31222 msgid "B<--connect URI> | B<-c URI>"
31226 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130
31227 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
31228 #: ../tools/virt-list-partitions.pl:80
31230 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
31231 "to the default libvirt hypervisor."
31235 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133
31236 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
31237 #: ../tools/virt-list-partitions.pl:83
31239 "If you specify guest block devices directly, then libvirt is not used at all."
31243 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140
31244 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
31245 #: ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
31246 msgid "B<--format> raw"
31250 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142
31251 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
31252 #: ../tools/virt-list-partitions.pl:92
31254 "Specify the format of disk images given on the command line. If this is "
31255 "omitted then the format is autodetected from the content of the disk image."
31259 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146
31260 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
31261 #: ../tools/virt-list-partitions.pl:96
31263 "If disk images are requested from libvirt, then this program asks libvirt "
31264 "for this information. In this case, the value of the format parameter is "
31269 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150
31270 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
31271 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
31272 #: ../tools/virt-list-partitions.pl:100
31274 "If working with untrusted raw-format guest disk images, you should ensure "
31275 "the format is always specified."
31279 #: ../tools/virt-edit.pl:141
31280 msgid "B<--expr EXPR> | B<-e EXPR>"
31284 #: ../tools/virt-edit.pl:143
31286 "Instead of launching the external editor, non-interactively apply the Perl "
31287 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
31292 #: ../tools/virt-edit.pl:147
31294 "Be careful to properly quote the expression to prevent it from being altered "
31299 #: ../tools/virt-edit.pl:268
31300 msgid "NON-INTERACTIVE EDITING"
31304 #: ../tools/virt-edit.pl:270
31306 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
31307 "administrator can interactively edit the file."
31311 #: ../tools/virt-edit.pl:273
31313 "There are two ways also to use C<virt-edit> from scripts in order to make "
31314 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
31315 "like this, it's less error-prone to write scripts directly using the "
31316 "libguestfs API and Augeas for configuration file editing.)"
31320 #: ../tools/virt-edit.pl:279
31322 "The first method is to temporarily set C<$EDITOR> to any script or program "
31323 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
31324 "update C<tmpfile> in place however it likes."
31328 #: ../tools/virt-edit.pl:283
31330 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
31331 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
31332 "instances of C<foo> with C<bar> in a file:"
31336 #: ../tools/virt-edit.pl:287
31339 " virt-edit domname filename -e 's/foo/bar/'\n"
31344 #: ../tools/virt-edit.pl:289
31346 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
31347 "For example to delete root's password you could do:"
31351 #: ../tools/virt-edit.pl:292
31354 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
31359 #: ../tools/virt-edit.pl:294
31361 "What really happens is that the snippet is evaluated as a Perl expression "
31362 "for each line of the file. The line, including the final C<\\n>, is passed "
31363 "in C<$_> and the expression should update C<$_> or leave it unchanged."
31367 #: ../tools/virt-edit.pl:299
31369 "To delete a line, set C<$_> to the empty string. For example, to delete the "
31370 "C<apache> user account from the password file you can do:"
31374 #: ../tools/virt-edit.pl:302
31377 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
31382 #: ../tools/virt-edit.pl:304
31384 "To insert a line, prepend or append it to C<$_>. However appending lines to "
31385 "the end of the file is rather difficult this way since there is no concept "
31386 "of \"last line of the file\" - your expression just doesn't get called "
31387 "again. You might want to use the first method (setting C<$EDITOR>) if you "
31392 #: ../tools/virt-edit.pl:310
31394 "The variable C<$lineno> contains the current line number. As is "
31395 "traditional, the first line in the file is number C<1>."
31399 #: ../tools/virt-edit.pl:313
31401 "The return value from the expression is ignored, but the expression may call "
31402 "C<die> in order to abort the whole program, leaving the original file "
31407 #: ../tools/virt-edit.pl:317
31409 "Remember when matching the end of a line that C<$_> may contain the final C<"
31410 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
31411 "newline then neither of these. Thus to match or substitute some text at the "
31412 "end of a line, use this regular expression:"
31416 #: ../tools/virt-edit.pl:322
31419 " /some text(\\r?\\n)?$/\n"
31424 #: ../tools/virt-edit.pl:324
31426 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
31427 "$_> itself (since that would remove all newlines from the file):"
31431 #: ../tools/virt-edit.pl:328
31434 " my $m = $_; chomp $m; $m =~ /some text$/\n"
31439 #: ../tools/virt-edit.pl:334
31444 #: ../tools/virt-edit.pl:336
31446 "If set, this string is used as the editor. It may contain arguments, eg. C<"
31451 #: ../tools/virt-edit.pl:339
31452 msgid "If not set, C<vi> is used."
31456 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559
31457 #: ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182
31458 #: ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:532
31459 #: ../tools/virt-list-partitions.pl:250
31460 msgid "SHELL QUOTING"
31464 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567
31465 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184
31466 #: ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:534
31467 #: ../tools/virt-list-partitions.pl:252
31469 "Libvirt guest names can contain arbitrary characters, some of which have "
31470 "meaning to the shell such as C<#> and space. You may need to quote or "
31471 "escape these characters on the command line. See the shell manual page L<sh"
31472 "(1)> for details."
31476 #: ../tools/virt-edit.pl:352
31478 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
31479 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
31484 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:598
31485 #: ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202
31486 #: ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:564
31487 #: ../tools/virt-list-partitions.pl:269
31492 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:600
31493 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204
31494 #: ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:566
31495 #: ../tools/virt-list-partitions.pl:271
31496 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
31500 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
31501 msgid "Copyright (C) 2009-2010 Red Hat Inc."
31505 #: ../tools/virt-win-reg.pl:37
31507 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
31511 #: ../tools/virt-win-reg.pl:41
31514 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
31519 #: ../tools/virt-win-reg.pl:43
31522 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
31527 #: ../tools/virt-win-reg.pl:45
31530 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
31535 #: ../tools/virt-win-reg.pl:47
31538 " virt-win-reg --merge domname [input.reg ...]\n"
31543 #: ../tools/virt-win-reg.pl:49
31546 " virt-win-reg [--options] disk.img ... # instead of domname\n"
31551 #: ../tools/virt-win-reg.pl:53
31553 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
31554 "virtual machines. If you do this, you I<will> get irreversible disk "
31555 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
31556 "but doesn't catch all cases."
31560 #: ../tools/virt-win-reg.pl:58
31562 "Modifying the Windows Registry is an inherently risky operation. The format "
31563 "is deliberately obscure and undocumented, and Registry changes can leave the "
31564 "system unbootable. Therefore when using the C<--merge> option, make sure "
31565 "you have a reliable backup first."
31569 #: ../tools/virt-win-reg.pl:65
31571 "This program can export and merge Windows Registry entries from a Windows "
31576 #: ../tools/virt-win-reg.pl:68
31578 "The first parameter is the libvirt guest name or the raw disk image of a "
31583 #: ../tools/virt-win-reg.pl:71
31585 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
31586 "exported (recursively). For example:"
31590 #: ../tools/virt-win-reg.pl:74
31593 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
31598 #: ../tools/virt-win-reg.pl:76
31600 "You can also display single values from within registry keys, for example:"
31604 #: ../tools/virt-win-reg.pl:79
31607 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
31608 " $ virt-win-reg Windows7 $cvkey ProductName\n"
31609 " Windows 7 Enterprise\n"
31614 #: ../tools/virt-win-reg.pl:83
31616 "With C<--merge>, you can merge a textual regedit file into the Windows "
31621 #: ../tools/virt-win-reg.pl:86
31624 " $ virt-win-reg --merge Windows7 changes.reg\n"
31629 #: ../tools/virt-win-reg.pl:88
31634 #: ../tools/virt-win-reg.pl:90
31636 "This program is only meant for simple access to the registry. If you want "
31637 "to do complicated things with the registry, we suggest you download the "
31638 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
31639 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
31640 "L<hivexregedit(1)>."
31644 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
31649 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
31650 msgid "Enable debugging messages."
31654 #: ../tools/virt-win-reg.pl:157
31659 #: ../tools/virt-win-reg.pl:159
31661 "In merge mode, this merges a textual regedit file into the Windows Registry "
31662 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
31663 "displays or exports Registry entries instead."
31667 #: ../tools/virt-win-reg.pl:163
31669 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
31670 "result in disk corruption. However exporting (without this flag) is always "
31675 #: ../tools/virt-win-reg.pl:171
31676 msgid "B<--encoding> UTF-16LE|ASCII"
31680 #: ../tools/virt-win-reg.pl:173
31682 "When merging (only), you may need to specify the encoding for strings to be "
31683 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
31684 "(3)/ENCODING STRINGS>."
31688 #: ../tools/virt-win-reg.pl:177
31690 "The default is to use UTF-16LE, which should work with recent versions of "
31695 #: ../tools/virt-win-reg.pl:402
31696 msgid "SUPPORTED SYSTEMS"
31700 #: ../tools/virt-win-reg.pl:404
31702 "The program currently supports Windows NT-derived guests starting with "
31703 "Windows XP through to at least Windows 7."
31707 #: ../tools/virt-win-reg.pl:407
31709 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
31710 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
31711 "and C<HKEY_USERS\\.DEFAULT>."
31715 #: ../tools/virt-win-reg.pl:411
31717 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
31722 #: ../tools/virt-win-reg.pl:414
31724 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
31729 #: ../tools/virt-win-reg.pl:417
31734 #: ../tools/virt-win-reg.pl:419
31736 "C<virt-win-reg> expects that regedit files have already been reencoded in "
31737 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
31738 "style line endings. Since Windows regedit files are often in UTF-16LE with "
31739 "Windows-style line endings, you may need to reencode the whole file before "
31740 "or after processing."
31744 #: ../tools/virt-win-reg.pl:425
31746 "To reencode a file from Windows format to Linux (before processing it with "
31747 "the C<--merge> option), you would do something like this:"
31751 #: ../tools/virt-win-reg.pl:428
31754 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
31759 #: ../tools/virt-win-reg.pl:430
31761 "To go in the opposite direction, after exporting and before sending the file "
31762 "to a Windows user, do something like this:"
31766 #: ../tools/virt-win-reg.pl:433
31769 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
31774 #: ../tools/virt-win-reg.pl:435
31775 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
31779 #: ../tools/virt-win-reg.pl:437
31781 "If you are unsure about the current encoding, use the L<file(1)> command. "
31782 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
31783 "style (CRLF) line endings, like this:"
31787 #: ../tools/virt-win-reg.pl:441
31790 " $ file software.reg\n"
31791 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
31792 " with CRLF line terminators\n"
31797 #: ../tools/virt-win-reg.pl:445
31798 msgid "This file would need conversion before you could C<--merge> it."
31802 #: ../tools/virt-win-reg.pl:447
31803 msgid "CurrentControlSet etc."
31807 #: ../tools/virt-win-reg.pl:449
31809 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
31810 "Registry at the level of the hive file, and therefore you cannot modify "
31815 #: ../tools/virt-win-reg.pl:453
31817 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
31818 "circumstances it might refer to another control set. The way to find out is "
31819 "to look at the C<HKLM\\SYSTEM\\Select> key:"
31823 #: ../tools/virt-win-reg.pl:457
31826 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
31827 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
31828 " \"Current\"=dword:00000001\n"
31829 " \"Default\"=dword:00000001\n"
31830 " \"Failed\"=dword:00000000\n"
31831 " \"LastKnownGood\"=dword:00000002\n"
31836 #: ../tools/virt-win-reg.pl:464
31837 msgid "\"Current\" is the one which Windows will choose when it boots."
31841 #: ../tools/virt-win-reg.pl:466
31843 "Similarly, other C<Current...> keys in the path may need to be replaced."
31847 #: ../tools/virt-win-reg.pl:469
31848 msgid "WINDOWS TIPS"
31852 #: ../tools/virt-win-reg.pl:471
31854 "Note that some of these tips modify the guest disk image. The guest I<must> "
31855 "be shut off, else you will get disk corruption."
31859 #: ../tools/virt-win-reg.pl:474
31860 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
31864 #: ../tools/virt-win-reg.pl:476
31866 "Prepare a DOS batch script, VBScript or executable. Upload this using "
31867 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
31868 "is uploaded into C<C:\\>:"
31872 #: ../tools/virt-win-reg.pl:480
31875 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
31880 #: ../tools/virt-win-reg.pl:482
31881 msgid "Prepare a regedit file containing the registry change:"
31885 #: ../tools/virt-win-reg.pl:484
31888 " cat > test.reg <<'EOF'\n"
31889 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
31890 " \"Test\"=\"c:\\\\test.bat\"\n"
31896 #: ../tools/virt-win-reg.pl:489
31898 "In this example we use the key C<RunOnce> which means that the script will "
31899 "run precisely once when the first user logs in. If you want it to run every "
31900 "time a user logs in, replace C<RunOnce> with C<Run>."
31904 #: ../tools/virt-win-reg.pl:493
31905 msgid "Now update the registry:"
31909 #: ../tools/virt-win-reg.pl:495
31912 " virt-win-reg --merge WindowsGuest test.reg\n"
31917 #: ../tools/virt-win-reg.pl:497
31918 msgid "INSTALLING A SERVICE"
31922 #: ../tools/virt-win-reg.pl:499
31924 "This section assumes you are familiar with Windows services, and you either "
31925 "have a program which handles the Windows Service Control Protocol directly "
31926 "or you want to run any program using a service wrapper like SrvAny or the "
31931 #: ../tools/virt-win-reg.pl:504
31933 "First upload the program and optionally the service wrapper. In this case "
31934 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
31938 #: ../tools/virt-win-reg.pl:508
31941 " guestfish -i -d WindowsGuest <<EOF\n"
31942 " upload rhsrvany.exe /rhsrvany.exe\n"
31943 " upload test.exe /test.exe\n"
31949 #: ../tools/virt-win-reg.pl:513
31951 "Prepare a regedit file containing the registry changes. In this example, "
31952 "the first registry change is needed for the service itself or the service "
31953 "wrapper (if used). The second registry change is only needed because I am "
31954 "using the RHSrvAny service wrapper."
31958 #: ../tools/virt-win-reg.pl:518
31961 " cat > service.reg <<'EOF'\n"
31962 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
31963 " \"Type\"=dword:00000010\n"
31964 " \"Start\"=dword:00000002\n"
31965 " \"ErrorControl\"=dword:00000001\n"
31966 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
31967 " \"DisplayName\"=\"RHSrvAny\"\n"
31968 " \"ObjectName\"=\"NetworkService\"\n"
31973 #: ../tools/virt-win-reg.pl:527
31976 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
31977 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
31978 " \"PWD\"=\"c:\\\\Temp\"\n"
31984 #: ../tools/virt-win-reg.pl:538
31986 "For use of C<ControlSet001> see the section above in this manual page. You "
31987 "may need to adjust this according to the control set that is in use by the "
31992 #: ../tools/virt-win-reg.pl:544
31994 "C<\"ObjectName\"> controls the privileges that the service will have. An "
31995 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
31996 "privileged account."
32000 #: ../tools/virt-win-reg.pl:550
32002 "For the meaning of the magic numbers, see this Microsoft KB article: "
32003 "L<http://support.microsoft.com/kb/103000>."
32007 #: ../tools/virt-win-reg.pl:555
32008 msgid "Update the registry:"
32012 #: ../tools/virt-win-reg.pl:557
32015 " virt-win-reg --merge WindowsGuest service.reg\n"
32020 #: ../tools/virt-win-reg.pl:561
32022 "Be careful when passing parameters containing C<\\> (backslash) in the "
32023 "shell. Usually you will have to use 'single quotes' or double backslashes "
32024 "(but not both) to protect them from the shell."
32028 #: ../tools/virt-win-reg.pl:565
32029 msgid "Paths and value names are case-insensitive."
32033 #: ../tools/virt-win-reg.pl:574
32035 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
32036 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
32037 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
32041 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
32043 "When reporting bugs, please enable debugging and capture the I<complete> "
32048 #: ../tools/virt-win-reg.pl:592
32051 " export LIBGUESTFS_DEBUG=1\n"
32052 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
32057 #: ../tools/virt-win-reg.pl:595
32059 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
32064 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510
32065 #: ../tools/virt-make-fs.pl:570
32066 msgid "Copyright (C) 2010 Red Hat Inc."
32070 #: ../tools/virt-resize.pl:42
32071 msgid "virt-resize - Resize a virtual machine disk"
32075 #: ../tools/virt-resize.pl:46
32078 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
32079 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
32080 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
32085 #: ../tools/virt-resize.pl:52
32087 "Virt-resize is a tool which can resize a virtual machine disk, making it "
32088 "larger or smaller overall, and resizing or deleting any partitions contained "
32093 #: ../tools/virt-resize.pl:56
32095 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
32096 "not> be used on live virtual machines - for consistent results, shut the "
32097 "virtual machine down before resizing it."
32101 #: ../tools/virt-resize.pl:60
32103 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
32104 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
32108 #: ../tools/virt-resize.pl:66
32110 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
32111 "fill the extra 5GB of space."
32115 #: ../tools/virt-resize.pl:69
32118 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
32119 " virt-filesystems --long -h --all -a olddisk\n"
32120 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
32121 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
32126 #: ../tools/virt-resize.pl:74
32128 "As above, but make the /boot partition 200MB bigger, while giving the "
32129 "remaining space to /dev/sda2:"
32133 #: ../tools/virt-resize.pl:77
32136 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
32141 #: ../tools/virt-resize.pl:79
32142 msgid "As above, but the output format will be uncompressed qcow2:"
32146 #: ../tools/virt-resize.pl:81
32149 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
32150 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
32155 #: ../tools/virt-resize.pl:84
32156 msgid "DETAILED USAGE"
32160 #: ../tools/virt-resize.pl:86
32161 msgid "EXPANDING A VIRTUAL MACHINE DISK"
32165 #: ../tools/virt-resize.pl:90
32166 msgid "1. Shut down the virtual machine"
32170 #: ../tools/virt-resize.pl:92
32171 msgid "2. Locate input disk image"
32175 #: ../tools/virt-resize.pl:94
32177 "Locate the input disk image (ie. the file or device on the host containing "
32178 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
32179 "dumpxml> like this to find the disk image name:"
32183 #: ../tools/virt-resize.pl:98
32186 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
32187 " Found 1 nodes:\n"
32189 " <source dev=\"/dev/vg/lv_guest\" />\n"
32194 #: ../tools/virt-resize.pl:103
32195 msgid "3. Look at current sizing"
32199 #: ../tools/virt-resize.pl:105
32200 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
32204 #: ../tools/virt-resize.pl:108
32207 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
32208 " Name Type Size Parent\n"
32209 " /dev/sda1 partition 101M /dev/sda\n"
32210 " /dev/sda2 partition 7.9G /dev/sda\n"
32211 " /dev/sda device 8.0G -\n"
32216 #: ../tools/virt-resize.pl:114
32218 "(This example is a virtual machine with an 8 GB disk which we would like to "
32219 "expand up to 10 GB)."
32223 #: ../tools/virt-resize.pl:117
32224 msgid "4. Create output disk"
32228 #: ../tools/virt-resize.pl:119
32230 "Virt-resize cannot do in-place disk modifications. You have to have space "
32231 "to store the resized output disk."
32235 #: ../tools/virt-resize.pl:122
32237 "To store the resized disk image in a file, create a file of a suitable size:"
32241 #: ../tools/virt-resize.pl:125
32244 " # rm -f outdisk\n"
32245 " # truncate -s 10G outdisk\n"
32250 #: ../tools/virt-resize.pl:128
32251 msgid "Or use L<lvcreate(1)> to create a logical volume:"
32255 #: ../tools/virt-resize.pl:130
32258 " # lvcreate -L 10G -n lv_name vg_name\n"
32263 #: ../tools/virt-resize.pl:132
32264 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
32268 #: ../tools/virt-resize.pl:134
32271 " # virsh pool-list\n"
32272 " # virsh vol-create-as poolname newvol 10G\n"
32277 #: ../tools/virt-resize.pl:137
32282 #: ../tools/virt-resize.pl:139
32284 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
32285 "file) and the output disk. The output disk is the one created in the "
32290 #: ../tools/virt-resize.pl:143
32293 " # virt-resize indisk outdisk\n"
32298 #: ../tools/virt-resize.pl:145
32300 "This command just copies disk image C<indisk> to disk image C<outdisk> "
32301 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
32302 "larger, then an extra, empty partition is created at the end of the disk "
32303 "covering the extra space. If C<outdisk> is smaller, then it will give an "
32308 #: ../tools/virt-resize.pl:151
32310 "More realistically you'd want to expand existing partitions in the disk "
32311 "image by passing extra options (for the full list see the L</OPTIONS> "
32316 #: ../tools/virt-resize.pl:155
32318 "L</--expand> is the most useful option. It expands the named partition "
32319 "within the disk to fill any extra space:"
32323 #: ../tools/virt-resize.pl:158
32326 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
32331 #: ../tools/virt-resize.pl:160
32333 "(In this case, an extra partition is I<not> created at the end of the disk, "
32334 "because there will be no unused space)."
32338 #: ../tools/virt-resize.pl:163
32340 "L</--resize> is the other commonly used option. The following would "
32341 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
32342 "rest of the available space:"
32346 #: ../tools/virt-resize.pl:167
32349 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
32350 " indisk outdisk\n"
32355 #: ../tools/virt-resize.pl:170
32357 "If the expanded partition in the image contains a filesystem or LVM PV, then "
32358 "if virt-resize knows how, it will resize the contents, the equivalent of "
32359 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
32360 ">. However virt-resize does not know how to resize some filesystems, so you "
32361 "would have to online resize them after booting the guest."
32365 #: ../tools/virt-resize.pl:177
32366 msgid "Other options are covered below."
32370 #: ../tools/virt-resize.pl:179
32375 #: ../tools/virt-resize.pl:181
32376 msgid "Thoroughly test the new disk image I<before> discarding the old one."
32380 #: ../tools/virt-resize.pl:183
32381 msgid "If you are using libvirt, edit the XML to point at the new disk:"
32385 #: ../tools/virt-resize.pl:185
32388 " # virsh edit guestname\n"
32393 #: ../tools/virt-resize.pl:187
32395 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
32396 "html#elementsDisks>"
32400 #: ../tools/virt-resize.pl:190
32401 msgid "Then start up the domain with the new, resized disk:"
32405 #: ../tools/virt-resize.pl:192
32408 " # virsh start guestname\n"
32413 #: ../tools/virt-resize.pl:194
32415 "and check that it still works. See also the L</NOTES> section below for "
32416 "additional information."
32420 #: ../tools/virt-resize.pl:197
32421 msgid "7. Resize LVs etc inside the guest"
32425 #: ../tools/virt-resize.pl:199
32426 msgid "(This can also be done offline using L<guestfish(1)>)"
32430 #: ../tools/virt-resize.pl:201
32432 "Once the guest has booted you should see the new space available, at least "
32433 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
32434 "may need to resize LVs inside PVs, and also resize filesystem types that "
32435 "virt-resize does not know how to expand."
32439 #: ../tools/virt-resize.pl:208
32440 msgid "SHRINKING A VIRTUAL MACHINE DISK"
32444 #: ../tools/virt-resize.pl:210
32446 "Shrinking is somewhat more complex than expanding, and only an overview is "
32451 #: ../tools/virt-resize.pl:213
32453 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
32454 "filesystems). The user has to shrink content before passing the disk image "
32455 "to virt-resize, and virt-resize will check that the content has been shrunk "
32460 #: ../tools/virt-resize.pl:218
32461 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
32465 #: ../tools/virt-resize.pl:220
32467 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
32468 "steps 3 and 4 above to allocate a new disk image."
32472 #: ../tools/virt-resize.pl:223
32474 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
32478 #: ../tools/virt-resize.pl:226
32479 msgid "IGNORING OR DELETING PARTITIONS"
32483 #: ../tools/virt-resize.pl:228
32485 "virt-resize also gives a convenient way to ignore or delete partitions when "
32486 "copying from the input disk to the output disk. Ignoring a partition speeds "
32487 "up the copy where you don't care about the existing contents of a "
32488 "partition. Deleting a partition removes it completely, but note that it "
32489 "also renumbers any partitions after the one which is deleted, which can "
32490 "leave some guests unbootable."
32494 #: ../tools/virt-resize.pl:235
32495 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
32499 #: ../tools/virt-resize.pl:237
32501 "If the input disk is in qcow2 format, then you may prefer that the output is "
32502 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
32503 "the fly. The output format is simply determined by the format of the empty "
32504 "output container that you provide. Thus to create qcow2 output, use:"
32508 #: ../tools/virt-resize.pl:243
32511 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
32516 #: ../tools/virt-resize.pl:245
32517 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
32521 #: ../tools/virt-resize.pl:247
32522 msgid "Similarly, to get non-sparse raw output use:"
32526 #: ../tools/virt-resize.pl:249
32529 " fallocate -l size outdisk\n"
32534 #: ../tools/virt-resize.pl:251
32536 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
32537 "dev/zero of=outdisk bs=1M count=..>)"
32541 #: ../tools/virt-resize.pl:264
32542 msgid "Display help."
32546 #: ../tools/virt-resize.pl:278
32547 msgid "B<--resize part=size>"
32551 #: ../tools/virt-resize.pl:280
32553 "Resize the named partition (expanding or shrinking it) so that it has the "
32558 #: ../tools/virt-resize.pl:283
32560 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
32561 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
32562 "Exabytes; or as a percentage of the current size; or as a relative number or "
32563 "percentage. For example:"
32567 #: ../tools/virt-resize.pl:288
32570 " --resize /dev/sda2=10G\n"
32575 #: ../tools/virt-resize.pl:290
32578 " --resize /dev/sda4=90%\n"
32583 #: ../tools/virt-resize.pl:292
32586 " --resize /dev/sda2=+1G\n"
32591 #: ../tools/virt-resize.pl:294
32594 " --resize /dev/sda2=-200M\n"
32599 #: ../tools/virt-resize.pl:296
32602 " --resize /dev/sda1=+128K\n"
32607 #: ../tools/virt-resize.pl:298
32610 " --resize /dev/sda1=+10%\n"
32615 #: ../tools/virt-resize.pl:300
32618 " --resize /dev/sda1=-10%\n"
32623 #: ../tools/virt-resize.pl:302
32625 "You can increase the size of any partition. Virt-resize will expand the "
32626 "direct content of the partition if it knows how (see C<--expand> below)."
32630 #: ../tools/virt-resize.pl:306
32632 "You can only I<decrease> the size of partitions that contain filesystems or "
32633 "PVs which have already been shrunk. Virt-resize will check this has been "
32634 "done before proceeding, or else will print an error (see also C<--resize-"
32639 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
32640 #: ../tools/virt-resize.pl:420
32641 msgid "You can give this option multiple times."
32645 #: ../tools/virt-resize.pl:317
32646 msgid "B<--resize-force part=size>"
32650 #: ../tools/virt-resize.pl:319
32652 "This is the same as C<--resize> except that it will let you decrease the "
32653 "size of any partition. Generally this means you will lose any data which "
32654 "was at the end of the partition you shrink, but you may not care about that "
32655 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
32656 "as a swap partition)."
32660 #: ../tools/virt-resize.pl:325
32661 msgid "See also the C<--ignore> option."
32665 #: ../tools/virt-resize.pl:331
32666 msgid "B<--expand part>"
32670 #: ../tools/virt-resize.pl:333
32672 "Expand the named partition so it uses up all extra space (space left over "
32673 "after any other resize changes that you request have been done)."
32677 #: ../tools/virt-resize.pl:336
32679 "If virt-resize knows how, it will expand the direct content of the "
32680 "partition. For example, if the partition is an LVM PV, it will expand the "
32681 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
32682 "content it doesn't know about alone."
32686 #: ../tools/virt-resize.pl:341
32687 msgid "Currently virt-resize can resize:"
32691 #: ../tools/virt-resize.pl:347
32693 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
32698 #: ../tools/virt-resize.pl:352
32700 "NTFS filesystems contained directly in a partition, if libguestfs was "
32701 "compiled with support for NTFS."
32705 #: ../tools/virt-resize.pl:355
32707 "The filesystem must have been shut down consistently last time it was used. "
32708 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
32709 "consistency check, so at the first boot after resizing Windows will check "
32714 #: ../tools/virt-resize.pl:362
32716 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
32717 "inside the PV, but see the C<--LV-expand> option. The user could also "
32718 "resize LVs as desired after boot."
32722 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
32723 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
32727 #: ../tools/virt-resize.pl:374
32728 msgid "B<--shrink part>"
32732 #: ../tools/virt-resize.pl:376
32734 "Shrink the named partition until the overall disk image fits in the "
32735 "destination. The named partition B<must> contain a filesystem or PV which "
32736 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
32737 "online tools). Virt-resize will check this and give an error if it has not "
32742 #: ../tools/virt-resize.pl:382
32744 "The amount by which the overall disk must be shrunk (after carrying out all "
32745 "other operations requested by the user) is called the \"deficit\". For "
32746 "example, a straight copy (assume no other operations) from a 5GB disk image "
32747 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
32748 "would give an error unless the user specified a partition to shrink and that "
32749 "partition had more than a gigabyte of free space."
32753 #: ../tools/virt-resize.pl:396
32754 msgid "B<--ignore part>"
32758 #: ../tools/virt-resize.pl:398
32760 "Ignore the named partition. Effectively this means the partition is "
32761 "allocated on the destination disk, but the content is not copied across from "
32762 "the source disk. The content of the partition will be blank (all zero "
32767 #: ../tools/virt-resize.pl:409
32768 msgid "B<--delete part>"
32772 #: ../tools/virt-resize.pl:411
32774 "Delete the named partition. It would be more accurate to describe this as "
32775 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
32776 "the original disk image is left intact."
32780 #: ../tools/virt-resize.pl:415
32782 "Note that when you delete a partition, then anything contained in the "
32783 "partition is also deleted. Furthermore, this causes any partitions that "
32784 "come after to be I<renumbered>, which can easily make your guest unbootable."
32788 #: ../tools/virt-resize.pl:426
32789 msgid "B<--LV-expand logvol>"
32793 #: ../tools/virt-resize.pl:428
32795 "This takes the logical volume and, as a final step, expands it to fill all "
32796 "the space available in its volume group. A typical usage, assuming a Linux "
32797 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
32798 "lv_root> would be:"
32802 #: ../tools/virt-resize.pl:433
32805 " virt-resize indisk outdisk \\\n"
32806 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
32811 #: ../tools/virt-resize.pl:436
32813 "This would first expand the partition (and PV), and then expand the root "
32814 "device to fill the extra space in the PV."
32818 #: ../tools/virt-resize.pl:439
32820 "The contents of the LV are also resized if virt-resize knows how to do "
32821 "that. You can stop virt-resize from trying to expand the content by using "
32822 "the option C<--no-expand-content>."
32826 #: ../tools/virt-resize.pl:443
32827 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
32831 #: ../tools/virt-resize.pl:446
32833 "You can give this option multiple times, I<but> it doesn't make sense to do "
32834 "this unless the logical volumes you specify are all in different volume "
32839 #: ../tools/virt-resize.pl:454
32840 msgid "B<--no-copy-boot-loader>"
32844 #: ../tools/virt-resize.pl:456
32846 "By default, virt-resize copies over some sectors at the start of the disk "
32847 "(up to the beginning of the first partition). Commonly these sectors "
32848 "contain the Master Boot Record (MBR) and the boot loader, and are required "
32849 "in order for the guest to boot correctly."
32853 #: ../tools/virt-resize.pl:461
32855 "If you specify this flag, then this initial copy is not done. You may need "
32856 "to reinstall the boot loader in this case."
32860 #: ../tools/virt-resize.pl:469
32861 msgid "B<--no-extra-partition>"
32865 #: ../tools/virt-resize.pl:471
32867 "By default, virt-resize creates an extra partition if there is any extra, "
32868 "unused space after all resizing has happened. Use this option to prevent "
32869 "the extra partition from being created. If you do this then the extra space "
32870 "will be inaccessible until you run fdisk, parted, or some other partitioning "
32871 "tool in the guest."
32875 #: ../tools/virt-resize.pl:477
32877 "Note that if the surplus space is smaller than 10 MB, no extra partition "
32882 #: ../tools/virt-resize.pl:484
32883 msgid "B<--no-expand-content>"
32887 #: ../tools/virt-resize.pl:486
32889 "By default, virt-resize will try to expand the direct contents of "
32890 "partitions, if it knows how (see C<--expand> option above)."
32894 #: ../tools/virt-resize.pl:489
32896 "If you give the C<--no-expand-content> option then virt-resize will not "
32901 #: ../tools/virt-resize.pl:496
32902 msgid "B<-d> | B<--debug>"
32906 #: ../tools/virt-resize.pl:504
32907 msgid "B<-n> | B<--dryrun>"
32911 #: ../tools/virt-resize.pl:506
32912 msgid "Print a summary of what would be done, but don't do anything."
32916 #: ../tools/virt-resize.pl:512
32917 msgid "B<-q> | B<--quiet>"
32921 #: ../tools/virt-resize.pl:514
32922 msgid "Don't print the summary."
32926 #: ../tools/virt-resize.pl:522
32928 "Specify the format of the input disk image. If this flag is not given then "
32929 "it is auto-detected from the image itself."
32933 #: ../tools/virt-resize.pl:528
32935 "Note that this option I<does not> affect the output format. See L</QCOW2 "
32936 "AND NON-SPARSE RAW FORMATS>."
32940 #: ../tools/virt-resize.pl:535
32941 msgid "B<--output-format> raw"
32945 #: ../tools/virt-resize.pl:537
32947 "Specify the format of the output disk image. If this flag is not given then "
32948 "it is auto-detected from the image itself."
32952 #: ../tools/virt-resize.pl:543
32954 "Note that you still need to create the output disk with the right format. "
32955 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
32959 #: ../tools/virt-resize.pl:1419
32964 #: ../tools/virt-resize.pl:1421
32965 msgid "\"Partition 1 does not end on cylinder boundary.\""
32969 #: ../tools/virt-resize.pl:1423
32971 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
32972 "means the partitions will not be aligned to the ancient CHS geometry. "
32973 "However CHS geometry is meaningless for disks manufactured since the early "
32974 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
32975 "cylinders is not required by any modern operating system."
32979 #: ../tools/virt-resize.pl:1430
32980 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
32984 #: ../tools/virt-resize.pl:1432
32986 "In Windows Vista and later versions, Microsoft switched to using a separate "
32987 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
32988 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
32989 "the boot partition. Doing so seems to break the guest completely. However "
32990 "expanding the second partition (ie. C: drive) should work."
32994 #: ../tools/virt-resize.pl:1439
32996 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
32997 "NTFS partitions have been expanded. This is just a safety check and (unless "
32998 "it find errors) is nothing to worry about."
33002 #: ../tools/virt-resize.pl:1443
33003 msgid "GUEST BOOT STUCK AT \"GRUB\""
33007 #: ../tools/virt-resize.pl:1445
33009 "If a Linux guest does not boot after resizing, and the boot is stuck after "
33010 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
33011 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
33012 "although we think is to do with partition alignment."
33016 #: ../tools/virt-resize.pl:1450
33019 " guestfish -i -a newdisk\n"
33020 " ><fs> cat /boot/grub/device.map\n"
33021 " # check the contents of this file are sensible or\n"
33022 " # edit the file if necessary\n"
33023 " ><fs> grub-install / /dev/vda\n"
33029 #: ../tools/virt-resize.pl:1457
33031 "For more flexible guest reconfiguration, including if you need to specify "
33032 "other parameters to grub-install, use L<virt-rescue(1)>."
33036 #: ../tools/virt-resize.pl:1460
33037 msgid "ALTERNATIVE TOOLS"
33041 #: ../tools/virt-resize.pl:1462
33043 "There are several proprietary tools for resizing partitions. We won't "
33044 "mention any here."
33048 #: ../tools/virt-resize.pl:1465
33050 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
33051 "operations on disk images. They can resize and move partitions, but I don't "
33052 "think they can do anything with the contents, and they certainly don't "
33057 #: ../tools/virt-resize.pl:1470
33059 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
33060 "but at a much lower level. You will probably end up hand-calculating sector "
33061 "offsets, which is something that virt-resize was designed to avoid. If you "
33062 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
33067 #: ../tools/virt-resize.pl:1485
33069 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
33070 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
33071 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
33072 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
33073 "libguestfs.org/>."
33077 #: ../tools/virt-list-filesystems.pl:32
33079 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33083 #: ../tools/virt-list-filesystems.pl:36
33086 " virt-list-filesystems [--options] domname\n"
33091 #: ../tools/virt-list-filesystems.pl:38
33094 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33099 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33101 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33106 #: ../tools/virt-list-filesystems.pl:45
33108 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33109 "are contained in a virtual machine or disk image."
33113 #: ../tools/virt-list-filesystems.pl:49
33115 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33116 "functionality. For more complex cases you should look at the L<guestfish(1)"
33121 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33122 msgid "B<-l> | B<--long>"
33126 #: ../tools/virt-list-filesystems.pl:108
33128 "With this option, C<virt-list-filesystems> displays the type of each "
33129 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33133 #: ../tools/virt-list-filesystems.pl:115
33134 msgid "B<-a> | B<--all>"
33138 #: ../tools/virt-list-filesystems.pl:117
33140 "Normally we only show mountable filesystems. If this option is given then "
33141 "swap devices are shown too."
33145 #: ../tools/virt-list-filesystems.pl:191
33147 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33148 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33149 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33153 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
33154 msgid "Copyright (C) 2009 Red Hat Inc."
33158 #: ../tools/virt-tar.pl:33
33159 msgid "virt-tar - Extract or upload files to a virtual machine"
33163 #: ../tools/virt-tar.pl:37
33166 " virt-tar [--options] -x domname directory tarball\n"
33171 #: ../tools/virt-tar.pl:39
33174 " virt-tar [--options] -u domname tarball directory\n"
33179 #: ../tools/virt-tar.pl:41
33182 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33187 #: ../tools/virt-tar.pl:43
33190 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33195 #: ../tools/virt-tar.pl:47
33196 msgid "Download C</home> from the VM into a local tarball:"
33200 #: ../tools/virt-tar.pl:49
33203 " virt-tar -x domname /home home.tar\n"
33208 #: ../tools/virt-tar.pl:51
33211 " virt-tar -zx domname /home home.tar.gz\n"
33216 #: ../tools/virt-tar.pl:53
33217 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33221 #: ../tools/virt-tar.pl:55
33224 " virt-tar -u domname uploadstuff.tar /tmp\n"
33229 #: ../tools/virt-tar.pl:57
33232 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
33237 #: ../tools/virt-tar.pl:61
33239 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
33240 "virtual machines. If you do this, you risk disk corruption in the VM. "
33241 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
33245 #: ../tools/virt-tar.pl:66
33247 "You can use C<-x> (extract) on live virtual machines, but you might get "
33248 "inconsistent results or errors if there is filesystem activity inside the "
33249 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
33250 "work, but the only way to guarantee consistent results is if the virtual "
33251 "machine is shut down."
33255 #: ../tools/virt-tar.pl:74
33257 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
33258 "parts of a guest filesystem. There are many possibilities: making backups, "
33259 "uploading data files, snooping on guest activity, fixing or customizing "
33264 #: ../tools/virt-tar.pl:79
33266 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
33267 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
33268 "should look at the L<guestfish(1)> tool."
33272 #: ../tools/virt-tar.pl:83
33274 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
33275 "its contents (recursively) from the virtual machine into a local tarball. "
33276 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
33277 "virtual machine. You cannot use these two options together."
33281 #: ../tools/virt-tar.pl:89
33283 "In addition, you may need to use the C<-z> (gZip) option to enable "
33284 "compression. When uploading, you have to specify C<-z> if the upload file "
33285 "is compressed because virt-tar won't detect this on its own."
33289 #: ../tools/virt-tar.pl:93
33291 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
33292 "example it cannot do PKZip files or bzip2 compression. If you want that "
33293 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
33294 "the L<libguestfs(3)> API)."
33298 #: ../tools/virt-tar.pl:151
33299 msgid "B<-x> | B<--extract> | B<--download>"
33303 #: ../tools/virt-tar.pl:153
33304 msgid "B<-u> | B<--upload>"
33308 #: ../tools/virt-tar.pl:155
33310 "Use C<-x> to extract (download) a directory from a virtual machine to a "
33315 #: ../tools/virt-tar.pl:158
33317 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
33318 "Please read the L</WARNING> section above before using this option."
33322 #: ../tools/virt-tar.pl:162
33323 msgid "You must specify exactly one of these options."
33327 #: ../tools/virt-tar.pl:168
33328 msgid "B<-z> | B<--gzip>"
33332 #: ../tools/virt-tar.pl:170
33333 msgid "Specify that the input or output tarball is gzip-compressed."
33337 #: ../tools/virt-tar.pl:283
33339 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
33340 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
33345 #: ../tools/virt-make-fs.pl:37
33346 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
33350 #: ../tools/virt-make-fs.pl:41
33353 " virt-make-fs [--options] input.tar output.img\n"
33358 #: ../tools/virt-make-fs.pl:43
33361 " virt-make-fs [--options] input.tar.gz output.img\n"
33366 #: ../tools/virt-make-fs.pl:45
33369 " virt-make-fs [--options] directory output.img\n"
33374 #: ../tools/virt-make-fs.pl:49
33376 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
33377 "archive or some files in a directory. It is similar to tools like L<mkisofs"
33378 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
33379 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
33380 "you want to attach these filesystems to existing virtual machines (eg. to "
33381 "import large amounts of read-only data to a VM)."
33385 #: ../tools/virt-make-fs.pl:57
33386 msgid "Basic usage is:"
33390 #: ../tools/virt-make-fs.pl:59
33393 " virt-make-fs input output\n"
33398 #: ../tools/virt-make-fs.pl:61
33400 "where C<input> is either a directory containing files that you want to add, "
33401 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
33402 "C<output> is a disk image. The input type is detected automatically. The "
33403 "output disk image defaults to a raw ext2 image unless you specify extra "
33404 "flags (see L</OPTIONS> below)."
33408 #: ../tools/virt-make-fs.pl:67
33409 msgid "EXTRA SPACE"
33413 #: ../tools/virt-make-fs.pl:69
33415 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
33416 "the files that it contains, but might have extra space. Depending on how "
33417 "you are going to use the output, you might think this extra space is wasted "
33418 "and want to minimize it, or you might want to leave space so that more files "
33419 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
33420 "but you can use the C<--size> flag to leave space in the filesystem if you "
33425 #: ../tools/virt-make-fs.pl:77
33427 "An alternative way to leave extra space but not make the output image any "
33428 "bigger is to use an alternative disk image format (instead of the default "
33429 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
33430 "image format (check your hypervisor supports this before using it). This "
33431 "allows you to choose a large C<--size> but the extra space won't actually be "
33432 "allocated in the image until you try to store something in it."
33436 #: ../tools/virt-make-fs.pl:85
33438 "Don't forget that you can also use local commands including L<resize2fs(8)> "
33439 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
33440 "to build another image from scratch."
33444 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
33445 #: ../tools/virt-make-fs.pl:142
33450 #: ../tools/virt-make-fs.pl:91
33453 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
33458 #: ../tools/virt-make-fs.pl:93
33459 msgid "FILESYSTEM TYPE"
33463 #: ../tools/virt-make-fs.pl:95
33465 "The default filesystem type is C<ext2>. Just about any filesystem type that "
33466 "libguestfs supports can be used (but I<not> read-only formats like "
33467 "ISO9660). Here are some of the more common choices:"
33471 #: ../tools/virt-make-fs.pl:101
33476 #: ../tools/virt-make-fs.pl:103
33478 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
33479 "you are not going to use the filesystem in a way that requires the journal, "
33480 "then this is just wasted overhead."
33484 #: ../tools/virt-make-fs.pl:107
33485 msgid "I<ntfs> or I<vfat>"
33489 #: ../tools/virt-make-fs.pl:109
33490 msgid "Useful if exporting data to a Windows guest."
33494 #: ../tools/virt-make-fs.pl:111
33496 "I<Note for vfat>: The tar archive or local directory must only contain files "
33497 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
33498 "program running within libguestfs is unable to change the ownership of non-"
33499 "root files, since vfat itself does not support this."
33503 #: ../tools/virt-make-fs.pl:116
33508 #: ../tools/virt-make-fs.pl:118
33510 "Lower overhead than C<ext2>, but certain limitations on filename length and "
33511 "total filesystem size."
33515 #: ../tools/virt-make-fs.pl:125
33518 " virt-make-fs --type=minix input minixfs.img\n"
33523 #: ../tools/virt-make-fs.pl:127
33524 msgid "TO PARTITION OR NOT TO PARTITION"
33528 #: ../tools/virt-make-fs.pl:129
33529 msgid "Optionally virt-make-fs can add a partition table to the output disk."
33533 #: ../tools/virt-make-fs.pl:131
33535 "Adding a partition can make the disk image more compatible with certain "
33536 "virtualized operating systems which don't expect to see a filesystem "
33537 "directly located on a block device (Linux doesn't care and will happily "
33538 "handle both types)."
33542 #: ../tools/virt-make-fs.pl:136
33544 "On the other hand, if you have a partition table then the output image is no "
33545 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
33546 "directly on a partitioned disk image. (However libguestfs tools such as "
33547 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
33551 #: ../tools/virt-make-fs.pl:144
33552 msgid "Add an MBR partition:"
33556 #: ../tools/virt-make-fs.pl:146
33559 " virt-make-fs --partition -- input disk.img\n"
33564 #: ../tools/virt-make-fs.pl:148
33566 "If the output disk image could be terabyte-sized or larger, it's better to "
33567 "use an EFI/GPT-compatible partition table:"
33571 #: ../tools/virt-make-fs.pl:151
33574 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
33579 #: ../tools/virt-make-fs.pl:179
33580 msgid "Enable debugging information."
33584 #: ../tools/virt-make-fs.pl:185
33585 msgid "B<--size=E<lt>NE<gt>>"
33589 #: ../tools/virt-make-fs.pl:187
33590 msgid "B<--size=+E<lt>NE<gt>>"
33594 #: ../tools/virt-make-fs.pl:189
33595 msgid "B<-s E<lt>NE<gt>>"
33599 #: ../tools/virt-make-fs.pl:191
33600 msgid "B<-s +E<lt>NE<gt>>"
33604 #: ../tools/virt-make-fs.pl:193
33606 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
33610 #: ../tools/virt-make-fs.pl:196
33612 "If this option is I<not> given, then the output image will be just large "
33613 "enough to contain all the files, with not much wasted space."
33617 #: ../tools/virt-make-fs.pl:199
33619 "To choose a fixed size output disk, specify an absolute number followed by b/"
33620 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33621 "Petabytes or Exabytes. This must be large enough to contain all the input "
33622 "files, else you will get an error."
33626 #: ../tools/virt-make-fs.pl:204
33628 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
33629 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33630 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
33631 "the input files, and (approximately) an extra 200 MB free space."
33635 #: ../tools/virt-make-fs.pl:210
33637 "Note that virt-make-fs estimates free space, and therefore will not produce "
33638 "filesystems containing precisely the free space requested. (It is much more "
33639 "expensive and time-consuming to produce a filesystem which has precisely the "
33640 "desired free space)."
33644 #: ../tools/virt-make-fs.pl:219
33645 msgid "B<--format=E<lt>fmtE<gt>>"
33649 #: ../tools/virt-make-fs.pl:221
33650 msgid "B<-F E<lt>fmtE<gt>>"
33654 #: ../tools/virt-make-fs.pl:223
33655 msgid "Choose the output disk image format."
33659 #: ../tools/virt-make-fs.pl:225
33660 msgid "The default is C<raw> (raw disk image)."
33664 #: ../tools/virt-make-fs.pl:227
33666 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
33667 "that would really make sense here is C<qcow2>."
33671 #: ../tools/virt-make-fs.pl:234
33672 msgid "B<--type=E<lt>fsE<gt>>"
33676 #: ../tools/virt-make-fs.pl:236
33677 msgid "B<-t E<lt>fsE<gt>>"
33681 #: ../tools/virt-make-fs.pl:238
33682 msgid "Choose the output filesystem type."
33686 #: ../tools/virt-make-fs.pl:240
33687 msgid "The default is C<ext2>."
33691 #: ../tools/virt-make-fs.pl:242
33693 "Any filesystem which is supported read-write by libguestfs can be used here."
33697 #: ../tools/virt-make-fs.pl:249
33698 msgid "B<--partition>"
33702 #: ../tools/virt-make-fs.pl:251
33703 msgid "B<--partition=E<lt>parttypeE<gt>>"
33707 #: ../tools/virt-make-fs.pl:253
33709 "If specified, this flag adds an MBR partition table to the output disk image."
33713 #: ../tools/virt-make-fs.pl:256
33715 "You can change the partition table type, eg. C<--partition=gpt> for large "
33720 #: ../tools/virt-make-fs.pl:259
33722 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
33723 "might consider the next parameter to be the partition type. For example:"
33727 #: ../tools/virt-make-fs.pl:263
33730 " virt-make-fs --partition input.tar ...\n"
33735 #: ../tools/virt-make-fs.pl:265
33737 "would cause virt-make-fs to think you wanted to use a partition type of "
33738 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
33739 "dash) between options and the input file argument:"
33743 #: ../tools/virt-make-fs.pl:269
33746 " virt-make-fs --partition -- input.tar ...\n"
33751 #: ../tools/virt-make-fs.pl:541
33753 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
33754 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
33755 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
33759 #: ../tools/virt-make-fs.pl:558
33762 " export LIBGUESTFS_DEBUG=1\n"
33763 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
33768 #: ../tools/virt-make-fs.pl:561
33770 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
33775 #: ../tools/virt-list-partitions.pl:32
33777 "virt-list-partitions - List partitions in a virtual machine or disk image"
33781 #: ../tools/virt-list-partitions.pl:36
33784 " virt-list-partitions [--options] domname\n"
33789 #: ../tools/virt-list-partitions.pl:38
33792 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
33797 #: ../tools/virt-list-partitions.pl:45
33799 "C<virt-list-partitions> is a command line tool to list the partitions that "
33800 "are contained in a virtual machine or disk image. It is mainly useful as a "
33801 "first step to using L<virt-resize(1)>."
33805 #: ../tools/virt-list-partitions.pl:50
33807 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
33808 "functionality. For more complex cases you should look at the L<guestfish(1)"
33813 #: ../tools/virt-list-partitions.pl:107
33814 msgid "B<-h> | B<--human-readable>"
33818 #: ../tools/virt-list-partitions.pl:109
33819 msgid "Show sizes in human-readable form (eg. \"1G\")."
33823 #: ../tools/virt-list-partitions.pl:117
33825 "With this option, C<virt-list-partitions> displays the type and size of each "
33826 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
33830 #: ../tools/virt-list-partitions.pl:124
33831 msgid "B<-t> | B<--total>"
33835 #: ../tools/virt-list-partitions.pl:126
33837 "Display the total size of each block device (as a separate row or rows)."
33841 #: ../tools/virt-list-partitions.pl:259
33843 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
33844 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
33845 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
git.annexia.org / libguestfs.git / blob