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-21 11:58+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"
254 #: ../src/guestfs.pod:98
257 " /* Now you can perform filesystem actions on the guest\n"
260 " guestfs_touch (g, \"/hello\");\n"
266 #: ../src/guestfs.pod:103
269 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
270 " * it is done automatically when you close the handle. See\n"
271 " * discussion of autosync in this page.\n"
273 " guestfs_sync (g);\n"
279 #: ../src/guestfs.pod:109
282 " /* Close the handle 'g'. */\n"
283 " guestfs_close (g);\n"
289 #: ../src/guestfs.pod:112
291 "The code above doesn't include any error checking. In real code you should "
292 "check return values carefully for errors. In general all functions that "
293 "return integers return C<-1> on error, and all functions that return "
294 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
295 "how to handle errors, and consult the documentation for each function call "
296 "below to see precisely how they return error indications. See L<guestfs-"
297 "examples(3)> for fully worked examples."
302 #: ../src/guestfs.pod:121
308 #: ../src/guestfs.pod:123
310 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
311 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
312 "actual block device, or simply an empty file of zeroes that you have created "
313 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
319 #: ../src/guestfs.pod:129
321 "The call you should use in modern code for adding drives is L</"
322 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
323 "specifying that the format is raw, do:"
328 #: ../src/guestfs.pod:133
331 " guestfs_add_drive_opts (g, filename,\n"
332 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
345 #: ../src/guestfs.pod:139
348 " guestfs_add_drive_opts (g, filename,\n"
349 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
350 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
357 #: ../src/guestfs.pod:144
359 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
360 "libguestfs won't modify the file."
365 #: ../src/guestfs.pod:147
367 "Be extremely cautious if the disk image is in use, eg. if it is being used "
368 "by a virtual machine. Adding it read-write will almost certainly cause disk "
369 "corruption, but adding it read-only is safe."
374 #: ../src/guestfs.pod:151
376 "You must add at least one disk image, and you may add multiple disk images. "
377 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
378 "first one you added), C</dev/sdb> (for the second one you added), etc."
383 #: ../src/guestfs.pod:156
385 "Once L</guestfs_launch> has been called you cannot add any more images. You "
386 "can call L</guestfs_list_devices> to get a list of the device names, in the "
387 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
392 #: ../src/guestfs.pod:161
397 #: ../src/guestfs.pod:163
399 "Before you can read or write files, create directories and so on in a disk "
400 "image that contains filesystems, you have to mount those filesystems using "
401 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
402 "a disk image contains (for example) one partition with a filesystem on that "
403 "partition, then you can mount it directly:"
407 #: ../src/guestfs.pod:170
410 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
415 #: ../src/guestfs.pod:172
417 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
418 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
419 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
420 "that these are libguestfs virtual devices, and are nothing to do with host "
425 #: ../src/guestfs.pod:178
427 "If you are given a disk image and you don't know what it contains then you "
428 "have to find out. Libguestfs can do that too: use L</"
429 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
430 "LVs, and either try mounting each to see what is mountable, or else examine "
431 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
432 "filesystems, use L</guestfs_list_filesystems>."
436 #: ../src/guestfs.pod:186
438 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
439 "L</INSPECTION> below). But you might find it easier to look at higher level "
440 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
444 #: ../src/guestfs.pod:191
446 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
447 "several other variations of the C<guestfs_mount_*> call."
452 #: ../src/guestfs.pod:194
453 msgid "FILESYSTEM ACCESS AND MODIFICATION"
458 #: ../src/guestfs.pod:196
460 "The majority of the libguestfs API consists of fairly low-level calls for "
461 "accessing and modifying the files, directories, symlinks etc on mounted "
462 "filesystems. There are over a hundred such calls which you can find listed "
463 "in detail below in this man page, and we don't even pretend to cover them "
464 "all in this overview."
469 #: ../src/guestfs.pod:202
471 "Specify filenames as full paths, starting with C<\"/\"> and including the "
477 #: ../src/guestfs.pod:205
479 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
480 "the file called C<\"etc/passwd\"> then you could do:"
485 #: ../src/guestfs.pod:208
488 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
494 #: ../src/guestfs.pod:210
496 "This would return C<data> as a newly allocated buffer containing the full "
497 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
498 "or C<NULL> if there was an error."
503 #: ../src/guestfs.pod:214
505 "As another example, to create a top-level directory on that filesystem "
506 "called C<\"var\"> you would do:"
511 #: ../src/guestfs.pod:217
514 " guestfs_mkdir (g, \"/var\");\n"
520 #: ../src/guestfs.pod:219
521 msgid "To create a symlink you could do:"
526 #: ../src/guestfs.pod:221
529 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
530 " \"/etc/rc3.d/S30portmap\");\n"
536 #: ../src/guestfs.pod:224
538 "Libguestfs will reject attempts to use relative paths and there is no "
539 "concept of a current working directory."
544 #: ../src/guestfs.pod:227
546 "Libguestfs can return errors in many situations: for example if the "
547 "filesystem isn't writable, or if a file or directory that you requested "
548 "doesn't exist. If you are using the C API (documented here) you have to "
549 "check for those error conditions after each call. (Other language bindings "
550 "turn these errors into exceptions)."
555 #: ../src/guestfs.pod:233
557 "File writes are affected by the per-handle umask, set by calling L</"
558 "guestfs_umask> and defaulting to 022. See L</UMASK>."
563 #: ../src/guestfs.pod:236
569 #: ../src/guestfs.pod:238
571 "Libguestfs contains API calls to read, create and modify partition tables on "
577 #: ../src/guestfs.pod:241
579 "In the common case where you want to create a single partition covering the "
580 "whole disk, you should use the L</guestfs_part_disk> call:"
585 #: ../src/guestfs.pod:245
588 " const char *parttype = \"mbr\";\n"
589 " if (disk_is_larger_than_2TB)\n"
590 " parttype = \"gpt\";\n"
591 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
597 #: ../src/guestfs.pod:250
599 "Obviously this effectively wipes anything that was on that disk image before."
604 #: ../src/guestfs.pod:253
610 #: ../src/guestfs.pod:255
612 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
613 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
614 "you familiarize yourself with the concepts of physical volumes, volume "
615 "groups and logical volumes."
620 #: ../src/guestfs.pod:260
622 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
623 "tldp.org/HOWTO/LVM-HOWTO/>."
628 #: ../src/guestfs.pod:263
633 #: ../src/guestfs.pod:265
635 "Use L</guestfs_cat> to download small, text only files. This call is "
636 "limited to files which are less than 2 MB and which cannot contain any ASCII "
637 "NUL (C<\\0>) characters. However the API is very simple to use."
642 #: ../src/guestfs.pod:269
644 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
645 "bit data, since it returns a (pointer, size) pair. However it is still "
646 "limited to \"small\" files, less than 2 MB."
651 #: ../src/guestfs.pod:273
653 "L</guestfs_download> can be used to download any file, with no limits on "
654 "content or size (even files larger than 4 GB)."
659 #: ../src/guestfs.pod:276
661 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
666 #: ../src/guestfs.pod:279
672 #: ../src/guestfs.pod:281
674 "It's often the case that you want to write a file or files to the disk image."
679 #: ../src/guestfs.pod:284
681 "To write a small file with fixed content, use L</guestfs_write>. To create "
682 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
683 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
684 "of other functions for creating test files, for example L</guestfs_fill> and "
685 "L</guestfs_fill_pattern>."
690 #: ../src/guestfs.pod:290
692 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
693 "file content or size (even files larger than 4 GB)."
698 #: ../src/guestfs.pod:293
700 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
705 #: ../src/guestfs.pod:295
707 "However the fastest way to upload I<large numbers of arbitrary files> is to "
708 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
709 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
710 "in a predictable way (eg. adding it last after all other drives) then you "
711 "can get the device name from L</guestfs_list_devices> and mount it directly "
712 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
713 "portable between kernel versions, and they don't support labels or UUIDs. "
714 "If you want to pre-build an image or you need to mount it using a label or "
715 "UUID, use an ISO image instead."
720 #: ../src/guestfs.pod:306
726 #: ../src/guestfs.pod:308
728 "There are various different commands for copying between files and devices "
729 "and in and out of the guest filesystem. These are summarised in the table "
735 #: ../src/guestfs.pod:314
736 msgid "B<file> to B<file>"
741 #: ../src/guestfs.pod:316
743 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
744 "directories recursively."
749 #: ../src/guestfs.pod:319
750 msgid "B<file or device> to B<file or device>"
755 #: ../src/guestfs.pod:321
757 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
758 "devices in the guest."
763 #: ../src/guestfs.pod:324
764 msgid "Example: duplicate the contents of an LV:"
769 #: ../src/guestfs.pod:326
772 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
778 #: ../src/guestfs.pod:328
780 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
781 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
782 "guestfs_copy_size>."
787 #: ../src/guestfs.pod:332
788 msgid "B<file on the host> to B<file or device>"
793 #: ../src/guestfs.pod:334
794 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
799 #: ../src/guestfs.pod:336
800 msgid "B<file or device> to B<file on the host>"
805 #: ../src/guestfs.pod:338
806 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
811 #: ../src/guestfs.pod:342
812 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
817 #: ../src/guestfs.pod:344
819 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
820 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
821 "appears you can only upload and download to files. However many Un*x-like "
822 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
823 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
824 "and arbitrary file descriptor N."
829 #: ../src/guestfs.pod:352
830 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
834 #: ../src/guestfs.pod:355
837 " guestfs_download (g, filename, \"/dev/stdout\");\n"
843 #: ../src/guestfs.pod:357
844 msgid "and you can write tar output to a pipe C<fd> by doing:"
848 #: ../src/guestfs.pod:359
852 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
853 " guestfs_tar_out (g, \"/\", devfd);\n"
859 #: ../src/guestfs.pod:363
860 msgid "LISTING FILES"
865 #: ../src/guestfs.pod:365
867 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
868 "L<guestfish(1)>-equivalent command C<ll>)."
873 #: ../src/guestfs.pod:368
875 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
876 "programs, as a flat list of strings."
881 #: ../src/guestfs.pod:371
883 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
884 "directory, plus additional information about each one. It is more "
885 "equivalent to using the L<readdir(3)> call on a local filesystem."
890 #: ../src/guestfs.pod:375
892 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
897 #: ../src/guestfs.pod:378
898 msgid "RUNNING COMMANDS"
903 #: ../src/guestfs.pod:380
905 "Although libguestfs is primarily an API for manipulating files inside guest "
906 "images, we also provide some limited facilities for running commands inside "
912 #: ../src/guestfs.pod:384
913 msgid "There are many limitations to this:"
918 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
919 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
920 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1011
921 #: ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024
922 #: ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059
923 #: ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089
924 #: ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101
925 #: ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592
926 #: ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711
927 #: ../src/guestfs.pod:2063 ../src/guestfs.pod:2069 ../src/guestfs.pod:2074
928 #: ../src/guestfs.pod:2080 ../src/guestfs.pod:2534 ../src/guestfs.pod:2538
929 #: ../src/guestfs.pod:2542 ../src/guestfs.pod:2546
930 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
931 #: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577
932 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
933 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
934 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
935 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
936 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
937 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
938 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
939 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
940 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
941 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427
942 #: ../fish/guestfish.pod:431 ../fish/guestfish.pod:435
943 #: ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13
944 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373
945 #: ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388
946 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065
947 #: ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073
948 #: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085
949 #: ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093
950 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
951 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201
952 #: ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210
953 #: ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257
954 #: ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266
955 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
956 #: ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345
957 #: ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
963 #: ../src/guestfs.pod:390
965 "The kernel version that the command runs under will be different from what "
971 #: ../src/guestfs.pod:395
973 "If the command needs to communicate with daemons, then most likely they "
979 #: ../src/guestfs.pod:400
980 msgid "The command will be running in limited memory."
985 #: ../src/guestfs.pod:404
987 "The network may not be available unless you enable it (see L</"
988 "guestfs_set_network>)."
993 #: ../src/guestfs.pod:409
994 msgid "Only supports Linux guests (not Windows, BSD, etc)."
999 #: ../src/guestfs.pod:413
1001 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
1006 #: ../src/guestfs.pod:418
1008 "For SELinux guests, you may need to enable SELinux and load policy first. "
1009 "See L</SELINUX> in this manpage."
1014 #: ../src/guestfs.pod:423
1016 "I<Security:> It is not safe to run commands from untrusted, possibly "
1017 "malicious guests. These commands may attempt to exploit your program by "
1018 "sending unexpected output. They could also try to exploit the Linux kernel "
1019 "or qemu provided by the libguestfs appliance. They could use the network "
1020 "provided by the libguestfs appliance to bypass ordinary network partitions "
1021 "and firewalls. They could use the elevated privileges or different SELinux "
1022 "context of your program to their advantage."
1027 #: ../src/guestfs.pod:432
1029 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
1030 "(a script which runs when the guest next boots normally), and to have this "
1031 "script run the commands you want in the normal context of the running guest, "
1032 "network security and so on. For information about other security issues, "
1038 #: ../src/guestfs.pod:440
1040 "The two main API calls to run commands are L</guestfs_command> and L</"
1041 "guestfs_sh> (there are also variations)."
1046 #: ../src/guestfs.pod:443
1048 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
1049 "shell globs, redirections, etc will work."
1054 #: ../src/guestfs.pod:446
1055 msgid "CONFIGURATION FILES"
1060 #: ../src/guestfs.pod:448
1062 "To read and write configuration files in Linux guest filesystems, we "
1063 "strongly recommend using Augeas. For example, Augeas understands how to "
1064 "read and write, say, a Linux shadow password file or X.org configuration "
1065 "file, and so avoids you having to write that code."
1070 #: ../src/guestfs.pod:453
1072 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1073 "document Augeas itself here because there is excellent documentation on the "
1074 "L<http://augeas.net/> website."
1079 #: ../src/guestfs.pod:457
1081 "If you don't want to use Augeas (you fool!) then try calling L</"
1082 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1088 #: ../src/guestfs.pod:461
1094 #: ../src/guestfs.pod:463
1096 "We support SELinux guests. To ensure that labeling happens correctly in "
1097 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1102 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335
1103 #: ../src/guestfs.pod:2108
1109 #: ../src/guestfs.pod:471
1110 msgid "Before launching, do:"
1115 #: ../src/guestfs.pod:473
1118 " guestfs_set_selinux (g, 1);\n"
1124 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1208 ../src/guestfs.pod:1339
1125 #: ../src/guestfs.pod:2133
1131 #: ../src/guestfs.pod:477
1133 "After mounting the guest's filesystem(s), load the policy. This is best "
1134 "done by running the L<load_policy(8)> command in the guest itself:"
1139 #: ../src/guestfs.pod:481
1142 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1148 #: ../src/guestfs.pod:483
1150 "(Older versions of C<load_policy> require you to specify the name of the "
1156 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1345
1162 #: ../src/guestfs.pod:488
1164 "Optionally, set the security context for the API. The correct security "
1165 "context to use can only be known by inspecting the guest. As an example:"
1170 #: ../src/guestfs.pod:492
1173 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1179 #: ../src/guestfs.pod:496
1180 msgid "This will work for running commands and editing existing files."
1185 #: ../src/guestfs.pod:498
1187 "When new files are created, you may need to label them explicitly, for "
1188 "example by running the external command C<restorecon pathname>."
1193 #: ../src/guestfs.pod:502
1199 #: ../src/guestfs.pod:504
1201 "Certain calls are affected by the current file mode creation mask (the "
1202 "\"umask\"). In particular ones which create files or directories, such as "
1203 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1204 "either the default mode that the file is created with or modifies the mode "
1210 #: ../src/guestfs.pod:510
1212 "The default umask is C<022>, so files are created with modes such as C<0644> "
1213 "and directories with C<0755>."
1218 #: ../src/guestfs.pod:513
1220 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1221 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1222 "guestfs_chmod> after creating each file or directory."
1227 #: ../src/guestfs.pod:517
1228 msgid "For more information about umask, see L<umask(2)>."
1233 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:720
1234 msgid "ENCRYPTED DISKS"
1239 #: ../src/guestfs.pod:521
1241 "Libguestfs allows you to access Linux guests which have been encrypted using "
1242 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1243 "standard. This includes nearly all whole disk encryption systems used by "
1244 "modern Linux guests."
1249 #: ../src/guestfs.pod:527
1251 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1252 "returns the string C<crypto_LUKS>)."
1257 #: ../src/guestfs.pod:530
1259 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1260 "will require the passphrase!"
1265 #: ../src/guestfs.pod:533
1267 "Opening a LUKS device creates a new device mapper device called C</dev/"
1268 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1269 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1270 "from and encrypted to the underlying block device respectively."
1275 #: ../src/guestfs.pod:539
1277 "LVM volume groups on the device can be made visible by calling L</"
1278 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1279 "(s) can now be mounted in the usual way."
1284 #: ../src/guestfs.pod:543
1286 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1287 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1288 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1289 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1290 "underlying encrypted block device)."
1295 #: ../src/guestfs.pod:550
1301 #: ../src/guestfs.pod:552
1303 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1304 "contains operating systems. (These APIs used to be in a separate Perl-only "
1305 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1306 "frequently used part of this library has been rewritten in C and moved into "
1312 #: ../src/guestfs.pod:558
1314 "Add all disks belonging to the unknown virtual machine and call L</"
1315 "guestfs_launch> in the usual way."
1320 #: ../src/guestfs.pod:561
1322 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1323 "and certain heuristics, and returns a list of operating systems that were "
1324 "found. An empty list means none were found. A single element is the root "
1325 "filesystem of the operating system. For dual- or multi-boot guests, "
1326 "multiple roots can be returned, each one corresponding to a separate "
1327 "operating system. (Multi-boot virtual machines are extremely rare in the "
1328 "world of virtualization, but since this scenario can happen, we have built "
1329 "libguestfs to deal with it.)"
1334 #: ../src/guestfs.pod:570
1336 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1337 "to get additional details about that operating system. For example, call L</"
1338 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1339 "Windows and Linux-based operating systems respectively."
1344 #: ../src/guestfs.pod:576
1346 "Un*x-like and Linux-based operating systems usually consist of several "
1347 "filesystems which are mounted at boot time (for example, a separate boot "
1348 "partition mounted on C</boot>). The inspection rules are able to detect how "
1349 "filesystems correspond to mount points. Call "
1350 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1351 "hash table like this example:"
1356 #: ../src/guestfs.pod:583
1359 " /boot => /dev/sda1\n"
1360 " / => /dev/vg_guest/lv_root\n"
1361 " /usr => /dev/vg_guest/lv_usr\n"
1367 #: ../src/guestfs.pod:587
1369 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1370 "filesystems as suggested."
1375 #: ../src/guestfs.pod:590
1377 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1378 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1383 #: ../src/guestfs.pod:594
1385 "Inspection currently only works for some common operating systems. "
1386 "Contributors are welcome to send patches for other operating systems that we "
1387 "currently cannot detect."
1392 #: ../src/guestfs.pod:598
1394 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1395 "for more details. The L</guestfs_inspect_os> function just ignores any "
1396 "encrypted devices."
1401 #: ../src/guestfs.pod:602
1403 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1404 "inspection and caches the results in the guest handle. Subsequent calls to "
1405 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1406 "read the disks. If you change the content of the guest disks, you can redo "
1407 "inspection by calling L</guestfs_inspect_os> again. (L</"
1408 "guestfs_inspect_list_applications> works a little differently from the other "
1409 "calls and does read the disks. See documentation for that function for "
1415 #: ../src/guestfs.pod:611
1416 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1421 #: ../src/guestfs.pod:613
1423 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1424 "ntfs-3g.org/> driver."
1429 #: ../src/guestfs.pod:616
1430 msgid "DRIVE LETTERS AND PATHS"
1435 #: ../src/guestfs.pod:618
1437 "DOS and Windows still use drive letters, and the filesystems are always "
1438 "treated as case insensitive by Windows itself, and therefore you might find "
1439 "a Windows configuration file referring to a path like C<c:\\windows"
1440 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1441 "might be referred to as C</WINDOWS/System32>."
1446 #: ../src/guestfs.pod:624
1448 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1449 "libguestfs to read the appropriate Windows Registry and configuration files, "
1450 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1456 #: ../src/guestfs.pod:629
1458 "Replacing backslash characters with forward slash characters is also outside "
1459 "the scope of libguestfs, but something that you can easily do."
1464 #: ../src/guestfs.pod:632
1466 "Where we can help is in resolving the case insensitivity of paths. For "
1467 "this, call L</guestfs_case_sensitive_path>."
1472 #: ../src/guestfs.pod:635
1473 msgid "ACCESSING THE WINDOWS REGISTRY"
1478 #: ../src/guestfs.pod:637
1480 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1481 "files, through the library C<hivex> which is part of the libguestfs project "
1482 "although ships as a separate tarball. You have to locate and download the "
1483 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1484 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1485 "reg(1)> for more help on this issue."
1490 #: ../src/guestfs.pod:645
1491 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1496 #: ../src/guestfs.pod:647
1498 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1499 "provide something which looks like a Linux symlink. The way it tries to do "
1500 "the rewriting is described here:"
1505 #: ../src/guestfs.pod:651
1507 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1513 #: ../src/guestfs.pod:653
1515 "The essential problem is that ntfs-3g simply does not have enough "
1516 "information to do a correct job. NTFS links can contain drive letters and "
1517 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1518 "It is almost certainly the case that libguestfs callers should ignore what "
1519 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1524 #: ../src/guestfs.pod:660
1526 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1527 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1528 "attribute, and read the raw reparse data from that (you can find the format "
1529 "documented in various places around the web)."
1534 #: ../src/guestfs.pod:665
1535 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1540 #: ../src/guestfs.pod:667
1542 "There are other useful extended attributes that can be read from ntfs-3g "
1543 "filesystems (using L</guestfs_getxattr>). See:"
1548 #: ../src/guestfs.pod:670
1550 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1555 #: ../src/guestfs.pod:672
1556 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1561 #: ../src/guestfs.pod:674
1563 "Although we don't want to discourage you from using the C API, we will "
1564 "mention here that the same API is also available in other languages."
1568 #: ../src/guestfs.pod:677
1570 "The API is broadly identical in all supported languages. This means that "
1571 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1572 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1573 "OCaml. In other words, a straightforward, predictable isomorphism between "
1579 #: ../src/guestfs.pod:683
1581 "Error messages are automatically transformed into exceptions if the language "
1587 #: ../src/guestfs.pod:686
1589 "We don't try to \"object orientify\" parts of the API in OO languages, "
1590 "although contributors are welcome to write higher level APIs above what we "
1591 "provide in their favourite languages if they wish."
1596 #: ../src/guestfs.pod:692
1602 #: ../src/guestfs.pod:694
1604 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1605 "identical to the C API. C++ classes and exceptions are not used."
1610 #: ../src/guestfs.pod:698
1616 #: ../src/guestfs.pod:700
1618 "The C# bindings are highly experimental. Please read the warnings at the "
1619 "top of C<csharp/Libguestfs.cs>."
1624 #: ../src/guestfs.pod:703
1630 #: ../src/guestfs.pod:705
1632 "This is the only language binding that is working but incomplete. Only "
1633 "calls which return simple integers have been bound in Haskell, and we are "
1634 "looking for help to complete this binding."
1639 #: ../src/guestfs.pod:709
1645 #: ../src/guestfs.pod:711
1647 "Full documentation is contained in the Javadoc which is distributed with "
1653 #: ../src/guestfs.pod:714
1658 #: ../src/guestfs.pod:716
1659 msgid "See L<guestfs-ocaml(3)>."
1664 #: ../src/guestfs.pod:718
1669 #: ../src/guestfs.pod:720
1670 msgid "See L<Sys::Guestfs(3)>."
1675 #: ../src/guestfs.pod:722
1681 #: ../src/guestfs.pod:724
1683 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1684 "the php-libguestfs package for your distribution."
1689 #: ../src/guestfs.pod:727
1690 msgid "The PHP binding only works correctly on 64 bit machines."
1695 #: ../src/guestfs.pod:729
1700 #: ../src/guestfs.pod:731
1701 msgid "See L<guestfs-python(3)>."
1706 #: ../src/guestfs.pod:733
1711 #: ../src/guestfs.pod:735
1712 msgid "See L<guestfs-ruby(3)>."
1717 #: ../src/guestfs.pod:737
1718 msgid "B<shell scripts>"
1722 #: ../src/guestfs.pod:739
1723 msgid "See L<guestfish(1)>."
1728 #: ../src/guestfs.pod:743
1729 msgid "LIBGUESTFS GOTCHAS"
1734 #: ../src/guestfs.pod:745
1736 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1737 "system [...] that works in the way it is documented but is counterintuitive "
1738 "and almost invites mistakes.\""
1743 #: ../src/guestfs.pod:749
1745 "Since we developed libguestfs and the associated tools, there are several "
1746 "things we would have designed differently, but are now stuck with for "
1747 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1748 "release, you can expect these to change. Beware of them."
1753 #: ../src/guestfs.pod:757
1754 msgid "Autosync / forgetting to sync."
1759 #: ../src/guestfs.pod:759
1761 "When modifying a filesystem from C or another language, you B<must> unmount "
1762 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1763 "libguestfs handle. You can also call:"
1768 #: ../src/guestfs.pod:763
1771 " guestfs_set_autosync (g, 1);\n"
1777 #: ../src/guestfs.pod:765
1779 "to have the unmount/sync done automatically for you when the handle 'g' is "
1780 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1785 #: ../src/guestfs.pod:769
1787 "If you forget to do this, then it is entirely possible that your changes "
1788 "won't be written out, or will be partially written, or (very rarely) that "
1789 "you'll get disk corruption."
1794 #: ../src/guestfs.pod:773
1796 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1797 "guestfish scripts that forget to sync will work just fine, which can make "
1798 "this very puzzling if you are trying to debug a problem."
1803 #: ../src/guestfs.pod:777
1805 "Update: Autosync is enabled by default for all API users starting from "
1806 "libguestfs 1.5.24."
1811 #: ../src/guestfs.pod:780
1812 msgid "Mount option C<-o sync> should not be the default."
1817 #: ../src/guestfs.pod:782
1819 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1820 "However C<-o sync> does not add any reliability benefit, but does have a "
1821 "very large performance impact."
1826 #: ../src/guestfs.pod:786
1828 "The work around is to use L</guestfs_mount_options> and set the mount "
1829 "options that you actually want to use."
1834 #: ../src/guestfs.pod:789
1835 msgid "Read-only should be the default."
1840 #: ../src/guestfs.pod:791
1842 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1843 "specify I<--rw> if you want to make changes to the image."
1848 #: ../src/guestfs.pod:794
1849 msgid "This would reduce the potential to corrupt live VM images."
1854 #: ../src/guestfs.pod:796
1856 "Note that many filesystems change the disk when you just mount and unmount, "
1857 "even if you didn't perform any writes. You need to use L</"
1858 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1863 #: ../src/guestfs.pod:800
1864 msgid "guestfish command line is hard to use."
1869 #: ../src/guestfs.pod:802
1871 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1872 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1873 "exist, so it fails. In earlier versions of guestfish the error message was "
1874 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1875 "we should have used C<guestfish -c command> to run commands."
1880 #: ../src/guestfs.pod:809
1881 msgid "guestfish megabyte modifiers don't work right on all commands"
1886 #: ../src/guestfs.pod:811
1888 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1889 "other modifiers). What guestfish actually does is to multiply the number "
1890 "part by the modifier part and pass the result to the C API. However this "
1891 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1892 "expecting some other unit (eg. megabytes)."
1897 #: ../src/guestfs.pod:818
1898 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1903 #: ../src/guestfs.pod:820
1906 " lvcreate LV VG 100M\n"
1912 #: ../src/guestfs.pod:822
1914 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1915 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1916 "megabytes * megabytes) logical volume. The error message you get from this "
1917 "is also a little obscure."
1922 #: ../src/guestfs.pod:827
1924 "This could be fixed in the generator by specially marking parameters and "
1925 "return values which take bytes or other units."
1930 #: ../src/guestfs.pod:830
1931 msgid "Ambiguity between devices and paths"
1936 #: ../src/guestfs.pod:832
1938 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1939 "sdb2>) and a similar pathname. A file might just happen to be called "
1940 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1945 #: ../src/guestfs.pod:837
1947 "In the current API we usually resolve this ambiguity by having two separate "
1948 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1949 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1950 "detecting if the path supplied begins with C</dev/>."
1955 #: ../src/guestfs.pod:843
1957 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1958 "make paths/devices into structured names. One way to do this would be to "
1959 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1960 "aspect of grub. Another way would be to use a structured type, equivalent "
1961 "to this OCaml type:"
1966 #: ../src/guestfs.pod:849
1969 " type path = Path of string | Device of int | Partition of int * int\n"
1975 #: ../src/guestfs.pod:851
1976 msgid "which would allow you to pass arguments like:"
1981 #: ../src/guestfs.pod:853
1984 " Path \"/foo/bar\"\n"
1985 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1986 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1987 " Path \"/dev/sdb2\" (* not a device *)\n"
1993 #: ../src/guestfs.pod:858
1995 "As you can see there are still problems to resolve even with this "
1996 "representation. Also consider how it might work in guestfish."
2001 #: ../src/guestfs.pod:863
2002 msgid "PROTOCOL LIMITS"
2007 #: ../src/guestfs.pod:865
2009 "Internally libguestfs uses a message-based protocol to pass API calls and "
2010 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
2011 "plenty more detail about this). The maximum message size used by the "
2012 "protocol is slightly less than 4 MB. For some API calls you may need to be "
2013 "aware of this limit. The API calls which may be affected are individually "
2014 "documented, with a link back to this section of the documentation."
2019 #: ../src/guestfs.pod:873
2021 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
2022 "a simple string. Because this string is at some point internally encoded as "
2023 "a message, the maximum size that it can return is slightly under 4 MB. If "
2024 "the requested file is larger than this then you will get an error."
2029 #: ../src/guestfs.pod:879
2031 "In order to transfer large files into and out of the guest filesystem, you "
2032 "need to use particular calls that support this. The sections L</UPLOADING> "
2033 "and L</DOWNLOADING> document how to do this."
2038 #: ../src/guestfs.pod:883
2040 "You might also consider mounting the disk image using our FUSE filesystem "
2041 "support (L<guestmount(1)>)."
2046 #: ../src/guestfs.pod:886
2047 msgid "KEYS AND PASSPHRASES"
2052 #: ../src/guestfs.pod:888
2054 "Certain libguestfs calls take a parameter that contains sensitive key "
2055 "material, passed in as a C string."
2060 #: ../src/guestfs.pod:891
2062 "In the future we would hope to change the libguestfs implementation so that "
2063 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
2064 "swap. However this is I<not> done at the moment, because of the complexity "
2065 "of such an implementation."
2070 #: ../src/guestfs.pod:896
2072 "Therefore you should be aware that any key parameter you pass to libguestfs "
2073 "might end up being written out to the swap partition. If this is a concern, "
2074 "scrub the swap partition or don't use libguestfs on encrypted devices."
2079 #: ../src/guestfs.pod:901
2080 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
2085 #: ../src/guestfs.pod:903
2087 "All high-level libguestfs actions are synchronous. If you want to use "
2088 "libguestfs asynchronously then you must create a thread."
2093 #: ../src/guestfs.pod:906
2095 "Only use the handle from a single thread. Either use the handle exclusively "
2096 "from one thread, or provide your own mutex so that two threads cannot issue "
2097 "calls on the same handle at the same time."
2102 #: ../src/guestfs.pod:910
2104 "See the graphical program guestfs-browser for one possible architecture for "
2105 "multithreaded programs using libvirt and libguestfs."
2110 #: ../src/guestfs.pod:913
2115 #: ../src/guestfs.pod:915
2117 "Libguestfs needs a supermin appliance, which it finds by looking along an "
2123 #: ../src/guestfs.pod:918
2125 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
2126 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
2131 #: ../src/guestfs.pod:921
2133 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
2134 "to change the directories that libguestfs will search in. The value is a "
2135 "colon-separated list of paths. The current directory is I<not> searched "
2136 "unless the path contains an empty element or C<.>. For example "
2137 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
2138 "then C</usr/lib/guestfs>."
2143 #: ../src/guestfs.pod:928
2144 msgid "QEMU WRAPPERS"
2149 #: ../src/guestfs.pod:930
2151 "If you want to compile your own qemu, run qemu from a non-standard location, "
2152 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
2158 #: ../src/guestfs.pod:934
2160 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2161 "last command in the shell script (so that qemu replaces the shell and "
2162 "becomes the direct child of the libguestfs-using program). If you don't do "
2163 "this, then the qemu process won't be cleaned up correctly."
2168 #: ../src/guestfs.pod:939
2170 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2176 #: ../src/guestfs.pod:942
2180 " qemudir=/home/rjones/d/qemu\n"
2181 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2187 #: ../src/guestfs.pod:946
2189 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2190 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2196 #: ../src/guestfs.pod:950
2199 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2205 #: ../src/guestfs.pod:952
2207 "Note that libguestfs also calls qemu with the -help and -version options in "
2208 "order to determine features."
2213 #: ../src/guestfs.pod:955
2214 msgid "ABI GUARANTEE"
2219 #: ../src/guestfs.pod:957
2221 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2222 "actions as outlined in this section. Although we will deprecate some "
2223 "actions, for example if they get replaced by newer calls, we will keep the "
2224 "old actions forever. This allows you the developer to program in confidence "
2225 "against the libguestfs API."
2230 #: ../src/guestfs.pod:963
2231 msgid "BLOCK DEVICE NAMING"
2236 #: ../src/guestfs.pod:965
2238 "In the kernel there is now quite a profusion of schemata for naming block "
2239 "devices (in this context, by I<block device> I mean a physical or virtual "
2240 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2241 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2242 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2243 "for the old IDE driver (particularly for SATA devices) those devices also "
2244 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2245 "paravirtualized drivers. This has created several different naming systems, "
2246 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2251 #: ../src/guestfs.pod:977
2253 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2254 "Linux kernel to access block devices. We can run a variety of appliances "
2255 "based on a variety of Linux kernels."
2260 #: ../src/guestfs.pod:981
2262 "This causes a problem for libguestfs because many API calls use device or "
2263 "partition names. Working scripts and the recipe (example) scripts that we "
2264 "make available over the internet could fail if the naming scheme changes."
2269 #: ../src/guestfs.pod:986
2271 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2272 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2273 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2274 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2279 #: ../src/guestfs.pod:992
2281 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2282 "L</guestfs_list_partitions> and similar calls return the true names of the "
2283 "devices and partitions as known to the appliance."
2288 #: ../src/guestfs.pod:997
2289 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2294 #: ../src/guestfs.pod:999
2296 "Usually this translation is transparent. However in some (very rare) cases "
2297 "you may need to know the exact algorithm. Such cases include where you use "
2298 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2299 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2304 #: ../src/guestfs.pod:1005
2306 "The algorithm is applied only to I<parameters> which are known to be either "
2307 "device or partition names. Return values from functions such as L</"
2308 "guestfs_list_devices> are never changed."
2313 #: ../src/guestfs.pod:1013
2314 msgid "Is the string a parameter which is a device or partition name?"
2319 #: ../src/guestfs.pod:1017
2320 msgid "Does the string begin with C</dev/sd>?"
2325 #: ../src/guestfs.pod:1021
2327 "Does the named device exist? If so, we use that device. However if I<not> "
2328 "then we continue with this algorithm."
2333 #: ../src/guestfs.pod:1026
2334 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2339 #: ../src/guestfs.pod:1028
2340 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2345 #: ../src/guestfs.pod:1030
2346 msgid "If that named device exists, use it. If not, continue."
2351 #: ../src/guestfs.pod:1034
2352 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2357 #: ../src/guestfs.pod:1036
2358 msgid "If that named device exists, use it. If not, return an error."
2363 #: ../src/guestfs.pod:1040
2364 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2369 #: ../src/guestfs.pod:1042
2371 "Although the standard naming scheme and automatic translation is useful for "
2372 "simple programs and guestfish scripts, for larger programs it is best not to "
2373 "rely on this mechanism."
2378 #: ../src/guestfs.pod:1046
2380 "Where possible for maximum future portability programs using libguestfs "
2381 "should use these future-proof techniques:"
2386 #: ../src/guestfs.pod:1053
2388 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2389 "device names, and then use those names directly."
2394 #: ../src/guestfs.pod:1056
2396 "Since those device names exist by definition, they will never be translated."
2401 #: ../src/guestfs.pod:1061
2403 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2404 "filesystem labels."
2409 #: ../src/guestfs.pod:1066
2415 #: ../src/guestfs.pod:1068
2417 "This section discusses security implications of using libguestfs, "
2418 "particularly with untrusted or malicious guests or disk images."
2423 #: ../src/guestfs.pod:1071
2424 msgid "GENERAL SECURITY CONSIDERATIONS"
2429 #: ../src/guestfs.pod:1073
2431 "Be careful with any files or data that you download from a guest (by "
2432 "\"download\" we mean not just the L</guestfs_download> command but any "
2433 "command that reads files, filenames, directories or anything else from a "
2434 "disk image). An attacker could manipulate the data to fool your program "
2435 "into doing the wrong thing. Consider cases such as:"
2440 #: ../src/guestfs.pod:1083
2441 msgid "the data (file etc) not being present"
2446 #: ../src/guestfs.pod:1087
2447 msgid "being present but empty"
2452 #: ../src/guestfs.pod:1091
2453 msgid "being much larger than normal"
2458 #: ../src/guestfs.pod:1095
2459 msgid "containing arbitrary 8 bit data"
2464 #: ../src/guestfs.pod:1099
2465 msgid "being in an unexpected character encoding"
2470 #: ../src/guestfs.pod:1103
2471 msgid "containing homoglyphs."
2476 #: ../src/guestfs.pod:1107
2477 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2482 #: ../src/guestfs.pod:1109
2484 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2485 "(VFS) module can sometimes be escalated into exploits by deliberately "
2486 "creating a malicious, malformed filesystem. These exploits are very severe "
2487 "for two reasons. Firstly there are very many filesystem drivers in the "
2488 "kernel, and many of them are infrequently used and not much developer "
2489 "attention has been paid to the code. Linux userspace helps potential "
2490 "crackers by detecting the filesystem type and automatically choosing the "
2491 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2492 "the administrator. Secondly, a kernel-level exploit is like a local root "
2493 "exploit (worse in some ways), giving immediate and total access to the "
2494 "system right down to the hardware level."
2499 #: ../src/guestfs.pod:1122
2501 "That explains why you should never mount a filesystem from an untrusted "
2502 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2503 "inside a qemu virtual machine, usually running as a non-root user. The "
2504 "attacker would need to write a filesystem which first exploited the kernel, "
2505 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2506 "the libguestfs protocol, and finally to be as serious as the host kernel "
2507 "exploit it would need to escalate its privileges to root. This multi-step "
2508 "escalation, performed by a static piece of data, is thought to be extremely "
2509 "hard to do, although we never say 'never' about security issues."
2514 #: ../src/guestfs.pod:1133
2516 "In any case callers can reduce the attack surface by forcing the filesystem "
2517 "type when mounting (use L</guestfs_mount_vfs>)."
2522 #: ../src/guestfs.pod:1136
2523 msgid "PROTOCOL SECURITY"
2528 #: ../src/guestfs.pod:1138
2530 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2531 "defined upper message size. However a program that uses libguestfs must "
2532 "also take care - for example you can write a program that downloads a binary "
2533 "from a disk image and executes it locally, and no amount of protocol "
2534 "security will save you from the consequences."
2539 #: ../src/guestfs.pod:1144
2540 msgid "INSPECTION SECURITY"
2545 #: ../src/guestfs.pod:1146
2547 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2548 "directly from the guest, and these could contain any 8 bit data. Callers "
2549 "should be careful to escape these before printing them to a structured file "
2550 "(for example, use HTML escaping if creating a web page)."
2555 #: ../src/guestfs.pod:1152
2557 "Guest configuration may be altered in unusual ways by the administrator of "
2558 "the virtual machine, and may not reflect reality (particularly for untrusted "
2559 "or actively malicious guests). For example we parse the hostname from "
2560 "configuration files like C</etc/sysconfig/network> that we find in the "
2561 "guest, but the guest administrator can easily manipulate these files to "
2562 "provide the wrong hostname."
2567 #: ../src/guestfs.pod:1160
2569 "The inspection API parses guest configuration using two external libraries: "
2570 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2571 "designed to be robust in the face of malicious data, although denial of "
2572 "service attacks are still possible, for example with oversized configuration "
2578 #: ../src/guestfs.pod:1166
2579 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2584 #: ../src/guestfs.pod:1168
2586 "Be very cautious about running commands from the guest. By running a "
2587 "command in the guest, you are giving CPU time to a binary that you do not "
2588 "control, under the same user account as the library, albeit wrapped in qemu "
2589 "virtualization. More information and alternatives can be found in the "
2590 "section L</RUNNING COMMANDS>."
2595 #: ../src/guestfs.pod:1174
2596 msgid "CVE-2010-3851"
2601 #: ../src/guestfs.pod:1176
2602 msgid "https://bugzilla.redhat.com/642934"
2607 #: ../src/guestfs.pod:1178
2609 "This security bug concerns the automatic disk format detection that qemu "
2610 "does on disk images."
2615 #: ../src/guestfs.pod:1181
2617 "A raw disk image is just the raw bytes, there is no header. Other disk "
2618 "images like qcow2 contain a special header. Qemu deals with this by looking "
2619 "for one of the known headers, and if none is found then assuming the disk "
2620 "image must be raw."
2625 #: ../src/guestfs.pod:1186
2627 "This allows a guest which has been given a raw disk image to write some "
2628 "other header. At next boot (or when the disk image is accessed by "
2629 "libguestfs) qemu would do autodetection and think the disk image format was, "
2630 "say, qcow2 based on the header written by the guest."
2635 #: ../src/guestfs.pod:1191
2637 "This in itself would not be a problem, but qcow2 offers many features, one "
2638 "of which is to allow a disk image to refer to another image (called the "
2639 "\"backing disk\"). It does this by placing the path to the backing disk "
2640 "into the qcow2 header. This path is not validated and could point to any "
2641 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2642 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2643 "control of the attacker."
2648 #: ../src/guestfs.pod:1199
2650 "In libguestfs this is rather hard to exploit except under two circumstances:"
2655 #: ../src/guestfs.pod:1206
2656 msgid "You have enabled the network or have opened the disk in write mode."
2661 #: ../src/guestfs.pod:1210
2663 "You are also running untrusted code from the guest (see L</RUNNING "
2669 #: ../src/guestfs.pod:1215
2671 "The way to avoid this is to specify the expected disk format when adding "
2672 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2673 "should always do this if the disk is raw format, and it's a good idea for "
2679 #: ../src/guestfs.pod:1220
2681 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2682 "format is fetched from libvirt and passed through."
2687 #: ../src/guestfs.pod:1223
2689 "For libguestfs tools, use the I<--format> command line parameter as "
2695 #: ../src/guestfs.pod:1226
2696 msgid "CONNECTION MANAGEMENT"
2701 #: ../src/guestfs.pod:1228
2707 #: ../src/guestfs.pod:1230
2709 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2710 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2711 "handle and release all resources used."
2716 #: ../src/guestfs.pod:1234
2718 "For information on using multiple handles and threads, see the section L</"
2719 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2724 #: ../src/guestfs.pod:1237
2725 msgid "guestfs_create"
2730 #: ../src/guestfs.pod:1239
2733 " guestfs_h *guestfs_create (void);\n"
2739 #: ../src/guestfs.pod:1241
2740 msgid "Create a connection handle."
2745 #: ../src/guestfs.pod:1243
2747 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2748 "on the handle at least once."
2753 #: ../src/guestfs.pod:1246
2755 "This function returns a non-NULL pointer to a handle on success or NULL on "
2761 #: ../src/guestfs.pod:1249
2762 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2767 #: ../src/guestfs.pod:1251
2769 "You may also want to configure error handling for the handle. See L</ERROR "
2770 "HANDLING> section below."
2775 #: ../src/guestfs.pod:1254
2776 msgid "guestfs_close"
2781 #: ../src/guestfs.pod:1256
2784 " void guestfs_close (guestfs_h *g);\n"
2790 #: ../src/guestfs.pod:1258
2791 msgid "This closes the connection handle and frees up all resources used."
2796 #: ../src/guestfs.pod:1260
2797 msgid "ERROR HANDLING"
2802 #: ../src/guestfs.pod:1262
2804 "API functions can return errors. For example, almost all functions that "
2805 "return C<int> will return C<-1> to indicate an error."
2810 #: ../src/guestfs.pod:1265
2812 "Additional information is available for errors: an error message string and "
2813 "optionally an error number (errno) if the thing that failed was a system "
2819 #: ../src/guestfs.pod:1269
2821 "You can get at the additional information about the last error on the handle "
2822 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2823 "up an error handler with L</guestfs_set_error_handler>."
2828 #: ../src/guestfs.pod:1274
2830 "When the handle is created, a default error handler is installed which "
2831 "prints the error message string to C<stderr>. For small short-running "
2832 "command line programs it is sufficient to do:"
2837 #: ../src/guestfs.pod:1278
2840 " if (guestfs_launch (g) == -1)\n"
2841 " exit (EXIT_FAILURE);\n"
2847 #: ../src/guestfs.pod:1281
2849 "since the default error handler will ensure that an error message has been "
2850 "printed to C<stderr> before the program exits."
2855 #: ../src/guestfs.pod:1284
2857 "For other programs the caller will almost certainly want to install an "
2858 "alternate error handler or do error handling in-line like this:"
2863 #: ../src/guestfs.pod:1287
2866 " g = guestfs_create ();\n"
2872 #: ../src/guestfs.pod:1289
2875 " /* This disables the default behaviour of printing errors\n"
2877 " guestfs_set_error_handler (g, NULL, NULL);\n"
2883 #: ../src/guestfs.pod:1293
2886 " if (guestfs_launch (g) == -1) {\n"
2887 " /* Examine the error message and print it etc. */\n"
2888 " char *msg = guestfs_last_error (g);\n"
2889 " int errnum = guestfs_last_errno (g);\n"
2890 " fprintf (stderr, \"%s\\n\", msg);\n"
2898 #: ../src/guestfs.pod:1301
2900 "Out of memory errors are handled differently. The default action is to call "
2901 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2902 "guestfs_set_out_of_memory_handler>."
2907 #: ../src/guestfs.pod:1305
2909 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2910 "because there is no handle if this happens there is no way to get additional "
2911 "error information. However L</guestfs_create> is supposed to be a "
2912 "lightweight operation which can only fail because of insufficient memory (it "
2913 "returns NULL in this case)."
2918 #: ../src/guestfs.pod:1311
2919 msgid "guestfs_last_error"
2924 #: ../src/guestfs.pod:1313
2927 " const char *guestfs_last_error (guestfs_h *g);\n"
2933 #: ../src/guestfs.pod:1315
2935 "This returns the last error message that happened on C<g>. If there has not "
2936 "been an error since the handle was created, then this returns C<NULL>."
2941 #: ../src/guestfs.pod:1319
2943 "The lifetime of the returned string is until the next error occurs, or L</"
2944 "guestfs_close> is called."
2949 #: ../src/guestfs.pod:1322
2950 msgid "guestfs_last_errno"
2955 #: ../src/guestfs.pod:1324
2958 " int guestfs_last_errno (guestfs_h *g);\n"
2964 #: ../src/guestfs.pod:1326
2965 msgid "This returns the last error number (errno) that happened on C<g>."
2970 #: ../src/guestfs.pod:1328
2971 msgid "If successful, an errno integer not equal to zero is returned."
2976 #: ../src/guestfs.pod:1330
2978 "If no error, this returns 0. This call can return 0 in three situations:"
2983 #: ../src/guestfs.pod:1337
2984 msgid "There has not been any error on the handle."
2989 #: ../src/guestfs.pod:1341
2991 "There has been an error but the errno was meaningless. This corresponds to "
2992 "the case where the error did not come from a failed system call, but for "
2993 "some other reason."
2998 #: ../src/guestfs.pod:1347
3000 "There was an error from a failed system call, but for some reason the errno "
3001 "was not captured and returned. This usually indicates a bug in libguestfs."
3006 #: ../src/guestfs.pod:1353
3008 "Libguestfs tries to convert the errno from inside the applicance into a "
3009 "corresponding errno for the caller (not entirely trivial: the appliance "
3010 "might be running a completely different operating system from the library "
3011 "and error numbers are not standardized across Un*xen). If this could not be "
3012 "done, then the error is translated to C<EINVAL>. In practice this should "
3013 "only happen in very rare circumstances."
3018 #: ../src/guestfs.pod:1361
3019 msgid "guestfs_set_error_handler"
3024 #: ../src/guestfs.pod:1363
3027 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
3029 " const char *msg);\n"
3030 " void guestfs_set_error_handler (guestfs_h *g,\n"
3031 " guestfs_error_handler_cb cb,\n"
3038 #: ../src/guestfs.pod:1370
3040 "The callback C<cb> will be called if there is an error. The parameters "
3041 "passed to the callback are an opaque data pointer and the error message "
3047 #: ../src/guestfs.pod:1374
3049 "C<errno> is not passed to the callback. To get that the callback must call "
3050 "L</guestfs_last_errno>."
3055 #: ../src/guestfs.pod:1377
3057 "Note that the message string C<msg> is freed as soon as the callback "
3058 "function returns, so if you want to stash it somewhere you must make your "
3064 #: ../src/guestfs.pod:1381
3065 msgid "The default handler prints messages on C<stderr>."
3070 #: ../src/guestfs.pod:1383
3071 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
3076 #: ../src/guestfs.pod:1385
3077 msgid "guestfs_get_error_handler"
3082 #: ../src/guestfs.pod:1387
3085 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
3086 " void **opaque_rtn);\n"
3092 #: ../src/guestfs.pod:1390
3093 msgid "Returns the current error handler callback."
3098 #: ../src/guestfs.pod:1392
3099 msgid "guestfs_set_out_of_memory_handler"
3104 #: ../src/guestfs.pod:1394
3107 " typedef void (*guestfs_abort_cb) (void);\n"
3108 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3109 " guestfs_abort_cb);\n"
3115 #: ../src/guestfs.pod:1398
3117 "The callback C<cb> will be called if there is an out of memory situation. "
3118 "I<Note this callback must not return>."
3123 #: ../src/guestfs.pod:1401
3124 msgid "The default is to call L<abort(3)>."
3129 #: ../src/guestfs.pod:1403
3131 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3136 #: ../src/guestfs.pod:1406
3137 msgid "guestfs_get_out_of_memory_handler"
3142 #: ../src/guestfs.pod:1408
3145 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3151 #: ../src/guestfs.pod:1410
3152 msgid "This returns the current out of memory handler."
3157 #: ../src/guestfs.pod:1412
3163 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:958
3169 #: ../src/guestfs.pod:1416
3175 #: ../src/guestfs.pod:1418
3181 #: ../src/guestfs.pod:1420
3182 msgid "AVAILABILITY"
3187 #: ../src/guestfs.pod:1422
3188 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3193 #: ../src/guestfs.pod:1424
3195 "Using L</guestfs_available> you can test availability of the following "
3196 "groups of functions. This test queries the appliance to see if the "
3197 "appliance you are currently using supports the functionality."
3202 #: ../src/guestfs.pod:1429
3203 msgid "@AVAILABILITY@"
3208 #: ../src/guestfs.pod:1431
3209 msgid "GUESTFISH supported COMMAND"
3214 #: ../src/guestfs.pod:1433
3216 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3217 "prints out the available groups and whether they are supported by this build "
3218 "of libguestfs. Note however that you have to do C<run> first."
3223 #: ../src/guestfs.pod:1438
3224 msgid "SINGLE CALLS AT COMPILE TIME"
3229 #: ../src/guestfs.pod:1440
3231 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3232 "function, such as:"
3237 #: ../src/guestfs.pod:1443
3240 " #define LIBGUESTFS_HAVE_DD 1\n"
3246 #: ../src/guestfs.pod:1445
3247 msgid "if L</guestfs_dd> is available."
3252 #: ../src/guestfs.pod:1447
3254 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3255 "function is available at compile time, we recommended using build tools such "
3256 "as autoconf or cmake. For example in autotools you could use:"
3261 #: ../src/guestfs.pod:1452
3264 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3265 " AC_CHECK_FUNCS([guestfs_dd])\n"
3271 #: ../src/guestfs.pod:1455
3273 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3279 #: ../src/guestfs.pod:1458
3280 msgid "SINGLE CALLS AT RUN TIME"
3285 #: ../src/guestfs.pod:1460
3287 "Testing at compile time doesn't guarantee that a function really exists in "
3288 "the library. The reason is that you might be dynamically linked against a "
3289 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3290 "This situation unfortunately results in a segmentation fault, which is a "
3291 "shortcoming of the C dynamic linking system itself."
3296 #: ../src/guestfs.pod:1467
3298 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3299 "in this example program (note that you still need the compile time check as "
3305 #: ../src/guestfs.pod:1471
3308 " #include <stdio.h>\n"
3309 " #include <stdlib.h>\n"
3310 " #include <unistd.h>\n"
3311 " #include <dlfcn.h>\n"
3312 " #include <guestfs.h>\n"
3318 #: ../src/guestfs.pod:1477
3323 " #ifdef LIBGUESTFS_HAVE_DD\n"
3325 " int has_function;\n"
3331 #: ../src/guestfs.pod:1483
3334 " /* Test if the function guestfs_dd is really available. */\n"
3335 " dl = dlopen (NULL, RTLD_LAZY);\n"
3337 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3338 " exit (EXIT_FAILURE);\n"
3340 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3347 #: ../src/guestfs.pod:1492
3350 " if (!has_function)\n"
3351 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3353 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3354 " /* Now it's safe to call\n"
3355 " guestfs_dd (g, \"foo\", \"bar\");\n"
3359 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3367 #: ../src/guestfs.pod:1505
3369 "You may think the above is an awful lot of hassle, and it is. There are "
3370 "other ways outside of the C linking system to ensure that this kind of "
3371 "incompatibility never arises, such as using package versioning:"
3376 #: ../src/guestfs.pod:1510
3379 " Requires: libguestfs >= 1.0.80\n"
3385 #: ../src/guestfs.pod:1512
3386 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3391 #: ../src/guestfs.pod:1514
3393 "A recent feature of the API is the introduction of calls which take optional "
3394 "arguments. In C these are declared 3 ways. The main way is as a call which "
3395 "takes variable arguments (ie. C<...>), as in this example:"
3400 #: ../src/guestfs.pod:1519
3403 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3409 #: ../src/guestfs.pod:1521
3411 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3412 "call with no optional arguments specified:"
3417 #: ../src/guestfs.pod:1524
3420 " guestfs_add_drive_opts (g, filename, -1);\n"
3426 #: ../src/guestfs.pod:1526
3427 msgid "With a single optional argument:"
3432 #: ../src/guestfs.pod:1528
3435 " guestfs_add_drive_opts (g, filename,\n"
3436 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3443 #: ../src/guestfs.pod:1532
3449 #: ../src/guestfs.pod:1534
3452 " guestfs_add_drive_opts (g, filename,\n"
3453 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3454 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3461 #: ../src/guestfs.pod:1539
3463 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3469 #: ../src/guestfs.pod:1542
3470 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3475 #: ../src/guestfs.pod:1544
3477 "The second variant has the same name with the suffix C<_va>, which works the "
3478 "same way but takes a C<va_list>. See the C manual for details. For the "
3479 "example function, this is declared:"
3484 #: ../src/guestfs.pod:1548
3487 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3494 #: ../src/guestfs.pod:1551
3495 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3500 #: ../src/guestfs.pod:1553
3502 "The third variant is useful where you need to construct these calls. You "
3503 "pass in a structure where you fill in the optional fields. The structure "
3504 "has a bitmask as the first element which you must set to indicate which "
3505 "fields you have filled in. For our example function the structure and call "
3511 #: ../src/guestfs.pod:1559
3514 " struct guestfs_add_drive_opts_argv {\n"
3515 " uint64_t bitmask;\n"
3517 " const char *format;\n"
3520 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3521 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3527 #: ../src/guestfs.pod:1568
3528 msgid "You could call it like this:"
3533 #: ../src/guestfs.pod:1570
3536 " struct guestfs_add_drive_opts_argv optargs = {\n"
3537 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3538 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3540 " .format = \"qcow2\"\n"
3547 #: ../src/guestfs.pod:1577
3550 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3556 #: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11
3557 #: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9
3558 #: ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532
3564 #: ../src/guestfs.pod:1585
3565 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3570 #: ../src/guestfs.pod:1590
3571 msgid "You do not need to fill in all fields of the structure."
3576 #: ../src/guestfs.pod:1594
3578 "There must be a one-to-one correspondence between fields of the structure "
3579 "that are filled in, and bits set in the bitmask."
3584 #: ../src/guestfs.pod:1599
3585 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3590 #: ../src/guestfs.pod:1601
3592 "In other languages, optional arguments are expressed in the way that is "
3593 "natural for that language. We refer you to the language-specific "
3594 "documentation for more details on that."
3599 #: ../src/guestfs.pod:1605
3600 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3605 #: ../src/guestfs.pod:1607
3606 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3611 #: ../src/guestfs.pod:1609
3613 "The child process generates events in some situations. Current events "
3614 "include: receiving a log message, the child process exits."
3619 #: ../src/guestfs.pod:1612
3621 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3627 #: ../src/guestfs.pod:1615
3629 "Only I<one callback of each type> can be registered for each handle. "
3630 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3631 "that type. Cancel all callbacks of this type by calling this function with "
3632 "C<cb> set to C<NULL>."
3637 #: ../src/guestfs.pod:1620
3638 msgid "guestfs_set_log_message_callback"
3643 #: ../src/guestfs.pod:1622
3646 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3647 " char *buf, int len);\n"
3648 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3649 " guestfs_log_message_cb cb,\n"
3656 #: ../src/guestfs.pod:1628
3658 "The callback function C<cb> will be called whenever qemu or the guest writes "
3659 "anything to the console."
3664 #: ../src/guestfs.pod:1631
3665 msgid "Use this function to capture kernel messages and similar."
3670 #: ../src/guestfs.pod:1633
3672 "Normally there is no log message handler, and log messages are just "
3678 #: ../src/guestfs.pod:1636
3679 msgid "guestfs_set_subprocess_quit_callback"
3684 #: ../src/guestfs.pod:1638
3687 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3688 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3689 " guestfs_subprocess_quit_cb cb,\n"
3696 #: ../src/guestfs.pod:1643
3698 "The callback function C<cb> will be called when the child process quits, "
3699 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3700 "corresponds to a transition from any state to the CONFIG state)."
3705 #: ../src/guestfs.pod:1648
3706 msgid "guestfs_set_launch_done_callback"
3711 #: ../src/guestfs.pod:1650
3714 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3715 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3716 " guestfs_launch_done_cb cb,\n"
3723 #: ../src/guestfs.pod:1655
3725 "The callback function C<cb> will be called when the child process becomes "
3726 "ready first time after it has been launched. (This corresponds to a "
3727 "transition from LAUNCHING to the READY state)."
3732 #: ../src/guestfs.pod:1659
3733 msgid "guestfs_set_close_callback"
3738 #: ../src/guestfs.pod:1661
3741 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3742 " void guestfs_set_close_callback (guestfs_h *g,\n"
3743 " guestfs_close_cb cb,\n"
3750 #: ../src/guestfs.pod:1666
3752 "The callback function C<cb> will be called while the handle is being closed "
3753 "(synchronously from L</guestfs_close>)."
3758 #: ../src/guestfs.pod:1669
3760 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3761 "handles that are open when the program exits. This means that this callback "
3762 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3763 "problems in higher-level languages (eg. if your HLL interpreter has already "
3764 "been cleaned up by the time this is called, and if your callback then jumps "
3765 "into some HLL function)."
3770 #: ../src/guestfs.pod:1677
3771 msgid "guestfs_set_progress_callback"
3776 #: ../src/guestfs.pod:1679
3779 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3780 " int proc_nr, int serial,\n"
3781 " uint64_t position, uint64_t total);\n"
3782 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3783 " guestfs_progress_cb cb,\n"
3790 #: ../src/guestfs.pod:1686
3792 "Some long-running operations can generate progress messages. If this "
3793 "callback is registered, then it will be called each time a progress message "
3794 "is generated (usually two seconds after the operation started, and three "
3795 "times per second thereafter until it completes, although the frequency may "
3796 "change in future versions)."
3801 #: ../src/guestfs.pod:1692
3803 "The callback receives two numbers: C<position> and C<total>. The units of "
3804 "C<total> are not defined, although for some operations C<total> may relate "
3805 "in some way to the amount of data to be transferred (eg. in bytes or "
3806 "megabytes), and C<position> may be the portion which has been transferred."
3811 #: ../src/guestfs.pod:1698
3812 msgid "The only defined and stable parts of the API are:"
3817 #: ../src/guestfs.pod:1704
3819 "The callback can display to the user some type of progress bar or indicator "
3820 "which shows the ratio of C<position>:C<total>."
3825 #: ../src/guestfs.pod:1709
3826 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3831 #: ../src/guestfs.pod:1713
3833 "If any progress notification is sent during a call, then a final progress "
3834 "notification is always sent when C<position> = C<total>."
3839 #: ../src/guestfs.pod:1716
3841 "This is to simplify caller code, so callers can easily set the progress "
3842 "indicator to \"100%\" at the end of the operation, without requiring special "
3843 "code to detect this case."
3848 #: ../src/guestfs.pod:1722
3850 "The callback also receives the procedure number and serial number of the "
3851 "call. These are only useful for debugging protocol issues, and the callback "
3852 "can normally ignore them. The callback may want to print these numbers in "
3853 "error messages or debugging messages."
3858 #: ../src/guestfs.pod:1727
3859 msgid "PRIVATE DATA AREA"
3864 #: ../src/guestfs.pod:1729
3866 "You can attach named pieces of private data to the libguestfs handle, and "
3867 "fetch them by name for the lifetime of the handle. This is called the "
3868 "private data area and is only available from the C API."
3873 #: ../src/guestfs.pod:1733
3874 msgid "To attach a named piece of data, use the following call:"
3879 #: ../src/guestfs.pod:1735
3882 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3888 #: ../src/guestfs.pod:1737
3890 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3891 "pointer (which can be C<NULL>). Any previous item with the same name is "
3897 #: ../src/guestfs.pod:1741
3899 "You can use any C<key> you want, but names beginning with an underscore "
3900 "character are reserved for internal libguestfs purposes (for implementing "
3901 "language bindings). It is recommended to prefix the name with some unique "
3902 "string to avoid collisions with other users."
3907 #: ../src/guestfs.pod:1746
3908 msgid "To retrieve the pointer, use:"
3913 #: ../src/guestfs.pod:1748
3916 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3922 #: ../src/guestfs.pod:1750
3924 "This function returns C<NULL> if either no data is found associated with "
3925 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3931 #: ../src/guestfs.pod:1754
3933 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3934 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3935 "all. In particular, libguestfs does I<not> try to free the data when the "
3936 "handle is closed. If the data must be freed, then the caller must either "
3937 "free it before calling L</guestfs_close> or must set up a close callback to "
3938 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3939 "can be registered for a handle)."
3944 #: ../src/guestfs.pod:1762
3946 "The private data area is implemented using a hash table, and should be "
3947 "reasonably efficient for moderate numbers of keys."
3952 #: ../src/guestfs.pod:1765 ../src/guestfs.pod:1770
3958 #: ../src/guestfs.pod:1767
3960 "<!-- old anchor for the next section --> <a name="
3961 "\"state_machine_and_low_level_event_api\"/>"
3966 #: ../src/guestfs.pod:1772
3967 msgid "ARCHITECTURE"
3972 #: ../src/guestfs.pod:1774
3974 "Internally, libguestfs is implemented by running an appliance (a special "
3975 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3976 "process of the main program."
3981 #: ../src/guestfs.pod:1778
3984 " ___________________\n"
3986 " | main program |\n"
3988 " | | child process / appliance\n"
3989 " | | __________________________\n"
3991 " +-------------------+ RPC | +-----------------+ |\n"
3992 " | libguestfs <--------------------> guestfsd | |\n"
3993 " | | | +-----------------+ |\n"
3994 " \\___________________/ | | Linux kernel | |\n"
3995 " | +--^--------------+ |\n"
3996 " \\_________|________________/\n"
4002 " \\______________/\n"
4008 #: ../src/guestfs.pod:1798
4010 "The library, linked to the main program, creates the child process and hence "
4011 "the appliance in the L</guestfs_launch> function."
4016 #: ../src/guestfs.pod:1801
4018 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4019 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4020 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4021 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4022 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4023 "attached to the qemu process which translates device access by the "
4024 "appliance's Linux kernel into accesses to the image."
4029 #: ../src/guestfs.pod:1810
4031 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4032 "Although the disk image you are attached to might also be used by some "
4033 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4034 "care if both libguestfs's qemu process and your virtual machine are trying "
4035 "to update the disk image at the same time, since these usually results in "
4036 "massive disk corruption)."
4041 #: ../src/guestfs.pod:1817
4042 msgid "STATE MACHINE"
4047 #: ../src/guestfs.pod:1819
4048 msgid "libguestfs uses a state machine to model the child process:"
4053 #: ../src/guestfs.pod:1821
4065 " / | \\ \\ guestfs_launch\n"
4066 " / | _\\__V______\n"
4068 " / | | LAUNCHING |\n"
4069 " / | \\___________/\n"
4071 " / | guestfs_launch\n"
4073 " ______ / __|____V\n"
4074 " / \\ ------> / \\\n"
4075 " | BUSY | | READY |\n"
4076 " \\______/ <------ \\________/\n"
4082 #: ../src/guestfs.pod:1843
4084 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4085 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4086 "(3) alternating between READY and BUSY as commands are issued to, and "
4087 "carried out by, the child process."
4092 #: ../src/guestfs.pod:1848
4094 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4095 "asynchronously at any time (eg. due to some internal error), and that causes "
4096 "the state to transition back to CONFIG."
4101 #: ../src/guestfs.pod:1852
4103 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4104 "issued when in the CONFIG state."
4109 #: ../src/guestfs.pod:1855
4111 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4112 "L</guestfs_launch> blocks until the child process is READY to accept "
4113 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4114 "moves the state from CONFIG to LAUNCHING while it is running."
4119 #: ../src/guestfs.pod:1861
4121 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4122 "state. These API calls block waiting for the command to be carried out (ie. "
4123 "the state to transition to BUSY and then back to READY). There are no non-"
4124 "blocking versions, and no way to issue more than one command per handle at "
4130 #: ../src/guestfs.pod:1867
4132 "Finally, the child process sends asynchronous messages back to the main "
4133 "program, such as kernel log messages. You can register a callback to "
4134 "receive these messages."
4139 #: ../src/guestfs.pod:1871
4145 #: ../src/guestfs.pod:1873
4146 msgid "COMMUNICATION PROTOCOL"
4151 #: ../src/guestfs.pod:1875
4153 "Don't rely on using this protocol directly. This section documents how it "
4154 "currently works, but it may change at any time."
4159 #: ../src/guestfs.pod:1878
4161 "The protocol used to talk between the library and the daemon running inside "
4162 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4163 "1014, RFC 1832, RFC 4506)."
4168 #: ../src/guestfs.pod:1882
4170 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4171 "this file is automatically generated)."
4176 #: ../src/guestfs.pod:1885
4178 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4179 "and C<FileOut> parameters, which are handled with very simple request/reply "
4180 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4181 "parameters, which use the same request and reply messages, but they may also "
4182 "be followed by files sent using a chunked encoding."
4187 #: ../src/guestfs.pod:1892
4188 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4193 #: ../src/guestfs.pod:1894
4194 msgid "For ordinary functions, the request message is:"
4199 #: ../src/guestfs.pod:1896
4202 " total length (header + arguments,\n"
4203 " but not including the length word itself)\n"
4204 " struct guestfs_message_header (encoded as XDR)\n"
4205 " struct guestfs_<foo>_args (encoded as XDR)\n"
4211 #: ../src/guestfs.pod:1901
4213 "The total length field allows the daemon to allocate a fixed size buffer "
4214 "into which it slurps the rest of the message. As a result, the total length "
4215 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4216 "effective size of any request is limited to somewhere under this size."
4221 #: ../src/guestfs.pod:1907
4223 "Note also that many functions don't take any arguments, in which case the "
4224 "C<guestfs_I<foo>_args> is completely omitted."
4229 #: ../src/guestfs.pod:1910
4231 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4232 "receiver knows what type of args structure to expect, or none at all."
4237 #: ../src/guestfs.pod:1914
4239 "For functions that take optional arguments, the optional arguments are "
4240 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4241 "arguments. A bitmask in the header indicates which optional arguments are "
4242 "meaningful. The bitmask is also checked to see if it contains bits set "
4243 "which the daemon does not know about (eg. if more optional arguments were "
4244 "added in a later version of the library), and this causes the call to be "
4250 #: ../src/guestfs.pod:1922
4251 msgid "The reply message for ordinary functions is:"
4256 #: ../src/guestfs.pod:1924
4259 " total length (header + ret,\n"
4260 " but not including the length word itself)\n"
4261 " struct guestfs_message_header (encoded as XDR)\n"
4262 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4268 #: ../src/guestfs.pod:1929
4270 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4271 "functions that return no formal return values."
4276 #: ../src/guestfs.pod:1932
4278 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4283 #: ../src/guestfs.pod:1935
4285 "In the case of an error, a flag is set in the header, and the reply message "
4286 "is slightly changed:"
4291 #: ../src/guestfs.pod:1938
4294 " total length (header + error,\n"
4295 " but not including the length word itself)\n"
4296 " struct guestfs_message_header (encoded as XDR)\n"
4297 " struct guestfs_message_error (encoded as XDR)\n"
4303 #: ../src/guestfs.pod:1943
4305 "The C<guestfs_message_error> structure contains the error message as a "
4311 #: ../src/guestfs.pod:1946
4312 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4317 #: ../src/guestfs.pod:1948
4319 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4320 "The normal request message is sent (see above). However this is followed by "
4321 "a sequence of file chunks."
4326 #: ../src/guestfs.pod:1952
4329 " total length (header + arguments,\n"
4330 " but not including the length word itself,\n"
4331 " and not including the chunks)\n"
4332 " struct guestfs_message_header (encoded as XDR)\n"
4333 " struct guestfs_<foo>_args (encoded as XDR)\n"
4334 " sequence of chunks for FileIn param #0\n"
4335 " sequence of chunks for FileIn param #1 etc.\n"
4341 #: ../src/guestfs.pod:1960
4342 msgid "The \"sequence of chunks\" is:"
4347 #: ../src/guestfs.pod:1962
4350 " length of chunk (not including length word itself)\n"
4351 " struct guestfs_chunk (encoded as XDR)\n"
4352 " length of chunk\n"
4353 " struct guestfs_chunk (encoded as XDR)\n"
4355 " length of chunk\n"
4356 " struct guestfs_chunk (with data.data_len == 0)\n"
4362 #: ../src/guestfs.pod:1970
4364 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4365 "is set in the final chunk to indicate either successful completion or early "
4371 #: ../src/guestfs.pod:1974
4373 "At time of writing there are no functions that have more than one FileIn "
4374 "parameter. However this is (theoretically) supported, by sending the "
4375 "sequence of chunks for each FileIn parameter one after another (from left to "
4381 #: ../src/guestfs.pod:1979
4383 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4384 "transfer. The library does this by sending a chunk with a special flag set "
4385 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4386 "RPC, does I<not> send any reply, and goes back to reading the next request."
4391 #: ../src/guestfs.pod:1985
4393 "The daemon may also cancel. It does this by writing a special word "
4394 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4395 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4396 "cancel chunk). The special word is chosen so that even if cancellation "
4397 "happens right at the end of the transfer (after the library has finished "
4398 "writing and has started listening for the reply), the \"spurious\" cancel "
4399 "flag will not be confused with the reply message."
4404 #: ../src/guestfs.pod:1994
4406 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4407 "limit), and also files where the size is not known in advance (eg. from "
4408 "pipes or sockets). However the chunks are rather small "
4409 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4410 "to keep much in memory."
4415 #: ../src/guestfs.pod:2000
4416 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4421 #: ../src/guestfs.pod:2002
4423 "The protocol for FileOut parameters is exactly the same as for FileIn "
4424 "parameters, but with the roles of daemon and library reversed."
4429 #: ../src/guestfs.pod:2005
4432 " total length (header + ret,\n"
4433 " but not including the length word itself,\n"
4434 " and not including the chunks)\n"
4435 " struct guestfs_message_header (encoded as XDR)\n"
4436 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4437 " sequence of chunks for FileOut param #0\n"
4438 " sequence of chunks for FileOut param #1 etc.\n"
4444 #: ../src/guestfs.pod:2013
4445 msgid "INITIAL MESSAGE"
4450 #: ../src/guestfs.pod:2015
4452 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4453 "which indicates that the guest and daemon is alive. This is what L</"
4454 "guestfs_launch> waits for."
4459 #: ../src/guestfs.pod:2019
4460 msgid "PROGRESS NOTIFICATION MESSAGES"
4465 #: ../src/guestfs.pod:2021
4467 "The daemon may send progress notification messages at any time. These are "
4468 "distinguished by the normal length word being replaced by "
4469 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4474 #: ../src/guestfs.pod:2025
4476 "The library turns them into progress callbacks (see "
4477 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
4478 "discards them if not."
4483 #: ../src/guestfs.pod:2029
4485 "The daemon self-limits the frequency of progress messages it sends (see "
4486 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4492 #: ../src/guestfs.pod:2033
4493 msgid "LIBGUESTFS VERSION NUMBERS"
4498 #: ../src/guestfs.pod:2035
4500 "Since April 2010, libguestfs has started to make separate development and "
4501 "stable releases, along with corresponding branches in our git repository. "
4502 "These separate releases can be identified by version number:"
4507 #: ../src/guestfs.pod:2040
4510 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4511 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4517 " | `-------- sub-version\n"
4519 " `------ always '1' because we don't change the ABI\n"
4525 #: ../src/guestfs.pod:2051
4526 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4531 #: ../src/guestfs.pod:2053
4533 "As time passes we cherry pick fixes from the development branch and backport "
4534 "those into the stable branch, the effect being that the stable branch should "
4535 "get more stable and less buggy over time. So the stable releases are ideal "
4536 "for people who don't need new features but would just like the software to "
4542 #: ../src/guestfs.pod:2059
4543 msgid "Our criteria for backporting changes are:"
4548 #: ../src/guestfs.pod:2065
4550 "Documentation changes which don't affect any code are backported unless the "
4551 "documentation refers to a future feature which is not in stable."
4556 #: ../src/guestfs.pod:2071
4558 "Bug fixes which are not controversial, fix obvious problems, and have been "
4559 "well tested are backported."
4564 #: ../src/guestfs.pod:2076
4566 "Simple rearrangements of code which shouldn't affect how it works get "
4567 "backported. This is so that the code in the two branches doesn't get too "
4568 "far out of step, allowing us to backport future fixes more easily."
4573 #: ../src/guestfs.pod:2082
4575 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4576 "exceptional case: the new feature is required in order to implement an "
4577 "important bug fix."
4582 #: ../src/guestfs.pod:2088
4584 "A new stable branch starts when we think the new features in development are "
4585 "substantial and compelling enough over the current stable branch to warrant "
4586 "it. When that happens we create new stable and development versions 1.N.0 "
4587 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4588 "stable at this point, but by backporting fixes from development, that branch "
4589 "will stabilize over time."
4593 #: ../src/guestfs.pod:2096
4594 msgid "EXTENDING LIBGUESTFS"
4598 #: ../src/guestfs.pod:2098
4599 msgid "ADDING A NEW API ACTION"
4603 #: ../src/guestfs.pod:2100
4605 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4606 "documentation) are generated, and this makes it easy to extend the "
4611 #: ../src/guestfs.pod:2104
4612 msgid "To add a new API action there are two changes:"
4616 #: ../src/guestfs.pod:2110
4618 "You need to add a description of the call (name, parameters, return type, "
4619 "tests, documentation) to C<generator/generator_actions.ml>."
4623 #: ../src/guestfs.pod:2113
4625 "There are two sorts of API action, depending on whether the call goes "
4626 "through to the daemon in the appliance, or is serviced entirely by the "
4627 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4628 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4629 "an example of the latter, since a trace flag is maintained in the handle and "
4630 "all tracing is done on the library side."
4634 #: ../src/guestfs.pod:2121
4636 "Most new actions are of the first type, and get added to the "
4637 "C<daemon_functions> list. Each function has a unique procedure number used "
4638 "in the RPC protocol which is assigned to that action when we publish "
4639 "libguestfs and cannot be reused. Take the latest procedure number and "
4644 #: ../src/guestfs.pod:2127
4646 "For library-only actions of the second type, add to the "
4647 "C<non_daemon_functions> list. Since these functions are serviced by the "
4648 "library and do not travel over the RPC mechanism to the daemon, these "
4649 "functions do not need a procedure number, and so the procedure number is set "
4654 #: ../src/guestfs.pod:2135
4655 msgid "Implement the action (in C):"
4659 #: ../src/guestfs.pod:2137
4661 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4662 "C<daemon/> directory."
4666 #: ../src/guestfs.pod:2140
4668 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4669 "(note: double underscore) in the C<src/> directory."
4673 #: ../src/guestfs.pod:2143
4674 msgid "In either case, use another function as an example of what to do."
4678 #: ../src/guestfs.pod:2147
4679 msgid "After making these changes, use C<make> to compile."
4683 #: ../src/guestfs.pod:2149
4685 "Note that you don't need to implement the RPC, language bindings, manual "
4686 "pages or anything else. It's all automatically generated from the OCaml "
4691 #: ../src/guestfs.pod:2153
4692 msgid "ADDING TESTS FOR AN API ACTION"
4696 #: ../src/guestfs.pod:2155
4698 "You can supply zero or as many tests as you want per API call. The tests "
4699 "can either be added as part of the API description (C<generator/"
4700 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4701 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4702 "slower, so if possible use the first method."
4706 #: ../src/guestfs.pod:2161
4708 "The following describes the test environment used when you add an API test "
4709 "in C<generator_actions.ml>."
4713 #: ../src/guestfs.pod:2164
4714 msgid "The test environment has 4 block devices:"
4718 #: ../src/guestfs.pod:2168
4719 msgid "C</dev/sda> 500MB"
4723 #: ../src/guestfs.pod:2170
4724 msgid "General block device for testing."
4728 #: ../src/guestfs.pod:2172
4729 msgid "C</dev/sdb> 50MB"
4733 #: ../src/guestfs.pod:2174
4735 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4740 #: ../src/guestfs.pod:2177
4741 msgid "C</dev/sdc> 10MB"
4745 #: ../src/guestfs.pod:2179
4746 msgid "Used in a few tests where two block devices are needed."
4750 #: ../src/guestfs.pod:2181
4755 #: ../src/guestfs.pod:2183
4756 msgid "ISO with fixed content (see C<images/test.iso>)."
4760 #: ../src/guestfs.pod:2187
4762 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4763 "appliance and block devices are reused between tests. So don't try testing "
4764 "L</guestfs_kill_subprocess> :-x"
4768 #: ../src/guestfs.pod:2191
4770 "Each test starts with an initial scenario, selected using one of the "
4771 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4772 "initialize the disks mentioned above in a particular way as documented in "
4773 "C<generator_types.ml>. You should not assume anything about the previous "
4774 "contents of other disks that are not initialized."
4778 #: ../src/guestfs.pod:2197
4780 "You can add a prerequisite clause to any individual test. This is a run-"
4781 "time check, which, if it fails, causes the test to be skipped. Useful if "
4782 "testing a command which might not work on all variations of libguestfs "
4783 "builds. A test that has prerequisite of C<Always> means to run "
4788 #: ../src/guestfs.pod:2203
4790 "In addition, packagers can skip individual tests by setting environment "
4791 "variables before running C<make check>."
4795 #: ../src/guestfs.pod:2206
4798 " SKIP_TEST_<CMD>_<NUM>=1\n"
4803 #: ../src/guestfs.pod:2208
4804 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4808 #: ../src/guestfs.pod:2210
4813 #: ../src/guestfs.pod:2212
4816 " SKIP_TEST_<CMD>=1\n"
4821 #: ../src/guestfs.pod:2214
4822 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4826 #: ../src/guestfs.pod:2216
4827 msgid "Packagers can run only certain tests by setting for example:"
4831 #: ../src/guestfs.pod:2218
4834 " TEST_ONLY=\"vfs_type zerofree\"\n"
4839 #: ../src/guestfs.pod:2220
4841 "See C<capitests/tests.c> for more details of how these environment variables "
4846 #: ../src/guestfs.pod:2223
4847 msgid "DEBUGGING NEW API ACTIONS"
4851 #: ../src/guestfs.pod:2225
4852 msgid "Test new actions work before submitting them."
4856 #: ../src/guestfs.pod:2227
4857 msgid "You can use guestfish to try out new commands."
4861 #: ../src/guestfs.pod:2229
4863 "Debugging the daemon is a problem because it runs inside a minimal "
4864 "environment. However you can fprintf messages in the daemon to stderr, and "
4865 "they will show up if you use C<guestfish -v>."
4869 #: ../src/guestfs.pod:2233
4870 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4874 #: ../src/guestfs.pod:2235
4876 "Our C source code generally adheres to some basic code-formatting "
4877 "conventions. The existing code base is not totally consistent on this "
4878 "front, but we do prefer that contributed code be formatted similarly. In "
4879 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4880 "indentation level, and other than that, follow the K&R style."
4884 #: ../src/guestfs.pod:2241
4886 "If you use Emacs, add the following to one of one of your start-up files (e."
4887 "g., ~/.emacs), to help ensure that you get indentation right:"
4891 #: ../src/guestfs.pod:2244
4894 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4895 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4896 " (add-hook 'find-file-hook\n"
4897 " '(lambda () (if (and buffer-file-name\n"
4898 " (string-match \"/libguestfs\\\\>\"\n"
4899 " (buffer-file-name))\n"
4900 " (not (string-equal mode-name \"Change Log\"))\n"
4901 " (not (string-equal mode-name \"Makefile\")))\n"
4902 " (setq indent-tabs-mode nil))))\n"
4907 #: ../src/guestfs.pod:2254
4910 " ;;; When editing C sources in libguestfs, use this style.\n"
4911 " (defun libguestfs-c-mode ()\n"
4912 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4914 " (c-set-style \"K&R\")\n"
4915 " (setq c-indent-level 2)\n"
4916 " (setq c-basic-offset 2))\n"
4917 " (add-hook 'c-mode-hook\n"
4918 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4919 " (buffer-file-name))\n"
4920 " (libguestfs-c-mode))))\n"
4925 #: ../src/guestfs.pod:2266
4926 msgid "Enable warnings when compiling (and fix any problems this finds):"
4930 #: ../src/guestfs.pod:2269
4933 " ./configure --enable-gcc-warnings\n"
4938 #: ../src/guestfs.pod:2271
4939 msgid "Useful targets are:"
4943 #: ../src/guestfs.pod:2273
4946 " make syntax-check # checks the syntax of the C code\n"
4947 " make check # runs the test suite\n"
4952 #: ../src/guestfs.pod:2276
4953 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4957 #: ../src/guestfs.pod:2278
4959 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4960 "which are used to do shell quoting."
4964 #: ../src/guestfs.pod:2283
4969 #: ../src/guestfs.pod:2285
4971 "Simple shell quoted string. Any spaces or other shell characters are "
4976 #: ../src/guestfs.pod:2288
4981 #: ../src/guestfs.pod:2290
4983 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4989 #: ../src/guestfs.pod:2295 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4990 msgid "For example:"
4994 #: ../src/guestfs.pod:2297
4997 " asprintf (&cmd, \"cat %R\", path);\n"
5002 #: ../src/guestfs.pod:2299
5003 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5007 #: ../src/guestfs.pod:2301
5009 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5010 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5011 "they are not passed via the shell (instead, straight to exec). You probably "
5012 "want to use the C<sysroot_path()> function however."
5016 #: ../src/guestfs.pod:2307
5017 msgid "SUBMITTING YOUR NEW API ACTIONS"
5021 #: ../src/guestfs.pod:2309
5023 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5024 "libguestfs> and CC to L<rjones@redhat.com>."
5028 #: ../src/guestfs.pod:2313
5029 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5033 #: ../src/guestfs.pod:2315
5034 msgid "We support i18n (gettext anyhow) in the library."
5038 #: ../src/guestfs.pod:2317
5040 "However many messages come from the daemon, and we don't translate those at "
5041 "the moment. One reason is that the appliance generally has all locale files "
5042 "removed from it, because they take up a lot of space. So we'd have to readd "
5043 "some of those, as well as copying our PO files into the appliance."
5047 #: ../src/guestfs.pod:2323
5049 "Debugging messages are never translated, since they are intended for the "
5054 #: ../src/guestfs.pod:2326
5055 msgid "SOURCE CODE SUBDIRECTORIES"
5059 #: ../src/guestfs.pod:2330
5060 msgid "C<appliance>"
5064 #: ../src/guestfs.pod:2332
5065 msgid "The libguestfs appliance, build scripts and so on."
5069 #: ../src/guestfs.pod:2334
5070 msgid "C<capitests>"
5074 #: ../src/guestfs.pod:2336
5075 msgid "Automated tests of the C API."
5079 #: ../src/guestfs.pod:2338
5084 #: ../src/guestfs.pod:2340
5086 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5091 #: ../src/guestfs.pod:2343
5096 #: ../src/guestfs.pod:2345
5097 msgid "Outside contributions, experimental parts."
5101 #: ../src/guestfs.pod:2347
5106 #: ../src/guestfs.pod:2349
5108 "The daemon that runs inside the libguestfs appliance and carries out actions."
5112 #: ../src/guestfs.pod:2352
5117 #: ../src/guestfs.pod:2354
5118 msgid "L<virt-df(1)> command and documentation."
5122 #: ../src/guestfs.pod:2356
5127 #: ../src/guestfs.pod:2358
5128 msgid "C API example code."
5132 #: ../src/guestfs.pod:2360
5137 #: ../src/guestfs.pod:2362
5138 msgid "L<guestfish(1)>, the command-line shell."
5142 #: ../src/guestfs.pod:2364
5147 #: ../src/guestfs.pod:2366
5149 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5153 #: ../src/guestfs.pod:2368
5154 msgid "C<generator>"
5158 #: ../src/guestfs.pod:2370
5160 "The crucially important generator, used to automatically generate large "
5161 "amounts of boilerplate C code for things like RPC and bindings."
5165 #: ../src/guestfs.pod:2373
5170 #: ../src/guestfs.pod:2375
5171 msgid "Files used by the test suite."
5175 #: ../src/guestfs.pod:2377
5176 msgid "Some \"phony\" guest images which we test against."
5180 #: ../src/guestfs.pod:2379
5181 msgid "C<inspector>"
5185 #: ../src/guestfs.pod:2381
5186 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5190 #: ../src/guestfs.pod:2383
5195 #: ../src/guestfs.pod:2385
5196 msgid "M4 macros used by autoconf."
5200 #: ../src/guestfs.pod:2387
5205 #: ../src/guestfs.pod:2389
5206 msgid "Translations of simple gettext strings."
5210 #: ../src/guestfs.pod:2391
5215 #: ../src/guestfs.pod:2393
5217 "The build infrastructure and PO files for translations of manpages and POD "
5218 "files. Eventually this will be combined with the C<po> directory, but that "
5219 "is rather complicated."
5223 #: ../src/guestfs.pod:2397
5224 msgid "C<regressions>"
5228 #: ../src/guestfs.pod:2399
5229 msgid "Regression tests."
5233 #: ../src/guestfs.pod:2401
5238 #: ../src/guestfs.pod:2403
5239 msgid "L<virt-rescue(1)> command and documentation."
5243 #: ../src/guestfs.pod:2405
5248 #: ../src/guestfs.pod:2407
5249 msgid "Source code to the C library."
5253 #: ../src/guestfs.pod:2409
5258 #: ../src/guestfs.pod:2411
5259 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5263 #: ../src/guestfs.pod:2413
5264 msgid "C<test-tool>"
5268 #: ../src/guestfs.pod:2415
5270 "Test tool for end users to test if their qemu/kernel combination will work "
5275 #: ../src/guestfs.pod:2418
5280 #: ../src/guestfs.pod:2420
5285 #: ../src/guestfs.pod:2422
5290 #: ../src/guestfs.pod:2424
5295 #: ../src/guestfs.pod:2426
5300 #: ../src/guestfs.pod:2428
5305 #: ../src/guestfs.pod:2430
5310 #: ../src/guestfs.pod:2432
5315 #: ../src/guestfs.pod:2434
5316 msgid "Language bindings."
5321 #: ../src/guestfs.pod:2438 ../fish/guestfish.pod:965
5322 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5323 msgid "ENVIRONMENT VARIABLES"
5328 #: ../src/guestfs.pod:2442 ../fish/guestfish.pod:991
5329 msgid "LIBGUESTFS_APPEND"
5334 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:993
5335 msgid "Pass additional options to the guest kernel."
5340 #: ../src/guestfs.pod:2446 ../fish/guestfish.pod:995
5341 msgid "LIBGUESTFS_DEBUG"
5346 #: ../src/guestfs.pod:2448
5348 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5349 "effect as calling C<guestfs_set_verbose (g, 1)>."
5354 #: ../src/guestfs.pod:2451 ../fish/guestfish.pod:1000
5355 msgid "LIBGUESTFS_MEMSIZE"
5360 #: ../src/guestfs.pod:2453 ../fish/guestfish.pod:1002
5362 "Set the memory allocated to the qemu process, in megabytes. For example:"
5367 #: ../src/guestfs.pod:2456 ../fish/guestfish.pod:1005
5370 " LIBGUESTFS_MEMSIZE=700\n"
5376 #: ../src/guestfs.pod:2458 ../fish/guestfish.pod:1007
5377 msgid "LIBGUESTFS_PATH"
5381 #: ../src/guestfs.pod:2460
5383 "Set the path that libguestfs uses to search for a supermin appliance. See "
5384 "the discussion of paths in section L</PATH> above."
5389 #: ../src/guestfs.pod:2463 ../fish/guestfish.pod:1012
5390 msgid "LIBGUESTFS_QEMU"
5395 #: ../src/guestfs.pod:2465 ../fish/guestfish.pod:1014
5397 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5398 "which was found at compile time by the configure script is used."
5403 #: ../src/guestfs.pod:2469
5404 msgid "See also L</QEMU WRAPPERS> above."
5409 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1018
5410 msgid "LIBGUESTFS_TRACE"
5415 #: ../src/guestfs.pod:2473
5417 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5418 "effect as calling C<guestfs_set_trace (g, 1)>."
5423 #: ../src/guestfs.pod:2476 ../fish/guestfish.pod:1027
5429 #: ../src/guestfs.pod:2478 ../fish/guestfish.pod:1029
5430 msgid "Location of temporary directory, defaults to C</tmp>."
5435 #: ../src/guestfs.pod:2480 ../fish/guestfish.pod:1031
5437 "If libguestfs was compiled to use the supermin appliance then the real "
5438 "appliance is cached in this directory, shared between all handles belonging "
5439 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5440 "use in case C</tmp> is not large enough."
5445 #: ../src/guestfs.pod:2488 ../fish/guestfish.pod:1089
5446 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
5447 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572
5448 #: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189
5449 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:539
5450 #: ../tools/virt-list-partitions.pl:257
5456 #: ../src/guestfs.pod:2490
5458 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5459 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
5460 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
5461 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
5462 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
5463 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5468 #: ../src/guestfs.pod:2513
5470 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5471 "(8)>, L<disktype(1)>."
5476 #: ../src/guestfs.pod:2520 ../tools/virt-win-reg.pl:587
5477 #: ../tools/virt-make-fs.pl:553
5483 #: ../src/guestfs.pod:2522
5484 msgid "To get a list of bugs against libguestfs use this link:"
5489 #: ../src/guestfs.pod:2524
5491 "L<https://bugzilla.redhat.com/buglist.cgi?"
5492 "component=libguestfs&product=Virtualization+Tools>"
5497 #: ../src/guestfs.pod:2526
5498 msgid "To report a new bug against libguestfs use this link:"
5503 #: ../src/guestfs.pod:2528
5505 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5506 "component=libguestfs&product=Virtualization+Tools>"
5511 #: ../src/guestfs.pod:2530
5512 msgid "When reporting a bug, please check:"
5517 #: ../src/guestfs.pod:2536
5518 msgid "That the bug hasn't been reported already."
5523 #: ../src/guestfs.pod:2540
5524 msgid "That you are testing a recent version."
5529 #: ../src/guestfs.pod:2544
5530 msgid "Describe the bug accurately, and give a way to reproduce it."
5535 #: ../src/guestfs.pod:2548
5537 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5543 #: ../src/guestfs.pod:2553 ../fish/guestfish.pod:1108
5544 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
5550 #: ../src/guestfs.pod:2555 ../fish/guestfish.pod:1110
5551 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
5552 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5557 #: ../src/guestfs.pod:2557 ../fish/guestfish.pod:1112
5558 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
5559 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:602
5560 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206
5561 #: ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:568
5562 #: ../tools/virt-list-partitions.pl:273
5568 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1114
5569 #: ../fuse/guestmount.pod:250
5570 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
5575 #: ../src/guestfs.pod:2562
5577 "This library is free software; you can redistribute it and/or modify it "
5578 "under the terms of the GNU Lesser General Public License as published by the "
5579 "Free Software Foundation; either version 2 of the License, or (at your "
5580 "option) any later version."
5585 #: ../src/guestfs.pod:2567
5587 "This library is distributed in the hope that it will be useful, but WITHOUT "
5588 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5589 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5595 #: ../src/guestfs.pod:2572
5597 "You should have received a copy of the GNU Lesser General Public License "
5598 "along with this library; if not, write to the Free Software Foundation, "
5599 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5604 #: ../src/guestfs-actions.pod:1
5605 msgid "guestfs_add_cdrom"
5610 #: ../src/guestfs-actions.pod:3
5614 " guestfs_add_cdrom (guestfs_h *g,\n"
5615 " const char *filename);\n"
5621 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5622 msgid "This function adds a virtual CD-ROM disk image to the guest."
5627 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5628 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5633 #: ../src/guestfs-actions.pod:17
5635 "This call checks for the existence of C<filename>. This stops you from "
5636 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5637 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5643 #: ../src/guestfs-actions.pod:24
5645 "If you just want to add an ISO file (often you use this as an efficient way "
5646 "to transfer large files into the guest), then you should probably use "
5647 "C<guestfs_add_drive_ro> instead."
5652 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
5653 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
5654 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
5655 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
5656 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
5657 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
5658 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
5659 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
5660 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
5661 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
5662 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
5663 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
5664 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
5665 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
5666 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
5667 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
5668 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
5669 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
5670 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
5671 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2243
5672 #: ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448
5673 #: ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3226
5674 #: ../src/guestfs-actions.pod:3241 ../src/guestfs-actions.pod:3261
5675 #: ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3430
5676 #: ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3457
5677 #: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3508
5678 #: ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3600
5679 #: ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3640
5680 #: ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3695
5681 #: ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3733
5682 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3780
5683 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3832
5684 #: ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3860
5685 #: ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3970
5686 #: ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4003
5687 #: ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4072
5688 #: ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4106
5689 #: ../src/guestfs-actions.pod:4120 ../src/guestfs-actions.pod:4134
5690 #: ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:4166
5691 #: ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4232
5692 #: ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4336
5693 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4374
5694 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4403
5695 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4431
5696 #: ../src/guestfs-actions.pod:4446 ../src/guestfs-actions.pod:4481
5697 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4516
5698 #: ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4547
5699 #: ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4633
5700 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4675
5701 #: ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4710
5702 #: ../src/guestfs-actions.pod:4844 ../src/guestfs-actions.pod:4901
5703 #: ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:4941
5704 #: ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:5039
5705 #: ../src/guestfs-actions.pod:5056 ../src/guestfs-actions.pod:5069
5706 #: ../src/guestfs-actions.pod:5083 ../src/guestfs-actions.pod:5372
5707 #: ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5405
5708 #: ../src/guestfs-actions.pod:5417 ../src/guestfs-actions.pod:5431
5709 #: ../src/guestfs-actions.pod:5443 ../src/guestfs-actions.pod:5457
5710 #: ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:5494
5711 #: ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5532
5712 #: ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5573
5713 #: ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5610
5714 #: ../src/guestfs-actions.pod:5631 ../src/guestfs-actions.pod:5650
5715 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5695
5716 #: ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:5738
5717 #: ../src/guestfs-actions.pod:5762 ../src/guestfs-actions.pod:5777
5718 #: ../src/guestfs-actions.pod:5792 ../src/guestfs-actions.pod:5811
5719 #: ../src/guestfs-actions.pod:5848 ../src/guestfs-actions.pod:5871
5720 #: ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6005
5721 #: ../src/guestfs-actions.pod:6126 ../src/guestfs-actions.pod:6138
5722 #: ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6164
5723 #: ../src/guestfs-actions.pod:6186 ../src/guestfs-actions.pod:6199
5724 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6225
5725 #: ../src/guestfs-actions.pod:6240 ../src/guestfs-actions.pod:6299
5726 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6332
5727 #: ../src/guestfs-actions.pod:6348 ../src/guestfs-actions.pod:6365
5728 #: ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6398
5729 #: ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6448
5730 #: ../src/guestfs-actions.pod:6489 ../src/guestfs-actions.pod:6502
5731 #: ../src/guestfs-actions.pod:6520 ../src/guestfs-actions.pod:6554
5732 #: ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6709
5733 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741
5734 #: ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6809
5735 #: ../src/guestfs-actions.pod:6854 ../src/guestfs-actions.pod:6887
5736 #: ../src/guestfs-actions.pod:6941 ../src/guestfs-actions.pod:6967
5737 #: ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7052
5738 #: ../src/guestfs-actions.pod:7081
5739 msgid "This function returns 0 on success or -1 on error."
5744 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
5745 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
5746 #: ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
5748 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5754 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
5755 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
5756 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
5757 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:6975
5758 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:31
5759 #: ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168
5760 #: ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1306
5761 #: ../fish/guestfish-actions.pod:1320 ../fish/guestfish-actions.pod:2820
5762 #: ../fish/guestfish-actions.pod:4624 ../fish/guestfish-actions.pod:4721
5764 "Deprecated functions will not be removed from the API, but the fact that "
5765 "they are deprecated indicates that there are problems with correct use of "
5771 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
5772 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
5773 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
5774 #: ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3243
5775 #: ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:5552
5776 #: ../src/guestfs-actions.pod:5669 ../src/guestfs-actions.pod:5779
5777 #: ../src/guestfs-actions.pod:6242 ../src/guestfs-actions.pod:6367
5778 #: ../src/guestfs-actions.pod:6889
5779 msgid "(Added in 0.3)"
5784 #: ../src/guestfs-actions.pod:41
5785 msgid "guestfs_add_domain"
5790 #: ../src/guestfs-actions.pod:43
5794 " guestfs_add_domain (guestfs_h *g,\n"
5795 " const char *dom,\n"
5802 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
5803 #: ../src/guestfs-actions.pod:4205
5805 "You may supply a list of optional arguments to this call. Use zero or more "
5806 "of the following pairs of parameters, and terminate the list with C<-1> on "
5807 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5812 #: ../src/guestfs-actions.pod:53
5815 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5816 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5817 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5823 #: ../src/guestfs-actions.pod:57
5825 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5826 "It works by connecting to libvirt, requesting the domain and domain XML from "
5827 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5833 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5835 "The number of disks added is returned. This operation is atomic: if an "
5836 "error is returned, then no disks are added."
5841 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5843 "This function does some minimal checks to make sure the libvirt domain is "
5844 "not running (unless C<readonly> is true). In a future version we will try "
5845 "to acquire the libvirt lock on each disk."
5850 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5852 "Disks must be accessible locally. This often means that adding disks from a "
5853 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5854 "unless those disks are accessible via the same device path locally too."
5858 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5860 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5861 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5862 "libvirt URI (or one set through an environment variable, see the libvirt "
5863 "documentation for full details)."
5868 #: ../src/guestfs-actions.pod:80
5870 "The other optional parameters are passed directly through to "
5871 "C<guestfs_add_drive_opts>."
5876 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336
5877 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
5878 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
5879 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
5880 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
5881 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
5882 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
5883 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662
5884 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4619
5885 #: ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:5153
5886 #: ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:6475
5887 #: ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6913
5888 #: ../src/guestfs-actions.pod:6926
5889 msgid "On error this function returns -1."
5894 #: ../src/guestfs-actions.pod:85
5895 msgid "(Added in 1.7.4)"
5900 #: ../src/guestfs-actions.pod:87
5901 msgid "guestfs_add_domain_va"
5906 #: ../src/guestfs-actions.pod:89
5910 " guestfs_add_domain_va (guestfs_h *g,\n"
5911 " const char *dom,\n"
5918 #: ../src/guestfs-actions.pod:94
5919 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5924 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
5925 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
5926 #: ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:4258
5927 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5932 #: ../src/guestfs-actions.pod:98
5933 msgid "guestfs_add_domain_argv"
5938 #: ../src/guestfs-actions.pod:100
5942 " guestfs_add_domain_argv (guestfs_h *g,\n"
5943 " const char *dom,\n"
5944 " const struct guestfs_add_domain_argv *optargs);\n"
5950 #: ../src/guestfs-actions.pod:105
5951 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5956 #: ../src/guestfs-actions.pod:109
5957 msgid "guestfs_add_drive"
5962 #: ../src/guestfs-actions.pod:111
5966 " guestfs_add_drive (guestfs_h *g,\n"
5967 " const char *filename);\n"
5973 #: ../src/guestfs-actions.pod:115
5975 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5976 "optional parameters, so the disk is added writable, with the format being "
5977 "detected automatically."
5982 #: ../src/guestfs-actions.pod:119
5984 "Automatic detection of the format opens you up to a potential security hole "
5985 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5986 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5987 "you should think about replacing calls to this function with calls to "
5988 "C<guestfs_add_drive_opts>, and specifying the format."
5993 #: ../src/guestfs-actions.pod:130
5994 msgid "guestfs_add_drive_opts"
5999 #: ../src/guestfs-actions.pod:132
6003 " guestfs_add_drive_opts (guestfs_h *g,\n"
6004 " const char *filename,\n"
6011 #: ../src/guestfs-actions.pod:142
6014 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6015 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6016 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6022 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
6024 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6025 "The first time you call this function, the disk appears as C</dev/sda>, the "
6026 "second time as C</dev/sdb>, and so on."
6031 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
6033 "You don't necessarily need to be root when using libguestfs. However you "
6034 "obviously do need sufficient permissions to access the filename for whatever "
6035 "operations you want to perform (ie. read access if you just want to read the "
6036 "image or write access if you want to modify the image)."
6041 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
6042 msgid "This call checks that C<filename> exists."
6047 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4215
6048 #: ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2831
6049 msgid "The optional arguments are:"
6054 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
6060 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
6062 "If true then the image is treated as read-only. Writes are still allowed, "
6063 "but they are stored in a temporary snapshot overlay which is discarded at "
6064 "the end. The disk that you add is not modified."
6069 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
6075 #: ../src/guestfs-actions.pod:171
6077 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6078 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6079 "Possible formats include C<raw> and C<qcow2>."
6084 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
6086 "Automatic detection of the format opens you up to a potential security hole "
6087 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6088 "RHBZ#642934. Specifying the format closes this security hole."
6093 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
6099 #: ../src/guestfs-actions.pod:182
6101 "This rarely-used option lets you emulate the behaviour of the deprecated "
6102 "C<guestfs_add_drive_with_if> call (q.v.)"
6107 #: ../src/guestfs-actions.pod:189
6108 msgid "(Added in 1.5.23)"
6113 #: ../src/guestfs-actions.pod:191
6114 msgid "guestfs_add_drive_opts_va"
6119 #: ../src/guestfs-actions.pod:193
6123 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6124 " const char *filename,\n"
6131 #: ../src/guestfs-actions.pod:198
6132 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6137 #: ../src/guestfs-actions.pod:202
6138 msgid "guestfs_add_drive_opts_argv"
6143 #: ../src/guestfs-actions.pod:204
6147 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6148 " const char *filename,\n"
6149 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6155 #: ../src/guestfs-actions.pod:209
6156 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6161 #: ../src/guestfs-actions.pod:213
6162 msgid "guestfs_add_drive_ro"
6167 #: ../src/guestfs-actions.pod:215
6171 " guestfs_add_drive_ro (guestfs_h *g,\n"
6172 " const char *filename);\n"
6178 #: ../src/guestfs-actions.pod:219
6180 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6181 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6182 "disk is added read-only, with the format being detected automatically."
6187 #: ../src/guestfs-actions.pod:226
6188 msgid "(Added in 1.0.38)"
6193 #: ../src/guestfs-actions.pod:228
6194 msgid "guestfs_add_drive_ro_with_if"
6199 #: ../src/guestfs-actions.pod:230
6203 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6204 " const char *filename,\n"
6205 " const char *iface);\n"
6211 #: ../src/guestfs-actions.pod:235
6213 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6214 "QEMU interface emulation to use at run time."
6219 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
6220 #: ../src/guestfs-actions.pod:2333
6221 msgid "(Added in 1.0.84)"
6226 #: ../src/guestfs-actions.pod:249
6227 msgid "guestfs_add_drive_with_if"
6232 #: ../src/guestfs-actions.pod:251
6236 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6237 " const char *filename,\n"
6238 " const char *iface);\n"
6244 #: ../src/guestfs-actions.pod:256
6246 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6247 "QEMU interface emulation to use at run time."
6252 #: ../src/guestfs-actions.pod:270
6253 msgid "guestfs_aug_clear"
6258 #: ../src/guestfs-actions.pod:272
6262 " guestfs_aug_clear (guestfs_h *g,\n"
6263 " const char *augpath);\n"
6269 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
6271 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6272 "L<augtool(1)> C<clear> command."
6277 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
6278 msgid "(Added in 1.3.4)"
6283 #: ../src/guestfs-actions.pod:283
6284 msgid "guestfs_aug_close"
6289 #: ../src/guestfs-actions.pod:285
6293 " guestfs_aug_close (guestfs_h *g);\n"
6299 #: ../src/guestfs-actions.pod:288
6301 "Close the current Augeas handle and free up any resources used by it. After "
6302 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6303 "any other Augeas functions."
6308 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
6309 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
6310 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
6311 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
6312 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
6313 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
6314 #: ../src/guestfs-actions.pod:5230
6315 msgid "(Added in 0.7)"
6320 #: ../src/guestfs-actions.pod:297
6321 msgid "guestfs_aug_defnode"
6326 #: ../src/guestfs-actions.pod:299
6329 " struct guestfs_int_bool *\n"
6330 " guestfs_aug_defnode (guestfs_h *g,\n"
6331 " const char *name,\n"
6332 " const char *expr,\n"
6333 " const char *val);\n"
6339 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
6341 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6346 #: ../src/guestfs-actions.pod:308
6348 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6349 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6350 "containing that single node."
6355 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
6357 "On success this returns a pair containing the number of nodes in the "
6358 "nodeset, and a boolean flag if a node was created."
6363 #: ../src/guestfs-actions.pod:316
6365 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6366 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6371 #: ../src/guestfs-actions.pod:322
6372 msgid "guestfs_aug_defvar"
6377 #: ../src/guestfs-actions.pod:324
6381 " guestfs_aug_defvar (guestfs_h *g,\n"
6382 " const char *name,\n"
6383 " const char *expr);\n"
6389 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
6391 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6392 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6397 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
6399 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6400 "evaluates to something which is not a nodeset."
6405 #: ../src/guestfs-actions.pod:340
6406 msgid "guestfs_aug_get"
6411 #: ../src/guestfs-actions.pod:342
6415 " guestfs_aug_get (guestfs_h *g,\n"
6416 " const char *augpath);\n"
6422 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
6424 "Look up the value associated with C<path>. If C<path> matches exactly one "
6425 "node, the C<value> is returned."
6430 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
6431 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
6432 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
6433 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
6434 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
6435 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
6436 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
6437 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
6438 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2298
6439 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586
6440 #: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2748
6441 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2803
6442 #: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2888
6443 #: ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3752
6444 #: ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4032
6445 #: ../src/guestfs-actions.pod:4765 ../src/guestfs-actions.pod:4958
6446 #: ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5306
6447 #: ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5918
6448 #: ../src/guestfs-actions.pod:5934 ../src/guestfs-actions.pod:5951
6449 #: ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6649
6450 #: ../src/guestfs-actions.pod:6668 ../src/guestfs-actions.pod:6686
6451 #: ../src/guestfs-actions.pod:6866 ../src/guestfs-actions.pod:7138
6453 "This function returns a string, or NULL on error. I<The caller must free "
6454 "the returned string after use>."
6459 #: ../src/guestfs-actions.pod:354
6460 msgid "guestfs_aug_init"
6465 #: ../src/guestfs-actions.pod:356
6469 " guestfs_aug_init (guestfs_h *g,\n"
6470 " const char *root,\n"
6477 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
6479 "Create a new Augeas handle for editing configuration files. If there was "
6480 "any previous Augeas handle associated with this guestfs session, then it is "
6486 #: ../src/guestfs-actions.pod:365
6487 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6492 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
6494 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6499 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
6501 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6502 "logical I<or> of the following integers:"
6507 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
6508 msgid "C<AUG_SAVE_BACKUP> = 1"
6513 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
6514 msgid "Keep the original file with a C<.augsave> extension."
6519 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
6520 msgid "C<AUG_SAVE_NEWFILE> = 2"
6525 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
6527 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6528 "original. Overrides C<AUG_SAVE_BACKUP>."
6533 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
6534 msgid "C<AUG_TYPE_CHECK> = 4"
6539 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
6540 msgid "Typecheck lenses (can be expensive)."
6545 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
6546 msgid "C<AUG_NO_STDINC> = 8"
6551 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
6552 msgid "Do not use standard load path for modules."
6557 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
6558 msgid "C<AUG_SAVE_NOOP> = 16"
6563 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
6564 msgid "Make save a no-op, just record what would have been changed."
6569 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
6570 msgid "C<AUG_NO_LOAD> = 32"
6575 #: ../src/guestfs-actions.pod:400
6576 msgid "Do not load the tree in C<guestfs_aug_init>."
6581 #: ../src/guestfs-actions.pod:404
6582 msgid "To close the handle, you can call C<guestfs_aug_close>."
6587 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
6588 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6593 #: ../src/guestfs-actions.pod:412
6594 msgid "guestfs_aug_insert"
6599 #: ../src/guestfs-actions.pod:414
6603 " guestfs_aug_insert (guestfs_h *g,\n"
6604 " const char *augpath,\n"
6605 " const char *label,\n"
6612 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
6614 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6615 "or after C<path> (depending on the boolean flag C<before>)."
6620 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
6622 "C<path> must match exactly one existing node in the tree, and C<label> must "
6623 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6628 #: ../src/guestfs-actions.pod:432
6629 msgid "guestfs_aug_load"
6634 #: ../src/guestfs-actions.pod:434
6638 " guestfs_aug_load (guestfs_h *g);\n"
6644 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
6645 msgid "Load files into the tree."
6650 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
6651 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6656 #: ../src/guestfs-actions.pod:446
6657 msgid "guestfs_aug_ls"
6662 #: ../src/guestfs-actions.pod:448
6666 " guestfs_aug_ls (guestfs_h *g,\n"
6667 " const char *augpath);\n"
6673 #: ../src/guestfs-actions.pod:452
6675 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6676 "sorting the resulting nodes into alphabetical order."
6681 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
6682 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
6683 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
6684 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
6685 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2178
6686 #: ../src/guestfs-actions.pod:2194 ../src/guestfs-actions.pod:2213
6687 #: ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2280
6688 #: ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:2400
6689 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2822
6690 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3322
6691 #: ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:3489
6692 #: ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:4580
6693 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5226
6694 #: ../src/guestfs-actions.pod:5340 ../src/guestfs-actions.pod:5991
6695 #: ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6107
6696 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6277
6697 #: ../src/guestfs-actions.pod:6759 ../src/guestfs-actions.pod:6779
6698 #: ../src/guestfs-actions.pod:6826 ../src/guestfs-actions.pod:6991
6699 #: ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7095
6700 #: ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7160
6701 #: ../src/guestfs-actions.pod:7179
6703 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6704 ">), or NULL if there was an error. I<The caller must free the strings and "
6705 "the array after use>."
6710 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
6711 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
6712 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3146
6713 #: ../src/guestfs-actions.pod:3735 ../src/guestfs-actions.pod:3785
6714 #: ../src/guestfs-actions.pod:3972 ../src/guestfs-actions.pod:4005
6715 #: ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4584
6716 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5419
6717 #: ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5445
6718 #: ../src/guestfs-actions.pod:5853 ../src/guestfs-actions.pod:6491
6719 #: ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6743
6720 #: ../src/guestfs-actions.pod:6979
6721 msgid "(Added in 0.8)"
6726 #: ../src/guestfs-actions.pod:461
6727 msgid "guestfs_aug_match"
6732 #: ../src/guestfs-actions.pod:463
6736 " guestfs_aug_match (guestfs_h *g,\n"
6737 " const char *augpath);\n"
6743 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
6745 "Returns a list of paths which match the path expression C<path>. The "
6746 "returned paths are sufficiently qualified so that they match exactly one "
6747 "node in the current tree."
6752 #: ../src/guestfs-actions.pod:477
6753 msgid "guestfs_aug_mv"
6758 #: ../src/guestfs-actions.pod:479
6762 " guestfs_aug_mv (guestfs_h *g,\n"
6763 " const char *src,\n"
6764 " const char *dest);\n"
6770 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
6772 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6773 "C<dest> is overwritten if it exists."
6778 #: ../src/guestfs-actions.pod:491
6779 msgid "guestfs_aug_rm"
6784 #: ../src/guestfs-actions.pod:493
6788 " guestfs_aug_rm (guestfs_h *g,\n"
6789 " const char *augpath);\n"
6795 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
6796 msgid "Remove C<path> and all of its children."
6801 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
6802 msgid "On success this returns the number of entries which were removed."
6807 #: ../src/guestfs-actions.pod:505
6808 msgid "guestfs_aug_save"
6813 #: ../src/guestfs-actions.pod:507
6817 " guestfs_aug_save (guestfs_h *g);\n"
6823 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
6824 msgid "This writes all pending changes to disk."
6829 #: ../src/guestfs-actions.pod:512
6831 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6837 #: ../src/guestfs-actions.pod:519
6838 msgid "guestfs_aug_set"
6843 #: ../src/guestfs-actions.pod:521
6847 " guestfs_aug_set (guestfs_h *g,\n"
6848 " const char *augpath,\n"
6849 " const char *val);\n"
6855 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
6856 msgid "Set the value associated with C<path> to C<val>."
6861 #: ../src/guestfs-actions.pod:528
6863 "In the Augeas API, it is possible to clear a node by setting the value to "
6864 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6865 "this call. Instead you must use the C<guestfs_aug_clear> call."
6870 #: ../src/guestfs-actions.pod:537
6871 msgid "guestfs_available"
6876 #: ../src/guestfs-actions.pod:539
6880 " guestfs_available (guestfs_h *g,\n"
6881 " char *const *groups);\n"
6887 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
6889 "This command is used to check the availability of some groups of "
6890 "functionality in the appliance, which not all builds of the libguestfs "
6891 "appliance will be able to provide."
6896 #: ../src/guestfs-actions.pod:547
6898 "The libguestfs groups, and the functions that those groups correspond to, "
6899 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6900 "runtime by calling C<guestfs_available_all_groups>."
6905 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
6907 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6908 "\"]> would check for the availability of the Linux inotify functions and "
6909 "Augeas (configuration file editing) functions."
6914 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
6915 msgid "The command returns no error if I<all> requested groups are available."
6920 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
6922 "It fails with an error if one or more of the requested groups is unavailable "
6928 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
6930 "If an unknown group name is included in the list of groups then an error is "
6936 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
6942 #: ../src/guestfs-actions.pod:571
6943 msgid "You must call C<guestfs_launch> before calling this function."
6948 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
6950 "The reason is because we don't know what groups are supported by the "
6951 "appliance/daemon until it is running and can be queried."
6956 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
6958 "If a group of functions is available, this does not necessarily mean that "
6959 "they will work. You still have to check for errors when calling individual "
6960 "API functions even if they are available."
6965 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6967 "It is usually the job of distro packagers to build complete functionality "
6968 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6969 "with all requirements satisfied, will support everything."
6974 #: ../src/guestfs-actions.pod:593
6976 "This call was added in version C<1.0.80>. In previous versions of "
6977 "libguestfs all you could do would be to speculatively execute a command to "
6978 "find out if the daemon implemented it. See also C<guestfs_version>."
6983 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6984 msgid "(Added in 1.0.80)"
6989 #: ../src/guestfs-actions.pod:604
6990 msgid "guestfs_available_all_groups"
6995 #: ../src/guestfs-actions.pod:606
6999 " guestfs_available_all_groups (guestfs_h *g);\n"
7005 #: ../src/guestfs-actions.pod:609
7007 "This command returns a list of all optional groups that this daemon knows "
7008 "about. Note this returns both supported and unsupported groups. To find "
7009 "out which ones the daemon can actually support you have to call "
7010 "C<guestfs_available> on each member of the returned list."
7015 #: ../src/guestfs-actions.pod:615
7016 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7021 #: ../src/guestfs-actions.pod:621
7022 msgid "(Added in 1.3.15)"
7027 #: ../src/guestfs-actions.pod:623
7028 msgid "guestfs_base64_in"
7033 #: ../src/guestfs-actions.pod:625
7037 " guestfs_base64_in (guestfs_h *g,\n"
7038 " const char *base64file,\n"
7039 " const char *filename);\n"
7045 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
7047 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7052 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
7053 msgid "(Added in 1.3.5)"
7058 #: ../src/guestfs-actions.pod:637
7059 msgid "guestfs_base64_out"
7064 #: ../src/guestfs-actions.pod:639
7068 " guestfs_base64_out (guestfs_h *g,\n"
7069 " const char *filename,\n"
7070 " const char *base64file);\n"
7076 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
7078 "This command downloads the contents of C<filename>, writing it out to local "
7079 "file C<base64file> encoded as base64."
7084 #: ../src/guestfs-actions.pod:651
7085 msgid "guestfs_blockdev_flushbufs"
7090 #: ../src/guestfs-actions.pod:653
7094 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7095 " const char *device);\n"
7101 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
7103 "This tells the kernel to flush internal buffers associated with C<device>."
7108 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
7109 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
7110 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
7111 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
7112 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
7113 #: ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:452
7114 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:471
7115 #: ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:496
7116 #: ../fish/guestfish-actions.pod:504 ../fish/guestfish-actions.pod:515
7117 #: ../fish/guestfish-actions.pod:523 ../fish/guestfish-actions.pod:531
7118 msgid "This uses the L<blockdev(8)> command."
7123 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
7124 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
7125 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
7126 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
7127 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
7128 msgid "(Added in 0.9.3)"
7133 #: ../src/guestfs-actions.pod:666
7134 msgid "guestfs_blockdev_getbsz"
7139 #: ../src/guestfs-actions.pod:668
7143 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7144 " const char *device);\n"
7150 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
7151 msgid "This returns the block size of a device."
7156 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
7157 #: ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
7159 "(Note this is different from both I<size in blocks> and I<filesystem block "
7165 #: ../src/guestfs-actions.pod:683
7166 msgid "guestfs_blockdev_getro"
7171 #: ../src/guestfs-actions.pod:685
7175 " guestfs_blockdev_getro (guestfs_h *g,\n"
7176 " const char *device);\n"
7182 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
7184 "Returns a boolean indicating if the block device is read-only (true if read-"
7185 "only, false if not)."
7190 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
7191 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
7192 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
7193 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
7194 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
7195 #: ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3068
7196 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3097
7197 #: ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3128
7198 #: ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3158
7199 #: ../src/guestfs-actions.pod:3171 ../src/guestfs-actions.pod:3185
7200 #: ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3215
7201 #: ../src/guestfs-actions.pod:4729
7202 msgid "This function returns a C truth value on success or -1 on error."
7207 #: ../src/guestfs-actions.pod:698
7208 msgid "guestfs_blockdev_getsize64"
7213 #: ../src/guestfs-actions.pod:700
7217 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7218 " const char *device);\n"
7224 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
7225 msgid "This returns the size of the device in bytes."
7230 #: ../src/guestfs-actions.pod:706
7231 msgid "See also C<guestfs_blockdev_getsz>."
7236 #: ../src/guestfs-actions.pod:714
7237 msgid "guestfs_blockdev_getss"
7242 #: ../src/guestfs-actions.pod:716
7246 " guestfs_blockdev_getss (guestfs_h *g,\n"
7247 " const char *device);\n"
7253 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
7255 "This returns the size of sectors on a block device. Usually 512, but can be "
7256 "larger for modern devices."
7261 #: ../src/guestfs-actions.pod:723
7263 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7269 #: ../src/guestfs-actions.pod:732
7270 msgid "guestfs_blockdev_getsz"
7275 #: ../src/guestfs-actions.pod:734
7279 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7280 " const char *device);\n"
7286 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
7288 "This returns the size of the device in units of 512-byte sectors (even if "
7289 "the sectorsize isn't 512 bytes ... weird)."
7294 #: ../src/guestfs-actions.pod:741
7296 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7297 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7302 #: ../src/guestfs-actions.pod:751
7303 msgid "guestfs_blockdev_rereadpt"
7308 #: ../src/guestfs-actions.pod:753
7312 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7313 " const char *device);\n"
7319 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
7320 msgid "Reread the partition table on C<device>."
7325 #: ../src/guestfs-actions.pod:765
7326 msgid "guestfs_blockdev_setbsz"
7331 #: ../src/guestfs-actions.pod:767
7335 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7336 " const char *device,\n"
7337 " int blocksize);\n"
7343 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
7344 msgid "This sets the block size of a device."
7349 #: ../src/guestfs-actions.pod:783
7350 msgid "guestfs_blockdev_setro"
7355 #: ../src/guestfs-actions.pod:785
7359 " guestfs_blockdev_setro (guestfs_h *g,\n"
7360 " const char *device);\n"
7366 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
7367 msgid "Sets the block device named C<device> to read-only."
7372 #: ../src/guestfs-actions.pod:797
7373 msgid "guestfs_blockdev_setrw"
7378 #: ../src/guestfs-actions.pod:799
7382 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7383 " const char *device);\n"
7389 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
7390 msgid "Sets the block device named C<device> to read-write."
7395 #: ../src/guestfs-actions.pod:811
7396 msgid "guestfs_case_sensitive_path"
7401 #: ../src/guestfs-actions.pod:813
7405 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7406 " const char *path);\n"
7412 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
7414 "This can be used to resolve case insensitive paths on a filesystem which is "
7415 "case sensitive. The use case is to resolve paths which you have read from "
7416 "Windows configuration files or the Windows Registry, to the true path."
7421 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
7423 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7424 "(and probably others), which is that although the underlying filesystem is "
7425 "case-insensitive, the driver exports the filesystem to Linux as case-"
7431 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
7433 "One consequence of this is that special directories such as C<c:\\windows> "
7434 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7435 "precise details of how they were created. In Windows itself this would not "
7441 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
7443 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7449 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
7451 "This function resolves the true case of each element in the path and returns "
7452 "the case-sensitive path."
7457 #: ../src/guestfs-actions.pod:839
7459 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7460 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7461 "how the directories were originally created under Windows)."
7466 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
7467 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7472 #: ../src/guestfs-actions.pod:847
7473 msgid "See also C<guestfs_realpath>."
7478 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6671
7479 msgid "(Added in 1.0.75)"
7484 #: ../src/guestfs-actions.pod:854
7490 #: ../src/guestfs-actions.pod:856
7494 " guestfs_cat (guestfs_h *g,\n"
7495 " const char *path);\n"
7501 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5216
7502 #: ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3468
7503 msgid "Return the contents of the file named C<path>."
7508 #: ../src/guestfs-actions.pod:862
7510 "Note that this function cannot correctly handle binary files (specifically, "
7511 "files containing C<\\0> character which is treated as end of string). For "
7512 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7513 "functions which have a more complex interface."
7518 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
7519 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
7520 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
7521 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
7522 #: ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2217
7523 #: ../src/guestfs-actions.pod:2260 ../src/guestfs-actions.pod:2284
7524 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2330
7525 #: ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5024
7526 #: ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5181
7527 #: ../src/guestfs-actions.pod:5205 ../src/guestfs-actions.pod:6056
7528 #: ../src/guestfs-actions.pod:6111 ../src/guestfs-actions.pod:6257
7529 #: ../src/guestfs-actions.pod:6281 ../src/guestfs-actions.pod:6943
7530 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6995
7531 #: ../src/guestfs-actions.pod:7014 ../src/guestfs-actions.pod:7099
7532 #: ../src/guestfs-actions.pod:7118 ../src/guestfs-actions.pod:7164
7533 #: ../src/guestfs-actions.pod:7183 ../fish/guestfish-actions.pod:580
7534 #: ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727
7535 #: ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913
7536 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990
7537 #: ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1480
7538 #: ../fish/guestfish-actions.pod:1490 ../fish/guestfish-actions.pod:1518
7539 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1543
7540 #: ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:3338
7541 #: ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3429
7542 #: ../fish/guestfish-actions.pod:3446 ../fish/guestfish-actions.pod:3461
7543 #: ../fish/guestfish-actions.pod:4044 ../fish/guestfish-actions.pod:4090
7544 #: ../fish/guestfish-actions.pod:4175 ../fish/guestfish-actions.pod:4190
7545 #: ../fish/guestfish-actions.pod:4600 ../fish/guestfish-actions.pod:4618
7546 #: ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4645
7547 #: ../fish/guestfish-actions.pod:4693 ../fish/guestfish-actions.pod:4703
7548 #: ../fish/guestfish-actions.pod:4732 ../fish/guestfish-actions.pod:4742
7550 "Because of the message protocol, there is a transfer limit of somewhere "
7551 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7556 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3326
7557 #: ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3405
7558 #: ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3898
7559 #: ../src/guestfs-actions.pod:3912 ../src/guestfs-actions.pod:5104
7560 #: ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:6830
7561 #: ../src/guestfs-actions.pod:6844
7562 msgid "(Added in 0.4)"
7567 #: ../src/guestfs-actions.pod:875
7568 msgid "guestfs_checksum"
7573 #: ../src/guestfs-actions.pod:877
7577 " guestfs_checksum (guestfs_h *g,\n"
7578 " const char *csumtype,\n"
7579 " const char *path);\n"
7585 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
7587 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7592 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
7594 "The type of checksum to compute is given by the C<csumtype> parameter which "
7595 "must have one of the following values:"
7600 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
7606 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
7608 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7614 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
7620 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
7621 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7626 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
7632 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
7633 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7638 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
7644 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
7645 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7650 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
7656 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
7657 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7662 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
7668 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
7669 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7674 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
7680 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
7681 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7686 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
7687 msgid "The checksum is returned as a printable string."
7692 #: ../src/guestfs-actions.pod:923
7693 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7698 #: ../src/guestfs-actions.pod:925
7699 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7704 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
7705 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3070
7706 #: ../src/guestfs-actions.pod:3099 ../src/guestfs-actions.pod:3160
7707 #: ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:6527
7708 msgid "(Added in 1.0.2)"
7713 #: ../src/guestfs-actions.pod:932
7714 msgid "guestfs_checksum_device"
7719 #: ../src/guestfs-actions.pod:934
7723 " guestfs_checksum_device (guestfs_h *g,\n"
7724 " const char *csumtype,\n"
7725 " const char *device);\n"
7731 #: ../src/guestfs-actions.pod:939
7733 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7734 "device named C<device>. For the types of checksums supported see the "
7735 "C<guestfs_checksum> command."
7740 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4635
7741 #: ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4731
7742 #: ../src/guestfs-actions.pod:4749 ../src/guestfs-actions.pod:4925
7743 #: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6450
7744 #: ../src/guestfs-actions.pod:6856
7745 msgid "(Added in 1.3.2)"
7750 #: ../src/guestfs-actions.pod:948
7751 msgid "guestfs_checksums_out"
7756 #: ../src/guestfs-actions.pod:950
7760 " guestfs_checksums_out (guestfs_h *g,\n"
7761 " const char *csumtype,\n"
7762 " const char *directory,\n"
7763 " const char *sumsfile);\n"
7769 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
7771 "This command computes the checksums of all regular files in C<directory> and "
7772 "then emits a list of those checksums to the local output file C<sumsfile>."
7777 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
7779 "This can be used for verifying the integrity of a virtual machine. However "
7780 "to be properly secure you should pay attention to the output of the checksum "
7781 "command (it uses the ones from GNU coreutils). In particular when the "
7782 "filename is not printable, coreutils uses a special backslash syntax. For "
7783 "more information, see the GNU coreutils info file."
7788 #: ../src/guestfs-actions.pod:970
7789 msgid "(Added in 1.3.7)"
7794 #: ../src/guestfs-actions.pod:972
7795 msgid "guestfs_chmod"
7800 #: ../src/guestfs-actions.pod:974
7804 " guestfs_chmod (guestfs_h *g,\n"
7806 " const char *path);\n"
7812 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
7814 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7820 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
7822 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7823 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7829 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4149
7830 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4353
7831 #: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:669
7832 #: ../fish/guestfish-actions.pod:2795 ../fish/guestfish-actions.pod:2913
7833 #: ../fish/guestfish-actions.pod:2923 ../fish/guestfish-actions.pod:2933
7834 msgid "The mode actually set is affected by the umask."
7839 #: ../src/guestfs-actions.pod:992
7840 msgid "guestfs_chown"
7845 #: ../src/guestfs-actions.pod:994
7849 " guestfs_chown (guestfs_h *g,\n"
7852 " const char *path);\n"
7858 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
7859 msgid "Change the file owner to C<owner> and group to C<group>."
7864 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3257
7865 #: ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2253
7867 "Only numeric uid and gid are supported. If you want to use names, you will "
7868 "need to locate and parse the password file yourself (Augeas support makes "
7869 "this relatively easy)."
7874 #: ../src/guestfs-actions.pod:1010
7875 msgid "guestfs_command"
7880 #: ../src/guestfs-actions.pod:1012
7884 " guestfs_command (guestfs_h *g,\n"
7885 " char *const *arguments);\n"
7891 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
7893 "This call runs a command from the guest filesystem. The filesystem must be "
7894 "mounted, and must contain a compatible operating system (ie. something "
7895 "Linux, with the same or compatible processor architecture)."
7900 #: ../src/guestfs-actions.pod:1021
7902 "The single parameter is an argv-style list of arguments. The first element "
7903 "is the name of the program to run. Subsequent elements are parameters. The "
7904 "list must be non-empty (ie. must contain a program name). Note that the "
7905 "command runs directly, and is I<not> invoked via the shell (see "
7911 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
7912 msgid "The return value is anything printed to I<stdout> by the command."
7917 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
7919 "If the command returns a non-zero exit status, then this function returns an "
7920 "error message. The error message string is the content of I<stderr> from "
7926 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
7928 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7929 "bin>. If you require a program from another location, you should provide "
7930 "the full path in the first parameter."
7935 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
7937 "Shared libraries and data files required by the program must be available on "
7938 "filesystems which are mounted in the correct places. It is the caller's "
7939 "responsibility to ensure all filesystems that are needed are mounted at the "
7945 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
7946 #: ../src/guestfs-actions.pod:1535
7947 msgid "(Added in 0.9.1)"
7952 #: ../src/guestfs-actions.pod:1054
7953 msgid "guestfs_command_lines"
7958 #: ../src/guestfs-actions.pod:1056
7962 " guestfs_command_lines (guestfs_h *g,\n"
7963 " char *const *arguments);\n"
7969 #: ../src/guestfs-actions.pod:1060
7971 "This is the same as C<guestfs_command>, but splits the result into a list of "
7977 #: ../src/guestfs-actions.pod:1063
7978 msgid "See also: C<guestfs_sh_lines>"
7983 #: ../src/guestfs-actions.pod:1074
7984 msgid "guestfs_config"
7989 #: ../src/guestfs-actions.pod:1076
7993 " guestfs_config (guestfs_h *g,\n"
7994 " const char *qemuparam,\n"
7995 " const char *qemuvalue);\n"
8001 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
8003 "This can be used to add arbitrary qemu command line parameters of the form "
8004 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8005 "setting some parameters which would interfere with parameters that we use."
8010 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
8011 msgid "The first character of C<param> string must be a C<-> (dash)."
8016 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
8017 msgid "C<value> can be NULL."
8022 #: ../src/guestfs-actions.pod:1094
8023 msgid "guestfs_copy_size"
8028 #: ../src/guestfs-actions.pod:1096
8032 " guestfs_copy_size (guestfs_h *g,\n"
8033 " const char *src,\n"
8034 " const char *dest,\n"
8041 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
8043 "This command copies exactly C<size> bytes from one source device or file "
8044 "C<src> to another destination device or file C<dest>."
8049 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
8051 "Note this will fail if the source is too short or if the destination is not "
8057 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
8058 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
8059 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6522
8060 #: ../src/guestfs-actions.pod:6556 ../src/guestfs-actions.pod:7035
8061 #: ../src/guestfs-actions.pod:7054
8063 "This long-running command can generate progress notification messages so "
8064 "that the caller can display a progress bar or indicator. To receive these "
8065 "messages, the caller must register a progress callback. See L<guestfs(3)/"
8066 "guestfs_set_progress_callback>."
8071 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3925
8072 #: ../src/guestfs-actions.pod:5131 ../src/guestfs-actions.pod:6763
8073 #: ../src/guestfs-actions.pod:6783 ../src/guestfs-actions.pod:6869
8074 msgid "(Added in 1.0.87)"
8079 #: ../src/guestfs-actions.pod:1117
8085 #: ../src/guestfs-actions.pod:1119
8089 " guestfs_cp (guestfs_h *g,\n"
8090 " const char *src,\n"
8091 " const char *dest);\n"
8097 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
8099 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8100 "destination filename or destination directory."
8105 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
8106 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
8107 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4598
8108 #: ../src/guestfs-actions.pod:4975
8109 msgid "(Added in 1.0.18)"
8114 #: ../src/guestfs-actions.pod:1131
8115 msgid "guestfs_cp_a"
8120 #: ../src/guestfs-actions.pod:1133
8124 " guestfs_cp_a (guestfs_h *g,\n"
8125 " const char *src,\n"
8126 " const char *dest);\n"
8132 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
8134 "This copies a file or directory from C<src> to C<dest> recursively using the "
8140 #: ../src/guestfs-actions.pod:1145
8146 #: ../src/guestfs-actions.pod:1147
8150 " guestfs_dd (guestfs_h *g,\n"
8151 " const char *src,\n"
8152 " const char *dest);\n"
8158 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
8160 "This command copies from one source device or file C<src> to another "
8161 "destination device or file C<dest>. Normally you would use this to copy to "
8162 "or from a device or partition, for example to duplicate a filesystem."
8167 #: ../src/guestfs-actions.pod:1157
8169 "If the destination is a device, it must be as large or larger than the "
8170 "source file or device, otherwise the copy will fail. This command cannot do "
8171 "partial copies (see C<guestfs_copy_size>)."
8176 #: ../src/guestfs-actions.pod:1165
8182 #: ../src/guestfs-actions.pod:1167
8186 " guestfs_df (guestfs_h *g);\n"
8192 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
8193 msgid "This command runs the C<df> command to report disk space used."
8198 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
8200 "This command is mostly useful for interactive sessions. It is I<not> "
8201 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8207 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
8208 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2263
8209 #: ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2355
8210 #: ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4498
8211 #: ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:6284
8212 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:6915
8213 #: ../src/guestfs-actions.pod:6928
8214 msgid "(Added in 1.0.54)"
8219 #: ../src/guestfs-actions.pod:1181
8220 msgid "guestfs_df_h"
8225 #: ../src/guestfs-actions.pod:1183
8229 " guestfs_df_h (guestfs_h *g);\n"
8235 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
8237 "This command runs the C<df -h> command to report disk space used in human-"
8243 #: ../src/guestfs-actions.pod:1198
8244 msgid "guestfs_dmesg"
8249 #: ../src/guestfs-actions.pod:1200
8253 " guestfs_dmesg (guestfs_h *g);\n"
8259 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
8261 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8262 "This is sometimes useful for extended debugging of problems."
8267 #: ../src/guestfs-actions.pod:1207
8269 "Another way to get the same information is to enable verbose messages with "
8270 "C<guestfs_set_verbose> or by setting the environment variable "
8271 "C<LIBGUESTFS_DEBUG=1> before running the program."
8276 #: ../src/guestfs-actions.pod:1217
8277 msgid "guestfs_download"
8282 #: ../src/guestfs-actions.pod:1219
8286 " guestfs_download (guestfs_h *g,\n"
8287 " const char *remotefilename,\n"
8288 " const char *filename);\n"
8294 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
8295 #: ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
8297 "Download file C<remotefilename> and save it as C<filename> on the local "
8303 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6516
8304 #: ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4348
8305 msgid "C<filename> can also be a named pipe."
8310 #: ../src/guestfs-actions.pod:1229
8311 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8316 #: ../src/guestfs-actions.pod:1240
8317 msgid "guestfs_download_offset"
8322 #: ../src/guestfs-actions.pod:1242
8326 " guestfs_download_offset (guestfs_h *g,\n"
8327 " const char *remotefilename,\n"
8328 " const char *filename,\n"
8329 " int64_t offset,\n"
8336 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
8338 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8339 "region must be within the file or device)."
8344 #: ../src/guestfs-actions.pod:1255
8346 "Note that there is no limit on the amount of data that can be downloaded "
8347 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8348 "full amount unless an error occurs."
8353 #: ../src/guestfs-actions.pod:1260
8354 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8359 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6561
8360 msgid "(Added in 1.5.17)"
8365 #: ../src/guestfs-actions.pod:1271
8366 msgid "guestfs_drop_caches"
8371 #: ../src/guestfs-actions.pod:1273
8375 " guestfs_drop_caches (guestfs_h *g,\n"
8376 " int whattodrop);\n"
8382 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
8384 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8385 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8386 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8391 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
8392 msgid "Setting C<whattodrop> to 3 should drop everything."
8397 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
8399 "This automatically calls L<sync(2)> before the operation, so that the "
8400 "maximum guest memory is freed."
8405 #: ../src/guestfs-actions.pod:1291
8411 #: ../src/guestfs-actions.pod:1293
8415 " guestfs_du (guestfs_h *g,\n"
8416 " const char *path);\n"
8422 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
8424 "This command runs the C<du -s> command to estimate file space usage for "
8430 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
8432 "C<path> can be a file or a directory. If C<path> is a directory then the "
8433 "estimate includes the contents of the directory and all subdirectories "
8439 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
8441 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8446 #: ../src/guestfs-actions.pod:1311
8447 msgid "guestfs_e2fsck_f"
8452 #: ../src/guestfs-actions.pod:1313
8456 " guestfs_e2fsck_f (guestfs_h *g,\n"
8457 " const char *device);\n"
8463 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
8465 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8466 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8472 #: ../src/guestfs-actions.pod:1321
8474 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8475 "Normally you should use C<guestfs_fsck>."
8480 #: ../src/guestfs-actions.pod:1326
8481 msgid "(Added in 1.0.29)"
8486 #: ../src/guestfs-actions.pod:1328
8487 msgid "guestfs_echo_daemon"
8492 #: ../src/guestfs-actions.pod:1330
8496 " guestfs_echo_daemon (guestfs_h *g,\n"
8497 " char *const *words);\n"
8503 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
8505 "This command concatenates the list of C<words> passed with single spaces "
8506 "between them and returns the resulting string."
8511 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
8512 msgid "You can use this command to test the connection through to the daemon."
8517 #: ../src/guestfs-actions.pod:1339
8518 msgid "See also C<guestfs_ping_daemon>."
8523 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
8524 #: ../src/guestfs-actions.pod:5764
8525 msgid "(Added in 1.0.69)"
8530 #: ../src/guestfs-actions.pod:1346
8531 msgid "guestfs_egrep"
8536 #: ../src/guestfs-actions.pod:1348
8540 " guestfs_egrep (guestfs_h *g,\n"
8541 " const char *regex,\n"
8542 " const char *path);\n"
8548 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
8550 "This calls the external C<egrep> program and returns the matching lines."
8555 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
8556 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
8557 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2201
8558 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2376
8559 #: ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2404
8560 #: ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:2472
8561 #: ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3418
8562 #: ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3445
8563 #: ../src/guestfs-actions.pod:3459 ../src/guestfs-actions.pod:4433
8564 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5358
8565 #: ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6140
8566 #: ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6166
8567 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6201
8568 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6227
8569 #: ../src/guestfs-actions.pod:6998 ../src/guestfs-actions.pod:7017
8570 #: ../src/guestfs-actions.pod:7102 ../src/guestfs-actions.pod:7121
8571 #: ../src/guestfs-actions.pod:7167 ../src/guestfs-actions.pod:7186
8572 msgid "(Added in 1.0.66)"
8577 #: ../src/guestfs-actions.pod:1365
8578 msgid "guestfs_egrepi"
8583 #: ../src/guestfs-actions.pod:1367
8587 " guestfs_egrepi (guestfs_h *g,\n"
8588 " const char *regex,\n"
8589 " const char *path);\n"
8595 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
8597 "This calls the external C<egrep -i> program and returns the matching lines."
8602 #: ../src/guestfs-actions.pod:1384
8603 msgid "guestfs_equal"
8608 #: ../src/guestfs-actions.pod:1386
8612 " guestfs_equal (guestfs_h *g,\n"
8613 " const char *file1,\n"
8614 " const char *file2);\n"
8620 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
8622 "This compares the two files C<file1> and C<file2> and returns true if their "
8623 "content is exactly equal, or false otherwise."
8628 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
8629 msgid "The external L<cmp(1)> program is used for the comparison."
8634 #: ../src/guestfs-actions.pod:1400
8635 msgid "guestfs_exists"
8640 #: ../src/guestfs-actions.pod:1402
8644 " guestfs_exists (guestfs_h *g,\n"
8645 " const char *path);\n"
8651 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
8653 "This returns C<true> if and only if there is a file, directory (or anything) "
8654 "with the given C<path> name."
8659 #: ../src/guestfs-actions.pod:1409
8660 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8665 #: ../src/guestfs-actions.pod:1415
8666 msgid "guestfs_fallocate"
8671 #: ../src/guestfs-actions.pod:1417
8675 " guestfs_fallocate (guestfs_h *g,\n"
8676 " const char *path,\n"
8683 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
8684 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
8686 "This command preallocates a file (containing zero bytes) named C<path> of "
8687 "size C<len> bytes. If the file exists already, it is overwritten."
8692 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
8694 "Do not confuse this with the guestfish-specific C<alloc> command which "
8695 "allocates a file in the host and attaches it as a device."
8700 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:946
8702 "This function is deprecated. In new code, use the C<fallocate64> call "
8708 #: ../src/guestfs-actions.pod:1441
8709 msgid "guestfs_fallocate64"
8714 #: ../src/guestfs-actions.pod:1443
8718 " guestfs_fallocate64 (guestfs_h *g,\n"
8719 " const char *path,\n"
8726 #: ../src/guestfs-actions.pod:1452
8728 "Note that this call allocates disk blocks for the file. To create a sparse "
8729 "file use C<guestfs_truncate_size> instead."
8734 #: ../src/guestfs-actions.pod:1455
8736 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8737 "oversight it only allowed 30 bit lengths to be specified, effectively "
8738 "limiting the maximum size of files created through that call to 1GB."
8743 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
8745 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8746 "commands which create a file in the host and attach it as a device."
8751 #: ../src/guestfs-actions.pod:1466
8752 msgid "(Added in 1.3.17)"
8757 #: ../src/guestfs-actions.pod:1468
8758 msgid "guestfs_fgrep"
8763 #: ../src/guestfs-actions.pod:1470
8767 " guestfs_fgrep (guestfs_h *g,\n"
8768 " const char *pattern,\n"
8769 " const char *path);\n"
8775 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
8777 "This calls the external C<fgrep> program and returns the matching lines."
8782 #: ../src/guestfs-actions.pod:1487
8783 msgid "guestfs_fgrepi"
8788 #: ../src/guestfs-actions.pod:1489
8792 " guestfs_fgrepi (guestfs_h *g,\n"
8793 " const char *pattern,\n"
8794 " const char *path);\n"
8800 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
8802 "This calls the external C<fgrep -i> program and returns the matching lines."
8807 #: ../src/guestfs-actions.pod:1506
8808 msgid "guestfs_file"
8813 #: ../src/guestfs-actions.pod:1508
8817 " guestfs_file (guestfs_h *g,\n"
8818 " const char *path);\n"
8824 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
8826 "This call uses the standard L<file(1)> command to determine the type or "
8827 "contents of the file."
8832 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
8834 "This call will also transparently look inside various types of compressed "
8840 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
8842 "The exact command which runs is C<file -zb path>. Note in particular that "
8843 "the filename is not prepended to the output (the C<-b> option)."
8848 #: ../src/guestfs-actions.pod:1522
8850 "This command can also be used on C</dev/> devices (and partitions, LV "
8851 "names). You can for example use this to determine if a device contains a "
8852 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8857 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
8859 "If the C<path> does not begin with C</dev/> then this command only works for "
8860 "the content of regular files. For other file types (directory, symbolic "
8861 "link etc) it will just return the string C<directory> etc."
8866 #: ../src/guestfs-actions.pod:1537
8867 msgid "guestfs_file_architecture"
8872 #: ../src/guestfs-actions.pod:1539
8876 " guestfs_file_architecture (guestfs_h *g,\n"
8877 " const char *filename);\n"
8883 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
8885 "This detects the architecture of the binary C<filename>, and returns it if "
8891 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
8892 msgid "Currently defined architectures are:"
8897 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1028
8903 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
8905 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8906 "irrespective of the precise processor requirements of the binary."
8911 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1033
8917 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
8918 msgid "64 bit x86-64."
8923 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
8929 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
8930 msgid "32 bit SPARC."
8935 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
8941 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
8942 msgid "64 bit SPARC V9 and above."
8947 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
8953 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
8954 msgid "Intel Itanium."
8959 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
8965 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
8966 msgid "32 bit Power PC."
8971 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
8977 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
8978 msgid "64 bit Power PC."
8983 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1059
8984 msgid "Libguestfs may return other architecture strings in future."
8989 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
8990 msgid "The function works on at least the following types of files:"
8995 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1067
8996 msgid "many types of Un*x and Linux binary"
9001 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1071
9002 msgid "many types of Un*x and Linux shared library"
9007 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1075
9008 msgid "Windows Win32 and Win64 binaries"
9013 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1079
9014 msgid "Windows Win32 and Win64 DLLs"
9019 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
9020 msgid "Win32 binaries and DLLs return C<i386>."
9025 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
9026 msgid "Win64 binaries and DLLs return C<x86_64>."
9031 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1087
9032 msgid "Linux kernel modules"
9037 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1091
9038 msgid "Linux new-style initrd images"
9043 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1095
9044 msgid "some non-x86 Linux vmlinuz kernels"
9049 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1099
9050 msgid "What it can't do currently:"
9055 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1105
9056 msgid "static libraries (libfoo.a)"
9061 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1109
9062 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9067 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1113
9068 msgid "x86 Linux vmlinuz kernels"
9073 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
9075 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9076 "compressed code, and are horribly hard to unpack. If you want to find the "
9077 "architecture of a kernel, use the architecture of the associated initrd or "
9078 "kernel module(s) instead."
9083 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
9084 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2508
9085 #: ../src/guestfs-actions.pod:2589 ../src/guestfs-actions.pod:2615
9086 #: ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2685
9087 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2806
9088 #: ../src/guestfs-actions.pod:2868 ../src/guestfs-actions.pod:3041
9089 #: ../src/guestfs-actions.pod:3173
9090 msgid "(Added in 1.5.3)"
9095 #: ../src/guestfs-actions.pod:1649
9096 msgid "guestfs_filesize"
9101 #: ../src/guestfs-actions.pod:1651
9105 " guestfs_filesize (guestfs_h *g,\n"
9106 " const char *file);\n"
9112 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1126
9113 msgid "This command returns the size of C<file> in bytes."
9118 #: ../src/guestfs-actions.pod:1657
9120 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9121 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9122 "devices, use C<guestfs_blockdev_getsize64>."
9127 #: ../src/guestfs-actions.pod:1663
9128 msgid "(Added in 1.0.82)"
9133 #: ../src/guestfs-actions.pod:1665
9134 msgid "guestfs_fill"
9139 #: ../src/guestfs-actions.pod:1667
9143 " guestfs_fill (guestfs_h *g,\n"
9146 " const char *path);\n"
9152 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1136
9154 "This command creates a new file called C<path>. The initial content of the "
9155 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9161 #: ../src/guestfs-actions.pod:1677
9163 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9164 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9165 "bytes use C<guestfs_fill_pattern>."
9170 #: ../src/guestfs-actions.pod:1689
9171 msgid "(Added in 1.0.79)"
9176 #: ../src/guestfs-actions.pod:1691
9177 msgid "guestfs_fill_pattern"
9182 #: ../src/guestfs-actions.pod:1693
9186 " guestfs_fill_pattern (guestfs_h *g,\n"
9187 " const char *pattern,\n"
9189 " const char *path);\n"
9195 #: ../src/guestfs-actions.pod:1699
9197 "This function is like C<guestfs_fill> except that it creates a new file of "
9198 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9199 "pattern is truncated if necessary to ensure the length of the file is "
9200 "exactly C<len> bytes."
9205 #: ../src/guestfs-actions.pod:1711
9206 msgid "(Added in 1.3.12)"
9211 #: ../src/guestfs-actions.pod:1713
9212 msgid "guestfs_find"
9217 #: ../src/guestfs-actions.pod:1715
9221 " guestfs_find (guestfs_h *g,\n"
9222 " const char *directory);\n"
9228 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1158
9230 "This command lists out all files and directories, recursively, starting at "
9231 "C<directory>. It is essentially equivalent to running the shell command "
9232 "C<find directory -print> but some post-processing happens on the output, "
9238 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
9240 "This returns a list of strings I<without any prefix>. Thus if the directory "
9246 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1166
9257 #: ../src/guestfs-actions.pod:1731
9259 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9264 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1173
9276 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
9277 msgid "If C<directory> is not a directory, then this command returns an error."
9282 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1181
9283 msgid "The returned list is sorted."
9288 #: ../src/guestfs-actions.pod:1744
9289 msgid "See also C<guestfs_find0>."
9294 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3862
9295 #: ../src/guestfs-actions.pod:5393
9296 msgid "(Added in 1.0.27)"
9301 #: ../src/guestfs-actions.pod:1755
9302 msgid "guestfs_find0"
9307 #: ../src/guestfs-actions.pod:1757
9311 " guestfs_find0 (guestfs_h *g,\n"
9312 " const char *directory,\n"
9313 " const char *files);\n"
9319 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1192
9321 "This command lists out all files and directories, recursively, starting at "
9322 "C<directory>, placing the resulting list in the external file called "
9328 #: ../src/guestfs-actions.pod:1766
9330 "This command works the same way as C<guestfs_find> with the following "
9336 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1203
9337 msgid "The resulting list is written to an external file."
9342 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1207
9344 "Items (filenames) in the result are separated by C<\\0> characters. See "
9345 "L<find(1)> option I<-print0>."
9350 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1212
9351 msgid "This command is not limited in the number of names that it can return."
9356 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1217
9357 msgid "The result list is not sorted."
9362 #: ../src/guestfs-actions.pod:1793
9363 msgid "(Added in 1.0.74)"
9368 #: ../src/guestfs-actions.pod:1795
9369 msgid "guestfs_findfs_label"
9374 #: ../src/guestfs-actions.pod:1797
9378 " guestfs_findfs_label (guestfs_h *g,\n"
9379 " const char *label);\n"
9385 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1227
9387 "This command searches the filesystems and returns the one which has the "
9388 "given label. An error is returned if no such filesystem can be found."
9393 #: ../src/guestfs-actions.pod:1805
9394 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9399 #: ../src/guestfs-actions.pod:1812
9400 msgid "guestfs_findfs_uuid"
9405 #: ../src/guestfs-actions.pod:1814
9409 " guestfs_findfs_uuid (guestfs_h *g,\n"
9410 " const char *uuid);\n"
9416 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1237
9418 "This command searches the filesystems and returns the one which has the "
9419 "given UUID. An error is returned if no such filesystem can be found."
9424 #: ../src/guestfs-actions.pod:1822
9425 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9430 #: ../src/guestfs-actions.pod:1829
9431 msgid "guestfs_fsck"
9436 #: ../src/guestfs-actions.pod:1831
9440 " guestfs_fsck (guestfs_h *g,\n"
9441 " const char *fstype,\n"
9442 " const char *device);\n"
9448 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
9450 "This runs the filesystem checker (fsck) on C<device> which should have "
9451 "filesystem type C<fstype>."
9456 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1250
9458 "The returned integer is the status. See L<fsck(8)> for the list of status "
9459 "codes from C<fsck>."
9464 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1259
9465 msgid "Multiple status codes can be summed together."
9470 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1263
9472 "A non-zero return code can mean \"success\", for example if errors have been "
9473 "corrected on the filesystem."
9478 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1268
9479 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9484 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1273
9486 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9491 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:7040
9492 msgid "(Added in 1.0.16)"
9497 #: ../src/guestfs-actions.pod:1868
9498 msgid "guestfs_get_append"
9503 #: ../src/guestfs-actions.pod:1870
9507 " guestfs_get_append (guestfs_h *g);\n"
9513 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
9515 "Return the additional kernel options which are added to the guest kernel "
9521 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1282
9522 msgid "If C<NULL> then no options are added."
9527 #: ../src/guestfs-actions.pod:1878
9529 "This function returns a string which may be NULL. There is no way to return "
9530 "an error from this function. The string is owned by the guest handle and "
9531 "must I<not> be freed."
9536 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:5071
9537 #: ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5902
9538 #: ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5937
9539 #: ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:6711
9540 #: ../src/guestfs-actions.pod:6729 ../src/guestfs-actions.pod:7083
9541 msgid "(Added in 1.0.26)"
9546 #: ../src/guestfs-actions.pod:1884
9547 msgid "guestfs_get_autosync"
9552 #: ../src/guestfs-actions.pod:1886
9556 " guestfs_get_autosync (guestfs_h *g);\n"
9562 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
9563 msgid "Get the autosync flag."
9568 #: ../src/guestfs-actions.pod:1895
9569 msgid "guestfs_get_direct"
9574 #: ../src/guestfs-actions.pod:1897
9578 " guestfs_get_direct (guestfs_h *g);\n"
9584 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1294
9585 msgid "Return the direct appliance mode flag."
9590 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5575
9591 msgid "(Added in 1.0.72)"
9596 #: ../src/guestfs-actions.pod:1906
9597 msgid "guestfs_get_e2label"
9602 #: ../src/guestfs-actions.pod:1908
9606 " guestfs_get_e2label (guestfs_h *g,\n"
9607 " const char *device);\n"
9613 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1300
9615 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9620 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1303
9622 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9627 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
9628 #: ../src/guestfs-actions.pod:5593 ../src/guestfs-actions.pod:5612
9629 msgid "(Added in 1.0.15)"
9634 #: ../src/guestfs-actions.pod:1927
9635 msgid "guestfs_get_e2uuid"
9640 #: ../src/guestfs-actions.pod:1929
9644 " guestfs_get_e2uuid (guestfs_h *g,\n"
9645 " const char *device);\n"
9651 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1314
9653 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9658 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1317
9660 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9665 #: ../src/guestfs-actions.pod:1948
9666 msgid "guestfs_get_memsize"
9671 #: ../src/guestfs-actions.pod:1950
9675 " guestfs_get_memsize (guestfs_h *g);\n"
9681 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1328
9683 "This gets the memory size in megabytes allocated to the qemu subprocess."
9688 #: ../src/guestfs-actions.pod:1956
9690 "If C<guestfs_set_memsize> was not called on this handle, and if "
9691 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9692 "value for memsize."
9697 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
9698 #: ../src/guestfs-actions.pod:5628 ../src/guestfs-actions.pod:5735
9699 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1386
9700 #: ../fish/guestfish-actions.pod:3755 ../fish/guestfish-actions.pod:3842
9702 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9707 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4153
9708 #: ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4357
9709 #: ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4388
9710 #: ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4418
9711 #: ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5633
9712 #: ../src/guestfs-actions.pod:5876 ../src/guestfs-actions.pod:6477
9713 msgid "(Added in 1.0.55)"
9718 #: ../src/guestfs-actions.pod:1967
9719 msgid "guestfs_get_network"
9724 #: ../src/guestfs-actions.pod:1969
9728 " guestfs_get_network (guestfs_h *g);\n"
9734 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1342
9735 msgid "This returns the enable network flag."
9740 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5652
9741 msgid "(Added in 1.5.4)"
9746 #: ../src/guestfs-actions.pod:1978
9747 msgid "guestfs_get_path"
9752 #: ../src/guestfs-actions.pod:1980
9756 " guestfs_get_path (guestfs_h *g);\n"
9762 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1348
9763 msgid "Return the current search path."
9768 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
9770 "This is always non-NULL. If it wasn't set already, then this will return "
9776 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
9778 "This function returns a string, or NULL on error. The string is owned by "
9779 "the guest handle and must I<not> be freed."
9784 #: ../src/guestfs-actions.pod:1993
9785 msgid "guestfs_get_pid"
9790 #: ../src/guestfs-actions.pod:1995
9794 " guestfs_get_pid (guestfs_h *g);\n"
9800 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
9802 "Return the process ID of the qemu subprocess. If there is no qemu "
9803 "subprocess, then this will return an error."
9808 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1362
9809 msgid "This is an internal call used for debugging and testing."
9814 #: ../src/guestfs-actions.pod:2005
9815 msgid "(Added in 1.0.56)"
9820 #: ../src/guestfs-actions.pod:2007
9821 msgid "guestfs_get_qemu"
9826 #: ../src/guestfs-actions.pod:2009
9830 " guestfs_get_qemu (guestfs_h *g);\n"
9836 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1368
9837 msgid "Return the current qemu binary."
9842 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
9844 "This is always non-NULL. If it wasn't set already, then this will return "
9845 "the default qemu binary name."
9850 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5697
9851 msgid "(Added in 1.0.6)"
9856 #: ../src/guestfs-actions.pod:2022
9857 msgid "guestfs_get_recovery_proc"
9862 #: ../src/guestfs-actions.pod:2024
9866 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9872 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9873 msgid "Return the recovery process enabled flag."
9878 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3263
9879 #: ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3960
9880 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:5001
9881 #: ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5721
9882 #: ../src/guestfs-actions.pod:6380 ../src/guestfs-actions.pod:6400
9883 #: ../src/guestfs-actions.pod:6592
9884 msgid "(Added in 1.0.77)"
9889 #: ../src/guestfs-actions.pod:2033
9890 msgid "guestfs_get_selinux"
9895 #: ../src/guestfs-actions.pod:2035
9899 " guestfs_get_selinux (guestfs_h *g);\n"
9905 #: ../src/guestfs-actions.pod:2038
9907 "This returns the current setting of the selinux flag which is passed to the "
9908 "appliance at boot time. See C<guestfs_set_selinux>."
9913 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
9914 #: ../src/guestfs-actions.pod:5740 ../src/guestfs-actions.pod:5794
9915 msgid "(Added in 1.0.67)"
9920 #: ../src/guestfs-actions.pod:2048
9921 msgid "guestfs_get_state"
9926 #: ../src/guestfs-actions.pod:2050
9930 " guestfs_get_state (guestfs_h *g);\n"
9936 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1393
9938 "This returns the current state as an opaque integer. This is only useful "
9939 "for printing debug and internal error messages."
9944 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3066
9945 #: ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3156
9946 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:1396
9947 #: ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2153
9948 #: ../fish/guestfish-actions.pod:2191 ../fish/guestfish-actions.pod:2207
9949 msgid "For more information on states, see L<guestfs(3)>."
9954 #: ../src/guestfs-actions.pod:2062
9955 msgid "guestfs_get_trace"
9960 #: ../src/guestfs-actions.pod:2064
9964 " guestfs_get_trace (guestfs_h *g);\n"
9970 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1402
9971 msgid "Return the command trace flag."
9976 #: ../src/guestfs-actions.pod:2073
9977 msgid "guestfs_get_umask"
9982 #: ../src/guestfs-actions.pod:2075
9986 " guestfs_get_umask (guestfs_h *g);\n"
9992 #: ../src/guestfs-actions.pod:2078
9994 "Return the current umask. By default the umask is C<022> unless it has been "
9995 "set by calling C<guestfs_umask>."
10000 #: ../src/guestfs-actions.pod:2085
10001 msgid "guestfs_get_verbose"
10006 #: ../src/guestfs-actions.pod:2087
10010 " guestfs_get_verbose (guestfs_h *g);\n"
10016 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
10017 msgid "This returns the verbose messages flag."
10022 #: ../src/guestfs-actions.pod:2096
10023 msgid "guestfs_getcon"
10028 #: ../src/guestfs-actions.pod:2098
10032 " guestfs_getcon (guestfs_h *g);\n"
10038 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1421
10039 msgid "This gets the SELinux security context of the daemon."
10044 #: ../src/guestfs-actions.pod:2103
10046 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10051 #: ../src/guestfs-actions.pod:2111
10052 msgid "guestfs_getxattr"
10057 #: ../src/guestfs-actions.pod:2113
10061 " guestfs_getxattr (guestfs_h *g,\n"
10062 " const char *path,\n"
10063 " const char *name,\n"
10064 " size_t *size_r);\n"
10070 #: ../src/guestfs-actions.pod:2119
10072 "Get a single extended attribute from file C<path> named C<name>. This call "
10073 "follows symlinks. If you want to lookup an extended attribute for the "
10074 "symlink itself, use C<guestfs_lgetxattr>."
10079 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:3277
10081 "Normally it is better to get all extended attributes from a file in one go "
10082 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10083 "implementations are buggy and do not provide a way to list out attributes. "
10084 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10085 "extended attributes you want in advance and call this function."
10090 #: ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:3284
10091 #: ../fish/guestfish-actions.pod:1441 ../fish/guestfish-actions.pod:2272
10093 "Extended attribute values are blobs of binary data. If there is no extended "
10094 "attribute named C<name>, this returns an error."
10099 #: ../src/guestfs-actions.pod:2133
10100 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10105 #: ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:2326
10106 #: ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:4994
10107 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5201
10109 "This function returns a buffer, or NULL on error. The size of the returned "
10110 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10115 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:3293
10116 msgid "(Added in 1.7.24)"
10121 #: ../src/guestfs-actions.pod:2141
10122 msgid "guestfs_getxattrs"
10127 #: ../src/guestfs-actions.pod:2143
10130 " struct guestfs_xattr_list *\n"
10131 " guestfs_getxattrs (guestfs_h *g,\n"
10132 " const char *path);\n"
10138 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
10140 "This call lists the extended attributes of the file or directory C<path>."
10145 #: ../src/guestfs-actions.pod:2150 ../fish/guestfish-actions.pod:1453
10147 "At the system call level, this is a combination of the L<listxattr(2)> and "
10148 "L<getxattr(2)> calls."
10153 #: ../src/guestfs-actions.pod:2153
10154 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10159 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3305
10160 #: ../src/guestfs-actions.pod:3956
10162 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10163 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10168 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3309
10169 #: ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3510
10170 #: ../src/guestfs-actions.pod:5374 ../src/guestfs-actions.pod:5813
10171 #: ../src/guestfs-actions.pod:7148
10172 msgid "(Added in 1.0.59)"
10177 #: ../src/guestfs-actions.pod:2161
10178 msgid "guestfs_glob_expand"
10183 #: ../src/guestfs-actions.pod:2163
10187 " guestfs_glob_expand (guestfs_h *g,\n"
10188 " const char *pattern);\n"
10194 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1462
10196 "This command searches for all the pathnames matching C<pattern> according to "
10197 "the wildcard expansion rules used by the shell."
10202 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
10204 "If no paths match, then this returns an empty list (note: not an error)."
10209 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1469
10211 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10212 "GLOB_BRACE>. See that manual page for more details."
10217 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:5978
10218 #: ../src/guestfs-actions.pod:5995
10219 msgid "(Added in 1.0.50)"
10224 #: ../src/guestfs-actions.pod:2184
10225 msgid "guestfs_grep"
10230 #: ../src/guestfs-actions.pod:2186
10234 " guestfs_grep (guestfs_h *g,\n"
10235 " const char *regex,\n"
10236 " const char *path);\n"
10242 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1477
10243 msgid "This calls the external C<grep> program and returns the matching lines."
10248 #: ../src/guestfs-actions.pod:2203
10249 msgid "guestfs_grepi"
10254 #: ../src/guestfs-actions.pod:2205
10258 " guestfs_grepi (guestfs_h *g,\n"
10259 " const char *regex,\n"
10260 " const char *path);\n"
10266 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1487
10268 "This calls the external C<grep -i> program and returns the matching lines."
10273 #: ../src/guestfs-actions.pod:2222
10274 msgid "guestfs_grub_install"
10279 #: ../src/guestfs-actions.pod:2224
10283 " guestfs_grub_install (guestfs_h *g,\n"
10284 " const char *root,\n"
10285 " const char *device);\n"
10291 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
10293 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10294 "the root directory being C<root>."
10299 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1500
10301 "Note: If grub-install reports the error \"No suitable drive was found in the "
10302 "generated device map.\" it may be that you need to create a C</boot/grub/"
10303 "device.map> file first that contains the mapping between grub device names "
10304 "and Linux device names. It is usually sufficient to create a file "
10310 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1507
10313 " (hd0) /dev/vda\n"
10319 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
10320 msgid "replacing C</dev/vda> with the name of the installation device."
10325 #: ../src/guestfs-actions.pod:2245
10326 msgid "(Added in 1.0.17)"
10331 #: ../src/guestfs-actions.pod:2247
10332 msgid "guestfs_head"
10337 #: ../src/guestfs-actions.pod:2249
10341 " guestfs_head (guestfs_h *g,\n"
10342 " const char *path);\n"
10348 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1515
10350 "This command returns up to the first 10 lines of a file as a list of strings."
10355 #: ../src/guestfs-actions.pod:2265
10356 msgid "guestfs_head_n"
10361 #: ../src/guestfs-actions.pod:2267
10365 " guestfs_head_n (guestfs_h *g,\n"
10367 " const char *path);\n"
10373 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
10375 "If the parameter C<nrlines> is a positive number, this returns the first "
10376 "C<nrlines> lines of the file C<path>."
10381 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1528
10383 "If the parameter C<nrlines> is a negative number, this returns lines from "
10384 "the file C<path>, excluding the last C<nrlines> lines."
10389 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6275
10390 #: ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:4188
10391 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10396 #: ../src/guestfs-actions.pod:2289
10397 msgid "guestfs_hexdump"
10402 #: ../src/guestfs-actions.pod:2291
10406 " guestfs_hexdump (guestfs_h *g,\n"
10407 " const char *path);\n"
10413 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1540
10415 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10416 "readable, canonical hex dump of the file."
10421 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6059
10422 #: ../src/guestfs-actions.pod:6114
10423 msgid "(Added in 1.0.22)"
10428 #: ../src/guestfs-actions.pod:2306
10429 msgid "guestfs_initrd_cat"
10434 #: ../src/guestfs-actions.pod:2308
10438 " guestfs_initrd_cat (guestfs_h *g,\n"
10439 " const char *initrdpath,\n"
10440 " const char *filename,\n"
10441 " size_t *size_r);\n"
10447 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1550
10449 "This command unpacks the file C<filename> from the initrd file called "
10450 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10456 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1554
10458 "For example, in guestfish you could use the following command to examine the "
10459 "boot script (usually called C</init>) contained in a Linux initrd or "
10465 #: ../src/guestfs-actions.pod:2322 ../fish/guestfish-actions.pod:1558
10468 " initrd-cat /boot/initrd-<version>.img init\n"
10474 #: ../src/guestfs-actions.pod:2324
10475 msgid "See also C<guestfs_initrd_list>."
10480 #: ../src/guestfs-actions.pod:2335
10481 msgid "guestfs_initrd_list"
10486 #: ../src/guestfs-actions.pod:2337
10490 " guestfs_initrd_list (guestfs_h *g,\n"
10491 " const char *path);\n"
10497 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1569
10498 msgid "This command lists out files contained in an initrd."
10503 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
10505 "The files are listed without any initial C</> character. The files are "
10506 "listed in the order they appear (not necessarily alphabetical). Directory "
10507 "names are listed as separate items."
10512 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1575
10514 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10515 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10521 #: ../src/guestfs-actions.pod:2357
10522 msgid "guestfs_inotify_add_watch"
10527 #: ../src/guestfs-actions.pod:2359
10531 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10532 " const char *path,\n"
10539 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1583
10540 msgid "Watch C<path> for the events listed in C<mask>."
10545 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
10547 "Note that if C<path> is a directory then events within that directory are "
10548 "watched, but this does I<not> happen recursively (in subdirectories)."
10553 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1589
10555 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10556 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10561 #: ../src/guestfs-actions.pod:2378
10562 msgid "guestfs_inotify_close"
10567 #: ../src/guestfs-actions.pod:2380
10571 " guestfs_inotify_close (guestfs_h *g);\n"
10577 #: ../src/guestfs-actions.pod:2383 ../fish/guestfish-actions.pod:1597
10579 "This closes the inotify handle which was previously opened by inotify_init. "
10580 "It removes all watches, throws away any pending events, and deallocates all "
10586 #: ../src/guestfs-actions.pod:2391
10587 msgid "guestfs_inotify_files"
10592 #: ../src/guestfs-actions.pod:2393
10596 " guestfs_inotify_files (guestfs_h *g);\n"
10602 #: ../src/guestfs-actions.pod:2396
10604 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10605 "returns a list of pathnames of objects that were touched. The returned "
10606 "pathnames are sorted and deduplicated."
10611 #: ../src/guestfs-actions.pod:2406
10612 msgid "guestfs_inotify_init"
10617 #: ../src/guestfs-actions.pod:2408
10621 " guestfs_inotify_init (guestfs_h *g,\n"
10622 " int maxevents);\n"
10628 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1613
10630 "This command creates a new inotify handle. The inotify subsystem can be "
10631 "used to notify events which happen to objects in the guest filesystem."
10636 #: ../src/guestfs-actions.pod:2416
10638 "C<maxevents> is the maximum number of events which will be queued up between "
10639 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10640 "passed as C<0>, then the kernel (or previously set) default is used. For "
10641 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10642 "throws away events, but records the fact that it threw them away by setting "
10643 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10644 "C<guestfs_inotify_read>)."
10649 #: ../src/guestfs-actions.pod:2426
10651 "Before any events are generated, you have to add some watches to the "
10652 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10653 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10658 #: ../src/guestfs-actions.pod:2432
10660 "Queued up events should be read periodically by calling "
10661 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10662 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10663 "often enough then you risk the internal queue overflowing."
10668 #: ../src/guestfs-actions.pod:2439
10670 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10671 "This also removes any watches automatically."
10676 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1644
10678 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10679 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10680 "that there is one global inotify handle per libguestfs instance."
10685 #: ../src/guestfs-actions.pod:2452
10686 msgid "guestfs_inotify_read"
10691 #: ../src/guestfs-actions.pod:2454
10694 " struct guestfs_inotify_event_list *\n"
10695 " guestfs_inotify_read (guestfs_h *g);\n"
10701 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
10703 "Return the complete queue of events that have happened since the previous "
10709 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1656
10710 msgid "If no events have happened, this returns an empty list."
10715 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
10717 "I<Note>: In order to make sure that all events have been read, you must call "
10718 "this function repeatedly until it returns an empty list. The reason is that "
10719 "the call will read events up to the maximum appliance-to-host message size "
10720 "and leave remaining events in the queue."
10725 #: ../src/guestfs-actions.pod:2468
10727 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10728 "there was an error. I<The caller must call "
10729 "C<guestfs_free_inotify_event_list> after use>."
10734 #: ../src/guestfs-actions.pod:2474
10735 msgid "guestfs_inotify_rm_watch"
10740 #: ../src/guestfs-actions.pod:2476
10744 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10751 #: ../src/guestfs-actions.pod:2480
10753 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10758 #: ../src/guestfs-actions.pod:2487
10759 msgid "guestfs_inspect_get_arch"
10764 #: ../src/guestfs-actions.pod:2489
10768 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10769 " const char *root);\n"
10775 #: ../src/guestfs-actions.pod:2493 ../src/guestfs-actions.pod:2516
10776 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2623
10777 #: ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2672
10778 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2730
10779 #: ../src/guestfs-actions.pod:2759 ../src/guestfs-actions.pod:2790
10780 #: ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2876
10781 #: ../src/guestfs-actions.pod:2899
10783 "This function should only be called with a root device string as returned by "
10784 "C<guestfs_inspect_os>."
10789 #: ../src/guestfs-actions.pod:2496
10791 "This returns the architecture of the inspected operating system. The "
10792 "possible return values are listed under C<guestfs_file_architecture>."
10797 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1682
10799 "If the architecture could not be determined, then the string C<unknown> is "
10805 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2584
10806 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2660
10807 #: ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2777
10808 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:2820
10809 #: ../src/guestfs-actions.pod:2863 ../src/guestfs-actions.pod:2886
10810 #: ../src/guestfs-actions.pod:2992 ../src/guestfs-actions.pod:3033
10811 #: ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1759
10812 #: ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1813
10813 #: ../fish/guestfish-actions.pod:1877 ../fish/guestfish-actions.pod:1901
10814 #: ../fish/guestfish-actions.pod:1918 ../fish/guestfish-actions.pod:1931
10815 #: ../fish/guestfish-actions.pod:1966 ../fish/guestfish-actions.pod:1982
10816 #: ../fish/guestfish-actions.pod:2081 ../fish/guestfish-actions.pod:2115
10817 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10822 #: ../src/guestfs-actions.pod:2510
10823 msgid "guestfs_inspect_get_distro"
10828 #: ../src/guestfs-actions.pod:2512
10832 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10833 " const char *root);\n"
10839 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
10841 "This returns the distro (distribution) of the inspected operating system."
10846 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1697
10847 msgid "Currently defined distros are:"
10852 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1701
10853 msgid "\"archlinux\""
10858 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
10859 msgid "Arch Linux."
10864 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
10870 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
10876 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
10882 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
10888 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
10894 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
10900 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
10901 msgid "\"linuxmint\""
10906 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
10907 msgid "Linux Mint."
10912 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
10913 msgid "\"mandriva\""
10918 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
10924 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
10930 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
10936 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
10942 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
10948 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
10949 msgid "\"redhat-based\""
10954 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
10955 msgid "Some Red Hat-derived distro."
10960 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
10966 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
10967 msgid "Red Hat Enterprise Linux and some derivatives."
10972 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
10978 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
10984 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2854
10985 #: ../fish/guestfish-actions.pod:1745 ../fish/guestfish-actions.pod:1957
10986 msgid "\"unknown\""
10991 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1747
10992 msgid "The distro could not be determined."
10997 #: ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:2846
10998 #: ../fish/guestfish-actions.pod:1749 ../fish/guestfish-actions.pod:1949
10999 msgid "\"windows\""
11004 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1751
11006 "Windows does not have distributions. This string is returned if the OS type "
11012 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2860
11013 #: ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1963
11015 "Future versions of libguestfs may return other strings here. The caller "
11016 "should be prepared to handle any string."
11021 #: ../src/guestfs-actions.pod:2591
11022 msgid "guestfs_inspect_get_filesystems"
11027 #: ../src/guestfs-actions.pod:2593
11031 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11032 " const char *root);\n"
11038 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1768
11040 "This returns a list of all the filesystems that we think are associated with "
11041 "this operating system. This includes the root filesystem, other ordinary "
11042 "filesystems, and non-mounted devices like swap partitions."
11047 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1773
11049 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11050 "to be shared between operating systems."
11055 #: ../src/guestfs-actions.pod:2608
11057 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11058 "C<guestfs_inspect_get_mountpoints>."
11063 #: ../src/guestfs-actions.pod:2617
11064 msgid "guestfs_inspect_get_hostname"
11069 #: ../src/guestfs-actions.pod:2619
11073 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11074 " const char *root);\n"
11080 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
11082 "This function returns the hostname of the operating system as found by "
11083 "inspection of the guest's configuration files."
11088 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1789
11090 "If the hostname could not be determined, then the string C<unknown> is "
11096 #: ../src/guestfs-actions.pod:2637
11097 msgid "(Added in 1.7.9)"
11102 #: ../src/guestfs-actions.pod:2639
11103 msgid "guestfs_inspect_get_major_version"
11108 #: ../src/guestfs-actions.pod:2641
11112 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11113 " const char *root);\n"
11119 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
11121 "This returns the major version number of the inspected operating system."
11126 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1804
11128 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11129 "popular public names used by the operating system. Notably the operating "
11130 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11131 "1). You can find out the real versions corresponding to releases of Windows "
11132 "by consulting Wikipedia or MSDN."
11137 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2678
11138 #: ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1825
11139 msgid "If the version could not be determined, then C<0> is returned."
11144 #: ../src/guestfs-actions.pod:2666
11145 msgid "guestfs_inspect_get_minor_version"
11150 #: ../src/guestfs-actions.pod:2668
11154 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11155 " const char *root);\n"
11161 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1822
11163 "This returns the minor version number of the inspected operating system."
11168 #: ../src/guestfs-actions.pod:2680
11170 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11171 "C<guestfs_inspect_get_major_version>."
11176 #: ../src/guestfs-actions.pod:2687
11177 msgid "guestfs_inspect_get_mountpoints"
11182 #: ../src/guestfs-actions.pod:2689
11186 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11187 " const char *root);\n"
11192 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
11194 "This returns a hash of where we think the filesystems associated with this "
11195 "operating system should be mounted. Callers should note that this is at "
11196 "best an educated guess made by reading configuration files such as C</etc/"
11197 "fstab>. I<In particular note> that this may return filesystems which are "
11198 "non-existent or not mountable and callers should be prepared to handle or "
11199 "ignore failures if they try to mount them."
11204 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1846
11206 "Each element in the returned hashtable has a key which is the path of the "
11207 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11208 "mounted there (eg. C</dev/sda1>)."
11213 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1851
11215 "Non-mounted devices such as swap devices are I<not> returned in this list."
11220 #: ../src/guestfs-actions.pod:2713
11222 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11223 "C<guestfs_inspect_get_filesystems>."
11228 #: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:3362
11229 #: ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:6416
11231 "This function returns a NULL-terminated array of strings, or NULL if there "
11232 "was an error. The array of strings will always have length C<2n+1>, where "
11233 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11234 "caller must free the strings and the array after use>."
11239 #: ../src/guestfs-actions.pod:2724
11240 msgid "guestfs_inspect_get_package_format"
11245 #: ../src/guestfs-actions.pod:2726
11249 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11250 " const char *root);\n"
11256 #: ../src/guestfs-actions.pod:2733
11258 "This function and C<guestfs_inspect_get_package_management> return the "
11259 "package format and package management tool used by the inspected operating "
11260 "system. For example for Fedora these functions would return C<rpm> (package "
11261 "format) and C<yum> (package management)."
11266 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1870
11268 "This returns the string C<unknown> if we could not determine the package "
11269 "format I<or> if the operating system does not have a real packaging system "
11275 #: ../src/guestfs-actions.pod:2743 ../fish/guestfish-actions.pod:1874
11277 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11278 "Future versions of libguestfs may return other strings."
11283 #: ../src/guestfs-actions.pod:2751 ../src/guestfs-actions.pod:2782
11284 msgid "(Added in 1.7.5)"
11289 #: ../src/guestfs-actions.pod:2753
11290 msgid "guestfs_inspect_get_package_management"
11295 #: ../src/guestfs-actions.pod:2755
11299 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11300 " const char *root);\n"
11306 #: ../src/guestfs-actions.pod:2762
11308 "C<guestfs_inspect_get_package_format> and this function return the package "
11309 "format and package management tool used by the inspected operating system. "
11310 "For example for Fedora these functions would return C<rpm> (package format) "
11311 "and C<yum> (package management)."
11316 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1892
11318 "This returns the string C<unknown> if we could not determine the package "
11319 "management tool I<or> if the operating system does not have a real packaging "
11320 "system (eg. Windows)."
11325 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1896
11327 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11328 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11329 "libguestfs may return other strings."
11334 #: ../src/guestfs-actions.pod:2784
11335 msgid "guestfs_inspect_get_product_name"
11340 #: ../src/guestfs-actions.pod:2786
11344 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11345 " const char *root);\n"
11351 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1910
11353 "This returns the product name of the inspected operating system. The "
11354 "product name is generally some freeform string which can be displayed to the "
11355 "user, but should not be parsed by programs."
11360 #: ../src/guestfs-actions.pod:2798 ../fish/guestfish-actions.pod:1915
11362 "If the product name could not be determined, then the string C<unknown> is "
11368 #: ../src/guestfs-actions.pod:2808
11369 msgid "guestfs_inspect_get_roots"
11374 #: ../src/guestfs-actions.pod:2810
11378 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11384 #: ../src/guestfs-actions.pod:2813
11386 "This function is a convenient way to get the list of root devices, as "
11387 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11388 "the whole inspection process."
11393 #: ../src/guestfs-actions.pod:2817
11395 "This returns an empty list if either no root devices were found or the "
11396 "caller has not called C<guestfs_inspect_os>."
11401 #: ../src/guestfs-actions.pod:2826
11402 msgid "(Added in 1.7.3)"
11407 #: ../src/guestfs-actions.pod:2828
11408 msgid "guestfs_inspect_get_type"
11413 #: ../src/guestfs-actions.pod:2830
11417 " guestfs_inspect_get_type (guestfs_h *g,\n"
11418 " const char *root);\n"
11424 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1940
11426 "This returns the type of the inspected operating system. Currently defined "
11432 #: ../src/guestfs-actions.pod:2842 ../fish/guestfish-actions.pod:1945
11438 #: ../src/guestfs-actions.pod:2844 ../fish/guestfish-actions.pod:1947
11439 msgid "Any Linux-based operating system."
11444 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1951
11445 msgid "Any Microsoft Windows operating system."
11450 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1953
11451 msgid "\"freebsd\""
11456 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1955
11462 #: ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1959
11463 msgid "The operating system type could not be determined."
11468 #: ../src/guestfs-actions.pod:2870
11469 msgid "guestfs_inspect_get_windows_systemroot"
11474 #: ../src/guestfs-actions.pod:2872
11478 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11479 " const char *root);\n"
11485 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1975
11487 "This returns the Windows systemroot of the inspected guest. The systemroot "
11488 "is a directory path such as C</WINDOWS>."
11493 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1978
11495 "This call assumes that the guest is Windows and that the systemroot could be "
11496 "determined by inspection. If this is not the case then an error is returned."
11501 #: ../src/guestfs-actions.pod:2891
11502 msgid "(Added in 1.5.25)"
11507 #: ../src/guestfs-actions.pod:2893
11508 msgid "guestfs_inspect_list_applications"
11513 #: ../src/guestfs-actions.pod:2895
11516 " struct guestfs_application_list *\n"
11517 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11518 " const char *root);\n"
11524 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1991
11525 msgid "Return the list of applications installed in the operating system."
11530 #: ../src/guestfs-actions.pod:2904
11532 "I<Note:> This call works differently from other parts of the inspection "
11533 "API. You have to call C<guestfs_inspect_os>, then "
11534 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11535 "this. Listing applications is a significantly more difficult operation "
11536 "which requires access to the full filesystem. Also note that unlike the "
11537 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11538 "the libguestfs handle, this call actually reads parts of the mounted "
11539 "filesystems during the call."
11544 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2003
11546 "This returns an empty list if the inspection code was not able to determine "
11547 "the list of applications."
11552 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2006
11553 msgid "The application structure contains the following fields:"
11558 #: ../src/guestfs-actions.pod:2921 ../fish/guestfish-actions.pod:2010
11559 msgid "C<app_name>"
11564 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
11566 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11567 "guests, this is the package name."
11572 #: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2015
11573 msgid "C<app_display_name>"
11578 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
11580 "The display name of the application, sometimes localized to the install "
11581 "language of the guest operating system."
11586 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2020
11588 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11589 "to display something can use C<app_name> instead."
11594 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2023
11595 msgid "C<app_epoch>"
11600 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
11602 "For package managers which use epochs, this contains the epoch of the "
11603 "package (an integer). If unavailable, this is returned as C<0>."
11608 #: ../src/guestfs-actions.pod:2939 ../fish/guestfish-actions.pod:2028
11609 msgid "C<app_version>"
11614 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
11616 "The version string of the application or package. If unavailable this is "
11617 "returned as an empty string C<\"\">."
11622 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2033
11623 msgid "C<app_release>"
11628 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2035
11630 "The release string of the application or package, for package managers that "
11631 "use this. If unavailable this is returned as an empty string C<\"\">."
11636 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2039
11637 msgid "C<app_install_path>"
11642 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2041
11644 "The installation path of the application (on operating systems such as "
11645 "Windows which use installation paths). This path is in the format used by "
11646 "the guest operating system, it is not a libguestfs path."
11651 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2046
11652 msgid "If unavailable this is returned as an empty string C<\"\">."
11657 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2048
11658 msgid "C<app_trans_path>"
11663 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
11665 "The install path translated into a libguestfs path. If unavailable this is "
11666 "returned as an empty string C<\"\">."
11671 #: ../src/guestfs-actions.pod:2964 ../fish/guestfish-actions.pod:2053
11672 msgid "C<app_publisher>"
11677 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2055
11679 "The name of the publisher of the application, for package managers that use "
11680 "this. If unavailable this is returned as an empty string C<\"\">."
11685 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2059
11691 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
11693 "The URL (eg. upstream URL) of the application. If unavailable this is "
11694 "returned as an empty string C<\"\">."
11699 #: ../src/guestfs-actions.pod:2975 ../fish/guestfish-actions.pod:2064
11700 msgid "C<app_source_package>"
11705 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
11707 "For packaging systems which support this, the name of the source package. "
11708 "If unavailable this is returned as an empty string C<\"\">."
11713 #: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2069
11714 msgid "C<app_summary>"
11719 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
11721 "A short (usually one line) description of the application or package. If "
11722 "unavailable this is returned as an empty string C<\"\">."
11727 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2074
11728 msgid "C<app_description>"
11733 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2076
11735 "A longer description of the application or package. If unavailable this is "
11736 "returned as an empty string C<\"\">."
11741 #: ../src/guestfs-actions.pod:2994
11743 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11744 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11750 #: ../src/guestfs-actions.pod:2998
11751 msgid "(Added in 1.7.8)"
11756 #: ../src/guestfs-actions.pod:3000
11757 msgid "guestfs_inspect_os"
11762 #: ../src/guestfs-actions.pod:3002
11766 " guestfs_inspect_os (guestfs_h *g);\n"
11772 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2087
11774 "This function uses other libguestfs functions and certain heuristics to "
11775 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11776 "for operating systems."
11781 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2091
11782 msgid "The list returned is empty if no operating systems were found."
11787 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2093
11789 "If one operating system was found, then this returns a list with a single "
11790 "element, which is the name of the root filesystem of this operating system. "
11791 "It is also possible for this function to return a list containing more than "
11792 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11793 "element being the root filesystem of one of the operating systems."
11798 #: ../src/guestfs-actions.pod:3018
11800 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11801 "functions in order to query further information about each operating system, "
11802 "such as the name and version."
11807 #: ../src/guestfs-actions.pod:3023
11809 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11810 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11811 "the contents. This should be called with no disks currently mounted. The "
11812 "function may also use Augeas, so any existing Augeas handle will be closed."
11817 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2111
11819 "This function cannot decrypt encrypted disks. The caller must do that first "
11820 "(supplying the necessary keys) if the disk is encrypted."
11825 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3320
11826 #: ../src/guestfs-actions.pod:3382
11827 msgid "See also C<guestfs_list_filesystems>."
11832 #: ../src/guestfs-actions.pod:3043
11833 msgid "guestfs_is_blockdev"
11838 #: ../src/guestfs-actions.pod:3045
11842 " guestfs_is_blockdev (guestfs_h *g,\n"
11843 " const char *path);\n"
11849 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2123
11851 "This returns C<true> if and only if there is a block device with the given "
11857 #: ../src/guestfs-actions.pod:3052 ../src/guestfs-actions.pod:3081
11858 #: ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3126
11859 #: ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3198
11860 #: ../src/guestfs-actions.pod:3213
11861 msgid "See also C<guestfs_stat>."
11866 #: ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3085
11867 #: ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3202
11868 #: ../src/guestfs-actions.pod:3217
11869 msgid "(Added in 1.5.10)"
11874 #: ../src/guestfs-actions.pod:3058
11875 msgid "guestfs_is_busy"
11880 #: ../src/guestfs-actions.pod:3060
11884 " guestfs_is_busy (guestfs_h *g);\n"
11890 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2132
11892 "This returns true iff this handle is busy processing a command (in the "
11898 #: ../src/guestfs-actions.pod:3072
11899 msgid "guestfs_is_chardev"
11904 #: ../src/guestfs-actions.pod:3074
11908 " guestfs_is_chardev (guestfs_h *g,\n"
11909 " const char *path);\n"
11915 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2141
11917 "This returns C<true> if and only if there is a character device with the "
11918 "given C<path> name."
11923 #: ../src/guestfs-actions.pod:3087
11924 msgid "guestfs_is_config"
11929 #: ../src/guestfs-actions.pod:3089
11933 " guestfs_is_config (guestfs_h *g);\n"
11939 #: ../src/guestfs-actions.pod:3092 ../fish/guestfish-actions.pod:2150
11941 "This returns true iff this handle is being configured (in the C<CONFIG> "
11947 #: ../src/guestfs-actions.pod:3101
11948 msgid "guestfs_is_dir"
11953 #: ../src/guestfs-actions.pod:3103
11957 " guestfs_is_dir (guestfs_h *g,\n"
11958 " const char *path);\n"
11964 #: ../src/guestfs-actions.pod:3107 ../fish/guestfish-actions.pod:2159
11966 "This returns C<true> if and only if there is a directory with the given "
11967 "C<path> name. Note that it returns false for other objects like files."
11972 #: ../src/guestfs-actions.pod:3117
11973 msgid "guestfs_is_fifo"
11978 #: ../src/guestfs-actions.pod:3119
11982 " guestfs_is_fifo (guestfs_h *g,\n"
11983 " const char *path);\n"
11989 #: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2169
11991 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11992 "given C<path> name."
11997 #: ../src/guestfs-actions.pod:3132
11998 msgid "guestfs_is_file"
12003 #: ../src/guestfs-actions.pod:3134
12007 " guestfs_is_file (guestfs_h *g,\n"
12008 " const char *path);\n"
12014 #: ../src/guestfs-actions.pod:3138 ../fish/guestfish-actions.pod:2178
12016 "This returns C<true> if and only if there is a regular file with the given "
12017 "C<path> name. Note that it returns false for other objects like directories."
12022 #: ../src/guestfs-actions.pod:3148
12023 msgid "guestfs_is_launching"
12028 #: ../src/guestfs-actions.pod:3150
12032 " guestfs_is_launching (guestfs_h *g);\n"
12038 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2188
12040 "This returns true iff this handle is launching the subprocess (in the "
12041 "C<LAUNCHING> state)."
12046 #: ../src/guestfs-actions.pod:3162
12047 msgid "guestfs_is_lv"
12052 #: ../src/guestfs-actions.pod:3164
12056 " guestfs_is_lv (guestfs_h *g,\n"
12057 " const char *device);\n"
12063 #: ../src/guestfs-actions.pod:3168 ../fish/guestfish-actions.pod:2197
12065 "This command tests whether C<device> is a logical volume, and returns true "
12066 "iff this is the case."
12071 #: ../src/guestfs-actions.pod:3175
12072 msgid "guestfs_is_ready"
12077 #: ../src/guestfs-actions.pod:3177
12081 " guestfs_is_ready (guestfs_h *g);\n"
12087 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2204
12089 "This returns true iff this handle is ready to accept commands (in the "
12095 #: ../src/guestfs-actions.pod:3189
12096 msgid "guestfs_is_socket"
12101 #: ../src/guestfs-actions.pod:3191
12105 " guestfs_is_socket (guestfs_h *g,\n"
12106 " const char *path);\n"
12112 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2213
12114 "This returns C<true> if and only if there is a Unix domain socket with the "
12115 "given C<path> name."
12120 #: ../src/guestfs-actions.pod:3204
12121 msgid "guestfs_is_symlink"
12126 #: ../src/guestfs-actions.pod:3206
12130 " guestfs_is_symlink (guestfs_h *g,\n"
12131 " const char *path);\n"
12137 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2222
12139 "This returns C<true> if and only if there is a symbolic link with the given "
12145 #: ../src/guestfs-actions.pod:3219
12146 msgid "guestfs_kill_subprocess"
12151 #: ../src/guestfs-actions.pod:3221
12155 " guestfs_kill_subprocess (guestfs_h *g);\n"
12161 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2231
12162 msgid "This kills the qemu subprocess. You should never need to call this."
12167 #: ../src/guestfs-actions.pod:3230
12168 msgid "guestfs_launch"
12173 #: ../src/guestfs-actions.pod:3232
12177 " guestfs_launch (guestfs_h *g);\n"
12183 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2239
12185 "Internally libguestfs is implemented by running a virtual machine using "
12191 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2242
12193 "You should call this after configuring the handle (eg. adding drives) but "
12194 "before performing any actions."
12199 #: ../src/guestfs-actions.pod:3245
12200 msgid "guestfs_lchown"
12205 #: ../src/guestfs-actions.pod:3247
12209 " guestfs_lchown (guestfs_h *g,\n"
12212 " const char *path);\n"
12218 #: ../src/guestfs-actions.pod:3253
12220 "Change the file owner to C<owner> and group to C<group>. This is like "
12221 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12222 "changed, not the target."
12227 #: ../src/guestfs-actions.pod:3265
12228 msgid "guestfs_lgetxattr"
12233 #: ../src/guestfs-actions.pod:3267
12237 " guestfs_lgetxattr (guestfs_h *g,\n"
12238 " const char *path,\n"
12239 " const char *name,\n"
12240 " size_t *size_r);\n"
12246 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2261
12248 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12249 "is a symlink, then this call returns an extended attribute from the symlink."
12254 #: ../src/guestfs-actions.pod:3287
12255 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12260 #: ../src/guestfs-actions.pod:3295
12261 msgid "guestfs_lgetxattrs"
12266 #: ../src/guestfs-actions.pod:3297
12269 " struct guestfs_xattr_list *\n"
12270 " guestfs_lgetxattrs (guestfs_h *g,\n"
12271 " const char *path);\n"
12277 #: ../src/guestfs-actions.pod:3301
12279 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12280 "then it returns the extended attributes of the link itself."
12285 #: ../src/guestfs-actions.pod:3311
12286 msgid "guestfs_list_devices"
12291 #: ../src/guestfs-actions.pod:3313
12295 " guestfs_list_devices (guestfs_h *g);\n"
12301 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2289
12302 msgid "List all the block devices."
12307 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2291
12308 msgid "The full block device names are returned, eg. C</dev/sda>."
12313 #: ../src/guestfs-actions.pod:3328
12314 msgid "guestfs_list_filesystems"
12319 #: ../src/guestfs-actions.pod:3330
12323 " guestfs_list_filesystems (guestfs_h *g);\n"
12329 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2299
12331 "This inspection command looks for filesystems on partitions, block devices "
12332 "and logical volumes, returning a list of devices containing filesystems and "
12338 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2303
12340 "The return value is a hash, where the keys are the devices containing "
12341 "filesystems, and the values are the filesystem types. For example:"
12346 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2307
12349 " \"/dev/sda1\" => \"ntfs\"\n"
12350 " \"/dev/sda2\" => \"ext2\"\n"
12351 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12352 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12358 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2312
12360 "The value can have the special value \"unknown\", meaning the content of the "
12361 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12366 #: ../src/guestfs-actions.pod:3350
12368 "This command runs other libguestfs commands, which might include "
12369 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12370 "soon after launch and only when nothing is mounted."
12375 #: ../src/guestfs-actions.pod:3354
12377 "Not all of the filesystems returned will be mountable. In particular, swap "
12378 "partitions are returned in the list. Also this command does not check that "
12379 "each filesystem found is valid and mountable, and some filesystems might be "
12380 "mountable but require special options. Filesystems may not all belong to a "
12381 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12386 #: ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:4961
12387 msgid "(Added in 1.5.15)"
12392 #: ../src/guestfs-actions.pod:3370
12393 msgid "guestfs_list_partitions"
12398 #: ../src/guestfs-actions.pod:3372
12402 " guestfs_list_partitions (guestfs_h *g);\n"
12408 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2332
12409 msgid "List all the partitions detected on all block devices."
12414 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2334
12415 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12420 #: ../src/guestfs-actions.pod:3379
12422 "This does not return logical volumes. For that you will need to call "
12428 #: ../src/guestfs-actions.pod:3390
12434 #: ../src/guestfs-actions.pod:3392
12438 " guestfs_ll (guestfs_h *g,\n"
12439 " const char *directory);\n"
12445 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2345
12447 "List the files in C<directory> (relative to the root directory, there is no "
12448 "cwd) in the format of 'ls -la'."
12453 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:2348
12455 "This command is mostly useful for interactive sessions. It is I<not> "
12456 "intended that you try to parse the output string."
12461 #: ../src/guestfs-actions.pod:3407
12467 #: ../src/guestfs-actions.pod:3409
12471 " guestfs_ln (guestfs_h *g,\n"
12472 " const char *target,\n"
12473 " const char *linkname);\n"
12479 #: ../src/guestfs-actions.pod:3414 ../fish/guestfish-actions.pod:2355
12480 msgid "This command creates a hard link using the C<ln> command."
12485 #: ../src/guestfs-actions.pod:3420
12486 msgid "guestfs_ln_f"
12491 #: ../src/guestfs-actions.pod:3422
12495 " guestfs_ln_f (guestfs_h *g,\n"
12496 " const char *target,\n"
12497 " const char *linkname);\n"
12503 #: ../src/guestfs-actions.pod:3427 ../fish/guestfish-actions.pod:2361
12505 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12506 "option removes the link (C<linkname>) if it exists already."
12511 #: ../src/guestfs-actions.pod:3434
12512 msgid "guestfs_ln_s"
12517 #: ../src/guestfs-actions.pod:3436
12521 " guestfs_ln_s (guestfs_h *g,\n"
12522 " const char *target,\n"
12523 " const char *linkname);\n"
12529 #: ../src/guestfs-actions.pod:3441 ../fish/guestfish-actions.pod:2368
12530 msgid "This command creates a symbolic link using the C<ln -s> command."
12535 #: ../src/guestfs-actions.pod:3447
12536 msgid "guestfs_ln_sf"
12541 #: ../src/guestfs-actions.pod:3449
12545 " guestfs_ln_sf (guestfs_h *g,\n"
12546 " const char *target,\n"
12547 " const char *linkname);\n"
12553 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2374
12555 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12556 "option removes the link (C<linkname>) if it exists already."
12561 #: ../src/guestfs-actions.pod:3461
12562 msgid "guestfs_lremovexattr"
12567 #: ../src/guestfs-actions.pod:3463
12571 " guestfs_lremovexattr (guestfs_h *g,\n"
12572 " const char *xattr,\n"
12573 " const char *path);\n"
12579 #: ../src/guestfs-actions.pod:3468
12581 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12582 "link, then it removes an extended attribute of the link itself."
12587 #: ../src/guestfs-actions.pod:3476
12593 #: ../src/guestfs-actions.pod:3478
12597 " guestfs_ls (guestfs_h *g,\n"
12598 " const char *directory);\n"
12604 #: ../src/guestfs-actions.pod:3482 ../fish/guestfish-actions.pod:2389
12606 "List the files in C<directory> (relative to the root directory, there is no "
12607 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12612 #: ../src/guestfs-actions.pod:3486
12614 "This command is mostly useful for interactive sessions. Programs should "
12615 "probably use C<guestfs_readdir> instead."
12620 #: ../src/guestfs-actions.pod:3495
12621 msgid "guestfs_lsetxattr"
12626 #: ../src/guestfs-actions.pod:3497
12630 " guestfs_lsetxattr (guestfs_h *g,\n"
12631 " const char *xattr,\n"
12632 " const char *val,\n"
12634 " const char *path);\n"
12640 #: ../src/guestfs-actions.pod:3504
12642 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12643 "then it sets an extended attribute of the link itself."
12648 #: ../src/guestfs-actions.pod:3512
12649 msgid "guestfs_lstat"
12654 #: ../src/guestfs-actions.pod:3514
12657 " struct guestfs_stat *\n"
12658 " guestfs_lstat (guestfs_h *g,\n"
12659 " const char *path);\n"
12665 #: ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:6015
12666 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:4023
12667 msgid "Returns file information for the given C<path>."
12672 #: ../src/guestfs-actions.pod:3520
12674 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12675 "link, then the link is stat-ed, not the file it refers to."
12680 #: ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:2414
12681 msgid "This is the same as the C<lstat(2)> system call."
12686 #: ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:6019
12688 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12689 "error. I<The caller must call C<guestfs_free_stat> after use>."
12694 #: ../src/guestfs-actions.pod:3530 ../src/guestfs-actions.pod:6023
12695 #: ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6422
12696 msgid "(Added in 0.9.2)"
12701 #: ../src/guestfs-actions.pod:3532
12702 msgid "guestfs_lstatlist"
12707 #: ../src/guestfs-actions.pod:3534
12710 " struct guestfs_stat_list *\n"
12711 " guestfs_lstatlist (guestfs_h *g,\n"
12712 " const char *path,\n"
12713 " char *const *names);\n"
12719 #: ../src/guestfs-actions.pod:3539
12721 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12722 "files, where all files are in the directory C<path>. C<names> is the list "
12723 "of files from this directory."
12728 #: ../src/guestfs-actions.pod:3543 ../fish/guestfish-actions.pod:2424
12730 "On return you get a list of stat structs, with a one-to-one correspondence "
12731 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12732 "then the C<ino> field of that structure is set to C<-1>."
12737 #: ../src/guestfs-actions.pod:3548
12739 "This call is intended for programs that want to efficiently list a directory "
12740 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12741 "for a similarly efficient call for getting extended attributes. Very long "
12742 "directory listings might cause the protocol message size to be exceeded, "
12743 "causing this call to fail. The caller must split up such requests into "
12744 "smaller groups of names."
12749 #: ../src/guestfs-actions.pod:3556
12751 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12752 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12757 #: ../src/guestfs-actions.pod:3562
12758 msgid "guestfs_luks_add_key"
12763 #: ../src/guestfs-actions.pod:3564
12767 " guestfs_luks_add_key (guestfs_h *g,\n"
12768 " const char *device,\n"
12769 " const char *key,\n"
12770 " const char *newkey,\n"
12777 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2441
12779 "This command adds a new key on LUKS device C<device>. C<key> is any "
12780 "existing key, and is used to access the device. C<newkey> is the new key to "
12781 "add. C<keyslot> is the key slot that will be replaced."
12786 #: ../src/guestfs-actions.pod:3576
12788 "Note that if C<keyslot> already contains a key, then this command will "
12789 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12794 #: ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3622
12795 #: ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3665
12796 #: ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:3716
12798 "This function takes a key or passphrase parameter which could contain "
12799 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12805 #: ../src/guestfs-actions.pod:3586 ../src/guestfs-actions.pod:3626
12806 #: ../src/guestfs-actions.pod:3649 ../src/guestfs-actions.pod:3669
12807 msgid "(Added in 1.5.2)"
12812 #: ../src/guestfs-actions.pod:3588
12813 msgid "guestfs_luks_close"
12818 #: ../src/guestfs-actions.pod:3590
12822 " guestfs_luks_close (guestfs_h *g,\n"
12823 " const char *device);\n"
12829 #: ../src/guestfs-actions.pod:3594
12831 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12832 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12833 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12834 "underlying block device."
12839 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3701
12840 #: ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:3770
12841 #: ../src/guestfs-actions.pod:3818
12842 msgid "(Added in 1.5.1)"
12847 #: ../src/guestfs-actions.pod:3604
12848 msgid "guestfs_luks_format"
12853 #: ../src/guestfs-actions.pod:3606
12857 " guestfs_luks_format (guestfs_h *g,\n"
12858 " const char *device,\n"
12859 " const char *key,\n"
12866 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2467
12868 "This command erases existing data on C<device> and formats the device as a "
12869 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12870 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12875 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642
12876 #: ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:4712
12877 #: ../src/guestfs-actions.pod:5475 ../src/guestfs-actions.pod:5850
12878 #: ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5899
12879 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:2475
12880 #: ../fish/guestfish-actions.pod:2488 ../fish/guestfish-actions.pod:2572
12881 #: ../fish/guestfish-actions.pod:3135 ../fish/guestfish-actions.pod:3642
12882 #: ../fish/guestfish-actions.pod:3922 ../fish/guestfish-actions.pod:3938
12883 #: ../fish/guestfish-actions.pod:3953 ../fish/guestfish-actions.pod:4668
12885 "B<This command is dangerous. Without careful use you can easily destroy all "
12891 #: ../src/guestfs-actions.pod:3628
12892 msgid "guestfs_luks_format_cipher"
12897 #: ../src/guestfs-actions.pod:3630
12901 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12902 " const char *device,\n"
12903 " const char *key,\n"
12905 " const char *cipher);\n"
12911 #: ../src/guestfs-actions.pod:3637
12913 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12914 "set the C<cipher> used."
12919 #: ../src/guestfs-actions.pod:3651
12920 msgid "guestfs_luks_kill_slot"
12925 #: ../src/guestfs-actions.pod:3653
12929 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12930 " const char *device,\n"
12931 " const char *key,\n"
12938 #: ../src/guestfs-actions.pod:3659 ../fish/guestfish-actions.pod:2495
12940 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12941 "device C<device>. C<key> must be one of the I<other> keys."
12946 #: ../src/guestfs-actions.pod:3671
12947 msgid "guestfs_luks_open"
12952 #: ../src/guestfs-actions.pod:3673
12956 " guestfs_luks_open (guestfs_h *g,\n"
12957 " const char *device,\n"
12958 " const char *key,\n"
12959 " const char *mapname);\n"
12965 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2506
12967 "This command opens a block device which has been encrypted according to the "
12968 "Linux Unified Key Setup (LUKS) standard."
12973 #: ../src/guestfs-actions.pod:3682 ../fish/guestfish-actions.pod:2509
12974 msgid "C<device> is the encrypted block device or partition."
12979 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
12981 "The caller must supply one of the keys associated with the LUKS block "
12982 "device, in the C<key> parameter."
12987 #: ../src/guestfs-actions.pod:3687 ../fish/guestfish-actions.pod:2514
12989 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12990 "writes to this block device are decrypted from and encrypted to the "
12991 "underlying C<device> respectively."
12996 #: ../src/guestfs-actions.pod:3691
12998 "If this block device contains LVM volume groups, then calling "
12999 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13005 #: ../src/guestfs-actions.pod:3703
13006 msgid "guestfs_luks_open_ro"
13011 #: ../src/guestfs-actions.pod:3705
13015 " guestfs_luks_open_ro (guestfs_h *g,\n"
13016 " const char *device,\n"
13017 " const char *key,\n"
13018 " const char *mapname);\n"
13024 #: ../src/guestfs-actions.pod:3711
13026 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13032 #: ../src/guestfs-actions.pod:3722
13033 msgid "guestfs_lvcreate"
13038 #: ../src/guestfs-actions.pod:3724
13042 " guestfs_lvcreate (guestfs_h *g,\n"
13043 " const char *logvol,\n"
13044 " const char *volgroup,\n"
13051 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2539
13053 "This creates an LVM logical volume called C<logvol> on the volume group "
13054 "C<volgroup>, with C<size> megabytes."
13059 #: ../src/guestfs-actions.pod:3737
13060 msgid "guestfs_lvm_canonical_lv_name"
13065 #: ../src/guestfs-actions.pod:3739
13069 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13070 " const char *lvname);\n"
13076 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2546
13078 "This converts alternative naming schemes for LVs that you might find to the "
13079 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13085 #: ../src/guestfs-actions.pod:3747 ../fish/guestfish-actions.pod:2550
13087 "This command returns an error if the C<lvname> parameter does not refer to a "
13093 #: ../src/guestfs-actions.pod:3750
13094 msgid "See also C<guestfs_is_lv>."
13099 #: ../src/guestfs-actions.pod:3755
13100 msgid "(Added in 1.5.24)"
13105 #: ../src/guestfs-actions.pod:3757
13106 msgid "guestfs_lvm_clear_filter"
13111 #: ../src/guestfs-actions.pod:3759
13115 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13121 #: ../src/guestfs-actions.pod:3762
13123 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13124 "see every block device."
13129 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3807
13130 #: ../fish/guestfish-actions.pod:2562 ../fish/guestfish-actions.pod:2593
13132 "This command also clears the LVM cache and performs a volume group scan."
13137 #: ../src/guestfs-actions.pod:3772
13138 msgid "guestfs_lvm_remove_all"
13143 #: ../src/guestfs-actions.pod:3774
13147 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13153 #: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2569
13155 "This command removes all LVM logical volumes, volume groups and physical "
13161 #: ../src/guestfs-actions.pod:3787
13162 msgid "guestfs_lvm_set_filter"
13167 #: ../src/guestfs-actions.pod:3789
13171 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13172 " char *const *devices);\n"
13178 #: ../src/guestfs-actions.pod:3793 ../fish/guestfish-actions.pod:2579
13180 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13181 "block devices in the list C<devices>, and will ignore all other attached "
13187 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2583
13189 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13190 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13191 "there are two types of duplication possible: either cloned PVs/VGs which "
13192 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13193 "same name. In normal operation you cannot create this situation, but you "
13194 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13195 "inside the LVM metadata."
13200 #: ../src/guestfs-actions.pod:3810 ../fish/guestfish-actions.pod:2596
13201 msgid "You can filter whole block devices or individual partitions."
13206 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
13208 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13209 "filesystem), even if you are not filtering out that VG."
13214 #: ../src/guestfs-actions.pod:3820
13215 msgid "guestfs_lvremove"
13220 #: ../src/guestfs-actions.pod:3822
13224 " guestfs_lvremove (guestfs_h *g,\n"
13225 " const char *device);\n"
13231 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2606
13233 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13234 "LV, such as C</dev/VG/LV>."
13239 #: ../src/guestfs-actions.pod:3829 ../fish/guestfish-actions.pod:2609
13241 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13247 #: ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:5058
13248 #: ../src/guestfs-actions.pod:6798
13249 msgid "(Added in 1.0.13)"
13254 #: ../src/guestfs-actions.pod:3836
13255 msgid "guestfs_lvrename"
13260 #: ../src/guestfs-actions.pod:3838
13264 " guestfs_lvrename (guestfs_h *g,\n"
13265 " const char *logvol,\n"
13266 " const char *newlogvol);\n"
13272 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2616
13273 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13278 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:6811
13279 msgid "(Added in 1.0.83)"
13284 #: ../src/guestfs-actions.pod:3849
13285 msgid "guestfs_lvresize"
13290 #: ../src/guestfs-actions.pod:3851
13294 " guestfs_lvresize (guestfs_h *g,\n"
13295 " const char *device,\n"
13302 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2622
13304 "This resizes (expands or shrinks) an existing LVM logical volume to "
13305 "C<mbytes>. When reducing, data in the reduced part is lost."
13310 #: ../src/guestfs-actions.pod:3864
13311 msgid "guestfs_lvresize_free"
13316 #: ../src/guestfs-actions.pod:3866
13320 " guestfs_lvresize_free (guestfs_h *g,\n"
13321 " const char *lv,\n"
13328 #: ../src/guestfs-actions.pod:3871 ../fish/guestfish-actions.pod:2630
13330 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13331 "remaining free space in the volume group. Commonly you would call this with "
13332 "pc = 100 which expands the logical volume as much as possible, using all "
13333 "remaining free space in the volume group."
13338 #: ../src/guestfs-actions.pod:3879
13339 msgid "(Added in 1.3.3)"
13344 #: ../src/guestfs-actions.pod:3881
13345 msgid "guestfs_lvs"
13350 #: ../src/guestfs-actions.pod:3883
13354 " guestfs_lvs (guestfs_h *g);\n"
13360 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2640
13362 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13368 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2643
13370 "This returns a list of the logical volume device names (eg. C</dev/"
13371 "VolGroup00/LogVol00>)."
13376 #: ../src/guestfs-actions.pod:3892
13377 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13382 #: ../src/guestfs-actions.pod:3900
13383 msgid "guestfs_lvs_full"
13388 #: ../src/guestfs-actions.pod:3902
13391 " struct guestfs_lvm_lv_list *\n"
13392 " guestfs_lvs_full (guestfs_h *g);\n"
13398 #: ../src/guestfs-actions.pod:3905 ../fish/guestfish-actions.pod:2652
13400 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13401 "(8)> command. The \"full\" version includes all fields."
13406 #: ../src/guestfs-actions.pod:3908
13408 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13409 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13414 #: ../src/guestfs-actions.pod:3914
13415 msgid "guestfs_lvuuid"
13420 #: ../src/guestfs-actions.pod:3916
13424 " guestfs_lvuuid (guestfs_h *g,\n"
13425 " const char *device);\n"
13431 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2659
13432 msgid "This command returns the UUID of the LVM LV C<device>."
13437 #: ../src/guestfs-actions.pod:3927
13438 msgid "guestfs_lxattrlist"
13443 #: ../src/guestfs-actions.pod:3929
13446 " struct guestfs_xattr_list *\n"
13447 " guestfs_lxattrlist (guestfs_h *g,\n"
13448 " const char *path,\n"
13449 " char *const *names);\n"
13455 #: ../src/guestfs-actions.pod:3934 ../fish/guestfish-actions.pod:2665
13457 "This call allows you to get the extended attributes of multiple files, where "
13458 "all files are in the directory C<path>. C<names> is the list of files from "
13464 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2669
13466 "On return you get a flat list of xattr structs which must be interpreted "
13467 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13468 "C<attrval> in this struct is zero-length to indicate there was an error "
13469 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13470 "number (the number of following attributes for this file, which could be C<"
13471 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13472 "for the first named file. This repeats for the second and subsequent files."
13477 #: ../src/guestfs-actions.pod:3948
13479 "This call is intended for programs that want to efficiently list a directory "
13480 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13481 "a similarly efficient call for getting standard stats. Very long directory "
13482 "listings might cause the protocol message size to be exceeded, causing this "
13483 "call to fail. The caller must split up such requests into smaller groups of "
13489 #: ../src/guestfs-actions.pod:3962
13490 msgid "guestfs_mkdir"
13495 #: ../src/guestfs-actions.pod:3964
13499 " guestfs_mkdir (guestfs_h *g,\n"
13500 " const char *path);\n"
13506 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2691
13507 msgid "Create a directory named C<path>."
13512 #: ../src/guestfs-actions.pod:3974
13513 msgid "guestfs_mkdir_mode"
13518 #: ../src/guestfs-actions.pod:3976
13522 " guestfs_mkdir_mode (guestfs_h *g,\n"
13523 " const char *path,\n"
13530 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2697
13532 "This command creates a directory, setting the initial permissions of the "
13533 "directory to C<mode>."
13538 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2700
13540 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13541 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13547 #: ../src/guestfs-actions.pod:3988
13548 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13553 #: ../src/guestfs-actions.pod:3994
13554 msgid "guestfs_mkdir_p"
13559 #: ../src/guestfs-actions.pod:3996
13563 " guestfs_mkdir_p (guestfs_h *g,\n"
13564 " const char *path);\n"
13570 #: ../src/guestfs-actions.pod:4000 ../fish/guestfish-actions.pod:2710
13572 "Create a directory named C<path>, creating any parent directories as "
13573 "necessary. This is like the C<mkdir -p> shell command."
13578 #: ../src/guestfs-actions.pod:4007
13579 msgid "guestfs_mkdtemp"
13584 #: ../src/guestfs-actions.pod:4009
13588 " guestfs_mkdtemp (guestfs_h *g,\n"
13589 " const char *template);\n"
13595 #: ../src/guestfs-actions.pod:4013 ../fish/guestfish-actions.pod:2717
13597 "This command creates a temporary directory. The C<template> parameter "
13598 "should be a full pathname for the temporary directory name with the final "
13599 "six characters being \"XXXXXX\"."
13604 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2722
13606 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13607 "being suitable for Windows filesystems."
13612 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2725
13613 msgid "The name of the temporary directory that was created is returned."
13618 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2728
13619 msgid "The temporary directory is created with mode 0700 and is owned by root."
13624 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2731
13626 "The caller is responsible for deleting the temporary directory and its "
13627 "contents after use."
13632 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2734
13633 msgid "See also: L<mkdtemp(3)>"
13638 #: ../src/guestfs-actions.pod:4037
13639 msgid "guestfs_mke2fs_J"
13644 #: ../src/guestfs-actions.pod:4039
13648 " guestfs_mke2fs_J (guestfs_h *g,\n"
13649 " const char *fstype,\n"
13650 " int blocksize,\n"
13651 " const char *device,\n"
13652 " const char *journal);\n"
13658 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2740
13660 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13661 "C<journal>. It is equivalent to the command:"
13666 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2744
13669 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13675 #: ../src/guestfs-actions.pod:4052
13676 msgid "See also C<guestfs_mke2journal>."
13681 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4074
13682 #: ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4108
13683 #: ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4136
13684 #: ../src/guestfs-actions.pod:4195 ../src/guestfs-actions.pod:4448
13685 msgid "(Added in 1.0.68)"
13690 #: ../src/guestfs-actions.pod:4058
13691 msgid "guestfs_mke2fs_JL"
13696 #: ../src/guestfs-actions.pod:4060
13700 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13701 " const char *fstype,\n"
13702 " int blocksize,\n"
13703 " const char *device,\n"
13704 " const char *label);\n"
13710 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2752
13712 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13713 "the journal labeled C<label>."
13718 #: ../src/guestfs-actions.pod:4070
13719 msgid "See also C<guestfs_mke2journal_L>."
13724 #: ../src/guestfs-actions.pod:4076
13725 msgid "guestfs_mke2fs_JU"
13730 #: ../src/guestfs-actions.pod:4078
13734 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13735 " const char *fstype,\n"
13736 " int blocksize,\n"
13737 " const char *device,\n"
13738 " const char *uuid);\n"
13744 #: ../src/guestfs-actions.pod:4085 ../fish/guestfish-actions.pod:2761
13746 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13747 "the journal with UUID C<uuid>."
13752 #: ../src/guestfs-actions.pod:4088
13753 msgid "See also C<guestfs_mke2journal_U>."
13758 #: ../src/guestfs-actions.pod:4094
13759 msgid "guestfs_mke2journal"
13764 #: ../src/guestfs-actions.pod:4096
13768 " guestfs_mke2journal (guestfs_h *g,\n"
13769 " int blocksize,\n"
13770 " const char *device);\n"
13776 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2770
13778 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13784 #: ../src/guestfs-actions.pod:4104 ../fish/guestfish-actions.pod:2773
13787 " mke2fs -O journal_dev -b blocksize device\n"
13793 #: ../src/guestfs-actions.pod:4110
13794 msgid "guestfs_mke2journal_L"
13799 #: ../src/guestfs-actions.pod:4112
13803 " guestfs_mke2journal_L (guestfs_h *g,\n"
13804 " int blocksize,\n"
13805 " const char *label,\n"
13806 " const char *device);\n"
13812 #: ../src/guestfs-actions.pod:4118 ../fish/guestfish-actions.pod:2779
13813 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13818 #: ../src/guestfs-actions.pod:4124
13819 msgid "guestfs_mke2journal_U"
13824 #: ../src/guestfs-actions.pod:4126
13828 " guestfs_mke2journal_U (guestfs_h *g,\n"
13829 " int blocksize,\n"
13830 " const char *uuid,\n"
13831 " const char *device);\n"
13837 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2785
13838 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13843 #: ../src/guestfs-actions.pod:4138
13844 msgid "guestfs_mkfifo"
13849 #: ../src/guestfs-actions.pod:4140
13853 " guestfs_mkfifo (guestfs_h *g,\n"
13855 " const char *path);\n"
13861 #: ../src/guestfs-actions.pod:4145
13863 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13864 "is just a convenient wrapper around C<guestfs_mknod>."
13869 #: ../src/guestfs-actions.pod:4155
13870 msgid "guestfs_mkfs"
13875 #: ../src/guestfs-actions.pod:4157
13879 " guestfs_mkfs (guestfs_h *g,\n"
13880 " const char *fstype,\n"
13881 " const char *device);\n"
13887 #: ../src/guestfs-actions.pod:4162 ../fish/guestfish-actions.pod:2801
13889 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13890 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13895 #: ../src/guestfs-actions.pod:4170
13896 msgid "guestfs_mkfs_b"
13901 #: ../src/guestfs-actions.pod:4172
13905 " guestfs_mkfs_b (guestfs_h *g,\n"
13906 " const char *fstype,\n"
13907 " int blocksize,\n"
13908 " const char *device);\n"
13914 #: ../src/guestfs-actions.pod:4178
13916 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13917 "block size of the resulting filesystem. Supported block sizes depend on the "
13918 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13923 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4225
13924 #: ../fish/guestfish-actions.pod:2814 ../fish/guestfish-actions.pod:2841
13926 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13932 #: ../src/guestfs-actions.pod:4188 ../fish/guestfish-actions.pod:2817
13934 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13939 #: ../src/guestfs-actions.pod:4197
13940 msgid "guestfs_mkfs_opts"
13945 #: ../src/guestfs-actions.pod:4199
13949 " guestfs_mkfs_opts (guestfs_h *g,\n"
13950 " const char *fstype,\n"
13951 " const char *device,\n"
13958 #: ../src/guestfs-actions.pod:4210
13961 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13967 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2828
13969 "This function creates a filesystem on C<device>. The filesystem type is "
13970 "C<fstype>, for example C<ext3>."
13975 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2835
13976 msgid "C<blocksize>"
13981 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2837
13983 "The filesystem block size. Supported block sizes depend on the filesystem "
13984 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13989 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2844
13990 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13994 #: ../src/guestfs-actions.pod:4234
13995 msgid "(Added in 1.7.19)"
14000 #: ../src/guestfs-actions.pod:4236
14001 msgid "guestfs_mkfs_opts_va"
14006 #: ../src/guestfs-actions.pod:4238
14010 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14011 " const char *fstype,\n"
14012 " const char *device,\n"
14013 " va_list args);\n"
14019 #: ../src/guestfs-actions.pod:4244
14020 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14025 #: ../src/guestfs-actions.pod:4248
14026 msgid "guestfs_mkfs_opts_argv"
14031 #: ../src/guestfs-actions.pod:4250
14035 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14036 " const char *fstype,\n"
14037 " const char *device,\n"
14038 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14044 #: ../src/guestfs-actions.pod:4256
14045 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14050 #: ../src/guestfs-actions.pod:4260
14051 msgid "guestfs_mkmountpoint"
14056 #: ../src/guestfs-actions.pod:4262
14060 " guestfs_mkmountpoint (guestfs_h *g,\n"
14061 " const char *exemptpath);\n"
14067 #: ../src/guestfs-actions.pod:4266
14069 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14070 "that can be used to create extra mountpoints before mounting the first "
14076 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2858
14078 "These calls are I<only> necessary in some very limited circumstances, mainly "
14079 "the case where you want to mount a mix of unrelated and/or read-only "
14080 "filesystems together."
14085 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2862
14087 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14088 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14089 "inside that. You can unpack this as follows in guestfish:"
14094 #: ../src/guestfs-actions.pod:4279 ../fish/guestfish-actions.pod:2867
14097 " add-ro Fedora-11-i686-Live.iso\n"
14099 " mkmountpoint /cd\n"
14100 " mkmountpoint /sqsh\n"
14101 " mkmountpoint /ext3fs\n"
14102 " mount /dev/sda /cd\n"
14103 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14104 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14110 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2876
14111 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14116 #: ../src/guestfs-actions.pod:4290
14118 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14119 "may get unexpected errors if you try to mix these calls. It is safest to "
14120 "manually unmount filesystems and remove mountpoints after use."
14125 #: ../src/guestfs-actions.pod:4294
14127 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14128 "first, so for this to work for manual mountpoints, you must ensure that the "
14129 "innermost mountpoints have the longest pathnames, as in the example code "
14135 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2887
14137 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14142 #: ../src/guestfs-actions.pod:4301
14144 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14145 "means that C<guestfs_umount_all> is called when the handle is closed which "
14146 "can also trigger these issues."
14151 #: ../src/guestfs-actions.pod:4307 ../src/guestfs-actions.pod:4566
14152 #: ../src/guestfs-actions.pod:5459
14153 msgid "(Added in 1.0.62)"
14158 #: ../src/guestfs-actions.pod:4309
14159 msgid "guestfs_mknod"
14164 #: ../src/guestfs-actions.pod:4311
14168 " guestfs_mknod (guestfs_h *g,\n"
14172 " const char *path);\n"
14178 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2897
14180 "This call creates block or character special devices, or named pipes (FIFOs)."
14185 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2900
14187 "The C<mode> parameter should be the mode, using the standard constants. "
14188 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14189 "used when creating block and character special devices."
14194 #: ../src/guestfs-actions.pod:4326
14196 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14197 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14198 "regular file). These constants are available in the standard Linux header "
14199 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14200 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14201 "the appropriate constant for you."
14206 #: ../src/guestfs-actions.pod:4340
14207 msgid "guestfs_mknod_b"
14212 #: ../src/guestfs-actions.pod:4342
14216 " guestfs_mknod_b (guestfs_h *g,\n"
14220 " const char *path);\n"
14226 #: ../src/guestfs-actions.pod:4349
14228 "This call creates a block device node called C<path> with mode C<mode> and "
14229 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14230 "wrapper around C<guestfs_mknod>."
14235 #: ../src/guestfs-actions.pod:4359
14236 msgid "guestfs_mknod_c"
14241 #: ../src/guestfs-actions.pod:4361
14245 " guestfs_mknod_c (guestfs_h *g,\n"
14249 " const char *path);\n"
14255 #: ../src/guestfs-actions.pod:4368
14257 "This call creates a char device node called C<path> with mode C<mode> and "
14258 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14259 "wrapper around C<guestfs_mknod>."
14264 #: ../src/guestfs-actions.pod:4378
14265 msgid "guestfs_mkswap"
14270 #: ../src/guestfs-actions.pod:4380
14274 " guestfs_mkswap (guestfs_h *g,\n"
14275 " const char *device);\n"
14281 #: ../src/guestfs-actions.pod:4384 ../fish/guestfish-actions.pod:2939
14282 msgid "Create a swap partition on C<device>."
14287 #: ../src/guestfs-actions.pod:4390
14288 msgid "guestfs_mkswap_L"
14293 #: ../src/guestfs-actions.pod:4392
14297 " guestfs_mkswap_L (guestfs_h *g,\n"
14298 " const char *label,\n"
14299 " const char *device);\n"
14305 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2945
14306 msgid "Create a swap partition on C<device> with label C<label>."
14311 #: ../src/guestfs-actions.pod:4399 ../fish/guestfish-actions.pod:2947
14313 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14314 "sda>), just to a partition. This appears to be a limitation of the kernel "
14320 #: ../src/guestfs-actions.pod:4407
14321 msgid "guestfs_mkswap_U"
14326 #: ../src/guestfs-actions.pod:4409
14330 " guestfs_mkswap_U (guestfs_h *g,\n"
14331 " const char *uuid,\n"
14332 " const char *device);\n"
14338 #: ../src/guestfs-actions.pod:4414 ../fish/guestfish-actions.pod:2955
14339 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14344 #: ../src/guestfs-actions.pod:4420
14345 msgid "guestfs_mkswap_file"
14350 #: ../src/guestfs-actions.pod:4422
14354 " guestfs_mkswap_file (guestfs_h *g,\n"
14355 " const char *path);\n"
14361 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:2961
14362 msgid "Create a swap file."
14367 #: ../src/guestfs-actions.pod:4428
14369 "This command just writes a swap file signature to an existing file. To "
14370 "create the file itself, use something like C<guestfs_fallocate>."
14375 #: ../src/guestfs-actions.pod:4435
14376 msgid "guestfs_modprobe"
14381 #: ../src/guestfs-actions.pod:4437
14385 " guestfs_modprobe (guestfs_h *g,\n"
14386 " const char *modulename);\n"
14392 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2970
14393 msgid "This loads a kernel module in the appliance."
14398 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2972
14400 "The kernel module must have been whitelisted when libguestfs was built (see "
14401 "C<appliance/kmod.whitelist.in> in the source)."
14406 #: ../src/guestfs-actions.pod:4450
14407 msgid "guestfs_mount"
14412 #: ../src/guestfs-actions.pod:4452
14416 " guestfs_mount (guestfs_h *g,\n"
14417 " const char *device,\n"
14418 " const char *mountpoint);\n"
14424 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:2979
14426 "Mount a guest disk at a position in the filesystem. Block devices are named "
14427 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14428 "those block devices contain partitions, they will have the usual names (eg. "
14429 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14434 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2985
14436 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14437 "mounted on C</> before others can be mounted. Other filesystems can only be "
14438 "mounted on directories which already exist."
14443 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:2990
14445 "The mounted filesystem is writable, if we have sufficient permissions on the "
14446 "underlying device."
14451 #: ../src/guestfs-actions.pod:4471
14453 "B<Important note:> When you use this call, the filesystem options C<sync> "
14454 "and C<noatime> are set implicitly. This was originally done because we "
14455 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14456 "very large negative performance impact and negligible effect on "
14457 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14458 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14459 "(use an empty string for the first parameter if you don't want any options)."
14464 #: ../src/guestfs-actions.pod:4485
14465 msgid "guestfs_mount_loop"
14470 #: ../src/guestfs-actions.pod:4487
14474 " guestfs_mount_loop (guestfs_h *g,\n"
14475 " const char *file,\n"
14476 " const char *mountpoint);\n"
14482 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:3007
14484 "This command lets you mount C<file> (a filesystem image in a file) on a "
14485 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14491 #: ../src/guestfs-actions.pod:4500
14492 msgid "guestfs_mount_options"
14497 #: ../src/guestfs-actions.pod:4502
14501 " guestfs_mount_options (guestfs_h *g,\n"
14502 " const char *options,\n"
14503 " const char *device,\n"
14504 " const char *mountpoint);\n"
14510 #: ../src/guestfs-actions.pod:4508
14512 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14513 "the mount options as for the L<mount(8)> I<-o> flag."
14518 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3019
14520 "If the C<options> parameter is an empty string, then no options are passed "
14521 "(all options default to whatever the filesystem uses)."
14526 #: ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4532
14527 #: ../src/guestfs-actions.pod:4549
14528 msgid "(Added in 1.0.10)"
14533 #: ../src/guestfs-actions.pod:4520
14534 msgid "guestfs_mount_ro"
14539 #: ../src/guestfs-actions.pod:4522
14543 " guestfs_mount_ro (guestfs_h *g,\n"
14544 " const char *device,\n"
14545 " const char *mountpoint);\n"
14551 #: ../src/guestfs-actions.pod:4527
14553 "This is the same as the C<guestfs_mount> command, but it mounts the "
14554 "filesystem with the read-only (I<-o ro>) flag."
14559 #: ../src/guestfs-actions.pod:4534
14560 msgid "guestfs_mount_vfs"
14565 #: ../src/guestfs-actions.pod:4536
14569 " guestfs_mount_vfs (guestfs_h *g,\n"
14570 " const char *options,\n"
14571 " const char *vfstype,\n"
14572 " const char *device,\n"
14573 " const char *mountpoint);\n"
14579 #: ../src/guestfs-actions.pod:4543
14581 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14582 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14588 #: ../src/guestfs-actions.pod:4551
14589 msgid "guestfs_mountpoints"
14594 #: ../src/guestfs-actions.pod:4553
14598 " guestfs_mountpoints (guestfs_h *g);\n"
14604 #: ../src/guestfs-actions.pod:4556
14606 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14607 "devices. This one returns a hash table (map) of device name to directory "
14608 "where the device is mounted."
14613 #: ../src/guestfs-actions.pod:4568
14614 msgid "guestfs_mounts"
14619 #: ../src/guestfs-actions.pod:4570
14623 " guestfs_mounts (guestfs_h *g);\n"
14629 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3050
14631 "This returns the list of currently mounted filesystems. It returns the list "
14632 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14637 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3053
14638 msgid "Some internal mounts are not shown."
14643 #: ../src/guestfs-actions.pod:4578
14644 msgid "See also: C<guestfs_mountpoints>"
14649 #: ../src/guestfs-actions.pod:4586
14655 #: ../src/guestfs-actions.pod:4588
14659 " guestfs_mv (guestfs_h *g,\n"
14660 " const char *src,\n"
14661 " const char *dest);\n"
14667 #: ../src/guestfs-actions.pod:4593 ../fish/guestfish-actions.pod:3061
14669 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14670 "destination filename or destination directory."
14675 #: ../src/guestfs-actions.pod:4600
14676 msgid "guestfs_ntfs_3g_probe"
14681 #: ../src/guestfs-actions.pod:4602
14685 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14687 " const char *device);\n"
14693 #: ../src/guestfs-actions.pod:4607 ../fish/guestfish-actions.pod:3068
14695 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14696 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14697 "write, and some cannot be mounted at all)."
14702 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3072
14704 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14705 "can be mounted read-write. Set it to false if you want to test if the "
14706 "volume can be mounted read-only."
14711 #: ../src/guestfs-actions.pod:4615 ../fish/guestfish-actions.pod:3076
14713 "The return value is an integer which C<0> if the operation would succeed, or "
14714 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14719 #: ../src/guestfs-actions.pod:4621
14720 msgid "(Added in 1.0.43)"
14725 #: ../src/guestfs-actions.pod:4623
14726 msgid "guestfs_ntfsresize"
14731 #: ../src/guestfs-actions.pod:4625
14735 " guestfs_ntfsresize (guestfs_h *g,\n"
14736 " const char *device);\n"
14742 #: ../src/guestfs-actions.pod:4629 ../fish/guestfish-actions.pod:3084
14744 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14745 "size of the underlying device. See also L<ntfsresize(8)>."
14750 #: ../src/guestfs-actions.pod:4637
14751 msgid "guestfs_ntfsresize_size"
14756 #: ../src/guestfs-actions.pod:4639
14760 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14761 " const char *device,\n"
14762 " int64_t size);\n"
14768 #: ../src/guestfs-actions.pod:4644
14770 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14771 "to specify the new size (in bytes) explicitly."
14776 #: ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:5085
14777 #: ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5407
14778 #: ../src/guestfs-actions.pod:6946
14779 msgid "(Added in 1.3.14)"
14784 #: ../src/guestfs-actions.pod:4651
14785 msgid "guestfs_part_add"
14790 #: ../src/guestfs-actions.pod:4653
14794 " guestfs_part_add (guestfs_h *g,\n"
14795 " const char *device,\n"
14796 " const char *prlogex,\n"
14797 " int64_t startsect,\n"
14798 " int64_t endsect);\n"
14804 #: ../src/guestfs-actions.pod:4660
14806 "This command adds a partition to C<device>. If there is no partition table "
14807 "on the device, call C<guestfs_part_init> first."
14812 #: ../src/guestfs-actions.pod:4663 ../fish/guestfish-actions.pod:3102
14814 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14815 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14816 "C<logical>) and C<e> (or C<extended>) partition types."
14821 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3107
14823 "C<startsect> and C<endsect> are the start and end of the partition in "
14824 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14825 "from the end of the disk (C<-1> is the last sector)."
14830 #: ../src/guestfs-actions.pod:4672
14832 "Creating a partition which covers the whole disk is not so easy. Use "
14833 "C<guestfs_part_disk> to do that."
14838 #: ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4715
14839 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4846
14840 #: ../src/guestfs-actions.pod:4884 ../src/guestfs-actions.pod:4903
14841 #: ../src/guestfs-actions.pod:4943
14842 msgid "(Added in 1.0.78)"
14847 #: ../src/guestfs-actions.pod:4679
14848 msgid "guestfs_part_del"
14853 #: ../src/guestfs-actions.pod:4681
14857 " guestfs_part_del (guestfs_h *g,\n"
14858 " const char *device,\n"
14865 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3118
14866 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14871 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3120
14873 "Note that in the case of MBR partitioning, deleting an extended partition "
14874 "also deletes any logical partitions it contains."
14879 #: ../src/guestfs-actions.pod:4696
14880 msgid "guestfs_part_disk"
14885 #: ../src/guestfs-actions.pod:4698
14889 " guestfs_part_disk (guestfs_h *g,\n"
14890 " const char *device,\n"
14891 " const char *parttype);\n"
14897 #: ../src/guestfs-actions.pod:4703
14899 "This command is simply a combination of C<guestfs_part_init> followed by "
14900 "C<guestfs_part_add> to create a single primary partition covering the whole "
14906 #: ../src/guestfs-actions.pod:4707
14908 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14909 "possible values are described in C<guestfs_part_init>."
14914 #: ../src/guestfs-actions.pod:4717
14915 msgid "guestfs_part_get_bootable"
14920 #: ../src/guestfs-actions.pod:4719
14924 " guestfs_part_get_bootable (guestfs_h *g,\n"
14925 " const char *device,\n"
14932 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3142
14934 "This command returns true if the partition C<partnum> on C<device> has the "
14935 "bootable flag set."
14940 #: ../src/guestfs-actions.pod:4727
14941 msgid "See also C<guestfs_part_set_bootable>."
14946 #: ../src/guestfs-actions.pod:4733
14947 msgid "guestfs_part_get_mbr_id"
14952 #: ../src/guestfs-actions.pod:4735
14956 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14957 " const char *device,\n"
14964 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3151
14966 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14967 "partition C<partnum>."
14972 #: ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4919
14974 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14975 "undefined results for other partition table types (see "
14976 "C<guestfs_part_get_parttype>)."
14981 #: ../src/guestfs-actions.pod:4751
14982 msgid "guestfs_part_get_parttype"
14987 #: ../src/guestfs-actions.pod:4753
14991 " guestfs_part_get_parttype (guestfs_h *g,\n"
14992 " const char *device);\n"
14998 #: ../src/guestfs-actions.pod:4757 ../fish/guestfish-actions.pod:3162
15000 "This command examines the partition table on C<device> and returns the "
15001 "partition table type (format) being used."
15006 #: ../src/guestfs-actions.pod:4760
15008 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15009 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15010 "possible, although unusual. See C<guestfs_part_init> for a full list."
15015 #: ../src/guestfs-actions.pod:4770
15016 msgid "guestfs_part_init"
15021 #: ../src/guestfs-actions.pod:4772
15025 " guestfs_part_init (guestfs_h *g,\n"
15026 " const char *device,\n"
15027 " const char *parttype);\n"
15033 #: ../src/guestfs-actions.pod:4777 ../fish/guestfish-actions.pod:3174
15035 "This creates an empty partition table on C<device> of one of the partition "
15036 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15037 "(for large disks)."
15042 #: ../src/guestfs-actions.pod:4781
15044 "Initially there are no partitions. Following this, you should call "
15045 "C<guestfs_part_add> for each partition required."
15050 #: ../src/guestfs-actions.pod:4784 ../fish/guestfish-actions.pod:3181
15051 msgid "Possible values for C<parttype> are:"
15056 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3185
15057 msgid "B<efi> | B<gpt>"
15062 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3187
15063 msgid "Intel EFI / GPT partition table."
15068 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3189
15070 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15071 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15072 "the C<mbr> format."
15077 #: ../src/guestfs-actions.pod:4796 ../fish/guestfish-actions.pod:3193
15078 msgid "B<mbr> | B<msdos>"
15083 #: ../src/guestfs-actions.pod:4798 ../fish/guestfish-actions.pod:3195
15085 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15086 "Windows. This partition type will B<only> work for device sizes up to 2 "
15087 "TB. For large disks we recommend using C<gpt>."
15092 #: ../src/guestfs-actions.pod:4805 ../fish/guestfish-actions.pod:3202
15094 "Other partition table types that may work but are not supported include:"
15099 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3207
15105 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3209
15106 msgid "AIX disk labels."
15111 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3211
15112 msgid "B<amiga> | B<rdb>"
15117 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
15118 msgid "Amiga \"Rigid Disk Block\" format."
15123 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3215
15129 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3217
15130 msgid "BSD disk labels."
15135 #: ../src/guestfs-actions.pod:4822 ../fish/guestfish-actions.pod:3219
15141 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3221
15142 msgid "DASD, used on IBM mainframes."
15147 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3223
15153 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3225
15154 msgid "MIPS/SGI volumes."
15159 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3227
15165 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3229
15166 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15171 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3231
15177 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3233
15178 msgid "NEC PC-98 format, common in Japan apparently."
15183 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3235
15189 #: ../src/guestfs-actions.pod:4840 ../fish/guestfish-actions.pod:3237
15190 msgid "Sun disk labels."
15195 #: ../src/guestfs-actions.pod:4848
15196 msgid "guestfs_part_list"
15201 #: ../src/guestfs-actions.pod:4850
15204 " struct guestfs_partition_list *\n"
15205 " guestfs_part_list (guestfs_h *g,\n"
15206 " const char *device);\n"
15212 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3245
15214 "This command parses the partition table on C<device> and returns the list of "
15215 "partitions found."
15220 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3248
15221 msgid "The fields in the returned structure are:"
15226 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3252
15227 msgid "B<part_num>"
15232 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3254
15233 msgid "Partition number, counting from 1."
15238 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3256
15239 msgid "B<part_start>"
15244 #: ../src/guestfs-actions.pod:4867
15246 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15247 "the device's sector size, see C<guestfs_blockdev_getss>."
15252 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3261
15253 msgid "B<part_end>"
15258 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3263
15259 msgid "End of the partition in bytes."
15264 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3265
15265 msgid "B<part_size>"
15270 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3267
15271 msgid "Size of the partition in bytes."
15276 #: ../src/guestfs-actions.pod:4880
15278 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15279 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15285 #: ../src/guestfs-actions.pod:4886
15286 msgid "guestfs_part_set_bootable"
15291 #: ../src/guestfs-actions.pod:4888
15295 " guestfs_part_set_bootable (guestfs_h *g,\n"
15296 " const char *device,\n"
15298 " int bootable);\n"
15304 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3275
15306 "This sets the bootable flag on partition numbered C<partnum> on device "
15307 "C<device>. Note that partitions are numbered from 1."
15312 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3278
15314 "The bootable flag is used by some operating systems (notably Windows) to "
15315 "determine which partition to boot from. It is by no means universally "
15321 #: ../src/guestfs-actions.pod:4905
15322 msgid "guestfs_part_set_mbr_id"
15327 #: ../src/guestfs-actions.pod:4907
15331 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15332 " const char *device,\n"
15340 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3286
15342 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15343 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15344 "documentation are in fact hexadecimal numbers, but usually documented "
15345 "without any leading \"0x\" which might be confusing."
15350 #: ../src/guestfs-actions.pod:4927
15351 msgid "guestfs_part_set_name"
15356 #: ../src/guestfs-actions.pod:4929
15360 " guestfs_part_set_name (guestfs_h *g,\n"
15361 " const char *device,\n"
15363 " const char *name);\n"
15369 #: ../src/guestfs-actions.pod:4935 ../fish/guestfish-actions.pod:3300
15371 "This sets the partition name on partition numbered C<partnum> on device "
15372 "C<device>. Note that partitions are numbered from 1."
15377 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3303
15379 "The partition name can only be set on certain types of partition table. "
15380 "This works on C<gpt> but not on C<mbr> partitions."
15385 #: ../src/guestfs-actions.pod:4945
15386 msgid "guestfs_part_to_dev"
15391 #: ../src/guestfs-actions.pod:4947
15395 " guestfs_part_to_dev (guestfs_h *g,\n"
15396 " const char *partition);\n"
15402 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3310
15404 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15405 "partition number, returning the device name (eg. \"/dev/sdb\")."
15410 #: ../src/guestfs-actions.pod:4955
15412 "The named partition must exist, for example as a string returned from "
15413 "C<guestfs_list_partitions>."
15418 #: ../src/guestfs-actions.pod:4963
15419 msgid "guestfs_ping_daemon"
15424 #: ../src/guestfs-actions.pod:4965
15428 " guestfs_ping_daemon (guestfs_h *g);\n"
15434 #: ../src/guestfs-actions.pod:4968 ../fish/guestfish-actions.pod:3321
15436 "This is a test probe into the guestfs daemon running inside the qemu "
15437 "subprocess. Calling this function checks that the daemon responds to the "
15438 "ping message, without affecting the daemon or attached block device(s) in "
15444 #: ../src/guestfs-actions.pod:4977
15445 msgid "guestfs_pread"
15450 #: ../src/guestfs-actions.pod:4979
15454 " guestfs_pread (guestfs_h *g,\n"
15455 " const char *path,\n"
15457 " int64_t offset,\n"
15458 " size_t *size_r);\n"
15464 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3330
15466 "This command lets you read part of a file. It reads C<count> bytes of the "
15467 "file, starting at C<offset>, from file C<path>."
15472 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5015
15473 #: ../fish/guestfish-actions.pod:3333 ../fish/guestfish-actions.pod:3348
15475 "This may read fewer bytes than requested. For further details see the "
15476 "L<pread(2)> system call."
15481 #: ../src/guestfs-actions.pod:4992
15482 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15487 #: ../src/guestfs-actions.pod:5003
15488 msgid "guestfs_pread_device"
15493 #: ../src/guestfs-actions.pod:5005
15497 " guestfs_pread_device (guestfs_h *g,\n"
15498 " const char *device,\n"
15500 " int64_t offset,\n"
15501 " size_t *size_r);\n"
15507 #: ../src/guestfs-actions.pod:5012 ../fish/guestfish-actions.pod:3345
15509 "This command lets you read part of a file. It reads C<count> bytes of "
15510 "C<device>, starting at C<offset>."
15515 #: ../src/guestfs-actions.pod:5018
15516 msgid "See also C<guestfs_pread>."
15521 #: ../src/guestfs-actions.pod:5027
15522 msgid "(Added in 1.5.21)"
15527 #: ../src/guestfs-actions.pod:5029
15528 msgid "guestfs_pvcreate"
15533 #: ../src/guestfs-actions.pod:5031
15537 " guestfs_pvcreate (guestfs_h *g,\n"
15538 " const char *device);\n"
15544 #: ../src/guestfs-actions.pod:5035 ../fish/guestfish-actions.pod:3360
15546 "This creates an LVM physical volume on the named C<device>, where C<device> "
15547 "should usually be a partition name such as C</dev/sda1>."
15552 #: ../src/guestfs-actions.pod:5043
15553 msgid "guestfs_pvremove"
15558 #: ../src/guestfs-actions.pod:5045
15562 " guestfs_pvremove (guestfs_h *g,\n"
15563 " const char *device);\n"
15569 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3368
15571 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15577 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3371
15579 "The implementation uses the C<pvremove> command which refuses to wipe "
15580 "physical volumes that contain any volume groups, so you have to remove those "
15586 #: ../src/guestfs-actions.pod:5060
15587 msgid "guestfs_pvresize"
15592 #: ../src/guestfs-actions.pod:5062
15596 " guestfs_pvresize (guestfs_h *g,\n"
15597 " const char *device);\n"
15603 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3379
15605 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15606 "the new size of the underlying device."
15611 #: ../src/guestfs-actions.pod:5073
15612 msgid "guestfs_pvresize_size"
15617 #: ../src/guestfs-actions.pod:5075
15621 " guestfs_pvresize_size (guestfs_h *g,\n"
15622 " const char *device,\n"
15623 " int64_t size);\n"
15629 #: ../src/guestfs-actions.pod:5080
15631 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15632 "specify the new size (in bytes) explicitly."
15637 #: ../src/guestfs-actions.pod:5087
15638 msgid "guestfs_pvs"
15643 #: ../src/guestfs-actions.pod:5089
15647 " guestfs_pvs (guestfs_h *g);\n"
15653 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3393
15655 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15661 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3396
15663 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15669 #: ../src/guestfs-actions.pod:5098
15670 msgid "See also C<guestfs_pvs_full>."
15675 #: ../src/guestfs-actions.pod:5106
15676 msgid "guestfs_pvs_full"
15681 #: ../src/guestfs-actions.pod:5108
15684 " struct guestfs_lvm_pv_list *\n"
15685 " guestfs_pvs_full (guestfs_h *g);\n"
15691 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3405
15693 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15694 "(8)> command. The \"full\" version includes all fields."
15699 #: ../src/guestfs-actions.pod:5114
15701 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15702 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15707 #: ../src/guestfs-actions.pod:5120
15708 msgid "guestfs_pvuuid"
15713 #: ../src/guestfs-actions.pod:5122
15717 " guestfs_pvuuid (guestfs_h *g,\n"
15718 " const char *device);\n"
15724 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3412
15725 msgid "This command returns the UUID of the LVM PV C<device>."
15730 #: ../src/guestfs-actions.pod:5133
15731 msgid "guestfs_pwrite"
15736 #: ../src/guestfs-actions.pod:5135
15740 " guestfs_pwrite (guestfs_h *g,\n"
15741 " const char *path,\n"
15742 " const char *content,\n"
15743 " size_t content_size,\n"
15744 " int64_t offset);\n"
15750 #: ../src/guestfs-actions.pod:5142 ../fish/guestfish-actions.pod:3418
15752 "This command writes to part of a file. It writes the data buffer C<content> "
15753 "to the file C<path> starting at offset C<offset>."
15758 #: ../src/guestfs-actions.pod:5145 ../fish/guestfish-actions.pod:3421
15760 "This command implements the L<pwrite(2)> system call, and like that system "
15761 "call it may not write the full data requested. The return value is the "
15762 "number of bytes that were actually written to the file. This could even be "
15763 "0, although short writes are unlikely for regular files in ordinary "
15769 #: ../src/guestfs-actions.pod:5151
15770 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15775 #: ../src/guestfs-actions.pod:5160
15776 msgid "guestfs_pwrite_device"
15781 #: ../src/guestfs-actions.pod:5162
15785 " guestfs_pwrite_device (guestfs_h *g,\n"
15786 " const char *device,\n"
15787 " const char *content,\n"
15788 " size_t content_size,\n"
15789 " int64_t offset);\n"
15795 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3436
15797 "This command writes to part of a device. It writes the data buffer "
15798 "C<content> to C<device> starting at offset C<offset>."
15803 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3439
15805 "This command implements the L<pwrite(2)> system call, and like that system "
15806 "call it may not write the full data requested (although short writes to disk "
15807 "devices and partitions are probably impossible with standard Linux kernels)."
15812 #: ../src/guestfs-actions.pod:5177
15813 msgid "See also C<guestfs_pwrite>."
15818 #: ../src/guestfs-actions.pod:5184
15819 msgid "(Added in 1.5.20)"
15824 #: ../src/guestfs-actions.pod:5186
15825 msgid "guestfs_read_file"
15830 #: ../src/guestfs-actions.pod:5188
15834 " guestfs_read_file (guestfs_h *g,\n"
15835 " const char *path,\n"
15836 " size_t *size_r);\n"
15842 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3453
15843 msgid "This calls returns the contents of the file C<path> as a buffer."
15848 #: ../src/guestfs-actions.pod:5196
15850 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15851 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15852 "function is limited in the total size of file that can be handled."
15857 #: ../src/guestfs-actions.pod:5208
15858 msgid "(Added in 1.0.63)"
15863 #: ../src/guestfs-actions.pod:5210
15864 msgid "guestfs_read_lines"
15869 #: ../src/guestfs-actions.pod:5212
15873 " guestfs_read_lines (guestfs_h *g,\n"
15874 " const char *path);\n"
15880 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3470
15882 "The file contents are returned as a list of lines. Trailing C<LF> and "
15883 "C<CRLF> character sequences are I<not> returned."
15888 #: ../src/guestfs-actions.pod:5221
15890 "Note that this function cannot correctly handle binary files (specifically, "
15891 "files containing C<\\0> character which is treated as end of line). For "
15892 "those you need to use the C<guestfs_read_file> function which has a more "
15893 "complex interface."
15898 #: ../src/guestfs-actions.pod:5232
15899 msgid "guestfs_readdir"
15904 #: ../src/guestfs-actions.pod:5234
15907 " struct guestfs_dirent_list *\n"
15908 " guestfs_readdir (guestfs_h *g,\n"
15909 " const char *dir);\n"
15915 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3482
15916 msgid "This returns the list of directory entries in directory C<dir>."
15921 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3484
15923 "All entries in the directory are returned, including C<.> and C<..>. The "
15924 "entries are I<not> sorted, but returned in the same order as the underlying "
15930 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3488
15932 "Also this call returns basic file type information about each file. The "
15933 "C<ftyp> field will contain one of the following characters:"
15938 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3493
15944 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3495
15945 msgid "Block special"
15950 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3497
15956 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
15957 msgid "Char special"
15962 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3501
15968 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3503
15974 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3505
15980 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3507
15981 msgid "FIFO (named pipe)"
15986 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3509
15992 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3511
15993 msgid "Symbolic link"
15998 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3513
16004 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
16005 msgid "Regular file"
16010 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
16016 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3519
16022 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
16028 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3523
16029 msgid "Unknown file type"
16034 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3525
16040 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3527
16042 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16047 #: ../src/guestfs-actions.pod:5288
16049 "This function is primarily intended for use by programs. To get a simple "
16050 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16051 "consumption, use C<guestfs_ll>."
16056 #: ../src/guestfs-actions.pod:5292
16058 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16059 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16064 #: ../src/guestfs-actions.pod:5298
16065 msgid "guestfs_readlink"
16070 #: ../src/guestfs-actions.pod:5300
16074 " guestfs_readlink (guestfs_h *g,\n"
16075 " const char *path);\n"
16081 #: ../src/guestfs-actions.pod:5304 ../fish/guestfish-actions.pod:3540
16082 msgid "This command reads the target of a symbolic link."
16087 #: ../src/guestfs-actions.pod:5311
16088 msgid "guestfs_readlinklist"
16093 #: ../src/guestfs-actions.pod:5313
16097 " guestfs_readlinklist (guestfs_h *g,\n"
16098 " const char *path,\n"
16099 " char *const *names);\n"
16105 #: ../src/guestfs-actions.pod:5318 ../fish/guestfish-actions.pod:3546
16107 "This call allows you to do a C<readlink> operation on multiple files, where "
16108 "all files are in the directory C<path>. C<names> is the list of files from "
16114 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3550
16116 "On return you get a list of strings, with a one-to-one correspondence to the "
16117 "C<names> list. Each string is the value of the symbolic link."
16122 #: ../src/guestfs-actions.pod:5326 ../fish/guestfish-actions.pod:3554
16124 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16125 "result string is the empty string C<\"\">. However the whole operation is "
16126 "completed even if there were C<readlink(2)> errors, and so you can call this "
16127 "function with names where you don't know if they are symbolic links already "
16128 "(albeit slightly less efficient)."
16133 #: ../src/guestfs-actions.pod:5333 ../fish/guestfish-actions.pod:3561
16135 "This call is intended for programs that want to efficiently list a directory "
16136 "contents without making many round-trips. Very long directory listings "
16137 "might cause the protocol message size to be exceeded, causing this call to "
16138 "fail. The caller must split up such requests into smaller groups of names."
16143 #: ../src/guestfs-actions.pod:5346
16144 msgid "guestfs_realpath"
16149 #: ../src/guestfs-actions.pod:5348
16153 " guestfs_realpath (guestfs_h *g,\n"
16154 " const char *path);\n"
16160 #: ../src/guestfs-actions.pod:5352 ../fish/guestfish-actions.pod:3572
16162 "Return the canonicalized absolute pathname of C<path>. The returned path "
16163 "has no C<.>, C<..> or symbolic link path elements."
16168 #: ../src/guestfs-actions.pod:5360
16169 msgid "guestfs_removexattr"
16174 #: ../src/guestfs-actions.pod:5362
16178 " guestfs_removexattr (guestfs_h *g,\n"
16179 " const char *xattr,\n"
16180 " const char *path);\n"
16186 #: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3579
16188 "This call removes the extended attribute named C<xattr> of the file C<path>."
16193 #: ../src/guestfs-actions.pod:5370
16194 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16199 #: ../src/guestfs-actions.pod:5376
16200 msgid "guestfs_resize2fs"
16205 #: ../src/guestfs-actions.pod:5378
16209 " guestfs_resize2fs (guestfs_h *g,\n"
16210 " const char *device);\n"
16216 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3588
16218 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16219 "underlying device."
16224 #: ../src/guestfs-actions.pod:5385
16226 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16227 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16228 "sometimes gives an error about this and sometimes not. In any case, it is "
16229 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16234 #: ../src/guestfs-actions.pod:5395
16235 msgid "guestfs_resize2fs_size"
16240 #: ../src/guestfs-actions.pod:5397
16244 " guestfs_resize2fs_size (guestfs_h *g,\n"
16245 " const char *device,\n"
16246 " int64_t size);\n"
16252 #: ../src/guestfs-actions.pod:5402
16254 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16255 "to specify the new size (in bytes) explicitly."
16260 #: ../src/guestfs-actions.pod:5409
16266 #: ../src/guestfs-actions.pod:5411
16270 " guestfs_rm (guestfs_h *g,\n"
16271 " const char *path);\n"
16277 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3608
16278 msgid "Remove the single file C<path>."
16283 #: ../src/guestfs-actions.pod:5421
16284 msgid "guestfs_rm_rf"
16289 #: ../src/guestfs-actions.pod:5423
16293 " guestfs_rm_rf (guestfs_h *g,\n"
16294 " const char *path);\n"
16300 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3614
16302 "Remove the file or directory C<path>, recursively removing the contents if "
16303 "its a directory. This is like the C<rm -rf> shell command."
16308 #: ../src/guestfs-actions.pod:5435
16309 msgid "guestfs_rmdir"
16314 #: ../src/guestfs-actions.pod:5437
16318 " guestfs_rmdir (guestfs_h *g,\n"
16319 " const char *path);\n"
16325 #: ../src/guestfs-actions.pod:5441 ../fish/guestfish-actions.pod:3622
16326 msgid "Remove the single directory C<path>."
16331 #: ../src/guestfs-actions.pod:5447
16332 msgid "guestfs_rmmountpoint"
16337 #: ../src/guestfs-actions.pod:5449
16341 " guestfs_rmmountpoint (guestfs_h *g,\n"
16342 " const char *exemptpath);\n"
16348 #: ../src/guestfs-actions.pod:5453
16350 "This calls removes a mountpoint that was previously created with "
16351 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16356 #: ../src/guestfs-actions.pod:5461
16357 msgid "guestfs_scrub_device"
16362 #: ../src/guestfs-actions.pod:5463
16366 " guestfs_scrub_device (guestfs_h *g,\n"
16367 " const char *device);\n"
16373 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3636
16375 "This command writes patterns over C<device> to make data retrieval more "
16381 #: ../src/guestfs-actions.pod:5470 ../src/guestfs-actions.pod:5491
16382 #: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:3639
16383 #: ../fish/guestfish-actions.pod:3654 ../fish/guestfish-actions.pod:3667
16385 "It is an interface to the L<scrub(1)> program. See that manual page for "
16391 #: ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5496
16392 #: ../src/guestfs-actions.pod:5515
16393 msgid "(Added in 1.0.52)"
16398 #: ../src/guestfs-actions.pod:5480
16399 msgid "guestfs_scrub_file"
16404 #: ../src/guestfs-actions.pod:5482
16408 " guestfs_scrub_file (guestfs_h *g,\n"
16409 " const char *file);\n"
16415 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3649
16417 "This command writes patterns over a file to make data retrieval more "
16423 #: ../src/guestfs-actions.pod:5489 ../fish/guestfish-actions.pod:3652
16424 msgid "The file is I<removed> after scrubbing."
16429 #: ../src/guestfs-actions.pod:5498
16430 msgid "guestfs_scrub_freespace"
16435 #: ../src/guestfs-actions.pod:5500
16439 " guestfs_scrub_freespace (guestfs_h *g,\n"
16440 " const char *dir);\n"
16446 #: ../src/guestfs-actions.pod:5504
16448 "This command creates the directory C<dir> and then fills it with files until "
16449 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16450 "and deletes them. The intention is to scrub any free space on the partition "
16451 "containing C<dir>."
16456 #: ../src/guestfs-actions.pod:5517
16457 msgid "guestfs_set_append"
16462 #: ../src/guestfs-actions.pod:5519
16466 " guestfs_set_append (guestfs_h *g,\n"
16467 " const char *append);\n"
16473 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3676
16475 "This function is used to add additional options to the guest kernel command "
16481 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3679
16483 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16484 "environment variable."
16489 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3682
16491 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16492 "(libguestfs always adds a few of its own)."
16497 #: ../src/guestfs-actions.pod:5536
16498 msgid "guestfs_set_autosync"
16503 #: ../src/guestfs-actions.pod:5538
16507 " guestfs_set_autosync (guestfs_h *g,\n"
16508 " int autosync);\n"
16514 #: ../src/guestfs-actions.pod:5542
16516 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16517 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
16518 "the handle is closed (also if the program exits without closing handles)."
16523 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3696
16525 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16526 "disabled by default)."
16531 #: ../src/guestfs-actions.pod:5554
16532 msgid "guestfs_set_direct"
16537 #: ../src/guestfs-actions.pod:5556
16541 " guestfs_set_direct (guestfs_h *g,\n"
16548 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3705
16550 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16551 "passed directly through to the appliance once it is launched."
16556 #: ../src/guestfs-actions.pod:5564
16558 "One consequence of this is that log messages aren't caught by the library "
16559 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16565 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3713
16566 msgid "You probably don't want to use this unless you know what you are doing."
16571 #: ../src/guestfs-actions.pod:5571 ../fish/guestfish-actions.pod:3716
16572 msgid "The default is disabled."
16577 #: ../src/guestfs-actions.pod:5577
16578 msgid "guestfs_set_e2label"
16583 #: ../src/guestfs-actions.pod:5579
16587 " guestfs_set_e2label (guestfs_h *g,\n"
16588 " const char *device,\n"
16589 " const char *label);\n"
16595 #: ../src/guestfs-actions.pod:5584 ../fish/guestfish-actions.pod:3722
16597 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16598 "C<label>. Filesystem labels are limited to 16 characters."
16603 #: ../src/guestfs-actions.pod:5588
16605 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16606 "the existing label on a filesystem."
16611 #: ../src/guestfs-actions.pod:5595
16612 msgid "guestfs_set_e2uuid"
16617 #: ../src/guestfs-actions.pod:5597
16621 " guestfs_set_e2uuid (guestfs_h *g,\n"
16622 " const char *device,\n"
16623 " const char *uuid);\n"
16629 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3733
16631 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16632 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16633 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16638 #: ../src/guestfs-actions.pod:5607
16640 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16641 "the existing UUID of a filesystem."
16646 #: ../src/guestfs-actions.pod:5614
16647 msgid "guestfs_set_memsize"
16652 #: ../src/guestfs-actions.pod:5616
16656 " guestfs_set_memsize (guestfs_h *g,\n"
16663 #: ../src/guestfs-actions.pod:5620
16665 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16666 "This only has any effect if called before C<guestfs_launch>."
16671 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3751
16673 "You can also change this by setting the environment variable "
16674 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16679 #: ../src/guestfs-actions.pod:5635
16680 msgid "guestfs_set_network"
16685 #: ../src/guestfs-actions.pod:5637
16689 " guestfs_set_network (guestfs_h *g,\n"
16696 #: ../src/guestfs-actions.pod:5641 ../fish/guestfish-actions.pod:3764
16698 "If C<network> is true, then the network is enabled in the libguestfs "
16699 "appliance. The default is false."
16704 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:3767
16706 "This affects whether commands are able to access the network (see L<guestfs"
16707 "(3)/RUNNING COMMANDS>)."
16712 #: ../src/guestfs-actions.pod:5647
16714 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16720 #: ../src/guestfs-actions.pod:5654
16721 msgid "guestfs_set_path"
16726 #: ../src/guestfs-actions.pod:5656
16730 " guestfs_set_path (guestfs_h *g,\n"
16731 " const char *searchpath);\n"
16737 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3779
16738 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16743 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3781
16745 "The default is C<$libdir/guestfs> unless overridden by setting "
16746 "C<LIBGUESTFS_PATH> environment variable."
16751 #: ../src/guestfs-actions.pod:5665 ../fish/guestfish-actions.pod:3784
16752 msgid "Setting C<path> to C<NULL> restores the default path."
16757 #: ../src/guestfs-actions.pod:5671
16758 msgid "guestfs_set_qemu"
16763 #: ../src/guestfs-actions.pod:5673
16767 " guestfs_set_qemu (guestfs_h *g,\n"
16768 " const char *qemu);\n"
16774 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:3792
16775 msgid "Set the qemu binary that we will use."
16780 #: ../src/guestfs-actions.pod:5679 ../fish/guestfish-actions.pod:3794
16782 "The default is chosen when the library was compiled by the configure script."
16787 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3797
16789 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16795 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3800
16796 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16801 #: ../src/guestfs-actions.pod:5687 ../fish/guestfish-actions.pod:3802
16803 "Note that you should call this function as early as possible after creating "
16804 "the handle. This is because some pre-launch operations depend on testing "
16805 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16806 "don't retest features, and so you might see inconsistent results. Using the "
16807 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16808 "the qemu binary at the same time as the handle is created."
16813 #: ../src/guestfs-actions.pod:5699
16814 msgid "guestfs_set_recovery_proc"
16819 #: ../src/guestfs-actions.pod:5701
16823 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16824 " int recoveryproc);\n"
16830 #: ../src/guestfs-actions.pod:5705
16832 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16833 "not create a recovery process. The purpose of the recovery process is to "
16834 "stop runaway qemu processes in the case where the main program aborts "
16840 #: ../src/guestfs-actions.pod:5710
16842 "This only has any effect if called before C<guestfs_launch>, and the default "
16848 #: ../src/guestfs-actions.pod:5713 ../fish/guestfish-actions.pod:3824
16850 "About the only time when you would want to disable this is if the main "
16851 "process will fork itself into the background (\"daemonize\" itself). In "
16852 "this case the recovery process thinks that the main program has disappeared "
16853 "and so kills qemu, which is not very helpful."
16858 #: ../src/guestfs-actions.pod:5723
16859 msgid "guestfs_set_selinux"
16864 #: ../src/guestfs-actions.pod:5725
16868 " guestfs_set_selinux (guestfs_h *g,\n"
16875 #: ../src/guestfs-actions.pod:5729 ../fish/guestfish-actions.pod:3836
16877 "This sets the selinux flag that is passed to the appliance at boot time. "
16878 "The default is C<selinux=0> (disabled)."
16883 #: ../src/guestfs-actions.pod:5732 ../fish/guestfish-actions.pod:3839
16885 "Note that if SELinux is enabled, it is always in Permissive mode "
16886 "(C<enforcing=0>)."
16891 #: ../src/guestfs-actions.pod:5742
16892 msgid "guestfs_set_trace"
16897 #: ../src/guestfs-actions.pod:5744
16901 " guestfs_set_trace (guestfs_h *g,\n"
16908 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3851
16910 "If the command trace flag is set to 1, then commands are printed on stderr "
16911 "before they are executed in a format which is very similar to the one used "
16912 "by guestfish. In other words, you can run a program with this enabled, and "
16913 "you will get out a script which you can feed to guestfish to perform the "
16914 "same set of actions."
16919 #: ../src/guestfs-actions.pod:5755 ../fish/guestfish-actions.pod:3858
16921 "If you want to trace C API calls into libguestfs (and other libraries) then "
16922 "possibly a better way is to use the external ltrace(1) command."
16927 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3862
16929 "Command traces are disabled unless the environment variable "
16930 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16935 #: ../src/guestfs-actions.pod:5766
16936 msgid "guestfs_set_verbose"
16941 #: ../src/guestfs-actions.pod:5768
16945 " guestfs_set_verbose (guestfs_h *g,\n"
16952 #: ../src/guestfs-actions.pod:5772 ../fish/guestfish-actions.pod:3871
16953 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
16958 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3873
16960 "Verbose messages are disabled unless the environment variable "
16961 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16966 #: ../src/guestfs-actions.pod:5781
16967 msgid "guestfs_setcon"
16972 #: ../src/guestfs-actions.pod:5783
16976 " guestfs_setcon (guestfs_h *g,\n"
16977 " const char *context);\n"
16983 #: ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3880
16985 "This sets the SELinux security context of the daemon to the string "
16991 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3883
16992 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16997 #: ../src/guestfs-actions.pod:5796
16998 msgid "guestfs_setxattr"
17003 #: ../src/guestfs-actions.pod:5798
17007 " guestfs_setxattr (guestfs_h *g,\n"
17008 " const char *xattr,\n"
17009 " const char *val,\n"
17011 " const char *path);\n"
17017 #: ../src/guestfs-actions.pod:5805 ../fish/guestfish-actions.pod:3889
17019 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17020 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17025 #: ../src/guestfs-actions.pod:5809
17026 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17031 #: ../src/guestfs-actions.pod:5815
17032 msgid "guestfs_sfdisk"
17037 #: ../src/guestfs-actions.pod:5817
17041 " guestfs_sfdisk (guestfs_h *g,\n"
17042 " const char *device,\n"
17046 " char *const *lines);\n"
17052 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3899
17054 "This is a direct interface to the L<sfdisk(8)> program for creating "
17055 "partitions on block devices."
17060 #: ../src/guestfs-actions.pod:5828 ../fish/guestfish-actions.pod:3902
17061 msgid "C<device> should be a block device, for example C</dev/sda>."
17066 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3904
17068 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17069 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17070 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17071 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17072 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17073 "the kernel) cannot work out the right geometry and you will need to tell it."
17078 #: ../src/guestfs-actions.pod:5838 ../fish/guestfish-actions.pod:3912
17080 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17081 "refer to the L<sfdisk(8)> manpage."
17086 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3915
17088 "To create a single partition occupying the whole disk, you would pass "
17089 "C<lines> as a single element list, when the single element being the string "
17095 #: ../src/guestfs-actions.pod:5845
17097 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17102 #: ../src/guestfs-actions.pod:5855
17103 msgid "guestfs_sfdiskM"
17108 #: ../src/guestfs-actions.pod:5857
17112 " guestfs_sfdiskM (guestfs_h *g,\n"
17113 " const char *device,\n"
17114 " char *const *lines);\n"
17120 #: ../src/guestfs-actions.pod:5862
17122 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17123 "partition sizes are specified in megabytes only (rounded to the nearest "
17124 "cylinder) and you don't need to specify the cyls, heads and sectors "
17125 "parameters which were rarely if ever used anyway."
17130 #: ../src/guestfs-actions.pod:5868
17132 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17133 "C<guestfs_part_disk>"
17138 #: ../src/guestfs-actions.pod:5878
17139 msgid "guestfs_sfdisk_N"
17144 #: ../src/guestfs-actions.pod:5880
17148 " guestfs_sfdisk_N (guestfs_h *g,\n"
17149 " const char *device,\n"
17154 " const char *line);\n"
17160 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3945
17162 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17163 "(note: C<n> counts from 1)."
17168 #: ../src/guestfs-actions.pod:5892
17170 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17171 "for the cyls/heads/sectors parameters."
17176 #: ../src/guestfs-actions.pod:5895
17177 msgid "See also: C<guestfs_part_add>"
17182 #: ../src/guestfs-actions.pod:5904
17183 msgid "guestfs_sfdisk_disk_geometry"
17188 #: ../src/guestfs-actions.pod:5906
17192 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17193 " const char *device);\n"
17199 #: ../src/guestfs-actions.pod:5910
17201 "This displays the disk geometry of C<device> read from the partition table. "
17202 "Especially in the case where the underlying block device has been resized, "
17203 "this can be different from the kernel's idea of the geometry (see "
17204 "C<guestfs_sfdisk_kernel_geometry>)."
17209 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:5931
17210 #: ../fish/guestfish-actions.pod:3965 ../fish/guestfish-actions.pod:3974
17211 msgid "The result is in human-readable format, and not designed to be parsed."
17216 #: ../src/guestfs-actions.pod:5923
17217 msgid "guestfs_sfdisk_kernel_geometry"
17222 #: ../src/guestfs-actions.pod:5925
17226 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17227 " const char *device);\n"
17233 #: ../src/guestfs-actions.pod:5929 ../fish/guestfish-actions.pod:3972
17234 msgid "This displays the kernel's idea of the geometry of C<device>."
17239 #: ../src/guestfs-actions.pod:5939
17240 msgid "guestfs_sfdisk_l"
17245 #: ../src/guestfs-actions.pod:5941
17249 " guestfs_sfdisk_l (guestfs_h *g,\n"
17250 " const char *device);\n"
17256 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:3981
17258 "This displays the partition table on C<device>, in the human-readable output "
17259 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17264 #: ../src/guestfs-actions.pod:5949
17265 msgid "See also: C<guestfs_part_list>"
17270 #: ../src/guestfs-actions.pod:5956
17276 #: ../src/guestfs-actions.pod:5958
17280 " guestfs_sh (guestfs_h *g,\n"
17281 " const char *command);\n"
17287 #: ../src/guestfs-actions.pod:5962 ../fish/guestfish-actions.pod:3991
17289 "This call runs a command from the guest filesystem via the guest's C</bin/"
17295 #: ../src/guestfs-actions.pod:5965
17296 msgid "This is like C<guestfs_command>, but passes the command to:"
17301 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:3996
17304 " /bin/sh -c \"command\"\n"
17310 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:3998
17312 "Depending on the guest's shell, this usually results in wildcards being "
17313 "expanded, shell expressions being interpolated and so on."
17318 #: ../src/guestfs-actions.pod:5973
17319 msgid "All the provisos about C<guestfs_command> apply to this call."
17324 #: ../src/guestfs-actions.pod:5980
17325 msgid "guestfs_sh_lines"
17330 #: ../src/guestfs-actions.pod:5982
17334 " guestfs_sh_lines (guestfs_h *g,\n"
17335 " const char *command);\n"
17341 #: ../src/guestfs-actions.pod:5986
17343 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17349 #: ../src/guestfs-actions.pod:5989
17350 msgid "See also: C<guestfs_command_lines>"
17355 #: ../src/guestfs-actions.pod:5997
17356 msgid "guestfs_sleep"
17361 #: ../src/guestfs-actions.pod:5999
17365 " guestfs_sleep (guestfs_h *g,\n"
17372 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4017
17373 msgid "Sleep for C<secs> seconds."
17378 #: ../src/guestfs-actions.pod:6007
17379 msgid "(Added in 1.0.41)"
17384 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-structs.pod:109
17385 msgid "guestfs_stat"
17390 #: ../src/guestfs-actions.pod:6011
17393 " struct guestfs_stat *\n"
17394 " guestfs_stat (guestfs_h *g,\n"
17395 " const char *path);\n"
17401 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4025
17402 msgid "This is the same as the C<stat(2)> system call."
17407 #: ../src/guestfs-actions.pod:6025 ../src/guestfs-structs.pod:135
17408 msgid "guestfs_statvfs"
17413 #: ../src/guestfs-actions.pod:6027
17416 " struct guestfs_statvfs *\n"
17417 " guestfs_statvfs (guestfs_h *g,\n"
17418 " const char *path);\n"
17424 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4031
17426 "Returns file system statistics for any mounted file system. C<path> should "
17427 "be a file or directory in the mounted file system (typically it is the mount "
17428 "point itself, but it doesn't need to be)."
17433 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4035
17434 msgid "This is the same as the C<statvfs(2)> system call."
17439 #: ../src/guestfs-actions.pod:6037
17441 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17442 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17447 #: ../src/guestfs-actions.pod:6043
17448 msgid "guestfs_strings"
17453 #: ../src/guestfs-actions.pod:6045
17457 " guestfs_strings (guestfs_h *g,\n"
17458 " const char *path);\n"
17464 #: ../src/guestfs-actions.pod:6049 ../fish/guestfish-actions.pod:4041
17466 "This runs the L<strings(1)> command on a file and returns the list of "
17467 "printable strings found."
17472 #: ../src/guestfs-actions.pod:6061
17473 msgid "guestfs_strings_e"
17478 #: ../src/guestfs-actions.pod:6063
17482 " guestfs_strings_e (guestfs_h *g,\n"
17483 " const char *encoding,\n"
17484 " const char *path);\n"
17490 #: ../src/guestfs-actions.pod:6068
17492 "This is like the C<guestfs_strings> command, but allows you to specify the "
17493 "encoding of strings that are looked for in the source file C<path>."
17498 #: ../src/guestfs-actions.pod:6072 ../fish/guestfish-actions.pod:4055
17499 msgid "Allowed encodings are:"
17504 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4059
17510 #: ../src/guestfs-actions.pod:6078
17512 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17513 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17518 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4064
17524 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4066
17525 msgid "Single 8-bit-byte characters."
17530 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4068
17536 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
17537 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17542 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4073
17543 msgid "l (lower case letter L)"
17548 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4075
17550 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17551 "examining binaries in Windows guests."
17556 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4078
17562 #: ../src/guestfs-actions.pod:6097 ../fish/guestfish-actions.pod:4080
17563 msgid "32-bit big endian such as UCS-4BE."
17568 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4082
17574 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4084
17575 msgid "32-bit little endian such as UCS-4LE."
17580 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4088
17581 msgid "The returned strings are transcoded to UTF-8."
17586 #: ../src/guestfs-actions.pod:6116
17587 msgid "guestfs_swapoff_device"
17592 #: ../src/guestfs-actions.pod:6118
17596 " guestfs_swapoff_device (guestfs_h *g,\n"
17597 " const char *device);\n"
17603 #: ../src/guestfs-actions.pod:6122
17605 "This command disables the libguestfs appliance swap device or partition "
17606 "named C<device>. See C<guestfs_swapon_device>."
17611 #: ../src/guestfs-actions.pod:6130
17612 msgid "guestfs_swapoff_file"
17617 #: ../src/guestfs-actions.pod:6132
17621 " guestfs_swapoff_file (guestfs_h *g,\n"
17622 " const char *file);\n"
17628 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4105
17629 msgid "This command disables the libguestfs appliance swap on file."
17634 #: ../src/guestfs-actions.pod:6142
17635 msgid "guestfs_swapoff_label"
17640 #: ../src/guestfs-actions.pod:6144
17644 " guestfs_swapoff_label (guestfs_h *g,\n"
17645 " const char *label);\n"
17651 #: ../src/guestfs-actions.pod:6148 ../fish/guestfish-actions.pod:4111
17653 "This command disables the libguestfs appliance swap on labeled swap "
17659 #: ../src/guestfs-actions.pod:6155
17660 msgid "guestfs_swapoff_uuid"
17665 #: ../src/guestfs-actions.pod:6157
17669 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17670 " const char *uuid);\n"
17676 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4118
17678 "This command disables the libguestfs appliance swap partition with the given "
17684 #: ../src/guestfs-actions.pod:6168
17685 msgid "guestfs_swapon_device"
17690 #: ../src/guestfs-actions.pod:6170
17694 " guestfs_swapon_device (guestfs_h *g,\n"
17695 " const char *device);\n"
17701 #: ../src/guestfs-actions.pod:6174
17703 "This command enables the libguestfs appliance to use the swap device or "
17704 "partition named C<device>. The increased memory is made available for all "
17705 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17710 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4130
17712 "Note that you should not swap to existing guest swap partitions unless you "
17713 "know what you are doing. They may contain hibernation information, or other "
17714 "information that the guest doesn't want you to trash. You also risk leaking "
17715 "information about the host to the guest this way. Instead, attach a new "
17716 "host device to the guest and swap on that."
17721 #: ../src/guestfs-actions.pod:6190
17722 msgid "guestfs_swapon_file"
17727 #: ../src/guestfs-actions.pod:6192
17731 " guestfs_swapon_file (guestfs_h *g,\n"
17732 " const char *file);\n"
17738 #: ../src/guestfs-actions.pod:6196
17740 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17746 #: ../src/guestfs-actions.pod:6203
17747 msgid "guestfs_swapon_label"
17752 #: ../src/guestfs-actions.pod:6205
17756 " guestfs_swapon_label (guestfs_h *g,\n"
17757 " const char *label);\n"
17763 #: ../src/guestfs-actions.pod:6209
17765 "This command enables swap to a labeled swap partition. See "
17766 "C<guestfs_swapon_device> for other notes."
17771 #: ../src/guestfs-actions.pod:6216
17772 msgid "guestfs_swapon_uuid"
17777 #: ../src/guestfs-actions.pod:6218
17781 " guestfs_swapon_uuid (guestfs_h *g,\n"
17782 " const char *uuid);\n"
17788 #: ../src/guestfs-actions.pod:6222
17790 "This command enables swap to a swap partition with the given UUID. See "
17791 "C<guestfs_swapon_device> for other notes."
17796 #: ../src/guestfs-actions.pod:6229
17797 msgid "guestfs_sync"
17802 #: ../src/guestfs-actions.pod:6231
17806 " guestfs_sync (guestfs_h *g);\n"
17812 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4162
17814 "This syncs the disk, so that any writes are flushed through to the "
17815 "underlying disk image."
17820 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4165
17822 "You should always call this if you have modified a disk image, before "
17823 "closing the handle."
17828 #: ../src/guestfs-actions.pod:6244
17829 msgid "guestfs_tail"
17834 #: ../src/guestfs-actions.pod:6246
17838 " guestfs_tail (guestfs_h *g,\n"
17839 " const char *path);\n"
17845 #: ../src/guestfs-actions.pod:6250 ../fish/guestfish-actions.pod:4172
17847 "This command returns up to the last 10 lines of a file as a list of strings."
17852 #: ../src/guestfs-actions.pod:6262
17853 msgid "guestfs_tail_n"
17858 #: ../src/guestfs-actions.pod:6264
17862 " guestfs_tail_n (guestfs_h *g,\n"
17864 " const char *path);\n"
17870 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4182
17872 "If the parameter C<nrlines> is a positive number, this returns the last "
17873 "C<nrlines> lines of the file C<path>."
17878 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4185
17880 "If the parameter C<nrlines> is a negative number, this returns lines from "
17881 "the file C<path>, starting with the C<-nrlines>th line."
17886 #: ../src/guestfs-actions.pod:6286
17887 msgid "guestfs_tar_in"
17892 #: ../src/guestfs-actions.pod:6288
17896 " guestfs_tar_in (guestfs_h *g,\n"
17897 " const char *tarfile,\n"
17898 " const char *directory);\n"
17904 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4197
17906 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17907 "tar file) into C<directory>."
17912 #: ../src/guestfs-actions.pod:6296
17914 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17919 #: ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6318
17920 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6350
17921 msgid "(Added in 1.0.3)"
17926 #: ../src/guestfs-actions.pod:6303
17927 msgid "guestfs_tar_out"
17932 #: ../src/guestfs-actions.pod:6305
17936 " guestfs_tar_out (guestfs_h *g,\n"
17937 " const char *directory,\n"
17938 " const char *tarfile);\n"
17944 #: ../src/guestfs-actions.pod:6310 ../fish/guestfish-actions.pod:4209
17946 "This command packs the contents of C<directory> and downloads it to local "
17952 #: ../src/guestfs-actions.pod:6313
17954 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17955 "C<guestfs_txz_out>."
17960 #: ../src/guestfs-actions.pod:6320
17961 msgid "guestfs_tgz_in"
17966 #: ../src/guestfs-actions.pod:6322
17970 " guestfs_tgz_in (guestfs_h *g,\n"
17971 " const char *tarball,\n"
17972 " const char *directory);\n"
17978 #: ../src/guestfs-actions.pod:6327 ../fish/guestfish-actions.pod:4221
17980 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17981 "tar file) into C<directory>."
17986 #: ../src/guestfs-actions.pod:6330
17987 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17992 #: ../src/guestfs-actions.pod:6336
17993 msgid "guestfs_tgz_out"
17998 #: ../src/guestfs-actions.pod:6338
18002 " guestfs_tgz_out (guestfs_h *g,\n"
18003 " const char *directory,\n"
18004 " const char *tarball);\n"
18010 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4232
18012 "This command packs the contents of C<directory> and downloads it to local "
18018 #: ../src/guestfs-actions.pod:6346
18019 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18024 #: ../src/guestfs-actions.pod:6352
18025 msgid "guestfs_touch"
18030 #: ../src/guestfs-actions.pod:6354
18034 " guestfs_touch (guestfs_h *g,\n"
18035 " const char *path);\n"
18041 #: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4243
18043 "Touch acts like the L<touch(1)> command. It can be used to update the "
18044 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18050 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4247
18052 "This command only works on regular files, and will fail on other file types "
18053 "such as directories, symbolic links, block special etc."
18058 #: ../src/guestfs-actions.pod:6369
18059 msgid "guestfs_truncate"
18064 #: ../src/guestfs-actions.pod:6371
18068 " guestfs_truncate (guestfs_h *g,\n"
18069 " const char *path);\n"
18075 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4254
18077 "This command truncates C<path> to a zero-length file. The file must exist "
18083 #: ../src/guestfs-actions.pod:6382
18084 msgid "guestfs_truncate_size"
18089 #: ../src/guestfs-actions.pod:6384
18093 " guestfs_truncate_size (guestfs_h *g,\n"
18094 " const char *path,\n"
18095 " int64_t size);\n"
18101 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4261
18103 "This command truncates C<path> to size C<size> bytes. The file must exist "
18109 #: ../src/guestfs-actions.pod:6392
18111 "If the current file size is less than C<size> then the file is extended to "
18112 "the required size with zero bytes. This creates a sparse file (ie. disk "
18113 "blocks are not allocated for the file until you write to it). To create a "
18114 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18119 #: ../src/guestfs-actions.pod:6402
18120 msgid "guestfs_tune2fs_l"
18125 #: ../src/guestfs-actions.pod:6404
18129 " guestfs_tune2fs_l (guestfs_h *g,\n"
18130 " const char *device);\n"
18136 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4274
18138 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18144 #: ../src/guestfs-actions.pod:6411 ../fish/guestfish-actions.pod:4277
18146 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18147 "for more details. The list of fields returned isn't clearly defined, and "
18148 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18149 "and the filesystem itself."
18154 #: ../src/guestfs-actions.pod:6424
18155 msgid "guestfs_txz_in"
18160 #: ../src/guestfs-actions.pod:6426
18164 " guestfs_txz_in (guestfs_h *g,\n"
18165 " const char *tarball,\n"
18166 " const char *directory);\n"
18172 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4286
18174 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18175 "tar file) into C<directory>."
18180 #: ../src/guestfs-actions.pod:6438
18181 msgid "guestfs_txz_out"
18186 #: ../src/guestfs-actions.pod:6440
18190 " guestfs_txz_out (guestfs_h *g,\n"
18191 " const char *directory,\n"
18192 " const char *tarball);\n"
18198 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4295
18200 "This command packs the contents of C<directory> and downloads it to local "
18201 "file C<tarball> (as an xz compressed tar archive)."
18206 #: ../src/guestfs-actions.pod:6452
18207 msgid "guestfs_umask"
18212 #: ../src/guestfs-actions.pod:6454
18216 " guestfs_umask (guestfs_h *g,\n"
18223 #: ../src/guestfs-actions.pod:6458 ../fish/guestfish-actions.pod:4304
18225 "This function sets the mask used for creating new files and device nodes to "
18231 #: ../src/guestfs-actions.pod:6461 ../fish/guestfish-actions.pod:4307
18233 "Typical umask values would be C<022> which creates new files with "
18234 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18235 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18240 #: ../src/guestfs-actions.pod:6466 ../fish/guestfish-actions.pod:4312
18242 "The default umask is C<022>. This is important because it means that "
18243 "directories and device nodes will be created with C<0644> or C<0755> mode "
18244 "even if you specify C<0777>."
18249 #: ../src/guestfs-actions.pod:6470
18251 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18252 "C<guestfs_mkdir>."
18257 #: ../src/guestfs-actions.pod:6473 ../fish/guestfish-actions.pod:4319
18258 msgid "This call returns the previous umask."
18263 #: ../src/guestfs-actions.pod:6479
18264 msgid "guestfs_umount"
18269 #: ../src/guestfs-actions.pod:6481
18273 " guestfs_umount (guestfs_h *g,\n"
18274 " const char *pathordevice);\n"
18280 #: ../src/guestfs-actions.pod:6485 ../fish/guestfish-actions.pod:4327
18282 "This unmounts the given filesystem. The filesystem may be specified either "
18283 "by its mountpoint (path) or the device which contains the filesystem."
18288 #: ../src/guestfs-actions.pod:6493
18289 msgid "guestfs_umount_all"
18294 #: ../src/guestfs-actions.pod:6495
18298 " guestfs_umount_all (guestfs_h *g);\n"
18304 #: ../src/guestfs-actions.pod:6498 ../fish/guestfish-actions.pod:4337
18305 msgid "This unmounts all mounted filesystems."
18310 #: ../src/guestfs-actions.pod:6500 ../fish/guestfish-actions.pod:4339
18311 msgid "Some internal mounts are not unmounted by this call."
18316 #: ../src/guestfs-actions.pod:6506
18317 msgid "guestfs_upload"
18322 #: ../src/guestfs-actions.pod:6508
18326 " guestfs_upload (guestfs_h *g,\n"
18327 " const char *filename,\n"
18328 " const char *remotefilename);\n"
18334 #: ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6537
18335 #: ../fish/guestfish-actions.pod:4345 ../fish/guestfish-actions.pod:4358
18336 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18341 #: ../src/guestfs-actions.pod:6518
18342 msgid "See also C<guestfs_download>."
18347 #: ../src/guestfs-actions.pod:6529
18348 msgid "guestfs_upload_offset"
18353 #: ../src/guestfs-actions.pod:6531
18357 " guestfs_upload_offset (guestfs_h *g,\n"
18358 " const char *filename,\n"
18359 " const char *remotefilename,\n"
18360 " int64_t offset);\n"
18366 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4361
18368 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18369 "The intention is to overwrite parts of existing files or devices, although "
18370 "if a non-existant file is specified then it is created with a \"hole\" "
18371 "before C<offset>. The size of the data written is implicit in the size of "
18372 "the source C<filename>."
18377 #: ../src/guestfs-actions.pod:6547
18379 "Note that there is no limit on the amount of data that can be uploaded with "
18380 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18381 "full amount unless an error occurs."
18386 #: ../src/guestfs-actions.pod:6552
18387 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18392 #: ../src/guestfs-actions.pod:6563
18393 msgid "guestfs_utimens"
18398 #: ../src/guestfs-actions.pod:6565
18402 " guestfs_utimens (guestfs_h *g,\n"
18403 " const char *path,\n"
18404 " int64_t atsecs,\n"
18405 " int64_t atnsecs,\n"
18406 " int64_t mtsecs,\n"
18407 " int64_t mtnsecs);\n"
18413 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4381
18414 msgid "This command sets the timestamps of a file with nanosecond precision."
18419 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4384
18421 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18427 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4387
18429 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18430 "nanoseconds from the epoch."
18435 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4390
18437 "If the C<*nsecs> field contains the special value C<-1> then the "
18438 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18439 "ignored in this case)."
18444 #: ../src/guestfs-actions.pod:6586 ../fish/guestfish-actions.pod:4394
18446 "If the C<*nsecs> field contains the special value C<-2> then the "
18447 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18453 #: ../src/guestfs-actions.pod:6594 ../src/guestfs-structs.pod:175
18454 msgid "guestfs_version"
18459 #: ../src/guestfs-actions.pod:6596
18462 " struct guestfs_version *\n"
18463 " guestfs_version (guestfs_h *g);\n"
18469 #: ../src/guestfs-actions.pod:6599 ../fish/guestfish-actions.pod:4402
18471 "Return the libguestfs version number that the program is linked against."
18476 #: ../src/guestfs-actions.pod:6602 ../fish/guestfish-actions.pod:4405
18478 "Note that because of dynamic linking this is not necessarily the version of "
18479 "libguestfs that you compiled against. You can compile the program, and then "
18480 "at runtime dynamically link against a completely different C<libguestfs.so> "
18486 #: ../src/guestfs-actions.pod:6607 ../fish/guestfish-actions.pod:4410
18488 "This call was added in version C<1.0.58>. In previous versions of "
18489 "libguestfs there was no way to get the version number. From C code you can "
18490 "use dynamic linker functions to find out if this symbol exists (if it "
18491 "doesn't, then it's an earlier version)."
18496 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
18498 "The call returns a structure with four elements. The first three (C<major>, "
18499 "C<minor> and C<release>) are numbers and correspond to the usual version "
18500 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18501 "but may be used for distro-specific information."
18506 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4422
18508 "To construct the original version string: C<$major.$minor.$release$extra>"
18513 #: ../src/guestfs-actions.pod:6622 ../fish/guestfish-actions.pod:4425
18514 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18519 #: ../src/guestfs-actions.pod:6624
18521 "I<Note:> Don't use this call to test for availability of features. In "
18522 "enterprise distributions we backport features from later versions into "
18523 "earlier versions, making this an unreliable way to test for features. Use "
18524 "C<guestfs_available> instead."
18529 #: ../src/guestfs-actions.pod:6630
18531 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18532 "error. I<The caller must call C<guestfs_free_version> after use>."
18537 #: ../src/guestfs-actions.pod:6634
18538 msgid "(Added in 1.0.58)"
18543 #: ../src/guestfs-actions.pod:6636
18544 msgid "guestfs_vfs_label"
18549 #: ../src/guestfs-actions.pod:6638
18553 " guestfs_vfs_label (guestfs_h *g,\n"
18554 " const char *device);\n"
18560 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4437
18561 msgid "This returns the filesystem label of the filesystem on C<device>."
18566 #: ../src/guestfs-actions.pod:6645 ../fish/guestfish-actions.pod:4440
18567 msgid "If the filesystem is unlabeled, this returns the empty string."
18572 #: ../src/guestfs-actions.pod:6647
18573 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18578 #: ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:6689
18579 msgid "(Added in 1.3.18)"
18584 #: ../src/guestfs-actions.pod:6654
18585 msgid "guestfs_vfs_type"
18590 #: ../src/guestfs-actions.pod:6656
18594 " guestfs_vfs_type (guestfs_h *g,\n"
18595 " const char *device);\n"
18601 #: ../src/guestfs-actions.pod:6660 ../fish/guestfish-actions.pod:4448
18603 "This command gets the filesystem type corresponding to the filesystem on "
18609 #: ../src/guestfs-actions.pod:6663 ../fish/guestfish-actions.pod:4451
18611 "For most filesystems, the result is the name of the Linux VFS module which "
18612 "would be used to mount this filesystem if you mounted it without specifying "
18613 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18618 #: ../src/guestfs-actions.pod:6673
18619 msgid "guestfs_vfs_uuid"
18624 #: ../src/guestfs-actions.pod:6675
18628 " guestfs_vfs_uuid (guestfs_h *g,\n"
18629 " const char *device);\n"
18635 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4460
18636 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18641 #: ../src/guestfs-actions.pod:6682 ../fish/guestfish-actions.pod:4463
18642 msgid "If the filesystem does not have a UUID, this returns the empty string."
18647 #: ../src/guestfs-actions.pod:6684
18648 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18653 #: ../src/guestfs-actions.pod:6691
18654 msgid "guestfs_vg_activate"
18659 #: ../src/guestfs-actions.pod:6693
18663 " guestfs_vg_activate (guestfs_h *g,\n"
18665 " char *const *volgroups);\n"
18671 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4471
18673 "This command activates or (if C<activate> is false) deactivates all logical "
18674 "volumes in the listed volume groups C<volgroups>. If activated, then they "
18675 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
18676 "deactivated, then those devices disappear."
18681 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4477
18682 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18687 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4479
18689 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18690 "activated or deactivated."
18695 #: ../src/guestfs-actions.pod:6713
18696 msgid "guestfs_vg_activate_all"
18701 #: ../src/guestfs-actions.pod:6715
18705 " guestfs_vg_activate_all (guestfs_h *g,\n"
18706 " int activate);\n"
18712 #: ../src/guestfs-actions.pod:6719 ../fish/guestfish-actions.pod:4486
18714 "This command activates or (if C<activate> is false) deactivates all logical "
18715 "volumes in all volume groups. If activated, then they are made known to the "
18716 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
18717 "those devices disappear."
18722 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4492
18723 msgid "This command is the same as running C<vgchange -a y|n>"
18728 #: ../src/guestfs-actions.pod:6731
18729 msgid "guestfs_vgcreate"
18734 #: ../src/guestfs-actions.pod:6733
18738 " guestfs_vgcreate (guestfs_h *g,\n"
18739 " const char *volgroup,\n"
18740 " char *const *physvols);\n"
18746 #: ../src/guestfs-actions.pod:6738 ../fish/guestfish-actions.pod:4498
18748 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18749 "of physical volumes C<physvols>."
18754 #: ../src/guestfs-actions.pod:6745
18755 msgid "guestfs_vglvuuids"
18760 #: ../src/guestfs-actions.pod:6747
18764 " guestfs_vglvuuids (guestfs_h *g,\n"
18765 " const char *vgname);\n"
18771 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4505
18773 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18774 "volumes created in this volume group."
18779 #: ../src/guestfs-actions.pod:6754
18781 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18782 "associate logical volumes and volume groups."
18787 #: ../src/guestfs-actions.pod:6757
18788 msgid "See also C<guestfs_vgpvuuids>."
18793 #: ../src/guestfs-actions.pod:6765
18794 msgid "guestfs_vgpvuuids"
18799 #: ../src/guestfs-actions.pod:6767
18803 " guestfs_vgpvuuids (guestfs_h *g,\n"
18804 " const char *vgname);\n"
18810 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4517
18812 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18813 "volumes that this volume group resides on."
18818 #: ../src/guestfs-actions.pod:6774
18820 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18821 "associate physical volumes and volume groups."
18826 #: ../src/guestfs-actions.pod:6777
18827 msgid "See also C<guestfs_vglvuuids>."
18832 #: ../src/guestfs-actions.pod:6785
18833 msgid "guestfs_vgremove"
18838 #: ../src/guestfs-actions.pod:6787
18842 " guestfs_vgremove (guestfs_h *g,\n"
18843 " const char *vgname);\n"
18849 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4529
18850 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18855 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4531
18857 "This also forcibly removes all logical volumes in the volume group (if any)."
18862 #: ../src/guestfs-actions.pod:6800
18863 msgid "guestfs_vgrename"
18868 #: ../src/guestfs-actions.pod:6802
18872 " guestfs_vgrename (guestfs_h *g,\n"
18873 " const char *volgroup,\n"
18874 " const char *newvolgroup);\n"
18880 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4538
18881 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18886 #: ../src/guestfs-actions.pod:6813
18887 msgid "guestfs_vgs"
18892 #: ../src/guestfs-actions.pod:6815
18896 " guestfs_vgs (guestfs_h *g);\n"
18902 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4544
18904 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18910 #: ../src/guestfs-actions.pod:6821 ../fish/guestfish-actions.pod:4547
18912 "This returns a list of just the volume group names that were detected (eg. "
18918 #: ../src/guestfs-actions.pod:6824
18919 msgid "See also C<guestfs_vgs_full>."
18924 #: ../src/guestfs-actions.pod:6832
18925 msgid "guestfs_vgs_full"
18930 #: ../src/guestfs-actions.pod:6834
18933 " struct guestfs_lvm_vg_list *\n"
18934 " guestfs_vgs_full (guestfs_h *g);\n"
18940 #: ../src/guestfs-actions.pod:6837 ../fish/guestfish-actions.pod:4556
18942 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18943 "> command. The \"full\" version includes all fields."
18948 #: ../src/guestfs-actions.pod:6840
18950 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18951 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18956 #: ../src/guestfs-actions.pod:6846
18957 msgid "guestfs_vgscan"
18962 #: ../src/guestfs-actions.pod:6848
18966 " guestfs_vgscan (guestfs_h *g);\n"
18972 #: ../src/guestfs-actions.pod:6851 ../fish/guestfish-actions.pod:4563
18974 "This rescans all block devices and rebuilds the list of LVM physical "
18975 "volumes, volume groups and logical volumes."
18980 #: ../src/guestfs-actions.pod:6858
18981 msgid "guestfs_vguuid"
18986 #: ../src/guestfs-actions.pod:6860
18990 " guestfs_vguuid (guestfs_h *g,\n"
18991 " const char *vgname);\n"
18997 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4570
18998 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19003 #: ../src/guestfs-actions.pod:6871
19004 msgid "guestfs_wait_ready"
19009 #: ../src/guestfs-actions.pod:6873
19013 " guestfs_wait_ready (guestfs_h *g);\n"
19019 #: ../src/guestfs-actions.pod:6876
19020 msgid "This function is a no op."
19025 #: ../src/guestfs-actions.pod:6878
19027 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19028 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19029 "is no longer necessary because C<guestfs_launch> now does the waiting."
19034 #: ../src/guestfs-actions.pod:6883
19036 "If you see any calls to this function in code then you can just remove them, "
19037 "unless you want to retain compatibility with older versions of the API."
19042 #: ../src/guestfs-actions.pod:6891
19043 msgid "guestfs_wc_c"
19048 #: ../src/guestfs-actions.pod:6893
19052 " guestfs_wc_c (guestfs_h *g,\n"
19053 " const char *path);\n"
19059 #: ../src/guestfs-actions.pod:6897 ../fish/guestfish-actions.pod:4576
19061 "This command counts the characters in a file, using the C<wc -c> external "
19067 #: ../src/guestfs-actions.pod:6904
19068 msgid "guestfs_wc_l"
19073 #: ../src/guestfs-actions.pod:6906
19077 " guestfs_wc_l (guestfs_h *g,\n"
19078 " const char *path);\n"
19084 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4583
19086 "This command counts the lines in a file, using the C<wc -l> external command."
19091 #: ../src/guestfs-actions.pod:6917
19092 msgid "guestfs_wc_w"
19097 #: ../src/guestfs-actions.pod:6919
19101 " guestfs_wc_w (guestfs_h *g,\n"
19102 " const char *path);\n"
19108 #: ../src/guestfs-actions.pod:6923 ../fish/guestfish-actions.pod:4590
19110 "This command counts the words in a file, using the C<wc -w> external command."
19115 #: ../src/guestfs-actions.pod:6930
19116 msgid "guestfs_write"
19121 #: ../src/guestfs-actions.pod:6932
19125 " guestfs_write (guestfs_h *g,\n"
19126 " const char *path,\n"
19127 " const char *content,\n"
19128 " size_t content_size);\n"
19134 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4597
19136 "This call creates a file called C<path>. The content of the file is the "
19137 "string C<content> (which can contain any 8 bit data)."
19142 #: ../src/guestfs-actions.pod:6948
19143 msgid "guestfs_write_file"
19148 #: ../src/guestfs-actions.pod:6950
19152 " guestfs_write_file (guestfs_h *g,\n"
19153 " const char *path,\n"
19154 " const char *content,\n"
19161 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4607
19163 "This call creates a file called C<path>. The contents of the file is the "
19164 "string C<content> (which can contain any 8 bit data), with length C<size>."
19169 #: ../src/guestfs-actions.pod:6960 ../fish/guestfish-actions.pod:4611
19171 "As a special case, if C<size> is C<0> then the length is calculated using "
19172 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19177 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4615
19179 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19180 "I<not> work, even if the length is specified."
19185 #: ../src/guestfs-actions.pod:6972 ../fish/guestfish-actions.pod:4621
19187 "This function is deprecated. In new code, use the C<write> call instead."
19192 #: ../src/guestfs-actions.pod:6981
19193 msgid "guestfs_zegrep"
19198 #: ../src/guestfs-actions.pod:6983
19202 " guestfs_zegrep (guestfs_h *g,\n"
19203 " const char *regex,\n"
19204 " const char *path);\n"
19210 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4632
19212 "This calls the external C<zegrep> program and returns the matching lines."
19217 #: ../src/guestfs-actions.pod:7000
19218 msgid "guestfs_zegrepi"
19223 #: ../src/guestfs-actions.pod:7002
19227 " guestfs_zegrepi (guestfs_h *g,\n"
19228 " const char *regex,\n"
19229 " const char *path);\n"
19235 #: ../src/guestfs-actions.pod:7007 ../fish/guestfish-actions.pod:4642
19237 "This calls the external C<zegrep -i> program and returns the matching lines."
19242 #: ../src/guestfs-actions.pod:7019
19243 msgid "guestfs_zero"
19248 #: ../src/guestfs-actions.pod:7021
19252 " guestfs_zero (guestfs_h *g,\n"
19253 " const char *device);\n"
19259 #: ../src/guestfs-actions.pod:7025 ../fish/guestfish-actions.pod:4652
19260 msgid "This command writes zeroes over the first few blocks of C<device>."
19265 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4654
19267 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19268 "securely wipe the device). It should be sufficient to remove any partition "
19269 "tables, filesystem superblocks and so on."
19274 #: ../src/guestfs-actions.pod:7031
19275 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
19280 #: ../src/guestfs-actions.pod:7042
19281 msgid "guestfs_zero_device"
19286 #: ../src/guestfs-actions.pod:7044
19290 " guestfs_zero_device (guestfs_h *g,\n"
19291 " const char *device);\n"
19297 #: ../src/guestfs-actions.pod:7048
19299 "This command writes zeroes over the entire C<device>. Compare with "
19300 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19305 #: ../src/guestfs-actions.pod:7062
19306 msgid "(Added in 1.3.1)"
19311 #: ../src/guestfs-actions.pod:7064
19312 msgid "guestfs_zerofree"
19317 #: ../src/guestfs-actions.pod:7066
19321 " guestfs_zerofree (guestfs_h *g,\n"
19322 " const char *device);\n"
19328 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4675
19330 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19331 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19332 "possible to compress the filesystem more effectively."
19337 #: ../src/guestfs-actions.pod:7075 ../fish/guestfish-actions.pod:4680
19338 msgid "You should B<not> run this program if the filesystem is mounted."
19343 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4683
19345 "It is possible that using this program can damage the filesystem or data on "
19351 #: ../src/guestfs-actions.pod:7085
19352 msgid "guestfs_zfgrep"
19357 #: ../src/guestfs-actions.pod:7087
19361 " guestfs_zfgrep (guestfs_h *g,\n"
19362 " const char *pattern,\n"
19363 " const char *path);\n"
19369 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4690
19371 "This calls the external C<zfgrep> program and returns the matching lines."
19376 #: ../src/guestfs-actions.pod:7104
19377 msgid "guestfs_zfgrepi"
19382 #: ../src/guestfs-actions.pod:7106
19386 " guestfs_zfgrepi (guestfs_h *g,\n"
19387 " const char *pattern,\n"
19388 " const char *path);\n"
19394 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4700
19396 "This calls the external C<zfgrep -i> program and returns the matching lines."
19401 #: ../src/guestfs-actions.pod:7123
19402 msgid "guestfs_zfile"
19407 #: ../src/guestfs-actions.pod:7125
19411 " guestfs_zfile (guestfs_h *g,\n"
19412 " const char *meth,\n"
19413 " const char *path);\n"
19419 #: ../src/guestfs-actions.pod:7130 ../fish/guestfish-actions.pod:4710
19421 "This command runs C<file> after first decompressing C<path> using C<method>."
19426 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4713
19427 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19432 #: ../src/guestfs-actions.pod:7135
19434 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19440 #: ../src/guestfs-actions.pod:7141 ../fish/guestfish-actions.pod:4718
19442 "This function is deprecated. In new code, use the C<file> call instead."
19447 #: ../src/guestfs-actions.pod:7150
19448 msgid "guestfs_zgrep"
19453 #: ../src/guestfs-actions.pod:7152
19457 " guestfs_zgrep (guestfs_h *g,\n"
19458 " const char *regex,\n"
19459 " const char *path);\n"
19465 #: ../src/guestfs-actions.pod:7157 ../fish/guestfish-actions.pod:4729
19467 "This calls the external C<zgrep> program and returns the matching lines."
19472 #: ../src/guestfs-actions.pod:7169
19473 msgid "guestfs_zgrepi"
19478 #: ../src/guestfs-actions.pod:7171
19482 " guestfs_zgrepi (guestfs_h *g,\n"
19483 " const char *regex,\n"
19484 " const char *path);\n"
19490 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4739
19492 "This calls the external C<zgrep -i> program and returns the matching lines."
19497 #: ../src/guestfs-availability.pod:3
19503 #: ../src/guestfs-availability.pod:5
19505 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
19506 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
19507 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
19508 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
19509 "L</guestfs_aug_save> L</guestfs_aug_set>"
19514 #: ../src/guestfs-availability.pod:21
19520 #: ../src/guestfs-availability.pod:23
19522 "The following functions: L</guestfs_inotify_add_watch> L</"
19523 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19524 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19529 #: ../src/guestfs-availability.pod:31
19530 msgid "B<linuxfsuuid>"
19535 #: ../src/guestfs-availability.pod:33
19537 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19538 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19543 #: ../src/guestfs-availability.pod:40
19544 msgid "B<linuxmodules>"
19549 #: ../src/guestfs-availability.pod:42
19550 msgid "The following functions: L</guestfs_modprobe>"
19555 #: ../src/guestfs-availability.pod:45
19556 msgid "B<linuxxattrs>"
19561 #: ../src/guestfs-availability.pod:47
19563 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19564 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19565 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19566 "guestfs_setxattr>"
19571 #: ../src/guestfs-availability.pod:58
19577 #: ../src/guestfs-availability.pod:60
19579 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19580 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19581 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19586 #: ../src/guestfs-availability.pod:69
19592 #: ../src/guestfs-availability.pod:71
19594 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19595 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19596 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19597 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19598 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19599 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19600 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19605 #: ../src/guestfs-availability.pod:94
19611 #: ../src/guestfs-availability.pod:96
19613 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19614 "guestfs_mknod_b> L</guestfs_mknod_c>"
19619 #: ../src/guestfs-availability.pod:102
19625 #: ../src/guestfs-availability.pod:104
19626 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19631 #: ../src/guestfs-availability.pod:107
19632 msgid "B<ntfsprogs>"
19637 #: ../src/guestfs-availability.pod:109
19639 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
19644 #: ../src/guestfs-availability.pod:113
19645 msgid "B<realpath>"
19650 #: ../src/guestfs-availability.pod:115
19651 msgid "The following functions: L</guestfs_realpath>"
19656 #: ../src/guestfs-availability.pod:118
19662 #: ../src/guestfs-availability.pod:120
19664 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19665 "guestfs_scrub_freespace>"
19670 #: ../src/guestfs-availability.pod:125
19676 #: ../src/guestfs-availability.pod:127
19677 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19682 #: ../src/guestfs-availability.pod:131
19688 #: ../src/guestfs-availability.pod:133
19689 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19694 #: ../src/guestfs-availability.pod:137
19695 msgid "B<zerofree>"
19700 #: ../src/guestfs-availability.pod:139
19701 msgid "The following functions: L</guestfs_zerofree>"
19706 #: ../src/guestfs-structs.pod:1
19707 msgid "guestfs_int_bool"
19712 #: ../src/guestfs-structs.pod:3
19715 " struct guestfs_int_bool {\n"
19724 #: ../src/guestfs-structs.pod:8
19727 " struct guestfs_int_bool_list {\n"
19728 " uint32_t len; /* Number of elements in list. */\n"
19729 " struct guestfs_int_bool *val; /* Elements. */\n"
19736 #: ../src/guestfs-structs.pod:13
19739 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19740 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19746 #: ../src/guestfs-structs.pod:16
19747 msgid "guestfs_lvm_pv"
19752 #: ../src/guestfs-structs.pod:18
19755 " struct guestfs_lvm_pv {\n"
19756 " char *pv_name;\n"
19757 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19758 " char pv_uuid[32];\n"
19760 " uint64_t pv_size;\n"
19761 " uint64_t dev_size;\n"
19762 " uint64_t pv_free;\n"
19763 " uint64_t pv_used;\n"
19764 " char *pv_attr;\n"
19765 " int64_t pv_pe_count;\n"
19766 " int64_t pv_pe_alloc_count;\n"
19767 " char *pv_tags;\n"
19768 " uint64_t pe_start;\n"
19769 " int64_t pv_mda_count;\n"
19770 " uint64_t pv_mda_free;\n"
19777 #: ../src/guestfs-structs.pod:36
19780 " struct guestfs_lvm_pv_list {\n"
19781 " uint32_t len; /* Number of elements in list. */\n"
19782 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19789 #: ../src/guestfs-structs.pod:41
19792 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19793 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19799 #: ../src/guestfs-structs.pod:44
19800 msgid "guestfs_lvm_vg"
19805 #: ../src/guestfs-structs.pod:46
19808 " struct guestfs_lvm_vg {\n"
19809 " char *vg_name;\n"
19810 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19811 " char vg_uuid[32];\n"
19813 " char *vg_attr;\n"
19814 " uint64_t vg_size;\n"
19815 " uint64_t vg_free;\n"
19816 " char *vg_sysid;\n"
19817 " uint64_t vg_extent_size;\n"
19818 " int64_t vg_extent_count;\n"
19819 " int64_t vg_free_count;\n"
19820 " int64_t max_lv;\n"
19821 " int64_t max_pv;\n"
19822 " int64_t pv_count;\n"
19823 " int64_t lv_count;\n"
19824 " int64_t snap_count;\n"
19825 " int64_t vg_seqno;\n"
19826 " char *vg_tags;\n"
19827 " int64_t vg_mda_count;\n"
19828 " uint64_t vg_mda_free;\n"
19835 #: ../src/guestfs-structs.pod:69
19838 " struct guestfs_lvm_vg_list {\n"
19839 " uint32_t len; /* Number of elements in list. */\n"
19840 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19847 #: ../src/guestfs-structs.pod:74
19850 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19851 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19857 #: ../src/guestfs-structs.pod:77
19858 msgid "guestfs_lvm_lv"
19863 #: ../src/guestfs-structs.pod:79
19866 " struct guestfs_lvm_lv {\n"
19867 " char *lv_name;\n"
19868 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19869 " char lv_uuid[32];\n"
19870 " char *lv_attr;\n"
19871 " int64_t lv_major;\n"
19872 " int64_t lv_minor;\n"
19873 " int64_t lv_kernel_major;\n"
19874 " int64_t lv_kernel_minor;\n"
19875 " uint64_t lv_size;\n"
19876 " int64_t seg_count;\n"
19878 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19879 " float snap_percent;\n"
19880 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19881 " float copy_percent;\n"
19882 " char *move_pv;\n"
19883 " char *lv_tags;\n"
19884 " char *mirror_log;\n"
19885 " char *modules;\n"
19892 #: ../src/guestfs-structs.pod:101
19895 " struct guestfs_lvm_lv_list {\n"
19896 " uint32_t len; /* Number of elements in list. */\n"
19897 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19904 #: ../src/guestfs-structs.pod:106
19907 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19908 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19914 #: ../src/guestfs-structs.pod:111
19917 " struct guestfs_stat {\n"
19921 " int64_t nlink;\n"
19926 " int64_t blksize;\n"
19927 " int64_t blocks;\n"
19928 " int64_t atime;\n"
19929 " int64_t mtime;\n"
19930 " int64_t ctime;\n"
19937 #: ../src/guestfs-structs.pod:127
19940 " struct guestfs_stat_list {\n"
19941 " uint32_t len; /* Number of elements in list. */\n"
19942 " struct guestfs_stat *val; /* Elements. */\n"
19949 #: ../src/guestfs-structs.pod:132
19952 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19953 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19959 #: ../src/guestfs-structs.pod:137
19962 " struct guestfs_statvfs {\n"
19963 " int64_t bsize;\n"
19964 " int64_t frsize;\n"
19965 " int64_t blocks;\n"
19966 " int64_t bfree;\n"
19967 " int64_t bavail;\n"
19968 " int64_t files;\n"
19969 " int64_t ffree;\n"
19970 " int64_t favail;\n"
19973 " int64_t namemax;\n"
19980 #: ../src/guestfs-structs.pod:151
19983 " struct guestfs_statvfs_list {\n"
19984 " uint32_t len; /* Number of elements in list. */\n"
19985 " struct guestfs_statvfs *val; /* Elements. */\n"
19992 #: ../src/guestfs-structs.pod:156
19995 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19996 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20002 #: ../src/guestfs-structs.pod:159
20003 msgid "guestfs_dirent"
20008 #: ../src/guestfs-structs.pod:161
20011 " struct guestfs_dirent {\n"
20021 #: ../src/guestfs-structs.pod:167
20024 " struct guestfs_dirent_list {\n"
20025 " uint32_t len; /* Number of elements in list. */\n"
20026 " struct guestfs_dirent *val; /* Elements. */\n"
20033 #: ../src/guestfs-structs.pod:172
20036 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20037 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20043 #: ../src/guestfs-structs.pod:177
20046 " struct guestfs_version {\n"
20047 " int64_t major;\n"
20048 " int64_t minor;\n"
20049 " int64_t release;\n"
20057 #: ../src/guestfs-structs.pod:184
20060 " struct guestfs_version_list {\n"
20061 " uint32_t len; /* Number of elements in list. */\n"
20062 " struct guestfs_version *val; /* Elements. */\n"
20069 #: ../src/guestfs-structs.pod:189
20072 " void guestfs_free_version (struct guestfs_free_version *);\n"
20073 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20079 #: ../src/guestfs-structs.pod:192
20080 msgid "guestfs_xattr"
20085 #: ../src/guestfs-structs.pod:194
20088 " struct guestfs_xattr {\n"
20089 " char *attrname;\n"
20090 " /* The next two fields describe a byte array. */\n"
20091 " uint32_t attrval_len;\n"
20092 " char *attrval;\n"
20099 #: ../src/guestfs-structs.pod:201
20102 " struct guestfs_xattr_list {\n"
20103 " uint32_t len; /* Number of elements in list. */\n"
20104 " struct guestfs_xattr *val; /* Elements. */\n"
20111 #: ../src/guestfs-structs.pod:206
20114 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20115 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
20121 #: ../src/guestfs-structs.pod:209
20122 msgid "guestfs_inotify_event"
20127 #: ../src/guestfs-structs.pod:211
20130 " struct guestfs_inotify_event {\n"
20131 " int64_t in_wd;\n"
20132 " uint32_t in_mask;\n"
20133 " uint32_t in_cookie;\n"
20134 " char *in_name;\n"
20141 #: ../src/guestfs-structs.pod:218
20144 " struct guestfs_inotify_event_list {\n"
20145 " uint32_t len; /* Number of elements in list. */\n"
20146 " struct guestfs_inotify_event *val; /* Elements. */\n"
20153 #: ../src/guestfs-structs.pod:223
20156 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20157 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20163 #: ../src/guestfs-structs.pod:226
20164 msgid "guestfs_partition"
20169 #: ../src/guestfs-structs.pod:228
20172 " struct guestfs_partition {\n"
20173 " int32_t part_num;\n"
20174 " uint64_t part_start;\n"
20175 " uint64_t part_end;\n"
20176 " uint64_t part_size;\n"
20183 #: ../src/guestfs-structs.pod:235
20186 " struct guestfs_partition_list {\n"
20187 " uint32_t len; /* Number of elements in list. */\n"
20188 " struct guestfs_partition *val; /* Elements. */\n"
20195 #: ../src/guestfs-structs.pod:240
20198 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
20199 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
20205 #: ../src/guestfs-structs.pod:243
20206 msgid "guestfs_application"
20211 #: ../src/guestfs-structs.pod:245
20214 " struct guestfs_application {\n"
20215 " char *app_name;\n"
20216 " char *app_display_name;\n"
20217 " int32_t app_epoch;\n"
20218 " char *app_version;\n"
20219 " char *app_release;\n"
20220 " char *app_install_path;\n"
20221 " char *app_trans_path;\n"
20222 " char *app_publisher;\n"
20223 " char *app_url;\n"
20224 " char *app_source_package;\n"
20225 " char *app_summary;\n"
20226 " char *app_description;\n"
20233 #: ../src/guestfs-structs.pod:260
20236 " struct guestfs_application_list {\n"
20237 " uint32_t len; /* Number of elements in list. */\n"
20238 " struct guestfs_application *val; /* Elements. */\n"
20245 #: ../src/guestfs-structs.pod:265
20248 " void guestfs_free_application (struct guestfs_free_application *);\n"
20249 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
20255 #: ../fish/guestfish.pod:5
20256 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20261 #: ../fish/guestfish.pod:9
20264 " guestfish [--options] [commands]\n"
20270 #: ../fish/guestfish.pod:11
20279 #: ../fish/guestfish.pod:13
20282 " guestfish [--ro|--rw] -a disk.img\n"
20288 #: ../fish/guestfish.pod:15
20291 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20297 #: ../fish/guestfish.pod:17
20300 " guestfish -d libvirt-domain\n"
20306 #: ../fish/guestfish.pod:19
20309 " guestfish [--ro|--rw] -a disk.img -i\n"
20315 #: ../fish/guestfish.pod:21
20318 " guestfish -d libvirt-domain -i\n"
20324 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
20325 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
20331 #: ../fish/guestfish.pod:25
20333 "Using guestfish in read/write mode on live virtual machines can be "
20334 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20335 "option to use guestfish safely if the disk image or virtual machine might be "
20341 #: ../fish/guestfish.pod:32
20343 "Guestfish is a shell and command-line tool for examining and modifying "
20344 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20345 "functionality of the guestfs API, see L<guestfs(3)>."
20350 #: ../fish/guestfish.pod:36
20352 "Guestfish gives you structured access to the libguestfs API, from shell "
20353 "scripts or the command line or interactively. If you want to rescue a "
20354 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20360 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:897
20361 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
20362 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
20368 #: ../fish/guestfish.pod:43
20369 msgid "As an interactive shell"
20374 #: ../fish/guestfish.pod:45
20383 #: ../fish/guestfish.pod:47
20386 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20387 " editing virtual machine filesystems.\n"
20393 #: ../fish/guestfish.pod:50
20396 " Type: 'help' for a list of commands\n"
20397 " 'man' to read the manual\n"
20398 " 'quit' to quit the shell\n"
20404 #: ../fish/guestfish.pod:54
20407 " ><fs> add-ro disk.img\n"
20409 " ><fs> list-filesystems\n"
20410 " /dev/sda1: ext4\n"
20411 " /dev/vg_guest/lv_root: ext4\n"
20412 " /dev/vg_guest/lv_swap: swap\n"
20413 " ><fs> mount /dev/vg_guest/lv_root /\n"
20414 " ><fs> cat /etc/fstab\n"
20416 " # Created by anaconda\n"
20424 #: ../fish/guestfish.pod:67
20425 msgid "From shell scripts"
20430 #: ../fish/guestfish.pod:69
20431 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20436 #: ../fish/guestfish.pod:71
20439 " guestfish <<_EOF_\n"
20442 " mount /dev/vg_guest/lv_root /\n"
20443 " write /etc/motd \"Welcome, new users\"\n"
20450 #: ../fish/guestfish.pod:78
20451 msgid "List the LVM logical volumes in a disk image:"
20456 #: ../fish/guestfish.pod:80
20459 " guestfish -a disk.img --ro <<_EOF_\n"
20468 #: ../fish/guestfish.pod:85
20469 msgid "List all the filesystems in a disk image:"
20474 #: ../fish/guestfish.pod:87
20477 " guestfish -a disk.img --ro <<_EOF_\n"
20479 " list-filesystems\n"
20486 #: ../fish/guestfish.pod:92
20487 msgid "On one command line"
20492 #: ../fish/guestfish.pod:94
20493 msgid "Update C</etc/resolv.conf> in a guest:"
20498 #: ../fish/guestfish.pod:96
20502 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20503 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20509 #: ../fish/guestfish.pod:100
20510 msgid "Edit C</boot/grub/grub.conf> interactively:"
20515 #: ../fish/guestfish.pod:102
20518 " guestfish --rw --add disk.img \\\n"
20519 " --mount /dev/vg_guest/lv_root \\\n"
20520 " --mount /dev/sda1:/boot \\\n"
20521 " edit /boot/grub/grub.conf\n"
20527 #: ../fish/guestfish.pod:107
20528 msgid "Mount disks automatically"
20533 #: ../fish/guestfish.pod:109
20535 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20540 #: ../fish/guestfish.pod:112
20543 " guestfish --ro -a disk.img -i cat /etc/group\n"
20549 #: ../fish/guestfish.pod:114
20552 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20558 #: ../fish/guestfish.pod:116
20559 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20564 #: ../fish/guestfish.pod:118
20567 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20573 #: ../fish/guestfish.pod:120
20574 msgid "As a script interpreter"
20579 #: ../fish/guestfish.pod:122
20580 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20585 #: ../fish/guestfish.pod:124
20588 " #!/usr/bin/guestfish -f\n"
20589 " sparse test1.img 100M\n"
20591 " part-disk /dev/sda mbr\n"
20592 " mkfs ext2 /dev/sda1\n"
20598 #: ../fish/guestfish.pod:130
20599 msgid "Start with a prepared disk"
20604 #: ../fish/guestfish.pod:132
20606 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20607 "single ext2-formatted partition:"
20612 #: ../fish/guestfish.pod:135
20615 " guestfish -N fs\n"
20621 #: ../fish/guestfish.pod:137
20622 msgid "To list what is available do:"
20627 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
20630 " guestfish -N help | less\n"
20636 #: ../fish/guestfish.pod:141
20637 msgid "Remote control"
20642 #: ../fish/guestfish.pod:143
20645 " eval \"`guestfish --listen`\"\n"
20646 " guestfish --remote add-ro disk.img\n"
20647 " guestfish --remote run\n"
20648 " guestfish --remote lvs\n"
20654 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20655 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
20656 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
20657 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
20658 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20664 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
20665 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104
20666 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
20667 #: ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161
20668 #: ../tools/virt-list-partitions.pl:62
20674 #: ../fish/guestfish.pod:154
20675 msgid "Displays general help on options."
20680 #: ../fish/guestfish.pod:156
20686 #: ../fish/guestfish.pod:158
20687 msgid "B<--cmd-help>"
20692 #: ../fish/guestfish.pod:160
20693 msgid "Lists all available guestfish commands."
20698 #: ../fish/guestfish.pod:162
20704 #: ../fish/guestfish.pod:164
20705 msgid "B<--cmd-help cmd>"
20710 #: ../fish/guestfish.pod:166
20711 msgid "Displays detailed help on a single command C<cmd>."
20716 #: ../fish/guestfish.pod:168
20717 msgid "B<-a image>"
20722 #: ../fish/guestfish.pod:170
20723 msgid "B<--add image>"
20728 #: ../fish/guestfish.pod:172
20729 msgid "Add a block device or virtual machine image to the shell."
20734 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
20736 "The format of the disk image is auto-detected. To override this and force a "
20737 "particular format use the I<--format=..> option."
20742 #: ../fish/guestfish.pod:177
20744 "Using this flag is mostly equivalent to using the C<add> command, with "
20745 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20746 "the I<--format:...> flag was given."
20751 #: ../fish/guestfish.pod:181
20757 #: ../fish/guestfish.pod:183
20758 msgid "B<--connect URI>"
20763 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
20765 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20766 "URI to use. The default is to use the default libvirt connection."
20771 #: ../fish/guestfish.pod:189
20777 #: ../fish/guestfish.pod:191
20779 "If using the I<--listen> option and a csh-like shell, use this option. See "
20780 "section L</REMOTE CONTROL AND CSH> below."
20785 #: ../fish/guestfish.pod:194
20786 msgid "B<-d libvirt-domain>"
20791 #: ../fish/guestfish.pod:196
20792 msgid "B<--domain libvirt-domain>"
20797 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
20799 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20800 "used, then any libvirt domain can be used. However in write mode, only "
20801 "libvirt domains which are shut down can be named here."
20806 #: ../fish/guestfish.pod:202
20808 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20809 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20810 "if the I<--format:...> flag was given."
20815 #: ../fish/guestfish.pod:206
20821 #: ../fish/guestfish.pod:208
20822 msgid "B<--no-dest-paths>"
20827 #: ../fish/guestfish.pod:210
20829 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20830 "to hit the tab key to complete paths on the guest filesystem, but this "
20831 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20832 "allow this feature to be disabled."
20837 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
20838 msgid "B<--echo-keys>"
20843 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
20845 "When prompting for keys and passphrases, guestfish normally turns echoing "
20846 "off so you cannot see what you are typing. If you are not worried about "
20847 "Tempest attacks and there is no one else in the room you can specify this "
20848 "flag to see what you are typing."
20853 #: ../fish/guestfish.pod:222
20859 #: ../fish/guestfish.pod:224
20860 msgid "B<--file file>"
20865 #: ../fish/guestfish.pod:226
20866 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20871 #: ../fish/guestfish.pod:229
20874 " #!/usr/bin/guestfish -f\n"
20880 #: ../fish/guestfish.pod:231
20881 msgid "B<--format=raw|qcow2|..>"
20886 #: ../fish/guestfish.pod:233
20887 msgid "B<--format>"
20892 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
20894 "The default for the I<-a> option is to auto-detect the format of the disk "
20895 "image. Using this forces the disk format for I<-a> options which follow on "
20896 "the command line. Using I<--format> with no argument switches back to auto-"
20897 "detection for subsequent I<-a> options."
20902 #: ../fish/guestfish.pod:242
20905 " guestfish --format=raw -a disk.img\n"
20911 #: ../fish/guestfish.pod:244
20912 msgid "forces raw format (no auto-detection) for C<disk.img>."
20917 #: ../fish/guestfish.pod:246
20920 " guestfish --format=raw -a disk.img --format -a another.img\n"
20926 #: ../fish/guestfish.pod:248
20928 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20929 "detection for C<another.img>."
20934 #: ../fish/guestfish.pod:251
20936 "If you have untrusted raw-format guest disk images, you should use this "
20937 "option to specify the disk format. This avoids a possible security problem "
20938 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20943 #: ../fish/guestfish.pod:256
20949 #: ../fish/guestfish.pod:258
20950 msgid "B<--inspector>"
20955 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
20957 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20958 "system and mount filesystems as they would be mounted on the real virtual "
20964 #: ../fish/guestfish.pod:264
20965 msgid "Typical usage is either:"
20970 #: ../fish/guestfish.pod:266
20973 " guestfish -d myguest -i\n"
20979 #: ../fish/guestfish.pod:268
20980 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20985 #: ../fish/guestfish.pod:270
20988 " guestfish --ro -d myguest -i\n"
20994 #: ../fish/guestfish.pod:272
20995 msgid "(for active domains, readonly), or specify the block device directly:"
21000 #: ../fish/guestfish.pod:274
21003 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21009 #: ../fish/guestfish.pod:276
21011 "Note that the command line syntax changed slightly over older versions of "
21012 "guestfish. You can still use the old syntax:"
21017 #: ../fish/guestfish.pod:279
21020 " guestfish [--ro] -i disk.img\n"
21026 #: ../fish/guestfish.pod:281
21029 " guestfish [--ro] -i libvirt-domain\n"
21035 #: ../fish/guestfish.pod:283
21037 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21038 "then using other commands to mount the filesystems that were found."
21043 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21044 msgid "B<--keys-from-stdin>"
21049 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21051 "Read key or passphrase parameters from stdin. The default is to try to read "
21052 "passphrases from the user by opening C</dev/tty>."
21057 #: ../fish/guestfish.pod:292
21058 msgid "B<--listen>"
21063 #: ../fish/guestfish.pod:294
21065 "Fork into the background and listen for remote commands. See section L</"
21066 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21071 #: ../fish/guestfish.pod:297
21072 msgid "B<-m dev[:mountpoint]>"
21077 #: ../fish/guestfish.pod:299
21078 msgid "B<--mount dev[:mountpoint]>"
21083 #: ../fish/guestfish.pod:301
21084 msgid "Mount the named partition or logical volume on the given mountpoint."
21089 #: ../fish/guestfish.pod:303
21090 msgid "If the mountpoint is omitted, it defaults to C</>."
21095 #: ../fish/guestfish.pod:305
21096 msgid "You have to mount something on C</> before most commands will work."
21101 #: ../fish/guestfish.pod:307
21103 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21109 #: ../fish/guestfish.pod:310
21111 "If you don't know what filesystems a disk image contains, you can either run "
21112 "guestfish without this option, then list the partitions, filesystems and LVs "
21113 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21114 "commands), or you can use the L<virt-filesystems(1)> program."
21119 #: ../fish/guestfish.pod:316
21121 "Using this flag is mostly equivalent to using the C<mount-options> command "
21122 "or the C<mount-ro> command if the I<--ro> flag was given."
21127 #: ../fish/guestfish.pod:319
21133 #: ../fish/guestfish.pod:321
21134 msgid "B<--no-sync>"
21139 #: ../fish/guestfish.pod:323
21141 "Disable autosync. This is enabled by default. See the discussion of "
21142 "autosync in the L<guestfs(3)> manpage."
21147 #: ../fish/guestfish.pod:326
21153 #: ../fish/guestfish.pod:328
21154 msgid "B<--new type>"
21159 #: ../fish/guestfish.pod:330
21165 #: ../fish/guestfish.pod:332
21167 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
21168 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
21169 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
21175 #: ../fish/guestfish.pod:337
21176 msgid "B<--progress-bars>"
21181 #: ../fish/guestfish.pod:339
21182 msgid "Enable progress bars, even when guestfish is used non-interactively."
21187 #: ../fish/guestfish.pod:341
21189 "Progress bars are enabled by default when guestfish is used as an "
21190 "interactive shell."
21195 #: ../fish/guestfish.pod:344
21196 msgid "B<--no-progress-bars>"
21201 #: ../fish/guestfish.pod:346
21202 msgid "Disable progress bars."
21207 #: ../fish/guestfish.pod:348
21208 msgid "B<--remote[=pid]>"
21213 #: ../fish/guestfish.pod:350
21215 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
21216 "CONTROL GUESTFISH OVER A SOCKET> below."
21221 #: ../fish/guestfish.pod:353
21227 #: ../fish/guestfish.pod:355
21233 #: ../fish/guestfish.pod:357
21235 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21236 "mounts are done read-only."
21241 #: ../fish/guestfish.pod:360
21243 "The option must always be used if the disk image or virtual machine might be "
21244 "running, and is generally recommended in cases where you don't need write "
21245 "access to the disk."
21250 #: ../fish/guestfish.pod:364
21252 "Note that prepared disk images created with I<-N> are not affected by this "
21253 "option. Also commands like C<add> are not affected - you have to specify "
21254 "the C<readonly:true> option explicitly if you need it."
21259 #: ../fish/guestfish.pod:368
21260 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21265 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
21266 msgid "B<--selinux>"
21271 #: ../fish/guestfish.pod:372
21272 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21277 #: ../fish/guestfish.pod:374
21283 #: ../fish/guestfish.pod:376
21284 msgid "B<--verbose>"
21289 #: ../fish/guestfish.pod:378
21291 "Enable very verbose messages. This is particularly useful if you find a bug."
21296 #: ../fish/guestfish.pod:381
21302 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:88
21303 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
21304 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114
21305 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
21306 msgid "B<--version>"
21311 #: ../fish/guestfish.pod:385
21312 msgid "Display the guestfish / libguestfs version number and exit."
21317 #: ../fish/guestfish.pod:387
21323 #: ../fish/guestfish.pod:389
21329 #: ../fish/guestfish.pod:391
21331 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
21337 #: ../fish/guestfish.pod:394
21343 #: ../fish/guestfish.pod:396
21344 msgid "Echo each command before executing it."
21349 #: ../fish/guestfish.pod:400
21350 msgid "COMMANDS ON COMMAND LINE"
21355 #: ../fish/guestfish.pod:402
21357 "Any additional (non-option) arguments are treated as commands to execute."
21362 #: ../fish/guestfish.pod:405
21364 "Commands to execute should be separated by a colon (C<:>), where the colon "
21365 "is a separate parameter. Thus:"
21370 #: ../fish/guestfish.pod:408
21373 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21379 #: ../fish/guestfish.pod:410
21381 "If there are no additional arguments, then we enter a shell, either an "
21382 "interactive shell with a prompt (if the input is a terminal) or a non-"
21383 "interactive shell."
21388 #: ../fish/guestfish.pod:414
21390 "In either command line mode or non-interactive shell, the first command that "
21391 "gives an error causes the whole shell to exit. In interactive mode (with a "
21392 "prompt) if a command fails, you can continue to enter commands."
21397 #: ../fish/guestfish.pod:419
21398 msgid "USING launch (OR run)"
21403 #: ../fish/guestfish.pod:421
21405 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21406 "then launch it, then mount any disks you need, and finally issue actions/"
21407 "commands. So the general order of the day is:"
21412 #: ../fish/guestfish.pod:429
21413 msgid "add or -a/--add"
21418 #: ../fish/guestfish.pod:433
21419 msgid "launch (aka run)"
21424 #: ../fish/guestfish.pod:437
21425 msgid "mount or -m/--mount"
21430 #: ../fish/guestfish.pod:441
21431 msgid "any other commands"
21436 #: ../fish/guestfish.pod:445
21438 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21439 "guest before mounting or performing any other commands."
21444 #: ../fish/guestfish.pod:448
21446 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21447 "I<--new> options were given then C<run> is done automatically, simply "
21448 "because guestfish can't perform the action you asked for without doing this."
21453 #: ../fish/guestfish.pod:453
21454 msgid "OPENING DISKS FOR READ AND WRITE"
21459 #: ../fish/guestfish.pod:455
21461 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
21462 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
21463 "open disk images read-only or for writing."
21468 #: ../fish/guestfish.pod:459
21470 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
21471 "disk images supplied on the command line for write. To open a disk image "
21472 "read-only you have to do I<-a image --ro>."
21477 #: ../fish/guestfish.pod:463
21479 "This matters: If you accidentally open a live VM disk image writable then "
21480 "you will cause irreversible disk corruption."
21484 #: ../fish/guestfish.pod:466
21486 "By libguestfs 1.10 we intend to change the default the other way. Disk "
21487 "images will be opened read-only. You will have to either specify "
21488 "I<guestfish --rw> or change a configuration file in order to get write "
21489 "access for disk images specified by those other command line options."
21494 #: ../fish/guestfish.pod:471
21496 "This version of guestfish has a I<--rw> option which does nothing (it is "
21497 "already the default). However it is highly recommended that you use this "
21498 "option to indicate that guestfish needs write access, and to prepare your "
21499 "scripts for the day when this option will be required for write access."
21504 #: ../fish/guestfish.pod:477
21506 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21507 "other libguestfs program apart from guestfish and guestmount."
21512 #: ../fish/guestfish.pod:480
21518 #: ../fish/guestfish.pod:482
21520 "You can quote ordinary parameters using either single or double quotes. For "
21526 #: ../fish/guestfish.pod:485
21529 " add \"file with a space.img\"\n"
21535 #: ../fish/guestfish.pod:487
21538 " rm '/file name'\n"
21544 #: ../fish/guestfish.pod:489
21553 #: ../fish/guestfish.pod:491
21555 "A few commands require a list of strings to be passed. For these, use a "
21556 "whitespace-separated list, enclosed in quotes. Strings containing "
21557 "whitespace to be passed through must be enclosed in single quotes. A "
21558 "literal single quote must be escaped with a backslash."
21563 #: ../fish/guestfish.pod:496
21566 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21567 " command \"/bin/echo 'foo bar'\"\n"
21568 " command \"/bin/echo \\'foo\\'\"\n"
21574 #: ../fish/guestfish.pod:500
21575 msgid "OPTIONAL ARGUMENTS"
21580 #: ../fish/guestfish.pod:502
21582 "Some commands take optional arguments. These arguments appear in this "
21583 "documentation as C<[argname:..]>. You can use them as in these examples:"
21588 #: ../fish/guestfish.pod:506
21591 " add-drive-opts filename\n"
21597 #: ../fish/guestfish.pod:508
21600 " add-drive-opts filename readonly:true\n"
21606 #: ../fish/guestfish.pod:510
21609 " add-drive-opts filename format:qcow2 readonly:false\n"
21615 #: ../fish/guestfish.pod:512
21617 "Each optional argument can appear at most once. All optional arguments must "
21618 "appear after the required ones."
21623 #: ../fish/guestfish.pod:515
21629 #: ../fish/guestfish.pod:517
21631 "This section applies to all commands which can take integers as parameters."
21636 #: ../fish/guestfish.pod:520
21637 msgid "SIZE SUFFIX"
21642 #: ../fish/guestfish.pod:522
21644 "When the command takes a parameter measured in bytes, you can use one of the "
21645 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21650 #: ../fish/guestfish.pod:528
21651 msgid "B<k> or B<K> or B<KiB>"
21656 #: ../fish/guestfish.pod:530
21657 msgid "The size in kilobytes (multiplied by 1024)."
21662 #: ../fish/guestfish.pod:532
21668 #: ../fish/guestfish.pod:534
21669 msgid "The size in SI 1000 byte units."
21674 #: ../fish/guestfish.pod:536
21675 msgid "B<M> or B<MiB>"
21680 #: ../fish/guestfish.pod:538
21681 msgid "The size in megabytes (multiplied by 1048576)."
21686 #: ../fish/guestfish.pod:540
21692 #: ../fish/guestfish.pod:542
21693 msgid "The size in SI 1000000 byte units."
21698 #: ../fish/guestfish.pod:544
21699 msgid "B<G> or B<GiB>"
21704 #: ../fish/guestfish.pod:546
21705 msgid "The size in gigabytes (multiplied by 2**30)."
21710 #: ../fish/guestfish.pod:548
21716 #: ../fish/guestfish.pod:550
21717 msgid "The size in SI 10**9 byte units."
21722 #: ../fish/guestfish.pod:552
21723 msgid "B<T> or B<TiB>"
21728 #: ../fish/guestfish.pod:554
21729 msgid "The size in terabytes (multiplied by 2**40)."
21734 #: ../fish/guestfish.pod:556
21740 #: ../fish/guestfish.pod:558
21741 msgid "The size in SI 10**12 byte units."
21746 #: ../fish/guestfish.pod:560
21747 msgid "B<P> or B<PiB>"
21752 #: ../fish/guestfish.pod:562
21753 msgid "The size in petabytes (multiplied by 2**50)."
21758 #: ../fish/guestfish.pod:564
21764 #: ../fish/guestfish.pod:566
21765 msgid "The size in SI 10**15 byte units."
21770 #: ../fish/guestfish.pod:568
21771 msgid "B<E> or B<EiB>"
21776 #: ../fish/guestfish.pod:570
21777 msgid "The size in exabytes (multiplied by 2**60)."
21782 #: ../fish/guestfish.pod:572
21788 #: ../fish/guestfish.pod:574
21789 msgid "The size in SI 10**18 byte units."
21794 #: ../fish/guestfish.pod:576
21795 msgid "B<Z> or B<ZiB>"
21800 #: ../fish/guestfish.pod:578
21801 msgid "The size in zettabytes (multiplied by 2**70)."
21806 #: ../fish/guestfish.pod:580
21812 #: ../fish/guestfish.pod:582
21813 msgid "The size in SI 10**21 byte units."
21818 #: ../fish/guestfish.pod:584
21819 msgid "B<Y> or B<YiB>"
21824 #: ../fish/guestfish.pod:586
21825 msgid "The size in yottabytes (multiplied by 2**80)."
21830 #: ../fish/guestfish.pod:588
21836 #: ../fish/guestfish.pod:590
21837 msgid "The size in SI 10**24 byte units."
21842 #: ../fish/guestfish.pod:596
21845 " truncate-size /file 1G\n"
21851 #: ../fish/guestfish.pod:598
21852 msgid "would truncate the file to 1 gigabyte."
21857 #: ../fish/guestfish.pod:600
21859 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21860 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21861 "suffix will probably not do what you expect."
21866 #: ../fish/guestfish.pod:604
21867 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21872 #: ../fish/guestfish.pod:606
21874 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21875 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21880 #: ../fish/guestfish.pod:609
21883 " 1234 decimal number 1234\n"
21884 " 02322 octal number, equivalent to decimal 1234\n"
21885 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21891 #: ../fish/guestfish.pod:613
21893 "When using the C<chmod> command, you almost always want to specify an octal "
21894 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21895 "L<chmod(1)> program):"
21900 #: ../fish/guestfish.pod:617
21903 " chmod 0777 /public # OK\n"
21904 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21910 #: ../fish/guestfish.pod:620
21912 "Commands that return numbers usually print them in decimal, but some "
21913 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21914 "octal, preceeded by C<0>)."
21919 #: ../fish/guestfish.pod:624
21920 msgid "WILDCARDS AND GLOBBING"
21925 #: ../fish/guestfish.pod:626
21927 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21928 "(globbing) by default. So for example the following will not do what you "
21934 #: ../fish/guestfish.pod:630
21943 #: ../fish/guestfish.pod:632
21945 "Assuming you don't have a directory called literally C</home/*> then the "
21946 "above command will return an error."
21951 #: ../fish/guestfish.pod:635
21952 msgid "To perform wildcard expansion, use the C<glob> command."
21957 #: ../fish/guestfish.pod:637
21960 " glob rm-rf /home/*\n"
21966 #: ../fish/guestfish.pod:639
21968 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21969 "many times), equivalent to:"
21974 #: ../fish/guestfish.pod:642
21977 " rm-rf /home/jim\n"
21978 " rm-rf /home/joe\n"
21979 " rm-rf /home/mary\n"
21985 #: ../fish/guestfish.pod:646
21986 msgid "C<glob> only works on simple guest paths and not on device names."
21991 #: ../fish/guestfish.pod:648
21993 "If you have several parameters, each containing a wildcard, then glob will "
21994 "perform a Cartesian product."
21999 #: ../fish/guestfish.pod:651
22005 #: ../fish/guestfish.pod:653
22007 "Any line which starts with a I<#> character is treated as a comment and "
22008 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22009 "a command. For example:"
22014 #: ../fish/guestfish.pod:657
22017 " # this is a comment\n"
22018 " # this is a comment\n"
22019 " foo # NOT a comment\n"
22025 #: ../fish/guestfish.pod:661
22026 msgid "Blank lines are also ignored."
22031 #: ../fish/guestfish.pod:663
22032 msgid "RUNNING COMMANDS LOCALLY"
22037 #: ../fish/guestfish.pod:665
22039 "Any line which starts with a I<!> character is treated as a command sent to "
22040 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22045 #: ../fish/guestfish.pod:669
22049 " tgz-out /remote local/remote-data.tar.gz\n"
22055 #: ../fish/guestfish.pod:672
22057 "will create a directory C<local> on the host, and then export the contents "
22058 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22059 "(See C<tgz-out>)."
22064 #: ../fish/guestfish.pod:676
22066 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22067 "effect, due to the way that subprocesses work in Unix."
22072 #: ../fish/guestfish.pod:679
22078 #: ../fish/guestfish.pod:681
22080 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
22081 "command (a guestfish command) to the second command (any host command). For "
22087 #: ../fish/guestfish.pod:685
22090 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
22096 #: ../fish/guestfish.pod:687
22098 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
22099 "program). The above command would list all accounts in the guest filesystem "
22100 "which have UID 0, ie. root accounts including backdoors. Other examples:"
22105 #: ../fish/guestfish.pod:692
22108 " hexdump /bin/ls | head\n"
22109 " list-devices | tail -1\n"
22110 " tgz-out / - | tar ztf -\n"
22116 #: ../fish/guestfish.pod:696
22118 "The space before the pipe symbol is required, any space after the pipe "
22119 "symbol is optional. Everything after the pipe symbol is just passed "
22120 "straight to the host shell, so it can contain redirections, globs and "
22121 "anything else that makes sense on the host side."
22126 #: ../fish/guestfish.pod:701
22128 "To use a literal argument which begins with a pipe symbol, you have to quote "
22134 #: ../fish/guestfish.pod:704
22143 #: ../fish/guestfish.pod:706
22144 msgid "HOME DIRECTORIES"
22149 #: ../fish/guestfish.pod:708
22151 "If a parameter starts with the character C<~> then the tilde may be expanded "
22152 "as a home directory path (either C<~> for the current user's home directory, "
22153 "or C<~user> for another user)."
22158 #: ../fish/guestfish.pod:712
22160 "Note that home directory expansion happens for users known I<on the host>, "
22161 "not in the guest filesystem."
22166 #: ../fish/guestfish.pod:715
22168 "To use a literal argument which begins with a tilde, you have to quote it, "
22174 #: ../fish/guestfish.pod:718
22183 #: ../fish/guestfish.pod:722
22185 "Libguestfs has some support for Linux guests encrypted according to the "
22186 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22187 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22188 "LUKS is supported."
22193 #: ../fish/guestfish.pod:727
22194 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22199 #: ../fish/guestfish.pod:729
22202 " ><fs> vfs-type /dev/sda2\n"
22209 #: ../fish/guestfish.pod:732
22211 "Then open those devices using L</luks-open>. This creates a device-mapper "
22212 "device called C</dev/mapper/luksdev>."
22217 #: ../fish/guestfish.pod:735
22220 " ><fs> luks-open /dev/sda2 luksdev\n"
22221 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22227 #: ../fish/guestfish.pod:738
22229 "Finally you have to tell LVM to scan for volume groups on the newly created "
22235 #: ../fish/guestfish.pod:741
22239 " vg-activate-all true\n"
22245 #: ../fish/guestfish.pod:744
22246 msgid "The logical volume(s) can now be mounted in the usual way."
22251 #: ../fish/guestfish.pod:746
22253 "Before closing a LUKS device you must unmount any logical volumes on it and "
22254 "deactivate the volume groups by calling C<vg-activate false VG> on each "
22255 "one. Then you can close the mapper device:"
22260 #: ../fish/guestfish.pod:750
22263 " vg-activate false /dev/VG\n"
22264 " luks-close /dev/mapper/luksdev\n"
22270 #: ../fish/guestfish.pod:753
22271 msgid "WINDOWS PATHS"
22276 #: ../fish/guestfish.pod:755
22278 "If a path is prefixed with C<win:> then you can use Windows-style paths "
22279 "(with some limitations). The following commands are equivalent:"
22284 #: ../fish/guestfish.pod:758
22287 " file /WINDOWS/system32/config/system.LOG\n"
22293 #: ../fish/guestfish.pod:760
22296 " file win:/windows/system32/config/system.log\n"
22302 #: ../fish/guestfish.pod:762
22305 " file win:\\windows\\system32\\config\\system.log\n"
22311 #: ../fish/guestfish.pod:764
22314 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
22320 #: ../fish/guestfish.pod:766
22322 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
22323 "handles case insensitivity like Windows would. This only works in argument "
22324 "positions that expect a path."
22329 #: ../fish/guestfish.pod:770
22330 msgid "UPLOADING AND DOWNLOADING FILES"
22335 #: ../fish/guestfish.pod:772
22337 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22338 "others which upload from or download to a local file, you can use the "
22339 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22344 #: ../fish/guestfish.pod:776
22353 #: ../fish/guestfish.pod:778
22355 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22360 #: ../fish/guestfish.pod:781
22363 " tar-out /etc - | tar tf -\n"
22369 #: ../fish/guestfish.pod:783
22371 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22372 "command (see L</PIPES>)."
22377 #: ../fish/guestfish.pod:786
22379 "When using C<-> to read from stdin, the input is read up to the end of "
22380 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22381 "some arbitrary end marker:"
22386 #: ../fish/guestfish.pod:790
22389 " upload -<<END /foo\n"
22399 #: ../fish/guestfish.pod:796
22401 "Any string of characters can be used instead of C<END>. The end marker must "
22402 "appear on a line of its own, without any preceeding or following characters "
22403 "(not even spaces)."
22408 #: ../fish/guestfish.pod:800
22410 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22411 "upload local files (so-called \"FileIn\" parameters in the generator)."
22416 #: ../fish/guestfish.pod:803
22417 msgid "EXIT ON ERROR BEHAVIOUR"
22422 #: ../fish/guestfish.pod:805
22424 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22425 "taking commands from a human over a tty), and will exit on the first error "
22426 "in non-interactive mode (scripts, commands given on the command line)."
22431 #: ../fish/guestfish.pod:810
22433 "If you prefix a command with a I<-> character, then that command will not "
22434 "cause guestfish to exit, even if that (one) command returns an error."
22439 #: ../fish/guestfish.pod:814
22440 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22445 #: ../fish/guestfish.pod:816
22447 "Guestfish can be remote-controlled over a socket. This is useful "
22448 "particularly in shell scripts where you want to make several different "
22449 "changes to a filesystem, but you don't want the overhead of starting up a "
22450 "guestfish process each time."
22455 #: ../fish/guestfish.pod:821
22456 msgid "Start a guestfish server process using:"
22461 #: ../fish/guestfish.pod:823
22464 " eval \"`guestfish --listen`\"\n"
22470 #: ../fish/guestfish.pod:825
22471 msgid "and then send it commands by doing:"
22476 #: ../fish/guestfish.pod:827
22479 " guestfish --remote cmd [...]\n"
22485 #: ../fish/guestfish.pod:829
22486 msgid "To cause the server to exit, send it the exit command:"
22491 #: ../fish/guestfish.pod:831
22494 " guestfish --remote exit\n"
22500 #: ../fish/guestfish.pod:833
22502 "Note that the server will normally exit if there is an error in a command. "
22503 "You can change this in the usual way. See section L</EXIT ON ERROR "
22509 #: ../fish/guestfish.pod:837
22510 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22515 #: ../fish/guestfish.pod:839
22517 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22518 "is how the I<--remote> option knows where to send the commands. You can "
22519 "have several guestfish listener processes running using:"
22524 #: ../fish/guestfish.pod:843
22527 " eval \"`guestfish --listen`\"\n"
22528 " pid1=$GUESTFISH_PID\n"
22529 " eval \"`guestfish --listen`\"\n"
22530 " pid2=$GUESTFISH_PID\n"
22532 " guestfish --remote=$pid1 cmd\n"
22533 " guestfish --remote=$pid2 cmd\n"
22539 #: ../fish/guestfish.pod:851
22540 msgid "REMOTE CONTROL AND CSH"
22545 #: ../fish/guestfish.pod:853
22547 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22553 #: ../fish/guestfish.pod:856
22556 " eval \"`guestfish --listen --csh`\"\n"
22562 #: ../fish/guestfish.pod:858
22563 msgid "REMOTE CONTROL DETAILS"
22568 #: ../fish/guestfish.pod:860
22570 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22571 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22572 "and C<$PID> is the process ID of the server."
22577 #: ../fish/guestfish.pod:864
22578 msgid "Guestfish client and server versions must match exactly."
22583 #: ../fish/guestfish.pod:866
22584 msgid "PREPARED DISK IMAGES"
22589 #: ../fish/guestfish.pod:868
22591 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22592 "preformatted disk images that guestfish can make for you to save typing. "
22593 "This is particularly useful for testing purposes. This option is used "
22594 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22595 "can be mixed with I<-a>)."
22600 #: ../fish/guestfish.pod:874
22602 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22603 "the second and so on. Existing files in the current directory are "
22609 #: ../fish/guestfish.pod:878
22611 "The type briefly describes how the disk should be sized, partitioned, how "
22612 "filesystem(s) should be created, and how content should be added. "
22613 "Optionally the type can be followed by extra parameters, separated by C<:> "
22614 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22615 "allocated disk, containing a single partition, with the partition formatted "
22616 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22622 #: ../fish/guestfish.pod:886
22623 msgid "To list the available types and any extra parameters they take, run:"
22628 #: ../fish/guestfish.pod:890
22630 "Note that the prepared filesystem is not mounted. You would usually have to "
22631 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22636 #: ../fish/guestfish.pod:894
22638 "If any I<-N> or I<--new> options are given, the guest is automatically "
22644 #: ../fish/guestfish.pod:899
22645 msgid "Create a 100MB disk with an ext4-formatted partition:"
22650 #: ../fish/guestfish.pod:901
22653 " guestfish -N fs:ext4\n"
22659 #: ../fish/guestfish.pod:903
22660 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22665 #: ../fish/guestfish.pod:905
22668 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22674 #: ../fish/guestfish.pod:907
22675 msgid "Create a blank 200MB disk:"
22680 #: ../fish/guestfish.pod:909
22683 " guestfish -N disk:200M\n"
22689 #: ../fish/guestfish.pod:911
22690 msgid "PROGRESS BARS"
22695 #: ../fish/guestfish.pod:913
22697 "Some (not all) long-running commands send progress notification messages as "
22698 "they are running. Guestfish turns these messages into progress bars."
22703 #: ../fish/guestfish.pod:917
22705 "When a command that supports progress bars takes longer than two seconds to "
22706 "run, and if progress bars are enabled, then you will see one appearing below "
22712 #: ../fish/guestfish.pod:921
22715 " ><fs> copy-size /large-file /another-file 2048M\n"
22716 " / 10% [#####-----------------------------------------] 00:30\n"
22722 #: ../fish/guestfish.pod:924
22724 "The spinner on the left hand side moves round once for every progress "
22725 "notification received from the backend. This is a (reasonably) golden "
22726 "assurance that the command is \"doing something\" even if the progress bar "
22727 "is not moving, because the command is able to send the progress "
22728 "notifications. When the bar reaches 100% and the command finishes, the "
22729 "spinner disappears."
22734 #: ../fish/guestfish.pod:931
22736 "Progress bars are enabled by default when guestfish is used interactively. "
22737 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22738 "and you can disable them completely using I<--no-progress-bars>."
22743 #: ../fish/guestfish.pod:936
22744 msgid "GUESTFISH COMMANDS"
22749 #: ../fish/guestfish.pod:938
22751 "The commands in this section are guestfish convenience commands, in other "
22752 "words, they are not part of the L<guestfs(3)> API."
22757 #: ../fish/guestfish.pod:941
22763 #: ../fish/guestfish.pod:943
22773 #: ../fish/guestfish.pod:946
22774 msgid "Without any parameter, this provides general help."
22779 #: ../fish/guestfish.pod:948
22780 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22785 #: ../fish/guestfish.pod:950
22786 msgid "quit | exit"
22791 #: ../fish/guestfish.pod:952
22792 msgid "This exits guestfish. You can also use C<^D> key."
22797 #: ../fish/guestfish.pod:954
22798 msgid "@FISH_COMMANDS@"
22803 #: ../fish/guestfish.pod:956
22809 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
22815 #: ../fish/guestfish.pod:962
22817 "guestfish returns 0 if the commands completed without error, or 1 if there "
22823 #: ../fish/guestfish.pod:969
22829 #: ../fish/guestfish.pod:971
22831 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22837 #: ../fish/guestfish.pod:974
22838 msgid "GUESTFISH_PID"
22843 #: ../fish/guestfish.pod:976
22845 "Used with the I<--remote> option to specify the remote guestfish process to "
22846 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22851 #: ../fish/guestfish.pod:980
22857 #: ../fish/guestfish.pod:982
22859 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22860 "not specified, the external L<hexedit(1)> program is used."
22865 #: ../fish/guestfish.pod:986
22871 #: ../fish/guestfish.pod:988
22873 "If compiled with GNU readline support, various files in the home directory "
22874 "can be used. See L</FILES>."
22879 #: ../fish/guestfish.pod:997
22881 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22882 "effect as using the B<-v> option."
22887 #: ../fish/guestfish.pod:1009
22889 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22890 "the discussion of paths in L<guestfs(3)>."
22895 #: ../fish/guestfish.pod:1020
22896 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22901 #: ../fish/guestfish.pod:1022
22907 #: ../fish/guestfish.pod:1024
22909 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22915 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
22921 #: ../fish/guestfish.pod:1043
22922 msgid "$HOME/.guestfish"
22927 #: ../fish/guestfish.pod:1045
22929 "If compiled with GNU readline support, then the command history is saved in "
22935 #: ../fish/guestfish.pod:1048
22936 msgid "$HOME/.inputrc"
22941 #: ../fish/guestfish.pod:1050
22942 msgid "/etc/inputrc"
22947 #: ../fish/guestfish.pod:1052
22949 "If compiled with GNU readline support, then these files can be used to "
22950 "configure readline. For further information, please see L<readline(3)/"
22951 "INITIALIZATION FILE>."
22956 #: ../fish/guestfish.pod:1056
22957 msgid "To write rules which only apply to guestfish, use:"
22962 #: ../fish/guestfish.pod:1058
22973 #: ../fish/guestfish.pod:1062
22975 "Variables that you can set in inputrc that change the behaviour of guestfish "
22976 "in useful ways include:"
22981 #: ../fish/guestfish.pod:1067
22982 msgid "completion-ignore-case (default: on)"
22987 #: ../fish/guestfish.pod:1069
22989 "By default, guestfish will ignore case when tab-completing paths on the "
22995 #: ../fish/guestfish.pod:1072
22998 " set completion-ignore-case off\n"
23004 #: ../fish/guestfish.pod:1074
23005 msgid "to make guestfish case sensitive."
23010 #: ../fish/guestfish.pod:1078
23016 #: ../fish/guestfish.pod:1080
23017 msgid "test2.img (etc)"
23022 #: ../fish/guestfish.pod:1082
23024 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
23025 "will be created in the file C<test1.img> in the current directory. The "
23026 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
23027 "the same name will be overwritten."
23032 #: ../fish/guestfish.pod:1091
23034 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
23035 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
23036 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
23037 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
23043 #: ../fish/guestfish.pod:1117 ../test-tool/libguestfs-test-tool.pod:124
23044 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
23045 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512
23046 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
23047 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
23049 "This program is free software; you can redistribute it and/or modify it "
23050 "under the terms of the GNU General Public License as published by the Free "
23051 "Software Foundation; either version 2 of the License, or (at your option) "
23052 "any later version."
23057 #: ../fish/guestfish.pod:1122 ../test-tool/libguestfs-test-tool.pod:129
23058 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
23059 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517
23060 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
23061 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
23063 "This program is distributed in the hope that it will be useful, but WITHOUT "
23064 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
23065 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
23071 #: ../fish/guestfish.pod:1127 ../test-tool/libguestfs-test-tool.pod:134
23072 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
23073 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522
23074 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
23075 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
23077 "You should have received a copy of the GNU General Public License along with "
23078 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
23079 "Ave, Cambridge, MA 02139, USA."
23084 #: ../fish/guestfish-actions.pod:1
23090 #: ../fish/guestfish-actions.pod:3
23093 " add-cdrom filename\n"
23099 #: ../fish/guestfish-actions.pod:15
23101 "This call checks for the existence of C<filename>. This stops you from "
23102 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23103 "and C<http:> URLs. To specify those, use the general L</config> call "
23109 #: ../fish/guestfish-actions.pod:22
23111 "If you just want to add an ISO file (often you use this as an efficient way "
23112 "to transfer large files into the guest), then you should probably use L</add-"
23113 "drive-ro> instead."
23118 #: ../fish/guestfish-actions.pod:35
23124 #: ../fish/guestfish-actions.pod:37
23130 #: ../fish/guestfish-actions.pod:39
23133 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
23139 #: ../fish/guestfish-actions.pod:41
23141 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
23142 "It works by connecting to libvirt, requesting the domain and domain XML from "
23143 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
23148 #: ../fish/guestfish-actions.pod:64
23150 "The other optional parameters are passed directly through to L</add-drive-"
23156 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131
23157 #: ../fish/guestfish-actions.pod:2848
23159 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
23164 #: ../fish/guestfish-actions.pod:69
23170 #: ../fish/guestfish-actions.pod:71
23173 " add-drive filename\n"
23179 #: ../fish/guestfish-actions.pod:73
23181 "This function is the equivalent of calling L</add-drive-opts> with no "
23182 "optional parameters, so the disk is added writable, with the format being "
23183 "detected automatically."
23188 #: ../fish/guestfish-actions.pod:77
23190 "Automatic detection of the format opens you up to a potential security hole "
23191 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
23192 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
23193 "you should think about replacing calls to this function with calls to L</add-"
23194 "drive-opts>, and specifying the format."
23199 #: ../fish/guestfish-actions.pod:84
23200 msgid "add-drive-opts"
23205 #: ../fish/guestfish-actions.pod:86
23211 #: ../fish/guestfish-actions.pod:88
23214 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
23220 #: ../fish/guestfish-actions.pod:115
23222 "This forces the image format. If you omit this (or use L</add-drive> or L</"
23223 "add-drive-ro>) then the format is automatically detected. Possible formats "
23224 "include C<raw> and C<qcow2>."
23229 #: ../fish/guestfish-actions.pod:126
23231 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
23232 "add-drive-with-if> call (q.v.)"
23237 #: ../fish/guestfish-actions.pod:133
23238 msgid "add-drive-ro"
23243 #: ../fish/guestfish-actions.pod:135
23249 #: ../fish/guestfish-actions.pod:137
23252 " add-drive-ro filename\n"
23258 #: ../fish/guestfish-actions.pod:139
23260 "This function is the equivalent of calling L</add-drive-opts> with the "
23261 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
23262 "is added read-only, with the format being detected automatically."
23267 #: ../fish/guestfish-actions.pod:144
23268 msgid "add-drive-ro-with-if"
23273 #: ../fish/guestfish-actions.pod:146
23276 " add-drive-ro-with-if filename iface\n"
23282 #: ../fish/guestfish-actions.pod:148
23284 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
23285 "interface emulation to use at run time."
23290 #: ../fish/guestfish-actions.pod:158
23291 msgid "add-drive-with-if"
23296 #: ../fish/guestfish-actions.pod:160
23299 " add-drive-with-if filename iface\n"
23305 #: ../fish/guestfish-actions.pod:162
23307 "This is the same as L</add-drive> but it allows you to specify the QEMU "
23308 "interface emulation to use at run time."
23313 #: ../fish/guestfish-actions.pod:172
23319 #: ../fish/guestfish-actions.pod:174
23322 " aug-clear augpath\n"
23328 #: ../fish/guestfish-actions.pod:179
23334 #: ../fish/guestfish-actions.pod:181
23343 #: ../fish/guestfish-actions.pod:183
23345 "Close the current Augeas handle and free up any resources used by it. After "
23346 "calling this, you have to call L</aug-init> again before you can use any "
23347 "other Augeas functions."
23352 #: ../fish/guestfish-actions.pod:188
23353 msgid "aug-defnode"
23358 #: ../fish/guestfish-actions.pod:190
23361 " aug-defnode name expr val\n"
23367 #: ../fish/guestfish-actions.pod:195
23369 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
23370 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
23371 "containing that single node."
23376 #: ../fish/guestfish-actions.pod:203
23382 #: ../fish/guestfish-actions.pod:205
23385 " aug-defvar name expr\n"
23391 #: ../fish/guestfish-actions.pod:214
23397 #: ../fish/guestfish-actions.pod:216
23400 " aug-get augpath\n"
23406 #: ../fish/guestfish-actions.pod:221
23412 #: ../fish/guestfish-actions.pod:223
23415 " aug-init root flags\n"
23421 #: ../fish/guestfish-actions.pod:229
23422 msgid "You must call this before using any other L</aug-*> commands."
23427 #: ../fish/guestfish-actions.pod:264
23428 msgid "Do not load the tree in L</aug-init>."
23433 #: ../fish/guestfish-actions.pod:268
23434 msgid "To close the handle, you can call L</aug-close>."
23439 #: ../fish/guestfish-actions.pod:272
23445 #: ../fish/guestfish-actions.pod:274
23448 " aug-insert augpath label true|false\n"
23454 #: ../fish/guestfish-actions.pod:284
23460 #: ../fish/guestfish-actions.pod:286
23469 #: ../fish/guestfish-actions.pod:293
23475 #: ../fish/guestfish-actions.pod:295
23478 " aug-ls augpath\n"
23484 #: ../fish/guestfish-actions.pod:297
23486 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
23487 "resulting nodes into alphabetical order."
23492 #: ../fish/guestfish-actions.pod:300
23498 #: ../fish/guestfish-actions.pod:302
23501 " aug-match augpath\n"
23507 #: ../fish/guestfish-actions.pod:308
23513 #: ../fish/guestfish-actions.pod:310
23516 " aug-mv src dest\n"
23522 #: ../fish/guestfish-actions.pod:315
23528 #: ../fish/guestfish-actions.pod:317
23531 " aug-rm augpath\n"
23537 #: ../fish/guestfish-actions.pod:323
23543 #: ../fish/guestfish-actions.pod:325
23552 #: ../fish/guestfish-actions.pod:329
23554 "The flags which were passed to L</aug-init> affect exactly how files are "
23560 #: ../fish/guestfish-actions.pod:332
23566 #: ../fish/guestfish-actions.pod:334
23569 " aug-set augpath val\n"
23575 #: ../fish/guestfish-actions.pod:338
23577 "In the Augeas API, it is possible to clear a node by setting the value to "
23578 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23579 "this call. Instead you must use the L</aug-clear> call."
23584 #: ../fish/guestfish-actions.pod:343
23590 #: ../fish/guestfish-actions.pod:345
23593 " available 'groups ...'\n"
23599 #: ../fish/guestfish-actions.pod:351
23601 "The libguestfs groups, and the functions that those groups correspond to, "
23602 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23603 "runtime by calling L</available-all-groups>."
23608 #: ../fish/guestfish-actions.pod:375
23609 msgid "You must call L</launch> before calling this function."
23614 #: ../fish/guestfish-actions.pod:397
23616 "This call was added in version C<1.0.80>. In previous versions of "
23617 "libguestfs all you could do would be to speculatively execute a command to "
23618 "find out if the daemon implemented it. See also L</version>."
23623 #: ../fish/guestfish-actions.pod:404
23624 msgid "available-all-groups"
23629 #: ../fish/guestfish-actions.pod:406
23632 " available-all-groups\n"
23638 #: ../fish/guestfish-actions.pod:408
23640 "This command returns a list of all optional groups that this daemon knows "
23641 "about. Note this returns both supported and unsupported groups. To find "
23642 "out which ones the daemon can actually support you have to call L</"
23643 "available> on each member of the returned list."
23648 #: ../fish/guestfish-actions.pod:414
23649 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23654 #: ../fish/guestfish-actions.pod:416
23660 #: ../fish/guestfish-actions.pod:418
23663 " base64-in (base64file|-) filename\n"
23669 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432
23670 #: ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825
23671 #: ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1221
23672 #: ../fish/guestfish-actions.pod:4203 ../fish/guestfish-actions.pod:4215
23673 #: ../fish/guestfish-actions.pod:4226 ../fish/guestfish-actions.pod:4237
23674 #: ../fish/guestfish-actions.pod:4289 ../fish/guestfish-actions.pod:4298
23675 #: ../fish/guestfish-actions.pod:4352 ../fish/guestfish-actions.pod:4375
23676 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23681 #: ../fish/guestfish-actions.pod:425
23687 #: ../fish/guestfish-actions.pod:427
23690 " base64-out filename (base64file|-)\n"
23696 #: ../fish/guestfish-actions.pod:434
23697 msgid "blockdev-flushbufs"
23702 #: ../fish/guestfish-actions.pod:436
23705 " blockdev-flushbufs device\n"
23711 #: ../fish/guestfish-actions.pod:443
23712 msgid "blockdev-getbsz"
23717 #: ../fish/guestfish-actions.pod:445
23720 " blockdev-getbsz device\n"
23726 #: ../fish/guestfish-actions.pod:454
23727 msgid "blockdev-getro"
23732 #: ../fish/guestfish-actions.pod:456
23735 " blockdev-getro device\n"
23741 #: ../fish/guestfish-actions.pod:463
23742 msgid "blockdev-getsize64"
23747 #: ../fish/guestfish-actions.pod:465
23750 " blockdev-getsize64 device\n"
23756 #: ../fish/guestfish-actions.pod:469
23757 msgid "See also L</blockdev-getsz>."
23762 #: ../fish/guestfish-actions.pod:473
23763 msgid "blockdev-getss"
23768 #: ../fish/guestfish-actions.pod:475
23771 " blockdev-getss device\n"
23777 #: ../fish/guestfish-actions.pod:480
23779 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23784 #: ../fish/guestfish-actions.pod:485
23785 msgid "blockdev-getsz"
23790 #: ../fish/guestfish-actions.pod:487
23793 " blockdev-getsz device\n"
23799 #: ../fish/guestfish-actions.pod:492
23801 "See also L</blockdev-getss> for the real sector size of the device, and L</"
23802 "blockdev-getsize64> for the more useful I<size in bytes>."
23807 #: ../fish/guestfish-actions.pod:498
23808 msgid "blockdev-rereadpt"
23813 #: ../fish/guestfish-actions.pod:500
23816 " blockdev-rereadpt device\n"
23822 #: ../fish/guestfish-actions.pod:506
23823 msgid "blockdev-setbsz"
23828 #: ../fish/guestfish-actions.pod:508
23831 " blockdev-setbsz device blocksize\n"
23837 #: ../fish/guestfish-actions.pod:517
23838 msgid "blockdev-setro"
23843 #: ../fish/guestfish-actions.pod:519
23846 " blockdev-setro device\n"
23852 #: ../fish/guestfish-actions.pod:525
23853 msgid "blockdev-setrw"
23858 #: ../fish/guestfish-actions.pod:527
23861 " blockdev-setrw device\n"
23867 #: ../fish/guestfish-actions.pod:533
23868 msgid "case-sensitive-path"
23873 #: ../fish/guestfish-actions.pod:535
23876 " case-sensitive-path path\n"
23882 #: ../fish/guestfish-actions.pod:559
23884 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
23885 "WINDOWS/system32\"> (the exact return value would depend on details of how "
23886 "the directories were originally created under Windows)."
23891 #: ../fish/guestfish-actions.pod:567
23892 msgid "See also L</realpath>."
23897 #: ../fish/guestfish-actions.pod:569
23903 #: ../fish/guestfish-actions.pod:571
23912 #: ../fish/guestfish-actions.pod:575
23914 "Note that this function cannot correctly handle binary files (specifically, "
23915 "files containing C<\\0> character which is treated as end of string). For "
23916 "those you need to use the L</read-file> or L</download> functions which have "
23917 "a more complex interface."
23922 #: ../fish/guestfish-actions.pod:583
23928 #: ../fish/guestfish-actions.pod:585
23931 " checksum csumtype path\n"
23937 #: ../fish/guestfish-actions.pod:628
23938 msgid "To get the checksum for a device, use L</checksum-device>."
23943 #: ../fish/guestfish-actions.pod:630
23944 msgid "To get the checksums for many files, use L</checksums-out>."
23949 #: ../fish/guestfish-actions.pod:632
23950 msgid "checksum-device"
23955 #: ../fish/guestfish-actions.pod:634
23958 " checksum-device csumtype device\n"
23964 #: ../fish/guestfish-actions.pod:636
23966 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23967 "device named C<device>. For the types of checksums supported see the L</"
23968 "checksum> command."
23973 #: ../fish/guestfish-actions.pod:640
23974 msgid "checksums-out"
23979 #: ../fish/guestfish-actions.pod:642
23982 " checksums-out csumtype directory (sumsfile|-)\n"
23988 #: ../fish/guestfish-actions.pod:658
23994 #: ../fish/guestfish-actions.pod:660
23997 " chmod mode path\n"
24003 #: ../fish/guestfish-actions.pod:671
24009 #: ../fish/guestfish-actions.pod:673
24012 " chown owner group path\n"
24018 #: ../fish/guestfish-actions.pod:681
24024 #: ../fish/guestfish-actions.pod:683
24027 " command 'arguments ...'\n"
24033 #: ../fish/guestfish-actions.pod:690
24035 "The single parameter is an argv-style list of arguments. The first element "
24036 "is the name of the program to run. Subsequent elements are parameters. The "
24037 "list must be non-empty (ie. must contain a program name). Note that the "
24038 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
24043 #: ../fish/guestfish-actions.pod:718
24044 msgid "command-lines"
24049 #: ../fish/guestfish-actions.pod:720
24052 " command-lines 'arguments ...'\n"
24058 #: ../fish/guestfish-actions.pod:722
24060 "This is the same as L</command>, but splits the result into a list of lines."
24065 #: ../fish/guestfish-actions.pod:725
24066 msgid "See also: L</sh-lines>"
24071 #: ../fish/guestfish-actions.pod:730
24077 #: ../fish/guestfish-actions.pod:732
24080 " config qemuparam qemuvalue\n"
24086 #: ../fish/guestfish-actions.pod:743
24092 #: ../fish/guestfish-actions.pod:745
24095 " copy-size src dest size\n"
24101 #: ../fish/guestfish-actions.pod:753
24107 #: ../fish/guestfish-actions.pod:755
24116 #: ../fish/guestfish-actions.pod:760
24122 #: ../fish/guestfish-actions.pod:762
24131 #: ../fish/guestfish-actions.pod:767
24137 #: ../fish/guestfish-actions.pod:769
24146 #: ../fish/guestfish-actions.pod:776
24148 "If the destination is a device, it must be as large or larger than the "
24149 "source file or device, otherwise the copy will fail. This command cannot do "
24150 "partial copies (see L</copy-size>)."
24155 #: ../fish/guestfish-actions.pod:780
24161 #: ../fish/guestfish-actions.pod:782
24170 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
24172 "This command is mostly useful for interactive sessions. It is I<not> "
24173 "intended that you try to parse the output string. Use L</statvfs> from "
24179 #: ../fish/guestfish-actions.pod:790
24185 #: ../fish/guestfish-actions.pod:792
24194 #: ../fish/guestfish-actions.pod:801
24200 #: ../fish/guestfish-actions.pod:803
24209 #: ../fish/guestfish-actions.pod:809
24211 "Another way to get the same information is to enable verbose messages with "
24212 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
24213 "before running the program."
24218 #: ../fish/guestfish-actions.pod:814
24224 #: ../fish/guestfish-actions.pod:816
24227 " download remotefilename (filename|-)\n"
24233 #: ../fish/guestfish-actions.pod:823
24234 msgid "See also L</upload>, L</cat>."
24239 #: ../fish/guestfish-actions.pod:827
24240 msgid "download-offset"
24245 #: ../fish/guestfish-actions.pod:829
24248 " download-offset remotefilename (filename|-) offset size\n"
24254 #: ../fish/guestfish-actions.pod:837
24256 "Note that there is no limit on the amount of data that can be downloaded "
24257 "with this call, unlike with L</pread>, and this call always reads the full "
24258 "amount unless an error occurs."
24263 #: ../fish/guestfish-actions.pod:842
24264 msgid "See also L</download>, L</pread>."
24269 #: ../fish/guestfish-actions.pod:846
24270 msgid "drop-caches"
24275 #: ../fish/guestfish-actions.pod:848
24278 " drop-caches whattodrop\n"
24284 #: ../fish/guestfish-actions.pod:860
24290 #: ../fish/guestfish-actions.pod:862
24299 #: ../fish/guestfish-actions.pod:874
24305 #: ../fish/guestfish-actions.pod:876
24308 " e2fsck-f device\n"
24314 #: ../fish/guestfish-actions.pod:882
24316 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
24317 "should use L</fsck>."
24322 #: ../fish/guestfish-actions.pod:885
24323 msgid "echo-daemon"
24328 #: ../fish/guestfish-actions.pod:887
24331 " echo-daemon 'words ...'\n"
24337 #: ../fish/guestfish-actions.pod:894
24338 msgid "See also L</ping-daemon>."
24343 #: ../fish/guestfish-actions.pod:896
24349 #: ../fish/guestfish-actions.pod:898
24352 " egrep regex path\n"
24358 #: ../fish/guestfish-actions.pod:906
24364 #: ../fish/guestfish-actions.pod:908
24367 " egrepi regex path\n"
24373 #: ../fish/guestfish-actions.pod:916
24379 #: ../fish/guestfish-actions.pod:918
24382 " equal file1 file2\n"
24388 #: ../fish/guestfish-actions.pod:925
24394 #: ../fish/guestfish-actions.pod:927
24403 #: ../fish/guestfish-actions.pod:932
24404 msgid "See also L</is-file>, L</is-dir>, L</stat>."
24409 #: ../fish/guestfish-actions.pod:934
24415 #: ../fish/guestfish-actions.pod:936
24418 " fallocate path len\n"
24424 #: ../fish/guestfish-actions.pod:953
24425 msgid "fallocate64"
24430 #: ../fish/guestfish-actions.pod:955
24433 " fallocate64 path len\n"
24439 #: ../fish/guestfish-actions.pod:961
24441 "Note that this call allocates disk blocks for the file. To create a sparse "
24442 "file use L</truncate-size> instead."
24447 #: ../fish/guestfish-actions.pod:964
24449 "The deprecated call L</fallocate> does the same, but owing to an oversight "
24450 "it only allowed 30 bit lengths to be specified, effectively limiting the "
24451 "maximum size of files created through that call to 1GB."
24456 #: ../fish/guestfish-actions.pod:973
24462 #: ../fish/guestfish-actions.pod:975
24465 " fgrep pattern path\n"
24471 #: ../fish/guestfish-actions.pod:983
24477 #: ../fish/guestfish-actions.pod:985
24480 " fgrepi pattern path\n"
24486 #: ../fish/guestfish-actions.pod:993
24492 #: ../fish/guestfish-actions.pod:995
24501 #: ../fish/guestfish-actions.pod:1007
24503 "This command can also be used on C</dev/> devices (and partitions, LV "
24504 "names). You can for example use this to determine if a device contains a "
24505 "filesystem, although it's usually better to use L</vfs-type>."
24510 #: ../fish/guestfish-actions.pod:1017
24511 msgid "file-architecture"
24516 #: ../fish/guestfish-actions.pod:1019
24519 " file-architecture filename\n"
24525 #: ../fish/guestfish-actions.pod:1122
24531 #: ../fish/guestfish-actions.pod:1124
24540 #: ../fish/guestfish-actions.pod:1128
24542 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
24543 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
24548 #: ../fish/guestfish-actions.pod:1132
24554 #: ../fish/guestfish-actions.pod:1134
24557 " fill c len path\n"
24563 #: ../fish/guestfish-actions.pod:1140
24565 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24566 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
24567 "L</fill-pattern>."
24572 #: ../fish/guestfish-actions.pod:1145
24573 msgid "fill-pattern"
24578 #: ../fish/guestfish-actions.pod:1147
24581 " fill-pattern pattern len path\n"
24587 #: ../fish/guestfish-actions.pod:1149
24589 "This function is like L</fill> except that it creates a new file of length "
24590 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
24591 "is truncated if necessary to ensure the length of the file is exactly C<len> "
24597 #: ../fish/guestfish-actions.pod:1154
24603 #: ../fish/guestfish-actions.pod:1156
24606 " find directory\n"
24612 #: ../fish/guestfish-actions.pod:1170
24613 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
24618 #: ../fish/guestfish-actions.pod:1183
24619 msgid "See also L</find0>."
24624 #: ../fish/guestfish-actions.pod:1188
24630 #: ../fish/guestfish-actions.pod:1190
24633 " find0 directory (files|-)\n"
24639 #: ../fish/guestfish-actions.pod:1196
24641 "This command works the same way as L</find> with the following exceptions:"
24646 #: ../fish/guestfish-actions.pod:1223
24647 msgid "findfs-label"
24652 #: ../fish/guestfish-actions.pod:1225
24655 " findfs-label label\n"
24661 #: ../fish/guestfish-actions.pod:1231
24662 msgid "To find the label of a filesystem, use L</vfs-label>."
24667 #: ../fish/guestfish-actions.pod:1233
24668 msgid "findfs-uuid"
24673 #: ../fish/guestfish-actions.pod:1235
24676 " findfs-uuid uuid\n"
24682 #: ../fish/guestfish-actions.pod:1241
24683 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
24688 #: ../fish/guestfish-actions.pod:1243
24694 #: ../fish/guestfish-actions.pod:1245
24697 " fsck fstype device\n"
24703 #: ../fish/guestfish-actions.pod:1275
24709 #: ../fish/guestfish-actions.pod:1277
24718 #: ../fish/guestfish-actions.pod:1284
24719 msgid "get-autosync"
24724 #: ../fish/guestfish-actions.pod:1286
24733 #: ../fish/guestfish-actions.pod:1290
24739 #: ../fish/guestfish-actions.pod:1292
24748 #: ../fish/guestfish-actions.pod:1296
24749 msgid "get-e2label"
24754 #: ../fish/guestfish-actions.pod:1298
24757 " get-e2label device\n"
24763 #: ../fish/guestfish-actions.pod:1310
24769 #: ../fish/guestfish-actions.pod:1312
24772 " get-e2uuid device\n"
24778 #: ../fish/guestfish-actions.pod:1324
24779 msgid "get-memsize"
24784 #: ../fish/guestfish-actions.pod:1326
24793 #: ../fish/guestfish-actions.pod:1331
24795 "If L</set-memsize> was not called on this handle, and if "
24796 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24797 "value for memsize."
24802 #: ../fish/guestfish-actions.pod:1338
24803 msgid "get-network"
24808 #: ../fish/guestfish-actions.pod:1340
24817 #: ../fish/guestfish-actions.pod:1344
24823 #: ../fish/guestfish-actions.pod:1346
24832 #: ../fish/guestfish-actions.pod:1353
24838 #: ../fish/guestfish-actions.pod:1355
24844 #: ../fish/guestfish-actions.pod:1357
24853 #: ../fish/guestfish-actions.pod:1364
24859 #: ../fish/guestfish-actions.pod:1366
24868 #: ../fish/guestfish-actions.pod:1373
24869 msgid "get-recovery-proc"
24874 #: ../fish/guestfish-actions.pod:1375
24877 " get-recovery-proc\n"
24883 #: ../fish/guestfish-actions.pod:1379
24884 msgid "get-selinux"
24889 #: ../fish/guestfish-actions.pod:1381
24898 #: ../fish/guestfish-actions.pod:1383
24900 "This returns the current setting of the selinux flag which is passed to the "
24901 "appliance at boot time. See L</set-selinux>."
24906 #: ../fish/guestfish-actions.pod:1389
24912 #: ../fish/guestfish-actions.pod:1391
24921 #: ../fish/guestfish-actions.pod:1398
24927 #: ../fish/guestfish-actions.pod:1400
24936 #: ../fish/guestfish-actions.pod:1404
24942 #: ../fish/guestfish-actions.pod:1406
24951 #: ../fish/guestfish-actions.pod:1408
24953 "Return the current umask. By default the umask is C<022> unless it has been "
24954 "set by calling L</umask>."
24959 #: ../fish/guestfish-actions.pod:1411
24960 msgid "get-verbose"
24965 #: ../fish/guestfish-actions.pod:1413
24974 #: ../fish/guestfish-actions.pod:1417
24980 #: ../fish/guestfish-actions.pod:1419
24989 #: ../fish/guestfish-actions.pod:1423
24990 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
24995 #: ../fish/guestfish-actions.pod:1426
25001 #: ../fish/guestfish-actions.pod:1428
25004 " getxattr path name\n"
25010 #: ../fish/guestfish-actions.pod:1430
25012 "Get a single extended attribute from file C<path> named C<name>. This call "
25013 "follows symlinks. If you want to lookup an extended attribute for the "
25014 "symlink itself, use L</lgetxattr>."
25019 #: ../fish/guestfish-actions.pod:1434 ../fish/guestfish-actions.pod:2265
25021 "Normally it is better to get all extended attributes from a file in one go "
25022 "by calling L</getxattrs>. However some Linux filesystem implementations are "
25023 "buggy and do not provide a way to list out attributes. For these "
25024 "filesystems (notably ntfs-3g) you have to know the names of the extended "
25025 "attributes you want in advance and call this function."
25030 #: ../fish/guestfish-actions.pod:1444
25031 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
25036 #: ../fish/guestfish-actions.pod:1446
25042 #: ../fish/guestfish-actions.pod:1448
25045 " getxattrs path\n"
25051 #: ../fish/guestfish-actions.pod:1456
25052 msgid "See also: L</lgetxattrs>, L<attr(5)>."
25057 #: ../fish/guestfish-actions.pod:1458
25058 msgid "glob-expand"
25063 #: ../fish/guestfish-actions.pod:1460
25066 " glob-expand pattern\n"
25072 #: ../fish/guestfish-actions.pod:1473
25078 #: ../fish/guestfish-actions.pod:1475
25081 " grep regex path\n"
25087 #: ../fish/guestfish-actions.pod:1483
25093 #: ../fish/guestfish-actions.pod:1485
25096 " grepi regex path\n"
25102 #: ../fish/guestfish-actions.pod:1493
25103 msgid "grub-install"
25108 #: ../fish/guestfish-actions.pod:1495
25111 " grub-install root device\n"
25117 #: ../fish/guestfish-actions.pod:1511
25123 #: ../fish/guestfish-actions.pod:1513
25132 #: ../fish/guestfish-actions.pod:1521
25138 #: ../fish/guestfish-actions.pod:1523
25141 " head-n nrlines path\n"
25147 #: ../fish/guestfish-actions.pod:1536
25153 #: ../fish/guestfish-actions.pod:1538
25162 #: ../fish/guestfish-actions.pod:1546
25168 #: ../fish/guestfish-actions.pod:1548
25171 " initrd-cat initrdpath filename\n"
25177 #: ../fish/guestfish-actions.pod:1560
25178 msgid "See also L</initrd-list>."
25183 #: ../fish/guestfish-actions.pod:1565
25184 msgid "initrd-list"
25189 #: ../fish/guestfish-actions.pod:1567
25192 " initrd-list path\n"
25198 #: ../fish/guestfish-actions.pod:1579
25199 msgid "inotify-add-watch"
25204 #: ../fish/guestfish-actions.pod:1581
25207 " inotify-add-watch path mask\n"
25213 #: ../fish/guestfish-actions.pod:1593
25214 msgid "inotify-close"
25219 #: ../fish/guestfish-actions.pod:1595
25228 #: ../fish/guestfish-actions.pod:1601
25229 msgid "inotify-files"
25234 #: ../fish/guestfish-actions.pod:1603
25243 #: ../fish/guestfish-actions.pod:1605
25245 "This function is a helpful wrapper around L</inotify-read> which just "
25246 "returns a list of pathnames of objects that were touched. The returned "
25247 "pathnames are sorted and deduplicated."
25252 #: ../fish/guestfish-actions.pod:1609
25253 msgid "inotify-init"
25258 #: ../fish/guestfish-actions.pod:1611
25261 " inotify-init maxevents\n"
25267 #: ../fish/guestfish-actions.pod:1617
25269 "C<maxevents> is the maximum number of events which will be queued up between "
25270 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
25271 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
25272 "default was 16384 events. Beyond this limit, the kernel throws away events, "
25273 "but records the fact that it threw them away by setting a flag "
25274 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
25279 #: ../fish/guestfish-actions.pod:1627
25281 "Before any events are generated, you have to add some watches to the "
25282 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
25283 "L</inotify-watch-all>."
25288 #: ../fish/guestfish-actions.pod:1633
25290 "Queued up events should be read periodically by calling L</inotify-read> (or "
25291 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
25292 "If you don't read the events out often enough then you risk the internal "
25293 "queue overflowing."
25298 #: ../fish/guestfish-actions.pod:1640
25300 "The handle should be closed after use by calling L</inotify-close>. This "
25301 "also removes any watches automatically."
25306 #: ../fish/guestfish-actions.pod:1649
25307 msgid "inotify-read"
25312 #: ../fish/guestfish-actions.pod:1651
25321 #: ../fish/guestfish-actions.pod:1664
25322 msgid "inotify-rm-watch"
25327 #: ../fish/guestfish-actions.pod:1666
25330 " inotify-rm-watch wd\n"
25336 #: ../fish/guestfish-actions.pod:1668
25337 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
25342 #: ../fish/guestfish-actions.pod:1671
25343 msgid "inspect-get-arch"
25348 #: ../fish/guestfish-actions.pod:1673
25351 " inspect-get-arch root\n"
25357 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1691
25358 #: ../fish/guestfish-actions.pod:1765 ../fish/guestfish-actions.pod:1783
25359 #: ../fish/guestfish-actions.pod:1798 ../fish/guestfish-actions.pod:1819
25360 #: ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1861
25361 #: ../fish/guestfish-actions.pod:1883 ../fish/guestfish-actions.pod:1907
25362 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:1972
25363 #: ../fish/guestfish-actions.pod:1988
25365 "This function should only be called with a root device string as returned by "
25371 #: ../fish/guestfish-actions.pod:1678
25373 "This returns the architecture of the inspected operating system. The "
25374 "possible return values are listed under L</file-architecture>."
25379 #: ../fish/guestfish-actions.pod:1687
25380 msgid "inspect-get-distro"
25385 #: ../fish/guestfish-actions.pod:1689
25388 " inspect-get-distro root\n"
25394 #: ../fish/guestfish-actions.pod:1761
25395 msgid "inspect-get-filesystems"
25400 #: ../fish/guestfish-actions.pod:1763
25403 " inspect-get-filesystems root\n"
25409 #: ../fish/guestfish-actions.pod:1776
25411 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25412 "get-mountpoints>."
25417 #: ../fish/guestfish-actions.pod:1779
25418 msgid "inspect-get-hostname"
25423 #: ../fish/guestfish-actions.pod:1781
25426 " inspect-get-hostname root\n"
25432 #: ../fish/guestfish-actions.pod:1794
25433 msgid "inspect-get-major-version"
25438 #: ../fish/guestfish-actions.pod:1796
25441 " inspect-get-major-version root\n"
25447 #: ../fish/guestfish-actions.pod:1815
25448 msgid "inspect-get-minor-version"
25453 #: ../fish/guestfish-actions.pod:1817
25456 " inspect-get-minor-version root\n"
25462 #: ../fish/guestfish-actions.pod:1827
25464 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25465 "get-major-version>."
25470 #: ../fish/guestfish-actions.pod:1830
25471 msgid "inspect-get-mountpoints"
25476 #: ../fish/guestfish-actions.pod:1832
25479 " inspect-get-mountpoints root\n"
25485 #: ../fish/guestfish-actions.pod:1854
25487 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25488 "get-filesystems>."
25493 #: ../fish/guestfish-actions.pod:1857
25494 msgid "inspect-get-package-format"
25499 #: ../fish/guestfish-actions.pod:1859
25502 " inspect-get-package-format root\n"
25508 #: ../fish/guestfish-actions.pod:1864
25510 "This function and L</inspect-get-package-management> return the package "
25511 "format and package management tool used by the inspected operating system. "
25512 "For example for Fedora these functions would return C<rpm> (package format) "
25513 "and C<yum> (package management)."
25518 #: ../fish/guestfish-actions.pod:1879
25519 msgid "inspect-get-package-management"
25524 #: ../fish/guestfish-actions.pod:1881
25527 " inspect-get-package-management root\n"
25533 #: ../fish/guestfish-actions.pod:1886
25535 "L</inspect-get-package-format> and this function return the package format "
25536 "and package management tool used by the inspected operating system. For "
25537 "example for Fedora these functions would return C<rpm> (package format) and "
25538 "C<yum> (package management)."
25543 #: ../fish/guestfish-actions.pod:1903
25544 msgid "inspect-get-product-name"
25549 #: ../fish/guestfish-actions.pod:1905
25552 " inspect-get-product-name root\n"
25558 #: ../fish/guestfish-actions.pod:1920
25559 msgid "inspect-get-roots"
25564 #: ../fish/guestfish-actions.pod:1922
25567 " inspect-get-roots\n"
25573 #: ../fish/guestfish-actions.pod:1924
25575 "This function is a convenient way to get the list of root devices, as "
25576 "returned from a previous call to L</inspect-os>, but without redoing the "
25577 "whole inspection process."
25582 #: ../fish/guestfish-actions.pod:1928
25584 "This returns an empty list if either no root devices were found or the "
25585 "caller has not called L</inspect-os>."
25590 #: ../fish/guestfish-actions.pod:1933
25591 msgid "inspect-get-type"
25596 #: ../fish/guestfish-actions.pod:1935
25599 " inspect-get-type root\n"
25605 #: ../fish/guestfish-actions.pod:1968
25606 msgid "inspect-get-windows-systemroot"
25611 #: ../fish/guestfish-actions.pod:1970
25614 " inspect-get-windows-systemroot root\n"
25620 #: ../fish/guestfish-actions.pod:1984
25621 msgid "inspect-list-applications"
25626 #: ../fish/guestfish-actions.pod:1986
25629 " inspect-list-applications root\n"
25635 #: ../fish/guestfish-actions.pod:1993
25637 "I<Note:> This call works differently from other parts of the inspection "
25638 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
25639 "then mount up the disks, before calling this. Listing applications is a "
25640 "significantly more difficult operation which requires access to the full "
25641 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
25642 "are just returning data cached in the libguestfs handle, this call actually "
25643 "reads parts of the mounted filesystems during the call."
25648 #: ../fish/guestfish-actions.pod:2083
25654 #: ../fish/guestfish-actions.pod:2085
25663 #: ../fish/guestfish-actions.pod:2100
25665 "You can pass the root string(s) returned to other L</inspect-get-*> "
25666 "functions in order to query further information about each operating system, "
25667 "such as the name and version."
25672 #: ../fish/guestfish-actions.pod:2105
25674 "This function uses other libguestfs features such as L</mount-ro> and L</"
25675 "umount-all> in order to mount and unmount filesystems and look at the "
25676 "contents. This should be called with no disks currently mounted. The "
25677 "function may also use Augeas, so any existing Augeas handle will be closed."
25682 #: ../fish/guestfish-actions.pod:2117 ../fish/guestfish-actions.pod:2293
25683 #: ../fish/guestfish-actions.pod:2339
25684 msgid "See also L</list-filesystems>."
25689 #: ../fish/guestfish-actions.pod:2119
25690 msgid "is-blockdev"
25695 #: ../fish/guestfish-actions.pod:2121
25698 " is-blockdev path\n"
25704 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2144
25705 #: ../fish/guestfish-actions.pod:2163 ../fish/guestfish-actions.pod:2172
25706 #: ../fish/guestfish-actions.pod:2182 ../fish/guestfish-actions.pod:2216
25707 #: ../fish/guestfish-actions.pod:2225
25708 msgid "See also L</stat>."
25713 #: ../fish/guestfish-actions.pod:2128
25719 #: ../fish/guestfish-actions.pod:2130
25728 #: ../fish/guestfish-actions.pod:2137
25734 #: ../fish/guestfish-actions.pod:2139
25737 " is-chardev path\n"
25743 #: ../fish/guestfish-actions.pod:2146
25749 #: ../fish/guestfish-actions.pod:2148
25758 #: ../fish/guestfish-actions.pod:2155
25764 #: ../fish/guestfish-actions.pod:2157
25773 #: ../fish/guestfish-actions.pod:2165
25779 #: ../fish/guestfish-actions.pod:2167
25788 #: ../fish/guestfish-actions.pod:2174
25794 #: ../fish/guestfish-actions.pod:2176
25803 #: ../fish/guestfish-actions.pod:2184
25804 msgid "is-launching"
25809 #: ../fish/guestfish-actions.pod:2186
25818 #: ../fish/guestfish-actions.pod:2193
25824 #: ../fish/guestfish-actions.pod:2195
25833 #: ../fish/guestfish-actions.pod:2200
25839 #: ../fish/guestfish-actions.pod:2202
25848 #: ../fish/guestfish-actions.pod:2209
25854 #: ../fish/guestfish-actions.pod:2211
25857 " is-socket path\n"
25863 #: ../fish/guestfish-actions.pod:2218
25869 #: ../fish/guestfish-actions.pod:2220
25872 " is-symlink path\n"
25878 #: ../fish/guestfish-actions.pod:2227
25879 msgid "kill-subprocess"
25884 #: ../fish/guestfish-actions.pod:2229
25887 " kill-subprocess\n"
25893 #: ../fish/guestfish-actions.pod:2233
25899 #: ../fish/guestfish-actions.pod:2235
25905 #: ../fish/guestfish-actions.pod:2237
25914 #: ../fish/guestfish-actions.pod:2245
25920 #: ../fish/guestfish-actions.pod:2247
25923 " lchown owner group path\n"
25929 #: ../fish/guestfish-actions.pod:2249
25931 "Change the file owner to C<owner> and group to C<group>. This is like L</"
25932 "chown> but if C<path> is a symlink then the link itself is changed, not the "
25938 #: ../fish/guestfish-actions.pod:2257
25944 #: ../fish/guestfish-actions.pod:2259
25947 " lgetxattr path name\n"
25953 #: ../fish/guestfish-actions.pod:2275
25954 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25959 #: ../fish/guestfish-actions.pod:2277
25965 #: ../fish/guestfish-actions.pod:2279
25968 " lgetxattrs path\n"
25974 #: ../fish/guestfish-actions.pod:2281
25976 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25977 "it returns the extended attributes of the link itself."
25982 #: ../fish/guestfish-actions.pod:2285
25983 msgid "list-devices"
25988 #: ../fish/guestfish-actions.pod:2287
25997 #: ../fish/guestfish-actions.pod:2295
25998 msgid "list-filesystems"
26003 #: ../fish/guestfish-actions.pod:2297
26006 " list-filesystems\n"
26012 #: ../fish/guestfish-actions.pod:2316
26014 "This command runs other libguestfs commands, which might include L</mount> "
26015 "and L</umount>, and therefore you should use this soon after launch and only "
26016 "when nothing is mounted."
26021 #: ../fish/guestfish-actions.pod:2320
26023 "Not all of the filesystems returned will be mountable. In particular, swap "
26024 "partitions are returned in the list. Also this command does not check that "
26025 "each filesystem found is valid and mountable, and some filesystems might be "
26026 "mountable but require special options. Filesystems may not all belong to a "
26027 "single logical operating system (use L</inspect-os> to look for OSes)."
26032 #: ../fish/guestfish-actions.pod:2328
26033 msgid "list-partitions"
26038 #: ../fish/guestfish-actions.pod:2330
26041 " list-partitions\n"
26047 #: ../fish/guestfish-actions.pod:2336
26049 "This does not return logical volumes. For that you will need to call L</"
26055 #: ../fish/guestfish-actions.pod:2341
26061 #: ../fish/guestfish-actions.pod:2343
26070 #: ../fish/guestfish-actions.pod:2351
26076 #: ../fish/guestfish-actions.pod:2353
26079 " ln target linkname\n"
26085 #: ../fish/guestfish-actions.pod:2357
26091 #: ../fish/guestfish-actions.pod:2359
26094 " ln-f target linkname\n"
26100 #: ../fish/guestfish-actions.pod:2364
26106 #: ../fish/guestfish-actions.pod:2366
26109 " ln-s target linkname\n"
26115 #: ../fish/guestfish-actions.pod:2370
26121 #: ../fish/guestfish-actions.pod:2372
26124 " ln-sf target linkname\n"
26130 #: ../fish/guestfish-actions.pod:2377
26131 msgid "lremovexattr"
26136 #: ../fish/guestfish-actions.pod:2379
26139 " lremovexattr xattr path\n"
26145 #: ../fish/guestfish-actions.pod:2381
26147 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
26148 "it removes an extended attribute of the link itself."
26153 #: ../fish/guestfish-actions.pod:2385
26159 #: ../fish/guestfish-actions.pod:2387
26168 #: ../fish/guestfish-actions.pod:2393
26170 "This command is mostly useful for interactive sessions. Programs should "
26171 "probably use L</readdir> instead."
26176 #: ../fish/guestfish-actions.pod:2396
26182 #: ../fish/guestfish-actions.pod:2398
26185 " lsetxattr xattr val vallen path\n"
26191 #: ../fish/guestfish-actions.pod:2400
26193 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
26194 "sets an extended attribute of the link itself."
26199 #: ../fish/guestfish-actions.pod:2404
26205 #: ../fish/guestfish-actions.pod:2406
26214 #: ../fish/guestfish-actions.pod:2410
26216 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
26217 "the link is stat-ed, not the file it refers to."
26222 #: ../fish/guestfish-actions.pod:2416
26228 #: ../fish/guestfish-actions.pod:2418
26231 " lstatlist path 'names ...'\n"
26237 #: ../fish/guestfish-actions.pod:2420
26239 "This call allows you to perform the L</lstat> operation on multiple files, "
26240 "where all files are in the directory C<path>. C<names> is the list of files "
26241 "from this directory."
26246 #: ../fish/guestfish-actions.pod:2429
26248 "This call is intended for programs that want to efficiently list a directory "
26249 "contents without making many round-trips. See also L</lxattrlist> for a "
26250 "similarly efficient call for getting extended attributes. Very long "
26251 "directory listings might cause the protocol message size to be exceeded, "
26252 "causing this call to fail. The caller must split up such requests into "
26253 "smaller groups of names."
26258 #: ../fish/guestfish-actions.pod:2437
26259 msgid "luks-add-key"
26264 #: ../fish/guestfish-actions.pod:2439
26267 " luks-add-key device keyslot\n"
26273 #: ../fish/guestfish-actions.pod:2446
26275 "Note that if C<keyslot> already contains a key, then this command will "
26276 "fail. You have to use L</luks-kill-slot> first to remove that key."
26281 #: ../fish/guestfish-actions.pod:2450 ../fish/guestfish-actions.pod:2472
26282 #: ../fish/guestfish-actions.pod:2485 ../fish/guestfish-actions.pod:2499
26283 #: ../fish/guestfish-actions.pod:2522 ../fish/guestfish-actions.pod:2532
26285 "This command has one or more key or passphrase parameters. Guestfish will "
26286 "prompt for these separately."
26291 #: ../fish/guestfish-actions.pod:2453
26297 #: ../fish/guestfish-actions.pod:2455
26300 " luks-close device\n"
26306 #: ../fish/guestfish-actions.pod:2457
26308 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
26309 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
26310 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
26316 #: ../fish/guestfish-actions.pod:2463
26317 msgid "luks-format"
26322 #: ../fish/guestfish-actions.pod:2465
26325 " luks-format device keyslot\n"
26331 #: ../fish/guestfish-actions.pod:2478
26332 msgid "luks-format-cipher"
26337 #: ../fish/guestfish-actions.pod:2480
26340 " luks-format-cipher device keyslot cipher\n"
26346 #: ../fish/guestfish-actions.pod:2482
26348 "This command is the same as L</luks-format> but it also allows you to set "
26349 "the C<cipher> used."
26354 #: ../fish/guestfish-actions.pod:2491
26355 msgid "luks-kill-slot"
26360 #: ../fish/guestfish-actions.pod:2493
26363 " luks-kill-slot device keyslot\n"
26369 #: ../fish/guestfish-actions.pod:2502
26375 #: ../fish/guestfish-actions.pod:2504
26378 " luks-open device mapname\n"
26384 #: ../fish/guestfish-actions.pod:2518
26386 "If this block device contains LVM volume groups, then calling L</vgscan> "
26387 "followed by L</vg-activate-all> will make them visible."
26392 #: ../fish/guestfish-actions.pod:2525
26393 msgid "luks-open-ro"
26398 #: ../fish/guestfish-actions.pod:2527
26401 " luks-open-ro device mapname\n"
26407 #: ../fish/guestfish-actions.pod:2529
26409 "This is the same as L</luks-open> except that a read-only mapping is created."
26414 #: ../fish/guestfish-actions.pod:2535
26420 #: ../fish/guestfish-actions.pod:2537
26423 " lvcreate logvol volgroup mbytes\n"
26429 #: ../fish/guestfish-actions.pod:2542
26430 msgid "lvm-canonical-lv-name"
26435 #: ../fish/guestfish-actions.pod:2544
26438 " lvm-canonical-lv-name lvname\n"
26444 #: ../fish/guestfish-actions.pod:2553
26445 msgid "See also L</is-lv>."
26450 #: ../fish/guestfish-actions.pod:2555
26451 msgid "lvm-clear-filter"
26456 #: ../fish/guestfish-actions.pod:2557
26459 " lvm-clear-filter\n"
26465 #: ../fish/guestfish-actions.pod:2559
26467 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
26473 #: ../fish/guestfish-actions.pod:2565
26474 msgid "lvm-remove-all"
26479 #: ../fish/guestfish-actions.pod:2567
26482 " lvm-remove-all\n"
26488 #: ../fish/guestfish-actions.pod:2575
26489 msgid "lvm-set-filter"
26494 #: ../fish/guestfish-actions.pod:2577
26497 " lvm-set-filter 'devices ...'\n"
26503 #: ../fish/guestfish-actions.pod:2602
26509 #: ../fish/guestfish-actions.pod:2604
26512 " lvremove device\n"
26518 #: ../fish/guestfish-actions.pod:2612
26524 #: ../fish/guestfish-actions.pod:2614
26527 " lvrename logvol newlogvol\n"
26533 #: ../fish/guestfish-actions.pod:2618
26539 #: ../fish/guestfish-actions.pod:2620
26542 " lvresize device mbytes\n"
26548 #: ../fish/guestfish-actions.pod:2626
26549 msgid "lvresize-free"
26554 #: ../fish/guestfish-actions.pod:2628
26557 " lvresize-free lv percent\n"
26563 #: ../fish/guestfish-actions.pod:2636
26569 #: ../fish/guestfish-actions.pod:2638
26578 #: ../fish/guestfish-actions.pod:2646
26579 msgid "See also L</lvs-full>, L</list-filesystems>."
26584 #: ../fish/guestfish-actions.pod:2648
26590 #: ../fish/guestfish-actions.pod:2650
26599 #: ../fish/guestfish-actions.pod:2655
26605 #: ../fish/guestfish-actions.pod:2657
26614 #: ../fish/guestfish-actions.pod:2661
26620 #: ../fish/guestfish-actions.pod:2663
26623 " lxattrlist path 'names ...'\n"
26629 #: ../fish/guestfish-actions.pod:2679
26631 "This call is intended for programs that want to efficiently list a directory "
26632 "contents without making many round-trips. See also L</lstatlist> for a "
26633 "similarly efficient call for getting standard stats. Very long directory "
26634 "listings might cause the protocol message size to be exceeded, causing this "
26635 "call to fail. The caller must split up such requests into smaller groups of "
26641 #: ../fish/guestfish-actions.pod:2687
26647 #: ../fish/guestfish-actions.pod:2689
26656 #: ../fish/guestfish-actions.pod:2693
26662 #: ../fish/guestfish-actions.pod:2695
26665 " mkdir-mode path mode\n"
26671 #: ../fish/guestfish-actions.pod:2704
26672 msgid "See also L</mkdir>, L</umask>"
26677 #: ../fish/guestfish-actions.pod:2706
26683 #: ../fish/guestfish-actions.pod:2708
26692 #: ../fish/guestfish-actions.pod:2713
26698 #: ../fish/guestfish-actions.pod:2715
26701 " mkdtemp template\n"
26707 #: ../fish/guestfish-actions.pod:2736
26713 #: ../fish/guestfish-actions.pod:2738
26716 " mke2fs-J fstype blocksize device journal\n"
26722 #: ../fish/guestfish-actions.pod:2746
26723 msgid "See also L</mke2journal>."
26728 #: ../fish/guestfish-actions.pod:2748
26734 #: ../fish/guestfish-actions.pod:2750
26737 " mke2fs-JL fstype blocksize device label\n"
26743 #: ../fish/guestfish-actions.pod:2755
26744 msgid "See also L</mke2journal-L>."
26749 #: ../fish/guestfish-actions.pod:2757
26755 #: ../fish/guestfish-actions.pod:2759
26758 " mke2fs-JU fstype blocksize device uuid\n"
26764 #: ../fish/guestfish-actions.pod:2764
26765 msgid "See also L</mke2journal-U>."
26770 #: ../fish/guestfish-actions.pod:2766
26771 msgid "mke2journal"
26776 #: ../fish/guestfish-actions.pod:2768
26779 " mke2journal blocksize device\n"
26785 #: ../fish/guestfish-actions.pod:2775
26786 msgid "mke2journal-L"
26791 #: ../fish/guestfish-actions.pod:2777
26794 " mke2journal-L blocksize label device\n"
26800 #: ../fish/guestfish-actions.pod:2781
26801 msgid "mke2journal-U"
26806 #: ../fish/guestfish-actions.pod:2783
26809 " mke2journal-U blocksize uuid device\n"
26815 #: ../fish/guestfish-actions.pod:2787
26821 #: ../fish/guestfish-actions.pod:2789
26824 " mkfifo mode path\n"
26830 #: ../fish/guestfish-actions.pod:2791
26832 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26833 "is just a convenient wrapper around L</mknod>."
26838 #: ../fish/guestfish-actions.pod:2797
26844 #: ../fish/guestfish-actions.pod:2799
26847 " mkfs fstype device\n"
26853 #: ../fish/guestfish-actions.pod:2805
26859 #: ../fish/guestfish-actions.pod:2807
26862 " mkfs-b fstype blocksize device\n"
26868 #: ../fish/guestfish-actions.pod:2809
26870 "This call is similar to L</mkfs>, but it allows you to control the block "
26871 "size of the resulting filesystem. Supported block sizes depend on the "
26872 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26877 #: ../fish/guestfish-actions.pod:2824
26883 #: ../fish/guestfish-actions.pod:2826
26886 " mkfs-opts fstype device [blocksize:..]\n"
26892 #: ../fish/guestfish-actions.pod:2850
26893 msgid "mkmountpoint"
26898 #: ../fish/guestfish-actions.pod:2852
26901 " mkmountpoint exemptpath\n"
26907 #: ../fish/guestfish-actions.pod:2854
26909 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
26910 "to create extra mountpoints before mounting the first filesystem."
26915 #: ../fish/guestfish-actions.pod:2878
26917 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26918 "unexpected errors if you try to mix these calls. It is safest to manually "
26919 "unmount filesystems and remove mountpoints after use."
26924 #: ../fish/guestfish-actions.pod:2882
26926 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26927 "for this to work for manual mountpoints, you must ensure that the innermost "
26928 "mountpoints have the longest pathnames, as in the example code above."
26933 #: ../fish/guestfish-actions.pod:2889
26935 "Autosync [see L</set-autosync>, this is set by default on handles] means "
26936 "that L</umount-all> is called when the handle is closed which can also "
26937 "trigger these issues."
26942 #: ../fish/guestfish-actions.pod:2893
26948 #: ../fish/guestfish-actions.pod:2895
26951 " mknod mode devmajor devminor path\n"
26957 #: ../fish/guestfish-actions.pod:2905
26959 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26960 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26961 "regular file). These constants are available in the standard Linux header "
26962 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26963 "wrappers around this command which bitwise OR in the appropriate constant "
26969 #: ../fish/guestfish-actions.pod:2915
26975 #: ../fish/guestfish-actions.pod:2917
26978 " mknod-b mode devmajor devminor path\n"
26984 #: ../fish/guestfish-actions.pod:2919
26986 "This call creates a block device node called C<path> with mode C<mode> and "
26987 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26988 "wrapper around L</mknod>."
26993 #: ../fish/guestfish-actions.pod:2925
26999 #: ../fish/guestfish-actions.pod:2927
27002 " mknod-c mode devmajor devminor path\n"
27008 #: ../fish/guestfish-actions.pod:2929
27010 "This call creates a char device node called C<path> with mode C<mode> and "
27011 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27012 "wrapper around L</mknod>."
27017 #: ../fish/guestfish-actions.pod:2935
27023 #: ../fish/guestfish-actions.pod:2937
27032 #: ../fish/guestfish-actions.pod:2941
27038 #: ../fish/guestfish-actions.pod:2943
27041 " mkswap-L label device\n"
27047 #: ../fish/guestfish-actions.pod:2951
27053 #: ../fish/guestfish-actions.pod:2953
27056 " mkswap-U uuid device\n"
27062 #: ../fish/guestfish-actions.pod:2957
27063 msgid "mkswap-file"
27068 #: ../fish/guestfish-actions.pod:2959
27071 " mkswap-file path\n"
27077 #: ../fish/guestfish-actions.pod:2963
27079 "This command just writes a swap file signature to an existing file. To "
27080 "create the file itself, use something like L</fallocate>."
27085 #: ../fish/guestfish-actions.pod:2966
27091 #: ../fish/guestfish-actions.pod:2968
27094 " modprobe modulename\n"
27100 #: ../fish/guestfish-actions.pod:2975
27106 #: ../fish/guestfish-actions.pod:2977
27109 " mount device mountpoint\n"
27115 #: ../fish/guestfish-actions.pod:2993
27117 "B<Important note:> When you use this call, the filesystem options C<sync> "
27118 "and C<noatime> are set implicitly. This was originally done because we "
27119 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27120 "very large negative performance impact and negligible effect on "
27121 "reliability. Therefore we recommend that you avoid using L</mount> in any "
27122 "code that needs performance, and instead use L</mount-options> (use an empty "
27123 "string for the first parameter if you don't want any options)."
27128 #: ../fish/guestfish-actions.pod:3003
27134 #: ../fish/guestfish-actions.pod:3005
27137 " mount-loop file mountpoint\n"
27143 #: ../fish/guestfish-actions.pod:3011
27144 msgid "mount-options"
27149 #: ../fish/guestfish-actions.pod:3013
27152 " mount-options options device mountpoint\n"
27158 #: ../fish/guestfish-actions.pod:3015
27160 "This is the same as the L</mount> command, but it allows you to set the "
27161 "mount options as for the L<mount(8)> I<-o> flag."
27166 #: ../fish/guestfish-actions.pod:3023
27172 #: ../fish/guestfish-actions.pod:3025
27175 " mount-ro device mountpoint\n"
27181 #: ../fish/guestfish-actions.pod:3027
27183 "This is the same as the L</mount> command, but it mounts the filesystem with "
27184 "the read-only (I<-o ro>) flag."
27189 #: ../fish/guestfish-actions.pod:3030
27195 #: ../fish/guestfish-actions.pod:3032
27198 " mount-vfs options vfstype device mountpoint\n"
27204 #: ../fish/guestfish-actions.pod:3034
27206 "This is the same as the L</mount> command, but it allows you to set both the "
27207 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
27212 #: ../fish/guestfish-actions.pod:3038
27213 msgid "mountpoints"
27218 #: ../fish/guestfish-actions.pod:3040
27227 #: ../fish/guestfish-actions.pod:3042
27229 "This call is similar to L</mounts>. That call returns a list of devices. "
27230 "This one returns a hash table (map) of device name to directory where the "
27231 "device is mounted."
27236 #: ../fish/guestfish-actions.pod:3046
27242 #: ../fish/guestfish-actions.pod:3048
27251 #: ../fish/guestfish-actions.pod:3055
27252 msgid "See also: L</mountpoints>"
27257 #: ../fish/guestfish-actions.pod:3057
27263 #: ../fish/guestfish-actions.pod:3059
27272 #: ../fish/guestfish-actions.pod:3064
27273 msgid "ntfs-3g-probe"
27278 #: ../fish/guestfish-actions.pod:3066
27281 " ntfs-3g-probe true|false device\n"
27287 #: ../fish/guestfish-actions.pod:3080
27293 #: ../fish/guestfish-actions.pod:3082
27296 " ntfsresize device\n"
27302 #: ../fish/guestfish-actions.pod:3088
27303 msgid "ntfsresize-size"
27308 #: ../fish/guestfish-actions.pod:3090
27311 " ntfsresize-size device size\n"
27317 #: ../fish/guestfish-actions.pod:3092
27319 "This command is the same as L</ntfsresize> except that it allows you to "
27320 "specify the new size (in bytes) explicitly."
27325 #: ../fish/guestfish-actions.pod:3095
27331 #: ../fish/guestfish-actions.pod:3097
27334 " part-add device prlogex startsect endsect\n"
27340 #: ../fish/guestfish-actions.pod:3099
27342 "This command adds a partition to C<device>. If there is no partition table "
27343 "on the device, call L</part-init> first."
27348 #: ../fish/guestfish-actions.pod:3111
27350 "Creating a partition which covers the whole disk is not so easy. Use L</"
27351 "part-disk> to do that."
27356 #: ../fish/guestfish-actions.pod:3114
27362 #: ../fish/guestfish-actions.pod:3116
27365 " part-del device partnum\n"
27371 #: ../fish/guestfish-actions.pod:3124
27377 #: ../fish/guestfish-actions.pod:3126
27380 " part-disk device parttype\n"
27386 #: ../fish/guestfish-actions.pod:3128
27388 "This command is simply a combination of L</part-init> followed by L</part-"
27389 "add> to create a single primary partition covering the whole disk."
27394 #: ../fish/guestfish-actions.pod:3132
27396 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27397 "possible values are described in L</part-init>."
27402 #: ../fish/guestfish-actions.pod:3138
27403 msgid "part-get-bootable"
27408 #: ../fish/guestfish-actions.pod:3140
27411 " part-get-bootable device partnum\n"
27417 #: ../fish/guestfish-actions.pod:3145
27418 msgid "See also L</part-set-bootable>."
27423 #: ../fish/guestfish-actions.pod:3147
27424 msgid "part-get-mbr-id"
27429 #: ../fish/guestfish-actions.pod:3149
27432 " part-get-mbr-id device partnum\n"
27438 #: ../fish/guestfish-actions.pod:3154 ../fish/guestfish-actions.pod:3292
27440 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27441 "undefined results for other partition table types (see L</part-get-"
27447 #: ../fish/guestfish-actions.pod:3158
27448 msgid "part-get-parttype"
27453 #: ../fish/guestfish-actions.pod:3160
27456 " part-get-parttype device\n"
27462 #: ../fish/guestfish-actions.pod:3165
27464 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27465 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27466 "possible, although unusual. See L</part-init> for a full list."
27471 #: ../fish/guestfish-actions.pod:3170
27477 #: ../fish/guestfish-actions.pod:3172
27480 " part-init device parttype\n"
27486 #: ../fish/guestfish-actions.pod:3178
27488 "Initially there are no partitions. Following this, you should call L</part-"
27489 "add> for each partition required."
27494 #: ../fish/guestfish-actions.pod:3241
27500 #: ../fish/guestfish-actions.pod:3243
27503 " part-list device\n"
27509 #: ../fish/guestfish-actions.pod:3258
27511 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27512 "the device's sector size, see L</blockdev-getss>."
27517 #: ../fish/guestfish-actions.pod:3271
27518 msgid "part-set-bootable"
27523 #: ../fish/guestfish-actions.pod:3273
27526 " part-set-bootable device partnum true|false\n"
27532 #: ../fish/guestfish-actions.pod:3282
27533 msgid "part-set-mbr-id"
27538 #: ../fish/guestfish-actions.pod:3284
27541 " part-set-mbr-id device partnum idbyte\n"
27547 #: ../fish/guestfish-actions.pod:3296
27548 msgid "part-set-name"
27553 #: ../fish/guestfish-actions.pod:3298
27556 " part-set-name device partnum name\n"
27562 #: ../fish/guestfish-actions.pod:3306
27563 msgid "part-to-dev"
27568 #: ../fish/guestfish-actions.pod:3308
27571 " part-to-dev partition\n"
27577 #: ../fish/guestfish-actions.pod:3314
27579 "The named partition must exist, for example as a string returned from L</"
27580 "list-partitions>."
27585 #: ../fish/guestfish-actions.pod:3317
27586 msgid "ping-daemon"
27591 #: ../fish/guestfish-actions.pod:3319
27600 #: ../fish/guestfish-actions.pod:3326
27606 #: ../fish/guestfish-actions.pod:3328
27609 " pread path count offset\n"
27615 #: ../fish/guestfish-actions.pod:3336
27616 msgid "See also L</pwrite>, L</pread-device>."
27621 #: ../fish/guestfish-actions.pod:3341
27622 msgid "pread-device"
27627 #: ../fish/guestfish-actions.pod:3343
27630 " pread-device device count offset\n"
27636 #: ../fish/guestfish-actions.pod:3351
27637 msgid "See also L</pread>."
27642 #: ../fish/guestfish-actions.pod:3356
27648 #: ../fish/guestfish-actions.pod:3358
27651 " pvcreate device\n"
27657 #: ../fish/guestfish-actions.pod:3364
27663 #: ../fish/guestfish-actions.pod:3366
27666 " pvremove device\n"
27672 #: ../fish/guestfish-actions.pod:3375
27678 #: ../fish/guestfish-actions.pod:3377
27681 " pvresize device\n"
27687 #: ../fish/guestfish-actions.pod:3382
27688 msgid "pvresize-size"
27693 #: ../fish/guestfish-actions.pod:3384
27696 " pvresize-size device size\n"
27702 #: ../fish/guestfish-actions.pod:3386
27704 "This command is the same as L</pvresize> except that it allows you to "
27705 "specify the new size (in bytes) explicitly."
27710 #: ../fish/guestfish-actions.pod:3389
27716 #: ../fish/guestfish-actions.pod:3391
27725 #: ../fish/guestfish-actions.pod:3399
27726 msgid "See also L</pvs-full>."
27731 #: ../fish/guestfish-actions.pod:3401
27737 #: ../fish/guestfish-actions.pod:3403
27746 #: ../fish/guestfish-actions.pod:3408
27752 #: ../fish/guestfish-actions.pod:3410
27761 #: ../fish/guestfish-actions.pod:3414
27767 #: ../fish/guestfish-actions.pod:3416
27770 " pwrite path content offset\n"
27776 #: ../fish/guestfish-actions.pod:3427
27777 msgid "See also L</pread>, L</pwrite-device>."
27782 #: ../fish/guestfish-actions.pod:3432
27783 msgid "pwrite-device"
27788 #: ../fish/guestfish-actions.pod:3434
27791 " pwrite-device device content offset\n"
27797 #: ../fish/guestfish-actions.pod:3444
27798 msgid "See also L</pwrite>."
27803 #: ../fish/guestfish-actions.pod:3449
27809 #: ../fish/guestfish-actions.pod:3451
27812 " read-file path\n"
27818 #: ../fish/guestfish-actions.pod:3456
27820 "Unlike L</cat>, this function can correctly handle files that contain "
27821 "embedded ASCII NUL characters. However unlike L</download>, this function "
27822 "is limited in the total size of file that can be handled."
27827 #: ../fish/guestfish-actions.pod:3464
27833 #: ../fish/guestfish-actions.pod:3466
27836 " read-lines path\n"
27842 #: ../fish/guestfish-actions.pod:3473
27844 "Note that this function cannot correctly handle binary files (specifically, "
27845 "files containing C<\\0> character which is treated as end of line). For "
27846 "those you need to use the L</read-file> function which has a more complex "
27852 #: ../fish/guestfish-actions.pod:3478
27858 #: ../fish/guestfish-actions.pod:3480
27867 #: ../fish/guestfish-actions.pod:3532
27869 "This function is primarily intended for use by programs. To get a simple "
27870 "list of names, use L</ls>. To get a printable directory for human "
27871 "consumption, use L</ll>."
27876 #: ../fish/guestfish-actions.pod:3536
27882 #: ../fish/guestfish-actions.pod:3538
27891 #: ../fish/guestfish-actions.pod:3542
27892 msgid "readlinklist"
27897 #: ../fish/guestfish-actions.pod:3544
27900 " readlinklist path 'names ...'\n"
27906 #: ../fish/guestfish-actions.pod:3568
27912 #: ../fish/guestfish-actions.pod:3570
27921 #: ../fish/guestfish-actions.pod:3575
27922 msgid "removexattr"
27927 #: ../fish/guestfish-actions.pod:3577
27930 " removexattr xattr path\n"
27936 #: ../fish/guestfish-actions.pod:3582
27937 msgid "See also: L</lremovexattr>, L<attr(5)>."
27942 #: ../fish/guestfish-actions.pod:3584
27948 #: ../fish/guestfish-actions.pod:3586
27951 " resize2fs device\n"
27957 #: ../fish/guestfish-actions.pod:3591
27959 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
27960 "before calling this command. For unknown reasons C<resize2fs> sometimes "
27961 "gives an error about this and sometimes not. In any case, it is always safe "
27962 "to call L</e2fsck-f> before calling this function."
27967 #: ../fish/guestfish-actions.pod:3597
27968 msgid "resize2fs-size"
27973 #: ../fish/guestfish-actions.pod:3599
27976 " resize2fs-size device size\n"
27982 #: ../fish/guestfish-actions.pod:3601
27984 "This command is the same as L</resize2fs> except that it allows you to "
27985 "specify the new size (in bytes) explicitly."
27990 #: ../fish/guestfish-actions.pod:3604
27996 #: ../fish/guestfish-actions.pod:3606
28005 #: ../fish/guestfish-actions.pod:3610
28011 #: ../fish/guestfish-actions.pod:3612
28020 #: ../fish/guestfish-actions.pod:3618
28026 #: ../fish/guestfish-actions.pod:3620
28035 #: ../fish/guestfish-actions.pod:3624
28036 msgid "rmmountpoint"
28041 #: ../fish/guestfish-actions.pod:3626
28044 " rmmountpoint exemptpath\n"
28050 #: ../fish/guestfish-actions.pod:3628
28052 "This calls removes a mountpoint that was previously created with L</"
28053 "mkmountpoint>. See L</mkmountpoint> for full details."
28058 #: ../fish/guestfish-actions.pod:3632
28059 msgid "scrub-device"
28064 #: ../fish/guestfish-actions.pod:3634
28067 " scrub-device device\n"
28073 #: ../fish/guestfish-actions.pod:3645
28079 #: ../fish/guestfish-actions.pod:3647
28082 " scrub-file file\n"
28088 #: ../fish/guestfish-actions.pod:3657
28089 msgid "scrub-freespace"
28094 #: ../fish/guestfish-actions.pod:3659
28097 " scrub-freespace dir\n"
28103 #: ../fish/guestfish-actions.pod:3661
28105 "This command creates the directory C<dir> and then fills it with files until "
28106 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
28107 "deletes them. The intention is to scrub any free space on the partition "
28108 "containing C<dir>."
28113 #: ../fish/guestfish-actions.pod:3670
28119 #: ../fish/guestfish-actions.pod:3672
28125 #: ../fish/guestfish-actions.pod:3674
28128 " set-append append\n"
28134 #: ../fish/guestfish-actions.pod:3685
28135 msgid "set-autosync"
28140 #: ../fish/guestfish-actions.pod:3687
28146 #: ../fish/guestfish-actions.pod:3689
28149 " set-autosync true|false\n"
28155 #: ../fish/guestfish-actions.pod:3691
28157 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
28158 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
28159 "closed (also if the program exits without closing handles)."
28164 #: ../fish/guestfish-actions.pod:3699
28170 #: ../fish/guestfish-actions.pod:3701
28176 #: ../fish/guestfish-actions.pod:3703
28179 " set-direct true|false\n"
28185 #: ../fish/guestfish-actions.pod:3709
28187 "One consequence of this is that log messages aren't caught by the library "
28188 "and handled by L</set-log-message-callback>, but go straight to stdout."
28193 #: ../fish/guestfish-actions.pod:3718
28194 msgid "set-e2label"
28199 #: ../fish/guestfish-actions.pod:3720
28202 " set-e2label device label\n"
28208 #: ../fish/guestfish-actions.pod:3726
28210 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
28211 "label on a filesystem."
28216 #: ../fish/guestfish-actions.pod:3729
28222 #: ../fish/guestfish-actions.pod:3731
28225 " set-e2uuid device uuid\n"
28231 #: ../fish/guestfish-actions.pod:3738
28233 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
28234 "UUID of a filesystem."
28239 #: ../fish/guestfish-actions.pod:3741
28240 msgid "set-memsize"
28245 #: ../fish/guestfish-actions.pod:3743
28251 #: ../fish/guestfish-actions.pod:3745
28254 " set-memsize memsize\n"
28260 #: ../fish/guestfish-actions.pod:3747
28262 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28263 "This only has any effect if called before L</launch>."
28268 #: ../fish/guestfish-actions.pod:3758
28269 msgid "set-network"
28274 #: ../fish/guestfish-actions.pod:3760
28280 #: ../fish/guestfish-actions.pod:3762
28283 " set-network true|false\n"
28289 #: ../fish/guestfish-actions.pod:3770
28291 "You must call this before calling L</launch>, otherwise it has no effect."
28296 #: ../fish/guestfish-actions.pod:3773
28302 #: ../fish/guestfish-actions.pod:3775
28308 #: ../fish/guestfish-actions.pod:3777
28311 " set-path searchpath\n"
28317 #: ../fish/guestfish-actions.pod:3786
28323 #: ../fish/guestfish-actions.pod:3788
28329 #: ../fish/guestfish-actions.pod:3790
28338 #: ../fish/guestfish-actions.pod:3810
28339 msgid "set-recovery-proc"
28344 #: ../fish/guestfish-actions.pod:3812
28345 msgid "recovery-proc"
28350 #: ../fish/guestfish-actions.pod:3814
28353 " set-recovery-proc true|false\n"
28359 #: ../fish/guestfish-actions.pod:3816
28361 "If this is called with the parameter C<false> then L</launch> does not "
28362 "create a recovery process. The purpose of the recovery process is to stop "
28363 "runaway qemu processes in the case where the main program aborts abruptly."
28368 #: ../fish/guestfish-actions.pod:3821
28370 "This only has any effect if called before L</launch>, and the default is "
28376 #: ../fish/guestfish-actions.pod:3830
28377 msgid "set-selinux"
28382 #: ../fish/guestfish-actions.pod:3832
28388 #: ../fish/guestfish-actions.pod:3834
28391 " set-selinux true|false\n"
28397 #: ../fish/guestfish-actions.pod:3845
28403 #: ../fish/guestfish-actions.pod:3847
28409 #: ../fish/guestfish-actions.pod:3849
28412 " set-trace true|false\n"
28418 #: ../fish/guestfish-actions.pod:3865
28419 msgid "set-verbose"
28424 #: ../fish/guestfish-actions.pod:3867
28430 #: ../fish/guestfish-actions.pod:3869
28433 " set-verbose true|false\n"
28439 #: ../fish/guestfish-actions.pod:3876
28445 #: ../fish/guestfish-actions.pod:3878
28448 " setcon context\n"
28454 #: ../fish/guestfish-actions.pod:3885
28460 #: ../fish/guestfish-actions.pod:3887
28463 " setxattr xattr val vallen path\n"
28469 #: ../fish/guestfish-actions.pod:3893
28470 msgid "See also: L</lsetxattr>, L<attr(5)>."
28475 #: ../fish/guestfish-actions.pod:3895
28481 #: ../fish/guestfish-actions.pod:3897
28484 " sfdisk device cyls heads sectors 'lines ...'\n"
28490 #: ../fish/guestfish-actions.pod:3919
28491 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
28496 #: ../fish/guestfish-actions.pod:3925
28502 #: ../fish/guestfish-actions.pod:3927
28505 " sfdiskM device 'lines ...'\n"
28511 #: ../fish/guestfish-actions.pod:3929
28513 "This is a simplified interface to the L</sfdisk> command, where partition "
28514 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
28515 "you don't need to specify the cyls, heads and sectors parameters which were "
28516 "rarely if ever used anyway."
28521 #: ../fish/guestfish-actions.pod:3935
28522 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
28527 #: ../fish/guestfish-actions.pod:3941
28533 #: ../fish/guestfish-actions.pod:3943
28536 " sfdisk-N device partnum cyls heads sectors line\n"
28542 #: ../fish/guestfish-actions.pod:3948
28544 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
28545 "cyls/heads/sectors parameters."
28550 #: ../fish/guestfish-actions.pod:3951
28551 msgid "See also: L</part-add>"
28556 #: ../fish/guestfish-actions.pod:3956
28557 msgid "sfdisk-disk-geometry"
28562 #: ../fish/guestfish-actions.pod:3958
28565 " sfdisk-disk-geometry device\n"
28571 #: ../fish/guestfish-actions.pod:3960
28573 "This displays the disk geometry of C<device> read from the partition table. "
28574 "Especially in the case where the underlying block device has been resized, "
28575 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
28576 "kernel-geometry>)."
28581 #: ../fish/guestfish-actions.pod:3968
28582 msgid "sfdisk-kernel-geometry"
28587 #: ../fish/guestfish-actions.pod:3970
28590 " sfdisk-kernel-geometry device\n"
28596 #: ../fish/guestfish-actions.pod:3977
28602 #: ../fish/guestfish-actions.pod:3979
28605 " sfdisk-l device\n"
28611 #: ../fish/guestfish-actions.pod:3985
28612 msgid "See also: L</part-list>"
28617 #: ../fish/guestfish-actions.pod:3987
28623 #: ../fish/guestfish-actions.pod:3989
28632 #: ../fish/guestfish-actions.pod:3994
28633 msgid "This is like L</command>, but passes the command to:"
28638 #: ../fish/guestfish-actions.pod:4002
28639 msgid "All the provisos about L</command> apply to this call."
28644 #: ../fish/guestfish-actions.pod:4004
28650 #: ../fish/guestfish-actions.pod:4006
28653 " sh-lines command\n"
28659 #: ../fish/guestfish-actions.pod:4008
28660 msgid "This is the same as L</sh>, but splits the result into a list of lines."
28665 #: ../fish/guestfish-actions.pod:4011
28666 msgid "See also: L</command-lines>"
28671 #: ../fish/guestfish-actions.pod:4013
28677 #: ../fish/guestfish-actions.pod:4015
28686 #: ../fish/guestfish-actions.pod:4019
28692 #: ../fish/guestfish-actions.pod:4021
28701 #: ../fish/guestfish-actions.pod:4027
28707 #: ../fish/guestfish-actions.pod:4029
28716 #: ../fish/guestfish-actions.pod:4037
28722 #: ../fish/guestfish-actions.pod:4039
28731 #: ../fish/guestfish-actions.pod:4047
28737 #: ../fish/guestfish-actions.pod:4049
28740 " strings-e encoding path\n"
28746 #: ../fish/guestfish-actions.pod:4051
28748 "This is like the L</strings> command, but allows you to specify the encoding "
28749 "of strings that are looked for in the source file C<path>."
28754 #: ../fish/guestfish-actions.pod:4061
28756 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28757 "ISO-8859-X (this is what L</strings> uses)."
28762 #: ../fish/guestfish-actions.pod:4093
28763 msgid "swapoff-device"
28768 #: ../fish/guestfish-actions.pod:4095
28771 " swapoff-device device\n"
28777 #: ../fish/guestfish-actions.pod:4097
28779 "This command disables the libguestfs appliance swap device or partition "
28780 "named C<device>. See L</swapon-device>."
28785 #: ../fish/guestfish-actions.pod:4101
28786 msgid "swapoff-file"
28791 #: ../fish/guestfish-actions.pod:4103
28794 " swapoff-file file\n"
28800 #: ../fish/guestfish-actions.pod:4107
28801 msgid "swapoff-label"
28806 #: ../fish/guestfish-actions.pod:4109
28809 " swapoff-label label\n"
28815 #: ../fish/guestfish-actions.pod:4114
28816 msgid "swapoff-uuid"
28821 #: ../fish/guestfish-actions.pod:4116
28824 " swapoff-uuid uuid\n"
28830 #: ../fish/guestfish-actions.pod:4121
28831 msgid "swapon-device"
28836 #: ../fish/guestfish-actions.pod:4123
28839 " swapon-device device\n"
28845 #: ../fish/guestfish-actions.pod:4125
28847 "This command enables the libguestfs appliance to use the swap device or "
28848 "partition named C<device>. The increased memory is made available for all "
28849 "commands, for example those run using L</command> or L</sh>."
28854 #: ../fish/guestfish-actions.pod:4137
28855 msgid "swapon-file"
28860 #: ../fish/guestfish-actions.pod:4139
28863 " swapon-file file\n"
28869 #: ../fish/guestfish-actions.pod:4141
28871 "This command enables swap to a file. See L</swapon-device> for other notes."
28876 #: ../fish/guestfish-actions.pod:4144
28877 msgid "swapon-label"
28882 #: ../fish/guestfish-actions.pod:4146
28885 " swapon-label label\n"
28891 #: ../fish/guestfish-actions.pod:4148
28893 "This command enables swap to a labeled swap partition. See L</swapon-"
28894 "device> for other notes."
28899 #: ../fish/guestfish-actions.pod:4151
28900 msgid "swapon-uuid"
28905 #: ../fish/guestfish-actions.pod:4153
28908 " swapon-uuid uuid\n"
28914 #: ../fish/guestfish-actions.pod:4155
28916 "This command enables swap to a swap partition with the given UUID. See L</"
28917 "swapon-device> for other notes."
28922 #: ../fish/guestfish-actions.pod:4158
28928 #: ../fish/guestfish-actions.pod:4160
28937 #: ../fish/guestfish-actions.pod:4168
28943 #: ../fish/guestfish-actions.pod:4170
28952 #: ../fish/guestfish-actions.pod:4178
28958 #: ../fish/guestfish-actions.pod:4180
28961 " tail-n nrlines path\n"
28967 #: ../fish/guestfish-actions.pod:4193
28973 #: ../fish/guestfish-actions.pod:4195
28976 " tar-in (tarfile|-) directory\n"
28982 #: ../fish/guestfish-actions.pod:4200
28983 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
28988 #: ../fish/guestfish-actions.pod:4205
28994 #: ../fish/guestfish-actions.pod:4207
28997 " tar-out directory (tarfile|-)\n"
29003 #: ../fish/guestfish-actions.pod:4212
29004 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
29009 #: ../fish/guestfish-actions.pod:4217
29015 #: ../fish/guestfish-actions.pod:4219
29018 " tgz-in (tarball|-) directory\n"
29024 #: ../fish/guestfish-actions.pod:4224
29025 msgid "To upload an uncompressed tarball, use L</tar-in>."
29030 #: ../fish/guestfish-actions.pod:4228
29036 #: ../fish/guestfish-actions.pod:4230
29039 " tgz-out directory (tarball|-)\n"
29045 #: ../fish/guestfish-actions.pod:4235
29046 msgid "To download an uncompressed tarball, use L</tar-out>."
29051 #: ../fish/guestfish-actions.pod:4239
29057 #: ../fish/guestfish-actions.pod:4241
29066 #: ../fish/guestfish-actions.pod:4250
29072 #: ../fish/guestfish-actions.pod:4252
29081 #: ../fish/guestfish-actions.pod:4257
29082 msgid "truncate-size"
29087 #: ../fish/guestfish-actions.pod:4259
29090 " truncate-size path size\n"
29096 #: ../fish/guestfish-actions.pod:4264
29098 "If the current file size is less than C<size> then the file is extended to "
29099 "the required size with zero bytes. This creates a sparse file (ie. disk "
29100 "blocks are not allocated for the file until you write to it). To create a "
29101 "non-sparse file of zeroes, use L</fallocate64> instead."
29106 #: ../fish/guestfish-actions.pod:4270
29112 #: ../fish/guestfish-actions.pod:4272
29115 " tune2fs-l device\n"
29121 #: ../fish/guestfish-actions.pod:4282
29127 #: ../fish/guestfish-actions.pod:4284
29130 " txz-in (tarball|-) directory\n"
29136 #: ../fish/guestfish-actions.pod:4291
29142 #: ../fish/guestfish-actions.pod:4293
29145 " txz-out directory (tarball|-)\n"
29151 #: ../fish/guestfish-actions.pod:4300
29157 #: ../fish/guestfish-actions.pod:4302
29166 #: ../fish/guestfish-actions.pod:4316
29167 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
29172 #: ../fish/guestfish-actions.pod:4321
29178 #: ../fish/guestfish-actions.pod:4323
29184 #: ../fish/guestfish-actions.pod:4325
29187 " umount pathordevice\n"
29193 #: ../fish/guestfish-actions.pod:4331
29199 #: ../fish/guestfish-actions.pod:4333
29200 msgid "unmount-all"
29205 #: ../fish/guestfish-actions.pod:4335
29214 #: ../fish/guestfish-actions.pod:4341
29220 #: ../fish/guestfish-actions.pod:4343
29223 " upload (filename|-) remotefilename\n"
29229 #: ../fish/guestfish-actions.pod:4350
29230 msgid "See also L</download>."
29235 #: ../fish/guestfish-actions.pod:4354
29236 msgid "upload-offset"
29241 #: ../fish/guestfish-actions.pod:4356
29244 " upload-offset (filename|-) remotefilename offset\n"
29250 #: ../fish/guestfish-actions.pod:4368
29252 "Note that there is no limit on the amount of data that can be uploaded with "
29253 "this call, unlike with L</pwrite>, and this call always writes the full "
29254 "amount unless an error occurs."
29259 #: ../fish/guestfish-actions.pod:4373
29260 msgid "See also L</upload>, L</pwrite>."
29265 #: ../fish/guestfish-actions.pod:4377
29271 #: ../fish/guestfish-actions.pod:4379
29274 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
29280 #: ../fish/guestfish-actions.pod:4398
29286 #: ../fish/guestfish-actions.pod:4400
29295 #: ../fish/guestfish-actions.pod:4427
29297 "I<Note:> Don't use this call to test for availability of features. In "
29298 "enterprise distributions we backport features from later versions into "
29299 "earlier versions, making this an unreliable way to test for features. Use "
29300 "L</available> instead."
29305 #: ../fish/guestfish-actions.pod:4433
29311 #: ../fish/guestfish-actions.pod:4435
29314 " vfs-label device\n"
29320 #: ../fish/guestfish-actions.pod:4442
29321 msgid "To find a filesystem from the label, use L</findfs-label>."
29326 #: ../fish/guestfish-actions.pod:4444
29332 #: ../fish/guestfish-actions.pod:4446
29335 " vfs-type device\n"
29341 #: ../fish/guestfish-actions.pod:4456
29347 #: ../fish/guestfish-actions.pod:4458
29350 " vfs-uuid device\n"
29356 #: ../fish/guestfish-actions.pod:4465
29357 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
29362 #: ../fish/guestfish-actions.pod:4467
29363 msgid "vg-activate"
29368 #: ../fish/guestfish-actions.pod:4469
29371 " vg-activate true|false 'volgroups ...'\n"
29377 #: ../fish/guestfish-actions.pod:4482
29378 msgid "vg-activate-all"
29383 #: ../fish/guestfish-actions.pod:4484
29386 " vg-activate-all true|false\n"
29392 #: ../fish/guestfish-actions.pod:4494
29398 #: ../fish/guestfish-actions.pod:4496
29401 " vgcreate volgroup 'physvols ...'\n"
29407 #: ../fish/guestfish-actions.pod:4501
29413 #: ../fish/guestfish-actions.pod:4503
29416 " vglvuuids vgname\n"
29422 #: ../fish/guestfish-actions.pod:4508
29424 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
29425 "logical volumes and volume groups."
29430 #: ../fish/guestfish-actions.pod:4511
29431 msgid "See also L</vgpvuuids>."
29436 #: ../fish/guestfish-actions.pod:4513
29442 #: ../fish/guestfish-actions.pod:4515
29445 " vgpvuuids vgname\n"
29451 #: ../fish/guestfish-actions.pod:4520
29453 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
29454 "physical volumes and volume groups."
29459 #: ../fish/guestfish-actions.pod:4523
29460 msgid "See also L</vglvuuids>."
29465 #: ../fish/guestfish-actions.pod:4525
29471 #: ../fish/guestfish-actions.pod:4527
29474 " vgremove vgname\n"
29480 #: ../fish/guestfish-actions.pod:4534
29486 #: ../fish/guestfish-actions.pod:4536
29489 " vgrename volgroup newvolgroup\n"
29495 #: ../fish/guestfish-actions.pod:4540
29501 #: ../fish/guestfish-actions.pod:4542
29510 #: ../fish/guestfish-actions.pod:4550
29511 msgid "See also L</vgs-full>."
29516 #: ../fish/guestfish-actions.pod:4552
29522 #: ../fish/guestfish-actions.pod:4554
29531 #: ../fish/guestfish-actions.pod:4559
29537 #: ../fish/guestfish-actions.pod:4561
29546 #: ../fish/guestfish-actions.pod:4566
29552 #: ../fish/guestfish-actions.pod:4568
29561 #: ../fish/guestfish-actions.pod:4572
29567 #: ../fish/guestfish-actions.pod:4574
29576 #: ../fish/guestfish-actions.pod:4579
29582 #: ../fish/guestfish-actions.pod:4581
29591 #: ../fish/guestfish-actions.pod:4586
29597 #: ../fish/guestfish-actions.pod:4588
29606 #: ../fish/guestfish-actions.pod:4593
29612 #: ../fish/guestfish-actions.pod:4595
29615 " write path content\n"
29621 #: ../fish/guestfish-actions.pod:4603
29627 #: ../fish/guestfish-actions.pod:4605
29630 " write-file path content size\n"
29636 #: ../fish/guestfish-actions.pod:4628
29642 #: ../fish/guestfish-actions.pod:4630
29645 " zegrep regex path\n"
29651 #: ../fish/guestfish-actions.pod:4638
29657 #: ../fish/guestfish-actions.pod:4640
29660 " zegrepi regex path\n"
29666 #: ../fish/guestfish-actions.pod:4648
29672 #: ../fish/guestfish-actions.pod:4650
29681 #: ../fish/guestfish-actions.pod:4658
29682 msgid "See also: L</zero-device>, L</scrub-device>."
29687 #: ../fish/guestfish-actions.pod:4660
29688 msgid "zero-device"
29693 #: ../fish/guestfish-actions.pod:4662
29696 " zero-device device\n"
29702 #: ../fish/guestfish-actions.pod:4664
29704 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
29705 "which just zeroes the first few blocks of a device."
29710 #: ../fish/guestfish-actions.pod:4671
29716 #: ../fish/guestfish-actions.pod:4673
29719 " zerofree device\n"
29725 #: ../fish/guestfish-actions.pod:4686
29731 #: ../fish/guestfish-actions.pod:4688
29734 " zfgrep pattern path\n"
29740 #: ../fish/guestfish-actions.pod:4696
29746 #: ../fish/guestfish-actions.pod:4698
29749 " zfgrepi pattern path\n"
29755 #: ../fish/guestfish-actions.pod:4706
29761 #: ../fish/guestfish-actions.pod:4708
29764 " zfile meth path\n"
29770 #: ../fish/guestfish-actions.pod:4715
29772 "Since 1.0.63, use L</file> instead which can now process compressed files."
29777 #: ../fish/guestfish-actions.pod:4725
29783 #: ../fish/guestfish-actions.pod:4727
29786 " zgrep regex path\n"
29792 #: ../fish/guestfish-actions.pod:4735
29798 #: ../fish/guestfish-actions.pod:4737
29801 " zgrepi regex path\n"
29807 #: ../fish/guestfish-commands.pod:1
29813 #: ../fish/guestfish-commands.pod:3
29819 #: ../fish/guestfish-commands.pod:5
29822 " alloc filename size\n"
29828 #: ../fish/guestfish-commands.pod:7
29830 "This creates an empty (zeroed) file of the given size, and then adds so it "
29831 "can be further examined."
29836 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
29837 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
29842 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
29843 msgid "Size can be specified using standard suffixes, eg. C<1M>."
29848 #: ../fish/guestfish-commands.pod:14
29850 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
29851 "image, see L</PREPARED DISK IMAGES>."
29856 #: ../fish/guestfish-commands.pod:17
29862 #: ../fish/guestfish-commands.pod:19
29865 " copy-in local [local ...] /remotedir\n"
29871 #: ../fish/guestfish-commands.pod:21
29873 "C<copy-in> copies local files or directories recursively into the disk "
29874 "image, placing them in the directory called C</remotedir> (which must "
29875 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
29876 "other commands as necessary."
29881 #: ../fish/guestfish-commands.pod:26
29883 "Multiple local files and directories can be specified, but the last "
29884 "parameter must always be a remote directory. Wildcards cannot be used."
29889 #: ../fish/guestfish-commands.pod:30
29895 #: ../fish/guestfish-commands.pod:32
29898 " copy-out remote [remote ...] localdir\n"
29904 #: ../fish/guestfish-commands.pod:34
29906 "C<copy-out> copies remote files or directories recursively out of the disk "
29907 "image, placing them on the host disk in a local directory called C<localdir> "
29908 "(which must exist). This guestfish meta-command turns into a sequence of L</"
29909 "download>, L</tar-out> and other commands as necessary."
29914 #: ../fish/guestfish-commands.pod:40
29916 "Multiple remote files and directories can be specified, but the last "
29917 "parameter must always be a local directory. To download to the current "
29918 "directory, use C<.> as in:"
29923 #: ../fish/guestfish-commands.pod:44
29926 " copy-out /home .\n"
29932 #: ../fish/guestfish-commands.pod:46
29934 "Wildcards cannot be used in the ordinary command, but you can use them with "
29935 "the help of L</glob> like this:"
29940 #: ../fish/guestfish-commands.pod:49
29943 " glob copy-out /home/* .\n"
29949 #: ../fish/guestfish-commands.pod:51
29955 #: ../fish/guestfish-commands.pod:53
29958 " echo [params ...]\n"
29964 #: ../fish/guestfish-commands.pod:55
29965 msgid "This echos the parameters to the terminal."
29970 #: ../fish/guestfish-commands.pod:57
29976 #: ../fish/guestfish-commands.pod:59
29982 #: ../fish/guestfish-commands.pod:61
29988 #: ../fish/guestfish-commands.pod:63
29997 #: ../fish/guestfish-commands.pod:65
29999 "This is used to edit a file. It downloads the file, edits it locally using "
30000 "your editor, then uploads the result."
30005 #: ../fish/guestfish-commands.pod:68
30007 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
30008 "or C<emacs> you will get those corresponding editors."
30013 #: ../fish/guestfish-commands.pod:72
30019 #: ../fish/guestfish-commands.pod:74
30022 " glob command args...\n"
30028 #: ../fish/guestfish-commands.pod:76
30030 "Expand wildcards in any paths in the args list, and run C<command> "
30031 "repeatedly on each matching path."
30036 #: ../fish/guestfish-commands.pod:79
30037 msgid "See L</WILDCARDS AND GLOBBING>."
30042 #: ../fish/guestfish-commands.pod:81
30048 #: ../fish/guestfish-commands.pod:83
30051 " hexedit <filename|device>\n"
30052 " hexedit <filename|device> <max>\n"
30053 " hexedit <filename|device> <start> <max>\n"
30059 #: ../fish/guestfish-commands.pod:87
30061 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
30067 #: ../fish/guestfish-commands.pod:90
30069 "This command works by downloading potentially the whole file or device, "
30070 "editing it locally, then uploading it. If the file or device is large, you "
30071 "have to specify which part you wish to edit by using C<max> and/or C<start> "
30072 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
30073 "usual modifiers allowed such as C<1M> (1 megabyte)."
30078 #: ../fish/guestfish-commands.pod:97
30079 msgid "For example to edit the first few sectors of a disk you might do:"
30084 #: ../fish/guestfish-commands.pod:100
30087 " hexedit /dev/sda 1M\n"
30093 #: ../fish/guestfish-commands.pod:102
30095 "which would allow you to edit anywhere within the first megabyte of the disk."
30100 #: ../fish/guestfish-commands.pod:105
30101 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
30106 #: ../fish/guestfish-commands.pod:107
30109 " hexedit /dev/sda1 0x400 0x400\n"
30115 #: ../fish/guestfish-commands.pod:109
30116 msgid "(assuming the superblock is in the standard location)."
30121 #: ../fish/guestfish-commands.pod:111
30123 "This command requires the external L<hexedit(1)> program. You can specify "
30124 "another program to use by setting the C<HEXEDITOR> environment variable."
30129 #: ../fish/guestfish-commands.pod:115
30130 msgid "See also L</hexdump>."
30135 #: ../fish/guestfish-commands.pod:117
30141 #: ../fish/guestfish-commands.pod:119
30150 #: ../fish/guestfish-commands.pod:121
30152 "Change the local directory, ie. the current directory of guestfish itself."
30157 #: ../fish/guestfish-commands.pod:124
30158 msgid "Note that C<!cd> won't do what you might expect."
30163 #: ../fish/guestfish-commands.pod:126
30169 #: ../fish/guestfish-commands.pod:128
30175 #: ../fish/guestfish-commands.pod:130
30184 #: ../fish/guestfish-commands.pod:132
30185 msgid "Opens the manual page for guestfish."
30190 #: ../fish/guestfish-commands.pod:134
30196 #: ../fish/guestfish-commands.pod:136
30202 #: ../fish/guestfish-commands.pod:138
30211 #: ../fish/guestfish-commands.pod:140
30220 #: ../fish/guestfish-commands.pod:142
30221 msgid "This is used to view a file."
30226 #: ../fish/guestfish-commands.pod:144
30228 "The default viewer is C<$PAGER>. However if you use the alternate command "
30229 "C<less> you will get the C<less> command specifically."
30234 #: ../fish/guestfish-commands.pod:147
30240 #: ../fish/guestfish-commands.pod:149
30249 #: ../fish/guestfish-commands.pod:151
30251 "Close and reopen the libguestfs handle. It is not necessary to use this "
30252 "normally, because the handle is closed properly when guestfish exits. "
30253 "However this is occasionally useful for testing."
30258 #: ../fish/guestfish-commands.pod:155
30264 #: ../fish/guestfish-commands.pod:157
30267 " sparse filename size\n"
30273 #: ../fish/guestfish-commands.pod:159
30275 "This creates an empty sparse file of the given size, and then adds so it can "
30276 "be further examined."
30281 #: ../fish/guestfish-commands.pod:162
30283 "In all respects it works the same as the L</alloc> command, except that the "
30284 "image file is allocated sparsely, which means that disk blocks are not "
30285 "assigned to the file until they are needed. Sparse disk files only use "
30286 "space when written to, but they are slower and there is a danger you could "
30287 "run out of real disk space during a write operation."
30292 #: ../fish/guestfish-commands.pod:172
30298 #: ../fish/guestfish-commands.pod:174
30307 #: ../fish/guestfish-commands.pod:176
30309 "This command returns a list of the optional groups known to the daemon, and "
30310 "indicates which ones are supported by this build of the libguestfs appliance."
30315 #: ../fish/guestfish-commands.pod:180
30316 msgid "See also L<guestfs(3)/AVAILABILITY>."
30321 #: ../fish/guestfish-commands.pod:182
30327 #: ../fish/guestfish-commands.pod:184
30330 " time command args...\n"
30336 #: ../fish/guestfish-commands.pod:186
30338 "Run the command as usual, but print the elapsed time afterwards. This can "
30339 "be useful for benchmarking operations."
30344 #: ../test-tool/libguestfs-test-tool.pod:5
30345 msgid "libguestfs-test-tool - End user tests for libguestfs"
30350 #: ../test-tool/libguestfs-test-tool.pod:9
30353 " libguestfs-test-tool [--options]\n"
30359 #: ../test-tool/libguestfs-test-tool.pod:13
30361 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
30362 "and developers, to allow them to check basic libguestfs functionality is "
30363 "working. This is needed because libguestfs occasionally breaks for reasons "
30364 "beyond our control: usually because of changes in the underlying qemu or "
30365 "kernel packages, or the host environment."
30370 #: ../test-tool/libguestfs-test-tool.pod:20
30371 msgid "If you suspect a problem in libguestfs, then just run:"
30376 #: ../test-tool/libguestfs-test-tool.pod:22
30379 " libguestfs-test-tool\n"
30385 #: ../test-tool/libguestfs-test-tool.pod:24
30386 msgid "It will print lots of diagnostic messages."
30391 #: ../test-tool/libguestfs-test-tool.pod:26
30392 msgid "If it runs to completion successfully, you will see this near the end:"
30397 #: ../test-tool/libguestfs-test-tool.pod:28
30400 " ===== TEST FINISHED OK =====\n"
30406 #: ../test-tool/libguestfs-test-tool.pod:30
30407 msgid "and the test tool will exit with code 0."
30412 #: ../test-tool/libguestfs-test-tool.pod:32
30414 "If it fails (and/or exits with non-zero error code), please paste the "
30415 "B<complete, unedited> output of the test tool into a bug report. More "
30416 "information about reporting bugs can be found on the L<http://libguestfs.org/"
30422 #: ../test-tool/libguestfs-test-tool.pod:41
30428 #: ../test-tool/libguestfs-test-tool.pod:43
30429 msgid "Display short usage information and exit."
30434 #: ../test-tool/libguestfs-test-tool.pod:45
30435 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
30440 #: ../test-tool/libguestfs-test-tool.pod:47
30442 "Pass an alternate name for the helper program. libguestfs-test-tool will "
30443 "normally look in the C<$libexec> directory that was configured when the tool "
30449 #: ../test-tool/libguestfs-test-tool.pod:51
30450 msgid "I<--qemu qemu_binary>"
30455 #: ../test-tool/libguestfs-test-tool.pod:53
30457 "If you have downloaded another qemu binary, point this option at the full "
30458 "path of the binary to try it."
30463 #: ../test-tool/libguestfs-test-tool.pod:56
30464 msgid "I<--qemudir qemu_source_dir>"
30469 #: ../test-tool/libguestfs-test-tool.pod:58
30471 "If you have compiled qemu from source, point this option at the source "
30472 "directory to try it."
30477 #: ../test-tool/libguestfs-test-tool.pod:61
30478 msgid "I<--timeout N>"
30483 #: ../test-tool/libguestfs-test-tool.pod:63
30485 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
30486 "does not usually need to be adjusted unless your machine is very slow."
30491 #: ../test-tool/libguestfs-test-tool.pod:69
30492 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
30497 #: ../test-tool/libguestfs-test-tool.pod:71
30499 "If you have compiled another version of qemu from source and would like to "
30500 "try that, then you can use the I<--qemudir> option to point to the qemu "
30501 "source directory."
30506 #: ../test-tool/libguestfs-test-tool.pod:75
30508 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
30509 "option to point to the binary."
30514 #: ../test-tool/libguestfs-test-tool.pod:78
30516 "When using an alternate qemu with libguestfs, usually you would need to "
30517 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
30518 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
30519 "use either of the I<--qemudir> or I<--qemu> options."
30524 #: ../test-tool/libguestfs-test-tool.pod:85
30526 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
30527 "I<1> if there was an error."
30532 #: ../test-tool/libguestfs-test-tool.pod:92
30533 msgid "/usr/libexec/libguestfs-test-tool-helper"
30538 #: ../test-tool/libguestfs-test-tool.pod:94
30540 "This helper program is run inside the appliance and provides additional "
30546 #: ../test-tool/libguestfs-test-tool.pod:97
30547 msgid "/usr/bin/mkisofs"
30552 #: ../test-tool/libguestfs-test-tool.pod:99
30554 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
30555 "which is used as part of the tests."
30560 #: ../test-tool/libguestfs-test-tool.pod:106
30562 "For the full list of environment variables which may affect libguestfs, "
30563 "please see the L<guestfs(3)> manual page."
30568 #: ../test-tool/libguestfs-test-tool.pod:111
30569 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
30574 #: ../test-tool/libguestfs-test-tool.pod:121
30575 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
30580 #: ../fuse/guestmount.pod:5
30582 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
30587 #: ../fuse/guestmount.pod:9
30590 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
30596 #: ../fuse/guestmount.pod:11
30599 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
30605 #: ../fuse/guestmount.pod:13
30608 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
30614 #: ../fuse/guestmount.pod:17
30616 "You must I<not> use C<guestmount> in read-write mode on live virtual "
30617 "machines. If you do this, you risk disk corruption in the VM."
30622 #: ../fuse/guestmount.pod:22
30624 "The guestmount program can be used to mount virtual machine filesystems and "
30625 "other disk images on the host. It uses libguestfs for access to the guest "
30626 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
30627 "a mountable device."
30632 #: ../fuse/guestmount.pod:27
30634 "Along with other options, you have to give at least one device (I<-a> "
30635 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
30636 "option) or use the I<-i> inspection option. How this works is better "
30637 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
30643 #: ../fuse/guestmount.pod:33
30645 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
30646 "by you, and the filesystem will not be visible to any other users unless you "
30647 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
30648 "the filesystem, use the C<fusermount -u> command."
30653 #: ../fuse/guestmount.pod:41
30655 "For a typical Windows guest which has its main filesystem on the first "
30661 #: ../fuse/guestmount.pod:44
30664 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
30670 #: ../fuse/guestmount.pod:46
30672 "For a typical Linux guest which has a /boot filesystem on the first "
30673 "partition, and the root filesystem on a logical volume:"
30678 #: ../fuse/guestmount.pod:49
30681 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
30687 #: ../fuse/guestmount.pod:51
30688 msgid "To get libguestfs to detect guest mountpoints for you:"
30693 #: ../fuse/guestmount.pod:53
30696 " guestmount -a guest.img -i --ro /mnt\n"
30702 #: ../fuse/guestmount.pod:55
30703 msgid "For a libvirt guest called \"Guest\" you could do:"
30708 #: ../fuse/guestmount.pod:57
30711 " guestmount -d Guest -i --ro /mnt\n"
30717 #: ../fuse/guestmount.pod:59
30719 "If you don't know what filesystems are contained in a guest or disk image, "
30720 "use L<virt-filesystems(1)> first:"
30725 #: ../fuse/guestmount.pod:62
30728 " virt-filesystems MyGuest\n"
30734 #: ../fuse/guestmount.pod:64
30736 "If you want to trace the libguestfs calls but without excessive debugging "
30737 "information, we recommend:"
30742 #: ../fuse/guestmount.pod:67
30745 " guestmount [...] --trace /mnt\n"
30751 #: ../fuse/guestmount.pod:69
30752 msgid "If you want to debug the program, we recommend:"
30757 #: ../fuse/guestmount.pod:71
30760 " guestmount [...] --trace --verbose /mnt\n"
30766 #: ../fuse/guestmount.pod:77
30767 msgid "B<-a image> | B<--add image>"
30772 #: ../fuse/guestmount.pod:79
30773 msgid "Add a block device or virtual machine image."
30778 #: ../fuse/guestmount.pod:84
30779 msgid "B<-c URI> | B<--connect URI>"
30784 #: ../fuse/guestmount.pod:90
30785 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
30790 #: ../fuse/guestmount.pod:96
30791 msgid "B<--dir-cache-timeout N>"
30796 #: ../fuse/guestmount.pod:98
30798 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
30799 "seconds. The readdir cache [actually, there are several semi-independent "
30800 "caches] is populated after a readdir(2) call with the stat and extended "
30801 "attributes of the files in the directory, in anticipation that they will be "
30802 "requested soon after."
30807 #: ../fuse/guestmount.pod:104
30809 "There is also a different attribute cache implemented by FUSE (see the FUSE "
30810 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
30811 "requests, only cache existing ones."
30816 #: ../fuse/guestmount.pod:115
30817 msgid "B<--format=raw|qcow2|..> | B<--format>"
30822 #: ../fuse/guestmount.pod:122
30824 "If you have untrusted raw-format guest disk images, you should use this "
30825 "option to specify the disk format. This avoids a possible security problem "
30826 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
30827 "guestfs_add_drive_opts>."
30832 #: ../fuse/guestmount.pod:127
30833 msgid "B<--fuse-help>"
30838 #: ../fuse/guestmount.pod:129
30839 msgid "Display help on special FUSE options (see I<-o> below)."
30844 #: ../fuse/guestmount.pod:133
30845 msgid "Display brief help and exit."
30850 #: ../fuse/guestmount.pod:135
30851 msgid "B<-i> | B<--inspector>"
30856 #: ../fuse/guestmount.pod:146
30857 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
30862 #: ../fuse/guestmount.pod:148
30864 "Mount the named partition or logical volume on the given mountpoint B<in the "
30865 "guest> (this has nothing to do with mountpoints in the host)."
30870 #: ../fuse/guestmount.pod:151
30872 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
30873 "something on C</>."
30878 #: ../fuse/guestmount.pod:154
30879 msgid "B<-n> | B<--no-sync>"
30884 #: ../fuse/guestmount.pod:156
30886 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
30887 "unmounted. If you specify this option, then we don't attempt to sync the "
30888 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
30893 #: ../fuse/guestmount.pod:161
30894 msgid "B<-o option> | B<--option option>"
30899 #: ../fuse/guestmount.pod:163
30900 msgid "Pass extra options to FUSE."
30905 #: ../fuse/guestmount.pod:165
30907 "To get a list of all the extra options supported by FUSE, use the command "
30908 "below. Note that only the FUSE I<-o> options can be passed, and only some "
30909 "of them are a good idea."
30914 #: ../fuse/guestmount.pod:169
30917 " guestmount --fuse-help\n"
30923 #: ../fuse/guestmount.pod:171
30924 msgid "Some potentially useful FUSE options:"
30929 #: ../fuse/guestmount.pod:175
30930 msgid "B<-o allow_other>"
30935 #: ../fuse/guestmount.pod:177
30936 msgid "Allow other users to see the filesystem."
30941 #: ../fuse/guestmount.pod:179
30942 msgid "B<-o attr_timeout=N>"
30947 #: ../fuse/guestmount.pod:181
30948 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
30953 #: ../fuse/guestmount.pod:183
30954 msgid "B<-o kernel_cache>"
30959 #: ../fuse/guestmount.pod:185
30961 "Allow the kernel to cache files (reduces the number of reads that have to go "
30962 "through the L<guestfs(3)> API). This is generally a good idea if you can "
30963 "afford the extra memory usage."
30968 #: ../fuse/guestmount.pod:189
30969 msgid "B<-o uid=N> B<-o gid=N>"
30974 #: ../fuse/guestmount.pod:191
30976 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
30977 "the chosen values."
30982 #: ../fuse/guestmount.pod:196
30983 msgid "B<-r> | B<--ro>"
30988 #: ../fuse/guestmount.pod:198
30990 "Add devices and mount everything read-only. Also disallow writes and make "
30991 "the disk appear read-only to FUSE."
30996 #: ../fuse/guestmount.pod:201
30998 "This is highly recommended if you are not going to edit the guest disk. If "
30999 "the guest is running and this option is I<not> supplied, then there is a "
31000 "strong risk of disk corruption in the guest. We try to prevent this from "
31001 "happening, but it is not always possible."
31006 #: ../fuse/guestmount.pod:206
31007 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
31012 #: ../fuse/guestmount.pod:210
31013 msgid "Enable SELinux support for the guest."
31018 #: ../fuse/guestmount.pod:212
31019 msgid "B<-v> | B<--verbose>"
31024 #: ../fuse/guestmount.pod:214
31025 msgid "Enable verbose messages from underlying libguestfs."
31030 #: ../fuse/guestmount.pod:216
31031 msgid "B<-V> | B<--version>"
31036 #: ../fuse/guestmount.pod:218
31037 msgid "Display the program version and exit."
31042 #: ../fuse/guestmount.pod:220
31043 msgid "B<-w> | B<--rw>"
31048 #: ../fuse/guestmount.pod:222
31050 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
31051 "FOR READ AND WRITE>."
31056 #: ../fuse/guestmount.pod:225
31057 msgid "B<-x> | B<--trace>"
31062 #: ../fuse/guestmount.pod:227
31063 msgid "Trace libguestfs calls and entry into each FUSE function."
31068 #: ../fuse/guestmount.pod:229
31069 msgid "This also stops the daemon from forking into the background."
31074 #: ../fuse/guestmount.pod:235
31076 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
31077 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
31082 #: ../tools/virt-edit.pl:34
31083 msgid "virt-edit - Edit a file in a virtual machine"
31087 #: ../tools/virt-edit.pl:38
31090 " virt-edit [--options] domname file\n"
31095 #: ../tools/virt-edit.pl:40
31098 " virt-edit [--options] disk.img [disk.img ...] file\n"
31103 #: ../tools/virt-edit.pl:42
31106 " virt-edit [domname|disk.img] file -e 'expr'\n"
31111 #: ../tools/virt-edit.pl:46
31113 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
31114 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
31115 "doing this, but doesn't catch all cases."
31119 #: ../tools/virt-edit.pl:52
31121 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
31122 "the named virtual machine (or disk image)."
31126 #: ../tools/virt-edit.pl:55
31128 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
31129 "you should look at the L<guestfish(1)> tool."
31133 #: ../tools/virt-edit.pl:60
31134 msgid "Edit the named files interactively:"
31138 #: ../tools/virt-edit.pl:62
31141 " virt-edit mydomain /boot/grub/grub.conf\n"
31146 #: ../tools/virt-edit.pl:64
31149 " virt-edit mydomain /etc/passwd\n"
31154 #: ../tools/virt-edit.pl:66
31156 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
31157 "below). To change the init default level to 5:"
31161 #: ../tools/virt-edit.pl:70
31164 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
31169 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106
31170 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
31171 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
31172 msgid "Display brief help."
31176 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114
31177 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
31178 #: ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171
31179 #: ../tools/virt-list-partitions.pl:72
31180 msgid "Display version number and exit."
31184 #: ../tools/virt-edit.pl:96
31185 msgid "B<--backup extension> | B<-b extension>"
31189 #: ../tools/virt-edit.pl:98
31191 "Create a backup of the original file I<in the guest disk image>. The backup "
31192 "has the original filename with C<extension> added."
31196 #: ../tools/virt-edit.pl:101
31198 "Usually the first character of C<extension> would be a dot C<.> so you would "
31203 #: ../tools/virt-edit.pl:104
31206 " virt-edit -b .orig [etc]\n"
31211 #: ../tools/virt-edit.pl:106
31212 msgid "By default, no backup file is made."
31216 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128
31217 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
31218 #: ../tools/virt-list-partitions.pl:78
31219 msgid "B<--connect URI> | B<-c URI>"
31223 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130
31224 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
31225 #: ../tools/virt-list-partitions.pl:80
31227 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
31228 "to the default libvirt hypervisor."
31232 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133
31233 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
31234 #: ../tools/virt-list-partitions.pl:83
31236 "If you specify guest block devices directly, then libvirt is not used at all."
31240 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140
31241 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
31242 #: ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
31243 msgid "B<--format> raw"
31247 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142
31248 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
31249 #: ../tools/virt-list-partitions.pl:92
31251 "Specify the format of disk images given on the command line. If this is "
31252 "omitted then the format is autodetected from the content of the disk image."
31256 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146
31257 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
31258 #: ../tools/virt-list-partitions.pl:96
31260 "If disk images are requested from libvirt, then this program asks libvirt "
31261 "for this information. In this case, the value of the format parameter is "
31266 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150
31267 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
31268 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
31269 #: ../tools/virt-list-partitions.pl:100
31271 "If working with untrusted raw-format guest disk images, you should ensure "
31272 "the format is always specified."
31276 #: ../tools/virt-edit.pl:141
31277 msgid "B<--expr EXPR> | B<-e EXPR>"
31281 #: ../tools/virt-edit.pl:143
31283 "Instead of launching the external editor, non-interactively apply the Perl "
31284 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
31289 #: ../tools/virt-edit.pl:147
31291 "Be careful to properly quote the expression to prevent it from being altered "
31296 #: ../tools/virt-edit.pl:268
31297 msgid "NON-INTERACTIVE EDITING"
31301 #: ../tools/virt-edit.pl:270
31303 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
31304 "administrator can interactively edit the file."
31308 #: ../tools/virt-edit.pl:273
31310 "There are two ways also to use C<virt-edit> from scripts in order to make "
31311 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
31312 "like this, it's less error-prone to write scripts directly using the "
31313 "libguestfs API and Augeas for configuration file editing.)"
31317 #: ../tools/virt-edit.pl:279
31319 "The first method is to temporarily set C<$EDITOR> to any script or program "
31320 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
31321 "update C<tmpfile> in place however it likes."
31325 #: ../tools/virt-edit.pl:283
31327 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
31328 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
31329 "instances of C<foo> with C<bar> in a file:"
31333 #: ../tools/virt-edit.pl:287
31336 " virt-edit domname filename -e 's/foo/bar/'\n"
31341 #: ../tools/virt-edit.pl:289
31343 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
31344 "For example to delete root's password you could do:"
31348 #: ../tools/virt-edit.pl:292
31351 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
31356 #: ../tools/virt-edit.pl:294
31358 "What really happens is that the snippet is evaluated as a Perl expression "
31359 "for each line of the file. The line, including the final C<\\n>, is passed "
31360 "in C<$_> and the expression should update C<$_> or leave it unchanged."
31364 #: ../tools/virt-edit.pl:299
31366 "To delete a line, set C<$_> to the empty string. For example, to delete the "
31367 "C<apache> user account from the password file you can do:"
31371 #: ../tools/virt-edit.pl:302
31374 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
31379 #: ../tools/virt-edit.pl:304
31381 "To insert a line, prepend or append it to C<$_>. However appending lines to "
31382 "the end of the file is rather difficult this way since there is no concept "
31383 "of \"last line of the file\" - your expression just doesn't get called "
31384 "again. You might want to use the first method (setting C<$EDITOR>) if you "
31389 #: ../tools/virt-edit.pl:310
31391 "The variable C<$lineno> contains the current line number. As is "
31392 "traditional, the first line in the file is number C<1>."
31396 #: ../tools/virt-edit.pl:313
31398 "The return value from the expression is ignored, but the expression may call "
31399 "C<die> in order to abort the whole program, leaving the original file "
31404 #: ../tools/virt-edit.pl:317
31406 "Remember when matching the end of a line that C<$_> may contain the final C<"
31407 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
31408 "newline then neither of these. Thus to match or substitute some text at the "
31409 "end of a line, use this regular expression:"
31413 #: ../tools/virt-edit.pl:322
31416 " /some text(\\r?\\n)?$/\n"
31421 #: ../tools/virt-edit.pl:324
31423 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
31424 "$_> itself (since that would remove all newlines from the file):"
31428 #: ../tools/virt-edit.pl:328
31431 " my $m = $_; chomp $m; $m =~ /some text$/\n"
31436 #: ../tools/virt-edit.pl:334
31441 #: ../tools/virt-edit.pl:336
31443 "If set, this string is used as the editor. It may contain arguments, eg. C<"
31448 #: ../tools/virt-edit.pl:339
31449 msgid "If not set, C<vi> is used."
31453 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559
31454 #: ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182
31455 #: ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:532
31456 #: ../tools/virt-list-partitions.pl:250
31457 msgid "SHELL QUOTING"
31461 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567
31462 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184
31463 #: ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:534
31464 #: ../tools/virt-list-partitions.pl:252
31466 "Libvirt guest names can contain arbitrary characters, some of which have "
31467 "meaning to the shell such as C<#> and space. You may need to quote or "
31468 "escape these characters on the command line. See the shell manual page L<sh"
31469 "(1)> for details."
31473 #: ../tools/virt-edit.pl:352
31475 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
31476 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
31481 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:598
31482 #: ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202
31483 #: ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:564
31484 #: ../tools/virt-list-partitions.pl:269
31489 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:600
31490 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204
31491 #: ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:566
31492 #: ../tools/virt-list-partitions.pl:271
31493 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
31497 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
31498 msgid "Copyright (C) 2009-2010 Red Hat Inc."
31502 #: ../tools/virt-win-reg.pl:37
31504 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
31508 #: ../tools/virt-win-reg.pl:41
31511 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
31516 #: ../tools/virt-win-reg.pl:43
31519 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
31524 #: ../tools/virt-win-reg.pl:45
31527 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
31532 #: ../tools/virt-win-reg.pl:47
31535 " virt-win-reg --merge domname [input.reg ...]\n"
31540 #: ../tools/virt-win-reg.pl:49
31543 " virt-win-reg [--options] disk.img ... # instead of domname\n"
31548 #: ../tools/virt-win-reg.pl:53
31550 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
31551 "virtual machines. If you do this, you I<will> get irreversible disk "
31552 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
31553 "but doesn't catch all cases."
31557 #: ../tools/virt-win-reg.pl:58
31559 "Modifying the Windows Registry is an inherently risky operation. The format "
31560 "is deliberately obscure and undocumented, and Registry changes can leave the "
31561 "system unbootable. Therefore when using the C<--merge> option, make sure "
31562 "you have a reliable backup first."
31566 #: ../tools/virt-win-reg.pl:65
31568 "This program can export and merge Windows Registry entries from a Windows "
31573 #: ../tools/virt-win-reg.pl:68
31575 "The first parameter is the libvirt guest name or the raw disk image of a "
31580 #: ../tools/virt-win-reg.pl:71
31582 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
31583 "exported (recursively). For example:"
31587 #: ../tools/virt-win-reg.pl:74
31590 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
31595 #: ../tools/virt-win-reg.pl:76
31597 "You can also display single values from within registry keys, for example:"
31601 #: ../tools/virt-win-reg.pl:79
31604 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
31605 " $ virt-win-reg Windows7 $cvkey ProductName\n"
31606 " Windows 7 Enterprise\n"
31611 #: ../tools/virt-win-reg.pl:83
31613 "With C<--merge>, you can merge a textual regedit file into the Windows "
31618 #: ../tools/virt-win-reg.pl:86
31621 " $ virt-win-reg --merge Windows7 changes.reg\n"
31626 #: ../tools/virt-win-reg.pl:88
31631 #: ../tools/virt-win-reg.pl:90
31633 "This program is only meant for simple access to the registry. If you want "
31634 "to do complicated things with the registry, we suggest you download the "
31635 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
31636 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
31637 "L<hivexregedit(1)>."
31641 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
31646 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
31647 msgid "Enable debugging messages."
31651 #: ../tools/virt-win-reg.pl:157
31656 #: ../tools/virt-win-reg.pl:159
31658 "In merge mode, this merges a textual regedit file into the Windows Registry "
31659 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
31660 "displays or exports Registry entries instead."
31664 #: ../tools/virt-win-reg.pl:163
31666 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
31667 "result in disk corruption. However exporting (without this flag) is always "
31672 #: ../tools/virt-win-reg.pl:171
31673 msgid "B<--encoding> UTF-16LE|ASCII"
31677 #: ../tools/virt-win-reg.pl:173
31679 "When merging (only), you may need to specify the encoding for strings to be "
31680 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
31681 "(3)/ENCODING STRINGS>."
31685 #: ../tools/virt-win-reg.pl:177
31687 "The default is to use UTF-16LE, which should work with recent versions of "
31692 #: ../tools/virt-win-reg.pl:402
31693 msgid "SUPPORTED SYSTEMS"
31697 #: ../tools/virt-win-reg.pl:404
31699 "The program currently supports Windows NT-derived guests starting with "
31700 "Windows XP through to at least Windows 7."
31704 #: ../tools/virt-win-reg.pl:407
31706 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
31707 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
31708 "and C<HKEY_USERS\\.DEFAULT>."
31712 #: ../tools/virt-win-reg.pl:411
31714 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
31719 #: ../tools/virt-win-reg.pl:414
31721 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
31726 #: ../tools/virt-win-reg.pl:417
31731 #: ../tools/virt-win-reg.pl:419
31733 "C<virt-win-reg> expects that regedit files have already been reencoded in "
31734 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
31735 "style line endings. Since Windows regedit files are often in UTF-16LE with "
31736 "Windows-style line endings, you may need to reencode the whole file before "
31737 "or after processing."
31741 #: ../tools/virt-win-reg.pl:425
31743 "To reencode a file from Windows format to Linux (before processing it with "
31744 "the C<--merge> option), you would do something like this:"
31748 #: ../tools/virt-win-reg.pl:428
31751 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
31756 #: ../tools/virt-win-reg.pl:430
31758 "To go in the opposite direction, after exporting and before sending the file "
31759 "to a Windows user, do something like this:"
31763 #: ../tools/virt-win-reg.pl:433
31766 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
31771 #: ../tools/virt-win-reg.pl:435
31772 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
31776 #: ../tools/virt-win-reg.pl:437
31778 "If you are unsure about the current encoding, use the L<file(1)> command. "
31779 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
31780 "style (CRLF) line endings, like this:"
31784 #: ../tools/virt-win-reg.pl:441
31787 " $ file software.reg\n"
31788 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
31789 " with CRLF line terminators\n"
31794 #: ../tools/virt-win-reg.pl:445
31795 msgid "This file would need conversion before you could C<--merge> it."
31799 #: ../tools/virt-win-reg.pl:447
31800 msgid "CurrentControlSet etc."
31804 #: ../tools/virt-win-reg.pl:449
31806 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
31807 "Registry at the level of the hive file, and therefore you cannot modify "
31812 #: ../tools/virt-win-reg.pl:453
31814 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
31815 "circumstances it might refer to another control set. The way to find out is "
31816 "to look at the C<HKLM\\SYSTEM\\Select> key:"
31820 #: ../tools/virt-win-reg.pl:457
31823 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
31824 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
31825 " \"Current\"=dword:00000001\n"
31826 " \"Default\"=dword:00000001\n"
31827 " \"Failed\"=dword:00000000\n"
31828 " \"LastKnownGood\"=dword:00000002\n"
31833 #: ../tools/virt-win-reg.pl:464
31834 msgid "\"Current\" is the one which Windows will choose when it boots."
31838 #: ../tools/virt-win-reg.pl:466
31840 "Similarly, other C<Current...> keys in the path may need to be replaced."
31844 #: ../tools/virt-win-reg.pl:469
31845 msgid "WINDOWS TIPS"
31849 #: ../tools/virt-win-reg.pl:471
31851 "Note that some of these tips modify the guest disk image. The guest I<must> "
31852 "be shut off, else you will get disk corruption."
31856 #: ../tools/virt-win-reg.pl:474
31857 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
31861 #: ../tools/virt-win-reg.pl:476
31863 "Prepare a DOS batch script, VBScript or executable. Upload this using "
31864 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
31865 "is uploaded into C<C:\\>:"
31869 #: ../tools/virt-win-reg.pl:480
31872 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
31877 #: ../tools/virt-win-reg.pl:482
31878 msgid "Prepare a regedit file containing the registry change:"
31882 #: ../tools/virt-win-reg.pl:484
31885 " cat > test.reg <<'EOF'\n"
31886 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
31887 " \"Test\"=\"c:\\\\test.bat\"\n"
31893 #: ../tools/virt-win-reg.pl:489
31895 "In this example we use the key C<RunOnce> which means that the script will "
31896 "run precisely once when the first user logs in. If you want it to run every "
31897 "time a user logs in, replace C<RunOnce> with C<Run>."
31901 #: ../tools/virt-win-reg.pl:493
31902 msgid "Now update the registry:"
31906 #: ../tools/virt-win-reg.pl:495
31909 " virt-win-reg --merge WindowsGuest test.reg\n"
31914 #: ../tools/virt-win-reg.pl:497
31915 msgid "INSTALLING A SERVICE"
31919 #: ../tools/virt-win-reg.pl:499
31921 "This section assumes you are familiar with Windows services, and you either "
31922 "have a program which handles the Windows Service Control Protocol directly "
31923 "or you want to run any program using a service wrapper like SrvAny or the "
31928 #: ../tools/virt-win-reg.pl:504
31930 "First upload the program and optionally the service wrapper. In this case "
31931 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
31935 #: ../tools/virt-win-reg.pl:508
31938 " guestfish -i -d WindowsGuest <<EOF\n"
31939 " upload rhsrvany.exe /rhsrvany.exe\n"
31940 " upload test.exe /test.exe\n"
31946 #: ../tools/virt-win-reg.pl:513
31948 "Prepare a regedit file containing the registry changes. In this example, "
31949 "the first registry change is needed for the service itself or the service "
31950 "wrapper (if used). The second registry change is only needed because I am "
31951 "using the RHSrvAny service wrapper."
31955 #: ../tools/virt-win-reg.pl:518
31958 " cat > service.reg <<'EOF'\n"
31959 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
31960 " \"Type\"=dword:00000010\n"
31961 " \"Start\"=dword:00000002\n"
31962 " \"ErrorControl\"=dword:00000001\n"
31963 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
31964 " \"DisplayName\"=\"RHSrvAny\"\n"
31965 " \"ObjectName\"=\"NetworkService\"\n"
31970 #: ../tools/virt-win-reg.pl:527
31973 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
31974 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
31975 " \"PWD\"=\"c:\\\\Temp\"\n"
31981 #: ../tools/virt-win-reg.pl:538
31983 "For use of C<ControlSet001> see the section above in this manual page. You "
31984 "may need to adjust this according to the control set that is in use by the "
31989 #: ../tools/virt-win-reg.pl:544
31991 "C<\"ObjectName\"> controls the privileges that the service will have. An "
31992 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
31993 "privileged account."
31997 #: ../tools/virt-win-reg.pl:550
31999 "For the meaning of the magic numbers, see this Microsoft KB article: "
32000 "L<http://support.microsoft.com/kb/103000>."
32004 #: ../tools/virt-win-reg.pl:555
32005 msgid "Update the registry:"
32009 #: ../tools/virt-win-reg.pl:557
32012 " virt-win-reg --merge WindowsGuest service.reg\n"
32017 #: ../tools/virt-win-reg.pl:561
32019 "Be careful when passing parameters containing C<\\> (backslash) in the "
32020 "shell. Usually you will have to use 'single quotes' or double backslashes "
32021 "(but not both) to protect them from the shell."
32025 #: ../tools/virt-win-reg.pl:565
32026 msgid "Paths and value names are case-insensitive."
32030 #: ../tools/virt-win-reg.pl:574
32032 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
32033 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
32034 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
32038 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
32040 "When reporting bugs, please enable debugging and capture the I<complete> "
32045 #: ../tools/virt-win-reg.pl:592
32048 " export LIBGUESTFS_DEBUG=1\n"
32049 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
32054 #: ../tools/virt-win-reg.pl:595
32056 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
32061 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510
32062 #: ../tools/virt-make-fs.pl:570
32063 msgid "Copyright (C) 2010 Red Hat Inc."
32067 #: ../tools/virt-resize.pl:42
32068 msgid "virt-resize - Resize a virtual machine disk"
32072 #: ../tools/virt-resize.pl:46
32075 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
32076 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
32077 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
32082 #: ../tools/virt-resize.pl:52
32084 "Virt-resize is a tool which can resize a virtual machine disk, making it "
32085 "larger or smaller overall, and resizing or deleting any partitions contained "
32090 #: ../tools/virt-resize.pl:56
32092 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
32093 "not> be used on live virtual machines - for consistent results, shut the "
32094 "virtual machine down before resizing it."
32098 #: ../tools/virt-resize.pl:60
32100 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
32101 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
32105 #: ../tools/virt-resize.pl:66
32107 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
32108 "fill the extra 5GB of space."
32112 #: ../tools/virt-resize.pl:69
32115 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
32116 " virt-filesystems --long -h --all -a olddisk\n"
32117 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
32118 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
32123 #: ../tools/virt-resize.pl:74
32125 "As above, but make the /boot partition 200MB bigger, while giving the "
32126 "remaining space to /dev/sda2:"
32130 #: ../tools/virt-resize.pl:77
32133 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
32138 #: ../tools/virt-resize.pl:79
32139 msgid "As above, but the output format will be uncompressed qcow2:"
32143 #: ../tools/virt-resize.pl:81
32146 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
32147 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
32152 #: ../tools/virt-resize.pl:84
32153 msgid "DETAILED USAGE"
32157 #: ../tools/virt-resize.pl:86
32158 msgid "EXPANDING A VIRTUAL MACHINE DISK"
32162 #: ../tools/virt-resize.pl:90
32163 msgid "1. Shut down the virtual machine"
32167 #: ../tools/virt-resize.pl:92
32168 msgid "2. Locate input disk image"
32172 #: ../tools/virt-resize.pl:94
32174 "Locate the input disk image (ie. the file or device on the host containing "
32175 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
32176 "dumpxml> like this to find the disk image name:"
32180 #: ../tools/virt-resize.pl:98
32183 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
32184 " Found 1 nodes:\n"
32186 " <source dev=\"/dev/vg/lv_guest\" />\n"
32191 #: ../tools/virt-resize.pl:103
32192 msgid "3. Look at current sizing"
32196 #: ../tools/virt-resize.pl:105
32197 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
32201 #: ../tools/virt-resize.pl:108
32204 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
32205 " Name Type Size Parent\n"
32206 " /dev/sda1 partition 101M /dev/sda\n"
32207 " /dev/sda2 partition 7.9G /dev/sda\n"
32208 " /dev/sda device 8.0G -\n"
32213 #: ../tools/virt-resize.pl:114
32215 "(This example is a virtual machine with an 8 GB disk which we would like to "
32216 "expand up to 10 GB)."
32220 #: ../tools/virt-resize.pl:117
32221 msgid "4. Create output disk"
32225 #: ../tools/virt-resize.pl:119
32227 "Virt-resize cannot do in-place disk modifications. You have to have space "
32228 "to store the resized output disk."
32232 #: ../tools/virt-resize.pl:122
32234 "To store the resized disk image in a file, create a file of a suitable size:"
32238 #: ../tools/virt-resize.pl:125
32241 " # rm -f outdisk\n"
32242 " # truncate -s 10G outdisk\n"
32247 #: ../tools/virt-resize.pl:128
32248 msgid "Or use L<lvcreate(1)> to create a logical volume:"
32252 #: ../tools/virt-resize.pl:130
32255 " # lvcreate -L 10G -n lv_name vg_name\n"
32260 #: ../tools/virt-resize.pl:132
32261 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
32265 #: ../tools/virt-resize.pl:134
32268 " # virsh pool-list\n"
32269 " # virsh vol-create-as poolname newvol 10G\n"
32274 #: ../tools/virt-resize.pl:137
32279 #: ../tools/virt-resize.pl:139
32281 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
32282 "file) and the output disk. The output disk is the one created in the "
32287 #: ../tools/virt-resize.pl:143
32290 " # virt-resize indisk outdisk\n"
32295 #: ../tools/virt-resize.pl:145
32297 "This command just copies disk image C<indisk> to disk image C<outdisk> "
32298 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
32299 "larger, then an extra, empty partition is created at the end of the disk "
32300 "covering the extra space. If C<outdisk> is smaller, then it will give an "
32305 #: ../tools/virt-resize.pl:151
32307 "More realistically you'd want to expand existing partitions in the disk "
32308 "image by passing extra options (for the full list see the L</OPTIONS> "
32313 #: ../tools/virt-resize.pl:155
32315 "L</--expand> is the most useful option. It expands the named partition "
32316 "within the disk to fill any extra space:"
32320 #: ../tools/virt-resize.pl:158
32323 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
32328 #: ../tools/virt-resize.pl:160
32330 "(In this case, an extra partition is I<not> created at the end of the disk, "
32331 "because there will be no unused space)."
32335 #: ../tools/virt-resize.pl:163
32337 "L</--resize> is the other commonly used option. The following would "
32338 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
32339 "rest of the available space:"
32343 #: ../tools/virt-resize.pl:167
32346 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
32347 " indisk outdisk\n"
32352 #: ../tools/virt-resize.pl:170
32354 "If the expanded partition in the image contains a filesystem or LVM PV, then "
32355 "if virt-resize knows how, it will resize the contents, the equivalent of "
32356 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
32357 ">. However virt-resize does not know how to resize some filesystems, so you "
32358 "would have to online resize them after booting the guest."
32362 #: ../tools/virt-resize.pl:177
32363 msgid "Other options are covered below."
32367 #: ../tools/virt-resize.pl:179
32372 #: ../tools/virt-resize.pl:181
32373 msgid "Thoroughly test the new disk image I<before> discarding the old one."
32377 #: ../tools/virt-resize.pl:183
32378 msgid "If you are using libvirt, edit the XML to point at the new disk:"
32382 #: ../tools/virt-resize.pl:185
32385 " # virsh edit guestname\n"
32390 #: ../tools/virt-resize.pl:187
32392 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
32393 "html#elementsDisks>"
32397 #: ../tools/virt-resize.pl:190
32398 msgid "Then start up the domain with the new, resized disk:"
32402 #: ../tools/virt-resize.pl:192
32405 " # virsh start guestname\n"
32410 #: ../tools/virt-resize.pl:194
32412 "and check that it still works. See also the L</NOTES> section below for "
32413 "additional information."
32417 #: ../tools/virt-resize.pl:197
32418 msgid "7. Resize LVs etc inside the guest"
32422 #: ../tools/virt-resize.pl:199
32423 msgid "(This can also be done offline using L<guestfish(1)>)"
32427 #: ../tools/virt-resize.pl:201
32429 "Once the guest has booted you should see the new space available, at least "
32430 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
32431 "may need to resize LVs inside PVs, and also resize filesystem types that "
32432 "virt-resize does not know how to expand."
32436 #: ../tools/virt-resize.pl:208
32437 msgid "SHRINKING A VIRTUAL MACHINE DISK"
32441 #: ../tools/virt-resize.pl:210
32443 "Shrinking is somewhat more complex than expanding, and only an overview is "
32448 #: ../tools/virt-resize.pl:213
32450 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
32451 "filesystems). The user has to shrink content before passing the disk image "
32452 "to virt-resize, and virt-resize will check that the content has been shrunk "
32457 #: ../tools/virt-resize.pl:218
32458 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
32462 #: ../tools/virt-resize.pl:220
32464 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
32465 "steps 3 and 4 above to allocate a new disk image."
32469 #: ../tools/virt-resize.pl:223
32471 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
32475 #: ../tools/virt-resize.pl:226
32476 msgid "IGNORING OR DELETING PARTITIONS"
32480 #: ../tools/virt-resize.pl:228
32482 "virt-resize also gives a convenient way to ignore or delete partitions when "
32483 "copying from the input disk to the output disk. Ignoring a partition speeds "
32484 "up the copy where you don't care about the existing contents of a "
32485 "partition. Deleting a partition removes it completely, but note that it "
32486 "also renumbers any partitions after the one which is deleted, which can "
32487 "leave some guests unbootable."
32491 #: ../tools/virt-resize.pl:235
32492 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
32496 #: ../tools/virt-resize.pl:237
32498 "If the input disk is in qcow2 format, then you may prefer that the output is "
32499 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
32500 "the fly. The output format is simply determined by the format of the empty "
32501 "output container that you provide. Thus to create qcow2 output, use:"
32505 #: ../tools/virt-resize.pl:243
32508 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
32513 #: ../tools/virt-resize.pl:245
32514 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
32518 #: ../tools/virt-resize.pl:247
32519 msgid "Similarly, to get non-sparse raw output use:"
32523 #: ../tools/virt-resize.pl:249
32526 " fallocate -l size outdisk\n"
32531 #: ../tools/virt-resize.pl:251
32533 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
32534 "dev/zero of=outdisk bs=1M count=..>)"
32538 #: ../tools/virt-resize.pl:264
32539 msgid "Display help."
32543 #: ../tools/virt-resize.pl:278
32544 msgid "B<--resize part=size>"
32548 #: ../tools/virt-resize.pl:280
32550 "Resize the named partition (expanding or shrinking it) so that it has the "
32555 #: ../tools/virt-resize.pl:283
32557 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
32558 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
32559 "Exabytes; or as a percentage of the current size; or as a relative number or "
32560 "percentage. For example:"
32564 #: ../tools/virt-resize.pl:288
32567 " --resize /dev/sda2=10G\n"
32572 #: ../tools/virt-resize.pl:290
32575 " --resize /dev/sda4=90%\n"
32580 #: ../tools/virt-resize.pl:292
32583 " --resize /dev/sda2=+1G\n"
32588 #: ../tools/virt-resize.pl:294
32591 " --resize /dev/sda2=-200M\n"
32596 #: ../tools/virt-resize.pl:296
32599 " --resize /dev/sda1=+128K\n"
32604 #: ../tools/virt-resize.pl:298
32607 " --resize /dev/sda1=+10%\n"
32612 #: ../tools/virt-resize.pl:300
32615 " --resize /dev/sda1=-10%\n"
32620 #: ../tools/virt-resize.pl:302
32622 "You can increase the size of any partition. Virt-resize will expand the "
32623 "direct content of the partition if it knows how (see C<--expand> below)."
32627 #: ../tools/virt-resize.pl:306
32629 "You can only I<decrease> the size of partitions that contain filesystems or "
32630 "PVs which have already been shrunk. Virt-resize will check this has been "
32631 "done before proceeding, or else will print an error (see also C<--resize-"
32636 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
32637 #: ../tools/virt-resize.pl:420
32638 msgid "You can give this option multiple times."
32642 #: ../tools/virt-resize.pl:317
32643 msgid "B<--resize-force part=size>"
32647 #: ../tools/virt-resize.pl:319
32649 "This is the same as C<--resize> except that it will let you decrease the "
32650 "size of any partition. Generally this means you will lose any data which "
32651 "was at the end of the partition you shrink, but you may not care about that "
32652 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
32653 "as a swap partition)."
32657 #: ../tools/virt-resize.pl:325
32658 msgid "See also the C<--ignore> option."
32662 #: ../tools/virt-resize.pl:331
32663 msgid "B<--expand part>"
32667 #: ../tools/virt-resize.pl:333
32669 "Expand the named partition so it uses up all extra space (space left over "
32670 "after any other resize changes that you request have been done)."
32674 #: ../tools/virt-resize.pl:336
32676 "If virt-resize knows how, it will expand the direct content of the "
32677 "partition. For example, if the partition is an LVM PV, it will expand the "
32678 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
32679 "content it doesn't know about alone."
32683 #: ../tools/virt-resize.pl:341
32684 msgid "Currently virt-resize can resize:"
32688 #: ../tools/virt-resize.pl:347
32690 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
32695 #: ../tools/virt-resize.pl:352
32697 "NTFS filesystems contained directly in a partition, if libguestfs was "
32698 "compiled with support for NTFS."
32702 #: ../tools/virt-resize.pl:355
32704 "The filesystem must have been shut down consistently last time it was used. "
32705 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
32706 "consistency check, so at the first boot after resizing Windows will check "
32711 #: ../tools/virt-resize.pl:362
32713 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
32714 "inside the PV, but see the C<--LV-expand> option. The user could also "
32715 "resize LVs as desired after boot."
32719 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
32720 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
32724 #: ../tools/virt-resize.pl:374
32725 msgid "B<--shrink part>"
32729 #: ../tools/virt-resize.pl:376
32731 "Shrink the named partition until the overall disk image fits in the "
32732 "destination. The named partition B<must> contain a filesystem or PV which "
32733 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
32734 "online tools). Virt-resize will check this and give an error if it has not "
32739 #: ../tools/virt-resize.pl:382
32741 "The amount by which the overall disk must be shrunk (after carrying out all "
32742 "other operations requested by the user) is called the \"deficit\". For "
32743 "example, a straight copy (assume no other operations) from a 5GB disk image "
32744 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
32745 "would give an error unless the user specified a partition to shrink and that "
32746 "partition had more than a gigabyte of free space."
32750 #: ../tools/virt-resize.pl:396
32751 msgid "B<--ignore part>"
32755 #: ../tools/virt-resize.pl:398
32757 "Ignore the named partition. Effectively this means the partition is "
32758 "allocated on the destination disk, but the content is not copied across from "
32759 "the source disk. The content of the partition will be blank (all zero "
32764 #: ../tools/virt-resize.pl:409
32765 msgid "B<--delete part>"
32769 #: ../tools/virt-resize.pl:411
32771 "Delete the named partition. It would be more accurate to describe this as "
32772 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
32773 "the original disk image is left intact."
32777 #: ../tools/virt-resize.pl:415
32779 "Note that when you delete a partition, then anything contained in the "
32780 "partition is also deleted. Furthermore, this causes any partitions that "
32781 "come after to be I<renumbered>, which can easily make your guest unbootable."
32785 #: ../tools/virt-resize.pl:426
32786 msgid "B<--LV-expand logvol>"
32790 #: ../tools/virt-resize.pl:428
32792 "This takes the logical volume and, as a final step, expands it to fill all "
32793 "the space available in its volume group. A typical usage, assuming a Linux "
32794 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
32795 "lv_root> would be:"
32799 #: ../tools/virt-resize.pl:433
32802 " virt-resize indisk outdisk \\\n"
32803 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
32808 #: ../tools/virt-resize.pl:436
32810 "This would first expand the partition (and PV), and then expand the root "
32811 "device to fill the extra space in the PV."
32815 #: ../tools/virt-resize.pl:439
32817 "The contents of the LV are also resized if virt-resize knows how to do "
32818 "that. You can stop virt-resize from trying to expand the content by using "
32819 "the option C<--no-expand-content>."
32823 #: ../tools/virt-resize.pl:443
32824 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
32828 #: ../tools/virt-resize.pl:446
32830 "You can give this option multiple times, I<but> it doesn't make sense to do "
32831 "this unless the logical volumes you specify are all in different volume "
32836 #: ../tools/virt-resize.pl:454
32837 msgid "B<--no-copy-boot-loader>"
32841 #: ../tools/virt-resize.pl:456
32843 "By default, virt-resize copies over some sectors at the start of the disk "
32844 "(up to the beginning of the first partition). Commonly these sectors "
32845 "contain the Master Boot Record (MBR) and the boot loader, and are required "
32846 "in order for the guest to boot correctly."
32850 #: ../tools/virt-resize.pl:461
32852 "If you specify this flag, then this initial copy is not done. You may need "
32853 "to reinstall the boot loader in this case."
32857 #: ../tools/virt-resize.pl:469
32858 msgid "B<--no-extra-partition>"
32862 #: ../tools/virt-resize.pl:471
32864 "By default, virt-resize creates an extra partition if there is any extra, "
32865 "unused space after all resizing has happened. Use this option to prevent "
32866 "the extra partition from being created. If you do this then the extra space "
32867 "will be inaccessible until you run fdisk, parted, or some other partitioning "
32868 "tool in the guest."
32872 #: ../tools/virt-resize.pl:477
32874 "Note that if the surplus space is smaller than 10 MB, no extra partition "
32879 #: ../tools/virt-resize.pl:484
32880 msgid "B<--no-expand-content>"
32884 #: ../tools/virt-resize.pl:486
32886 "By default, virt-resize will try to expand the direct contents of "
32887 "partitions, if it knows how (see C<--expand> option above)."
32891 #: ../tools/virt-resize.pl:489
32893 "If you give the C<--no-expand-content> option then virt-resize will not "
32898 #: ../tools/virt-resize.pl:496
32899 msgid "B<-d> | B<--debug>"
32903 #: ../tools/virt-resize.pl:504
32904 msgid "B<-n> | B<--dryrun>"
32908 #: ../tools/virt-resize.pl:506
32909 msgid "Print a summary of what would be done, but don't do anything."
32913 #: ../tools/virt-resize.pl:512
32914 msgid "B<-q> | B<--quiet>"
32918 #: ../tools/virt-resize.pl:514
32919 msgid "Don't print the summary."
32923 #: ../tools/virt-resize.pl:522
32925 "Specify the format of the input disk image. If this flag is not given then "
32926 "it is auto-detected from the image itself."
32930 #: ../tools/virt-resize.pl:528
32932 "Note that this option I<does not> affect the output format. See L</QCOW2 "
32933 "AND NON-SPARSE RAW FORMATS>."
32937 #: ../tools/virt-resize.pl:535
32938 msgid "B<--output-format> raw"
32942 #: ../tools/virt-resize.pl:537
32944 "Specify the format of the output disk image. If this flag is not given then "
32945 "it is auto-detected from the image itself."
32949 #: ../tools/virt-resize.pl:543
32951 "Note that you still need to create the output disk with the right format. "
32952 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
32956 #: ../tools/virt-resize.pl:1419
32961 #: ../tools/virt-resize.pl:1421
32962 msgid "\"Partition 1 does not end on cylinder boundary.\""
32966 #: ../tools/virt-resize.pl:1423
32968 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
32969 "means the partitions will not be aligned to the ancient CHS geometry. "
32970 "However CHS geometry is meaningless for disks manufactured since the early "
32971 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
32972 "cylinders is not required by any modern operating system."
32976 #: ../tools/virt-resize.pl:1430
32977 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
32981 #: ../tools/virt-resize.pl:1432
32983 "In Windows Vista and later versions, Microsoft switched to using a separate "
32984 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
32985 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
32986 "the boot partition. Doing so seems to break the guest completely. However "
32987 "expanding the second partition (ie. C: drive) should work."
32991 #: ../tools/virt-resize.pl:1439
32993 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
32994 "NTFS partitions have been expanded. This is just a safety check and (unless "
32995 "it find errors) is nothing to worry about."
32999 #: ../tools/virt-resize.pl:1443
33000 msgid "GUEST BOOT STUCK AT \"GRUB\""
33004 #: ../tools/virt-resize.pl:1445
33006 "If a Linux guest does not boot after resizing, and the boot is stuck after "
33007 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
33008 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
33009 "although we think is to do with partition alignment."
33013 #: ../tools/virt-resize.pl:1450
33016 " guestfish -i -a newdisk\n"
33017 " ><fs> cat /boot/grub/device.map\n"
33018 " # check the contents of this file are sensible or\n"
33019 " # edit the file if necessary\n"
33020 " ><fs> grub-install / /dev/vda\n"
33026 #: ../tools/virt-resize.pl:1457
33028 "For more flexible guest reconfiguration, including if you need to specify "
33029 "other parameters to grub-install, use L<virt-rescue(1)>."
33033 #: ../tools/virt-resize.pl:1460
33034 msgid "ALTERNATIVE TOOLS"
33038 #: ../tools/virt-resize.pl:1462
33040 "There are several proprietary tools for resizing partitions. We won't "
33041 "mention any here."
33045 #: ../tools/virt-resize.pl:1465
33047 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
33048 "operations on disk images. They can resize and move partitions, but I don't "
33049 "think they can do anything with the contents, and they certainly don't "
33054 #: ../tools/virt-resize.pl:1470
33056 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
33057 "but at a much lower level. You will probably end up hand-calculating sector "
33058 "offsets, which is something that virt-resize was designed to avoid. If you "
33059 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
33064 #: ../tools/virt-resize.pl:1485
33066 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
33067 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
33068 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
33069 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
33070 "libguestfs.org/>."
33074 #: ../tools/virt-list-filesystems.pl:32
33076 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33080 #: ../tools/virt-list-filesystems.pl:36
33083 " virt-list-filesystems [--options] domname\n"
33088 #: ../tools/virt-list-filesystems.pl:38
33091 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33096 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33098 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33103 #: ../tools/virt-list-filesystems.pl:45
33105 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33106 "are contained in a virtual machine or disk image."
33110 #: ../tools/virt-list-filesystems.pl:49
33112 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33113 "functionality. For more complex cases you should look at the L<guestfish(1)"
33118 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33119 msgid "B<-l> | B<--long>"
33123 #: ../tools/virt-list-filesystems.pl:108
33125 "With this option, C<virt-list-filesystems> displays the type of each "
33126 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33130 #: ../tools/virt-list-filesystems.pl:115
33131 msgid "B<-a> | B<--all>"
33135 #: ../tools/virt-list-filesystems.pl:117
33137 "Normally we only show mountable filesystems. If this option is given then "
33138 "swap devices are shown too."
33142 #: ../tools/virt-list-filesystems.pl:191
33144 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33145 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33146 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33150 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
33151 msgid "Copyright (C) 2009 Red Hat Inc."
33155 #: ../tools/virt-tar.pl:33
33156 msgid "virt-tar - Extract or upload files to a virtual machine"
33160 #: ../tools/virt-tar.pl:37
33163 " virt-tar [--options] -x domname directory tarball\n"
33168 #: ../tools/virt-tar.pl:39
33171 " virt-tar [--options] -u domname tarball directory\n"
33176 #: ../tools/virt-tar.pl:41
33179 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33184 #: ../tools/virt-tar.pl:43
33187 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33192 #: ../tools/virt-tar.pl:47
33193 msgid "Download C</home> from the VM into a local tarball:"
33197 #: ../tools/virt-tar.pl:49
33200 " virt-tar -x domname /home home.tar\n"
33205 #: ../tools/virt-tar.pl:51
33208 " virt-tar -zx domname /home home.tar.gz\n"
33213 #: ../tools/virt-tar.pl:53
33214 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33218 #: ../tools/virt-tar.pl:55
33221 " virt-tar -u domname uploadstuff.tar /tmp\n"
33226 #: ../tools/virt-tar.pl:57
33229 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
33234 #: ../tools/virt-tar.pl:61
33236 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
33237 "virtual machines. If you do this, you risk disk corruption in the VM. "
33238 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
33242 #: ../tools/virt-tar.pl:66
33244 "You can use C<-x> (extract) on live virtual machines, but you might get "
33245 "inconsistent results or errors if there is filesystem activity inside the "
33246 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
33247 "work, but the only way to guarantee consistent results is if the virtual "
33248 "machine is shut down."
33252 #: ../tools/virt-tar.pl:74
33254 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
33255 "parts of a guest filesystem. There are many possibilities: making backups, "
33256 "uploading data files, snooping on guest activity, fixing or customizing "
33261 #: ../tools/virt-tar.pl:79
33263 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
33264 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
33265 "should look at the L<guestfish(1)> tool."
33269 #: ../tools/virt-tar.pl:83
33271 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
33272 "its contents (recursively) from the virtual machine into a local tarball. "
33273 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
33274 "virtual machine. You cannot use these two options together."
33278 #: ../tools/virt-tar.pl:89
33280 "In addition, you may need to use the C<-z> (gZip) option to enable "
33281 "compression. When uploading, you have to specify C<-z> if the upload file "
33282 "is compressed because virt-tar won't detect this on its own."
33286 #: ../tools/virt-tar.pl:93
33288 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
33289 "example it cannot do PKZip files or bzip2 compression. If you want that "
33290 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
33291 "the L<libguestfs(3)> API)."
33295 #: ../tools/virt-tar.pl:151
33296 msgid "B<-x> | B<--extract> | B<--download>"
33300 #: ../tools/virt-tar.pl:153
33301 msgid "B<-u> | B<--upload>"
33305 #: ../tools/virt-tar.pl:155
33307 "Use C<-x> to extract (download) a directory from a virtual machine to a "
33312 #: ../tools/virt-tar.pl:158
33314 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
33315 "Please read the L</WARNING> section above before using this option."
33319 #: ../tools/virt-tar.pl:162
33320 msgid "You must specify exactly one of these options."
33324 #: ../tools/virt-tar.pl:168
33325 msgid "B<-z> | B<--gzip>"
33329 #: ../tools/virt-tar.pl:170
33330 msgid "Specify that the input or output tarball is gzip-compressed."
33334 #: ../tools/virt-tar.pl:283
33336 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
33337 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
33342 #: ../tools/virt-make-fs.pl:37
33343 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
33347 #: ../tools/virt-make-fs.pl:41
33350 " virt-make-fs [--options] input.tar output.img\n"
33355 #: ../tools/virt-make-fs.pl:43
33358 " virt-make-fs [--options] input.tar.gz output.img\n"
33363 #: ../tools/virt-make-fs.pl:45
33366 " virt-make-fs [--options] directory output.img\n"
33371 #: ../tools/virt-make-fs.pl:49
33373 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
33374 "archive or some files in a directory. It is similar to tools like L<mkisofs"
33375 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
33376 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
33377 "you want to attach these filesystems to existing virtual machines (eg. to "
33378 "import large amounts of read-only data to a VM)."
33382 #: ../tools/virt-make-fs.pl:57
33383 msgid "Basic usage is:"
33387 #: ../tools/virt-make-fs.pl:59
33390 " virt-make-fs input output\n"
33395 #: ../tools/virt-make-fs.pl:61
33397 "where C<input> is either a directory containing files that you want to add, "
33398 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
33399 "C<output> is a disk image. The input type is detected automatically. The "
33400 "output disk image defaults to a raw ext2 image unless you specify extra "
33401 "flags (see L</OPTIONS> below)."
33405 #: ../tools/virt-make-fs.pl:67
33406 msgid "EXTRA SPACE"
33410 #: ../tools/virt-make-fs.pl:69
33412 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
33413 "the files that it contains, but might have extra space. Depending on how "
33414 "you are going to use the output, you might think this extra space is wasted "
33415 "and want to minimize it, or you might want to leave space so that more files "
33416 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
33417 "but you can use the C<--size> flag to leave space in the filesystem if you "
33422 #: ../tools/virt-make-fs.pl:77
33424 "An alternative way to leave extra space but not make the output image any "
33425 "bigger is to use an alternative disk image format (instead of the default "
33426 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
33427 "image format (check your hypervisor supports this before using it). This "
33428 "allows you to choose a large C<--size> but the extra space won't actually be "
33429 "allocated in the image until you try to store something in it."
33433 #: ../tools/virt-make-fs.pl:85
33435 "Don't forget that you can also use local commands including L<resize2fs(8)> "
33436 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
33437 "to build another image from scratch."
33441 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
33442 #: ../tools/virt-make-fs.pl:142
33447 #: ../tools/virt-make-fs.pl:91
33450 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
33455 #: ../tools/virt-make-fs.pl:93
33456 msgid "FILESYSTEM TYPE"
33460 #: ../tools/virt-make-fs.pl:95
33462 "The default filesystem type is C<ext2>. Just about any filesystem type that "
33463 "libguestfs supports can be used (but I<not> read-only formats like "
33464 "ISO9660). Here are some of the more common choices:"
33468 #: ../tools/virt-make-fs.pl:101
33473 #: ../tools/virt-make-fs.pl:103
33475 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
33476 "you are not going to use the filesystem in a way that requires the journal, "
33477 "then this is just wasted overhead."
33481 #: ../tools/virt-make-fs.pl:107
33482 msgid "I<ntfs> or I<vfat>"
33486 #: ../tools/virt-make-fs.pl:109
33487 msgid "Useful if exporting data to a Windows guest."
33491 #: ../tools/virt-make-fs.pl:111
33493 "I<Note for vfat>: The tar archive or local directory must only contain files "
33494 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
33495 "program running within libguestfs is unable to change the ownership of non-"
33496 "root files, since vfat itself does not support this."
33500 #: ../tools/virt-make-fs.pl:116
33505 #: ../tools/virt-make-fs.pl:118
33507 "Lower overhead than C<ext2>, but certain limitations on filename length and "
33508 "total filesystem size."
33512 #: ../tools/virt-make-fs.pl:125
33515 " virt-make-fs --type=minix input minixfs.img\n"
33520 #: ../tools/virt-make-fs.pl:127
33521 msgid "TO PARTITION OR NOT TO PARTITION"
33525 #: ../tools/virt-make-fs.pl:129
33526 msgid "Optionally virt-make-fs can add a partition table to the output disk."
33530 #: ../tools/virt-make-fs.pl:131
33532 "Adding a partition can make the disk image more compatible with certain "
33533 "virtualized operating systems which don't expect to see a filesystem "
33534 "directly located on a block device (Linux doesn't care and will happily "
33535 "handle both types)."
33539 #: ../tools/virt-make-fs.pl:136
33541 "On the other hand, if you have a partition table then the output image is no "
33542 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
33543 "directly on a partitioned disk image. (However libguestfs tools such as "
33544 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
33548 #: ../tools/virt-make-fs.pl:144
33549 msgid "Add an MBR partition:"
33553 #: ../tools/virt-make-fs.pl:146
33556 " virt-make-fs --partition -- input disk.img\n"
33561 #: ../tools/virt-make-fs.pl:148
33563 "If the output disk image could be terabyte-sized or larger, it's better to "
33564 "use an EFI/GPT-compatible partition table:"
33568 #: ../tools/virt-make-fs.pl:151
33571 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
33576 #: ../tools/virt-make-fs.pl:179
33577 msgid "Enable debugging information."
33581 #: ../tools/virt-make-fs.pl:185
33582 msgid "B<--size=E<lt>NE<gt>>"
33586 #: ../tools/virt-make-fs.pl:187
33587 msgid "B<--size=+E<lt>NE<gt>>"
33591 #: ../tools/virt-make-fs.pl:189
33592 msgid "B<-s E<lt>NE<gt>>"
33596 #: ../tools/virt-make-fs.pl:191
33597 msgid "B<-s +E<lt>NE<gt>>"
33601 #: ../tools/virt-make-fs.pl:193
33603 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
33607 #: ../tools/virt-make-fs.pl:196
33609 "If this option is I<not> given, then the output image will be just large "
33610 "enough to contain all the files, with not much wasted space."
33614 #: ../tools/virt-make-fs.pl:199
33616 "To choose a fixed size output disk, specify an absolute number followed by b/"
33617 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33618 "Petabytes or Exabytes. This must be large enough to contain all the input "
33619 "files, else you will get an error."
33623 #: ../tools/virt-make-fs.pl:204
33625 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
33626 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33627 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
33628 "the input files, and (approximately) an extra 200 MB free space."
33632 #: ../tools/virt-make-fs.pl:210
33634 "Note that virt-make-fs estimates free space, and therefore will not produce "
33635 "filesystems containing precisely the free space requested. (It is much more "
33636 "expensive and time-consuming to produce a filesystem which has precisely the "
33637 "desired free space)."
33641 #: ../tools/virt-make-fs.pl:219
33642 msgid "B<--format=E<lt>fmtE<gt>>"
33646 #: ../tools/virt-make-fs.pl:221
33647 msgid "B<-F E<lt>fmtE<gt>>"
33651 #: ../tools/virt-make-fs.pl:223
33652 msgid "Choose the output disk image format."
33656 #: ../tools/virt-make-fs.pl:225
33657 msgid "The default is C<raw> (raw disk image)."
33661 #: ../tools/virt-make-fs.pl:227
33663 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
33664 "that would really make sense here is C<qcow2>."
33668 #: ../tools/virt-make-fs.pl:234
33669 msgid "B<--type=E<lt>fsE<gt>>"
33673 #: ../tools/virt-make-fs.pl:236
33674 msgid "B<-t E<lt>fsE<gt>>"
33678 #: ../tools/virt-make-fs.pl:238
33679 msgid "Choose the output filesystem type."
33683 #: ../tools/virt-make-fs.pl:240
33684 msgid "The default is C<ext2>."
33688 #: ../tools/virt-make-fs.pl:242
33690 "Any filesystem which is supported read-write by libguestfs can be used here."
33694 #: ../tools/virt-make-fs.pl:249
33695 msgid "B<--partition>"
33699 #: ../tools/virt-make-fs.pl:251
33700 msgid "B<--partition=E<lt>parttypeE<gt>>"
33704 #: ../tools/virt-make-fs.pl:253
33706 "If specified, this flag adds an MBR partition table to the output disk image."
33710 #: ../tools/virt-make-fs.pl:256
33712 "You can change the partition table type, eg. C<--partition=gpt> for large "
33717 #: ../tools/virt-make-fs.pl:259
33719 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
33720 "might consider the next parameter to be the partition type. For example:"
33724 #: ../tools/virt-make-fs.pl:263
33727 " virt-make-fs --partition input.tar ...\n"
33732 #: ../tools/virt-make-fs.pl:265
33734 "would cause virt-make-fs to think you wanted to use a partition type of "
33735 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
33736 "dash) between options and the input file argument:"
33740 #: ../tools/virt-make-fs.pl:269
33743 " virt-make-fs --partition -- input.tar ...\n"
33748 #: ../tools/virt-make-fs.pl:541
33750 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
33751 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
33752 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
33756 #: ../tools/virt-make-fs.pl:558
33759 " export LIBGUESTFS_DEBUG=1\n"
33760 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
33765 #: ../tools/virt-make-fs.pl:561
33767 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
33772 #: ../tools/virt-list-partitions.pl:32
33774 "virt-list-partitions - List partitions in a virtual machine or disk image"
33778 #: ../tools/virt-list-partitions.pl:36
33781 " virt-list-partitions [--options] domname\n"
33786 #: ../tools/virt-list-partitions.pl:38
33789 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
33794 #: ../tools/virt-list-partitions.pl:45
33796 "C<virt-list-partitions> is a command line tool to list the partitions that "
33797 "are contained in a virtual machine or disk image. It is mainly useful as a "
33798 "first step to using L<virt-resize(1)>."
33802 #: ../tools/virt-list-partitions.pl:50
33804 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
33805 "functionality. For more complex cases you should look at the L<guestfish(1)"
33810 #: ../tools/virt-list-partitions.pl:107
33811 msgid "B<-h> | B<--human-readable>"
33815 #: ../tools/virt-list-partitions.pl:109
33816 msgid "Show sizes in human-readable form (eg. \"1G\")."
33820 #: ../tools/virt-list-partitions.pl:117
33822 "With this option, C<virt-list-partitions> displays the type and size of each "
33823 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
33827 #: ../tools/virt-list-partitions.pl:124
33828 msgid "B<-t> | B<--total>"
33832 #: ../tools/virt-list-partitions.pl:126
33834 "Display the total size of each block device (as a separate row or rows)."
33838 #: ../tools/virt-list-partitions.pl:259
33840 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
33841 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
33842 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."