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-07-16 10:13+0200\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
22 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
23 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
24 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../tools/virt-list-partitions.pl:30
32 #: ../src/guestfs.pod:5
33 msgid "guestfs - Library for accessing and modifying virtual machine images"
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
41 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
42 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
43 #: ../tools/virt-list-partitions.pl:34
49 #: ../src/guestfs.pod:9
52 " #include <guestfs.h>\n"
58 #: ../src/guestfs.pod:11
61 " guestfs_h *g = guestfs_create ();\n"
62 " guestfs_add_drive (g, \"guest.img\");\n"
63 " guestfs_launch (g);\n"
64 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
65 " guestfs_touch (g, \"/hello\");\n"
66 " guestfs_umount (g, \"/\");\n"
67 " guestfs_close (g);\n"
73 #: ../src/guestfs.pod:19
76 " cc prog.c -o prog -lguestfs\n"
78 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
84 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
85 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
86 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
87 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
88 #: ../tools/virt-tar.pl: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:2064 ../src/guestfs.pod:2070 ../src/guestfs.pod:2075
928 #: ../src/guestfs.pod:2081 ../src/guestfs.pod:2540 ../src/guestfs.pod:2544
929 #: ../src/guestfs.pod:2548 ../src/guestfs.pod:2552
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:1584 ../src/guestfs-actions.pod:1588
934 #: ../src/guestfs-actions.pod:1592 ../src/guestfs-actions.pod:1596
935 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
936 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1622
937 #: ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630
938 #: ../src/guestfs-actions.pod:1768 ../src/guestfs-actions.pod:1772
939 #: ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782
940 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:1847
941 #: ../src/guestfs-actions.pod:1852 ../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:1062
947 #: ../fish/guestfish-actions.pod:1066 ../fish/guestfish-actions.pod:1070
948 #: ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1082
949 #: ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1090
950 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1104
951 #: ../fish/guestfish-actions.pod:1108 ../fish/guestfish-actions.pod:1198
952 #: ../fish/guestfish-actions.pod:1202 ../fish/guestfish-actions.pod:1207
953 #: ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1254
954 #: ../fish/guestfish-actions.pod:1258 ../fish/guestfish-actions.pod:1263
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:2109
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:2134
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:1839 ../fish/guestfish-actions.pod:9
3558 #: ../fish/guestfish-actions.pod:1250 ../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>"
3830 #: ../src/guestfs.pod:1713
3832 "If any progress notification is sent during a call, then a final progress "
3833 "notification is always sent when C<position> = C<total> (I<unless> the call "
3834 "fails with an error)."
3839 #: ../src/guestfs.pod:1717
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:1723
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:1728
3859 msgid "PRIVATE DATA AREA"
3864 #: ../src/guestfs.pod:1730
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:1734
3874 msgid "To attach a named piece of data, use the following call:"
3879 #: ../src/guestfs.pod:1736
3882 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3888 #: ../src/guestfs.pod:1738
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:1742
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:1747
3908 msgid "To retrieve the pointer, use:"
3913 #: ../src/guestfs.pod:1749
3916 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3922 #: ../src/guestfs.pod:1751
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:1755
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:1763
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:1766 ../src/guestfs.pod:1771
3958 #: ../src/guestfs.pod:1768
3960 "<!-- old anchor for the next section --> <a name="
3961 "\"state_machine_and_low_level_event_api\"/>"
3966 #: ../src/guestfs.pod:1773
3967 msgid "ARCHITECTURE"
3972 #: ../src/guestfs.pod:1775
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:1779
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:1799
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:1802
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:1811
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:1818
4042 msgid "STATE MACHINE"
4047 #: ../src/guestfs.pod:1820
4048 msgid "libguestfs uses a state machine to model the child process:"
4053 #: ../src/guestfs.pod:1822
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:1844
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:1849
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:1853
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:1856
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:1862
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:1868
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:1872
4145 #: ../src/guestfs.pod:1874
4146 msgid "COMMUNICATION PROTOCOL"
4151 #: ../src/guestfs.pod:1876
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:1879
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:1883
4170 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4171 "this file is automatically generated)."
4176 #: ../src/guestfs.pod:1886
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:1893
4188 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4193 #: ../src/guestfs.pod:1895
4194 msgid "For ordinary functions, the request message is:"
4199 #: ../src/guestfs.pod:1897
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:1902
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:1908
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:1911
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:1915
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:1923
4251 msgid "The reply message for ordinary functions is:"
4256 #: ../src/guestfs.pod:1925
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:1930
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:1933
4278 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4283 #: ../src/guestfs.pod:1936
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:1939
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:1944
4305 "The C<guestfs_message_error> structure contains the error message as a "
4311 #: ../src/guestfs.pod:1947
4312 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4317 #: ../src/guestfs.pod:1949
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:1953
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:1961
4342 msgid "The \"sequence of chunks\" is:"
4347 #: ../src/guestfs.pod:1963
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:1971
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:1975
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:1980
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:1986
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:1995
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:2001
4416 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4421 #: ../src/guestfs.pod:2003
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:2006
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:2014
4445 msgid "INITIAL MESSAGE"
4450 #: ../src/guestfs.pod:2016
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:2020
4460 msgid "PROGRESS NOTIFICATION MESSAGES"
4465 #: ../src/guestfs.pod:2022
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:2026
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:2030
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:2034
4493 msgid "LIBGUESTFS VERSION NUMBERS"
4498 #: ../src/guestfs.pod:2036
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:2041
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:2052
4526 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4531 #: ../src/guestfs.pod:2054
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:2060
4543 msgid "Our criteria for backporting changes are:"
4548 #: ../src/guestfs.pod:2066
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:2072
4558 "Bug fixes which are not controversial, fix obvious problems, and have been "
4559 "well tested are backported."
4564 #: ../src/guestfs.pod:2077
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:2083
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:2089
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:2097
4594 msgid "EXTENDING LIBGUESTFS"
4598 #: ../src/guestfs.pod:2099
4599 msgid "ADDING A NEW API ACTION"
4603 #: ../src/guestfs.pod:2101
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:2105
4612 msgid "To add a new API action there are two changes:"
4616 #: ../src/guestfs.pod:2111
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:2114
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:2122
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:2128
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:2136
4655 msgid "Implement the action (in C):"
4659 #: ../src/guestfs.pod:2138
4661 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4662 "C<daemon/> directory."
4666 #: ../src/guestfs.pod:2141
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:2144
4674 msgid "In either case, use another function as an example of what to do."
4678 #: ../src/guestfs.pod:2148
4679 msgid "After making these changes, use C<make> to compile."
4683 #: ../src/guestfs.pod:2150
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:2154
4692 msgid "ADDING TESTS FOR AN API ACTION"
4696 #: ../src/guestfs.pod:2156
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:2162
4708 "The following describes the test environment used when you add an API test "
4709 "in C<generator_actions.ml>."
4713 #: ../src/guestfs.pod:2165
4714 msgid "The test environment has 4 block devices:"
4718 #: ../src/guestfs.pod:2169
4719 msgid "C</dev/sda> 500MB"
4723 #: ../src/guestfs.pod:2171
4724 msgid "General block device for testing."
4728 #: ../src/guestfs.pod:2173
4729 msgid "C</dev/sdb> 50MB"
4733 #: ../src/guestfs.pod:2175
4735 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4740 #: ../src/guestfs.pod:2178
4741 msgid "C</dev/sdc> 10MB"
4745 #: ../src/guestfs.pod:2180
4746 msgid "Used in a few tests where two block devices are needed."
4750 #: ../src/guestfs.pod:2182
4755 #: ../src/guestfs.pod:2184
4756 msgid "ISO with fixed content (see C<images/test.iso>)."
4760 #: ../src/guestfs.pod:2188
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:2192
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:2198
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:2204
4790 "In addition, packagers can skip individual tests by setting environment "
4791 "variables before running C<make check>."
4795 #: ../src/guestfs.pod:2207
4798 " SKIP_TEST_<CMD>_<NUM>=1\n"
4803 #: ../src/guestfs.pod:2209
4804 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4808 #: ../src/guestfs.pod:2211
4813 #: ../src/guestfs.pod:2213
4816 " SKIP_TEST_<CMD>=1\n"
4821 #: ../src/guestfs.pod:2215
4822 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4826 #: ../src/guestfs.pod:2217
4827 msgid "Packagers can run only certain tests by setting for example:"
4831 #: ../src/guestfs.pod:2219
4834 " TEST_ONLY=\"vfs_type zerofree\"\n"
4839 #: ../src/guestfs.pod:2221
4841 "See C<capitests/tests.c> for more details of how these environment variables "
4846 #: ../src/guestfs.pod:2224
4847 msgid "DEBUGGING NEW API ACTIONS"
4851 #: ../src/guestfs.pod:2226
4852 msgid "Test new actions work before submitting them."
4856 #: ../src/guestfs.pod:2228
4857 msgid "You can use guestfish to try out new commands."
4861 #: ../src/guestfs.pod:2230
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:2234
4870 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4874 #: ../src/guestfs.pod:2236
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:2242
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:2245
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:2255
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:2267
4926 msgid "Enable warnings when compiling (and fix any problems this finds):"
4930 #: ../src/guestfs.pod:2270
4933 " ./configure --enable-gcc-warnings\n"
4938 #: ../src/guestfs.pod:2272
4939 msgid "Useful targets are:"
4943 #: ../src/guestfs.pod:2274
4946 " make syntax-check # checks the syntax of the C code\n"
4947 " make check # runs the test suite\n"
4952 #: ../src/guestfs.pod:2277
4953 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4957 #: ../src/guestfs.pod:2279
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:2284
4969 #: ../src/guestfs.pod:2286
4971 "Simple shell quoted string. Any spaces or other shell characters are "
4976 #: ../src/guestfs.pod:2289
4981 #: ../src/guestfs.pod:2291
4983 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4989 #: ../src/guestfs.pod:2296 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4990 msgid "For example:"
4994 #: ../src/guestfs.pod:2298
4997 " asprintf (&cmd, \"cat %R\", path);\n"
5002 #: ../src/guestfs.pod:2300
5003 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5007 #: ../src/guestfs.pod:2302
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:2308
5017 msgid "SUBMITTING YOUR NEW API ACTIONS"
5021 #: ../src/guestfs.pod:2310
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:2314
5029 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5033 #: ../src/guestfs.pod:2316
5034 msgid "We support i18n (gettext anyhow) in the library."
5038 #: ../src/guestfs.pod:2318
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:2324
5049 "Debugging messages are never translated, since they are intended for the "
5054 #: ../src/guestfs.pod:2327
5055 msgid "SOURCE CODE SUBDIRECTORIES"
5059 #: ../src/guestfs.pod:2331
5060 msgid "C<appliance>"
5064 #: ../src/guestfs.pod:2333
5065 msgid "The libguestfs appliance, build scripts and so on."
5069 #: ../src/guestfs.pod:2335
5070 msgid "C<capitests>"
5074 #: ../src/guestfs.pod:2337
5075 msgid "Automated tests of the C API."
5079 #: ../src/guestfs.pod:2339
5084 #: ../src/guestfs.pod:2341
5086 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5091 #: ../src/guestfs.pod:2344
5096 #: ../src/guestfs.pod:2346
5098 "Safety and liveness tests of components that libguestfs depends upon (not of "
5099 "libguestfs itself). Mainly this is for qemu and the kernel."
5103 #: ../src/guestfs.pod:2349
5108 #: ../src/guestfs.pod:2351
5109 msgid "Outside contributions, experimental parts."
5113 #: ../src/guestfs.pod:2353
5118 #: ../src/guestfs.pod:2355
5120 "The daemon that runs inside the libguestfs appliance and carries out actions."
5124 #: ../src/guestfs.pod:2358
5129 #: ../src/guestfs.pod:2360
5130 msgid "L<virt-df(1)> command and documentation."
5134 #: ../src/guestfs.pod:2362
5139 #: ../src/guestfs.pod:2364
5140 msgid "C API example code."
5144 #: ../src/guestfs.pod:2366
5149 #: ../src/guestfs.pod:2368
5150 msgid "L<guestfish(1)>, the command-line shell."
5154 #: ../src/guestfs.pod:2370
5159 #: ../src/guestfs.pod:2372
5161 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5165 #: ../src/guestfs.pod:2374
5166 msgid "C<generator>"
5170 #: ../src/guestfs.pod:2376
5172 "The crucially important generator, used to automatically generate large "
5173 "amounts of boilerplate C code for things like RPC and bindings."
5177 #: ../src/guestfs.pod:2379
5182 #: ../src/guestfs.pod:2381
5183 msgid "Files used by the test suite."
5187 #: ../src/guestfs.pod:2383
5188 msgid "Some \"phony\" guest images which we test against."
5192 #: ../src/guestfs.pod:2385
5193 msgid "C<inspector>"
5197 #: ../src/guestfs.pod:2387
5198 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5202 #: ../src/guestfs.pod:2389
5207 #: ../src/guestfs.pod:2391
5208 msgid "M4 macros used by autoconf."
5212 #: ../src/guestfs.pod:2393
5217 #: ../src/guestfs.pod:2395
5218 msgid "Translations of simple gettext strings."
5222 #: ../src/guestfs.pod:2397
5227 #: ../src/guestfs.pod:2399
5229 "The build infrastructure and PO files for translations of manpages and POD "
5230 "files. Eventually this will be combined with the C<po> directory, but that "
5231 "is rather complicated."
5235 #: ../src/guestfs.pod:2403
5236 msgid "C<regressions>"
5240 #: ../src/guestfs.pod:2405
5241 msgid "Regression tests."
5245 #: ../src/guestfs.pod:2407
5250 #: ../src/guestfs.pod:2409
5251 msgid "L<virt-rescue(1)> command and documentation."
5255 #: ../src/guestfs.pod:2411
5260 #: ../src/guestfs.pod:2413
5261 msgid "Source code to the C library."
5265 #: ../src/guestfs.pod:2415
5270 #: ../src/guestfs.pod:2417
5271 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5275 #: ../src/guestfs.pod:2419
5276 msgid "C<test-tool>"
5280 #: ../src/guestfs.pod:2421
5282 "Test tool for end users to test if their qemu/kernel combination will work "
5287 #: ../src/guestfs.pod:2424
5292 #: ../src/guestfs.pod:2426
5297 #: ../src/guestfs.pod:2428
5302 #: ../src/guestfs.pod:2430
5307 #: ../src/guestfs.pod:2432
5312 #: ../src/guestfs.pod:2434
5317 #: ../src/guestfs.pod:2436
5322 #: ../src/guestfs.pod:2438
5327 #: ../src/guestfs.pod:2440
5328 msgid "Language bindings."
5333 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:965
5334 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:375
5335 msgid "ENVIRONMENT VARIABLES"
5340 #: ../src/guestfs.pod:2448 ../fish/guestfish.pod:991
5341 msgid "LIBGUESTFS_APPEND"
5346 #: ../src/guestfs.pod:2450 ../fish/guestfish.pod:993
5347 msgid "Pass additional options to the guest kernel."
5352 #: ../src/guestfs.pod:2452 ../fish/guestfish.pod:995
5353 msgid "LIBGUESTFS_DEBUG"
5358 #: ../src/guestfs.pod:2454
5360 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5361 "effect as calling C<guestfs_set_verbose (g, 1)>."
5366 #: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1000
5367 msgid "LIBGUESTFS_MEMSIZE"
5372 #: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1002
5374 "Set the memory allocated to the qemu process, in megabytes. For example:"
5379 #: ../src/guestfs.pod:2462 ../fish/guestfish.pod:1005
5382 " LIBGUESTFS_MEMSIZE=700\n"
5388 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1007
5389 msgid "LIBGUESTFS_PATH"
5393 #: ../src/guestfs.pod:2466
5395 "Set the path that libguestfs uses to search for a supermin appliance. See "
5396 "the discussion of paths in section L</PATH> above."
5401 #: ../src/guestfs.pod:2469 ../fish/guestfish.pod:1012
5402 msgid "LIBGUESTFS_QEMU"
5407 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1014
5409 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5410 "which was found at compile time by the configure script is used."
5415 #: ../src/guestfs.pod:2475
5416 msgid "See also L</QEMU WRAPPERS> above."
5421 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1018
5422 msgid "LIBGUESTFS_TRACE"
5427 #: ../src/guestfs.pod:2479
5429 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5430 "effect as calling C<guestfs_set_trace (g, 1)>."
5435 #: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1027
5441 #: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1029
5442 msgid "Location of temporary directory, defaults to C</tmp>."
5447 #: ../src/guestfs.pod:2486 ../fish/guestfish.pod:1031
5449 "If libguestfs was compiled to use the supermin appliance then the real "
5450 "appliance is cached in this directory, shared between all handles belonging "
5451 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5452 "use in case C</tmp> is not large enough."
5457 #: ../src/guestfs.pod:2494 ../fish/guestfish.pod:1089
5458 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
5459 #: ../tools/virt-edit.pl:395 ../tools/virt-win-reg.pl:572
5460 #: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189
5461 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:539
5462 #: ../tools/virt-list-partitions.pl:257
5468 #: ../src/guestfs.pod:2496
5470 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5471 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
5472 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
5473 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
5474 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
5475 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5480 #: ../src/guestfs.pod:2519
5482 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5483 "(8)>, L<disktype(1)>."
5488 #: ../src/guestfs.pod:2526 ../tools/virt-win-reg.pl:587
5489 #: ../tools/virt-make-fs.pl:553
5495 #: ../src/guestfs.pod:2528
5496 msgid "To get a list of bugs against libguestfs use this link:"
5501 #: ../src/guestfs.pod:2530
5503 "L<https://bugzilla.redhat.com/buglist.cgi?"
5504 "component=libguestfs&product=Virtualization+Tools>"
5509 #: ../src/guestfs.pod:2532
5510 msgid "To report a new bug against libguestfs use this link:"
5515 #: ../src/guestfs.pod:2534
5517 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5518 "component=libguestfs&product=Virtualization+Tools>"
5523 #: ../src/guestfs.pod:2536
5524 msgid "When reporting a bug, please check:"
5529 #: ../src/guestfs.pod:2542
5530 msgid "That the bug hasn't been reported already."
5535 #: ../src/guestfs.pod:2546
5536 msgid "That you are testing a recent version."
5541 #: ../src/guestfs.pod:2550
5542 msgid "Describe the bug accurately, and give a way to reproduce it."
5547 #: ../src/guestfs.pod:2554
5549 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5555 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1108
5556 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
5562 #: ../src/guestfs.pod:2561 ../fish/guestfish.pod:1110
5563 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
5564 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5569 #: ../src/guestfs.pod:2563 ../fish/guestfish.pod:1112
5570 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
5571 #: ../tools/virt-edit.pl:411 ../tools/virt-win-reg.pl:602
5572 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206
5573 #: ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:568
5574 #: ../tools/virt-list-partitions.pl:273
5580 #: ../src/guestfs.pod:2565 ../fish/guestfish.pod:1114
5581 #: ../fuse/guestmount.pod:250
5582 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
5587 #: ../src/guestfs.pod:2568
5589 "This library is free software; you can redistribute it and/or modify it "
5590 "under the terms of the GNU Lesser General Public License as published by the "
5591 "Free Software Foundation; either version 2 of the License, or (at your "
5592 "option) any later version."
5597 #: ../src/guestfs.pod:2573
5599 "This library is distributed in the hope that it will be useful, but WITHOUT "
5600 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5601 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5607 #: ../src/guestfs.pod:2578
5609 "You should have received a copy of the GNU Lesser General Public License "
5610 "along with this library; if not, write to the Free Software Foundation, "
5611 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5616 #: ../src/guestfs-actions.pod:1
5617 msgid "guestfs_add_cdrom"
5622 #: ../src/guestfs-actions.pod:3
5626 " guestfs_add_cdrom (guestfs_h *g,\n"
5627 " const char *filename);\n"
5633 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5634 msgid "This function adds a virtual CD-ROM disk image to the guest."
5639 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5640 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5645 #: ../src/guestfs-actions.pod:17
5647 "This call checks for the existence of C<filename>. This stops you from "
5648 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5649 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5655 #: ../src/guestfs-actions.pod:24
5657 "If you just want to add an ISO file (often you use this as an efficient way "
5658 "to transfer large files into the guest), then you should probably use "
5659 "C<guestfs_add_drive_ro> instead."
5664 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
5665 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
5666 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
5667 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
5668 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
5669 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
5670 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
5671 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
5672 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
5673 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
5674 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
5675 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
5676 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
5677 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
5678 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
5679 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
5680 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
5681 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
5682 #: ../src/guestfs-actions.pod:1679 ../src/guestfs-actions.pod:1701
5683 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:2240
5684 #: ../src/guestfs-actions.pod:2384 ../src/guestfs-actions.pod:2445
5685 #: ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:3223
5686 #: ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3258
5687 #: ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3427
5688 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3454
5689 #: ../src/guestfs-actions.pod:3469 ../src/guestfs-actions.pod:3505
5690 #: ../src/guestfs-actions.pod:3577 ../src/guestfs-actions.pod:3597
5691 #: ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3637
5692 #: ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3692
5693 #: ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3730
5694 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3777
5695 #: ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:3829
5696 #: ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3857
5697 #: ../src/guestfs-actions.pod:3874 ../src/guestfs-actions.pod:3967
5698 #: ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:4000
5699 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4069
5700 #: ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4103
5701 #: ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4131
5702 #: ../src/guestfs-actions.pod:4148 ../src/guestfs-actions.pod:4163
5703 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4229
5704 #: ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4333
5705 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4371
5706 #: ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4400
5707 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4428
5708 #: ../src/guestfs-actions.pod:4443 ../src/guestfs-actions.pod:4478
5709 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4513
5710 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4544
5711 #: ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4639
5712 #: ../src/guestfs-actions.pod:4653 ../src/guestfs-actions.pod:4681
5713 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4716
5714 #: ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4907
5715 #: ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:4947
5716 #: ../src/guestfs-actions.pod:4979 ../src/guestfs-actions.pod:5045
5717 #: ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5075
5718 #: ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:5378
5719 #: ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5411
5720 #: ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5437
5721 #: ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5463
5722 #: ../src/guestfs-actions.pod:5479 ../src/guestfs-actions.pod:5500
5723 #: ../src/guestfs-actions.pod:5519 ../src/guestfs-actions.pod:5538
5724 #: ../src/guestfs-actions.pod:5556 ../src/guestfs-actions.pod:5579
5725 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5616
5726 #: ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5656
5727 #: ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:5701
5728 #: ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:5744
5729 #: ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:5783
5730 #: ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5817
5731 #: ../src/guestfs-actions.pod:5854 ../src/guestfs-actions.pod:5877
5732 #: ../src/guestfs-actions.pod:5903 ../src/guestfs-actions.pod:6011
5733 #: ../src/guestfs-actions.pod:6132 ../src/guestfs-actions.pod:6144
5734 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6170
5735 #: ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6205
5736 #: ../src/guestfs-actions.pod:6218 ../src/guestfs-actions.pod:6231
5737 #: ../src/guestfs-actions.pod:6246 ../src/guestfs-actions.pod:6305
5738 #: ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6338
5739 #: ../src/guestfs-actions.pod:6354 ../src/guestfs-actions.pod:6371
5740 #: ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6404
5741 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-actions.pod:6454
5742 #: ../src/guestfs-actions.pod:6495 ../src/guestfs-actions.pod:6508
5743 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6560
5744 #: ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:6715
5745 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6747
5746 #: ../src/guestfs-actions.pod:6802 ../src/guestfs-actions.pod:6815
5747 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6893
5748 #: ../src/guestfs-actions.pod:6947 ../src/guestfs-actions.pod:6973
5749 #: ../src/guestfs-actions.pod:7039 ../src/guestfs-actions.pod:7058
5750 #: ../src/guestfs-actions.pod:7087
5751 msgid "This function returns 0 on success or -1 on error."
5756 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
5757 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
5758 #: ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
5760 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5766 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
5767 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
5768 #: ../src/guestfs-actions.pod:1918 ../src/guestfs-actions.pod:1939
5769 #: ../src/guestfs-actions.pod:4188 ../src/guestfs-actions.pod:6981
5770 #: ../src/guestfs-actions.pod:7150 ../fish/guestfish-actions.pod:31
5771 #: ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168
5772 #: ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1303
5773 #: ../fish/guestfish-actions.pod:1317 ../fish/guestfish-actions.pod:2817
5774 #: ../fish/guestfish-actions.pod:4630 ../fish/guestfish-actions.pod:4727
5776 "Deprecated functions will not be removed from the API, but the fact that "
5777 "they are deprecated indicates that there are problems with correct use of "
5783 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
5784 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1890
5785 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2091
5786 #: ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:3240
5787 #: ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:5558
5788 #: ../src/guestfs-actions.pod:5675 ../src/guestfs-actions.pod:5785
5789 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6373
5790 #: ../src/guestfs-actions.pod:6895
5791 msgid "(Added in 0.3)"
5796 #: ../src/guestfs-actions.pod:41
5797 msgid "guestfs_add_domain"
5802 #: ../src/guestfs-actions.pod:43
5806 " guestfs_add_domain (guestfs_h *g,\n"
5807 " const char *dom,\n"
5814 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
5815 #: ../src/guestfs-actions.pod:4202
5817 "You may supply a list of optional arguments to this call. Use zero or more "
5818 "of the following pairs of parameters, and terminate the list with C<-1> on "
5819 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5824 #: ../src/guestfs-actions.pod:53
5827 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5828 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5829 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5835 #: ../src/guestfs-actions.pod:57
5837 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5838 "It works by connecting to libvirt, requesting the domain and domain XML from "
5839 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5845 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5847 "The number of disks added is returned. This operation is atomic: if an "
5848 "error is returned, then no disks are added."
5853 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5855 "This function does some minimal checks to make sure the libvirt domain is "
5856 "not running (unless C<readonly> is true). In a future version we will try "
5857 "to acquire the libvirt lock on each disk."
5862 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5864 "Disks must be accessible locally. This often means that adding disks from a "
5865 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5866 "unless those disks are accessible via the same device path locally too."
5870 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5872 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5873 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5874 "libvirt URI (or one set through an environment variable, see the libvirt "
5875 "documentation for full details)."
5880 #: ../src/guestfs-actions.pod:80
5882 "The other optional parameters are passed directly through to "
5883 "C<guestfs_add_drive_opts>."
5888 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336
5889 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
5890 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
5891 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
5892 #: ../src/guestfs-actions.pod:1658 ../src/guestfs-actions.pod:1861
5893 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2000
5894 #: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2078
5895 #: ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2659
5896 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:4616
5897 #: ../src/guestfs-actions.pod:4753 ../src/guestfs-actions.pod:5159
5898 #: ../src/guestfs-actions.pod:5185 ../src/guestfs-actions.pod:6481
5899 #: ../src/guestfs-actions.pod:6906 ../src/guestfs-actions.pod:6919
5900 #: ../src/guestfs-actions.pod:6932
5901 msgid "On error this function returns -1."
5906 #: ../src/guestfs-actions.pod:85
5907 msgid "(Added in 1.7.4)"
5912 #: ../src/guestfs-actions.pod:87
5913 msgid "guestfs_add_domain_va"
5918 #: ../src/guestfs-actions.pod:89
5922 " guestfs_add_domain_va (guestfs_h *g,\n"
5923 " const char *dom,\n"
5930 #: ../src/guestfs-actions.pod:94
5931 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5936 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
5937 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
5938 #: ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4255
5939 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5944 #: ../src/guestfs-actions.pod:98
5945 msgid "guestfs_add_domain_argv"
5950 #: ../src/guestfs-actions.pod:100
5954 " guestfs_add_domain_argv (guestfs_h *g,\n"
5955 " const char *dom,\n"
5956 " const struct guestfs_add_domain_argv *optargs);\n"
5962 #: ../src/guestfs-actions.pod:105
5963 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5968 #: ../src/guestfs-actions.pod:109
5969 msgid "guestfs_add_drive"
5974 #: ../src/guestfs-actions.pod:111
5978 " guestfs_add_drive (guestfs_h *g,\n"
5979 " const char *filename);\n"
5985 #: ../src/guestfs-actions.pod:115
5987 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5988 "optional parameters, so the disk is added writable, with the format being "
5989 "detected automatically."
5994 #: ../src/guestfs-actions.pod:119
5996 "Automatic detection of the format opens you up to a potential security hole "
5997 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5998 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5999 "you should think about replacing calls to this function with calls to "
6000 "C<guestfs_add_drive_opts>, and specifying the format."
6005 #: ../src/guestfs-actions.pod:130
6006 msgid "guestfs_add_drive_opts"
6011 #: ../src/guestfs-actions.pod:132
6015 " guestfs_add_drive_opts (guestfs_h *g,\n"
6016 " const char *filename,\n"
6023 #: ../src/guestfs-actions.pod:142
6026 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6027 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6028 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6034 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
6036 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6037 "The first time you call this function, the disk appears as C</dev/sda>, the "
6038 "second time as C</dev/sdb>, and so on."
6043 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
6045 "You don't necessarily need to be root when using libguestfs. However you "
6046 "obviously do need sufficient permissions to access the filename for whatever "
6047 "operations you want to perform (ie. read access if you just want to read the "
6048 "image or write access if you want to modify the image)."
6053 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
6054 msgid "This call checks that C<filename> exists."
6059 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4212
6060 #: ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2828
6061 msgid "The optional arguments are:"
6066 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
6072 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
6074 "If true then the image is treated as read-only. Writes are still allowed, "
6075 "but they are stored in a temporary snapshot overlay which is discarded at "
6076 "the end. The disk that you add is not modified."
6081 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
6087 #: ../src/guestfs-actions.pod:171
6089 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6090 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6091 "Possible formats include C<raw> and C<qcow2>."
6096 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
6098 "Automatic detection of the format opens you up to a potential security hole "
6099 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6100 "RHBZ#642934. Specifying the format closes this security hole."
6105 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
6111 #: ../src/guestfs-actions.pod:182
6113 "This rarely-used option lets you emulate the behaviour of the deprecated "
6114 "C<guestfs_add_drive_with_if> call (q.v.)"
6119 #: ../src/guestfs-actions.pod:189
6120 msgid "(Added in 1.5.23)"
6125 #: ../src/guestfs-actions.pod:191
6126 msgid "guestfs_add_drive_opts_va"
6131 #: ../src/guestfs-actions.pod:193
6135 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6136 " const char *filename,\n"
6143 #: ../src/guestfs-actions.pod:198
6144 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6149 #: ../src/guestfs-actions.pod:202
6150 msgid "guestfs_add_drive_opts_argv"
6155 #: ../src/guestfs-actions.pod:204
6159 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6160 " const char *filename,\n"
6161 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6167 #: ../src/guestfs-actions.pod:209
6168 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6173 #: ../src/guestfs-actions.pod:213
6174 msgid "guestfs_add_drive_ro"
6179 #: ../src/guestfs-actions.pod:215
6183 " guestfs_add_drive_ro (guestfs_h *g,\n"
6184 " const char *filename);\n"
6190 #: ../src/guestfs-actions.pod:219
6192 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6193 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6194 "disk is added read-only, with the format being detected automatically."
6199 #: ../src/guestfs-actions.pod:226
6200 msgid "(Added in 1.0.38)"
6205 #: ../src/guestfs-actions.pod:228
6206 msgid "guestfs_add_drive_ro_with_if"
6211 #: ../src/guestfs-actions.pod:230
6215 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6216 " const char *filename,\n"
6217 " const char *iface);\n"
6223 #: ../src/guestfs-actions.pod:235
6225 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6226 "QEMU interface emulation to use at run time."
6231 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
6232 #: ../src/guestfs-actions.pod:2330
6233 msgid "(Added in 1.0.84)"
6238 #: ../src/guestfs-actions.pod:249
6239 msgid "guestfs_add_drive_with_if"
6244 #: ../src/guestfs-actions.pod:251
6248 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6249 " const char *filename,\n"
6250 " const char *iface);\n"
6256 #: ../src/guestfs-actions.pod:256
6258 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6259 "QEMU interface emulation to use at run time."
6264 #: ../src/guestfs-actions.pod:270
6265 msgid "guestfs_aug_clear"
6270 #: ../src/guestfs-actions.pod:272
6274 " guestfs_aug_clear (guestfs_h *g,\n"
6275 " const char *augpath);\n"
6281 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
6283 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6284 "L<augtool(1)> C<clear> command."
6289 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2080
6290 msgid "(Added in 1.3.4)"
6295 #: ../src/guestfs-actions.pod:283
6296 msgid "guestfs_aug_close"
6301 #: ../src/guestfs-actions.pod:285
6305 " guestfs_aug_close (guestfs_h *g);\n"
6311 #: ../src/guestfs-actions.pod:288
6313 "Close the current Augeas handle and free up any resources used by it. After "
6314 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6315 "any other Augeas functions."
6320 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
6321 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
6322 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
6323 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
6324 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
6325 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
6326 #: ../src/guestfs-actions.pod:5236
6327 msgid "(Added in 0.7)"
6332 #: ../src/guestfs-actions.pod:297
6333 msgid "guestfs_aug_defnode"
6338 #: ../src/guestfs-actions.pod:299
6341 " struct guestfs_int_bool *\n"
6342 " guestfs_aug_defnode (guestfs_h *g,\n"
6343 " const char *name,\n"
6344 " const char *expr,\n"
6345 " const char *val);\n"
6351 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
6353 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6358 #: ../src/guestfs-actions.pod:308
6360 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6361 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6362 "containing that single node."
6367 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
6369 "On success this returns a pair containing the number of nodes in the "
6370 "nodeset, and a boolean flag if a node was created."
6375 #: ../src/guestfs-actions.pod:316
6377 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6378 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6383 #: ../src/guestfs-actions.pod:322
6384 msgid "guestfs_aug_defvar"
6389 #: ../src/guestfs-actions.pod:324
6393 " guestfs_aug_defvar (guestfs_h *g,\n"
6394 " const char *name,\n"
6395 " const char *expr);\n"
6401 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
6403 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6404 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6409 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
6411 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6412 "evaluates to something which is not a nodeset."
6417 #: ../src/guestfs-actions.pod:340
6418 msgid "guestfs_aug_get"
6423 #: ../src/guestfs-actions.pod:342
6427 " guestfs_aug_get (guestfs_h *g,\n"
6428 " const char *augpath);\n"
6434 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
6436 "Look up the value associated with C<path>. If C<path> matches exactly one "
6437 "node, the C<value> is returned."
6442 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
6443 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
6444 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
6445 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
6446 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
6447 #: ../src/guestfs-actions.pod:1529 ../src/guestfs-actions.pod:1641
6448 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1821
6449 #: ../src/guestfs-actions.pod:1912 ../src/guestfs-actions.pod:1933
6450 #: ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2295
6451 #: ../src/guestfs-actions.pod:2502 ../src/guestfs-actions.pod:2583
6452 #: ../src/guestfs-actions.pod:2631 ../src/guestfs-actions.pod:2745
6453 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2800
6454 #: ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2885
6455 #: ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:3749
6456 #: ../src/guestfs-actions.pod:3919 ../src/guestfs-actions.pod:4029
6457 #: ../src/guestfs-actions.pod:4771 ../src/guestfs-actions.pod:4964
6458 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5312
6459 #: ../src/guestfs-actions.pod:5361 ../src/guestfs-actions.pod:5924
6460 #: ../src/guestfs-actions.pod:5940 ../src/guestfs-actions.pod:5957
6461 #: ../src/guestfs-actions.pod:5981 ../src/guestfs-actions.pod:6655
6462 #: ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6692
6463 #: ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:7144
6465 "This function returns a string, or NULL on error. I<The caller must free "
6466 "the returned string after use>."
6471 #: ../src/guestfs-actions.pod:354
6472 msgid "guestfs_aug_init"
6477 #: ../src/guestfs-actions.pod:356
6481 " guestfs_aug_init (guestfs_h *g,\n"
6482 " const char *root,\n"
6489 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
6491 "Create a new Augeas handle for editing configuration files. If there was "
6492 "any previous Augeas handle associated with this guestfs session, then it is "
6498 #: ../src/guestfs-actions.pod:365
6499 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6504 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
6506 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6511 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
6513 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6514 "logical I<or> of the following integers:"
6519 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
6520 msgid "C<AUG_SAVE_BACKUP> = 1"
6525 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
6526 msgid "Keep the original file with a C<.augsave> extension."
6531 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
6532 msgid "C<AUG_SAVE_NEWFILE> = 2"
6537 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
6539 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6540 "original. Overrides C<AUG_SAVE_BACKUP>."
6545 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
6546 msgid "C<AUG_TYPE_CHECK> = 4"
6551 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
6552 msgid "Typecheck lenses (can be expensive)."
6557 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
6558 msgid "C<AUG_NO_STDINC> = 8"
6563 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
6564 msgid "Do not use standard load path for modules."
6569 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
6570 msgid "C<AUG_SAVE_NOOP> = 16"
6575 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
6576 msgid "Make save a no-op, just record what would have been changed."
6581 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
6582 msgid "C<AUG_NO_LOAD> = 32"
6587 #: ../src/guestfs-actions.pod:400
6588 msgid "Do not load the tree in C<guestfs_aug_init>."
6593 #: ../src/guestfs-actions.pod:404
6594 msgid "To close the handle, you can call C<guestfs_aug_close>."
6599 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
6600 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6605 #: ../src/guestfs-actions.pod:412
6606 msgid "guestfs_aug_insert"
6611 #: ../src/guestfs-actions.pod:414
6615 " guestfs_aug_insert (guestfs_h *g,\n"
6616 " const char *augpath,\n"
6617 " const char *label,\n"
6624 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
6626 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6627 "or after C<path> (depending on the boolean flag C<before>)."
6632 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
6634 "C<path> must match exactly one existing node in the tree, and C<label> must "
6635 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6640 #: ../src/guestfs-actions.pod:432
6641 msgid "guestfs_aug_load"
6646 #: ../src/guestfs-actions.pod:434
6650 " guestfs_aug_load (guestfs_h *g);\n"
6656 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
6657 msgid "Load files into the tree."
6662 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
6663 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6668 #: ../src/guestfs-actions.pod:446
6669 msgid "guestfs_aug_ls"
6674 #: ../src/guestfs-actions.pod:448
6678 " guestfs_aug_ls (guestfs_h *g,\n"
6679 " const char *augpath);\n"
6685 #: ../src/guestfs-actions.pod:452
6687 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6688 "sorting the resulting nodes into alphabetical order."
6693 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
6694 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
6695 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
6696 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
6697 #: ../src/guestfs-actions.pod:1743 ../src/guestfs-actions.pod:2175
6698 #: ../src/guestfs-actions.pod:2191 ../src/guestfs-actions.pod:2210
6699 #: ../src/guestfs-actions.pod:2253 ../src/guestfs-actions.pod:2277
6700 #: ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2397
6701 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2819
6702 #: ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3319
6703 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3486
6704 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4577
6705 #: ../src/guestfs-actions.pod:5106 ../src/guestfs-actions.pod:5232
6706 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5997
6707 #: ../src/guestfs-actions.pod:6058 ../src/guestfs-actions.pod:6113
6708 #: ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:6283
6709 #: ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6785
6710 #: ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6997
6711 #: ../src/guestfs-actions.pod:7016 ../src/guestfs-actions.pod:7101
6712 #: ../src/guestfs-actions.pod:7120 ../src/guestfs-actions.pod:7166
6713 #: ../src/guestfs-actions.pod:7185
6715 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6716 ">), or NULL if there was an error. I<The caller must free the strings and "
6717 "the array after use>."
6722 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
6723 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
6724 #: ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3143
6725 #: ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3782
6726 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:4002
6727 #: ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4581
6728 #: ../src/guestfs-actions.pod:5047 ../src/guestfs-actions.pod:5425
6729 #: ../src/guestfs-actions.pod:5439 ../src/guestfs-actions.pod:5451
6730 #: ../src/guestfs-actions.pod:5859 ../src/guestfs-actions.pod:6497
6731 #: ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6749
6732 #: ../src/guestfs-actions.pod:6985
6733 msgid "(Added in 0.8)"
6738 #: ../src/guestfs-actions.pod:461
6739 msgid "guestfs_aug_match"
6744 #: ../src/guestfs-actions.pod:463
6748 " guestfs_aug_match (guestfs_h *g,\n"
6749 " const char *augpath);\n"
6755 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
6757 "Returns a list of paths which match the path expression C<path>. The "
6758 "returned paths are sufficiently qualified so that they match exactly one "
6759 "node in the current tree."
6764 #: ../src/guestfs-actions.pod:477
6765 msgid "guestfs_aug_mv"
6770 #: ../src/guestfs-actions.pod:479
6774 " guestfs_aug_mv (guestfs_h *g,\n"
6775 " const char *src,\n"
6776 " const char *dest);\n"
6782 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
6784 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6785 "C<dest> is overwritten if it exists."
6790 #: ../src/guestfs-actions.pod:491
6791 msgid "guestfs_aug_rm"
6796 #: ../src/guestfs-actions.pod:493
6800 " guestfs_aug_rm (guestfs_h *g,\n"
6801 " const char *augpath);\n"
6807 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
6808 msgid "Remove C<path> and all of its children."
6813 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
6814 msgid "On success this returns the number of entries which were removed."
6819 #: ../src/guestfs-actions.pod:505
6820 msgid "guestfs_aug_save"
6825 #: ../src/guestfs-actions.pod:507
6829 " guestfs_aug_save (guestfs_h *g);\n"
6835 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
6836 msgid "This writes all pending changes to disk."
6841 #: ../src/guestfs-actions.pod:512
6843 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6849 #: ../src/guestfs-actions.pod:519
6850 msgid "guestfs_aug_set"
6855 #: ../src/guestfs-actions.pod:521
6859 " guestfs_aug_set (guestfs_h *g,\n"
6860 " const char *augpath,\n"
6861 " const char *val);\n"
6867 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
6868 msgid "Set the value associated with C<path> to C<val>."
6873 #: ../src/guestfs-actions.pod:528
6875 "In the Augeas API, it is possible to clear a node by setting the value to "
6876 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6877 "this call. Instead you must use the C<guestfs_aug_clear> call."
6882 #: ../src/guestfs-actions.pod:537
6883 msgid "guestfs_available"
6888 #: ../src/guestfs-actions.pod:539
6892 " guestfs_available (guestfs_h *g,\n"
6893 " char *const *groups);\n"
6899 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
6901 "This command is used to check the availability of some groups of "
6902 "functionality in the appliance, which not all builds of the libguestfs "
6903 "appliance will be able to provide."
6908 #: ../src/guestfs-actions.pod:547
6910 "The libguestfs groups, and the functions that those groups correspond to, "
6911 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6912 "runtime by calling C<guestfs_available_all_groups>."
6917 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
6919 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6920 "\"]> would check for the availability of the Linux inotify functions and "
6921 "Augeas (configuration file editing) functions."
6926 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
6927 msgid "The command returns no error if I<all> requested groups are available."
6932 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
6934 "It fails with an error if one or more of the requested groups is unavailable "
6940 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
6942 "If an unknown group name is included in the list of groups then an error is "
6948 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
6954 #: ../src/guestfs-actions.pod:571
6955 msgid "You must call C<guestfs_launch> before calling this function."
6960 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
6962 "The reason is because we don't know what groups are supported by the "
6963 "appliance/daemon until it is running and can be queried."
6968 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
6970 "If a group of functions is available, this does not necessarily mean that "
6971 "they will work. You still have to check for errors when calling individual "
6972 "API functions even if they are available."
6977 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6979 "It is usually the job of distro packagers to build complete functionality "
6980 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6981 "with all requirements satisfied, will support everything."
6986 #: ../src/guestfs-actions.pod:593
6988 "This call was added in version C<1.0.80>. In previous versions of "
6989 "libguestfs all you could do would be to speculatively execute a command to "
6990 "find out if the daemon implemented it. See also C<guestfs_version>."
6995 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6996 msgid "(Added in 1.0.80)"
7001 #: ../src/guestfs-actions.pod:604
7002 msgid "guestfs_available_all_groups"
7007 #: ../src/guestfs-actions.pod:606
7011 " guestfs_available_all_groups (guestfs_h *g);\n"
7017 #: ../src/guestfs-actions.pod:609
7019 "This command returns a list of all optional groups that this daemon knows "
7020 "about. Note this returns both supported and unsupported groups. To find "
7021 "out which ones the daemon can actually support you have to call "
7022 "C<guestfs_available> on each member of the returned list."
7027 #: ../src/guestfs-actions.pod:615
7028 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7033 #: ../src/guestfs-actions.pod:621
7034 msgid "(Added in 1.3.15)"
7039 #: ../src/guestfs-actions.pod:623
7040 msgid "guestfs_base64_in"
7045 #: ../src/guestfs-actions.pod:625
7049 " guestfs_base64_in (guestfs_h *g,\n"
7050 " const char *base64file,\n"
7051 " const char *filename);\n"
7057 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
7059 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7064 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
7065 msgid "(Added in 1.3.5)"
7070 #: ../src/guestfs-actions.pod:637
7071 msgid "guestfs_base64_out"
7076 #: ../src/guestfs-actions.pod:639
7080 " guestfs_base64_out (guestfs_h *g,\n"
7081 " const char *filename,\n"
7082 " const char *base64file);\n"
7088 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
7090 "This command downloads the contents of C<filename>, writing it out to local "
7091 "file C<base64file> encoded as base64."
7096 #: ../src/guestfs-actions.pod:651
7097 msgid "guestfs_blockdev_flushbufs"
7102 #: ../src/guestfs-actions.pod:653
7106 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7107 " const char *device);\n"
7113 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
7115 "This tells the kernel to flush internal buffers associated with C<device>."
7120 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
7121 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
7122 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
7123 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
7124 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
7125 #: ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:452
7126 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:471
7127 #: ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:496
7128 #: ../fish/guestfish-actions.pod:504 ../fish/guestfish-actions.pod:515
7129 #: ../fish/guestfish-actions.pod:523 ../fish/guestfish-actions.pod:531
7130 msgid "This uses the L<blockdev(8)> command."
7135 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
7136 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
7137 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
7138 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
7139 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
7140 msgid "(Added in 0.9.3)"
7145 #: ../src/guestfs-actions.pod:666
7146 msgid "guestfs_blockdev_getbsz"
7151 #: ../src/guestfs-actions.pod:668
7155 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7156 " const char *device);\n"
7162 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
7163 msgid "This returns the block size of a device."
7168 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
7169 #: ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
7171 "(Note this is different from both I<size in blocks> and I<filesystem block "
7177 #: ../src/guestfs-actions.pod:683
7178 msgid "guestfs_blockdev_getro"
7183 #: ../src/guestfs-actions.pod:685
7187 " guestfs_blockdev_getro (guestfs_h *g,\n"
7188 " const char *device);\n"
7194 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
7196 "Returns a boolean indicating if the block device is read-only (true if read-"
7197 "only, false if not)."
7202 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
7203 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1888
7204 #: ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1971
7205 #: ../src/guestfs-actions.pod:2026 ../src/guestfs-actions.pod:2041
7206 #: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2089
7207 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3065
7208 #: ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3094
7209 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3125
7210 #: ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3155
7211 #: ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3182
7212 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3212
7213 #: ../src/guestfs-actions.pod:4735
7214 msgid "This function returns a C truth value on success or -1 on error."
7219 #: ../src/guestfs-actions.pod:698
7220 msgid "guestfs_blockdev_getsize64"
7225 #: ../src/guestfs-actions.pod:700
7229 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7230 " const char *device);\n"
7236 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
7237 msgid "This returns the size of the device in bytes."
7242 #: ../src/guestfs-actions.pod:706
7243 msgid "See also C<guestfs_blockdev_getsz>."
7248 #: ../src/guestfs-actions.pod:714
7249 msgid "guestfs_blockdev_getss"
7254 #: ../src/guestfs-actions.pod:716
7258 " guestfs_blockdev_getss (guestfs_h *g,\n"
7259 " const char *device);\n"
7265 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
7267 "This returns the size of sectors on a block device. Usually 512, but can be "
7268 "larger for modern devices."
7273 #: ../src/guestfs-actions.pod:723
7275 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7281 #: ../src/guestfs-actions.pod:732
7282 msgid "guestfs_blockdev_getsz"
7287 #: ../src/guestfs-actions.pod:734
7291 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7292 " const char *device);\n"
7298 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
7300 "This returns the size of the device in units of 512-byte sectors (even if "
7301 "the sectorsize isn't 512 bytes ... weird)."
7306 #: ../src/guestfs-actions.pod:741
7308 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7309 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7314 #: ../src/guestfs-actions.pod:751
7315 msgid "guestfs_blockdev_rereadpt"
7320 #: ../src/guestfs-actions.pod:753
7324 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7325 " const char *device);\n"
7331 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
7332 msgid "Reread the partition table on C<device>."
7337 #: ../src/guestfs-actions.pod:765
7338 msgid "guestfs_blockdev_setbsz"
7343 #: ../src/guestfs-actions.pod:767
7347 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7348 " const char *device,\n"
7349 " int blocksize);\n"
7355 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
7356 msgid "This sets the block size of a device."
7361 #: ../src/guestfs-actions.pod:783
7362 msgid "guestfs_blockdev_setro"
7367 #: ../src/guestfs-actions.pod:785
7371 " guestfs_blockdev_setro (guestfs_h *g,\n"
7372 " const char *device);\n"
7378 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
7379 msgid "Sets the block device named C<device> to read-only."
7384 #: ../src/guestfs-actions.pod:797
7385 msgid "guestfs_blockdev_setrw"
7390 #: ../src/guestfs-actions.pod:799
7394 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7395 " const char *device);\n"
7401 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
7402 msgid "Sets the block device named C<device> to read-write."
7407 #: ../src/guestfs-actions.pod:811
7408 msgid "guestfs_case_sensitive_path"
7413 #: ../src/guestfs-actions.pod:813
7417 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7418 " const char *path);\n"
7424 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
7426 "This can be used to resolve case insensitive paths on a filesystem which is "
7427 "case sensitive. The use case is to resolve paths which you have read from "
7428 "Windows configuration files or the Windows Registry, to the true path."
7433 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
7435 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7436 "(and probably others), which is that although the underlying filesystem is "
7437 "case-insensitive, the driver exports the filesystem to Linux as case-"
7443 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
7445 "One consequence of this is that special directories such as C<c:\\windows> "
7446 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7447 "precise details of how they were created. In Windows itself this would not "
7453 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
7455 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7461 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
7463 "This function resolves the true case of each element in the path and returns "
7464 "the case-sensitive path."
7469 #: ../src/guestfs-actions.pod:839
7471 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7472 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7473 "how the directories were originally created under Windows)."
7478 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
7479 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7484 #: ../src/guestfs-actions.pod:847
7485 msgid "See also C<guestfs_realpath>."
7490 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6677
7491 msgid "(Added in 1.0.75)"
7496 #: ../src/guestfs-actions.pod:854
7502 #: ../src/guestfs-actions.pod:856
7506 " guestfs_cat (guestfs_h *g,\n"
7507 " const char *path);\n"
7513 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5222
7514 #: ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3474
7515 msgid "Return the contents of the file named C<path>."
7520 #: ../src/guestfs-actions.pod:862
7522 "Note that this function cannot correctly handle binary files (specifically, "
7523 "files containing C<\\0> character which is treated as end of string). For "
7524 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7525 "functions which have a more complex interface."
7530 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
7531 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
7532 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
7533 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1747
7534 #: ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:2214
7535 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2281
7536 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2327
7537 #: ../src/guestfs-actions.pod:5004 ../src/guestfs-actions.pod:5030
7538 #: ../src/guestfs-actions.pod:5161 ../src/guestfs-actions.pod:5187
7539 #: ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:6062
7540 #: ../src/guestfs-actions.pod:6117 ../src/guestfs-actions.pod:6263
7541 #: ../src/guestfs-actions.pod:6287 ../src/guestfs-actions.pod:6949
7542 #: ../src/guestfs-actions.pod:6975 ../src/guestfs-actions.pod:7001
7543 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7105
7544 #: ../src/guestfs-actions.pod:7124 ../src/guestfs-actions.pod:7170
7545 #: ../src/guestfs-actions.pod:7189 ../fish/guestfish-actions.pod:580
7546 #: ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727
7547 #: ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913
7548 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990
7549 #: ../fish/guestfish-actions.pod:1182 ../fish/guestfish-actions.pod:1477
7550 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:1515
7551 #: ../fish/guestfish-actions.pod:1530 ../fish/guestfish-actions.pod:1540
7552 #: ../fish/guestfish-actions.pod:1559 ../fish/guestfish-actions.pod:3344
7553 #: ../fish/guestfish-actions.pod:3359 ../fish/guestfish-actions.pod:3435
7554 #: ../fish/guestfish-actions.pod:3452 ../fish/guestfish-actions.pod:3467
7555 #: ../fish/guestfish-actions.pod:4050 ../fish/guestfish-actions.pod:4096
7556 #: ../fish/guestfish-actions.pod:4181 ../fish/guestfish-actions.pod:4196
7557 #: ../fish/guestfish-actions.pod:4606 ../fish/guestfish-actions.pod:4624
7558 #: ../fish/guestfish-actions.pod:4641 ../fish/guestfish-actions.pod:4651
7559 #: ../fish/guestfish-actions.pod:4699 ../fish/guestfish-actions.pod:4709
7560 #: ../fish/guestfish-actions.pod:4738 ../fish/guestfish-actions.pod:4748
7562 "Because of the message protocol, there is a transfer limit of somewhere "
7563 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7568 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3323
7569 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3402
7570 #: ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3895
7571 #: ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:5110
7572 #: ../src/guestfs-actions.pod:5124 ../src/guestfs-actions.pod:6836
7573 #: ../src/guestfs-actions.pod:6850
7574 msgid "(Added in 0.4)"
7579 #: ../src/guestfs-actions.pod:875
7580 msgid "guestfs_checksum"
7585 #: ../src/guestfs-actions.pod:877
7589 " guestfs_checksum (guestfs_h *g,\n"
7590 " const char *csumtype,\n"
7591 " const char *path);\n"
7597 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
7599 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7604 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
7606 "The type of checksum to compute is given by the C<csumtype> parameter which "
7607 "must have one of the following values:"
7612 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
7618 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
7620 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7626 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
7632 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
7633 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7638 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
7644 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
7645 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7650 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
7656 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
7657 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7662 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
7668 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
7669 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7674 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
7680 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
7681 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7686 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
7692 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
7693 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7698 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
7699 msgid "The checksum is returned as a printable string."
7704 #: ../src/guestfs-actions.pod:923
7705 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7710 #: ../src/guestfs-actions.pod:925
7711 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7716 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
7717 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:3067
7718 #: ../src/guestfs-actions.pod:3096 ../src/guestfs-actions.pod:3157
7719 #: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:6533
7720 msgid "(Added in 1.0.2)"
7725 #: ../src/guestfs-actions.pod:932
7726 msgid "guestfs_checksum_device"
7731 #: ../src/guestfs-actions.pod:934
7735 " guestfs_checksum_device (guestfs_h *g,\n"
7736 " const char *csumtype,\n"
7737 " const char *device);\n"
7743 #: ../src/guestfs-actions.pod:939
7745 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7746 "device named C<device>. For the types of checksums supported see the "
7747 "C<guestfs_checksum> command."
7752 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4641
7753 #: ../src/guestfs-actions.pod:4700 ../src/guestfs-actions.pod:4737
7754 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4931
7755 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6456
7756 #: ../src/guestfs-actions.pod:6862
7757 msgid "(Added in 1.3.2)"
7762 #: ../src/guestfs-actions.pod:948
7763 msgid "guestfs_checksums_out"
7768 #: ../src/guestfs-actions.pod:950
7772 " guestfs_checksums_out (guestfs_h *g,\n"
7773 " const char *csumtype,\n"
7774 " const char *directory,\n"
7775 " const char *sumsfile);\n"
7781 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
7783 "This command computes the checksums of all regular files in C<directory> and "
7784 "then emits a list of those checksums to the local output file C<sumsfile>."
7789 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
7791 "This can be used for verifying the integrity of a virtual machine. However "
7792 "to be properly secure you should pay attention to the output of the checksum "
7793 "command (it uses the ones from GNU coreutils). In particular when the "
7794 "filename is not printable, coreutils uses a special backslash syntax. For "
7795 "more information, see the GNU coreutils info file."
7800 #: ../src/guestfs-actions.pod:970
7801 msgid "(Added in 1.3.7)"
7806 #: ../src/guestfs-actions.pod:972
7807 msgid "guestfs_chmod"
7812 #: ../src/guestfs-actions.pod:974
7816 " guestfs_chmod (guestfs_h *g,\n"
7818 " const char *path);\n"
7824 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
7826 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7832 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
7834 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7835 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7841 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4146
7842 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4350
7843 #: ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:669
7844 #: ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2910
7845 #: ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2930
7846 msgid "The mode actually set is affected by the umask."
7851 #: ../src/guestfs-actions.pod:992
7852 msgid "guestfs_chown"
7857 #: ../src/guestfs-actions.pod:994
7861 " guestfs_chown (guestfs_h *g,\n"
7864 " const char *path);\n"
7870 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
7871 msgid "Change the file owner to C<owner> and group to C<group>."
7876 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3254
7877 #: ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2250
7879 "Only numeric uid and gid are supported. If you want to use names, you will "
7880 "need to locate and parse the password file yourself (Augeas support makes "
7881 "this relatively easy)."
7886 #: ../src/guestfs-actions.pod:1010
7887 msgid "guestfs_command"
7892 #: ../src/guestfs-actions.pod:1012
7896 " guestfs_command (guestfs_h *g,\n"
7897 " char *const *arguments);\n"
7903 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
7905 "This call runs a command from the guest filesystem. The filesystem must be "
7906 "mounted, and must contain a compatible operating system (ie. something "
7907 "Linux, with the same or compatible processor architecture)."
7912 #: ../src/guestfs-actions.pod:1021
7914 "The single parameter is an argv-style list of arguments. The first element "
7915 "is the name of the program to run. Subsequent elements are parameters. The "
7916 "list must be non-empty (ie. must contain a program name). Note that the "
7917 "command runs directly, and is I<not> invoked via the shell (see "
7923 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
7924 msgid "The return value is anything printed to I<stdout> by the command."
7929 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
7931 "If the command returns a non-zero exit status, then this function returns an "
7932 "error message. The error message string is the content of I<stderr> from "
7938 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
7940 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7941 "bin>. If you require a program from another location, you should provide "
7942 "the full path in the first parameter."
7947 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
7949 "Shared libraries and data files required by the program must be available on "
7950 "filesystems which are mounted in the correct places. It is the caller's "
7951 "responsibility to ensure all filesystems that are needed are mounted at the "
7957 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
7958 #: ../src/guestfs-actions.pod:1532
7959 msgid "(Added in 0.9.1)"
7964 #: ../src/guestfs-actions.pod:1054
7965 msgid "guestfs_command_lines"
7970 #: ../src/guestfs-actions.pod:1056
7974 " guestfs_command_lines (guestfs_h *g,\n"
7975 " char *const *arguments);\n"
7981 #: ../src/guestfs-actions.pod:1060
7983 "This is the same as C<guestfs_command>, but splits the result into a list of "
7989 #: ../src/guestfs-actions.pod:1063
7990 msgid "See also: C<guestfs_sh_lines>"
7995 #: ../src/guestfs-actions.pod:1074
7996 msgid "guestfs_config"
8001 #: ../src/guestfs-actions.pod:1076
8005 " guestfs_config (guestfs_h *g,\n"
8006 " const char *qemuparam,\n"
8007 " const char *qemuvalue);\n"
8013 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
8015 "This can be used to add arbitrary qemu command line parameters of the form "
8016 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8017 "setting some parameters which would interfere with parameters that we use."
8022 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
8023 msgid "The first character of C<param> string must be a C<-> (dash)."
8028 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
8029 msgid "C<value> can be NULL."
8034 #: ../src/guestfs-actions.pod:1094
8035 msgid "guestfs_copy_size"
8040 #: ../src/guestfs-actions.pod:1096
8044 " guestfs_copy_size (guestfs_h *g,\n"
8045 " const char *src,\n"
8046 " const char *dest,\n"
8053 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
8055 "This command copies exactly C<size> bytes from one source device or file "
8056 "C<src> to another destination device or file C<dest>."
8061 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
8063 "Note this will fail if the source is too short or if the destination is not "
8069 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
8070 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1681
8071 #: ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:6528
8072 #: ../src/guestfs-actions.pod:6562 ../src/guestfs-actions.pod:7041
8073 #: ../src/guestfs-actions.pod:7060
8075 "This long-running command can generate progress notification messages so "
8076 "that the caller can display a progress bar or indicator. To receive these "
8077 "messages, the caller must register a progress callback. See L<guestfs(3)/"
8078 "guestfs_set_progress_callback>."
8083 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3922
8084 #: ../src/guestfs-actions.pod:5137 ../src/guestfs-actions.pod:6769
8085 #: ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6875
8086 msgid "(Added in 1.0.87)"
8091 #: ../src/guestfs-actions.pod:1117
8097 #: ../src/guestfs-actions.pod:1119
8101 " guestfs_cp (guestfs_h *g,\n"
8102 " const char *src,\n"
8103 " const char *dest);\n"
8109 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
8111 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8112 "destination filename or destination directory."
8117 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
8118 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
8119 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4595
8120 #: ../src/guestfs-actions.pod:4981
8121 msgid "(Added in 1.0.18)"
8126 #: ../src/guestfs-actions.pod:1131
8127 msgid "guestfs_cp_a"
8132 #: ../src/guestfs-actions.pod:1133
8136 " guestfs_cp_a (guestfs_h *g,\n"
8137 " const char *src,\n"
8138 " const char *dest);\n"
8144 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
8146 "This copies a file or directory from C<src> to C<dest> recursively using the "
8152 #: ../src/guestfs-actions.pod:1145
8158 #: ../src/guestfs-actions.pod:1147
8162 " guestfs_dd (guestfs_h *g,\n"
8163 " const char *src,\n"
8164 " const char *dest);\n"
8170 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
8172 "This command copies from one source device or file C<src> to another "
8173 "destination device or file C<dest>. Normally you would use this to copy to "
8174 "or from a device or partition, for example to duplicate a filesystem."
8179 #: ../src/guestfs-actions.pod:1157
8181 "If the destination is a device, it must be as large or larger than the "
8182 "source file or device, otherwise the copy will fail. This command cannot do "
8183 "partial copies (see C<guestfs_copy_size>)."
8188 #: ../src/guestfs-actions.pod:1165
8194 #: ../src/guestfs-actions.pod:1167
8198 " guestfs_df (guestfs_h *g);\n"
8204 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
8205 msgid "This command runs the C<df> command to report disk space used."
8210 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
8212 "This command is mostly useful for interactive sessions. It is I<not> "
8213 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8219 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
8220 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2260
8221 #: ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2352
8222 #: ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4495
8223 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6290
8224 #: ../src/guestfs-actions.pod:6908 ../src/guestfs-actions.pod:6921
8225 #: ../src/guestfs-actions.pod:6934
8226 msgid "(Added in 1.0.54)"
8231 #: ../src/guestfs-actions.pod:1181
8232 msgid "guestfs_df_h"
8237 #: ../src/guestfs-actions.pod:1183
8241 " guestfs_df_h (guestfs_h *g);\n"
8247 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
8249 "This command runs the C<df -h> command to report disk space used in human-"
8255 #: ../src/guestfs-actions.pod:1198
8256 msgid "guestfs_dmesg"
8261 #: ../src/guestfs-actions.pod:1200
8265 " guestfs_dmesg (guestfs_h *g);\n"
8271 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
8273 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8274 "This is sometimes useful for extended debugging of problems."
8279 #: ../src/guestfs-actions.pod:1207
8281 "Another way to get the same information is to enable verbose messages with "
8282 "C<guestfs_set_verbose> or by setting the environment variable "
8283 "C<LIBGUESTFS_DEBUG=1> before running the program."
8288 #: ../src/guestfs-actions.pod:1217
8289 msgid "guestfs_download"
8294 #: ../src/guestfs-actions.pod:1219
8298 " guestfs_download (guestfs_h *g,\n"
8299 " const char *remotefilename,\n"
8300 " const char *filename);\n"
8306 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
8307 #: ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
8309 "Download file C<remotefilename> and save it as C<filename> on the local "
8315 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6522
8316 #: ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4354
8317 msgid "C<filename> can also be a named pipe."
8322 #: ../src/guestfs-actions.pod:1229
8323 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8328 #: ../src/guestfs-actions.pod:1240
8329 msgid "guestfs_download_offset"
8334 #: ../src/guestfs-actions.pod:1242
8338 " guestfs_download_offset (guestfs_h *g,\n"
8339 " const char *remotefilename,\n"
8340 " const char *filename,\n"
8341 " int64_t offset,\n"
8348 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
8350 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8351 "region must be within the file or device)."
8356 #: ../src/guestfs-actions.pod:1255
8358 "Note that there is no limit on the amount of data that can be downloaded "
8359 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8360 "full amount unless an error occurs."
8365 #: ../src/guestfs-actions.pod:1260
8366 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8371 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6567
8372 msgid "(Added in 1.5.17)"
8377 #: ../src/guestfs-actions.pod:1271
8378 msgid "guestfs_drop_caches"
8383 #: ../src/guestfs-actions.pod:1273
8387 " guestfs_drop_caches (guestfs_h *g,\n"
8388 " int whattodrop);\n"
8394 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
8396 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8397 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8398 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8403 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
8404 msgid "Setting C<whattodrop> to 3 should drop everything."
8409 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
8411 "This automatically calls L<sync(2)> before the operation, so that the "
8412 "maximum guest memory is freed."
8417 #: ../src/guestfs-actions.pod:1291
8423 #: ../src/guestfs-actions.pod:1293
8427 " guestfs_du (guestfs_h *g,\n"
8428 " const char *path);\n"
8434 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
8436 "This command runs the C<du -s> command to estimate file space usage for "
8442 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
8444 "C<path> can be a file or a directory. If C<path> is a directory then the "
8445 "estimate includes the contents of the directory and all subdirectories "
8451 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
8453 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8458 #: ../src/guestfs-actions.pod:1311
8459 msgid "guestfs_e2fsck_f"
8464 #: ../src/guestfs-actions.pod:1313
8468 " guestfs_e2fsck_f (guestfs_h *g,\n"
8469 " const char *device);\n"
8475 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
8477 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8478 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8484 #: ../src/guestfs-actions.pod:1321
8486 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8487 "Normally you should use C<guestfs_fsck>."
8492 #: ../src/guestfs-actions.pod:1326
8493 msgid "(Added in 1.0.29)"
8498 #: ../src/guestfs-actions.pod:1328
8499 msgid "guestfs_echo_daemon"
8504 #: ../src/guestfs-actions.pod:1330
8508 " guestfs_echo_daemon (guestfs_h *g,\n"
8509 " char *const *words);\n"
8515 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
8517 "This command concatenates the list of C<words> passed with single spaces "
8518 "between them and returns the resulting string."
8523 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
8524 msgid "You can use this command to test the connection through to the daemon."
8529 #: ../src/guestfs-actions.pod:1339
8530 msgid "See also C<guestfs_ping_daemon>."
8535 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2068
8536 #: ../src/guestfs-actions.pod:5770
8537 msgid "(Added in 1.0.69)"
8542 #: ../src/guestfs-actions.pod:1346
8543 msgid "guestfs_egrep"
8548 #: ../src/guestfs-actions.pod:1348
8552 " guestfs_egrep (guestfs_h *g,\n"
8553 " const char *regex,\n"
8554 " const char *path);\n"
8560 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
8562 "This calls the external C<egrep> program and returns the matching lines."
8567 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
8568 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
8569 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2198
8570 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2373
8571 #: ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:2401
8572 #: ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2469
8573 #: ../src/guestfs-actions.pod:2482 ../src/guestfs-actions.pod:3415
8574 #: ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3442
8575 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:4430
8576 #: ../src/guestfs-actions.pod:5315 ../src/guestfs-actions.pod:5364
8577 #: ../src/guestfs-actions.pod:6134 ../src/guestfs-actions.pod:6146
8578 #: ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6172
8579 #: ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6207
8580 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6233
8581 #: ../src/guestfs-actions.pod:7004 ../src/guestfs-actions.pod:7023
8582 #: ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7127
8583 #: ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7192
8584 msgid "(Added in 1.0.66)"
8589 #: ../src/guestfs-actions.pod:1365
8590 msgid "guestfs_egrepi"
8595 #: ../src/guestfs-actions.pod:1367
8599 " guestfs_egrepi (guestfs_h *g,\n"
8600 " const char *regex,\n"
8601 " const char *path);\n"
8607 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
8609 "This calls the external C<egrep -i> program and returns the matching lines."
8614 #: ../src/guestfs-actions.pod:1384
8615 msgid "guestfs_equal"
8620 #: ../src/guestfs-actions.pod:1386
8624 " guestfs_equal (guestfs_h *g,\n"
8625 " const char *file1,\n"
8626 " const char *file2);\n"
8632 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
8634 "This compares the two files C<file1> and C<file2> and returns true if their "
8635 "content is exactly equal, or false otherwise."
8640 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
8641 msgid "The external L<cmp(1)> program is used for the comparison."
8646 #: ../src/guestfs-actions.pod:1400
8647 msgid "guestfs_exists"
8652 #: ../src/guestfs-actions.pod:1402
8656 " guestfs_exists (guestfs_h *g,\n"
8657 " const char *path);\n"
8663 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
8665 "This returns C<true> if and only if there is a file, directory (or anything) "
8666 "with the given C<path> name."
8671 #: ../src/guestfs-actions.pod:1409
8672 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8677 #: ../src/guestfs-actions.pod:1415
8678 msgid "guestfs_fallocate"
8683 #: ../src/guestfs-actions.pod:1417
8687 " guestfs_fallocate (guestfs_h *g,\n"
8688 " const char *path,\n"
8695 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
8696 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
8698 "This command preallocates a file (containing zero bytes) named C<path> of "
8699 "size C<len> bytes. If the file exists already, it is overwritten."
8704 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
8706 "Do not confuse this with the guestfish-specific C<alloc> command which "
8707 "allocates a file in the host and attaches it as a device."
8712 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:946
8714 "This function is deprecated. In new code, use the C<fallocate64> call "
8720 #: ../src/guestfs-actions.pod:1441
8721 msgid "guestfs_fallocate64"
8726 #: ../src/guestfs-actions.pod:1443
8730 " guestfs_fallocate64 (guestfs_h *g,\n"
8731 " const char *path,\n"
8738 #: ../src/guestfs-actions.pod:1452
8740 "Note that this call allocates disk blocks for the file. To create a sparse "
8741 "file use C<guestfs_truncate_size> instead."
8746 #: ../src/guestfs-actions.pod:1455
8748 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8749 "oversight it only allowed 30 bit lengths to be specified, effectively "
8750 "limiting the maximum size of files created through that call to 1GB."
8755 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
8757 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8758 "commands which create a file in the host and attach it as a device."
8763 #: ../src/guestfs-actions.pod:1466
8764 msgid "(Added in 1.3.17)"
8769 #: ../src/guestfs-actions.pod:1468
8770 msgid "guestfs_fgrep"
8775 #: ../src/guestfs-actions.pod:1470
8779 " guestfs_fgrep (guestfs_h *g,\n"
8780 " const char *pattern,\n"
8781 " const char *path);\n"
8787 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
8789 "This calls the external C<fgrep> program and returns the matching lines."
8794 #: ../src/guestfs-actions.pod:1487
8795 msgid "guestfs_fgrepi"
8800 #: ../src/guestfs-actions.pod:1489
8804 " guestfs_fgrepi (guestfs_h *g,\n"
8805 " const char *pattern,\n"
8806 " const char *path);\n"
8812 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
8814 "This calls the external C<fgrep -i> program and returns the matching lines."
8819 #: ../src/guestfs-actions.pod:1506
8820 msgid "guestfs_file"
8825 #: ../src/guestfs-actions.pod:1508
8829 " guestfs_file (guestfs_h *g,\n"
8830 " const char *path);\n"
8836 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
8838 "This call uses the standard L<file(1)> command to determine the type or "
8839 "contents of the file."
8844 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
8846 "This call will also transparently look inside various types of compressed "
8852 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
8854 "The exact command which runs is C<file -zb path>. Note in particular that "
8855 "the filename is not prepended to the output (the C<-b> option)."
8859 #: ../src/guestfs-actions.pod:1522 ../fish/guestfish-actions.pod:1007
8861 "The output depends on the output of the underlying L<file(1)> command and it "
8862 "can change in future in ways beyond our control. In other words, the output "
8863 "is not guaranteed by the ABI."
8867 #: ../src/guestfs-actions.pod:1526
8869 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8870 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8875 #: ../src/guestfs-actions.pod:1534
8876 msgid "guestfs_file_architecture"
8881 #: ../src/guestfs-actions.pod:1536
8885 " guestfs_file_architecture (guestfs_h *g,\n"
8886 " const char *filename);\n"
8892 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1018
8894 "This detects the architecture of the binary C<filename>, and returns it if "
8900 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
8901 msgid "Currently defined architectures are:"
8906 #: ../src/guestfs-actions.pod:1547 ../fish/guestfish-actions.pod:1025
8912 #: ../src/guestfs-actions.pod:1549 ../fish/guestfish-actions.pod:1027
8914 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8915 "irrespective of the precise processor requirements of the binary."
8920 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
8926 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
8927 msgid "64 bit x86-64."
8932 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1034
8938 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1036
8939 msgid "32 bit SPARC."
8944 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1038
8950 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1040
8951 msgid "64 bit SPARC V9 and above."
8956 #: ../src/guestfs-actions.pod:1564 ../fish/guestfish-actions.pod:1042
8962 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1044
8963 msgid "Intel Itanium."
8968 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1046
8974 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1048
8975 msgid "32 bit Power PC."
8980 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1050
8986 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1052
8987 msgid "64 bit Power PC."
8992 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1056
8993 msgid "Libguestfs may return other architecture strings in future."
8998 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1058
8999 msgid "The function works on at least the following types of files:"
9004 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1064
9005 msgid "many types of Un*x and Linux binary"
9010 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1068
9011 msgid "many types of Un*x and Linux shared library"
9016 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1072
9017 msgid "Windows Win32 and Win64 binaries"
9022 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1076
9023 msgid "Windows Win32 and Win64 DLLs"
9028 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1078
9029 msgid "Win32 binaries and DLLs return C<i386>."
9034 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1080
9035 msgid "Win64 binaries and DLLs return C<x86_64>."
9040 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1084
9041 msgid "Linux kernel modules"
9046 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1088
9047 msgid "Linux new-style initrd images"
9052 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1092
9053 msgid "some non-x86 Linux vmlinuz kernels"
9058 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1096
9059 msgid "What it can't do currently:"
9064 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1102
9065 msgid "static libraries (libfoo.a)"
9070 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1106
9071 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9076 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1110
9077 msgid "x86 Linux vmlinuz kernels"
9082 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1112
9084 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9085 "compressed code, and are horribly hard to unpack. If you want to find the "
9086 "architecture of a kernel, use the architecture of the associated initrd or "
9087 "kernel module(s) instead."
9092 #: ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807
9093 #: ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:2505
9094 #: ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2612
9095 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2682
9096 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2803
9097 #: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:3038
9098 #: ../src/guestfs-actions.pod:3170
9099 msgid "(Added in 1.5.3)"
9104 #: ../src/guestfs-actions.pod:1646
9105 msgid "guestfs_filesize"
9110 #: ../src/guestfs-actions.pod:1648
9114 " guestfs_filesize (guestfs_h *g,\n"
9115 " const char *file);\n"
9121 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1123
9122 msgid "This command returns the size of C<file> in bytes."
9127 #: ../src/guestfs-actions.pod:1654
9129 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9130 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9131 "devices, use C<guestfs_blockdev_getsize64>."
9136 #: ../src/guestfs-actions.pod:1660
9137 msgid "(Added in 1.0.82)"
9142 #: ../src/guestfs-actions.pod:1662
9143 msgid "guestfs_fill"
9148 #: ../src/guestfs-actions.pod:1664
9152 " guestfs_fill (guestfs_h *g,\n"
9155 " const char *path);\n"
9161 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1133
9163 "This command creates a new file called C<path>. The initial content of the "
9164 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9170 #: ../src/guestfs-actions.pod:1674
9172 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9173 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9174 "bytes use C<guestfs_fill_pattern>."
9179 #: ../src/guestfs-actions.pod:1686
9180 msgid "(Added in 1.0.79)"
9185 #: ../src/guestfs-actions.pod:1688
9186 msgid "guestfs_fill_pattern"
9191 #: ../src/guestfs-actions.pod:1690
9195 " guestfs_fill_pattern (guestfs_h *g,\n"
9196 " const char *pattern,\n"
9198 " const char *path);\n"
9204 #: ../src/guestfs-actions.pod:1696
9206 "This function is like C<guestfs_fill> except that it creates a new file of "
9207 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9208 "pattern is truncated if necessary to ensure the length of the file is "
9209 "exactly C<len> bytes."
9214 #: ../src/guestfs-actions.pod:1708
9215 msgid "(Added in 1.3.12)"
9220 #: ../src/guestfs-actions.pod:1710
9221 msgid "guestfs_find"
9226 #: ../src/guestfs-actions.pod:1712
9230 " guestfs_find (guestfs_h *g,\n"
9231 " const char *directory);\n"
9237 #: ../src/guestfs-actions.pod:1716 ../fish/guestfish-actions.pod:1155
9239 "This command lists out all files and directories, recursively, starting at "
9240 "C<directory>. It is essentially equivalent to running the shell command "
9241 "C<find directory -print> but some post-processing happens on the output, "
9247 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
9249 "This returns a list of strings I<without any prefix>. Thus if the directory "
9255 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
9266 #: ../src/guestfs-actions.pod:1728
9268 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9273 #: ../src/guestfs-actions.pod:1731 ../fish/guestfish-actions.pod:1170
9285 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
9286 msgid "If C<directory> is not a directory, then this command returns an error."
9291 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
9292 msgid "The returned list is sorted."
9297 #: ../src/guestfs-actions.pod:1741
9298 msgid "See also C<guestfs_find0>."
9303 #: ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:3859
9304 #: ../src/guestfs-actions.pod:5399
9305 msgid "(Added in 1.0.27)"
9310 #: ../src/guestfs-actions.pod:1752
9311 msgid "guestfs_find0"
9316 #: ../src/guestfs-actions.pod:1754
9320 " guestfs_find0 (guestfs_h *g,\n"
9321 " const char *directory,\n"
9322 " const char *files);\n"
9328 #: ../src/guestfs-actions.pod:1759 ../fish/guestfish-actions.pod:1189
9330 "This command lists out all files and directories, recursively, starting at "
9331 "C<directory>, placing the resulting list in the external file called "
9337 #: ../src/guestfs-actions.pod:1763
9339 "This command works the same way as C<guestfs_find> with the following "
9345 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1200
9346 msgid "The resulting list is written to an external file."
9351 #: ../src/guestfs-actions.pod:1774 ../fish/guestfish-actions.pod:1204
9353 "Items (filenames) in the result are separated by C<\\0> characters. See "
9354 "L<find(1)> option I<-print0>."
9359 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
9360 msgid "This command is not limited in the number of names that it can return."
9365 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
9366 msgid "The result list is not sorted."
9371 #: ../src/guestfs-actions.pod:1790
9372 msgid "(Added in 1.0.74)"
9377 #: ../src/guestfs-actions.pod:1792
9378 msgid "guestfs_findfs_label"
9383 #: ../src/guestfs-actions.pod:1794
9387 " guestfs_findfs_label (guestfs_h *g,\n"
9388 " const char *label);\n"
9394 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1224
9396 "This command searches the filesystems and returns the one which has the "
9397 "given label. An error is returned if no such filesystem can be found."
9402 #: ../src/guestfs-actions.pod:1802
9403 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9408 #: ../src/guestfs-actions.pod:1809
9409 msgid "guestfs_findfs_uuid"
9414 #: ../src/guestfs-actions.pod:1811
9418 " guestfs_findfs_uuid (guestfs_h *g,\n"
9419 " const char *uuid);\n"
9425 #: ../src/guestfs-actions.pod:1815 ../fish/guestfish-actions.pod:1234
9427 "This command searches the filesystems and returns the one which has the "
9428 "given UUID. An error is returned if no such filesystem can be found."
9433 #: ../src/guestfs-actions.pod:1819
9434 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9439 #: ../src/guestfs-actions.pod:1826
9440 msgid "guestfs_fsck"
9445 #: ../src/guestfs-actions.pod:1828
9449 " guestfs_fsck (guestfs_h *g,\n"
9450 " const char *fstype,\n"
9451 " const char *device);\n"
9457 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1244
9459 "This runs the filesystem checker (fsck) on C<device> which should have "
9460 "filesystem type C<fstype>."
9465 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
9467 "The returned integer is the status. See L<fsck(8)> for the list of status "
9468 "codes from C<fsck>."
9473 #: ../src/guestfs-actions.pod:1845 ../fish/guestfish-actions.pod:1256
9474 msgid "Multiple status codes can be summed together."
9479 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1260
9481 "A non-zero return code can mean \"success\", for example if errors have been "
9482 "corrected on the filesystem."
9487 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
9488 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9493 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
9495 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9500 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:7046
9501 msgid "(Added in 1.0.16)"
9506 #: ../src/guestfs-actions.pod:1865
9507 msgid "guestfs_get_append"
9512 #: ../src/guestfs-actions.pod:1867
9516 " guestfs_get_append (guestfs_h *g);\n"
9522 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1276
9524 "Return the additional kernel options which are added to the guest kernel "
9530 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
9531 msgid "If C<NULL> then no options are added."
9536 #: ../src/guestfs-actions.pod:1875
9538 "This function returns a string which may be NULL. There is no way to return "
9539 "an error from this function. The string is owned by the guest handle and "
9540 "must I<not> be freed."
9545 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:5077
9546 #: ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5908
9547 #: ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:5943
9548 #: ../src/guestfs-actions.pod:5960 ../src/guestfs-actions.pod:6717
9549 #: ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:7089
9550 msgid "(Added in 1.0.26)"
9555 #: ../src/guestfs-actions.pod:1881
9556 msgid "guestfs_get_autosync"
9561 #: ../src/guestfs-actions.pod:1883
9565 " guestfs_get_autosync (guestfs_h *g);\n"
9571 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1285
9572 msgid "Get the autosync flag."
9577 #: ../src/guestfs-actions.pod:1892
9578 msgid "guestfs_get_direct"
9583 #: ../src/guestfs-actions.pod:1894
9587 " guestfs_get_direct (guestfs_h *g);\n"
9593 #: ../src/guestfs-actions.pod:1897 ../fish/guestfish-actions.pod:1291
9594 msgid "Return the direct appliance mode flag."
9599 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:5581
9600 msgid "(Added in 1.0.72)"
9605 #: ../src/guestfs-actions.pod:1903
9606 msgid "guestfs_get_e2label"
9611 #: ../src/guestfs-actions.pod:1905
9615 " guestfs_get_e2label (guestfs_h *g,\n"
9616 " const char *device);\n"
9622 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1297
9624 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9629 #: ../src/guestfs-actions.pod:1915 ../fish/guestfish-actions.pod:1300
9631 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9636 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1943
9637 #: ../src/guestfs-actions.pod:5599 ../src/guestfs-actions.pod:5618
9638 msgid "(Added in 1.0.15)"
9643 #: ../src/guestfs-actions.pod:1924
9644 msgid "guestfs_get_e2uuid"
9649 #: ../src/guestfs-actions.pod:1926
9653 " guestfs_get_e2uuid (guestfs_h *g,\n"
9654 " const char *device);\n"
9660 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1311
9662 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9667 #: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1314
9669 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9674 #: ../src/guestfs-actions.pod:1945
9675 msgid "guestfs_get_memsize"
9680 #: ../src/guestfs-actions.pod:1947
9684 " guestfs_get_memsize (guestfs_h *g);\n"
9690 #: ../src/guestfs-actions.pod:1950 ../fish/guestfish-actions.pod:1325
9692 "This gets the memory size in megabytes allocated to the qemu subprocess."
9697 #: ../src/guestfs-actions.pod:1953
9699 "If C<guestfs_set_memsize> was not called on this handle, and if "
9700 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9701 "value for memsize."
9706 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:2038
9707 #: ../src/guestfs-actions.pod:5634 ../src/guestfs-actions.pod:5741
9708 #: ../fish/guestfish-actions.pod:1332 ../fish/guestfish-actions.pod:1383
9709 #: ../fish/guestfish-actions.pod:3761 ../fish/guestfish-actions.pod:3848
9711 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9716 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:4150
9717 #: ../src/guestfs-actions.pod:4335 ../src/guestfs-actions.pod:4354
9718 #: ../src/guestfs-actions.pod:4373 ../src/guestfs-actions.pod:4385
9719 #: ../src/guestfs-actions.pod:4402 ../src/guestfs-actions.pod:4415
9720 #: ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5639
9721 #: ../src/guestfs-actions.pod:5882 ../src/guestfs-actions.pod:6483
9722 msgid "(Added in 1.0.55)"
9727 #: ../src/guestfs-actions.pod:1964
9728 msgid "guestfs_get_network"
9733 #: ../src/guestfs-actions.pod:1966
9737 " guestfs_get_network (guestfs_h *g);\n"
9743 #: ../src/guestfs-actions.pod:1969 ../fish/guestfish-actions.pod:1339
9744 msgid "This returns the enable network flag."
9749 #: ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:5658
9750 msgid "(Added in 1.5.4)"
9755 #: ../src/guestfs-actions.pod:1975
9756 msgid "guestfs_get_path"
9761 #: ../src/guestfs-actions.pod:1977
9765 " guestfs_get_path (guestfs_h *g);\n"
9771 #: ../src/guestfs-actions.pod:1980 ../fish/guestfish-actions.pod:1345
9772 msgid "Return the current search path."
9777 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1347
9779 "This is always non-NULL. If it wasn't set already, then this will return "
9785 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2014
9787 "This function returns a string, or NULL on error. The string is owned by "
9788 "the guest handle and must I<not> be freed."
9793 #: ../src/guestfs-actions.pod:1990
9794 msgid "guestfs_get_pid"
9799 #: ../src/guestfs-actions.pod:1992
9803 " guestfs_get_pid (guestfs_h *g);\n"
9809 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1356
9811 "Return the process ID of the qemu subprocess. If there is no qemu "
9812 "subprocess, then this will return an error."
9817 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
9818 msgid "This is an internal call used for debugging and testing."
9823 #: ../src/guestfs-actions.pod:2002
9824 msgid "(Added in 1.0.56)"
9829 #: ../src/guestfs-actions.pod:2004
9830 msgid "guestfs_get_qemu"
9835 #: ../src/guestfs-actions.pod:2006
9839 " guestfs_get_qemu (guestfs_h *g);\n"
9845 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1365
9846 msgid "Return the current qemu binary."
9851 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1367
9853 "This is always non-NULL. If it wasn't set already, then this will return "
9854 "the default qemu binary name."
9859 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:5703
9860 msgid "(Added in 1.0.6)"
9865 #: ../src/guestfs-actions.pod:2019
9866 msgid "guestfs_get_recovery_proc"
9871 #: ../src/guestfs-actions.pod:2021
9875 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9881 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1374
9882 msgid "Return the recovery process enabled flag."
9887 #: ../src/guestfs-actions.pod:2028 ../src/guestfs-actions.pod:3260
9888 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3957
9889 #: ../src/guestfs-actions.pod:3989 ../src/guestfs-actions.pod:5007
9890 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5727
9891 #: ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6406
9892 #: ../src/guestfs-actions.pod:6598
9893 msgid "(Added in 1.0.77)"
9898 #: ../src/guestfs-actions.pod:2030
9899 msgid "guestfs_get_selinux"
9904 #: ../src/guestfs-actions.pod:2032
9908 " guestfs_get_selinux (guestfs_h *g);\n"
9914 #: ../src/guestfs-actions.pod:2035
9916 "This returns the current setting of the selinux flag which is passed to the "
9917 "appliance at boot time. See C<guestfs_set_selinux>."
9922 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:2106
9923 #: ../src/guestfs-actions.pod:5746 ../src/guestfs-actions.pod:5800
9924 msgid "(Added in 1.0.67)"
9929 #: ../src/guestfs-actions.pod:2045
9930 msgid "guestfs_get_state"
9935 #: ../src/guestfs-actions.pod:2047
9939 " guestfs_get_state (guestfs_h *g);\n"
9945 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9947 "This returns the current state as an opaque integer. This is only useful "
9948 "for printing debug and internal error messages."
9953 #: ../src/guestfs-actions.pod:2053 ../src/guestfs-actions.pod:3063
9954 #: ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3153
9955 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:1393
9956 #: ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2150
9957 #: ../fish/guestfish-actions.pod:2188 ../fish/guestfish-actions.pod:2204
9958 msgid "For more information on states, see L<guestfs(3)>."
9963 #: ../src/guestfs-actions.pod:2059
9964 msgid "guestfs_get_trace"
9969 #: ../src/guestfs-actions.pod:2061
9973 " guestfs_get_trace (guestfs_h *g);\n"
9979 #: ../src/guestfs-actions.pod:2064 ../fish/guestfish-actions.pod:1399
9980 msgid "Return the command trace flag."
9985 #: ../src/guestfs-actions.pod:2070
9986 msgid "guestfs_get_umask"
9991 #: ../src/guestfs-actions.pod:2072
9995 " guestfs_get_umask (guestfs_h *g);\n"
10001 #: ../src/guestfs-actions.pod:2075
10003 "Return the current umask. By default the umask is C<022> unless it has been "
10004 "set by calling C<guestfs_umask>."
10009 #: ../src/guestfs-actions.pod:2082
10010 msgid "guestfs_get_verbose"
10015 #: ../src/guestfs-actions.pod:2084
10019 " guestfs_get_verbose (guestfs_h *g);\n"
10025 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
10026 msgid "This returns the verbose messages flag."
10031 #: ../src/guestfs-actions.pod:2093
10032 msgid "guestfs_getcon"
10037 #: ../src/guestfs-actions.pod:2095
10041 " guestfs_getcon (guestfs_h *g);\n"
10047 #: ../src/guestfs-actions.pod:2098 ../fish/guestfish-actions.pod:1418
10048 msgid "This gets the SELinux security context of the daemon."
10053 #: ../src/guestfs-actions.pod:2100
10055 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10060 #: ../src/guestfs-actions.pod:2108
10061 msgid "guestfs_getxattr"
10066 #: ../src/guestfs-actions.pod:2110
10070 " guestfs_getxattr (guestfs_h *g,\n"
10071 " const char *path,\n"
10072 " const char *name,\n"
10073 " size_t *size_r);\n"
10079 #: ../src/guestfs-actions.pod:2116
10081 "Get a single extended attribute from file C<path> named C<name>. This call "
10082 "follows symlinks. If you want to lookup an extended attribute for the "
10083 "symlink itself, use C<guestfs_lgetxattr>."
10088 #: ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:3274
10090 "Normally it is better to get all extended attributes from a file in one go "
10091 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10092 "implementations are buggy and do not provide a way to list out attributes. "
10093 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10094 "extended attributes you want in advance and call this function."
10099 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3281
10100 #: ../fish/guestfish-actions.pod:1438 ../fish/guestfish-actions.pod:2269
10102 "Extended attribute values are blobs of binary data. If there is no extended "
10103 "attribute named C<name>, this returns an error."
10108 #: ../src/guestfs-actions.pod:2130
10109 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10114 #: ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:2323
10115 #: ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:5000
10116 #: ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:5207
10118 "This function returns a buffer, or NULL on error. The size of the returned "
10119 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10124 #: ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:3290
10125 msgid "(Added in 1.7.24)"
10130 #: ../src/guestfs-actions.pod:2138
10131 msgid "guestfs_getxattrs"
10136 #: ../src/guestfs-actions.pod:2140
10139 " struct guestfs_xattr_list *\n"
10140 " guestfs_getxattrs (guestfs_h *g,\n"
10141 " const char *path);\n"
10147 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1447
10149 "This call lists the extended attributes of the file or directory C<path>."
10154 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
10156 "At the system call level, this is a combination of the L<listxattr(2)> and "
10157 "L<getxattr(2)> calls."
10162 #: ../src/guestfs-actions.pod:2150
10163 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10168 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3302
10169 #: ../src/guestfs-actions.pod:3953
10171 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10172 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10177 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3306
10178 #: ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3507
10179 #: ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5819
10180 #: ../src/guestfs-actions.pod:7154
10181 msgid "(Added in 1.0.59)"
10186 #: ../src/guestfs-actions.pod:2158
10187 msgid "guestfs_glob_expand"
10192 #: ../src/guestfs-actions.pod:2160
10196 " guestfs_glob_expand (guestfs_h *g,\n"
10197 " const char *pattern);\n"
10203 #: ../src/guestfs-actions.pod:2164 ../fish/guestfish-actions.pod:1459
10205 "This command searches for all the pathnames matching C<pattern> according to "
10206 "the wildcard expansion rules used by the shell."
10211 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1463
10213 "If no paths match, then this returns an empty list (note: not an error)."
10218 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
10220 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10221 "GLOB_BRACE>. See that manual page for more details."
10226 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:5984
10227 #: ../src/guestfs-actions.pod:6001
10228 msgid "(Added in 1.0.50)"
10233 #: ../src/guestfs-actions.pod:2181
10234 msgid "guestfs_grep"
10239 #: ../src/guestfs-actions.pod:2183
10243 " guestfs_grep (guestfs_h *g,\n"
10244 " const char *regex,\n"
10245 " const char *path);\n"
10251 #: ../src/guestfs-actions.pod:2188 ../fish/guestfish-actions.pod:1474
10252 msgid "This calls the external C<grep> program and returns the matching lines."
10257 #: ../src/guestfs-actions.pod:2200
10258 msgid "guestfs_grepi"
10263 #: ../src/guestfs-actions.pod:2202
10267 " guestfs_grepi (guestfs_h *g,\n"
10268 " const char *regex,\n"
10269 " const char *path);\n"
10275 #: ../src/guestfs-actions.pod:2207 ../fish/guestfish-actions.pod:1484
10277 "This calls the external C<grep -i> program and returns the matching lines."
10282 #: ../src/guestfs-actions.pod:2219
10283 msgid "guestfs_grub_install"
10288 #: ../src/guestfs-actions.pod:2221
10292 " guestfs_grub_install (guestfs_h *g,\n"
10293 " const char *root,\n"
10294 " const char *device);\n"
10300 #: ../src/guestfs-actions.pod:2226 ../fish/guestfish-actions.pod:1494
10302 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10303 "the root directory being C<root>."
10308 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
10310 "Note: If grub-install reports the error \"No suitable drive was found in the "
10311 "generated device map.\" it may be that you need to create a C</boot/grub/"
10312 "device.map> file first that contains the mapping between grub device names "
10313 "and Linux device names. It is usually sufficient to create a file "
10319 #: ../src/guestfs-actions.pod:2236 ../fish/guestfish-actions.pod:1504
10322 " (hd0) /dev/vda\n"
10328 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1506
10329 msgid "replacing C</dev/vda> with the name of the installation device."
10334 #: ../src/guestfs-actions.pod:2242
10335 msgid "(Added in 1.0.17)"
10340 #: ../src/guestfs-actions.pod:2244
10341 msgid "guestfs_head"
10346 #: ../src/guestfs-actions.pod:2246
10350 " guestfs_head (guestfs_h *g,\n"
10351 " const char *path);\n"
10357 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1512
10359 "This command returns up to the first 10 lines of a file as a list of strings."
10364 #: ../src/guestfs-actions.pod:2262
10365 msgid "guestfs_head_n"
10370 #: ../src/guestfs-actions.pod:2264
10374 " guestfs_head_n (guestfs_h *g,\n"
10376 " const char *path);\n"
10382 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1522
10384 "If the parameter C<nrlines> is a positive number, this returns the first "
10385 "C<nrlines> lines of the file C<path>."
10390 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
10392 "If the parameter C<nrlines> is a negative number, this returns lines from "
10393 "the file C<path>, excluding the last C<nrlines> lines."
10398 #: ../src/guestfs-actions.pod:2275 ../src/guestfs-actions.pod:6281
10399 #: ../fish/guestfish-actions.pod:1528 ../fish/guestfish-actions.pod:4194
10400 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10405 #: ../src/guestfs-actions.pod:2286
10406 msgid "guestfs_hexdump"
10411 #: ../src/guestfs-actions.pod:2288
10415 " guestfs_hexdump (guestfs_h *g,\n"
10416 " const char *path);\n"
10422 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1537
10424 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10425 "readable, canonical hex dump of the file."
10430 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6065
10431 #: ../src/guestfs-actions.pod:6120
10432 msgid "(Added in 1.0.22)"
10437 #: ../src/guestfs-actions.pod:2303
10438 msgid "guestfs_initrd_cat"
10443 #: ../src/guestfs-actions.pod:2305
10447 " guestfs_initrd_cat (guestfs_h *g,\n"
10448 " const char *initrdpath,\n"
10449 " const char *filename,\n"
10450 " size_t *size_r);\n"
10456 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1547
10458 "This command unpacks the file C<filename> from the initrd file called "
10459 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10465 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1551
10467 "For example, in guestfish you could use the following command to examine the "
10468 "boot script (usually called C</init>) contained in a Linux initrd or "
10474 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1555
10477 " initrd-cat /boot/initrd-<version>.img init\n"
10483 #: ../src/guestfs-actions.pod:2321
10484 msgid "See also C<guestfs_initrd_list>."
10489 #: ../src/guestfs-actions.pod:2332
10490 msgid "guestfs_initrd_list"
10495 #: ../src/guestfs-actions.pod:2334
10499 " guestfs_initrd_list (guestfs_h *g,\n"
10500 " const char *path);\n"
10506 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1566
10507 msgid "This command lists out files contained in an initrd."
10512 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1568
10514 "The files are listed without any initial C</> character. The files are "
10515 "listed in the order they appear (not necessarily alphabetical). Directory "
10516 "names are listed as separate items."
10521 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1572
10523 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10524 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10530 #: ../src/guestfs-actions.pod:2354
10531 msgid "guestfs_inotify_add_watch"
10536 #: ../src/guestfs-actions.pod:2356
10540 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10541 " const char *path,\n"
10548 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1580
10549 msgid "Watch C<path> for the events listed in C<mask>."
10554 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1582
10556 "Note that if C<path> is a directory then events within that directory are "
10557 "watched, but this does I<not> happen recursively (in subdirectories)."
10562 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1586
10564 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10565 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10570 #: ../src/guestfs-actions.pod:2375
10571 msgid "guestfs_inotify_close"
10576 #: ../src/guestfs-actions.pod:2377
10580 " guestfs_inotify_close (guestfs_h *g);\n"
10586 #: ../src/guestfs-actions.pod:2380 ../fish/guestfish-actions.pod:1594
10588 "This closes the inotify handle which was previously opened by inotify_init. "
10589 "It removes all watches, throws away any pending events, and deallocates all "
10595 #: ../src/guestfs-actions.pod:2388
10596 msgid "guestfs_inotify_files"
10601 #: ../src/guestfs-actions.pod:2390
10605 " guestfs_inotify_files (guestfs_h *g);\n"
10611 #: ../src/guestfs-actions.pod:2393
10613 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10614 "returns a list of pathnames of objects that were touched. The returned "
10615 "pathnames are sorted and deduplicated."
10620 #: ../src/guestfs-actions.pod:2403
10621 msgid "guestfs_inotify_init"
10626 #: ../src/guestfs-actions.pod:2405
10630 " guestfs_inotify_init (guestfs_h *g,\n"
10631 " int maxevents);\n"
10637 #: ../src/guestfs-actions.pod:2409 ../fish/guestfish-actions.pod:1610
10639 "This command creates a new inotify handle. The inotify subsystem can be "
10640 "used to notify events which happen to objects in the guest filesystem."
10645 #: ../src/guestfs-actions.pod:2413
10647 "C<maxevents> is the maximum number of events which will be queued up between "
10648 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10649 "passed as C<0>, then the kernel (or previously set) default is used. For "
10650 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10651 "throws away events, but records the fact that it threw them away by setting "
10652 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10653 "C<guestfs_inotify_read>)."
10658 #: ../src/guestfs-actions.pod:2423
10660 "Before any events are generated, you have to add some watches to the "
10661 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10662 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10667 #: ../src/guestfs-actions.pod:2429
10669 "Queued up events should be read periodically by calling "
10670 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10671 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10672 "often enough then you risk the internal queue overflowing."
10677 #: ../src/guestfs-actions.pod:2436
10679 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10680 "This also removes any watches automatically."
10685 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1641
10687 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10688 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10689 "that there is one global inotify handle per libguestfs instance."
10694 #: ../src/guestfs-actions.pod:2449
10695 msgid "guestfs_inotify_read"
10700 #: ../src/guestfs-actions.pod:2451
10703 " struct guestfs_inotify_event_list *\n"
10704 " guestfs_inotify_read (guestfs_h *g);\n"
10710 #: ../src/guestfs-actions.pod:2454 ../fish/guestfish-actions.pod:1650
10712 "Return the complete queue of events that have happened since the previous "
10718 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
10719 msgid "If no events have happened, this returns an empty list."
10724 #: ../src/guestfs-actions.pod:2459 ../fish/guestfish-actions.pod:1655
10726 "I<Note>: In order to make sure that all events have been read, you must call "
10727 "this function repeatedly until it returns an empty list. The reason is that "
10728 "the call will read events up to the maximum appliance-to-host message size "
10729 "and leave remaining events in the queue."
10734 #: ../src/guestfs-actions.pod:2465
10736 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10737 "there was an error. I<The caller must call "
10738 "C<guestfs_free_inotify_event_list> after use>."
10743 #: ../src/guestfs-actions.pod:2471
10744 msgid "guestfs_inotify_rm_watch"
10749 #: ../src/guestfs-actions.pod:2473
10753 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10760 #: ../src/guestfs-actions.pod:2477
10762 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10767 #: ../src/guestfs-actions.pod:2484
10768 msgid "guestfs_inspect_get_arch"
10773 #: ../src/guestfs-actions.pod:2486
10777 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10778 " const char *root);\n"
10784 #: ../src/guestfs-actions.pod:2490 ../src/guestfs-actions.pod:2513
10785 #: ../src/guestfs-actions.pod:2594 ../src/guestfs-actions.pod:2620
10786 #: ../src/guestfs-actions.pod:2642 ../src/guestfs-actions.pod:2669
10787 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2727
10788 #: ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:2787
10789 #: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2873
10790 #: ../src/guestfs-actions.pod:2896
10792 "This function should only be called with a root device string as returned by "
10793 "C<guestfs_inspect_os>."
10798 #: ../src/guestfs-actions.pod:2493
10800 "This returns the architecture of the inspected operating system. The "
10801 "possible return values are listed under C<guestfs_file_architecture>."
10806 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1679
10808 "If the architecture could not be determined, then the string C<unknown> is "
10814 #: ../src/guestfs-actions.pod:2500 ../src/guestfs-actions.pod:2581
10815 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2657
10816 #: ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2774
10817 #: ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:2817
10818 #: ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2883
10819 #: ../src/guestfs-actions.pod:2989 ../src/guestfs-actions.pod:3030
10820 #: ../fish/guestfish-actions.pod:1682 ../fish/guestfish-actions.pod:1756
10821 #: ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1810
10822 #: ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:1898
10823 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1928
10824 #: ../fish/guestfish-actions.pod:1963 ../fish/guestfish-actions.pod:1979
10825 #: ../fish/guestfish-actions.pod:2078 ../fish/guestfish-actions.pod:2112
10826 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10831 #: ../src/guestfs-actions.pod:2507
10832 msgid "guestfs_inspect_get_distro"
10837 #: ../src/guestfs-actions.pod:2509
10841 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10842 " const char *root);\n"
10848 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1691
10850 "This returns the distro (distribution) of the inspected operating system."
10855 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
10856 msgid "Currently defined distros are:"
10861 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1698
10862 msgid "\"archlinux\""
10867 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1700
10868 msgid "Arch Linux."
10873 #: ../src/guestfs-actions.pod:2527 ../fish/guestfish-actions.pod:1702
10879 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1704
10885 #: ../src/guestfs-actions.pod:2531 ../fish/guestfish-actions.pod:1706
10891 #: ../src/guestfs-actions.pod:2533 ../fish/guestfish-actions.pod:1708
10897 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1710
10903 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1712
10909 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1714
10910 msgid "\"linuxmint\""
10915 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1716
10916 msgid "Linux Mint."
10921 #: ../src/guestfs-actions.pod:2543 ../fish/guestfish-actions.pod:1718
10922 msgid "\"mandriva\""
10927 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1720
10933 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1722
10939 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1724
10945 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1726
10951 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1728
10957 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1730
10958 msgid "\"redhat-based\""
10963 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1732
10964 msgid "Some Red Hat-derived distro."
10969 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1734
10975 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1736
10976 msgid "Red Hat Enterprise Linux and some derivatives."
10981 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1738
10987 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1740
10993 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2851
10994 #: ../fish/guestfish-actions.pod:1742 ../fish/guestfish-actions.pod:1954
10995 msgid "\"unknown\""
11000 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1744
11001 msgid "The distro could not be determined."
11006 #: ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:2843
11007 #: ../fish/guestfish-actions.pod:1746 ../fish/guestfish-actions.pod:1946
11008 msgid "\"windows\""
11013 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1748
11015 "Windows does not have distributions. This string is returned if the OS type "
11021 #: ../src/guestfs-actions.pod:2578 ../src/guestfs-actions.pod:2857
11022 #: ../fish/guestfish-actions.pod:1753 ../fish/guestfish-actions.pod:1960
11024 "Future versions of libguestfs may return other strings here. The caller "
11025 "should be prepared to handle any string."
11030 #: ../src/guestfs-actions.pod:2588
11031 msgid "guestfs_inspect_get_filesystems"
11036 #: ../src/guestfs-actions.pod:2590
11040 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11041 " const char *root);\n"
11047 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1765
11049 "This returns a list of all the filesystems that we think are associated with "
11050 "this operating system. This includes the root filesystem, other ordinary "
11051 "filesystems, and non-mounted devices like swap partitions."
11056 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1770
11058 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11059 "to be shared between operating systems."
11064 #: ../src/guestfs-actions.pod:2605
11066 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11067 "C<guestfs_inspect_get_mountpoints>."
11072 #: ../src/guestfs-actions.pod:2614
11073 msgid "guestfs_inspect_get_hostname"
11078 #: ../src/guestfs-actions.pod:2616
11082 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11083 " const char *root);\n"
11089 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1783
11091 "This function returns the hostname of the operating system as found by "
11092 "inspection of the guest's configuration files."
11097 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
11099 "If the hostname could not be determined, then the string C<unknown> is "
11105 #: ../src/guestfs-actions.pod:2634
11106 msgid "(Added in 1.7.9)"
11111 #: ../src/guestfs-actions.pod:2636
11112 msgid "guestfs_inspect_get_major_version"
11117 #: ../src/guestfs-actions.pod:2638
11121 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11122 " const char *root);\n"
11128 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1798
11130 "This returns the major version number of the inspected operating system."
11135 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
11137 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11138 "popular public names used by the operating system. Notably the operating "
11139 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11140 "1). You can find out the real versions corresponding to releases of Windows "
11141 "by consulting Wikipedia or MSDN."
11146 #: ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:2675
11147 #: ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1822
11148 msgid "If the version could not be determined, then C<0> is returned."
11153 #: ../src/guestfs-actions.pod:2663
11154 msgid "guestfs_inspect_get_minor_version"
11159 #: ../src/guestfs-actions.pod:2665
11163 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11164 " const char *root);\n"
11170 #: ../src/guestfs-actions.pod:2672 ../fish/guestfish-actions.pod:1819
11172 "This returns the minor version number of the inspected operating system."
11177 #: ../src/guestfs-actions.pod:2677
11179 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11180 "C<guestfs_inspect_get_major_version>."
11185 #: ../src/guestfs-actions.pod:2684
11186 msgid "guestfs_inspect_get_mountpoints"
11191 #: ../src/guestfs-actions.pod:2686
11195 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11196 " const char *root);\n"
11201 #: ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:1834
11203 "This returns a hash of where we think the filesystems associated with this "
11204 "operating system should be mounted. Callers should note that this is at "
11205 "best an educated guess made by reading configuration files such as C</etc/"
11206 "fstab>. I<In particular note> that this may return filesystems which are "
11207 "non-existent or not mountable and callers should be prepared to handle or "
11208 "ignore failures if they try to mount them."
11213 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1843
11215 "Each element in the returned hashtable has a key which is the path of the "
11216 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11217 "mounted there (eg. C</dev/sda1>)."
11222 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
11224 "Non-mounted devices such as swap devices are I<not> returned in this list."
11229 #: ../src/guestfs-actions.pod:2710
11231 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11232 "C<guestfs_inspect_get_filesystems>."
11237 #: ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3359
11238 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:6422
11240 "This function returns a NULL-terminated array of strings, or NULL if there "
11241 "was an error. The array of strings will always have length C<2n+1>, where "
11242 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11243 "caller must free the strings and the array after use>."
11248 #: ../src/guestfs-actions.pod:2721
11249 msgid "guestfs_inspect_get_package_format"
11254 #: ../src/guestfs-actions.pod:2723
11258 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11259 " const char *root);\n"
11265 #: ../src/guestfs-actions.pod:2730
11267 "This function and C<guestfs_inspect_get_package_management> return the "
11268 "package format and package management tool used by the inspected operating "
11269 "system. For example for Fedora these functions would return C<rpm> (package "
11270 "format) and C<yum> (package management)."
11275 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1867
11277 "This returns the string C<unknown> if we could not determine the package "
11278 "format I<or> if the operating system does not have a real packaging system "
11284 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1871
11286 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11287 "Future versions of libguestfs may return other strings."
11292 #: ../src/guestfs-actions.pod:2748 ../src/guestfs-actions.pod:2779
11293 msgid "(Added in 1.7.5)"
11298 #: ../src/guestfs-actions.pod:2750
11299 msgid "guestfs_inspect_get_package_management"
11304 #: ../src/guestfs-actions.pod:2752
11308 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11309 " const char *root);\n"
11315 #: ../src/guestfs-actions.pod:2759
11317 "C<guestfs_inspect_get_package_format> and this function return the package "
11318 "format and package management tool used by the inspected operating system. "
11319 "For example for Fedora these functions would return C<rpm> (package format) "
11320 "and C<yum> (package management)."
11325 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1889
11327 "This returns the string C<unknown> if we could not determine the package "
11328 "management tool I<or> if the operating system does not have a real packaging "
11329 "system (eg. Windows)."
11334 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1893
11336 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11337 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11338 "libguestfs may return other strings."
11343 #: ../src/guestfs-actions.pod:2781
11344 msgid "guestfs_inspect_get_product_name"
11349 #: ../src/guestfs-actions.pod:2783
11353 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11354 " const char *root);\n"
11360 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1907
11362 "This returns the product name of the inspected operating system. The "
11363 "product name is generally some freeform string which can be displayed to the "
11364 "user, but should not be parsed by programs."
11369 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1912
11371 "If the product name could not be determined, then the string C<unknown> is "
11377 #: ../src/guestfs-actions.pod:2805
11378 msgid "guestfs_inspect_get_roots"
11383 #: ../src/guestfs-actions.pod:2807
11387 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11393 #: ../src/guestfs-actions.pod:2810
11395 "This function is a convenient way to get the list of root devices, as "
11396 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11397 "the whole inspection process."
11402 #: ../src/guestfs-actions.pod:2814
11404 "This returns an empty list if either no root devices were found or the "
11405 "caller has not called C<guestfs_inspect_os>."
11410 #: ../src/guestfs-actions.pod:2823
11411 msgid "(Added in 1.7.3)"
11416 #: ../src/guestfs-actions.pod:2825
11417 msgid "guestfs_inspect_get_type"
11422 #: ../src/guestfs-actions.pod:2827
11426 " guestfs_inspect_get_type (guestfs_h *g,\n"
11427 " const char *root);\n"
11433 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1937
11435 "This returns the type of the inspected operating system. Currently defined "
11441 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1942
11447 #: ../src/guestfs-actions.pod:2841 ../fish/guestfish-actions.pod:1944
11448 msgid "Any Linux-based operating system."
11453 #: ../src/guestfs-actions.pod:2845 ../fish/guestfish-actions.pod:1948
11454 msgid "Any Microsoft Windows operating system."
11459 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1950
11460 msgid "\"freebsd\""
11465 #: ../src/guestfs-actions.pod:2849 ../fish/guestfish-actions.pod:1952
11471 #: ../src/guestfs-actions.pod:2853 ../fish/guestfish-actions.pod:1956
11472 msgid "The operating system type could not be determined."
11477 #: ../src/guestfs-actions.pod:2867
11478 msgid "guestfs_inspect_get_windows_systemroot"
11483 #: ../src/guestfs-actions.pod:2869
11487 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11488 " const char *root);\n"
11494 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1972
11496 "This returns the Windows systemroot of the inspected guest. The systemroot "
11497 "is a directory path such as C</WINDOWS>."
11502 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1975
11504 "This call assumes that the guest is Windows and that the systemroot could be "
11505 "determined by inspection. If this is not the case then an error is returned."
11510 #: ../src/guestfs-actions.pod:2888
11511 msgid "(Added in 1.5.25)"
11516 #: ../src/guestfs-actions.pod:2890
11517 msgid "guestfs_inspect_list_applications"
11522 #: ../src/guestfs-actions.pod:2892
11525 " struct guestfs_application_list *\n"
11526 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11527 " const char *root);\n"
11533 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1988
11534 msgid "Return the list of applications installed in the operating system."
11539 #: ../src/guestfs-actions.pod:2901
11541 "I<Note:> This call works differently from other parts of the inspection "
11542 "API. You have to call C<guestfs_inspect_os>, then "
11543 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11544 "this. Listing applications is a significantly more difficult operation "
11545 "which requires access to the full filesystem. Also note that unlike the "
11546 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11547 "the libguestfs handle, this call actually reads parts of the mounted "
11548 "filesystems during the call."
11553 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:2000
11555 "This returns an empty list if the inspection code was not able to determine "
11556 "the list of applications."
11561 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2003
11562 msgid "The application structure contains the following fields:"
11567 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2007
11568 msgid "C<app_name>"
11573 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2009
11575 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11576 "guests, this is the package name."
11581 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
11582 msgid "C<app_display_name>"
11587 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2014
11589 "The display name of the application, sometimes localized to the install "
11590 "language of the guest operating system."
11595 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
11597 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11598 "to display something can use C<app_name> instead."
11603 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2020
11604 msgid "C<app_epoch>"
11609 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2022
11611 "For package managers which use epochs, this contains the epoch of the "
11612 "package (an integer). If unavailable, this is returned as C<0>."
11617 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
11618 msgid "C<app_version>"
11623 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2027
11625 "The version string of the application or package. If unavailable this is "
11626 "returned as an empty string C<\"\">."
11631 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
11632 msgid "C<app_release>"
11637 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2032
11639 "The release string of the application or package, for package managers that "
11640 "use this. If unavailable this is returned as an empty string C<\"\">."
11645 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2036
11646 msgid "C<app_install_path>"
11651 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2038
11653 "The installation path of the application (on operating systems such as "
11654 "Windows which use installation paths). This path is in the format used by "
11655 "the guest operating system, it is not a libguestfs path."
11660 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2043
11661 msgid "If unavailable this is returned as an empty string C<\"\">."
11666 #: ../src/guestfs-actions.pod:2956 ../fish/guestfish-actions.pod:2045
11667 msgid "C<app_trans_path>"
11672 #: ../src/guestfs-actions.pod:2958 ../fish/guestfish-actions.pod:2047
11674 "The install path translated into a libguestfs path. If unavailable this is "
11675 "returned as an empty string C<\"\">."
11680 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
11681 msgid "C<app_publisher>"
11686 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2052
11688 "The name of the publisher of the application, for package managers that use "
11689 "this. If unavailable this is returned as an empty string C<\"\">."
11694 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2056
11700 #: ../src/guestfs-actions.pod:2969 ../fish/guestfish-actions.pod:2058
11702 "The URL (eg. upstream URL) of the application. If unavailable this is "
11703 "returned as an empty string C<\"\">."
11708 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
11709 msgid "C<app_source_package>"
11714 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2063
11716 "For packaging systems which support this, the name of the source package. "
11717 "If unavailable this is returned as an empty string C<\"\">."
11722 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
11723 msgid "C<app_summary>"
11728 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2068
11730 "A short (usually one line) description of the application or package. If "
11731 "unavailable this is returned as an empty string C<\"\">."
11736 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
11737 msgid "C<app_description>"
11742 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2073
11744 "A longer description of the application or package. If unavailable this is "
11745 "returned as an empty string C<\"\">."
11750 #: ../src/guestfs-actions.pod:2991
11752 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11753 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11759 #: ../src/guestfs-actions.pod:2995
11760 msgid "(Added in 1.7.8)"
11765 #: ../src/guestfs-actions.pod:2997
11766 msgid "guestfs_inspect_os"
11771 #: ../src/guestfs-actions.pod:2999
11775 " guestfs_inspect_os (guestfs_h *g);\n"
11781 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2084
11783 "This function uses other libguestfs functions and certain heuristics to "
11784 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11785 "for operating systems."
11790 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2088
11791 msgid "The list returned is empty if no operating systems were found."
11796 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2090
11798 "If one operating system was found, then this returns a list with a single "
11799 "element, which is the name of the root filesystem of this operating system. "
11800 "It is also possible for this function to return a list containing more than "
11801 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11802 "element being the root filesystem of one of the operating systems."
11807 #: ../src/guestfs-actions.pod:3015
11809 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11810 "functions in order to query further information about each operating system, "
11811 "such as the name and version."
11816 #: ../src/guestfs-actions.pod:3020
11818 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11819 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11820 "the contents. This should be called with no disks currently mounted. The "
11821 "function may also use Augeas, so any existing Augeas handle will be closed."
11826 #: ../src/guestfs-actions.pod:3026 ../fish/guestfish-actions.pod:2108
11828 "This function cannot decrypt encrypted disks. The caller must do that first "
11829 "(supplying the necessary keys) if the disk is encrypted."
11834 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3317
11835 #: ../src/guestfs-actions.pod:3379
11836 msgid "See also C<guestfs_list_filesystems>."
11841 #: ../src/guestfs-actions.pod:3040
11842 msgid "guestfs_is_blockdev"
11847 #: ../src/guestfs-actions.pod:3042
11851 " guestfs_is_blockdev (guestfs_h *g,\n"
11852 " const char *path);\n"
11858 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2120
11860 "This returns C<true> if and only if there is a block device with the given "
11866 #: ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3078
11867 #: ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3123
11868 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3195
11869 #: ../src/guestfs-actions.pod:3210
11870 msgid "See also C<guestfs_stat>."
11875 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3082
11876 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3199
11877 #: ../src/guestfs-actions.pod:3214
11878 msgid "(Added in 1.5.10)"
11883 #: ../src/guestfs-actions.pod:3055
11884 msgid "guestfs_is_busy"
11889 #: ../src/guestfs-actions.pod:3057
11893 " guestfs_is_busy (guestfs_h *g);\n"
11899 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2129
11901 "This returns true iff this handle is busy processing a command (in the "
11907 #: ../src/guestfs-actions.pod:3069
11908 msgid "guestfs_is_chardev"
11913 #: ../src/guestfs-actions.pod:3071
11917 " guestfs_is_chardev (guestfs_h *g,\n"
11918 " const char *path);\n"
11924 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2138
11926 "This returns C<true> if and only if there is a character device with the "
11927 "given C<path> name."
11932 #: ../src/guestfs-actions.pod:3084
11933 msgid "guestfs_is_config"
11938 #: ../src/guestfs-actions.pod:3086
11942 " guestfs_is_config (guestfs_h *g);\n"
11948 #: ../src/guestfs-actions.pod:3089 ../fish/guestfish-actions.pod:2147
11950 "This returns true iff this handle is being configured (in the C<CONFIG> "
11956 #: ../src/guestfs-actions.pod:3098
11957 msgid "guestfs_is_dir"
11962 #: ../src/guestfs-actions.pod:3100
11966 " guestfs_is_dir (guestfs_h *g,\n"
11967 " const char *path);\n"
11973 #: ../src/guestfs-actions.pod:3104 ../fish/guestfish-actions.pod:2156
11975 "This returns C<true> if and only if there is a directory with the given "
11976 "C<path> name. Note that it returns false for other objects like files."
11981 #: ../src/guestfs-actions.pod:3114
11982 msgid "guestfs_is_fifo"
11987 #: ../src/guestfs-actions.pod:3116
11991 " guestfs_is_fifo (guestfs_h *g,\n"
11992 " const char *path);\n"
11998 #: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2166
12000 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12001 "given C<path> name."
12006 #: ../src/guestfs-actions.pod:3129
12007 msgid "guestfs_is_file"
12012 #: ../src/guestfs-actions.pod:3131
12016 " guestfs_is_file (guestfs_h *g,\n"
12017 " const char *path);\n"
12023 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2175
12025 "This returns C<true> if and only if there is a regular file with the given "
12026 "C<path> name. Note that it returns false for other objects like directories."
12031 #: ../src/guestfs-actions.pod:3145
12032 msgid "guestfs_is_launching"
12037 #: ../src/guestfs-actions.pod:3147
12041 " guestfs_is_launching (guestfs_h *g);\n"
12047 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2185
12049 "This returns true iff this handle is launching the subprocess (in the "
12050 "C<LAUNCHING> state)."
12055 #: ../src/guestfs-actions.pod:3159
12056 msgid "guestfs_is_lv"
12061 #: ../src/guestfs-actions.pod:3161
12065 " guestfs_is_lv (guestfs_h *g,\n"
12066 " const char *device);\n"
12072 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2194
12074 "This command tests whether C<device> is a logical volume, and returns true "
12075 "iff this is the case."
12080 #: ../src/guestfs-actions.pod:3172
12081 msgid "guestfs_is_ready"
12086 #: ../src/guestfs-actions.pod:3174
12090 " guestfs_is_ready (guestfs_h *g);\n"
12096 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2201
12098 "This returns true iff this handle is ready to accept commands (in the "
12104 #: ../src/guestfs-actions.pod:3186
12105 msgid "guestfs_is_socket"
12110 #: ../src/guestfs-actions.pod:3188
12114 " guestfs_is_socket (guestfs_h *g,\n"
12115 " const char *path);\n"
12121 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2210
12123 "This returns C<true> if and only if there is a Unix domain socket with the "
12124 "given C<path> name."
12129 #: ../src/guestfs-actions.pod:3201
12130 msgid "guestfs_is_symlink"
12135 #: ../src/guestfs-actions.pod:3203
12139 " guestfs_is_symlink (guestfs_h *g,\n"
12140 " const char *path);\n"
12146 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2219
12148 "This returns C<true> if and only if there is a symbolic link with the given "
12154 #: ../src/guestfs-actions.pod:3216
12155 msgid "guestfs_kill_subprocess"
12160 #: ../src/guestfs-actions.pod:3218
12164 " guestfs_kill_subprocess (guestfs_h *g);\n"
12170 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2228
12171 msgid "This kills the qemu subprocess. You should never need to call this."
12176 #: ../src/guestfs-actions.pod:3227
12177 msgid "guestfs_launch"
12182 #: ../src/guestfs-actions.pod:3229
12186 " guestfs_launch (guestfs_h *g);\n"
12192 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2236
12194 "Internally libguestfs is implemented by running a virtual machine using "
12200 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2239
12202 "You should call this after configuring the handle (eg. adding drives) but "
12203 "before performing any actions."
12208 #: ../src/guestfs-actions.pod:3242
12209 msgid "guestfs_lchown"
12214 #: ../src/guestfs-actions.pod:3244
12218 " guestfs_lchown (guestfs_h *g,\n"
12221 " const char *path);\n"
12227 #: ../src/guestfs-actions.pod:3250
12229 "Change the file owner to C<owner> and group to C<group>. This is like "
12230 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12231 "changed, not the target."
12236 #: ../src/guestfs-actions.pod:3262
12237 msgid "guestfs_lgetxattr"
12242 #: ../src/guestfs-actions.pod:3264
12246 " guestfs_lgetxattr (guestfs_h *g,\n"
12247 " const char *path,\n"
12248 " const char *name,\n"
12249 " size_t *size_r);\n"
12255 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2258
12257 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12258 "is a symlink, then this call returns an extended attribute from the symlink."
12263 #: ../src/guestfs-actions.pod:3284
12264 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12269 #: ../src/guestfs-actions.pod:3292
12270 msgid "guestfs_lgetxattrs"
12275 #: ../src/guestfs-actions.pod:3294
12278 " struct guestfs_xattr_list *\n"
12279 " guestfs_lgetxattrs (guestfs_h *g,\n"
12280 " const char *path);\n"
12286 #: ../src/guestfs-actions.pod:3298
12288 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12289 "then it returns the extended attributes of the link itself."
12294 #: ../src/guestfs-actions.pod:3308
12295 msgid "guestfs_list_devices"
12300 #: ../src/guestfs-actions.pod:3310
12304 " guestfs_list_devices (guestfs_h *g);\n"
12310 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2286
12311 msgid "List all the block devices."
12316 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2288
12317 msgid "The full block device names are returned, eg. C</dev/sda>."
12322 #: ../src/guestfs-actions.pod:3325
12323 msgid "guestfs_list_filesystems"
12328 #: ../src/guestfs-actions.pod:3327
12332 " guestfs_list_filesystems (guestfs_h *g);\n"
12338 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2296
12340 "This inspection command looks for filesystems on partitions, block devices "
12341 "and logical volumes, returning a list of devices containing filesystems and "
12347 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2300
12349 "The return value is a hash, where the keys are the devices containing "
12350 "filesystems, and the values are the filesystem types. For example:"
12355 #: ../src/guestfs-actions.pod:3338 ../fish/guestfish-actions.pod:2304
12358 " \"/dev/sda1\" => \"ntfs\"\n"
12359 " \"/dev/sda2\" => \"ext2\"\n"
12360 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12361 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12367 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2309
12369 "The value can have the special value \"unknown\", meaning the content of the "
12370 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12375 #: ../src/guestfs-actions.pod:3347
12377 "This command runs other libguestfs commands, which might include "
12378 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12379 "soon after launch and only when nothing is mounted."
12384 #: ../src/guestfs-actions.pod:3351
12386 "Not all of the filesystems returned will be mountable. In particular, swap "
12387 "partitions are returned in the list. Also this command does not check that "
12388 "each filesystem found is valid and mountable, and some filesystems might be "
12389 "mountable but require special options. Filesystems may not all belong to a "
12390 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12395 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:4967
12396 msgid "(Added in 1.5.15)"
12401 #: ../src/guestfs-actions.pod:3367
12402 msgid "guestfs_list_partitions"
12407 #: ../src/guestfs-actions.pod:3369
12411 " guestfs_list_partitions (guestfs_h *g);\n"
12417 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2329
12418 msgid "List all the partitions detected on all block devices."
12423 #: ../src/guestfs-actions.pod:3374 ../fish/guestfish-actions.pod:2331
12424 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12429 #: ../src/guestfs-actions.pod:3376
12431 "This does not return logical volumes. For that you will need to call "
12437 #: ../src/guestfs-actions.pod:3387
12443 #: ../src/guestfs-actions.pod:3389
12447 " guestfs_ll (guestfs_h *g,\n"
12448 " const char *directory);\n"
12454 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2342
12456 "List the files in C<directory> (relative to the root directory, there is no "
12457 "cwd) in the format of 'ls -la'."
12462 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2345
12464 "This command is mostly useful for interactive sessions. It is I<not> "
12465 "intended that you try to parse the output string."
12470 #: ../src/guestfs-actions.pod:3404
12476 #: ../src/guestfs-actions.pod:3406
12480 " guestfs_ln (guestfs_h *g,\n"
12481 " const char *target,\n"
12482 " const char *linkname);\n"
12488 #: ../src/guestfs-actions.pod:3411 ../fish/guestfish-actions.pod:2352
12489 msgid "This command creates a hard link using the C<ln> command."
12494 #: ../src/guestfs-actions.pod:3417
12495 msgid "guestfs_ln_f"
12500 #: ../src/guestfs-actions.pod:3419
12504 " guestfs_ln_f (guestfs_h *g,\n"
12505 " const char *target,\n"
12506 " const char *linkname);\n"
12512 #: ../src/guestfs-actions.pod:3424 ../fish/guestfish-actions.pod:2358
12514 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12515 "option removes the link (C<linkname>) if it exists already."
12520 #: ../src/guestfs-actions.pod:3431
12521 msgid "guestfs_ln_s"
12526 #: ../src/guestfs-actions.pod:3433
12530 " guestfs_ln_s (guestfs_h *g,\n"
12531 " const char *target,\n"
12532 " const char *linkname);\n"
12538 #: ../src/guestfs-actions.pod:3438 ../fish/guestfish-actions.pod:2365
12539 msgid "This command creates a symbolic link using the C<ln -s> command."
12544 #: ../src/guestfs-actions.pod:3444
12545 msgid "guestfs_ln_sf"
12550 #: ../src/guestfs-actions.pod:3446
12554 " guestfs_ln_sf (guestfs_h *g,\n"
12555 " const char *target,\n"
12556 " const char *linkname);\n"
12562 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2371
12564 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12565 "option removes the link (C<linkname>) if it exists already."
12570 #: ../src/guestfs-actions.pod:3458
12571 msgid "guestfs_lremovexattr"
12576 #: ../src/guestfs-actions.pod:3460
12580 " guestfs_lremovexattr (guestfs_h *g,\n"
12581 " const char *xattr,\n"
12582 " const char *path);\n"
12588 #: ../src/guestfs-actions.pod:3465
12590 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12591 "link, then it removes an extended attribute of the link itself."
12596 #: ../src/guestfs-actions.pod:3473
12602 #: ../src/guestfs-actions.pod:3475
12606 " guestfs_ls (guestfs_h *g,\n"
12607 " const char *directory);\n"
12613 #: ../src/guestfs-actions.pod:3479 ../fish/guestfish-actions.pod:2386
12615 "List the files in C<directory> (relative to the root directory, there is no "
12616 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12621 #: ../src/guestfs-actions.pod:3483
12623 "This command is mostly useful for interactive sessions. Programs should "
12624 "probably use C<guestfs_readdir> instead."
12629 #: ../src/guestfs-actions.pod:3492
12630 msgid "guestfs_lsetxattr"
12635 #: ../src/guestfs-actions.pod:3494
12639 " guestfs_lsetxattr (guestfs_h *g,\n"
12640 " const char *xattr,\n"
12641 " const char *val,\n"
12643 " const char *path);\n"
12649 #: ../src/guestfs-actions.pod:3501
12651 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12652 "then it sets an extended attribute of the link itself."
12657 #: ../src/guestfs-actions.pod:3509
12658 msgid "guestfs_lstat"
12663 #: ../src/guestfs-actions.pod:3511
12666 " struct guestfs_stat *\n"
12667 " guestfs_lstat (guestfs_h *g,\n"
12668 " const char *path);\n"
12674 #: ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:6021
12675 #: ../fish/guestfish-actions.pod:2405 ../fish/guestfish-actions.pod:4029
12676 msgid "Returns file information for the given C<path>."
12681 #: ../src/guestfs-actions.pod:3517
12683 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12684 "link, then the link is stat-ed, not the file it refers to."
12689 #: ../src/guestfs-actions.pod:3521 ../fish/guestfish-actions.pod:2411
12690 msgid "This is the same as the C<lstat(2)> system call."
12695 #: ../src/guestfs-actions.pod:3523 ../src/guestfs-actions.pod:6025
12697 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12698 "error. I<The caller must call C<guestfs_free_stat> after use>."
12703 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:6029
12704 #: ../src/guestfs-actions.pod:6047 ../src/guestfs-actions.pod:6428
12705 msgid "(Added in 0.9.2)"
12710 #: ../src/guestfs-actions.pod:3529
12711 msgid "guestfs_lstatlist"
12716 #: ../src/guestfs-actions.pod:3531
12719 " struct guestfs_stat_list *\n"
12720 " guestfs_lstatlist (guestfs_h *g,\n"
12721 " const char *path,\n"
12722 " char *const *names);\n"
12728 #: ../src/guestfs-actions.pod:3536
12730 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12731 "files, where all files are in the directory C<path>. C<names> is the list "
12732 "of files from this directory."
12737 #: ../src/guestfs-actions.pod:3540 ../fish/guestfish-actions.pod:2421
12739 "On return you get a list of stat structs, with a one-to-one correspondence "
12740 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12741 "then the C<ino> field of that structure is set to C<-1>."
12746 #: ../src/guestfs-actions.pod:3545
12748 "This call is intended for programs that want to efficiently list a directory "
12749 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12750 "for a similarly efficient call for getting extended attributes. Very long "
12751 "directory listings might cause the protocol message size to be exceeded, "
12752 "causing this call to fail. The caller must split up such requests into "
12753 "smaller groups of names."
12758 #: ../src/guestfs-actions.pod:3553
12760 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12761 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12766 #: ../src/guestfs-actions.pod:3559
12767 msgid "guestfs_luks_add_key"
12772 #: ../src/guestfs-actions.pod:3561
12776 " guestfs_luks_add_key (guestfs_h *g,\n"
12777 " const char *device,\n"
12778 " const char *key,\n"
12779 " const char *newkey,\n"
12786 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2438
12788 "This command adds a new key on LUKS device C<device>. C<key> is any "
12789 "existing key, and is used to access the device. C<newkey> is the new key to "
12790 "add. C<keyslot> is the key slot that will be replaced."
12795 #: ../src/guestfs-actions.pod:3573
12797 "Note that if C<keyslot> already contains a key, then this command will "
12798 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12803 #: ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3619
12804 #: ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3662
12805 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3713
12807 "This function takes a key or passphrase parameter which could contain "
12808 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12814 #: ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3623
12815 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3666
12816 msgid "(Added in 1.5.2)"
12821 #: ../src/guestfs-actions.pod:3585
12822 msgid "guestfs_luks_close"
12827 #: ../src/guestfs-actions.pod:3587
12831 " guestfs_luks_close (guestfs_h *g,\n"
12832 " const char *device);\n"
12838 #: ../src/guestfs-actions.pod:3591
12840 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12841 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12842 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12843 "underlying block device."
12848 #: ../src/guestfs-actions.pod:3599 ../src/guestfs-actions.pod:3698
12849 #: ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3767
12850 #: ../src/guestfs-actions.pod:3815
12851 msgid "(Added in 1.5.1)"
12856 #: ../src/guestfs-actions.pod:3601
12857 msgid "guestfs_luks_format"
12862 #: ../src/guestfs-actions.pod:3603
12866 " guestfs_luks_format (guestfs_h *g,\n"
12867 " const char *device,\n"
12868 " const char *key,\n"
12875 #: ../src/guestfs-actions.pod:3609 ../fish/guestfish-actions.pod:2464
12877 "This command erases existing data on C<device> and formats the device as a "
12878 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12879 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12884 #: ../src/guestfs-actions.pod:3616 ../src/guestfs-actions.pod:3639
12885 #: ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:4718
12886 #: ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5856
12887 #: ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:5905
12888 #: ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:2472
12889 #: ../fish/guestfish-actions.pod:2485 ../fish/guestfish-actions.pod:2569
12890 #: ../fish/guestfish-actions.pod:3141 ../fish/guestfish-actions.pod:3648
12891 #: ../fish/guestfish-actions.pod:3928 ../fish/guestfish-actions.pod:3944
12892 #: ../fish/guestfish-actions.pod:3959 ../fish/guestfish-actions.pod:4674
12894 "B<This command is dangerous. Without careful use you can easily destroy all "
12900 #: ../src/guestfs-actions.pod:3625
12901 msgid "guestfs_luks_format_cipher"
12906 #: ../src/guestfs-actions.pod:3627
12910 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12911 " const char *device,\n"
12912 " const char *key,\n"
12914 " const char *cipher);\n"
12920 #: ../src/guestfs-actions.pod:3634
12922 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12923 "set the C<cipher> used."
12928 #: ../src/guestfs-actions.pod:3648
12929 msgid "guestfs_luks_kill_slot"
12934 #: ../src/guestfs-actions.pod:3650
12938 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12939 " const char *device,\n"
12940 " const char *key,\n"
12947 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2492
12949 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12950 "device C<device>. C<key> must be one of the I<other> keys."
12955 #: ../src/guestfs-actions.pod:3668
12956 msgid "guestfs_luks_open"
12961 #: ../src/guestfs-actions.pod:3670
12965 " guestfs_luks_open (guestfs_h *g,\n"
12966 " const char *device,\n"
12967 " const char *key,\n"
12968 " const char *mapname);\n"
12974 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2503
12976 "This command opens a block device which has been encrypted according to the "
12977 "Linux Unified Key Setup (LUKS) standard."
12982 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2506
12983 msgid "C<device> is the encrypted block device or partition."
12988 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2508
12990 "The caller must supply one of the keys associated with the LUKS block "
12991 "device, in the C<key> parameter."
12996 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
12998 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12999 "writes to this block device are decrypted from and encrypted to the "
13000 "underlying C<device> respectively."
13005 #: ../src/guestfs-actions.pod:3688
13007 "If this block device contains LVM volume groups, then calling "
13008 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13014 #: ../src/guestfs-actions.pod:3700
13015 msgid "guestfs_luks_open_ro"
13020 #: ../src/guestfs-actions.pod:3702
13024 " guestfs_luks_open_ro (guestfs_h *g,\n"
13025 " const char *device,\n"
13026 " const char *key,\n"
13027 " const char *mapname);\n"
13033 #: ../src/guestfs-actions.pod:3708
13035 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13041 #: ../src/guestfs-actions.pod:3719
13042 msgid "guestfs_lvcreate"
13047 #: ../src/guestfs-actions.pod:3721
13051 " guestfs_lvcreate (guestfs_h *g,\n"
13052 " const char *logvol,\n"
13053 " const char *volgroup,\n"
13060 #: ../src/guestfs-actions.pod:3727 ../fish/guestfish-actions.pod:2536
13062 "This creates an LVM logical volume called C<logvol> on the volume group "
13063 "C<volgroup>, with C<size> megabytes."
13068 #: ../src/guestfs-actions.pod:3734
13069 msgid "guestfs_lvm_canonical_lv_name"
13074 #: ../src/guestfs-actions.pod:3736
13078 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13079 " const char *lvname);\n"
13085 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2543
13087 "This converts alternative naming schemes for LVs that you might find to the "
13088 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13094 #: ../src/guestfs-actions.pod:3744 ../fish/guestfish-actions.pod:2547
13096 "This command returns an error if the C<lvname> parameter does not refer to a "
13102 #: ../src/guestfs-actions.pod:3747
13103 msgid "See also C<guestfs_is_lv>."
13108 #: ../src/guestfs-actions.pod:3752
13109 msgid "(Added in 1.5.24)"
13114 #: ../src/guestfs-actions.pod:3754
13115 msgid "guestfs_lvm_clear_filter"
13120 #: ../src/guestfs-actions.pod:3756
13124 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13130 #: ../src/guestfs-actions.pod:3759
13132 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13133 "see every block device."
13138 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3804
13139 #: ../fish/guestfish-actions.pod:2559 ../fish/guestfish-actions.pod:2590
13141 "This command also clears the LVM cache and performs a volume group scan."
13146 #: ../src/guestfs-actions.pod:3769
13147 msgid "guestfs_lvm_remove_all"
13152 #: ../src/guestfs-actions.pod:3771
13156 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13162 #: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2566
13164 "This command removes all LVM logical volumes, volume groups and physical "
13170 #: ../src/guestfs-actions.pod:3784
13171 msgid "guestfs_lvm_set_filter"
13176 #: ../src/guestfs-actions.pod:3786
13180 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13181 " char *const *devices);\n"
13187 #: ../src/guestfs-actions.pod:3790 ../fish/guestfish-actions.pod:2576
13189 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13190 "block devices in the list C<devices>, and will ignore all other attached "
13196 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
13198 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13199 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13200 "there are two types of duplication possible: either cloned PVs/VGs which "
13201 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13202 "same name. In normal operation you cannot create this situation, but you "
13203 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13204 "inside the LVM metadata."
13209 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2593
13210 msgid "You can filter whole block devices or individual partitions."
13215 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2595
13217 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13218 "filesystem), even if you are not filtering out that VG."
13223 #: ../src/guestfs-actions.pod:3817
13224 msgid "guestfs_lvremove"
13229 #: ../src/guestfs-actions.pod:3819
13233 " guestfs_lvremove (guestfs_h *g,\n"
13234 " const char *device);\n"
13240 #: ../src/guestfs-actions.pod:3823 ../fish/guestfish-actions.pod:2603
13242 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13243 "LV, such as C</dev/VG/LV>."
13248 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2606
13250 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13256 #: ../src/guestfs-actions.pod:3831 ../src/guestfs-actions.pod:5064
13257 #: ../src/guestfs-actions.pod:6804
13258 msgid "(Added in 1.0.13)"
13263 #: ../src/guestfs-actions.pod:3833
13264 msgid "guestfs_lvrename"
13269 #: ../src/guestfs-actions.pod:3835
13273 " guestfs_lvrename (guestfs_h *g,\n"
13274 " const char *logvol,\n"
13275 " const char *newlogvol);\n"
13281 #: ../src/guestfs-actions.pod:3840 ../fish/guestfish-actions.pod:2613
13282 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13287 #: ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:6817
13288 msgid "(Added in 1.0.83)"
13293 #: ../src/guestfs-actions.pod:3846
13294 msgid "guestfs_lvresize"
13299 #: ../src/guestfs-actions.pod:3848
13303 " guestfs_lvresize (guestfs_h *g,\n"
13304 " const char *device,\n"
13311 #: ../src/guestfs-actions.pod:3853 ../fish/guestfish-actions.pod:2619
13313 "This resizes (expands or shrinks) an existing LVM logical volume to "
13314 "C<mbytes>. When reducing, data in the reduced part is lost."
13319 #: ../src/guestfs-actions.pod:3861
13320 msgid "guestfs_lvresize_free"
13325 #: ../src/guestfs-actions.pod:3863
13329 " guestfs_lvresize_free (guestfs_h *g,\n"
13330 " const char *lv,\n"
13337 #: ../src/guestfs-actions.pod:3868 ../fish/guestfish-actions.pod:2627
13339 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13340 "remaining free space in the volume group. Commonly you would call this with "
13341 "pc = 100 which expands the logical volume as much as possible, using all "
13342 "remaining free space in the volume group."
13347 #: ../src/guestfs-actions.pod:3876
13348 msgid "(Added in 1.3.3)"
13353 #: ../src/guestfs-actions.pod:3878
13354 msgid "guestfs_lvs"
13359 #: ../src/guestfs-actions.pod:3880
13363 " guestfs_lvs (guestfs_h *g);\n"
13369 #: ../src/guestfs-actions.pod:3883 ../fish/guestfish-actions.pod:2637
13371 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13377 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2640
13379 "This returns a list of the logical volume device names (eg. C</dev/"
13380 "VolGroup00/LogVol00>)."
13385 #: ../src/guestfs-actions.pod:3889
13386 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13391 #: ../src/guestfs-actions.pod:3897
13392 msgid "guestfs_lvs_full"
13397 #: ../src/guestfs-actions.pod:3899
13400 " struct guestfs_lvm_lv_list *\n"
13401 " guestfs_lvs_full (guestfs_h *g);\n"
13407 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2649
13409 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13410 "(8)> command. The \"full\" version includes all fields."
13415 #: ../src/guestfs-actions.pod:3905
13417 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13418 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13423 #: ../src/guestfs-actions.pod:3911
13424 msgid "guestfs_lvuuid"
13429 #: ../src/guestfs-actions.pod:3913
13433 " guestfs_lvuuid (guestfs_h *g,\n"
13434 " const char *device);\n"
13440 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2656
13441 msgid "This command returns the UUID of the LVM LV C<device>."
13446 #: ../src/guestfs-actions.pod:3924
13447 msgid "guestfs_lxattrlist"
13452 #: ../src/guestfs-actions.pod:3926
13455 " struct guestfs_xattr_list *\n"
13456 " guestfs_lxattrlist (guestfs_h *g,\n"
13457 " const char *path,\n"
13458 " char *const *names);\n"
13464 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2662
13466 "This call allows you to get the extended attributes of multiple files, where "
13467 "all files are in the directory C<path>. C<names> is the list of files from "
13473 #: ../src/guestfs-actions.pod:3935 ../fish/guestfish-actions.pod:2666
13475 "On return you get a flat list of xattr structs which must be interpreted "
13476 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13477 "C<attrval> in this struct is zero-length to indicate there was an error "
13478 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13479 "number (the number of following attributes for this file, which could be C<"
13480 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13481 "for the first named file. This repeats for the second and subsequent files."
13486 #: ../src/guestfs-actions.pod:3945
13488 "This call is intended for programs that want to efficiently list a directory "
13489 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13490 "a similarly efficient call for getting standard stats. Very long directory "
13491 "listings might cause the protocol message size to be exceeded, causing this "
13492 "call to fail. The caller must split up such requests into smaller groups of "
13498 #: ../src/guestfs-actions.pod:3959
13499 msgid "guestfs_mkdir"
13504 #: ../src/guestfs-actions.pod:3961
13508 " guestfs_mkdir (guestfs_h *g,\n"
13509 " const char *path);\n"
13515 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2688
13516 msgid "Create a directory named C<path>."
13521 #: ../src/guestfs-actions.pod:3971
13522 msgid "guestfs_mkdir_mode"
13527 #: ../src/guestfs-actions.pod:3973
13531 " guestfs_mkdir_mode (guestfs_h *g,\n"
13532 " const char *path,\n"
13539 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2694
13541 "This command creates a directory, setting the initial permissions of the "
13542 "directory to C<mode>."
13547 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2697
13549 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13550 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13556 #: ../src/guestfs-actions.pod:3985
13557 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13562 #: ../src/guestfs-actions.pod:3991
13563 msgid "guestfs_mkdir_p"
13568 #: ../src/guestfs-actions.pod:3993
13572 " guestfs_mkdir_p (guestfs_h *g,\n"
13573 " const char *path);\n"
13579 #: ../src/guestfs-actions.pod:3997 ../fish/guestfish-actions.pod:2707
13581 "Create a directory named C<path>, creating any parent directories as "
13582 "necessary. This is like the C<mkdir -p> shell command."
13587 #: ../src/guestfs-actions.pod:4004
13588 msgid "guestfs_mkdtemp"
13593 #: ../src/guestfs-actions.pod:4006
13597 " guestfs_mkdtemp (guestfs_h *g,\n"
13598 " const char *template);\n"
13604 #: ../src/guestfs-actions.pod:4010 ../fish/guestfish-actions.pod:2714
13606 "This command creates a temporary directory. The C<template> parameter "
13607 "should be a full pathname for the temporary directory name with the final "
13608 "six characters being \"XXXXXX\"."
13613 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2719
13615 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13616 "being suitable for Windows filesystems."
13621 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2722
13622 msgid "The name of the temporary directory that was created is returned."
13627 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2725
13628 msgid "The temporary directory is created with mode 0700 and is owned by root."
13633 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2728
13635 "The caller is responsible for deleting the temporary directory and its "
13636 "contents after use."
13641 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2731
13642 msgid "See also: L<mkdtemp(3)>"
13647 #: ../src/guestfs-actions.pod:4034
13648 msgid "guestfs_mke2fs_J"
13653 #: ../src/guestfs-actions.pod:4036
13657 " guestfs_mke2fs_J (guestfs_h *g,\n"
13658 " const char *fstype,\n"
13659 " int blocksize,\n"
13660 " const char *device,\n"
13661 " const char *journal);\n"
13667 #: ../src/guestfs-actions.pod:4043 ../fish/guestfish-actions.pod:2737
13669 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13670 "C<journal>. It is equivalent to the command:"
13675 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2741
13678 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13684 #: ../src/guestfs-actions.pod:4049
13685 msgid "See also C<guestfs_mke2journal>."
13690 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4071
13691 #: ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4105
13692 #: ../src/guestfs-actions.pod:4119 ../src/guestfs-actions.pod:4133
13693 #: ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4445
13694 msgid "(Added in 1.0.68)"
13699 #: ../src/guestfs-actions.pod:4055
13700 msgid "guestfs_mke2fs_JL"
13705 #: ../src/guestfs-actions.pod:4057
13709 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13710 " const char *fstype,\n"
13711 " int blocksize,\n"
13712 " const char *device,\n"
13713 " const char *label);\n"
13719 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2749
13721 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13722 "the journal labeled C<label>."
13727 #: ../src/guestfs-actions.pod:4067
13728 msgid "See also C<guestfs_mke2journal_L>."
13733 #: ../src/guestfs-actions.pod:4073
13734 msgid "guestfs_mke2fs_JU"
13739 #: ../src/guestfs-actions.pod:4075
13743 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13744 " const char *fstype,\n"
13745 " int blocksize,\n"
13746 " const char *device,\n"
13747 " const char *uuid);\n"
13753 #: ../src/guestfs-actions.pod:4082 ../fish/guestfish-actions.pod:2758
13755 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13756 "the journal with UUID C<uuid>."
13761 #: ../src/guestfs-actions.pod:4085
13762 msgid "See also C<guestfs_mke2journal_U>."
13767 #: ../src/guestfs-actions.pod:4091
13768 msgid "guestfs_mke2journal"
13773 #: ../src/guestfs-actions.pod:4093
13777 " guestfs_mke2journal (guestfs_h *g,\n"
13778 " int blocksize,\n"
13779 " const char *device);\n"
13785 #: ../src/guestfs-actions.pod:4098 ../fish/guestfish-actions.pod:2767
13787 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13793 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2770
13796 " mke2fs -O journal_dev -b blocksize device\n"
13802 #: ../src/guestfs-actions.pod:4107
13803 msgid "guestfs_mke2journal_L"
13808 #: ../src/guestfs-actions.pod:4109
13812 " guestfs_mke2journal_L (guestfs_h *g,\n"
13813 " int blocksize,\n"
13814 " const char *label,\n"
13815 " const char *device);\n"
13821 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2776
13822 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13827 #: ../src/guestfs-actions.pod:4121
13828 msgid "guestfs_mke2journal_U"
13833 #: ../src/guestfs-actions.pod:4123
13837 " guestfs_mke2journal_U (guestfs_h *g,\n"
13838 " int blocksize,\n"
13839 " const char *uuid,\n"
13840 " const char *device);\n"
13846 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2782
13847 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13852 #: ../src/guestfs-actions.pod:4135
13853 msgid "guestfs_mkfifo"
13858 #: ../src/guestfs-actions.pod:4137
13862 " guestfs_mkfifo (guestfs_h *g,\n"
13864 " const char *path);\n"
13870 #: ../src/guestfs-actions.pod:4142
13872 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13873 "is just a convenient wrapper around C<guestfs_mknod>."
13878 #: ../src/guestfs-actions.pod:4152
13879 msgid "guestfs_mkfs"
13884 #: ../src/guestfs-actions.pod:4154
13888 " guestfs_mkfs (guestfs_h *g,\n"
13889 " const char *fstype,\n"
13890 " const char *device);\n"
13896 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2798
13898 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13899 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13904 #: ../src/guestfs-actions.pod:4167
13905 msgid "guestfs_mkfs_b"
13910 #: ../src/guestfs-actions.pod:4169
13914 " guestfs_mkfs_b (guestfs_h *g,\n"
13915 " const char *fstype,\n"
13916 " int blocksize,\n"
13917 " const char *device);\n"
13923 #: ../src/guestfs-actions.pod:4175
13925 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13926 "block size of the resulting filesystem. Supported block sizes depend on the "
13927 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13932 #: ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4222
13933 #: ../fish/guestfish-actions.pod:2811 ../fish/guestfish-actions.pod:2838
13935 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13941 #: ../src/guestfs-actions.pod:4185 ../fish/guestfish-actions.pod:2814
13943 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13948 #: ../src/guestfs-actions.pod:4194
13949 msgid "guestfs_mkfs_opts"
13954 #: ../src/guestfs-actions.pod:4196
13958 " guestfs_mkfs_opts (guestfs_h *g,\n"
13959 " const char *fstype,\n"
13960 " const char *device,\n"
13967 #: ../src/guestfs-actions.pod:4207
13970 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13976 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2825
13978 "This function creates a filesystem on C<device>. The filesystem type is "
13979 "C<fstype>, for example C<ext3>."
13984 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2832
13985 msgid "C<blocksize>"
13990 #: ../src/guestfs-actions.pod:4218 ../fish/guestfish-actions.pod:2834
13992 "The filesystem block size. Supported block sizes depend on the filesystem "
13993 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13998 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2841
13999 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14003 #: ../src/guestfs-actions.pod:4231
14004 msgid "(Added in 1.7.19)"
14009 #: ../src/guestfs-actions.pod:4233
14010 msgid "guestfs_mkfs_opts_va"
14015 #: ../src/guestfs-actions.pod:4235
14019 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14020 " const char *fstype,\n"
14021 " const char *device,\n"
14022 " va_list args);\n"
14028 #: ../src/guestfs-actions.pod:4241
14029 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14034 #: ../src/guestfs-actions.pod:4245
14035 msgid "guestfs_mkfs_opts_argv"
14040 #: ../src/guestfs-actions.pod:4247
14044 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14045 " const char *fstype,\n"
14046 " const char *device,\n"
14047 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14053 #: ../src/guestfs-actions.pod:4253
14054 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14059 #: ../src/guestfs-actions.pod:4257
14060 msgid "guestfs_mkmountpoint"
14065 #: ../src/guestfs-actions.pod:4259
14069 " guestfs_mkmountpoint (guestfs_h *g,\n"
14070 " const char *exemptpath);\n"
14076 #: ../src/guestfs-actions.pod:4263
14078 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14079 "that can be used to create extra mountpoints before mounting the first "
14085 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2855
14087 "These calls are I<only> necessary in some very limited circumstances, mainly "
14088 "the case where you want to mount a mix of unrelated and/or read-only "
14089 "filesystems together."
14094 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2859
14096 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14097 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14098 "inside that. You can unpack this as follows in guestfish:"
14103 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2864
14106 " add-ro Fedora-11-i686-Live.iso\n"
14108 " mkmountpoint /cd\n"
14109 " mkmountpoint /sqsh\n"
14110 " mkmountpoint /ext3fs\n"
14111 " mount /dev/sda /cd\n"
14112 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14113 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14119 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2873
14120 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14125 #: ../src/guestfs-actions.pod:4287
14127 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14128 "may get unexpected errors if you try to mix these calls. It is safest to "
14129 "manually unmount filesystems and remove mountpoints after use."
14134 #: ../src/guestfs-actions.pod:4291
14136 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14137 "first, so for this to work for manual mountpoints, you must ensure that the "
14138 "innermost mountpoints have the longest pathnames, as in the example code "
14144 #: ../src/guestfs-actions.pod:4296 ../fish/guestfish-actions.pod:2884
14146 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14151 #: ../src/guestfs-actions.pod:4298
14153 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14154 "means that C<guestfs_umount_all> is called when the handle is closed which "
14155 "can also trigger these issues."
14160 #: ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4563
14161 #: ../src/guestfs-actions.pod:5465
14162 msgid "(Added in 1.0.62)"
14167 #: ../src/guestfs-actions.pod:4306
14168 msgid "guestfs_mknod"
14173 #: ../src/guestfs-actions.pod:4308
14177 " guestfs_mknod (guestfs_h *g,\n"
14181 " const char *path);\n"
14187 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2894
14189 "This call creates block or character special devices, or named pipes (FIFOs)."
14194 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2897
14196 "The C<mode> parameter should be the mode, using the standard constants. "
14197 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14198 "used when creating block and character special devices."
14203 #: ../src/guestfs-actions.pod:4323
14205 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14206 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14207 "regular file). These constants are available in the standard Linux header "
14208 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14209 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14210 "the appropriate constant for you."
14215 #: ../src/guestfs-actions.pod:4337
14216 msgid "guestfs_mknod_b"
14221 #: ../src/guestfs-actions.pod:4339
14225 " guestfs_mknod_b (guestfs_h *g,\n"
14229 " const char *path);\n"
14235 #: ../src/guestfs-actions.pod:4346
14237 "This call creates a block device node called C<path> with mode C<mode> and "
14238 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14239 "wrapper around C<guestfs_mknod>."
14244 #: ../src/guestfs-actions.pod:4356
14245 msgid "guestfs_mknod_c"
14250 #: ../src/guestfs-actions.pod:4358
14254 " guestfs_mknod_c (guestfs_h *g,\n"
14258 " const char *path);\n"
14264 #: ../src/guestfs-actions.pod:4365
14266 "This call creates a char device node called C<path> with mode C<mode> and "
14267 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14268 "wrapper around C<guestfs_mknod>."
14273 #: ../src/guestfs-actions.pod:4375
14274 msgid "guestfs_mkswap"
14279 #: ../src/guestfs-actions.pod:4377
14283 " guestfs_mkswap (guestfs_h *g,\n"
14284 " const char *device);\n"
14290 #: ../src/guestfs-actions.pod:4381 ../fish/guestfish-actions.pod:2936
14291 msgid "Create a swap partition on C<device>."
14296 #: ../src/guestfs-actions.pod:4387
14297 msgid "guestfs_mkswap_L"
14302 #: ../src/guestfs-actions.pod:4389
14306 " guestfs_mkswap_L (guestfs_h *g,\n"
14307 " const char *label,\n"
14308 " const char *device);\n"
14314 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2942
14315 msgid "Create a swap partition on C<device> with label C<label>."
14320 #: ../src/guestfs-actions.pod:4396 ../fish/guestfish-actions.pod:2944
14322 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14323 "sda>), just to a partition. This appears to be a limitation of the kernel "
14329 #: ../src/guestfs-actions.pod:4404
14330 msgid "guestfs_mkswap_U"
14335 #: ../src/guestfs-actions.pod:4406
14339 " guestfs_mkswap_U (guestfs_h *g,\n"
14340 " const char *uuid,\n"
14341 " const char *device);\n"
14347 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:2952
14348 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14353 #: ../src/guestfs-actions.pod:4417
14354 msgid "guestfs_mkswap_file"
14359 #: ../src/guestfs-actions.pod:4419
14363 " guestfs_mkswap_file (guestfs_h *g,\n"
14364 " const char *path);\n"
14370 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:2958
14371 msgid "Create a swap file."
14376 #: ../src/guestfs-actions.pod:4425
14378 "This command just writes a swap file signature to an existing file. To "
14379 "create the file itself, use something like C<guestfs_fallocate>."
14384 #: ../src/guestfs-actions.pod:4432
14385 msgid "guestfs_modprobe"
14390 #: ../src/guestfs-actions.pod:4434
14394 " guestfs_modprobe (guestfs_h *g,\n"
14395 " const char *modulename);\n"
14401 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2967
14402 msgid "This loads a kernel module in the appliance."
14407 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:2969
14409 "The kernel module must have been whitelisted when libguestfs was built (see "
14410 "C<appliance/kmod.whitelist.in> in the source)."
14415 #: ../src/guestfs-actions.pod:4447
14416 msgid "guestfs_mount"
14421 #: ../src/guestfs-actions.pod:4449
14425 " guestfs_mount (guestfs_h *g,\n"
14426 " const char *device,\n"
14427 " const char *mountpoint);\n"
14433 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2976
14435 "Mount a guest disk at a position in the filesystem. Block devices are named "
14436 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14437 "those block devices contain partitions, they will have the usual names (eg. "
14438 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14443 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:2982
14445 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14446 "mounted on C</> before others can be mounted. Other filesystems can only be "
14447 "mounted on directories which already exist."
14452 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2987
14454 "The mounted filesystem is writable, if we have sufficient permissions on the "
14455 "underlying device."
14460 #: ../src/guestfs-actions.pod:4468
14462 "B<Important note:> When you use this call, the filesystem options C<sync> "
14463 "and C<noatime> are set implicitly. This was originally done because we "
14464 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14465 "very large negative performance impact and negligible effect on "
14466 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14467 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14468 "(use an empty string for the first parameter if you don't want any options)."
14473 #: ../src/guestfs-actions.pod:4482
14474 msgid "guestfs_mount_loop"
14479 #: ../src/guestfs-actions.pod:4484
14483 " guestfs_mount_loop (guestfs_h *g,\n"
14484 " const char *file,\n"
14485 " const char *mountpoint);\n"
14491 #: ../src/guestfs-actions.pod:4489 ../fish/guestfish-actions.pod:3004
14493 "This command lets you mount C<file> (a filesystem image in a file) on a "
14494 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14500 #: ../src/guestfs-actions.pod:4497
14501 msgid "guestfs_mount_options"
14506 #: ../src/guestfs-actions.pod:4499
14510 " guestfs_mount_options (guestfs_h *g,\n"
14511 " const char *options,\n"
14512 " const char *device,\n"
14513 " const char *mountpoint);\n"
14519 #: ../src/guestfs-actions.pod:4505
14521 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14522 "the mount options as for the L<mount(8)> I<-o> flag."
14527 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3016
14529 "If the C<options> parameter is an empty string, then no options are passed "
14530 "(all options default to whatever the filesystem uses)."
14535 #: ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4529
14536 #: ../src/guestfs-actions.pod:4546
14537 msgid "(Added in 1.0.10)"
14542 #: ../src/guestfs-actions.pod:4517
14543 msgid "guestfs_mount_ro"
14548 #: ../src/guestfs-actions.pod:4519
14552 " guestfs_mount_ro (guestfs_h *g,\n"
14553 " const char *device,\n"
14554 " const char *mountpoint);\n"
14560 #: ../src/guestfs-actions.pod:4524
14562 "This is the same as the C<guestfs_mount> command, but it mounts the "
14563 "filesystem with the read-only (I<-o ro>) flag."
14568 #: ../src/guestfs-actions.pod:4531
14569 msgid "guestfs_mount_vfs"
14574 #: ../src/guestfs-actions.pod:4533
14578 " guestfs_mount_vfs (guestfs_h *g,\n"
14579 " const char *options,\n"
14580 " const char *vfstype,\n"
14581 " const char *device,\n"
14582 " const char *mountpoint);\n"
14588 #: ../src/guestfs-actions.pod:4540
14590 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14591 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14597 #: ../src/guestfs-actions.pod:4548
14598 msgid "guestfs_mountpoints"
14603 #: ../src/guestfs-actions.pod:4550
14607 " guestfs_mountpoints (guestfs_h *g);\n"
14613 #: ../src/guestfs-actions.pod:4553
14615 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14616 "devices. This one returns a hash table (map) of device name to directory "
14617 "where the device is mounted."
14622 #: ../src/guestfs-actions.pod:4565
14623 msgid "guestfs_mounts"
14628 #: ../src/guestfs-actions.pod:4567
14632 " guestfs_mounts (guestfs_h *g);\n"
14638 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3047
14640 "This returns the list of currently mounted filesystems. It returns the list "
14641 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14646 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3050
14647 msgid "Some internal mounts are not shown."
14652 #: ../src/guestfs-actions.pod:4575
14653 msgid "See also: C<guestfs_mountpoints>"
14658 #: ../src/guestfs-actions.pod:4583
14664 #: ../src/guestfs-actions.pod:4585
14668 " guestfs_mv (guestfs_h *g,\n"
14669 " const char *src,\n"
14670 " const char *dest);\n"
14676 #: ../src/guestfs-actions.pod:4590 ../fish/guestfish-actions.pod:3058
14678 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14679 "destination filename or destination directory."
14684 #: ../src/guestfs-actions.pod:4597
14685 msgid "guestfs_ntfs_3g_probe"
14690 #: ../src/guestfs-actions.pod:4599
14694 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14696 " const char *device);\n"
14702 #: ../src/guestfs-actions.pod:4604 ../fish/guestfish-actions.pod:3065
14704 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14705 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14706 "write, and some cannot be mounted at all)."
14711 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3069
14713 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14714 "can be mounted read-write. Set it to false if you want to test if the "
14715 "volume can be mounted read-only."
14720 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3073
14722 "The return value is an integer which C<0> if the operation would succeed, or "
14723 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14728 #: ../src/guestfs-actions.pod:4618
14729 msgid "(Added in 1.0.43)"
14734 #: ../src/guestfs-actions.pod:4620
14735 msgid "guestfs_ntfsresize"
14740 #: ../src/guestfs-actions.pod:4622
14744 " guestfs_ntfsresize (guestfs_h *g,\n"
14745 " const char *device);\n"
14750 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3081
14752 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14753 "size of the underlying device."
14757 #: ../src/guestfs-actions.pod:4629 ../fish/guestfish-actions.pod:3084
14759 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14760 "consistency check (for safety). You have to boot into Windows to perform "
14761 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14762 "resize filesystems which have been marked in this way. So in effect it is "
14763 "not possible to call ntfsresize multiple times on a single filesystem "
14764 "without booting into Windows between each resize."
14768 #: ../src/guestfs-actions.pod:4637 ../fish/guestfish-actions.pod:3092
14769 msgid "See also L<ntfsresize(8)>."
14774 #: ../src/guestfs-actions.pod:4643
14775 msgid "guestfs_ntfsresize_size"
14780 #: ../src/guestfs-actions.pod:4645
14784 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14785 " const char *device,\n"
14786 " int64_t size);\n"
14792 #: ../src/guestfs-actions.pod:4650
14794 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14795 "to specify the new size (in bytes) explicitly."
14800 #: ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:5091
14801 #: ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5413
14802 #: ../src/guestfs-actions.pod:6952
14803 msgid "(Added in 1.3.14)"
14808 #: ../src/guestfs-actions.pod:4657
14809 msgid "guestfs_part_add"
14814 #: ../src/guestfs-actions.pod:4659
14818 " guestfs_part_add (guestfs_h *g,\n"
14819 " const char *device,\n"
14820 " const char *prlogex,\n"
14821 " int64_t startsect,\n"
14822 " int64_t endsect);\n"
14828 #: ../src/guestfs-actions.pod:4666
14830 "This command adds a partition to C<device>. If there is no partition table "
14831 "on the device, call C<guestfs_part_init> first."
14836 #: ../src/guestfs-actions.pod:4669 ../fish/guestfish-actions.pod:3108
14838 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14839 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14840 "C<logical>) and C<e> (or C<extended>) partition types."
14845 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3113
14847 "C<startsect> and C<endsect> are the start and end of the partition in "
14848 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14849 "from the end of the disk (C<-1> is the last sector)."
14854 #: ../src/guestfs-actions.pod:4678
14856 "Creating a partition which covers the whole disk is not so easy. Use "
14857 "C<guestfs_part_disk> to do that."
14862 #: ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:4721
14863 #: ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4852
14864 #: ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4909
14865 #: ../src/guestfs-actions.pod:4949
14866 msgid "(Added in 1.0.78)"
14871 #: ../src/guestfs-actions.pod:4685
14872 msgid "guestfs_part_del"
14877 #: ../src/guestfs-actions.pod:4687
14881 " guestfs_part_del (guestfs_h *g,\n"
14882 " const char *device,\n"
14889 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3124
14890 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14895 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3126
14897 "Note that in the case of MBR partitioning, deleting an extended partition "
14898 "also deletes any logical partitions it contains."
14903 #: ../src/guestfs-actions.pod:4702
14904 msgid "guestfs_part_disk"
14909 #: ../src/guestfs-actions.pod:4704
14913 " guestfs_part_disk (guestfs_h *g,\n"
14914 " const char *device,\n"
14915 " const char *parttype);\n"
14921 #: ../src/guestfs-actions.pod:4709
14923 "This command is simply a combination of C<guestfs_part_init> followed by "
14924 "C<guestfs_part_add> to create a single primary partition covering the whole "
14930 #: ../src/guestfs-actions.pod:4713
14932 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14933 "possible values are described in C<guestfs_part_init>."
14938 #: ../src/guestfs-actions.pod:4723
14939 msgid "guestfs_part_get_bootable"
14944 #: ../src/guestfs-actions.pod:4725
14948 " guestfs_part_get_bootable (guestfs_h *g,\n"
14949 " const char *device,\n"
14956 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3148
14958 "This command returns true if the partition C<partnum> on C<device> has the "
14959 "bootable flag set."
14964 #: ../src/guestfs-actions.pod:4733
14965 msgid "See also C<guestfs_part_set_bootable>."
14970 #: ../src/guestfs-actions.pod:4739
14971 msgid "guestfs_part_get_mbr_id"
14976 #: ../src/guestfs-actions.pod:4741
14980 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14981 " const char *device,\n"
14988 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3157
14990 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14991 "partition C<partnum>."
14996 #: ../src/guestfs-actions.pod:4749 ../src/guestfs-actions.pod:4925
14998 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14999 "undefined results for other partition table types (see "
15000 "C<guestfs_part_get_parttype>)."
15005 #: ../src/guestfs-actions.pod:4757
15006 msgid "guestfs_part_get_parttype"
15011 #: ../src/guestfs-actions.pod:4759
15015 " guestfs_part_get_parttype (guestfs_h *g,\n"
15016 " const char *device);\n"
15022 #: ../src/guestfs-actions.pod:4763 ../fish/guestfish-actions.pod:3168
15024 "This command examines the partition table on C<device> and returns the "
15025 "partition table type (format) being used."
15030 #: ../src/guestfs-actions.pod:4766
15032 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15033 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15034 "possible, although unusual. See C<guestfs_part_init> for a full list."
15039 #: ../src/guestfs-actions.pod:4776
15040 msgid "guestfs_part_init"
15045 #: ../src/guestfs-actions.pod:4778
15049 " guestfs_part_init (guestfs_h *g,\n"
15050 " const char *device,\n"
15051 " const char *parttype);\n"
15057 #: ../src/guestfs-actions.pod:4783 ../fish/guestfish-actions.pod:3180
15059 "This creates an empty partition table on C<device> of one of the partition "
15060 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15061 "(for large disks)."
15066 #: ../src/guestfs-actions.pod:4787
15068 "Initially there are no partitions. Following this, you should call "
15069 "C<guestfs_part_add> for each partition required."
15074 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3187
15075 msgid "Possible values for C<parttype> are:"
15080 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3191
15081 msgid "B<efi> | B<gpt>"
15086 #: ../src/guestfs-actions.pod:4796 ../fish/guestfish-actions.pod:3193
15087 msgid "Intel EFI / GPT partition table."
15092 #: ../src/guestfs-actions.pod:4798 ../fish/guestfish-actions.pod:3195
15094 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15095 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15096 "the C<mbr> format."
15101 #: ../src/guestfs-actions.pod:4802 ../fish/guestfish-actions.pod:3199
15102 msgid "B<mbr> | B<msdos>"
15107 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3201
15109 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15110 "Windows. This partition type will B<only> work for device sizes up to 2 "
15111 "TB. For large disks we recommend using C<gpt>."
15116 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3208
15118 "Other partition table types that may work but are not supported include:"
15123 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
15129 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3215
15130 msgid "AIX disk labels."
15135 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3217
15136 msgid "B<amiga> | B<rdb>"
15141 #: ../src/guestfs-actions.pod:4822 ../fish/guestfish-actions.pod:3219
15142 msgid "Amiga \"Rigid Disk Block\" format."
15147 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3221
15153 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3223
15154 msgid "BSD disk labels."
15159 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3225
15165 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3227
15166 msgid "DASD, used on IBM mainframes."
15171 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3229
15177 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3231
15178 msgid "MIPS/SGI volumes."
15183 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3233
15189 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3235
15190 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15195 #: ../src/guestfs-actions.pod:4840 ../fish/guestfish-actions.pod:3237
15201 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3239
15202 msgid "NEC PC-98 format, common in Japan apparently."
15207 #: ../src/guestfs-actions.pod:4844 ../fish/guestfish-actions.pod:3241
15213 #: ../src/guestfs-actions.pod:4846 ../fish/guestfish-actions.pod:3243
15214 msgid "Sun disk labels."
15219 #: ../src/guestfs-actions.pod:4854
15220 msgid "guestfs_part_list"
15225 #: ../src/guestfs-actions.pod:4856
15228 " struct guestfs_partition_list *\n"
15229 " guestfs_part_list (guestfs_h *g,\n"
15230 " const char *device);\n"
15236 #: ../src/guestfs-actions.pod:4860 ../fish/guestfish-actions.pod:3251
15238 "This command parses the partition table on C<device> and returns the list of "
15239 "partitions found."
15244 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3254
15245 msgid "The fields in the returned structure are:"
15250 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3258
15251 msgid "B<part_num>"
15256 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3260
15257 msgid "Partition number, counting from 1."
15262 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3262
15263 msgid "B<part_start>"
15268 #: ../src/guestfs-actions.pod:4873
15270 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15271 "the device's sector size, see C<guestfs_blockdev_getss>."
15276 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3267
15277 msgid "B<part_end>"
15282 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3269
15283 msgid "End of the partition in bytes."
15288 #: ../src/guestfs-actions.pod:4880 ../fish/guestfish-actions.pod:3271
15289 msgid "B<part_size>"
15294 #: ../src/guestfs-actions.pod:4882 ../fish/guestfish-actions.pod:3273
15295 msgid "Size of the partition in bytes."
15300 #: ../src/guestfs-actions.pod:4886
15302 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15303 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15309 #: ../src/guestfs-actions.pod:4892
15310 msgid "guestfs_part_set_bootable"
15315 #: ../src/guestfs-actions.pod:4894
15319 " guestfs_part_set_bootable (guestfs_h *g,\n"
15320 " const char *device,\n"
15322 " int bootable);\n"
15328 #: ../src/guestfs-actions.pod:4900 ../fish/guestfish-actions.pod:3281
15330 "This sets the bootable flag on partition numbered C<partnum> on device "
15331 "C<device>. Note that partitions are numbered from 1."
15336 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3284
15338 "The bootable flag is used by some operating systems (notably Windows) to "
15339 "determine which partition to boot from. It is by no means universally "
15345 #: ../src/guestfs-actions.pod:4911
15346 msgid "guestfs_part_set_mbr_id"
15351 #: ../src/guestfs-actions.pod:4913
15355 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15356 " const char *device,\n"
15364 #: ../src/guestfs-actions.pod:4919 ../fish/guestfish-actions.pod:3292
15366 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15367 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15368 "documentation are in fact hexadecimal numbers, but usually documented "
15369 "without any leading \"0x\" which might be confusing."
15374 #: ../src/guestfs-actions.pod:4933
15375 msgid "guestfs_part_set_name"
15380 #: ../src/guestfs-actions.pod:4935
15384 " guestfs_part_set_name (guestfs_h *g,\n"
15385 " const char *device,\n"
15387 " const char *name);\n"
15393 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3306
15395 "This sets the partition name on partition numbered C<partnum> on device "
15396 "C<device>. Note that partitions are numbered from 1."
15401 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3309
15403 "The partition name can only be set on certain types of partition table. "
15404 "This works on C<gpt> but not on C<mbr> partitions."
15409 #: ../src/guestfs-actions.pod:4951
15410 msgid "guestfs_part_to_dev"
15415 #: ../src/guestfs-actions.pod:4953
15419 " guestfs_part_to_dev (guestfs_h *g,\n"
15420 " const char *partition);\n"
15426 #: ../src/guestfs-actions.pod:4957 ../fish/guestfish-actions.pod:3316
15428 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15429 "partition number, returning the device name (eg. \"/dev/sdb\")."
15434 #: ../src/guestfs-actions.pod:4961
15436 "The named partition must exist, for example as a string returned from "
15437 "C<guestfs_list_partitions>."
15442 #: ../src/guestfs-actions.pod:4969
15443 msgid "guestfs_ping_daemon"
15448 #: ../src/guestfs-actions.pod:4971
15452 " guestfs_ping_daemon (guestfs_h *g);\n"
15458 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3327
15460 "This is a test probe into the guestfs daemon running inside the qemu "
15461 "subprocess. Calling this function checks that the daemon responds to the "
15462 "ping message, without affecting the daemon or attached block device(s) in "
15468 #: ../src/guestfs-actions.pod:4983
15469 msgid "guestfs_pread"
15474 #: ../src/guestfs-actions.pod:4985
15478 " guestfs_pread (guestfs_h *g,\n"
15479 " const char *path,\n"
15481 " int64_t offset,\n"
15482 " size_t *size_r);\n"
15488 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3336
15490 "This command lets you read part of a file. It reads C<count> bytes of the "
15491 "file, starting at C<offset>, from file C<path>."
15496 #: ../src/guestfs-actions.pod:4995 ../src/guestfs-actions.pod:5021
15497 #: ../fish/guestfish-actions.pod:3339 ../fish/guestfish-actions.pod:3354
15499 "This may read fewer bytes than requested. For further details see the "
15500 "L<pread(2)> system call."
15505 #: ../src/guestfs-actions.pod:4998
15506 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15511 #: ../src/guestfs-actions.pod:5009
15512 msgid "guestfs_pread_device"
15517 #: ../src/guestfs-actions.pod:5011
15521 " guestfs_pread_device (guestfs_h *g,\n"
15522 " const char *device,\n"
15524 " int64_t offset,\n"
15525 " size_t *size_r);\n"
15531 #: ../src/guestfs-actions.pod:5018 ../fish/guestfish-actions.pod:3351
15533 "This command lets you read part of a file. It reads C<count> bytes of "
15534 "C<device>, starting at C<offset>."
15539 #: ../src/guestfs-actions.pod:5024
15540 msgid "See also C<guestfs_pread>."
15545 #: ../src/guestfs-actions.pod:5033
15546 msgid "(Added in 1.5.21)"
15551 #: ../src/guestfs-actions.pod:5035
15552 msgid "guestfs_pvcreate"
15557 #: ../src/guestfs-actions.pod:5037
15561 " guestfs_pvcreate (guestfs_h *g,\n"
15562 " const char *device);\n"
15568 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3366
15570 "This creates an LVM physical volume on the named C<device>, where C<device> "
15571 "should usually be a partition name such as C</dev/sda1>."
15576 #: ../src/guestfs-actions.pod:5049
15577 msgid "guestfs_pvremove"
15582 #: ../src/guestfs-actions.pod:5051
15586 " guestfs_pvremove (guestfs_h *g,\n"
15587 " const char *device);\n"
15593 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3374
15595 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15601 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3377
15603 "The implementation uses the C<pvremove> command which refuses to wipe "
15604 "physical volumes that contain any volume groups, so you have to remove those "
15610 #: ../src/guestfs-actions.pod:5066
15611 msgid "guestfs_pvresize"
15616 #: ../src/guestfs-actions.pod:5068
15620 " guestfs_pvresize (guestfs_h *g,\n"
15621 " const char *device);\n"
15627 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3385
15629 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15630 "the new size of the underlying device."
15635 #: ../src/guestfs-actions.pod:5079
15636 msgid "guestfs_pvresize_size"
15641 #: ../src/guestfs-actions.pod:5081
15645 " guestfs_pvresize_size (guestfs_h *g,\n"
15646 " const char *device,\n"
15647 " int64_t size);\n"
15653 #: ../src/guestfs-actions.pod:5086
15655 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15656 "specify the new size (in bytes) explicitly."
15661 #: ../src/guestfs-actions.pod:5093
15662 msgid "guestfs_pvs"
15667 #: ../src/guestfs-actions.pod:5095
15671 " guestfs_pvs (guestfs_h *g);\n"
15677 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3399
15679 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15685 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3402
15687 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15693 #: ../src/guestfs-actions.pod:5104
15694 msgid "See also C<guestfs_pvs_full>."
15699 #: ../src/guestfs-actions.pod:5112
15700 msgid "guestfs_pvs_full"
15705 #: ../src/guestfs-actions.pod:5114
15708 " struct guestfs_lvm_pv_list *\n"
15709 " guestfs_pvs_full (guestfs_h *g);\n"
15715 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3411
15717 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15718 "(8)> command. The \"full\" version includes all fields."
15723 #: ../src/guestfs-actions.pod:5120
15725 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15726 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15731 #: ../src/guestfs-actions.pod:5126
15732 msgid "guestfs_pvuuid"
15737 #: ../src/guestfs-actions.pod:5128
15741 " guestfs_pvuuid (guestfs_h *g,\n"
15742 " const char *device);\n"
15748 #: ../src/guestfs-actions.pod:5132 ../fish/guestfish-actions.pod:3418
15749 msgid "This command returns the UUID of the LVM PV C<device>."
15754 #: ../src/guestfs-actions.pod:5139
15755 msgid "guestfs_pwrite"
15760 #: ../src/guestfs-actions.pod:5141
15764 " guestfs_pwrite (guestfs_h *g,\n"
15765 " const char *path,\n"
15766 " const char *content,\n"
15767 " size_t content_size,\n"
15768 " int64_t offset);\n"
15774 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3424
15776 "This command writes to part of a file. It writes the data buffer C<content> "
15777 "to the file C<path> starting at offset C<offset>."
15782 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3427
15784 "This command implements the L<pwrite(2)> system call, and like that system "
15785 "call it may not write the full data requested. The return value is the "
15786 "number of bytes that were actually written to the file. This could even be "
15787 "0, although short writes are unlikely for regular files in ordinary "
15793 #: ../src/guestfs-actions.pod:5157
15794 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15799 #: ../src/guestfs-actions.pod:5166
15800 msgid "guestfs_pwrite_device"
15805 #: ../src/guestfs-actions.pod:5168
15809 " guestfs_pwrite_device (guestfs_h *g,\n"
15810 " const char *device,\n"
15811 " const char *content,\n"
15812 " size_t content_size,\n"
15813 " int64_t offset);\n"
15819 #: ../src/guestfs-actions.pod:5175 ../fish/guestfish-actions.pod:3442
15821 "This command writes to part of a device. It writes the data buffer "
15822 "C<content> to C<device> starting at offset C<offset>."
15827 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3445
15829 "This command implements the L<pwrite(2)> system call, and like that system "
15830 "call it may not write the full data requested (although short writes to disk "
15831 "devices and partitions are probably impossible with standard Linux kernels)."
15836 #: ../src/guestfs-actions.pod:5183
15837 msgid "See also C<guestfs_pwrite>."
15842 #: ../src/guestfs-actions.pod:5190
15843 msgid "(Added in 1.5.20)"
15848 #: ../src/guestfs-actions.pod:5192
15849 msgid "guestfs_read_file"
15854 #: ../src/guestfs-actions.pod:5194
15858 " guestfs_read_file (guestfs_h *g,\n"
15859 " const char *path,\n"
15860 " size_t *size_r);\n"
15866 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3459
15867 msgid "This calls returns the contents of the file C<path> as a buffer."
15872 #: ../src/guestfs-actions.pod:5202
15874 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15875 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15876 "function is limited in the total size of file that can be handled."
15881 #: ../src/guestfs-actions.pod:5214
15882 msgid "(Added in 1.0.63)"
15887 #: ../src/guestfs-actions.pod:5216
15888 msgid "guestfs_read_lines"
15893 #: ../src/guestfs-actions.pod:5218
15897 " guestfs_read_lines (guestfs_h *g,\n"
15898 " const char *path);\n"
15904 #: ../src/guestfs-actions.pod:5224 ../fish/guestfish-actions.pod:3476
15906 "The file contents are returned as a list of lines. Trailing C<LF> and "
15907 "C<CRLF> character sequences are I<not> returned."
15912 #: ../src/guestfs-actions.pod:5227
15914 "Note that this function cannot correctly handle binary files (specifically, "
15915 "files containing C<\\0> character which is treated as end of line). For "
15916 "those you need to use the C<guestfs_read_file> function which has a more "
15917 "complex interface."
15922 #: ../src/guestfs-actions.pod:5238
15923 msgid "guestfs_readdir"
15928 #: ../src/guestfs-actions.pod:5240
15931 " struct guestfs_dirent_list *\n"
15932 " guestfs_readdir (guestfs_h *g,\n"
15933 " const char *dir);\n"
15939 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3488
15940 msgid "This returns the list of directory entries in directory C<dir>."
15945 #: ../src/guestfs-actions.pod:5246 ../fish/guestfish-actions.pod:3490
15947 "All entries in the directory are returned, including C<.> and C<..>. The "
15948 "entries are I<not> sorted, but returned in the same order as the underlying "
15954 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3494
15956 "Also this call returns basic file type information about each file. The "
15957 "C<ftyp> field will contain one of the following characters:"
15962 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
15968 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3501
15969 msgid "Block special"
15974 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3503
15980 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3505
15981 msgid "Char special"
15986 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3507
15992 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3509
15998 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3511
16004 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3513
16005 msgid "FIFO (named pipe)"
16010 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
16016 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
16017 msgid "Symbolic link"
16022 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3519
16028 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
16029 msgid "Regular file"
16034 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3523
16040 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3525
16046 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3527
16052 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3529
16053 msgid "Unknown file type"
16058 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3531
16064 #: ../src/guestfs-actions.pod:5289 ../fish/guestfish-actions.pod:3533
16066 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16071 #: ../src/guestfs-actions.pod:5294
16073 "This function is primarily intended for use by programs. To get a simple "
16074 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16075 "consumption, use C<guestfs_ll>."
16080 #: ../src/guestfs-actions.pod:5298
16082 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16083 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16088 #: ../src/guestfs-actions.pod:5304
16089 msgid "guestfs_readlink"
16094 #: ../src/guestfs-actions.pod:5306
16098 " guestfs_readlink (guestfs_h *g,\n"
16099 " const char *path);\n"
16105 #: ../src/guestfs-actions.pod:5310 ../fish/guestfish-actions.pod:3546
16106 msgid "This command reads the target of a symbolic link."
16111 #: ../src/guestfs-actions.pod:5317
16112 msgid "guestfs_readlinklist"
16117 #: ../src/guestfs-actions.pod:5319
16121 " guestfs_readlinklist (guestfs_h *g,\n"
16122 " const char *path,\n"
16123 " char *const *names);\n"
16129 #: ../src/guestfs-actions.pod:5324 ../fish/guestfish-actions.pod:3552
16131 "This call allows you to do a C<readlink> operation on multiple files, where "
16132 "all files are in the directory C<path>. C<names> is the list of files from "
16138 #: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:3556
16140 "On return you get a list of strings, with a one-to-one correspondence to the "
16141 "C<names> list. Each string is the value of the symbolic link."
16146 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3560
16148 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16149 "result string is the empty string C<\"\">. However the whole operation is "
16150 "completed even if there were C<readlink(2)> errors, and so you can call this "
16151 "function with names where you don't know if they are symbolic links already "
16152 "(albeit slightly less efficient)."
16157 #: ../src/guestfs-actions.pod:5339 ../fish/guestfish-actions.pod:3567
16159 "This call is intended for programs that want to efficiently list a directory "
16160 "contents without making many round-trips. Very long directory listings "
16161 "might cause the protocol message size to be exceeded, causing this call to "
16162 "fail. The caller must split up such requests into smaller groups of names."
16167 #: ../src/guestfs-actions.pod:5352
16168 msgid "guestfs_realpath"
16173 #: ../src/guestfs-actions.pod:5354
16177 " guestfs_realpath (guestfs_h *g,\n"
16178 " const char *path);\n"
16184 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3578
16186 "Return the canonicalized absolute pathname of C<path>. The returned path "
16187 "has no C<.>, C<..> or symbolic link path elements."
16192 #: ../src/guestfs-actions.pod:5366
16193 msgid "guestfs_removexattr"
16198 #: ../src/guestfs-actions.pod:5368
16202 " guestfs_removexattr (guestfs_h *g,\n"
16203 " const char *xattr,\n"
16204 " const char *path);\n"
16210 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3585
16212 "This call removes the extended attribute named C<xattr> of the file C<path>."
16217 #: ../src/guestfs-actions.pod:5376
16218 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16223 #: ../src/guestfs-actions.pod:5382
16224 msgid "guestfs_resize2fs"
16229 #: ../src/guestfs-actions.pod:5384
16233 " guestfs_resize2fs (guestfs_h *g,\n"
16234 " const char *device);\n"
16240 #: ../src/guestfs-actions.pod:5388 ../fish/guestfish-actions.pod:3594
16242 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16243 "underlying device."
16248 #: ../src/guestfs-actions.pod:5391
16250 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16251 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16252 "sometimes gives an error about this and sometimes not. In any case, it is "
16253 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16258 #: ../src/guestfs-actions.pod:5401
16259 msgid "guestfs_resize2fs_size"
16264 #: ../src/guestfs-actions.pod:5403
16268 " guestfs_resize2fs_size (guestfs_h *g,\n"
16269 " const char *device,\n"
16270 " int64_t size);\n"
16276 #: ../src/guestfs-actions.pod:5408
16278 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16279 "to specify the new size (in bytes) explicitly."
16284 #: ../src/guestfs-actions.pod:5415
16290 #: ../src/guestfs-actions.pod:5417
16294 " guestfs_rm (guestfs_h *g,\n"
16295 " const char *path);\n"
16301 #: ../src/guestfs-actions.pod:5421 ../fish/guestfish-actions.pod:3614
16302 msgid "Remove the single file C<path>."
16307 #: ../src/guestfs-actions.pod:5427
16308 msgid "guestfs_rm_rf"
16313 #: ../src/guestfs-actions.pod:5429
16317 " guestfs_rm_rf (guestfs_h *g,\n"
16318 " const char *path);\n"
16324 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:3620
16326 "Remove the file or directory C<path>, recursively removing the contents if "
16327 "its a directory. This is like the C<rm -rf> shell command."
16332 #: ../src/guestfs-actions.pod:5441
16333 msgid "guestfs_rmdir"
16338 #: ../src/guestfs-actions.pod:5443
16342 " guestfs_rmdir (guestfs_h *g,\n"
16343 " const char *path);\n"
16349 #: ../src/guestfs-actions.pod:5447 ../fish/guestfish-actions.pod:3628
16350 msgid "Remove the single directory C<path>."
16355 #: ../src/guestfs-actions.pod:5453
16356 msgid "guestfs_rmmountpoint"
16361 #: ../src/guestfs-actions.pod:5455
16365 " guestfs_rmmountpoint (guestfs_h *g,\n"
16366 " const char *exemptpath);\n"
16372 #: ../src/guestfs-actions.pod:5459
16374 "This calls removes a mountpoint that was previously created with "
16375 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16380 #: ../src/guestfs-actions.pod:5467
16381 msgid "guestfs_scrub_device"
16386 #: ../src/guestfs-actions.pod:5469
16390 " guestfs_scrub_device (guestfs_h *g,\n"
16391 " const char *device);\n"
16397 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3642
16399 "This command writes patterns over C<device> to make data retrieval more "
16405 #: ../src/guestfs-actions.pod:5476 ../src/guestfs-actions.pod:5497
16406 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3645
16407 #: ../fish/guestfish-actions.pod:3660 ../fish/guestfish-actions.pod:3673
16409 "It is an interface to the L<scrub(1)> program. See that manual page for "
16415 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5502
16416 #: ../src/guestfs-actions.pod:5521
16417 msgid "(Added in 1.0.52)"
16422 #: ../src/guestfs-actions.pod:5486
16423 msgid "guestfs_scrub_file"
16428 #: ../src/guestfs-actions.pod:5488
16432 " guestfs_scrub_file (guestfs_h *g,\n"
16433 " const char *file);\n"
16439 #: ../src/guestfs-actions.pod:5492 ../fish/guestfish-actions.pod:3655
16441 "This command writes patterns over a file to make data retrieval more "
16447 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3658
16448 msgid "The file is I<removed> after scrubbing."
16453 #: ../src/guestfs-actions.pod:5504
16454 msgid "guestfs_scrub_freespace"
16459 #: ../src/guestfs-actions.pod:5506
16463 " guestfs_scrub_freespace (guestfs_h *g,\n"
16464 " const char *dir);\n"
16470 #: ../src/guestfs-actions.pod:5510
16472 "This command creates the directory C<dir> and then fills it with files until "
16473 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16474 "and deletes them. The intention is to scrub any free space on the partition "
16475 "containing C<dir>."
16480 #: ../src/guestfs-actions.pod:5523
16481 msgid "guestfs_set_append"
16486 #: ../src/guestfs-actions.pod:5525
16490 " guestfs_set_append (guestfs_h *g,\n"
16491 " const char *append);\n"
16497 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3682
16499 "This function is used to add additional options to the guest kernel command "
16505 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3685
16507 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16508 "environment variable."
16513 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3688
16515 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16516 "(libguestfs always adds a few of its own)."
16521 #: ../src/guestfs-actions.pod:5542
16522 msgid "guestfs_set_autosync"
16527 #: ../src/guestfs-actions.pod:5544
16531 " guestfs_set_autosync (guestfs_h *g,\n"
16532 " int autosync);\n"
16538 #: ../src/guestfs-actions.pod:5548
16540 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16541 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
16542 "the handle is closed (also if the program exits without closing handles)."
16547 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3702
16549 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16550 "disabled by default)."
16555 #: ../src/guestfs-actions.pod:5560
16556 msgid "guestfs_set_direct"
16561 #: ../src/guestfs-actions.pod:5562
16565 " guestfs_set_direct (guestfs_h *g,\n"
16572 #: ../src/guestfs-actions.pod:5566 ../fish/guestfish-actions.pod:3711
16574 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16575 "passed directly through to the appliance once it is launched."
16580 #: ../src/guestfs-actions.pod:5570
16582 "One consequence of this is that log messages aren't caught by the library "
16583 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16589 #: ../src/guestfs-actions.pod:5574 ../fish/guestfish-actions.pod:3719
16590 msgid "You probably don't want to use this unless you know what you are doing."
16595 #: ../src/guestfs-actions.pod:5577 ../fish/guestfish-actions.pod:3722
16596 msgid "The default is disabled."
16601 #: ../src/guestfs-actions.pod:5583
16602 msgid "guestfs_set_e2label"
16607 #: ../src/guestfs-actions.pod:5585
16611 " guestfs_set_e2label (guestfs_h *g,\n"
16612 " const char *device,\n"
16613 " const char *label);\n"
16619 #: ../src/guestfs-actions.pod:5590 ../fish/guestfish-actions.pod:3728
16621 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16622 "C<label>. Filesystem labels are limited to 16 characters."
16627 #: ../src/guestfs-actions.pod:5594
16629 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16630 "the existing label on a filesystem."
16635 #: ../src/guestfs-actions.pod:5601
16636 msgid "guestfs_set_e2uuid"
16641 #: ../src/guestfs-actions.pod:5603
16645 " guestfs_set_e2uuid (guestfs_h *g,\n"
16646 " const char *device,\n"
16647 " const char *uuid);\n"
16653 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3739
16655 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16656 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16657 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16662 #: ../src/guestfs-actions.pod:5613
16664 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16665 "the existing UUID of a filesystem."
16670 #: ../src/guestfs-actions.pod:5620
16671 msgid "guestfs_set_memsize"
16676 #: ../src/guestfs-actions.pod:5622
16680 " guestfs_set_memsize (guestfs_h *g,\n"
16687 #: ../src/guestfs-actions.pod:5626
16689 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16690 "This only has any effect if called before C<guestfs_launch>."
16695 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3757
16697 "You can also change this by setting the environment variable "
16698 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16703 #: ../src/guestfs-actions.pod:5641
16704 msgid "guestfs_set_network"
16709 #: ../src/guestfs-actions.pod:5643
16713 " guestfs_set_network (guestfs_h *g,\n"
16720 #: ../src/guestfs-actions.pod:5647 ../fish/guestfish-actions.pod:3770
16722 "If C<network> is true, then the network is enabled in the libguestfs "
16723 "appliance. The default is false."
16728 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3773
16730 "This affects whether commands are able to access the network (see L<guestfs"
16731 "(3)/RUNNING COMMANDS>)."
16736 #: ../src/guestfs-actions.pod:5653
16738 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16744 #: ../src/guestfs-actions.pod:5660
16745 msgid "guestfs_set_path"
16750 #: ../src/guestfs-actions.pod:5662
16754 " guestfs_set_path (guestfs_h *g,\n"
16755 " const char *searchpath);\n"
16761 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3785
16762 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16767 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3787
16769 "The default is C<$libdir/guestfs> unless overridden by setting "
16770 "C<LIBGUESTFS_PATH> environment variable."
16775 #: ../src/guestfs-actions.pod:5671 ../fish/guestfish-actions.pod:3790
16776 msgid "Setting C<path> to C<NULL> restores the default path."
16781 #: ../src/guestfs-actions.pod:5677
16782 msgid "guestfs_set_qemu"
16787 #: ../src/guestfs-actions.pod:5679
16791 " guestfs_set_qemu (guestfs_h *g,\n"
16792 " const char *qemu);\n"
16798 #: ../src/guestfs-actions.pod:5683 ../fish/guestfish-actions.pod:3798
16799 msgid "Set the qemu binary that we will use."
16804 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3800
16806 "The default is chosen when the library was compiled by the configure script."
16811 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3803
16813 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16819 #: ../src/guestfs-actions.pod:5691 ../fish/guestfish-actions.pod:3806
16820 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16825 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3808
16827 "Note that you should call this function as early as possible after creating "
16828 "the handle. This is because some pre-launch operations depend on testing "
16829 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16830 "don't retest features, and so you might see inconsistent results. Using the "
16831 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16832 "the qemu binary at the same time as the handle is created."
16837 #: ../src/guestfs-actions.pod:5705
16838 msgid "guestfs_set_recovery_proc"
16843 #: ../src/guestfs-actions.pod:5707
16847 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16848 " int recoveryproc);\n"
16854 #: ../src/guestfs-actions.pod:5711
16856 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16857 "not create a recovery process. The purpose of the recovery process is to "
16858 "stop runaway qemu processes in the case where the main program aborts "
16864 #: ../src/guestfs-actions.pod:5716
16866 "This only has any effect if called before C<guestfs_launch>, and the default "
16872 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3830
16874 "About the only time when you would want to disable this is if the main "
16875 "process will fork itself into the background (\"daemonize\" itself). In "
16876 "this case the recovery process thinks that the main program has disappeared "
16877 "and so kills qemu, which is not very helpful."
16882 #: ../src/guestfs-actions.pod:5729
16883 msgid "guestfs_set_selinux"
16888 #: ../src/guestfs-actions.pod:5731
16892 " guestfs_set_selinux (guestfs_h *g,\n"
16899 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3842
16901 "This sets the selinux flag that is passed to the appliance at boot time. "
16902 "The default is C<selinux=0> (disabled)."
16907 #: ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:3845
16909 "Note that if SELinux is enabled, it is always in Permissive mode "
16910 "(C<enforcing=0>)."
16915 #: ../src/guestfs-actions.pod:5748
16916 msgid "guestfs_set_trace"
16921 #: ../src/guestfs-actions.pod:5750
16925 " guestfs_set_trace (guestfs_h *g,\n"
16932 #: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3857
16934 "If the command trace flag is set to 1, then commands are printed on stderr "
16935 "before they are executed in a format which is very similar to the one used "
16936 "by guestfish. In other words, you can run a program with this enabled, and "
16937 "you will get out a script which you can feed to guestfish to perform the "
16938 "same set of actions."
16943 #: ../src/guestfs-actions.pod:5761 ../fish/guestfish-actions.pod:3864
16945 "If you want to trace C API calls into libguestfs (and other libraries) then "
16946 "possibly a better way is to use the external ltrace(1) command."
16951 #: ../src/guestfs-actions.pod:5765 ../fish/guestfish-actions.pod:3868
16953 "Command traces are disabled unless the environment variable "
16954 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16959 #: ../src/guestfs-actions.pod:5772
16960 msgid "guestfs_set_verbose"
16965 #: ../src/guestfs-actions.pod:5774
16969 " guestfs_set_verbose (guestfs_h *g,\n"
16976 #: ../src/guestfs-actions.pod:5778 ../fish/guestfish-actions.pod:3877
16977 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
16982 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3879
16984 "Verbose messages are disabled unless the environment variable "
16985 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16990 #: ../src/guestfs-actions.pod:5787
16991 msgid "guestfs_setcon"
16996 #: ../src/guestfs-actions.pod:5789
17000 " guestfs_setcon (guestfs_h *g,\n"
17001 " const char *context);\n"
17007 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3886
17009 "This sets the SELinux security context of the daemon to the string "
17015 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3889
17016 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17021 #: ../src/guestfs-actions.pod:5802
17022 msgid "guestfs_setxattr"
17027 #: ../src/guestfs-actions.pod:5804
17031 " guestfs_setxattr (guestfs_h *g,\n"
17032 " const char *xattr,\n"
17033 " const char *val,\n"
17035 " const char *path);\n"
17041 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3895
17043 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17044 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17049 #: ../src/guestfs-actions.pod:5815
17050 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17055 #: ../src/guestfs-actions.pod:5821
17056 msgid "guestfs_sfdisk"
17061 #: ../src/guestfs-actions.pod:5823
17065 " guestfs_sfdisk (guestfs_h *g,\n"
17066 " const char *device,\n"
17070 " char *const *lines);\n"
17076 #: ../src/guestfs-actions.pod:5831 ../fish/guestfish-actions.pod:3905
17078 "This is a direct interface to the L<sfdisk(8)> program for creating "
17079 "partitions on block devices."
17084 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3908
17085 msgid "C<device> should be a block device, for example C</dev/sda>."
17090 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3910
17092 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17093 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17094 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17095 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17096 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17097 "the kernel) cannot work out the right geometry and you will need to tell it."
17102 #: ../src/guestfs-actions.pod:5844 ../fish/guestfish-actions.pod:3918
17104 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17105 "refer to the L<sfdisk(8)> manpage."
17110 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3921
17112 "To create a single partition occupying the whole disk, you would pass "
17113 "C<lines> as a single element list, when the single element being the string "
17119 #: ../src/guestfs-actions.pod:5851
17121 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17126 #: ../src/guestfs-actions.pod:5861
17127 msgid "guestfs_sfdiskM"
17132 #: ../src/guestfs-actions.pod:5863
17136 " guestfs_sfdiskM (guestfs_h *g,\n"
17137 " const char *device,\n"
17138 " char *const *lines);\n"
17144 #: ../src/guestfs-actions.pod:5868
17146 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17147 "partition sizes are specified in megabytes only (rounded to the nearest "
17148 "cylinder) and you don't need to specify the cyls, heads and sectors "
17149 "parameters which were rarely if ever used anyway."
17154 #: ../src/guestfs-actions.pod:5874
17156 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17157 "C<guestfs_part_disk>"
17162 #: ../src/guestfs-actions.pod:5884
17163 msgid "guestfs_sfdisk_N"
17168 #: ../src/guestfs-actions.pod:5886
17172 " guestfs_sfdisk_N (guestfs_h *g,\n"
17173 " const char *device,\n"
17178 " const char *line);\n"
17184 #: ../src/guestfs-actions.pod:5895 ../fish/guestfish-actions.pod:3951
17186 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17187 "(note: C<n> counts from 1)."
17192 #: ../src/guestfs-actions.pod:5898
17194 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17195 "for the cyls/heads/sectors parameters."
17200 #: ../src/guestfs-actions.pod:5901
17201 msgid "See also: C<guestfs_part_add>"
17206 #: ../src/guestfs-actions.pod:5910
17207 msgid "guestfs_sfdisk_disk_geometry"
17212 #: ../src/guestfs-actions.pod:5912
17216 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17217 " const char *device);\n"
17223 #: ../src/guestfs-actions.pod:5916
17225 "This displays the disk geometry of C<device> read from the partition table. "
17226 "Especially in the case where the underlying block device has been resized, "
17227 "this can be different from the kernel's idea of the geometry (see "
17228 "C<guestfs_sfdisk_kernel_geometry>)."
17233 #: ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5937
17234 #: ../fish/guestfish-actions.pod:3971 ../fish/guestfish-actions.pod:3980
17235 msgid "The result is in human-readable format, and not designed to be parsed."
17240 #: ../src/guestfs-actions.pod:5929
17241 msgid "guestfs_sfdisk_kernel_geometry"
17246 #: ../src/guestfs-actions.pod:5931
17250 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17251 " const char *device);\n"
17257 #: ../src/guestfs-actions.pod:5935 ../fish/guestfish-actions.pod:3978
17258 msgid "This displays the kernel's idea of the geometry of C<device>."
17263 #: ../src/guestfs-actions.pod:5945
17264 msgid "guestfs_sfdisk_l"
17269 #: ../src/guestfs-actions.pod:5947
17273 " guestfs_sfdisk_l (guestfs_h *g,\n"
17274 " const char *device);\n"
17280 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3987
17282 "This displays the partition table on C<device>, in the human-readable output "
17283 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17288 #: ../src/guestfs-actions.pod:5955
17289 msgid "See also: C<guestfs_part_list>"
17294 #: ../src/guestfs-actions.pod:5962
17300 #: ../src/guestfs-actions.pod:5964
17304 " guestfs_sh (guestfs_h *g,\n"
17305 " const char *command);\n"
17311 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:3997
17313 "This call runs a command from the guest filesystem via the guest's C</bin/"
17319 #: ../src/guestfs-actions.pod:5971
17320 msgid "This is like C<guestfs_command>, but passes the command to:"
17325 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4002
17328 " /bin/sh -c \"command\"\n"
17334 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:4004
17336 "Depending on the guest's shell, this usually results in wildcards being "
17337 "expanded, shell expressions being interpolated and so on."
17342 #: ../src/guestfs-actions.pod:5979
17343 msgid "All the provisos about C<guestfs_command> apply to this call."
17348 #: ../src/guestfs-actions.pod:5986
17349 msgid "guestfs_sh_lines"
17354 #: ../src/guestfs-actions.pod:5988
17358 " guestfs_sh_lines (guestfs_h *g,\n"
17359 " const char *command);\n"
17365 #: ../src/guestfs-actions.pod:5992
17367 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17373 #: ../src/guestfs-actions.pod:5995
17374 msgid "See also: C<guestfs_command_lines>"
17379 #: ../src/guestfs-actions.pod:6003
17380 msgid "guestfs_sleep"
17385 #: ../src/guestfs-actions.pod:6005
17389 " guestfs_sleep (guestfs_h *g,\n"
17396 #: ../src/guestfs-actions.pod:6009 ../fish/guestfish-actions.pod:4023
17397 msgid "Sleep for C<secs> seconds."
17402 #: ../src/guestfs-actions.pod:6013
17403 msgid "(Added in 1.0.41)"
17408 #: ../src/guestfs-actions.pod:6015 ../src/guestfs-structs.pod:109
17409 msgid "guestfs_stat"
17414 #: ../src/guestfs-actions.pod:6017
17417 " struct guestfs_stat *\n"
17418 " guestfs_stat (guestfs_h *g,\n"
17419 " const char *path);\n"
17425 #: ../src/guestfs-actions.pod:6023 ../fish/guestfish-actions.pod:4031
17426 msgid "This is the same as the C<stat(2)> system call."
17431 #: ../src/guestfs-actions.pod:6031 ../src/guestfs-structs.pod:135
17432 msgid "guestfs_statvfs"
17437 #: ../src/guestfs-actions.pod:6033
17440 " struct guestfs_statvfs *\n"
17441 " guestfs_statvfs (guestfs_h *g,\n"
17442 " const char *path);\n"
17448 #: ../src/guestfs-actions.pod:6037 ../fish/guestfish-actions.pod:4037
17450 "Returns file system statistics for any mounted file system. C<path> should "
17451 "be a file or directory in the mounted file system (typically it is the mount "
17452 "point itself, but it doesn't need to be)."
17457 #: ../src/guestfs-actions.pod:6041 ../fish/guestfish-actions.pod:4041
17458 msgid "This is the same as the C<statvfs(2)> system call."
17463 #: ../src/guestfs-actions.pod:6043
17465 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17466 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17471 #: ../src/guestfs-actions.pod:6049
17472 msgid "guestfs_strings"
17477 #: ../src/guestfs-actions.pod:6051
17481 " guestfs_strings (guestfs_h *g,\n"
17482 " const char *path);\n"
17488 #: ../src/guestfs-actions.pod:6055 ../fish/guestfish-actions.pod:4047
17490 "This runs the L<strings(1)> command on a file and returns the list of "
17491 "printable strings found."
17496 #: ../src/guestfs-actions.pod:6067
17497 msgid "guestfs_strings_e"
17502 #: ../src/guestfs-actions.pod:6069
17506 " guestfs_strings_e (guestfs_h *g,\n"
17507 " const char *encoding,\n"
17508 " const char *path);\n"
17514 #: ../src/guestfs-actions.pod:6074
17516 "This is like the C<guestfs_strings> command, but allows you to specify the "
17517 "encoding of strings that are looked for in the source file C<path>."
17522 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4061
17523 msgid "Allowed encodings are:"
17528 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4065
17534 #: ../src/guestfs-actions.pod:6084
17536 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17537 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17542 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
17548 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4072
17549 msgid "Single 8-bit-byte characters."
17554 #: ../src/guestfs-actions.pod:6091 ../fish/guestfish-actions.pod:4074
17560 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4076
17561 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17566 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4079
17567 msgid "l (lower case letter L)"
17572 #: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4081
17574 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17575 "examining binaries in Windows guests."
17580 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4084
17586 #: ../src/guestfs-actions.pod:6103 ../fish/guestfish-actions.pod:4086
17587 msgid "32-bit big endian such as UCS-4BE."
17592 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4088
17598 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4090
17599 msgid "32-bit little endian such as UCS-4LE."
17604 #: ../src/guestfs-actions.pod:6111 ../fish/guestfish-actions.pod:4094
17605 msgid "The returned strings are transcoded to UTF-8."
17610 #: ../src/guestfs-actions.pod:6122
17611 msgid "guestfs_swapoff_device"
17616 #: ../src/guestfs-actions.pod:6124
17620 " guestfs_swapoff_device (guestfs_h *g,\n"
17621 " const char *device);\n"
17627 #: ../src/guestfs-actions.pod:6128
17629 "This command disables the libguestfs appliance swap device or partition "
17630 "named C<device>. See C<guestfs_swapon_device>."
17635 #: ../src/guestfs-actions.pod:6136
17636 msgid "guestfs_swapoff_file"
17641 #: ../src/guestfs-actions.pod:6138
17645 " guestfs_swapoff_file (guestfs_h *g,\n"
17646 " const char *file);\n"
17652 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4111
17653 msgid "This command disables the libguestfs appliance swap on file."
17658 #: ../src/guestfs-actions.pod:6148
17659 msgid "guestfs_swapoff_label"
17664 #: ../src/guestfs-actions.pod:6150
17668 " guestfs_swapoff_label (guestfs_h *g,\n"
17669 " const char *label);\n"
17675 #: ../src/guestfs-actions.pod:6154 ../fish/guestfish-actions.pod:4117
17677 "This command disables the libguestfs appliance swap on labeled swap "
17683 #: ../src/guestfs-actions.pod:6161
17684 msgid "guestfs_swapoff_uuid"
17689 #: ../src/guestfs-actions.pod:6163
17693 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17694 " const char *uuid);\n"
17700 #: ../src/guestfs-actions.pod:6167 ../fish/guestfish-actions.pod:4124
17702 "This command disables the libguestfs appliance swap partition with the given "
17708 #: ../src/guestfs-actions.pod:6174
17709 msgid "guestfs_swapon_device"
17714 #: ../src/guestfs-actions.pod:6176
17718 " guestfs_swapon_device (guestfs_h *g,\n"
17719 " const char *device);\n"
17725 #: ../src/guestfs-actions.pod:6180
17727 "This command enables the libguestfs appliance to use the swap device or "
17728 "partition named C<device>. The increased memory is made available for all "
17729 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17734 #: ../src/guestfs-actions.pod:6185 ../fish/guestfish-actions.pod:4136
17736 "Note that you should not swap to existing guest swap partitions unless you "
17737 "know what you are doing. They may contain hibernation information, or other "
17738 "information that the guest doesn't want you to trash. You also risk leaking "
17739 "information about the host to the guest this way. Instead, attach a new "
17740 "host device to the guest and swap on that."
17745 #: ../src/guestfs-actions.pod:6196
17746 msgid "guestfs_swapon_file"
17751 #: ../src/guestfs-actions.pod:6198
17755 " guestfs_swapon_file (guestfs_h *g,\n"
17756 " const char *file);\n"
17762 #: ../src/guestfs-actions.pod:6202
17764 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17770 #: ../src/guestfs-actions.pod:6209
17771 msgid "guestfs_swapon_label"
17776 #: ../src/guestfs-actions.pod:6211
17780 " guestfs_swapon_label (guestfs_h *g,\n"
17781 " const char *label);\n"
17787 #: ../src/guestfs-actions.pod:6215
17789 "This command enables swap to a labeled swap partition. See "
17790 "C<guestfs_swapon_device> for other notes."
17795 #: ../src/guestfs-actions.pod:6222
17796 msgid "guestfs_swapon_uuid"
17801 #: ../src/guestfs-actions.pod:6224
17805 " guestfs_swapon_uuid (guestfs_h *g,\n"
17806 " const char *uuid);\n"
17812 #: ../src/guestfs-actions.pod:6228
17814 "This command enables swap to a swap partition with the given UUID. See "
17815 "C<guestfs_swapon_device> for other notes."
17820 #: ../src/guestfs-actions.pod:6235
17821 msgid "guestfs_sync"
17826 #: ../src/guestfs-actions.pod:6237
17830 " guestfs_sync (guestfs_h *g);\n"
17836 #: ../src/guestfs-actions.pod:6240 ../fish/guestfish-actions.pod:4168
17838 "This syncs the disk, so that any writes are flushed through to the "
17839 "underlying disk image."
17844 #: ../src/guestfs-actions.pod:6243 ../fish/guestfish-actions.pod:4171
17846 "You should always call this if you have modified a disk image, before "
17847 "closing the handle."
17852 #: ../src/guestfs-actions.pod:6250
17853 msgid "guestfs_tail"
17858 #: ../src/guestfs-actions.pod:6252
17862 " guestfs_tail (guestfs_h *g,\n"
17863 " const char *path);\n"
17869 #: ../src/guestfs-actions.pod:6256 ../fish/guestfish-actions.pod:4178
17871 "This command returns up to the last 10 lines of a file as a list of strings."
17876 #: ../src/guestfs-actions.pod:6268
17877 msgid "guestfs_tail_n"
17882 #: ../src/guestfs-actions.pod:6270
17886 " guestfs_tail_n (guestfs_h *g,\n"
17888 " const char *path);\n"
17894 #: ../src/guestfs-actions.pod:6275 ../fish/guestfish-actions.pod:4188
17896 "If the parameter C<nrlines> is a positive number, this returns the last "
17897 "C<nrlines> lines of the file C<path>."
17902 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4191
17904 "If the parameter C<nrlines> is a negative number, this returns lines from "
17905 "the file C<path>, starting with the C<-nrlines>th line."
17910 #: ../src/guestfs-actions.pod:6292
17911 msgid "guestfs_tar_in"
17916 #: ../src/guestfs-actions.pod:6294
17920 " guestfs_tar_in (guestfs_h *g,\n"
17921 " const char *tarfile,\n"
17922 " const char *directory);\n"
17928 #: ../src/guestfs-actions.pod:6299 ../fish/guestfish-actions.pod:4203
17930 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17931 "tar file) into C<directory>."
17936 #: ../src/guestfs-actions.pod:6302
17938 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17943 #: ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6324
17944 #: ../src/guestfs-actions.pod:6340 ../src/guestfs-actions.pod:6356
17945 msgid "(Added in 1.0.3)"
17950 #: ../src/guestfs-actions.pod:6309
17951 msgid "guestfs_tar_out"
17956 #: ../src/guestfs-actions.pod:6311
17960 " guestfs_tar_out (guestfs_h *g,\n"
17961 " const char *directory,\n"
17962 " const char *tarfile);\n"
17968 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4215
17970 "This command packs the contents of C<directory> and downloads it to local "
17976 #: ../src/guestfs-actions.pod:6319
17978 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17979 "C<guestfs_txz_out>."
17984 #: ../src/guestfs-actions.pod:6326
17985 msgid "guestfs_tgz_in"
17990 #: ../src/guestfs-actions.pod:6328
17994 " guestfs_tgz_in (guestfs_h *g,\n"
17995 " const char *tarball,\n"
17996 " const char *directory);\n"
18002 #: ../src/guestfs-actions.pod:6333 ../fish/guestfish-actions.pod:4227
18004 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18005 "tar file) into C<directory>."
18010 #: ../src/guestfs-actions.pod:6336
18011 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18016 #: ../src/guestfs-actions.pod:6342
18017 msgid "guestfs_tgz_out"
18022 #: ../src/guestfs-actions.pod:6344
18026 " guestfs_tgz_out (guestfs_h *g,\n"
18027 " const char *directory,\n"
18028 " const char *tarball);\n"
18034 #: ../src/guestfs-actions.pod:6349 ../fish/guestfish-actions.pod:4238
18036 "This command packs the contents of C<directory> and downloads it to local "
18042 #: ../src/guestfs-actions.pod:6352
18043 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18048 #: ../src/guestfs-actions.pod:6358
18049 msgid "guestfs_touch"
18054 #: ../src/guestfs-actions.pod:6360
18058 " guestfs_touch (guestfs_h *g,\n"
18059 " const char *path);\n"
18065 #: ../src/guestfs-actions.pod:6364 ../fish/guestfish-actions.pod:4249
18067 "Touch acts like the L<touch(1)> command. It can be used to update the "
18068 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18074 #: ../src/guestfs-actions.pod:6368 ../fish/guestfish-actions.pod:4253
18076 "This command only works on regular files, and will fail on other file types "
18077 "such as directories, symbolic links, block special etc."
18082 #: ../src/guestfs-actions.pod:6375
18083 msgid "guestfs_truncate"
18088 #: ../src/guestfs-actions.pod:6377
18092 " guestfs_truncate (guestfs_h *g,\n"
18093 " const char *path);\n"
18099 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4260
18101 "This command truncates C<path> to a zero-length file. The file must exist "
18107 #: ../src/guestfs-actions.pod:6388
18108 msgid "guestfs_truncate_size"
18113 #: ../src/guestfs-actions.pod:6390
18117 " guestfs_truncate_size (guestfs_h *g,\n"
18118 " const char *path,\n"
18119 " int64_t size);\n"
18125 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4267
18127 "This command truncates C<path> to size C<size> bytes. The file must exist "
18133 #: ../src/guestfs-actions.pod:6398
18135 "If the current file size is less than C<size> then the file is extended to "
18136 "the required size with zero bytes. This creates a sparse file (ie. disk "
18137 "blocks are not allocated for the file until you write to it). To create a "
18138 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18143 #: ../src/guestfs-actions.pod:6408
18144 msgid "guestfs_tune2fs_l"
18149 #: ../src/guestfs-actions.pod:6410
18153 " guestfs_tune2fs_l (guestfs_h *g,\n"
18154 " const char *device);\n"
18160 #: ../src/guestfs-actions.pod:6414 ../fish/guestfish-actions.pod:4280
18162 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18168 #: ../src/guestfs-actions.pod:6417 ../fish/guestfish-actions.pod:4283
18170 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18171 "for more details. The list of fields returned isn't clearly defined, and "
18172 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18173 "and the filesystem itself."
18178 #: ../src/guestfs-actions.pod:6430
18179 msgid "guestfs_txz_in"
18184 #: ../src/guestfs-actions.pod:6432
18188 " guestfs_txz_in (guestfs_h *g,\n"
18189 " const char *tarball,\n"
18190 " const char *directory);\n"
18196 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4292
18198 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18199 "tar file) into C<directory>."
18204 #: ../src/guestfs-actions.pod:6444
18205 msgid "guestfs_txz_out"
18210 #: ../src/guestfs-actions.pod:6446
18214 " guestfs_txz_out (guestfs_h *g,\n"
18215 " const char *directory,\n"
18216 " const char *tarball);\n"
18222 #: ../src/guestfs-actions.pod:6451 ../fish/guestfish-actions.pod:4301
18224 "This command packs the contents of C<directory> and downloads it to local "
18225 "file C<tarball> (as an xz compressed tar archive)."
18230 #: ../src/guestfs-actions.pod:6458
18231 msgid "guestfs_umask"
18236 #: ../src/guestfs-actions.pod:6460
18240 " guestfs_umask (guestfs_h *g,\n"
18247 #: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4310
18249 "This function sets the mask used for creating new files and device nodes to "
18255 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4313
18257 "Typical umask values would be C<022> which creates new files with "
18258 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18259 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18264 #: ../src/guestfs-actions.pod:6472 ../fish/guestfish-actions.pod:4318
18266 "The default umask is C<022>. This is important because it means that "
18267 "directories and device nodes will be created with C<0644> or C<0755> mode "
18268 "even if you specify C<0777>."
18273 #: ../src/guestfs-actions.pod:6476
18275 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18276 "C<guestfs_mkdir>."
18281 #: ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:4325
18282 msgid "This call returns the previous umask."
18287 #: ../src/guestfs-actions.pod:6485
18288 msgid "guestfs_umount"
18293 #: ../src/guestfs-actions.pod:6487
18297 " guestfs_umount (guestfs_h *g,\n"
18298 " const char *pathordevice);\n"
18304 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4333
18306 "This unmounts the given filesystem. The filesystem may be specified either "
18307 "by its mountpoint (path) or the device which contains the filesystem."
18312 #: ../src/guestfs-actions.pod:6499
18313 msgid "guestfs_umount_all"
18318 #: ../src/guestfs-actions.pod:6501
18322 " guestfs_umount_all (guestfs_h *g);\n"
18328 #: ../src/guestfs-actions.pod:6504 ../fish/guestfish-actions.pod:4343
18329 msgid "This unmounts all mounted filesystems."
18334 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4345
18335 msgid "Some internal mounts are not unmounted by this call."
18340 #: ../src/guestfs-actions.pod:6512
18341 msgid "guestfs_upload"
18346 #: ../src/guestfs-actions.pod:6514
18350 " guestfs_upload (guestfs_h *g,\n"
18351 " const char *filename,\n"
18352 " const char *remotefilename);\n"
18358 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6543
18359 #: ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4364
18360 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18365 #: ../src/guestfs-actions.pod:6524
18366 msgid "See also C<guestfs_download>."
18371 #: ../src/guestfs-actions.pod:6535
18372 msgid "guestfs_upload_offset"
18377 #: ../src/guestfs-actions.pod:6537
18381 " guestfs_upload_offset (guestfs_h *g,\n"
18382 " const char *filename,\n"
18383 " const char *remotefilename,\n"
18384 " int64_t offset);\n"
18390 #: ../src/guestfs-actions.pod:6546 ../fish/guestfish-actions.pod:4367
18392 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18393 "The intention is to overwrite parts of existing files or devices, although "
18394 "if a non-existant file is specified then it is created with a \"hole\" "
18395 "before C<offset>. The size of the data written is implicit in the size of "
18396 "the source C<filename>."
18401 #: ../src/guestfs-actions.pod:6553
18403 "Note that there is no limit on the amount of data that can be uploaded with "
18404 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18405 "full amount unless an error occurs."
18410 #: ../src/guestfs-actions.pod:6558
18411 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18416 #: ../src/guestfs-actions.pod:6569
18417 msgid "guestfs_utimens"
18422 #: ../src/guestfs-actions.pod:6571
18426 " guestfs_utimens (guestfs_h *g,\n"
18427 " const char *path,\n"
18428 " int64_t atsecs,\n"
18429 " int64_t atnsecs,\n"
18430 " int64_t mtsecs,\n"
18431 " int64_t mtnsecs);\n"
18437 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4387
18438 msgid "This command sets the timestamps of a file with nanosecond precision."
18443 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4390
18445 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18451 #: ../src/guestfs-actions.pod:6585 ../fish/guestfish-actions.pod:4393
18453 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18454 "nanoseconds from the epoch."
18459 #: ../src/guestfs-actions.pod:6588 ../fish/guestfish-actions.pod:4396
18461 "If the C<*nsecs> field contains the special value C<-1> then the "
18462 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18463 "ignored in this case)."
18468 #: ../src/guestfs-actions.pod:6592 ../fish/guestfish-actions.pod:4400
18470 "If the C<*nsecs> field contains the special value C<-2> then the "
18471 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18477 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-structs.pod:175
18478 msgid "guestfs_version"
18483 #: ../src/guestfs-actions.pod:6602
18486 " struct guestfs_version *\n"
18487 " guestfs_version (guestfs_h *g);\n"
18493 #: ../src/guestfs-actions.pod:6605 ../fish/guestfish-actions.pod:4408
18495 "Return the libguestfs version number that the program is linked against."
18500 #: ../src/guestfs-actions.pod:6608 ../fish/guestfish-actions.pod:4411
18502 "Note that because of dynamic linking this is not necessarily the version of "
18503 "libguestfs that you compiled against. You can compile the program, and then "
18504 "at runtime dynamically link against a completely different C<libguestfs.so> "
18510 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
18512 "This call was added in version C<1.0.58>. In previous versions of "
18513 "libguestfs there was no way to get the version number. From C code you can "
18514 "use dynamic linker functions to find out if this symbol exists (if it "
18515 "doesn't, then it's an earlier version)."
18520 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4422
18522 "The call returns a structure with four elements. The first three (C<major>, "
18523 "C<minor> and C<release>) are numbers and correspond to the usual version "
18524 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18525 "but may be used for distro-specific information."
18530 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4428
18532 "To construct the original version string: C<$major.$minor.$release$extra>"
18537 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4431
18538 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18543 #: ../src/guestfs-actions.pod:6630
18545 "I<Note:> Don't use this call to test for availability of features. In "
18546 "enterprise distributions we backport features from later versions into "
18547 "earlier versions, making this an unreliable way to test for features. Use "
18548 "C<guestfs_available> instead."
18553 #: ../src/guestfs-actions.pod:6636
18555 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18556 "error. I<The caller must call C<guestfs_free_version> after use>."
18561 #: ../src/guestfs-actions.pod:6640
18562 msgid "(Added in 1.0.58)"
18567 #: ../src/guestfs-actions.pod:6642
18568 msgid "guestfs_vfs_label"
18573 #: ../src/guestfs-actions.pod:6644
18577 " guestfs_vfs_label (guestfs_h *g,\n"
18578 " const char *device);\n"
18584 #: ../src/guestfs-actions.pod:6648 ../fish/guestfish-actions.pod:4443
18585 msgid "This returns the filesystem label of the filesystem on C<device>."
18590 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4446
18591 msgid "If the filesystem is unlabeled, this returns the empty string."
18596 #: ../src/guestfs-actions.pod:6653
18597 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18602 #: ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6695
18603 msgid "(Added in 1.3.18)"
18608 #: ../src/guestfs-actions.pod:6660
18609 msgid "guestfs_vfs_type"
18614 #: ../src/guestfs-actions.pod:6662
18618 " guestfs_vfs_type (guestfs_h *g,\n"
18619 " const char *device);\n"
18625 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4454
18627 "This command gets the filesystem type corresponding to the filesystem on "
18633 #: ../src/guestfs-actions.pod:6669 ../fish/guestfish-actions.pod:4457
18635 "For most filesystems, the result is the name of the Linux VFS module which "
18636 "would be used to mount this filesystem if you mounted it without specifying "
18637 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18642 #: ../src/guestfs-actions.pod:6679
18643 msgid "guestfs_vfs_uuid"
18648 #: ../src/guestfs-actions.pod:6681
18652 " guestfs_vfs_uuid (guestfs_h *g,\n"
18653 " const char *device);\n"
18659 #: ../src/guestfs-actions.pod:6685 ../fish/guestfish-actions.pod:4466
18660 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18665 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4469
18666 msgid "If the filesystem does not have a UUID, this returns the empty string."
18671 #: ../src/guestfs-actions.pod:6690
18672 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18677 #: ../src/guestfs-actions.pod:6697
18678 msgid "guestfs_vg_activate"
18683 #: ../src/guestfs-actions.pod:6699
18687 " guestfs_vg_activate (guestfs_h *g,\n"
18689 " char *const *volgroups);\n"
18695 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4477
18697 "This command activates or (if C<activate> is false) deactivates all logical "
18698 "volumes in the listed volume groups C<volgroups>. If activated, then they "
18699 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
18700 "deactivated, then those devices disappear."
18705 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4483
18706 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18711 #: ../src/guestfs-actions.pod:6712 ../fish/guestfish-actions.pod:4485
18713 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18714 "activated or deactivated."
18719 #: ../src/guestfs-actions.pod:6719
18720 msgid "guestfs_vg_activate_all"
18725 #: ../src/guestfs-actions.pod:6721
18729 " guestfs_vg_activate_all (guestfs_h *g,\n"
18730 " int activate);\n"
18736 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4492
18738 "This command activates or (if C<activate> is false) deactivates all logical "
18739 "volumes in all volume groups. If activated, then they are made known to the "
18740 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
18741 "those devices disappear."
18746 #: ../src/guestfs-actions.pod:6731 ../fish/guestfish-actions.pod:4498
18747 msgid "This command is the same as running C<vgchange -a y|n>"
18752 #: ../src/guestfs-actions.pod:6737
18753 msgid "guestfs_vgcreate"
18758 #: ../src/guestfs-actions.pod:6739
18762 " guestfs_vgcreate (guestfs_h *g,\n"
18763 " const char *volgroup,\n"
18764 " char *const *physvols);\n"
18770 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4504
18772 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18773 "of physical volumes C<physvols>."
18778 #: ../src/guestfs-actions.pod:6751
18779 msgid "guestfs_vglvuuids"
18784 #: ../src/guestfs-actions.pod:6753
18788 " guestfs_vglvuuids (guestfs_h *g,\n"
18789 " const char *vgname);\n"
18795 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4511
18797 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18798 "volumes created in this volume group."
18803 #: ../src/guestfs-actions.pod:6760
18805 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18806 "associate logical volumes and volume groups."
18811 #: ../src/guestfs-actions.pod:6763
18812 msgid "See also C<guestfs_vgpvuuids>."
18817 #: ../src/guestfs-actions.pod:6771
18818 msgid "guestfs_vgpvuuids"
18823 #: ../src/guestfs-actions.pod:6773
18827 " guestfs_vgpvuuids (guestfs_h *g,\n"
18828 " const char *vgname);\n"
18834 #: ../src/guestfs-actions.pod:6777 ../fish/guestfish-actions.pod:4523
18836 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18837 "volumes that this volume group resides on."
18842 #: ../src/guestfs-actions.pod:6780
18844 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18845 "associate physical volumes and volume groups."
18850 #: ../src/guestfs-actions.pod:6783
18851 msgid "See also C<guestfs_vglvuuids>."
18856 #: ../src/guestfs-actions.pod:6791
18857 msgid "guestfs_vgremove"
18862 #: ../src/guestfs-actions.pod:6793
18866 " guestfs_vgremove (guestfs_h *g,\n"
18867 " const char *vgname);\n"
18873 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4535
18874 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18879 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4537
18881 "This also forcibly removes all logical volumes in the volume group (if any)."
18886 #: ../src/guestfs-actions.pod:6806
18887 msgid "guestfs_vgrename"
18892 #: ../src/guestfs-actions.pod:6808
18896 " guestfs_vgrename (guestfs_h *g,\n"
18897 " const char *volgroup,\n"
18898 " const char *newvolgroup);\n"
18904 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4544
18905 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18910 #: ../src/guestfs-actions.pod:6819
18911 msgid "guestfs_vgs"
18916 #: ../src/guestfs-actions.pod:6821
18920 " guestfs_vgs (guestfs_h *g);\n"
18926 #: ../src/guestfs-actions.pod:6824 ../fish/guestfish-actions.pod:4550
18928 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18934 #: ../src/guestfs-actions.pod:6827 ../fish/guestfish-actions.pod:4553
18936 "This returns a list of just the volume group names that were detected (eg. "
18942 #: ../src/guestfs-actions.pod:6830
18943 msgid "See also C<guestfs_vgs_full>."
18948 #: ../src/guestfs-actions.pod:6838
18949 msgid "guestfs_vgs_full"
18954 #: ../src/guestfs-actions.pod:6840
18957 " struct guestfs_lvm_vg_list *\n"
18958 " guestfs_vgs_full (guestfs_h *g);\n"
18964 #: ../src/guestfs-actions.pod:6843 ../fish/guestfish-actions.pod:4562
18966 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18967 "> command. The \"full\" version includes all fields."
18972 #: ../src/guestfs-actions.pod:6846
18974 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18975 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18980 #: ../src/guestfs-actions.pod:6852
18981 msgid "guestfs_vgscan"
18986 #: ../src/guestfs-actions.pod:6854
18990 " guestfs_vgscan (guestfs_h *g);\n"
18996 #: ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:4569
18998 "This rescans all block devices and rebuilds the list of LVM physical "
18999 "volumes, volume groups and logical volumes."
19004 #: ../src/guestfs-actions.pod:6864
19005 msgid "guestfs_vguuid"
19010 #: ../src/guestfs-actions.pod:6866
19014 " guestfs_vguuid (guestfs_h *g,\n"
19015 " const char *vgname);\n"
19021 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4576
19022 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19027 #: ../src/guestfs-actions.pod:6877
19028 msgid "guestfs_wait_ready"
19033 #: ../src/guestfs-actions.pod:6879
19037 " guestfs_wait_ready (guestfs_h *g);\n"
19043 #: ../src/guestfs-actions.pod:6882
19044 msgid "This function is a no op."
19049 #: ../src/guestfs-actions.pod:6884
19051 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19052 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19053 "is no longer necessary because C<guestfs_launch> now does the waiting."
19058 #: ../src/guestfs-actions.pod:6889
19060 "If you see any calls to this function in code then you can just remove them, "
19061 "unless you want to retain compatibility with older versions of the API."
19066 #: ../src/guestfs-actions.pod:6897
19067 msgid "guestfs_wc_c"
19072 #: ../src/guestfs-actions.pod:6899
19076 " guestfs_wc_c (guestfs_h *g,\n"
19077 " const char *path);\n"
19083 #: ../src/guestfs-actions.pod:6903 ../fish/guestfish-actions.pod:4582
19085 "This command counts the characters in a file, using the C<wc -c> external "
19091 #: ../src/guestfs-actions.pod:6910
19092 msgid "guestfs_wc_l"
19097 #: ../src/guestfs-actions.pod:6912
19101 " guestfs_wc_l (guestfs_h *g,\n"
19102 " const char *path);\n"
19108 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4589
19110 "This command counts the lines in a file, using the C<wc -l> external command."
19115 #: ../src/guestfs-actions.pod:6923
19116 msgid "guestfs_wc_w"
19121 #: ../src/guestfs-actions.pod:6925
19125 " guestfs_wc_w (guestfs_h *g,\n"
19126 " const char *path);\n"
19132 #: ../src/guestfs-actions.pod:6929 ../fish/guestfish-actions.pod:4596
19134 "This command counts the words in a file, using the C<wc -w> external command."
19139 #: ../src/guestfs-actions.pod:6936
19140 msgid "guestfs_write"
19145 #: ../src/guestfs-actions.pod:6938
19149 " guestfs_write (guestfs_h *g,\n"
19150 " const char *path,\n"
19151 " const char *content,\n"
19152 " size_t content_size);\n"
19158 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4603
19160 "This call creates a file called C<path>. The content of the file is the "
19161 "string C<content> (which can contain any 8 bit data)."
19166 #: ../src/guestfs-actions.pod:6954
19167 msgid "guestfs_write_file"
19172 #: ../src/guestfs-actions.pod:6956
19176 " guestfs_write_file (guestfs_h *g,\n"
19177 " const char *path,\n"
19178 " const char *content,\n"
19185 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4613
19187 "This call creates a file called C<path>. The contents of the file is the "
19188 "string C<content> (which can contain any 8 bit data), with length C<size>."
19193 #: ../src/guestfs-actions.pod:6966 ../fish/guestfish-actions.pod:4617
19195 "As a special case, if C<size> is C<0> then the length is calculated using "
19196 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19201 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4621
19203 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19204 "I<not> work, even if the length is specified."
19209 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4627
19211 "This function is deprecated. In new code, use the C<write> call instead."
19216 #: ../src/guestfs-actions.pod:6987
19217 msgid "guestfs_zegrep"
19222 #: ../src/guestfs-actions.pod:6989
19226 " guestfs_zegrep (guestfs_h *g,\n"
19227 " const char *regex,\n"
19228 " const char *path);\n"
19234 #: ../src/guestfs-actions.pod:6994 ../fish/guestfish-actions.pod:4638
19236 "This calls the external C<zegrep> program and returns the matching lines."
19241 #: ../src/guestfs-actions.pod:7006
19242 msgid "guestfs_zegrepi"
19247 #: ../src/guestfs-actions.pod:7008
19251 " guestfs_zegrepi (guestfs_h *g,\n"
19252 " const char *regex,\n"
19253 " const char *path);\n"
19259 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4648
19261 "This calls the external C<zegrep -i> program and returns the matching lines."
19266 #: ../src/guestfs-actions.pod:7025
19267 msgid "guestfs_zero"
19272 #: ../src/guestfs-actions.pod:7027
19276 " guestfs_zero (guestfs_h *g,\n"
19277 " const char *device);\n"
19283 #: ../src/guestfs-actions.pod:7031 ../fish/guestfish-actions.pod:4658
19284 msgid "This command writes zeroes over the first few blocks of C<device>."
19289 #: ../src/guestfs-actions.pod:7033 ../fish/guestfish-actions.pod:4660
19291 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19292 "securely wipe the device). It should be sufficient to remove any partition "
19293 "tables, filesystem superblocks and so on."
19298 #: ../src/guestfs-actions.pod:7037
19299 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
19304 #: ../src/guestfs-actions.pod:7048
19305 msgid "guestfs_zero_device"
19310 #: ../src/guestfs-actions.pod:7050
19314 " guestfs_zero_device (guestfs_h *g,\n"
19315 " const char *device);\n"
19321 #: ../src/guestfs-actions.pod:7054
19323 "This command writes zeroes over the entire C<device>. Compare with "
19324 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19329 #: ../src/guestfs-actions.pod:7068
19330 msgid "(Added in 1.3.1)"
19335 #: ../src/guestfs-actions.pod:7070
19336 msgid "guestfs_zerofree"
19341 #: ../src/guestfs-actions.pod:7072
19345 " guestfs_zerofree (guestfs_h *g,\n"
19346 " const char *device);\n"
19352 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4681
19354 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19355 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19356 "possible to compress the filesystem more effectively."
19361 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4686
19362 msgid "You should B<not> run this program if the filesystem is mounted."
19367 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4689
19369 "It is possible that using this program can damage the filesystem or data on "
19375 #: ../src/guestfs-actions.pod:7091
19376 msgid "guestfs_zfgrep"
19381 #: ../src/guestfs-actions.pod:7093
19385 " guestfs_zfgrep (guestfs_h *g,\n"
19386 " const char *pattern,\n"
19387 " const char *path);\n"
19393 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4696
19395 "This calls the external C<zfgrep> program and returns the matching lines."
19400 #: ../src/guestfs-actions.pod:7110
19401 msgid "guestfs_zfgrepi"
19406 #: ../src/guestfs-actions.pod:7112
19410 " guestfs_zfgrepi (guestfs_h *g,\n"
19411 " const char *pattern,\n"
19412 " const char *path);\n"
19418 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4706
19420 "This calls the external C<zfgrep -i> program and returns the matching lines."
19425 #: ../src/guestfs-actions.pod:7129
19426 msgid "guestfs_zfile"
19431 #: ../src/guestfs-actions.pod:7131
19435 " guestfs_zfile (guestfs_h *g,\n"
19436 " const char *meth,\n"
19437 " const char *path);\n"
19443 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4716
19445 "This command runs C<file> after first decompressing C<path> using C<method>."
19450 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4719
19451 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19456 #: ../src/guestfs-actions.pod:7141
19458 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19464 #: ../src/guestfs-actions.pod:7147 ../fish/guestfish-actions.pod:4724
19466 "This function is deprecated. In new code, use the C<file> call instead."
19471 #: ../src/guestfs-actions.pod:7156
19472 msgid "guestfs_zgrep"
19477 #: ../src/guestfs-actions.pod:7158
19481 " guestfs_zgrep (guestfs_h *g,\n"
19482 " const char *regex,\n"
19483 " const char *path);\n"
19489 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4735
19491 "This calls the external C<zgrep> program and returns the matching lines."
19496 #: ../src/guestfs-actions.pod:7175
19497 msgid "guestfs_zgrepi"
19502 #: ../src/guestfs-actions.pod:7177
19506 " guestfs_zgrepi (guestfs_h *g,\n"
19507 " const char *regex,\n"
19508 " const char *path);\n"
19514 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4745
19516 "This calls the external C<zgrep -i> program and returns the matching lines."
19521 #: ../src/guestfs-availability.pod:3
19527 #: ../src/guestfs-availability.pod:5
19529 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
19530 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
19531 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
19532 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
19533 "L</guestfs_aug_save> L</guestfs_aug_set>"
19538 #: ../src/guestfs-availability.pod:21
19544 #: ../src/guestfs-availability.pod:23
19546 "The following functions: L</guestfs_inotify_add_watch> L</"
19547 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19548 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19553 #: ../src/guestfs-availability.pod:31
19554 msgid "B<linuxfsuuid>"
19559 #: ../src/guestfs-availability.pod:33
19561 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19562 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19567 #: ../src/guestfs-availability.pod:40
19568 msgid "B<linuxmodules>"
19573 #: ../src/guestfs-availability.pod:42
19574 msgid "The following functions: L</guestfs_modprobe>"
19579 #: ../src/guestfs-availability.pod:45
19580 msgid "B<linuxxattrs>"
19585 #: ../src/guestfs-availability.pod:47
19587 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19588 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19589 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19590 "guestfs_setxattr>"
19595 #: ../src/guestfs-availability.pod:58
19601 #: ../src/guestfs-availability.pod:60
19603 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19604 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19605 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19610 #: ../src/guestfs-availability.pod:69
19616 #: ../src/guestfs-availability.pod:71
19618 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19619 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19620 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19621 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19622 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19623 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19624 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19629 #: ../src/guestfs-availability.pod:94
19635 #: ../src/guestfs-availability.pod:96
19637 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19638 "guestfs_mknod_b> L</guestfs_mknod_c>"
19643 #: ../src/guestfs-availability.pod:102
19649 #: ../src/guestfs-availability.pod:104
19650 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19655 #: ../src/guestfs-availability.pod:107
19656 msgid "B<ntfsprogs>"
19661 #: ../src/guestfs-availability.pod:109
19663 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
19668 #: ../src/guestfs-availability.pod:113
19669 msgid "B<realpath>"
19674 #: ../src/guestfs-availability.pod:115
19675 msgid "The following functions: L</guestfs_realpath>"
19680 #: ../src/guestfs-availability.pod:118
19686 #: ../src/guestfs-availability.pod:120
19688 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19689 "guestfs_scrub_freespace>"
19694 #: ../src/guestfs-availability.pod:125
19700 #: ../src/guestfs-availability.pod:127
19701 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19706 #: ../src/guestfs-availability.pod:131
19712 #: ../src/guestfs-availability.pod:133
19713 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19718 #: ../src/guestfs-availability.pod:137
19719 msgid "B<zerofree>"
19724 #: ../src/guestfs-availability.pod:139
19725 msgid "The following functions: L</guestfs_zerofree>"
19730 #: ../src/guestfs-structs.pod:1
19731 msgid "guestfs_int_bool"
19736 #: ../src/guestfs-structs.pod:3
19739 " struct guestfs_int_bool {\n"
19748 #: ../src/guestfs-structs.pod:8
19751 " struct guestfs_int_bool_list {\n"
19752 " uint32_t len; /* Number of elements in list. */\n"
19753 " struct guestfs_int_bool *val; /* Elements. */\n"
19760 #: ../src/guestfs-structs.pod:13
19763 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19764 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19770 #: ../src/guestfs-structs.pod:16
19771 msgid "guestfs_lvm_pv"
19776 #: ../src/guestfs-structs.pod:18
19779 " struct guestfs_lvm_pv {\n"
19780 " char *pv_name;\n"
19781 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19782 " char pv_uuid[32];\n"
19784 " uint64_t pv_size;\n"
19785 " uint64_t dev_size;\n"
19786 " uint64_t pv_free;\n"
19787 " uint64_t pv_used;\n"
19788 " char *pv_attr;\n"
19789 " int64_t pv_pe_count;\n"
19790 " int64_t pv_pe_alloc_count;\n"
19791 " char *pv_tags;\n"
19792 " uint64_t pe_start;\n"
19793 " int64_t pv_mda_count;\n"
19794 " uint64_t pv_mda_free;\n"
19801 #: ../src/guestfs-structs.pod:36
19804 " struct guestfs_lvm_pv_list {\n"
19805 " uint32_t len; /* Number of elements in list. */\n"
19806 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19813 #: ../src/guestfs-structs.pod:41
19816 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19817 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19823 #: ../src/guestfs-structs.pod:44
19824 msgid "guestfs_lvm_vg"
19829 #: ../src/guestfs-structs.pod:46
19832 " struct guestfs_lvm_vg {\n"
19833 " char *vg_name;\n"
19834 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19835 " char vg_uuid[32];\n"
19837 " char *vg_attr;\n"
19838 " uint64_t vg_size;\n"
19839 " uint64_t vg_free;\n"
19840 " char *vg_sysid;\n"
19841 " uint64_t vg_extent_size;\n"
19842 " int64_t vg_extent_count;\n"
19843 " int64_t vg_free_count;\n"
19844 " int64_t max_lv;\n"
19845 " int64_t max_pv;\n"
19846 " int64_t pv_count;\n"
19847 " int64_t lv_count;\n"
19848 " int64_t snap_count;\n"
19849 " int64_t vg_seqno;\n"
19850 " char *vg_tags;\n"
19851 " int64_t vg_mda_count;\n"
19852 " uint64_t vg_mda_free;\n"
19859 #: ../src/guestfs-structs.pod:69
19862 " struct guestfs_lvm_vg_list {\n"
19863 " uint32_t len; /* Number of elements in list. */\n"
19864 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19871 #: ../src/guestfs-structs.pod:74
19874 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19875 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19881 #: ../src/guestfs-structs.pod:77
19882 msgid "guestfs_lvm_lv"
19887 #: ../src/guestfs-structs.pod:79
19890 " struct guestfs_lvm_lv {\n"
19891 " char *lv_name;\n"
19892 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19893 " char lv_uuid[32];\n"
19894 " char *lv_attr;\n"
19895 " int64_t lv_major;\n"
19896 " int64_t lv_minor;\n"
19897 " int64_t lv_kernel_major;\n"
19898 " int64_t lv_kernel_minor;\n"
19899 " uint64_t lv_size;\n"
19900 " int64_t seg_count;\n"
19902 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19903 " float snap_percent;\n"
19904 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19905 " float copy_percent;\n"
19906 " char *move_pv;\n"
19907 " char *lv_tags;\n"
19908 " char *mirror_log;\n"
19909 " char *modules;\n"
19916 #: ../src/guestfs-structs.pod:101
19919 " struct guestfs_lvm_lv_list {\n"
19920 " uint32_t len; /* Number of elements in list. */\n"
19921 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19928 #: ../src/guestfs-structs.pod:106
19931 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19932 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19938 #: ../src/guestfs-structs.pod:111
19941 " struct guestfs_stat {\n"
19945 " int64_t nlink;\n"
19950 " int64_t blksize;\n"
19951 " int64_t blocks;\n"
19952 " int64_t atime;\n"
19953 " int64_t mtime;\n"
19954 " int64_t ctime;\n"
19961 #: ../src/guestfs-structs.pod:127
19964 " struct guestfs_stat_list {\n"
19965 " uint32_t len; /* Number of elements in list. */\n"
19966 " struct guestfs_stat *val; /* Elements. */\n"
19973 #: ../src/guestfs-structs.pod:132
19976 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19977 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19983 #: ../src/guestfs-structs.pod:137
19986 " struct guestfs_statvfs {\n"
19987 " int64_t bsize;\n"
19988 " int64_t frsize;\n"
19989 " int64_t blocks;\n"
19990 " int64_t bfree;\n"
19991 " int64_t bavail;\n"
19992 " int64_t files;\n"
19993 " int64_t ffree;\n"
19994 " int64_t favail;\n"
19997 " int64_t namemax;\n"
20004 #: ../src/guestfs-structs.pod:151
20007 " struct guestfs_statvfs_list {\n"
20008 " uint32_t len; /* Number of elements in list. */\n"
20009 " struct guestfs_statvfs *val; /* Elements. */\n"
20016 #: ../src/guestfs-structs.pod:156
20019 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
20020 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20026 #: ../src/guestfs-structs.pod:159
20027 msgid "guestfs_dirent"
20032 #: ../src/guestfs-structs.pod:161
20035 " struct guestfs_dirent {\n"
20045 #: ../src/guestfs-structs.pod:167
20048 " struct guestfs_dirent_list {\n"
20049 " uint32_t len; /* Number of elements in list. */\n"
20050 " struct guestfs_dirent *val; /* Elements. */\n"
20057 #: ../src/guestfs-structs.pod:172
20060 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20061 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20067 #: ../src/guestfs-structs.pod:177
20070 " struct guestfs_version {\n"
20071 " int64_t major;\n"
20072 " int64_t minor;\n"
20073 " int64_t release;\n"
20081 #: ../src/guestfs-structs.pod:184
20084 " struct guestfs_version_list {\n"
20085 " uint32_t len; /* Number of elements in list. */\n"
20086 " struct guestfs_version *val; /* Elements. */\n"
20093 #: ../src/guestfs-structs.pod:189
20096 " void guestfs_free_version (struct guestfs_free_version *);\n"
20097 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20103 #: ../src/guestfs-structs.pod:192
20104 msgid "guestfs_xattr"
20109 #: ../src/guestfs-structs.pod:194
20112 " struct guestfs_xattr {\n"
20113 " char *attrname;\n"
20114 " /* The next two fields describe a byte array. */\n"
20115 " uint32_t attrval_len;\n"
20116 " char *attrval;\n"
20123 #: ../src/guestfs-structs.pod:201
20126 " struct guestfs_xattr_list {\n"
20127 " uint32_t len; /* Number of elements in list. */\n"
20128 " struct guestfs_xattr *val; /* Elements. */\n"
20135 #: ../src/guestfs-structs.pod:206
20138 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20139 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
20145 #: ../src/guestfs-structs.pod:209
20146 msgid "guestfs_inotify_event"
20151 #: ../src/guestfs-structs.pod:211
20154 " struct guestfs_inotify_event {\n"
20155 " int64_t in_wd;\n"
20156 " uint32_t in_mask;\n"
20157 " uint32_t in_cookie;\n"
20158 " char *in_name;\n"
20165 #: ../src/guestfs-structs.pod:218
20168 " struct guestfs_inotify_event_list {\n"
20169 " uint32_t len; /* Number of elements in list. */\n"
20170 " struct guestfs_inotify_event *val; /* Elements. */\n"
20177 #: ../src/guestfs-structs.pod:223
20180 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20181 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20187 #: ../src/guestfs-structs.pod:226
20188 msgid "guestfs_partition"
20193 #: ../src/guestfs-structs.pod:228
20196 " struct guestfs_partition {\n"
20197 " int32_t part_num;\n"
20198 " uint64_t part_start;\n"
20199 " uint64_t part_end;\n"
20200 " uint64_t part_size;\n"
20207 #: ../src/guestfs-structs.pod:235
20210 " struct guestfs_partition_list {\n"
20211 " uint32_t len; /* Number of elements in list. */\n"
20212 " struct guestfs_partition *val; /* Elements. */\n"
20219 #: ../src/guestfs-structs.pod:240
20222 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
20223 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
20229 #: ../src/guestfs-structs.pod:243
20230 msgid "guestfs_application"
20235 #: ../src/guestfs-structs.pod:245
20238 " struct guestfs_application {\n"
20239 " char *app_name;\n"
20240 " char *app_display_name;\n"
20241 " int32_t app_epoch;\n"
20242 " char *app_version;\n"
20243 " char *app_release;\n"
20244 " char *app_install_path;\n"
20245 " char *app_trans_path;\n"
20246 " char *app_publisher;\n"
20247 " char *app_url;\n"
20248 " char *app_source_package;\n"
20249 " char *app_summary;\n"
20250 " char *app_description;\n"
20257 #: ../src/guestfs-structs.pod:260
20260 " struct guestfs_application_list {\n"
20261 " uint32_t len; /* Number of elements in list. */\n"
20262 " struct guestfs_application *val; /* Elements. */\n"
20269 #: ../src/guestfs-structs.pod:265
20272 " void guestfs_free_application (struct guestfs_free_application *);\n"
20273 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
20279 #: ../fish/guestfish.pod:5
20280 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20285 #: ../fish/guestfish.pod:9
20288 " guestfish [--options] [commands]\n"
20294 #: ../fish/guestfish.pod:11
20303 #: ../fish/guestfish.pod:13
20306 " guestfish [--ro|--rw] -a disk.img\n"
20312 #: ../fish/guestfish.pod:15
20315 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20321 #: ../fish/guestfish.pod:17
20324 " guestfish -d libvirt-domain\n"
20330 #: ../fish/guestfish.pod:19
20333 " guestfish [--ro|--rw] -a disk.img -i\n"
20339 #: ../fish/guestfish.pod:21
20342 " guestfish -d libvirt-domain -i\n"
20348 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
20349 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
20355 #: ../fish/guestfish.pod:25
20357 "Using guestfish in read/write mode on live virtual machines can be "
20358 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20359 "option to use guestfish safely if the disk image or virtual machine might be "
20365 #: ../fish/guestfish.pod:32
20367 "Guestfish is a shell and command-line tool for examining and modifying "
20368 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20369 "functionality of the guestfs API, see L<guestfs(3)>."
20374 #: ../fish/guestfish.pod:36
20376 "Guestfish gives you structured access to the libguestfs API, from shell "
20377 "scripts or the command line or interactively. If you want to rescue a "
20378 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20384 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:897
20385 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63
20386 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
20392 #: ../fish/guestfish.pod:43
20393 msgid "As an interactive shell"
20398 #: ../fish/guestfish.pod:45
20407 #: ../fish/guestfish.pod:47
20410 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20411 " editing virtual machine filesystems.\n"
20417 #: ../fish/guestfish.pod:50
20420 " Type: 'help' for a list of commands\n"
20421 " 'man' to read the manual\n"
20422 " 'quit' to quit the shell\n"
20428 #: ../fish/guestfish.pod:54
20431 " ><fs> add-ro disk.img\n"
20433 " ><fs> list-filesystems\n"
20434 " /dev/sda1: ext4\n"
20435 " /dev/vg_guest/lv_root: ext4\n"
20436 " /dev/vg_guest/lv_swap: swap\n"
20437 " ><fs> mount /dev/vg_guest/lv_root /\n"
20438 " ><fs> cat /etc/fstab\n"
20440 " # Created by anaconda\n"
20448 #: ../fish/guestfish.pod:67
20449 msgid "From shell scripts"
20454 #: ../fish/guestfish.pod:69
20455 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20460 #: ../fish/guestfish.pod:71
20463 " guestfish <<_EOF_\n"
20466 " mount /dev/vg_guest/lv_root /\n"
20467 " write /etc/motd \"Welcome, new users\"\n"
20474 #: ../fish/guestfish.pod:78
20475 msgid "List the LVM logical volumes in a disk image:"
20480 #: ../fish/guestfish.pod:80
20483 " guestfish -a disk.img --ro <<_EOF_\n"
20492 #: ../fish/guestfish.pod:85
20493 msgid "List all the filesystems in a disk image:"
20498 #: ../fish/guestfish.pod:87
20501 " guestfish -a disk.img --ro <<_EOF_\n"
20503 " list-filesystems\n"
20510 #: ../fish/guestfish.pod:92
20511 msgid "On one command line"
20516 #: ../fish/guestfish.pod:94
20517 msgid "Update C</etc/resolv.conf> in a guest:"
20522 #: ../fish/guestfish.pod:96
20526 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20527 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20533 #: ../fish/guestfish.pod:100
20534 msgid "Edit C</boot/grub/grub.conf> interactively:"
20539 #: ../fish/guestfish.pod:102
20542 " guestfish --rw --add disk.img \\\n"
20543 " --mount /dev/vg_guest/lv_root \\\n"
20544 " --mount /dev/sda1:/boot \\\n"
20545 " edit /boot/grub/grub.conf\n"
20551 #: ../fish/guestfish.pod:107
20552 msgid "Mount disks automatically"
20557 #: ../fish/guestfish.pod:109
20559 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20564 #: ../fish/guestfish.pod:112
20567 " guestfish --ro -a disk.img -i cat /etc/group\n"
20573 #: ../fish/guestfish.pod:114
20576 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20582 #: ../fish/guestfish.pod:116
20583 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20588 #: ../fish/guestfish.pod:118
20591 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20597 #: ../fish/guestfish.pod:120
20598 msgid "As a script interpreter"
20603 #: ../fish/guestfish.pod:122
20604 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20609 #: ../fish/guestfish.pod:124
20612 " #!/usr/bin/guestfish -f\n"
20613 " sparse test1.img 100M\n"
20615 " part-disk /dev/sda mbr\n"
20616 " mkfs ext2 /dev/sda1\n"
20622 #: ../fish/guestfish.pod:130
20623 msgid "Start with a prepared disk"
20628 #: ../fish/guestfish.pod:132
20630 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20631 "single ext2-formatted partition:"
20636 #: ../fish/guestfish.pod:135
20639 " guestfish -N fs\n"
20645 #: ../fish/guestfish.pod:137
20646 msgid "To list what is available do:"
20651 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
20654 " guestfish -N help | less\n"
20660 #: ../fish/guestfish.pod:141
20661 msgid "Remote control"
20666 #: ../fish/guestfish.pod:143
20669 " eval \"`guestfish --listen`\"\n"
20670 " guestfish --remote add-ro disk.img\n"
20671 " guestfish --remote run\n"
20672 " guestfish --remote lvs\n"
20678 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20679 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:77
20680 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
20681 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
20682 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20688 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
20689 #: ../tools/virt-edit.pl:85 ../tools/virt-win-reg.pl:104
20690 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
20691 #: ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161
20692 #: ../tools/virt-list-partitions.pl:62
20698 #: ../fish/guestfish.pod:154
20699 msgid "Displays general help on options."
20704 #: ../fish/guestfish.pod:156
20710 #: ../fish/guestfish.pod:158
20711 msgid "B<--cmd-help>"
20716 #: ../fish/guestfish.pod:160
20717 msgid "Lists all available guestfish commands."
20722 #: ../fish/guestfish.pod:162
20728 #: ../fish/guestfish.pod:164
20729 msgid "B<--cmd-help cmd>"
20734 #: ../fish/guestfish.pod:166
20735 msgid "Displays detailed help on a single command C<cmd>."
20740 #: ../fish/guestfish.pod:168
20741 msgid "B<-a image>"
20746 #: ../fish/guestfish.pod:170
20747 msgid "B<--add image>"
20752 #: ../fish/guestfish.pod:172
20753 msgid "Add a block device or virtual machine image to the shell."
20758 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
20760 "The format of the disk image is auto-detected. To override this and force a "
20761 "particular format use the I<--format=..> option."
20765 #: ../fish/guestfish.pod:177
20767 "Using this flag is mostly equivalent to using the C<add> command, with "
20768 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20769 "the I<--format=...> flag was given."
20774 #: ../fish/guestfish.pod:181
20780 #: ../fish/guestfish.pod:183
20781 msgid "B<--connect URI>"
20786 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
20788 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20789 "URI to use. The default is to use the default libvirt connection."
20794 #: ../fish/guestfish.pod:189
20800 #: ../fish/guestfish.pod:191
20802 "If using the I<--listen> option and a csh-like shell, use this option. See "
20803 "section L</REMOTE CONTROL AND CSH> below."
20808 #: ../fish/guestfish.pod:194
20809 msgid "B<-d libvirt-domain>"
20814 #: ../fish/guestfish.pod:196
20815 msgid "B<--domain libvirt-domain>"
20820 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
20822 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20823 "used, then any libvirt domain can be used. However in write mode, only "
20824 "libvirt domains which are shut down can be named here."
20829 #: ../fish/guestfish.pod:202
20831 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20832 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20833 "if the I<--format:...> flag was given."
20838 #: ../fish/guestfish.pod:206
20844 #: ../fish/guestfish.pod:208
20845 msgid "B<--no-dest-paths>"
20850 #: ../fish/guestfish.pod:210
20852 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20853 "to hit the tab key to complete paths on the guest filesystem, but this "
20854 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20855 "allow this feature to be disabled."
20860 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
20861 msgid "B<--echo-keys>"
20866 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
20868 "When prompting for keys and passphrases, guestfish normally turns echoing "
20869 "off so you cannot see what you are typing. If you are not worried about "
20870 "Tempest attacks and there is no one else in the room you can specify this "
20871 "flag to see what you are typing."
20876 #: ../fish/guestfish.pod:222
20882 #: ../fish/guestfish.pod:224
20883 msgid "B<--file file>"
20888 #: ../fish/guestfish.pod:226
20889 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20894 #: ../fish/guestfish.pod:229
20897 " #!/usr/bin/guestfish -f\n"
20903 #: ../fish/guestfish.pod:231
20904 msgid "B<--format=raw|qcow2|..>"
20909 #: ../fish/guestfish.pod:233
20910 msgid "B<--format>"
20915 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
20917 "The default for the I<-a> option is to auto-detect the format of the disk "
20918 "image. Using this forces the disk format for I<-a> options which follow on "
20919 "the command line. Using I<--format> with no argument switches back to auto-"
20920 "detection for subsequent I<-a> options."
20925 #: ../fish/guestfish.pod:242
20928 " guestfish --format=raw -a disk.img\n"
20934 #: ../fish/guestfish.pod:244
20935 msgid "forces raw format (no auto-detection) for C<disk.img>."
20940 #: ../fish/guestfish.pod:246
20943 " guestfish --format=raw -a disk.img --format -a another.img\n"
20949 #: ../fish/guestfish.pod:248
20951 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20952 "detection for C<another.img>."
20957 #: ../fish/guestfish.pod:251
20959 "If you have untrusted raw-format guest disk images, you should use this "
20960 "option to specify the disk format. This avoids a possible security problem "
20961 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20966 #: ../fish/guestfish.pod:256
20972 #: ../fish/guestfish.pod:258
20973 msgid "B<--inspector>"
20978 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
20980 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20981 "system and mount filesystems as they would be mounted on the real virtual "
20987 #: ../fish/guestfish.pod:264
20988 msgid "Typical usage is either:"
20993 #: ../fish/guestfish.pod:266
20996 " guestfish -d myguest -i\n"
21002 #: ../fish/guestfish.pod:268
21003 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21008 #: ../fish/guestfish.pod:270
21011 " guestfish --ro -d myguest -i\n"
21017 #: ../fish/guestfish.pod:272
21018 msgid "(for active domains, readonly), or specify the block device directly:"
21023 #: ../fish/guestfish.pod:274
21026 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21032 #: ../fish/guestfish.pod:276
21034 "Note that the command line syntax changed slightly over older versions of "
21035 "guestfish. You can still use the old syntax:"
21040 #: ../fish/guestfish.pod:279
21043 " guestfish [--ro] -i disk.img\n"
21049 #: ../fish/guestfish.pod:281
21052 " guestfish [--ro] -i libvirt-domain\n"
21058 #: ../fish/guestfish.pod:283
21060 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21061 "then using other commands to mount the filesystems that were found."
21066 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21067 msgid "B<--keys-from-stdin>"
21072 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21074 "Read key or passphrase parameters from stdin. The default is to try to read "
21075 "passphrases from the user by opening C</dev/tty>."
21080 #: ../fish/guestfish.pod:292
21081 msgid "B<--listen>"
21086 #: ../fish/guestfish.pod:294
21088 "Fork into the background and listen for remote commands. See section L</"
21089 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21094 #: ../fish/guestfish.pod:297
21095 msgid "B<-m dev[:mountpoint]>"
21100 #: ../fish/guestfish.pod:299
21101 msgid "B<--mount dev[:mountpoint]>"
21106 #: ../fish/guestfish.pod:301
21107 msgid "Mount the named partition or logical volume on the given mountpoint."
21112 #: ../fish/guestfish.pod:303
21113 msgid "If the mountpoint is omitted, it defaults to C</>."
21118 #: ../fish/guestfish.pod:305
21119 msgid "You have to mount something on C</> before most commands will work."
21124 #: ../fish/guestfish.pod:307
21126 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21132 #: ../fish/guestfish.pod:310
21134 "If you don't know what filesystems a disk image contains, you can either run "
21135 "guestfish without this option, then list the partitions, filesystems and LVs "
21136 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21137 "commands), or you can use the L<virt-filesystems(1)> program."
21142 #: ../fish/guestfish.pod:316
21144 "Using this flag is mostly equivalent to using the C<mount-options> command "
21145 "or the C<mount-ro> command if the I<--ro> flag was given."
21150 #: ../fish/guestfish.pod:319
21156 #: ../fish/guestfish.pod:321
21157 msgid "B<--no-sync>"
21162 #: ../fish/guestfish.pod:323
21164 "Disable autosync. This is enabled by default. See the discussion of "
21165 "autosync in the L<guestfs(3)> manpage."
21170 #: ../fish/guestfish.pod:326
21176 #: ../fish/guestfish.pod:328
21177 msgid "B<--new type>"
21182 #: ../fish/guestfish.pod:330
21188 #: ../fish/guestfish.pod:332
21190 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
21191 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
21192 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
21198 #: ../fish/guestfish.pod:337
21199 msgid "B<--progress-bars>"
21204 #: ../fish/guestfish.pod:339
21205 msgid "Enable progress bars, even when guestfish is used non-interactively."
21210 #: ../fish/guestfish.pod:341
21212 "Progress bars are enabled by default when guestfish is used as an "
21213 "interactive shell."
21218 #: ../fish/guestfish.pod:344
21219 msgid "B<--no-progress-bars>"
21224 #: ../fish/guestfish.pod:346
21225 msgid "Disable progress bars."
21230 #: ../fish/guestfish.pod:348
21231 msgid "B<--remote[=pid]>"
21236 #: ../fish/guestfish.pod:350
21238 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
21239 "CONTROL GUESTFISH OVER A SOCKET> below."
21244 #: ../fish/guestfish.pod:353
21250 #: ../fish/guestfish.pod:355
21256 #: ../fish/guestfish.pod:357
21258 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21259 "mounts are done read-only."
21264 #: ../fish/guestfish.pod:360
21266 "The option must always be used if the disk image or virtual machine might be "
21267 "running, and is generally recommended in cases where you don't need write "
21268 "access to the disk."
21273 #: ../fish/guestfish.pod:364
21275 "Note that prepared disk images created with I<-N> are not affected by this "
21276 "option. Also commands like C<add> are not affected - you have to specify "
21277 "the C<readonly:true> option explicitly if you need it."
21282 #: ../fish/guestfish.pod:368
21283 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21288 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
21289 msgid "B<--selinux>"
21294 #: ../fish/guestfish.pod:372
21295 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21300 #: ../fish/guestfish.pod:374
21306 #: ../fish/guestfish.pod:376
21307 msgid "B<--verbose>"
21312 #: ../fish/guestfish.pod:378
21314 "Enable very verbose messages. This is particularly useful if you find a bug."
21319 #: ../fish/guestfish.pod:381
21325 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:93
21326 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
21327 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114
21328 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
21329 msgid "B<--version>"
21334 #: ../fish/guestfish.pod:385
21335 msgid "Display the guestfish / libguestfs version number and exit."
21340 #: ../fish/guestfish.pod:387
21346 #: ../fish/guestfish.pod:389
21352 #: ../fish/guestfish.pod:391
21354 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
21360 #: ../fish/guestfish.pod:394
21366 #: ../fish/guestfish.pod:396
21367 msgid "Echo each command before executing it."
21372 #: ../fish/guestfish.pod:400
21373 msgid "COMMANDS ON COMMAND LINE"
21378 #: ../fish/guestfish.pod:402
21380 "Any additional (non-option) arguments are treated as commands to execute."
21385 #: ../fish/guestfish.pod:405
21387 "Commands to execute should be separated by a colon (C<:>), where the colon "
21388 "is a separate parameter. Thus:"
21393 #: ../fish/guestfish.pod:408
21396 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21402 #: ../fish/guestfish.pod:410
21404 "If there are no additional arguments, then we enter a shell, either an "
21405 "interactive shell with a prompt (if the input is a terminal) or a non-"
21406 "interactive shell."
21411 #: ../fish/guestfish.pod:414
21413 "In either command line mode or non-interactive shell, the first command that "
21414 "gives an error causes the whole shell to exit. In interactive mode (with a "
21415 "prompt) if a command fails, you can continue to enter commands."
21420 #: ../fish/guestfish.pod:419
21421 msgid "USING launch (OR run)"
21426 #: ../fish/guestfish.pod:421
21428 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21429 "then launch it, then mount any disks you need, and finally issue actions/"
21430 "commands. So the general order of the day is:"
21435 #: ../fish/guestfish.pod:429
21436 msgid "add or -a/--add"
21441 #: ../fish/guestfish.pod:433
21442 msgid "launch (aka run)"
21447 #: ../fish/guestfish.pod:437
21448 msgid "mount or -m/--mount"
21453 #: ../fish/guestfish.pod:441
21454 msgid "any other commands"
21459 #: ../fish/guestfish.pod:445
21461 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21462 "guest before mounting or performing any other commands."
21467 #: ../fish/guestfish.pod:448
21469 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21470 "I<--new> options were given then C<run> is done automatically, simply "
21471 "because guestfish can't perform the action you asked for without doing this."
21476 #: ../fish/guestfish.pod:453
21477 msgid "OPENING DISKS FOR READ AND WRITE"
21482 #: ../fish/guestfish.pod:455
21484 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
21485 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
21486 "open disk images read-only or for writing."
21491 #: ../fish/guestfish.pod:459
21493 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
21494 "disk images supplied on the command line for write. To open a disk image "
21495 "read-only you have to do I<-a image --ro>."
21500 #: ../fish/guestfish.pod:463
21502 "This matters: If you accidentally open a live VM disk image writable then "
21503 "you will cause irreversible disk corruption."
21507 #: ../fish/guestfish.pod:466
21509 "By libguestfs 1.10 we intend to change the default the other way. Disk "
21510 "images will be opened read-only. You will have to either specify "
21511 "I<guestfish --rw> or change a configuration file in order to get write "
21512 "access for disk images specified by those other command line options."
21517 #: ../fish/guestfish.pod:471
21519 "This version of guestfish has a I<--rw> option which does nothing (it is "
21520 "already the default). However it is highly recommended that you use this "
21521 "option to indicate that guestfish needs write access, and to prepare your "
21522 "scripts for the day when this option will be required for write access."
21527 #: ../fish/guestfish.pod:477
21529 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21530 "other libguestfs program apart from guestfish and guestmount."
21535 #: ../fish/guestfish.pod:480
21541 #: ../fish/guestfish.pod:482
21543 "You can quote ordinary parameters using either single or double quotes. For "
21549 #: ../fish/guestfish.pod:485
21552 " add \"file with a space.img\"\n"
21558 #: ../fish/guestfish.pod:487
21561 " rm '/file name'\n"
21567 #: ../fish/guestfish.pod:489
21576 #: ../fish/guestfish.pod:491
21578 "A few commands require a list of strings to be passed. For these, use a "
21579 "whitespace-separated list, enclosed in quotes. Strings containing "
21580 "whitespace to be passed through must be enclosed in single quotes. A "
21581 "literal single quote must be escaped with a backslash."
21586 #: ../fish/guestfish.pod:496
21589 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21590 " command \"/bin/echo 'foo bar'\"\n"
21591 " command \"/bin/echo \\'foo\\'\"\n"
21597 #: ../fish/guestfish.pod:500
21598 msgid "OPTIONAL ARGUMENTS"
21603 #: ../fish/guestfish.pod:502
21605 "Some commands take optional arguments. These arguments appear in this "
21606 "documentation as C<[argname:..]>. You can use them as in these examples:"
21611 #: ../fish/guestfish.pod:506
21614 " add-drive-opts filename\n"
21620 #: ../fish/guestfish.pod:508
21623 " add-drive-opts filename readonly:true\n"
21629 #: ../fish/guestfish.pod:510
21632 " add-drive-opts filename format:qcow2 readonly:false\n"
21638 #: ../fish/guestfish.pod:512
21640 "Each optional argument can appear at most once. All optional arguments must "
21641 "appear after the required ones."
21646 #: ../fish/guestfish.pod:515
21652 #: ../fish/guestfish.pod:517
21654 "This section applies to all commands which can take integers as parameters."
21659 #: ../fish/guestfish.pod:520
21660 msgid "SIZE SUFFIX"
21665 #: ../fish/guestfish.pod:522
21667 "When the command takes a parameter measured in bytes, you can use one of the "
21668 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21673 #: ../fish/guestfish.pod:528
21674 msgid "B<k> or B<K> or B<KiB>"
21679 #: ../fish/guestfish.pod:530
21680 msgid "The size in kilobytes (multiplied by 1024)."
21685 #: ../fish/guestfish.pod:532
21691 #: ../fish/guestfish.pod:534
21692 msgid "The size in SI 1000 byte units."
21697 #: ../fish/guestfish.pod:536
21698 msgid "B<M> or B<MiB>"
21703 #: ../fish/guestfish.pod:538
21704 msgid "The size in megabytes (multiplied by 1048576)."
21709 #: ../fish/guestfish.pod:540
21715 #: ../fish/guestfish.pod:542
21716 msgid "The size in SI 1000000 byte units."
21721 #: ../fish/guestfish.pod:544
21722 msgid "B<G> or B<GiB>"
21727 #: ../fish/guestfish.pod:546
21728 msgid "The size in gigabytes (multiplied by 2**30)."
21733 #: ../fish/guestfish.pod:548
21739 #: ../fish/guestfish.pod:550
21740 msgid "The size in SI 10**9 byte units."
21745 #: ../fish/guestfish.pod:552
21746 msgid "B<T> or B<TiB>"
21751 #: ../fish/guestfish.pod:554
21752 msgid "The size in terabytes (multiplied by 2**40)."
21757 #: ../fish/guestfish.pod:556
21763 #: ../fish/guestfish.pod:558
21764 msgid "The size in SI 10**12 byte units."
21769 #: ../fish/guestfish.pod:560
21770 msgid "B<P> or B<PiB>"
21775 #: ../fish/guestfish.pod:562
21776 msgid "The size in petabytes (multiplied by 2**50)."
21781 #: ../fish/guestfish.pod:564
21787 #: ../fish/guestfish.pod:566
21788 msgid "The size in SI 10**15 byte units."
21793 #: ../fish/guestfish.pod:568
21794 msgid "B<E> or B<EiB>"
21799 #: ../fish/guestfish.pod:570
21800 msgid "The size in exabytes (multiplied by 2**60)."
21805 #: ../fish/guestfish.pod:572
21811 #: ../fish/guestfish.pod:574
21812 msgid "The size in SI 10**18 byte units."
21817 #: ../fish/guestfish.pod:576
21818 msgid "B<Z> or B<ZiB>"
21823 #: ../fish/guestfish.pod:578
21824 msgid "The size in zettabytes (multiplied by 2**70)."
21829 #: ../fish/guestfish.pod:580
21835 #: ../fish/guestfish.pod:582
21836 msgid "The size in SI 10**21 byte units."
21841 #: ../fish/guestfish.pod:584
21842 msgid "B<Y> or B<YiB>"
21847 #: ../fish/guestfish.pod:586
21848 msgid "The size in yottabytes (multiplied by 2**80)."
21853 #: ../fish/guestfish.pod:588
21859 #: ../fish/guestfish.pod:590
21860 msgid "The size in SI 10**24 byte units."
21865 #: ../fish/guestfish.pod:596
21868 " truncate-size /file 1G\n"
21874 #: ../fish/guestfish.pod:598
21875 msgid "would truncate the file to 1 gigabyte."
21880 #: ../fish/guestfish.pod:600
21882 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21883 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21884 "suffix will probably not do what you expect."
21889 #: ../fish/guestfish.pod:604
21890 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21895 #: ../fish/guestfish.pod:606
21897 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21898 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21903 #: ../fish/guestfish.pod:609
21906 " 1234 decimal number 1234\n"
21907 " 02322 octal number, equivalent to decimal 1234\n"
21908 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21914 #: ../fish/guestfish.pod:613
21916 "When using the C<chmod> command, you almost always want to specify an octal "
21917 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21918 "L<chmod(1)> program):"
21923 #: ../fish/guestfish.pod:617
21926 " chmod 0777 /public # OK\n"
21927 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21933 #: ../fish/guestfish.pod:620
21935 "Commands that return numbers usually print them in decimal, but some "
21936 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21937 "octal, preceeded by C<0>)."
21942 #: ../fish/guestfish.pod:624
21943 msgid "WILDCARDS AND GLOBBING"
21948 #: ../fish/guestfish.pod:626
21950 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21951 "(globbing) by default. So for example the following will not do what you "
21957 #: ../fish/guestfish.pod:630
21966 #: ../fish/guestfish.pod:632
21968 "Assuming you don't have a directory called literally C</home/*> then the "
21969 "above command will return an error."
21974 #: ../fish/guestfish.pod:635
21975 msgid "To perform wildcard expansion, use the C<glob> command."
21980 #: ../fish/guestfish.pod:637
21983 " glob rm-rf /home/*\n"
21989 #: ../fish/guestfish.pod:639
21991 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21992 "many times), equivalent to:"
21997 #: ../fish/guestfish.pod:642
22000 " rm-rf /home/jim\n"
22001 " rm-rf /home/joe\n"
22002 " rm-rf /home/mary\n"
22008 #: ../fish/guestfish.pod:646
22009 msgid "C<glob> only works on simple guest paths and not on device names."
22014 #: ../fish/guestfish.pod:648
22016 "If you have several parameters, each containing a wildcard, then glob will "
22017 "perform a Cartesian product."
22022 #: ../fish/guestfish.pod:651
22028 #: ../fish/guestfish.pod:653
22030 "Any line which starts with a I<#> character is treated as a comment and "
22031 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22032 "a command. For example:"
22037 #: ../fish/guestfish.pod:657
22040 " # this is a comment\n"
22041 " # this is a comment\n"
22042 " foo # NOT a comment\n"
22048 #: ../fish/guestfish.pod:661
22049 msgid "Blank lines are also ignored."
22054 #: ../fish/guestfish.pod:663
22055 msgid "RUNNING COMMANDS LOCALLY"
22060 #: ../fish/guestfish.pod:665
22062 "Any line which starts with a I<!> character is treated as a command sent to "
22063 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22068 #: ../fish/guestfish.pod:669
22072 " tgz-out /remote local/remote-data.tar.gz\n"
22078 #: ../fish/guestfish.pod:672
22080 "will create a directory C<local> on the host, and then export the contents "
22081 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22082 "(See C<tgz-out>)."
22087 #: ../fish/guestfish.pod:676
22089 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22090 "effect, due to the way that subprocesses work in Unix."
22095 #: ../fish/guestfish.pod:679
22101 #: ../fish/guestfish.pod:681
22103 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
22104 "command (a guestfish command) to the second command (any host command). For "
22110 #: ../fish/guestfish.pod:685
22113 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
22119 #: ../fish/guestfish.pod:687
22121 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
22122 "program). The above command would list all accounts in the guest filesystem "
22123 "which have UID 0, ie. root accounts including backdoors. Other examples:"
22128 #: ../fish/guestfish.pod:692
22131 " hexdump /bin/ls | head\n"
22132 " list-devices | tail -1\n"
22133 " tgz-out / - | tar ztf -\n"
22139 #: ../fish/guestfish.pod:696
22141 "The space before the pipe symbol is required, any space after the pipe "
22142 "symbol is optional. Everything after the pipe symbol is just passed "
22143 "straight to the host shell, so it can contain redirections, globs and "
22144 "anything else that makes sense on the host side."
22149 #: ../fish/guestfish.pod:701
22151 "To use a literal argument which begins with a pipe symbol, you have to quote "
22157 #: ../fish/guestfish.pod:704
22166 #: ../fish/guestfish.pod:706
22167 msgid "HOME DIRECTORIES"
22172 #: ../fish/guestfish.pod:708
22174 "If a parameter starts with the character C<~> then the tilde may be expanded "
22175 "as a home directory path (either C<~> for the current user's home directory, "
22176 "or C<~user> for another user)."
22181 #: ../fish/guestfish.pod:712
22183 "Note that home directory expansion happens for users known I<on the host>, "
22184 "not in the guest filesystem."
22189 #: ../fish/guestfish.pod:715
22191 "To use a literal argument which begins with a tilde, you have to quote it, "
22197 #: ../fish/guestfish.pod:718
22206 #: ../fish/guestfish.pod:722
22208 "Libguestfs has some support for Linux guests encrypted according to the "
22209 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22210 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22211 "LUKS is supported."
22216 #: ../fish/guestfish.pod:727
22217 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22222 #: ../fish/guestfish.pod:729
22225 " ><fs> vfs-type /dev/sda2\n"
22232 #: ../fish/guestfish.pod:732
22234 "Then open those devices using L</luks-open>. This creates a device-mapper "
22235 "device called C</dev/mapper/luksdev>."
22240 #: ../fish/guestfish.pod:735
22243 " ><fs> luks-open /dev/sda2 luksdev\n"
22244 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22250 #: ../fish/guestfish.pod:738
22252 "Finally you have to tell LVM to scan for volume groups on the newly created "
22258 #: ../fish/guestfish.pod:741
22262 " vg-activate-all true\n"
22268 #: ../fish/guestfish.pod:744
22269 msgid "The logical volume(s) can now be mounted in the usual way."
22274 #: ../fish/guestfish.pod:746
22276 "Before closing a LUKS device you must unmount any logical volumes on it and "
22277 "deactivate the volume groups by calling C<vg-activate false VG> on each "
22278 "one. Then you can close the mapper device:"
22283 #: ../fish/guestfish.pod:750
22286 " vg-activate false /dev/VG\n"
22287 " luks-close /dev/mapper/luksdev\n"
22293 #: ../fish/guestfish.pod:753
22294 msgid "WINDOWS PATHS"
22299 #: ../fish/guestfish.pod:755
22301 "If a path is prefixed with C<win:> then you can use Windows-style paths "
22302 "(with some limitations). The following commands are equivalent:"
22307 #: ../fish/guestfish.pod:758
22310 " file /WINDOWS/system32/config/system.LOG\n"
22316 #: ../fish/guestfish.pod:760
22319 " file win:/windows/system32/config/system.log\n"
22325 #: ../fish/guestfish.pod:762
22328 " file win:\\windows\\system32\\config\\system.log\n"
22334 #: ../fish/guestfish.pod:764
22337 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
22343 #: ../fish/guestfish.pod:766
22345 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
22346 "handles case insensitivity like Windows would. This only works in argument "
22347 "positions that expect a path."
22352 #: ../fish/guestfish.pod:770
22353 msgid "UPLOADING AND DOWNLOADING FILES"
22358 #: ../fish/guestfish.pod:772
22360 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22361 "others which upload from or download to a local file, you can use the "
22362 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22367 #: ../fish/guestfish.pod:776
22376 #: ../fish/guestfish.pod:778
22378 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22383 #: ../fish/guestfish.pod:781
22386 " tar-out /etc - | tar tf -\n"
22392 #: ../fish/guestfish.pod:783
22394 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22395 "command (see L</PIPES>)."
22400 #: ../fish/guestfish.pod:786
22402 "When using C<-> to read from stdin, the input is read up to the end of "
22403 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22404 "some arbitrary end marker:"
22409 #: ../fish/guestfish.pod:790
22412 " upload -<<END /foo\n"
22422 #: ../fish/guestfish.pod:796
22424 "Any string of characters can be used instead of C<END>. The end marker must "
22425 "appear on a line of its own, without any preceeding or following characters "
22426 "(not even spaces)."
22431 #: ../fish/guestfish.pod:800
22433 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22434 "upload local files (so-called \"FileIn\" parameters in the generator)."
22439 #: ../fish/guestfish.pod:803
22440 msgid "EXIT ON ERROR BEHAVIOUR"
22445 #: ../fish/guestfish.pod:805
22447 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22448 "taking commands from a human over a tty), and will exit on the first error "
22449 "in non-interactive mode (scripts, commands given on the command line)."
22454 #: ../fish/guestfish.pod:810
22456 "If you prefix a command with a I<-> character, then that command will not "
22457 "cause guestfish to exit, even if that (one) command returns an error."
22462 #: ../fish/guestfish.pod:814
22463 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22468 #: ../fish/guestfish.pod:816
22470 "Guestfish can be remote-controlled over a socket. This is useful "
22471 "particularly in shell scripts where you want to make several different "
22472 "changes to a filesystem, but you don't want the overhead of starting up a "
22473 "guestfish process each time."
22478 #: ../fish/guestfish.pod:821
22479 msgid "Start a guestfish server process using:"
22484 #: ../fish/guestfish.pod:823
22487 " eval \"`guestfish --listen`\"\n"
22493 #: ../fish/guestfish.pod:825
22494 msgid "and then send it commands by doing:"
22499 #: ../fish/guestfish.pod:827
22502 " guestfish --remote cmd [...]\n"
22508 #: ../fish/guestfish.pod:829
22509 msgid "To cause the server to exit, send it the exit command:"
22514 #: ../fish/guestfish.pod:831
22517 " guestfish --remote exit\n"
22523 #: ../fish/guestfish.pod:833
22525 "Note that the server will normally exit if there is an error in a command. "
22526 "You can change this in the usual way. See section L</EXIT ON ERROR "
22532 #: ../fish/guestfish.pod:837
22533 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22538 #: ../fish/guestfish.pod:839
22540 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22541 "is how the I<--remote> option knows where to send the commands. You can "
22542 "have several guestfish listener processes running using:"
22547 #: ../fish/guestfish.pod:843
22550 " eval \"`guestfish --listen`\"\n"
22551 " pid1=$GUESTFISH_PID\n"
22552 " eval \"`guestfish --listen`\"\n"
22553 " pid2=$GUESTFISH_PID\n"
22555 " guestfish --remote=$pid1 cmd\n"
22556 " guestfish --remote=$pid2 cmd\n"
22562 #: ../fish/guestfish.pod:851
22563 msgid "REMOTE CONTROL AND CSH"
22568 #: ../fish/guestfish.pod:853
22570 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22576 #: ../fish/guestfish.pod:856
22579 " eval \"`guestfish --listen --csh`\"\n"
22585 #: ../fish/guestfish.pod:858
22586 msgid "REMOTE CONTROL DETAILS"
22591 #: ../fish/guestfish.pod:860
22593 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22594 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22595 "and C<$PID> is the process ID of the server."
22600 #: ../fish/guestfish.pod:864
22601 msgid "Guestfish client and server versions must match exactly."
22606 #: ../fish/guestfish.pod:866
22607 msgid "PREPARED DISK IMAGES"
22612 #: ../fish/guestfish.pod:868
22614 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22615 "preformatted disk images that guestfish can make for you to save typing. "
22616 "This is particularly useful for testing purposes. This option is used "
22617 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22618 "can be mixed with I<-a>)."
22623 #: ../fish/guestfish.pod:874
22625 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22626 "the second and so on. Existing files in the current directory are "
22632 #: ../fish/guestfish.pod:878
22634 "The type briefly describes how the disk should be sized, partitioned, how "
22635 "filesystem(s) should be created, and how content should be added. "
22636 "Optionally the type can be followed by extra parameters, separated by C<:> "
22637 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22638 "allocated disk, containing a single partition, with the partition formatted "
22639 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22645 #: ../fish/guestfish.pod:886
22646 msgid "To list the available types and any extra parameters they take, run:"
22651 #: ../fish/guestfish.pod:890
22653 "Note that the prepared filesystem is not mounted. You would usually have to "
22654 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22659 #: ../fish/guestfish.pod:894
22661 "If any I<-N> or I<--new> options are given, the guest is automatically "
22667 #: ../fish/guestfish.pod:899
22668 msgid "Create a 100MB disk with an ext4-formatted partition:"
22673 #: ../fish/guestfish.pod:901
22676 " guestfish -N fs:ext4\n"
22682 #: ../fish/guestfish.pod:903
22683 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22688 #: ../fish/guestfish.pod:905
22691 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22697 #: ../fish/guestfish.pod:907
22698 msgid "Create a blank 200MB disk:"
22703 #: ../fish/guestfish.pod:909
22706 " guestfish -N disk:200M\n"
22712 #: ../fish/guestfish.pod:911
22713 msgid "PROGRESS BARS"
22718 #: ../fish/guestfish.pod:913
22720 "Some (not all) long-running commands send progress notification messages as "
22721 "they are running. Guestfish turns these messages into progress bars."
22726 #: ../fish/guestfish.pod:917
22728 "When a command that supports progress bars takes longer than two seconds to "
22729 "run, and if progress bars are enabled, then you will see one appearing below "
22735 #: ../fish/guestfish.pod:921
22738 " ><fs> copy-size /large-file /another-file 2048M\n"
22739 " / 10% [#####-----------------------------------------] 00:30\n"
22745 #: ../fish/guestfish.pod:924
22747 "The spinner on the left hand side moves round once for every progress "
22748 "notification received from the backend. This is a (reasonably) golden "
22749 "assurance that the command is \"doing something\" even if the progress bar "
22750 "is not moving, because the command is able to send the progress "
22751 "notifications. When the bar reaches 100% and the command finishes, the "
22752 "spinner disappears."
22757 #: ../fish/guestfish.pod:931
22759 "Progress bars are enabled by default when guestfish is used interactively. "
22760 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22761 "and you can disable them completely using I<--no-progress-bars>."
22766 #: ../fish/guestfish.pod:936
22767 msgid "GUESTFISH COMMANDS"
22772 #: ../fish/guestfish.pod:938
22774 "The commands in this section are guestfish convenience commands, in other "
22775 "words, they are not part of the L<guestfs(3)> API."
22780 #: ../fish/guestfish.pod:941
22786 #: ../fish/guestfish.pod:943
22796 #: ../fish/guestfish.pod:946
22797 msgid "Without any parameter, this provides general help."
22802 #: ../fish/guestfish.pod:948
22803 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22808 #: ../fish/guestfish.pod:950
22809 msgid "quit | exit"
22814 #: ../fish/guestfish.pod:952
22815 msgid "This exits guestfish. You can also use C<^D> key."
22820 #: ../fish/guestfish.pod:954
22821 msgid "@FISH_COMMANDS@"
22826 #: ../fish/guestfish.pod:956
22832 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
22838 #: ../fish/guestfish.pod:962
22840 "guestfish returns 0 if the commands completed without error, or 1 if there "
22846 #: ../fish/guestfish.pod:969
22852 #: ../fish/guestfish.pod:971
22854 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22860 #: ../fish/guestfish.pod:974
22861 msgid "GUESTFISH_PID"
22866 #: ../fish/guestfish.pod:976
22868 "Used with the I<--remote> option to specify the remote guestfish process to "
22869 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22874 #: ../fish/guestfish.pod:980
22880 #: ../fish/guestfish.pod:982
22882 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22883 "not specified, the external L<hexedit(1)> program is used."
22888 #: ../fish/guestfish.pod:986
22894 #: ../fish/guestfish.pod:988
22896 "If compiled with GNU readline support, various files in the home directory "
22897 "can be used. See L</FILES>."
22902 #: ../fish/guestfish.pod:997
22904 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22905 "effect as using the B<-v> option."
22910 #: ../fish/guestfish.pod:1009
22912 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22913 "the discussion of paths in L<guestfs(3)>."
22918 #: ../fish/guestfish.pod:1020
22919 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22924 #: ../fish/guestfish.pod:1022
22930 #: ../fish/guestfish.pod:1024
22932 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22938 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
22944 #: ../fish/guestfish.pod:1043
22945 msgid "$HOME/.guestfish"
22950 #: ../fish/guestfish.pod:1045
22952 "If compiled with GNU readline support, then the command history is saved in "
22958 #: ../fish/guestfish.pod:1048
22959 msgid "$HOME/.inputrc"
22964 #: ../fish/guestfish.pod:1050
22965 msgid "/etc/inputrc"
22970 #: ../fish/guestfish.pod:1052
22972 "If compiled with GNU readline support, then these files can be used to "
22973 "configure readline. For further information, please see L<readline(3)/"
22974 "INITIALIZATION FILE>."
22979 #: ../fish/guestfish.pod:1056
22980 msgid "To write rules which only apply to guestfish, use:"
22985 #: ../fish/guestfish.pod:1058
22996 #: ../fish/guestfish.pod:1062
22998 "Variables that you can set in inputrc that change the behaviour of guestfish "
22999 "in useful ways include:"
23004 #: ../fish/guestfish.pod:1067
23005 msgid "completion-ignore-case (default: on)"
23010 #: ../fish/guestfish.pod:1069
23012 "By default, guestfish will ignore case when tab-completing paths on the "
23018 #: ../fish/guestfish.pod:1072
23021 " set completion-ignore-case off\n"
23027 #: ../fish/guestfish.pod:1074
23028 msgid "to make guestfish case sensitive."
23033 #: ../fish/guestfish.pod:1078
23039 #: ../fish/guestfish.pod:1080
23040 msgid "test2.img (etc)"
23045 #: ../fish/guestfish.pod:1082
23047 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
23048 "will be created in the file C<test1.img> in the current directory. The "
23049 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
23050 "the same name will be overwritten."
23055 #: ../fish/guestfish.pod:1091
23057 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
23058 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
23059 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
23060 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
23066 #: ../fish/guestfish.pod:1117 ../test-tool/libguestfs-test-tool.pod:124
23067 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:415
23068 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512
23069 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
23070 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
23072 "This program is free software; you can redistribute it and/or modify it "
23073 "under the terms of the GNU General Public License as published by the Free "
23074 "Software Foundation; either version 2 of the License, or (at your option) "
23075 "any later version."
23080 #: ../fish/guestfish.pod:1122 ../test-tool/libguestfs-test-tool.pod:129
23081 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:420
23082 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517
23083 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
23084 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
23086 "This program is distributed in the hope that it will be useful, but WITHOUT "
23087 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
23088 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
23094 #: ../fish/guestfish.pod:1127 ../test-tool/libguestfs-test-tool.pod:134
23095 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:425
23096 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522
23097 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
23098 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
23100 "You should have received a copy of the GNU General Public License along with "
23101 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
23102 "Ave, Cambridge, MA 02139, USA."
23107 #: ../fish/guestfish-actions.pod:1
23113 #: ../fish/guestfish-actions.pod:3
23116 " add-cdrom filename\n"
23122 #: ../fish/guestfish-actions.pod:15
23124 "This call checks for the existence of C<filename>. This stops you from "
23125 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23126 "and C<http:> URLs. To specify those, use the general L</config> call "
23132 #: ../fish/guestfish-actions.pod:22
23134 "If you just want to add an ISO file (often you use this as an efficient way "
23135 "to transfer large files into the guest), then you should probably use L</add-"
23136 "drive-ro> instead."
23141 #: ../fish/guestfish-actions.pod:35
23147 #: ../fish/guestfish-actions.pod:37
23153 #: ../fish/guestfish-actions.pod:39
23156 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
23162 #: ../fish/guestfish-actions.pod:41
23164 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
23165 "It works by connecting to libvirt, requesting the domain and domain XML from "
23166 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
23171 #: ../fish/guestfish-actions.pod:64
23173 "The other optional parameters are passed directly through to L</add-drive-"
23179 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131
23180 #: ../fish/guestfish-actions.pod:2845
23182 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
23187 #: ../fish/guestfish-actions.pod:69
23193 #: ../fish/guestfish-actions.pod:71
23196 " add-drive filename\n"
23202 #: ../fish/guestfish-actions.pod:73
23204 "This function is the equivalent of calling L</add-drive-opts> with no "
23205 "optional parameters, so the disk is added writable, with the format being "
23206 "detected automatically."
23211 #: ../fish/guestfish-actions.pod:77
23213 "Automatic detection of the format opens you up to a potential security hole "
23214 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
23215 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
23216 "you should think about replacing calls to this function with calls to L</add-"
23217 "drive-opts>, and specifying the format."
23222 #: ../fish/guestfish-actions.pod:84
23223 msgid "add-drive-opts"
23228 #: ../fish/guestfish-actions.pod:86
23234 #: ../fish/guestfish-actions.pod:88
23237 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
23243 #: ../fish/guestfish-actions.pod:115
23245 "This forces the image format. If you omit this (or use L</add-drive> or L</"
23246 "add-drive-ro>) then the format is automatically detected. Possible formats "
23247 "include C<raw> and C<qcow2>."
23252 #: ../fish/guestfish-actions.pod:126
23254 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
23255 "add-drive-with-if> call (q.v.)"
23260 #: ../fish/guestfish-actions.pod:133
23261 msgid "add-drive-ro"
23266 #: ../fish/guestfish-actions.pod:135
23272 #: ../fish/guestfish-actions.pod:137
23275 " add-drive-ro filename\n"
23281 #: ../fish/guestfish-actions.pod:139
23283 "This function is the equivalent of calling L</add-drive-opts> with the "
23284 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
23285 "is added read-only, with the format being detected automatically."
23290 #: ../fish/guestfish-actions.pod:144
23291 msgid "add-drive-ro-with-if"
23296 #: ../fish/guestfish-actions.pod:146
23299 " add-drive-ro-with-if filename iface\n"
23305 #: ../fish/guestfish-actions.pod:148
23307 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
23308 "interface emulation to use at run time."
23313 #: ../fish/guestfish-actions.pod:158
23314 msgid "add-drive-with-if"
23319 #: ../fish/guestfish-actions.pod:160
23322 " add-drive-with-if filename iface\n"
23328 #: ../fish/guestfish-actions.pod:162
23330 "This is the same as L</add-drive> but it allows you to specify the QEMU "
23331 "interface emulation to use at run time."
23336 #: ../fish/guestfish-actions.pod:172
23342 #: ../fish/guestfish-actions.pod:174
23345 " aug-clear augpath\n"
23351 #: ../fish/guestfish-actions.pod:179
23357 #: ../fish/guestfish-actions.pod:181
23366 #: ../fish/guestfish-actions.pod:183
23368 "Close the current Augeas handle and free up any resources used by it. After "
23369 "calling this, you have to call L</aug-init> again before you can use any "
23370 "other Augeas functions."
23375 #: ../fish/guestfish-actions.pod:188
23376 msgid "aug-defnode"
23381 #: ../fish/guestfish-actions.pod:190
23384 " aug-defnode name expr val\n"
23390 #: ../fish/guestfish-actions.pod:195
23392 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
23393 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
23394 "containing that single node."
23399 #: ../fish/guestfish-actions.pod:203
23405 #: ../fish/guestfish-actions.pod:205
23408 " aug-defvar name expr\n"
23414 #: ../fish/guestfish-actions.pod:214
23420 #: ../fish/guestfish-actions.pod:216
23423 " aug-get augpath\n"
23429 #: ../fish/guestfish-actions.pod:221
23435 #: ../fish/guestfish-actions.pod:223
23438 " aug-init root flags\n"
23444 #: ../fish/guestfish-actions.pod:229
23445 msgid "You must call this before using any other L</aug-*> commands."
23450 #: ../fish/guestfish-actions.pod:264
23451 msgid "Do not load the tree in L</aug-init>."
23456 #: ../fish/guestfish-actions.pod:268
23457 msgid "To close the handle, you can call L</aug-close>."
23462 #: ../fish/guestfish-actions.pod:272
23468 #: ../fish/guestfish-actions.pod:274
23471 " aug-insert augpath label true|false\n"
23477 #: ../fish/guestfish-actions.pod:284
23483 #: ../fish/guestfish-actions.pod:286
23492 #: ../fish/guestfish-actions.pod:293
23498 #: ../fish/guestfish-actions.pod:295
23501 " aug-ls augpath\n"
23507 #: ../fish/guestfish-actions.pod:297
23509 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
23510 "resulting nodes into alphabetical order."
23515 #: ../fish/guestfish-actions.pod:300
23521 #: ../fish/guestfish-actions.pod:302
23524 " aug-match augpath\n"
23530 #: ../fish/guestfish-actions.pod:308
23536 #: ../fish/guestfish-actions.pod:310
23539 " aug-mv src dest\n"
23545 #: ../fish/guestfish-actions.pod:315
23551 #: ../fish/guestfish-actions.pod:317
23554 " aug-rm augpath\n"
23560 #: ../fish/guestfish-actions.pod:323
23566 #: ../fish/guestfish-actions.pod:325
23575 #: ../fish/guestfish-actions.pod:329
23577 "The flags which were passed to L</aug-init> affect exactly how files are "
23583 #: ../fish/guestfish-actions.pod:332
23589 #: ../fish/guestfish-actions.pod:334
23592 " aug-set augpath val\n"
23598 #: ../fish/guestfish-actions.pod:338
23600 "In the Augeas API, it is possible to clear a node by setting the value to "
23601 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23602 "this call. Instead you must use the L</aug-clear> call."
23607 #: ../fish/guestfish-actions.pod:343
23613 #: ../fish/guestfish-actions.pod:345
23616 " available 'groups ...'\n"
23622 #: ../fish/guestfish-actions.pod:351
23624 "The libguestfs groups, and the functions that those groups correspond to, "
23625 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23626 "runtime by calling L</available-all-groups>."
23631 #: ../fish/guestfish-actions.pod:375
23632 msgid "You must call L</launch> before calling this function."
23637 #: ../fish/guestfish-actions.pod:397
23639 "This call was added in version C<1.0.80>. In previous versions of "
23640 "libguestfs all you could do would be to speculatively execute a command to "
23641 "find out if the daemon implemented it. See also L</version>."
23646 #: ../fish/guestfish-actions.pod:404
23647 msgid "available-all-groups"
23652 #: ../fish/guestfish-actions.pod:406
23655 " available-all-groups\n"
23661 #: ../fish/guestfish-actions.pod:408
23663 "This command returns a list of all optional groups that this daemon knows "
23664 "about. Note this returns both supported and unsupported groups. To find "
23665 "out which ones the daemon can actually support you have to call L</"
23666 "available> on each member of the returned list."
23671 #: ../fish/guestfish-actions.pod:414
23672 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23677 #: ../fish/guestfish-actions.pod:416
23683 #: ../fish/guestfish-actions.pod:418
23686 " base64-in (base64file|-) filename\n"
23692 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432
23693 #: ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825
23694 #: ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1218
23695 #: ../fish/guestfish-actions.pod:4209 ../fish/guestfish-actions.pod:4221
23696 #: ../fish/guestfish-actions.pod:4232 ../fish/guestfish-actions.pod:4243
23697 #: ../fish/guestfish-actions.pod:4295 ../fish/guestfish-actions.pod:4304
23698 #: ../fish/guestfish-actions.pod:4358 ../fish/guestfish-actions.pod:4381
23699 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23704 #: ../fish/guestfish-actions.pod:425
23710 #: ../fish/guestfish-actions.pod:427
23713 " base64-out filename (base64file|-)\n"
23719 #: ../fish/guestfish-actions.pod:434
23720 msgid "blockdev-flushbufs"
23725 #: ../fish/guestfish-actions.pod:436
23728 " blockdev-flushbufs device\n"
23734 #: ../fish/guestfish-actions.pod:443
23735 msgid "blockdev-getbsz"
23740 #: ../fish/guestfish-actions.pod:445
23743 " blockdev-getbsz device\n"
23749 #: ../fish/guestfish-actions.pod:454
23750 msgid "blockdev-getro"
23755 #: ../fish/guestfish-actions.pod:456
23758 " blockdev-getro device\n"
23764 #: ../fish/guestfish-actions.pod:463
23765 msgid "blockdev-getsize64"
23770 #: ../fish/guestfish-actions.pod:465
23773 " blockdev-getsize64 device\n"
23779 #: ../fish/guestfish-actions.pod:469
23780 msgid "See also L</blockdev-getsz>."
23785 #: ../fish/guestfish-actions.pod:473
23786 msgid "blockdev-getss"
23791 #: ../fish/guestfish-actions.pod:475
23794 " blockdev-getss device\n"
23800 #: ../fish/guestfish-actions.pod:480
23802 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23807 #: ../fish/guestfish-actions.pod:485
23808 msgid "blockdev-getsz"
23813 #: ../fish/guestfish-actions.pod:487
23816 " blockdev-getsz device\n"
23822 #: ../fish/guestfish-actions.pod:492
23824 "See also L</blockdev-getss> for the real sector size of the device, and L</"
23825 "blockdev-getsize64> for the more useful I<size in bytes>."
23830 #: ../fish/guestfish-actions.pod:498
23831 msgid "blockdev-rereadpt"
23836 #: ../fish/guestfish-actions.pod:500
23839 " blockdev-rereadpt device\n"
23845 #: ../fish/guestfish-actions.pod:506
23846 msgid "blockdev-setbsz"
23851 #: ../fish/guestfish-actions.pod:508
23854 " blockdev-setbsz device blocksize\n"
23860 #: ../fish/guestfish-actions.pod:517
23861 msgid "blockdev-setro"
23866 #: ../fish/guestfish-actions.pod:519
23869 " blockdev-setro device\n"
23875 #: ../fish/guestfish-actions.pod:525
23876 msgid "blockdev-setrw"
23881 #: ../fish/guestfish-actions.pod:527
23884 " blockdev-setrw device\n"
23890 #: ../fish/guestfish-actions.pod:533
23891 msgid "case-sensitive-path"
23896 #: ../fish/guestfish-actions.pod:535
23899 " case-sensitive-path path\n"
23905 #: ../fish/guestfish-actions.pod:559
23907 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
23908 "WINDOWS/system32\"> (the exact return value would depend on details of how "
23909 "the directories were originally created under Windows)."
23914 #: ../fish/guestfish-actions.pod:567
23915 msgid "See also L</realpath>."
23920 #: ../fish/guestfish-actions.pod:569
23926 #: ../fish/guestfish-actions.pod:571
23935 #: ../fish/guestfish-actions.pod:575
23937 "Note that this function cannot correctly handle binary files (specifically, "
23938 "files containing C<\\0> character which is treated as end of string). For "
23939 "those you need to use the L</read-file> or L</download> functions which have "
23940 "a more complex interface."
23945 #: ../fish/guestfish-actions.pod:583
23951 #: ../fish/guestfish-actions.pod:585
23954 " checksum csumtype path\n"
23960 #: ../fish/guestfish-actions.pod:628
23961 msgid "To get the checksum for a device, use L</checksum-device>."
23966 #: ../fish/guestfish-actions.pod:630
23967 msgid "To get the checksums for many files, use L</checksums-out>."
23972 #: ../fish/guestfish-actions.pod:632
23973 msgid "checksum-device"
23978 #: ../fish/guestfish-actions.pod:634
23981 " checksum-device csumtype device\n"
23987 #: ../fish/guestfish-actions.pod:636
23989 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23990 "device named C<device>. For the types of checksums supported see the L</"
23991 "checksum> command."
23996 #: ../fish/guestfish-actions.pod:640
23997 msgid "checksums-out"
24002 #: ../fish/guestfish-actions.pod:642
24005 " checksums-out csumtype directory (sumsfile|-)\n"
24011 #: ../fish/guestfish-actions.pod:658
24017 #: ../fish/guestfish-actions.pod:660
24020 " chmod mode path\n"
24026 #: ../fish/guestfish-actions.pod:671
24032 #: ../fish/guestfish-actions.pod:673
24035 " chown owner group path\n"
24041 #: ../fish/guestfish-actions.pod:681
24047 #: ../fish/guestfish-actions.pod:683
24050 " command 'arguments ...'\n"
24056 #: ../fish/guestfish-actions.pod:690
24058 "The single parameter is an argv-style list of arguments. The first element "
24059 "is the name of the program to run. Subsequent elements are parameters. The "
24060 "list must be non-empty (ie. must contain a program name). Note that the "
24061 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
24066 #: ../fish/guestfish-actions.pod:718
24067 msgid "command-lines"
24072 #: ../fish/guestfish-actions.pod:720
24075 " command-lines 'arguments ...'\n"
24081 #: ../fish/guestfish-actions.pod:722
24083 "This is the same as L</command>, but splits the result into a list of lines."
24088 #: ../fish/guestfish-actions.pod:725
24089 msgid "See also: L</sh-lines>"
24094 #: ../fish/guestfish-actions.pod:730
24100 #: ../fish/guestfish-actions.pod:732
24103 " config qemuparam qemuvalue\n"
24109 #: ../fish/guestfish-actions.pod:743
24115 #: ../fish/guestfish-actions.pod:745
24118 " copy-size src dest size\n"
24124 #: ../fish/guestfish-actions.pod:753
24130 #: ../fish/guestfish-actions.pod:755
24139 #: ../fish/guestfish-actions.pod:760
24145 #: ../fish/guestfish-actions.pod:762
24154 #: ../fish/guestfish-actions.pod:767
24160 #: ../fish/guestfish-actions.pod:769
24169 #: ../fish/guestfish-actions.pod:776
24171 "If the destination is a device, it must be as large or larger than the "
24172 "source file or device, otherwise the copy will fail. This command cannot do "
24173 "partial copies (see L</copy-size>)."
24178 #: ../fish/guestfish-actions.pod:780
24184 #: ../fish/guestfish-actions.pod:782
24193 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
24195 "This command is mostly useful for interactive sessions. It is I<not> "
24196 "intended that you try to parse the output string. Use L</statvfs> from "
24202 #: ../fish/guestfish-actions.pod:790
24208 #: ../fish/guestfish-actions.pod:792
24217 #: ../fish/guestfish-actions.pod:801
24223 #: ../fish/guestfish-actions.pod:803
24232 #: ../fish/guestfish-actions.pod:809
24234 "Another way to get the same information is to enable verbose messages with "
24235 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
24236 "before running the program."
24241 #: ../fish/guestfish-actions.pod:814
24247 #: ../fish/guestfish-actions.pod:816
24250 " download remotefilename (filename|-)\n"
24256 #: ../fish/guestfish-actions.pod:823
24257 msgid "See also L</upload>, L</cat>."
24262 #: ../fish/guestfish-actions.pod:827
24263 msgid "download-offset"
24268 #: ../fish/guestfish-actions.pod:829
24271 " download-offset remotefilename (filename|-) offset size\n"
24277 #: ../fish/guestfish-actions.pod:837
24279 "Note that there is no limit on the amount of data that can be downloaded "
24280 "with this call, unlike with L</pread>, and this call always reads the full "
24281 "amount unless an error occurs."
24286 #: ../fish/guestfish-actions.pod:842
24287 msgid "See also L</download>, L</pread>."
24292 #: ../fish/guestfish-actions.pod:846
24293 msgid "drop-caches"
24298 #: ../fish/guestfish-actions.pod:848
24301 " drop-caches whattodrop\n"
24307 #: ../fish/guestfish-actions.pod:860
24313 #: ../fish/guestfish-actions.pod:862
24322 #: ../fish/guestfish-actions.pod:874
24328 #: ../fish/guestfish-actions.pod:876
24331 " e2fsck-f device\n"
24337 #: ../fish/guestfish-actions.pod:882
24339 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
24340 "should use L</fsck>."
24345 #: ../fish/guestfish-actions.pod:885
24346 msgid "echo-daemon"
24351 #: ../fish/guestfish-actions.pod:887
24354 " echo-daemon 'words ...'\n"
24360 #: ../fish/guestfish-actions.pod:894
24361 msgid "See also L</ping-daemon>."
24366 #: ../fish/guestfish-actions.pod:896
24372 #: ../fish/guestfish-actions.pod:898
24375 " egrep regex path\n"
24381 #: ../fish/guestfish-actions.pod:906
24387 #: ../fish/guestfish-actions.pod:908
24390 " egrepi regex path\n"
24396 #: ../fish/guestfish-actions.pod:916
24402 #: ../fish/guestfish-actions.pod:918
24405 " equal file1 file2\n"
24411 #: ../fish/guestfish-actions.pod:925
24417 #: ../fish/guestfish-actions.pod:927
24426 #: ../fish/guestfish-actions.pod:932
24427 msgid "See also L</is-file>, L</is-dir>, L</stat>."
24432 #: ../fish/guestfish-actions.pod:934
24438 #: ../fish/guestfish-actions.pod:936
24441 " fallocate path len\n"
24447 #: ../fish/guestfish-actions.pod:953
24448 msgid "fallocate64"
24453 #: ../fish/guestfish-actions.pod:955
24456 " fallocate64 path len\n"
24462 #: ../fish/guestfish-actions.pod:961
24464 "Note that this call allocates disk blocks for the file. To create a sparse "
24465 "file use L</truncate-size> instead."
24470 #: ../fish/guestfish-actions.pod:964
24472 "The deprecated call L</fallocate> does the same, but owing to an oversight "
24473 "it only allowed 30 bit lengths to be specified, effectively limiting the "
24474 "maximum size of files created through that call to 1GB."
24479 #: ../fish/guestfish-actions.pod:973
24485 #: ../fish/guestfish-actions.pod:975
24488 " fgrep pattern path\n"
24494 #: ../fish/guestfish-actions.pod:983
24500 #: ../fish/guestfish-actions.pod:985
24503 " fgrepi pattern path\n"
24509 #: ../fish/guestfish-actions.pod:993
24515 #: ../fish/guestfish-actions.pod:995
24523 #: ../fish/guestfish-actions.pod:1011
24525 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
24531 #: ../fish/guestfish-actions.pod:1014
24532 msgid "file-architecture"
24537 #: ../fish/guestfish-actions.pod:1016
24540 " file-architecture filename\n"
24546 #: ../fish/guestfish-actions.pod:1119
24552 #: ../fish/guestfish-actions.pod:1121
24561 #: ../fish/guestfish-actions.pod:1125
24563 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
24564 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
24569 #: ../fish/guestfish-actions.pod:1129
24575 #: ../fish/guestfish-actions.pod:1131
24578 " fill c len path\n"
24584 #: ../fish/guestfish-actions.pod:1137
24586 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24587 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
24588 "L</fill-pattern>."
24593 #: ../fish/guestfish-actions.pod:1142
24594 msgid "fill-pattern"
24599 #: ../fish/guestfish-actions.pod:1144
24602 " fill-pattern pattern len path\n"
24608 #: ../fish/guestfish-actions.pod:1146
24610 "This function is like L</fill> except that it creates a new file of length "
24611 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
24612 "is truncated if necessary to ensure the length of the file is exactly C<len> "
24618 #: ../fish/guestfish-actions.pod:1151
24624 #: ../fish/guestfish-actions.pod:1153
24627 " find directory\n"
24633 #: ../fish/guestfish-actions.pod:1167
24634 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
24639 #: ../fish/guestfish-actions.pod:1180
24640 msgid "See also L</find0>."
24645 #: ../fish/guestfish-actions.pod:1185
24651 #: ../fish/guestfish-actions.pod:1187
24654 " find0 directory (files|-)\n"
24660 #: ../fish/guestfish-actions.pod:1193
24662 "This command works the same way as L</find> with the following exceptions:"
24667 #: ../fish/guestfish-actions.pod:1220
24668 msgid "findfs-label"
24673 #: ../fish/guestfish-actions.pod:1222
24676 " findfs-label label\n"
24682 #: ../fish/guestfish-actions.pod:1228
24683 msgid "To find the label of a filesystem, use L</vfs-label>."
24688 #: ../fish/guestfish-actions.pod:1230
24689 msgid "findfs-uuid"
24694 #: ../fish/guestfish-actions.pod:1232
24697 " findfs-uuid uuid\n"
24703 #: ../fish/guestfish-actions.pod:1238
24704 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
24709 #: ../fish/guestfish-actions.pod:1240
24715 #: ../fish/guestfish-actions.pod:1242
24718 " fsck fstype device\n"
24724 #: ../fish/guestfish-actions.pod:1272
24730 #: ../fish/guestfish-actions.pod:1274
24739 #: ../fish/guestfish-actions.pod:1281
24740 msgid "get-autosync"
24745 #: ../fish/guestfish-actions.pod:1283
24754 #: ../fish/guestfish-actions.pod:1287
24760 #: ../fish/guestfish-actions.pod:1289
24769 #: ../fish/guestfish-actions.pod:1293
24770 msgid "get-e2label"
24775 #: ../fish/guestfish-actions.pod:1295
24778 " get-e2label device\n"
24784 #: ../fish/guestfish-actions.pod:1307
24790 #: ../fish/guestfish-actions.pod:1309
24793 " get-e2uuid device\n"
24799 #: ../fish/guestfish-actions.pod:1321
24800 msgid "get-memsize"
24805 #: ../fish/guestfish-actions.pod:1323
24814 #: ../fish/guestfish-actions.pod:1328
24816 "If L</set-memsize> was not called on this handle, and if "
24817 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24818 "value for memsize."
24823 #: ../fish/guestfish-actions.pod:1335
24824 msgid "get-network"
24829 #: ../fish/guestfish-actions.pod:1337
24838 #: ../fish/guestfish-actions.pod:1341
24844 #: ../fish/guestfish-actions.pod:1343
24853 #: ../fish/guestfish-actions.pod:1350
24859 #: ../fish/guestfish-actions.pod:1352
24865 #: ../fish/guestfish-actions.pod:1354
24874 #: ../fish/guestfish-actions.pod:1361
24880 #: ../fish/guestfish-actions.pod:1363
24889 #: ../fish/guestfish-actions.pod:1370
24890 msgid "get-recovery-proc"
24895 #: ../fish/guestfish-actions.pod:1372
24898 " get-recovery-proc\n"
24904 #: ../fish/guestfish-actions.pod:1376
24905 msgid "get-selinux"
24910 #: ../fish/guestfish-actions.pod:1378
24919 #: ../fish/guestfish-actions.pod:1380
24921 "This returns the current setting of the selinux flag which is passed to the "
24922 "appliance at boot time. See L</set-selinux>."
24927 #: ../fish/guestfish-actions.pod:1386
24933 #: ../fish/guestfish-actions.pod:1388
24942 #: ../fish/guestfish-actions.pod:1395
24948 #: ../fish/guestfish-actions.pod:1397
24957 #: ../fish/guestfish-actions.pod:1401
24963 #: ../fish/guestfish-actions.pod:1403
24972 #: ../fish/guestfish-actions.pod:1405
24974 "Return the current umask. By default the umask is C<022> unless it has been "
24975 "set by calling L</umask>."
24980 #: ../fish/guestfish-actions.pod:1408
24981 msgid "get-verbose"
24986 #: ../fish/guestfish-actions.pod:1410
24995 #: ../fish/guestfish-actions.pod:1414
25001 #: ../fish/guestfish-actions.pod:1416
25010 #: ../fish/guestfish-actions.pod:1420
25011 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
25016 #: ../fish/guestfish-actions.pod:1423
25022 #: ../fish/guestfish-actions.pod:1425
25025 " getxattr path name\n"
25031 #: ../fish/guestfish-actions.pod:1427
25033 "Get a single extended attribute from file C<path> named C<name>. This call "
25034 "follows symlinks. If you want to lookup an extended attribute for the "
25035 "symlink itself, use L</lgetxattr>."
25040 #: ../fish/guestfish-actions.pod:1431 ../fish/guestfish-actions.pod:2262
25042 "Normally it is better to get all extended attributes from a file in one go "
25043 "by calling L</getxattrs>. However some Linux filesystem implementations are "
25044 "buggy and do not provide a way to list out attributes. For these "
25045 "filesystems (notably ntfs-3g) you have to know the names of the extended "
25046 "attributes you want in advance and call this function."
25051 #: ../fish/guestfish-actions.pod:1441
25052 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
25057 #: ../fish/guestfish-actions.pod:1443
25063 #: ../fish/guestfish-actions.pod:1445
25066 " getxattrs path\n"
25072 #: ../fish/guestfish-actions.pod:1453
25073 msgid "See also: L</lgetxattrs>, L<attr(5)>."
25078 #: ../fish/guestfish-actions.pod:1455
25079 msgid "glob-expand"
25084 #: ../fish/guestfish-actions.pod:1457
25087 " glob-expand pattern\n"
25093 #: ../fish/guestfish-actions.pod:1470
25099 #: ../fish/guestfish-actions.pod:1472
25102 " grep regex path\n"
25108 #: ../fish/guestfish-actions.pod:1480
25114 #: ../fish/guestfish-actions.pod:1482
25117 " grepi regex path\n"
25123 #: ../fish/guestfish-actions.pod:1490
25124 msgid "grub-install"
25129 #: ../fish/guestfish-actions.pod:1492
25132 " grub-install root device\n"
25138 #: ../fish/guestfish-actions.pod:1508
25144 #: ../fish/guestfish-actions.pod:1510
25153 #: ../fish/guestfish-actions.pod:1518
25159 #: ../fish/guestfish-actions.pod:1520
25162 " head-n nrlines path\n"
25168 #: ../fish/guestfish-actions.pod:1533
25174 #: ../fish/guestfish-actions.pod:1535
25183 #: ../fish/guestfish-actions.pod:1543
25189 #: ../fish/guestfish-actions.pod:1545
25192 " initrd-cat initrdpath filename\n"
25198 #: ../fish/guestfish-actions.pod:1557
25199 msgid "See also L</initrd-list>."
25204 #: ../fish/guestfish-actions.pod:1562
25205 msgid "initrd-list"
25210 #: ../fish/guestfish-actions.pod:1564
25213 " initrd-list path\n"
25219 #: ../fish/guestfish-actions.pod:1576
25220 msgid "inotify-add-watch"
25225 #: ../fish/guestfish-actions.pod:1578
25228 " inotify-add-watch path mask\n"
25234 #: ../fish/guestfish-actions.pod:1590
25235 msgid "inotify-close"
25240 #: ../fish/guestfish-actions.pod:1592
25249 #: ../fish/guestfish-actions.pod:1598
25250 msgid "inotify-files"
25255 #: ../fish/guestfish-actions.pod:1600
25264 #: ../fish/guestfish-actions.pod:1602
25266 "This function is a helpful wrapper around L</inotify-read> which just "
25267 "returns a list of pathnames of objects that were touched. The returned "
25268 "pathnames are sorted and deduplicated."
25273 #: ../fish/guestfish-actions.pod:1606
25274 msgid "inotify-init"
25279 #: ../fish/guestfish-actions.pod:1608
25282 " inotify-init maxevents\n"
25288 #: ../fish/guestfish-actions.pod:1614
25290 "C<maxevents> is the maximum number of events which will be queued up between "
25291 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
25292 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
25293 "default was 16384 events. Beyond this limit, the kernel throws away events, "
25294 "but records the fact that it threw them away by setting a flag "
25295 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
25300 #: ../fish/guestfish-actions.pod:1624
25302 "Before any events are generated, you have to add some watches to the "
25303 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
25304 "L</inotify-watch-all>."
25309 #: ../fish/guestfish-actions.pod:1630
25311 "Queued up events should be read periodically by calling L</inotify-read> (or "
25312 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
25313 "If you don't read the events out often enough then you risk the internal "
25314 "queue overflowing."
25319 #: ../fish/guestfish-actions.pod:1637
25321 "The handle should be closed after use by calling L</inotify-close>. This "
25322 "also removes any watches automatically."
25327 #: ../fish/guestfish-actions.pod:1646
25328 msgid "inotify-read"
25333 #: ../fish/guestfish-actions.pod:1648
25342 #: ../fish/guestfish-actions.pod:1661
25343 msgid "inotify-rm-watch"
25348 #: ../fish/guestfish-actions.pod:1663
25351 " inotify-rm-watch wd\n"
25357 #: ../fish/guestfish-actions.pod:1665
25358 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
25363 #: ../fish/guestfish-actions.pod:1668
25364 msgid "inspect-get-arch"
25369 #: ../fish/guestfish-actions.pod:1670
25372 " inspect-get-arch root\n"
25378 #: ../fish/guestfish-actions.pod:1672 ../fish/guestfish-actions.pod:1688
25379 #: ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:1780
25380 #: ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1816
25381 #: ../fish/guestfish-actions.pod:1831 ../fish/guestfish-actions.pod:1858
25382 #: ../fish/guestfish-actions.pod:1880 ../fish/guestfish-actions.pod:1904
25383 #: ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1969
25384 #: ../fish/guestfish-actions.pod:1985
25386 "This function should only be called with a root device string as returned by "
25392 #: ../fish/guestfish-actions.pod:1675
25394 "This returns the architecture of the inspected operating system. The "
25395 "possible return values are listed under L</file-architecture>."
25400 #: ../fish/guestfish-actions.pod:1684
25401 msgid "inspect-get-distro"
25406 #: ../fish/guestfish-actions.pod:1686
25409 " inspect-get-distro root\n"
25415 #: ../fish/guestfish-actions.pod:1758
25416 msgid "inspect-get-filesystems"
25421 #: ../fish/guestfish-actions.pod:1760
25424 " inspect-get-filesystems root\n"
25430 #: ../fish/guestfish-actions.pod:1773
25432 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25433 "get-mountpoints>."
25438 #: ../fish/guestfish-actions.pod:1776
25439 msgid "inspect-get-hostname"
25444 #: ../fish/guestfish-actions.pod:1778
25447 " inspect-get-hostname root\n"
25453 #: ../fish/guestfish-actions.pod:1791
25454 msgid "inspect-get-major-version"
25459 #: ../fish/guestfish-actions.pod:1793
25462 " inspect-get-major-version root\n"
25468 #: ../fish/guestfish-actions.pod:1812
25469 msgid "inspect-get-minor-version"
25474 #: ../fish/guestfish-actions.pod:1814
25477 " inspect-get-minor-version root\n"
25483 #: ../fish/guestfish-actions.pod:1824
25485 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25486 "get-major-version>."
25491 #: ../fish/guestfish-actions.pod:1827
25492 msgid "inspect-get-mountpoints"
25497 #: ../fish/guestfish-actions.pod:1829
25500 " inspect-get-mountpoints root\n"
25506 #: ../fish/guestfish-actions.pod:1851
25508 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25509 "get-filesystems>."
25514 #: ../fish/guestfish-actions.pod:1854
25515 msgid "inspect-get-package-format"
25520 #: ../fish/guestfish-actions.pod:1856
25523 " inspect-get-package-format root\n"
25529 #: ../fish/guestfish-actions.pod:1861
25531 "This function and L</inspect-get-package-management> return the package "
25532 "format and package management tool used by the inspected operating system. "
25533 "For example for Fedora these functions would return C<rpm> (package format) "
25534 "and C<yum> (package management)."
25539 #: ../fish/guestfish-actions.pod:1876
25540 msgid "inspect-get-package-management"
25545 #: ../fish/guestfish-actions.pod:1878
25548 " inspect-get-package-management root\n"
25554 #: ../fish/guestfish-actions.pod:1883
25556 "L</inspect-get-package-format> and this function return the package format "
25557 "and package management tool used by the inspected operating system. For "
25558 "example for Fedora these functions would return C<rpm> (package format) and "
25559 "C<yum> (package management)."
25564 #: ../fish/guestfish-actions.pod:1900
25565 msgid "inspect-get-product-name"
25570 #: ../fish/guestfish-actions.pod:1902
25573 " inspect-get-product-name root\n"
25579 #: ../fish/guestfish-actions.pod:1917
25580 msgid "inspect-get-roots"
25585 #: ../fish/guestfish-actions.pod:1919
25588 " inspect-get-roots\n"
25594 #: ../fish/guestfish-actions.pod:1921
25596 "This function is a convenient way to get the list of root devices, as "
25597 "returned from a previous call to L</inspect-os>, but without redoing the "
25598 "whole inspection process."
25603 #: ../fish/guestfish-actions.pod:1925
25605 "This returns an empty list if either no root devices were found or the "
25606 "caller has not called L</inspect-os>."
25611 #: ../fish/guestfish-actions.pod:1930
25612 msgid "inspect-get-type"
25617 #: ../fish/guestfish-actions.pod:1932
25620 " inspect-get-type root\n"
25626 #: ../fish/guestfish-actions.pod:1965
25627 msgid "inspect-get-windows-systemroot"
25632 #: ../fish/guestfish-actions.pod:1967
25635 " inspect-get-windows-systemroot root\n"
25641 #: ../fish/guestfish-actions.pod:1981
25642 msgid "inspect-list-applications"
25647 #: ../fish/guestfish-actions.pod:1983
25650 " inspect-list-applications root\n"
25656 #: ../fish/guestfish-actions.pod:1990
25658 "I<Note:> This call works differently from other parts of the inspection "
25659 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
25660 "then mount up the disks, before calling this. Listing applications is a "
25661 "significantly more difficult operation which requires access to the full "
25662 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
25663 "are just returning data cached in the libguestfs handle, this call actually "
25664 "reads parts of the mounted filesystems during the call."
25669 #: ../fish/guestfish-actions.pod:2080
25675 #: ../fish/guestfish-actions.pod:2082
25684 #: ../fish/guestfish-actions.pod:2097
25686 "You can pass the root string(s) returned to other L</inspect-get-*> "
25687 "functions in order to query further information about each operating system, "
25688 "such as the name and version."
25693 #: ../fish/guestfish-actions.pod:2102
25695 "This function uses other libguestfs features such as L</mount-ro> and L</"
25696 "umount-all> in order to mount and unmount filesystems and look at the "
25697 "contents. This should be called with no disks currently mounted. The "
25698 "function may also use Augeas, so any existing Augeas handle will be closed."
25703 #: ../fish/guestfish-actions.pod:2114 ../fish/guestfish-actions.pod:2290
25704 #: ../fish/guestfish-actions.pod:2336
25705 msgid "See also L</list-filesystems>."
25710 #: ../fish/guestfish-actions.pod:2116
25711 msgid "is-blockdev"
25716 #: ../fish/guestfish-actions.pod:2118
25719 " is-blockdev path\n"
25725 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2141
25726 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2169
25727 #: ../fish/guestfish-actions.pod:2179 ../fish/guestfish-actions.pod:2213
25728 #: ../fish/guestfish-actions.pod:2222
25729 msgid "See also L</stat>."
25734 #: ../fish/guestfish-actions.pod:2125
25740 #: ../fish/guestfish-actions.pod:2127
25749 #: ../fish/guestfish-actions.pod:2134
25755 #: ../fish/guestfish-actions.pod:2136
25758 " is-chardev path\n"
25764 #: ../fish/guestfish-actions.pod:2143
25770 #: ../fish/guestfish-actions.pod:2145
25779 #: ../fish/guestfish-actions.pod:2152
25785 #: ../fish/guestfish-actions.pod:2154
25794 #: ../fish/guestfish-actions.pod:2162
25800 #: ../fish/guestfish-actions.pod:2164
25809 #: ../fish/guestfish-actions.pod:2171
25815 #: ../fish/guestfish-actions.pod:2173
25824 #: ../fish/guestfish-actions.pod:2181
25825 msgid "is-launching"
25830 #: ../fish/guestfish-actions.pod:2183
25839 #: ../fish/guestfish-actions.pod:2190
25845 #: ../fish/guestfish-actions.pod:2192
25854 #: ../fish/guestfish-actions.pod:2197
25860 #: ../fish/guestfish-actions.pod:2199
25869 #: ../fish/guestfish-actions.pod:2206
25875 #: ../fish/guestfish-actions.pod:2208
25878 " is-socket path\n"
25884 #: ../fish/guestfish-actions.pod:2215
25890 #: ../fish/guestfish-actions.pod:2217
25893 " is-symlink path\n"
25899 #: ../fish/guestfish-actions.pod:2224
25900 msgid "kill-subprocess"
25905 #: ../fish/guestfish-actions.pod:2226
25908 " kill-subprocess\n"
25914 #: ../fish/guestfish-actions.pod:2230
25920 #: ../fish/guestfish-actions.pod:2232
25926 #: ../fish/guestfish-actions.pod:2234
25935 #: ../fish/guestfish-actions.pod:2242
25941 #: ../fish/guestfish-actions.pod:2244
25944 " lchown owner group path\n"
25950 #: ../fish/guestfish-actions.pod:2246
25952 "Change the file owner to C<owner> and group to C<group>. This is like L</"
25953 "chown> but if C<path> is a symlink then the link itself is changed, not the "
25959 #: ../fish/guestfish-actions.pod:2254
25965 #: ../fish/guestfish-actions.pod:2256
25968 " lgetxattr path name\n"
25974 #: ../fish/guestfish-actions.pod:2272
25975 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25980 #: ../fish/guestfish-actions.pod:2274
25986 #: ../fish/guestfish-actions.pod:2276
25989 " lgetxattrs path\n"
25995 #: ../fish/guestfish-actions.pod:2278
25997 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25998 "it returns the extended attributes of the link itself."
26003 #: ../fish/guestfish-actions.pod:2282
26004 msgid "list-devices"
26009 #: ../fish/guestfish-actions.pod:2284
26018 #: ../fish/guestfish-actions.pod:2292
26019 msgid "list-filesystems"
26024 #: ../fish/guestfish-actions.pod:2294
26027 " list-filesystems\n"
26033 #: ../fish/guestfish-actions.pod:2313
26035 "This command runs other libguestfs commands, which might include L</mount> "
26036 "and L</umount>, and therefore you should use this soon after launch and only "
26037 "when nothing is mounted."
26042 #: ../fish/guestfish-actions.pod:2317
26044 "Not all of the filesystems returned will be mountable. In particular, swap "
26045 "partitions are returned in the list. Also this command does not check that "
26046 "each filesystem found is valid and mountable, and some filesystems might be "
26047 "mountable but require special options. Filesystems may not all belong to a "
26048 "single logical operating system (use L</inspect-os> to look for OSes)."
26053 #: ../fish/guestfish-actions.pod:2325
26054 msgid "list-partitions"
26059 #: ../fish/guestfish-actions.pod:2327
26062 " list-partitions\n"
26068 #: ../fish/guestfish-actions.pod:2333
26070 "This does not return logical volumes. For that you will need to call L</"
26076 #: ../fish/guestfish-actions.pod:2338
26082 #: ../fish/guestfish-actions.pod:2340
26091 #: ../fish/guestfish-actions.pod:2348
26097 #: ../fish/guestfish-actions.pod:2350
26100 " ln target linkname\n"
26106 #: ../fish/guestfish-actions.pod:2354
26112 #: ../fish/guestfish-actions.pod:2356
26115 " ln-f target linkname\n"
26121 #: ../fish/guestfish-actions.pod:2361
26127 #: ../fish/guestfish-actions.pod:2363
26130 " ln-s target linkname\n"
26136 #: ../fish/guestfish-actions.pod:2367
26142 #: ../fish/guestfish-actions.pod:2369
26145 " ln-sf target linkname\n"
26151 #: ../fish/guestfish-actions.pod:2374
26152 msgid "lremovexattr"
26157 #: ../fish/guestfish-actions.pod:2376
26160 " lremovexattr xattr path\n"
26166 #: ../fish/guestfish-actions.pod:2378
26168 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
26169 "it removes an extended attribute of the link itself."
26174 #: ../fish/guestfish-actions.pod:2382
26180 #: ../fish/guestfish-actions.pod:2384
26189 #: ../fish/guestfish-actions.pod:2390
26191 "This command is mostly useful for interactive sessions. Programs should "
26192 "probably use L</readdir> instead."
26197 #: ../fish/guestfish-actions.pod:2393
26203 #: ../fish/guestfish-actions.pod:2395
26206 " lsetxattr xattr val vallen path\n"
26212 #: ../fish/guestfish-actions.pod:2397
26214 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
26215 "sets an extended attribute of the link itself."
26220 #: ../fish/guestfish-actions.pod:2401
26226 #: ../fish/guestfish-actions.pod:2403
26235 #: ../fish/guestfish-actions.pod:2407
26237 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
26238 "the link is stat-ed, not the file it refers to."
26243 #: ../fish/guestfish-actions.pod:2413
26249 #: ../fish/guestfish-actions.pod:2415
26252 " lstatlist path 'names ...'\n"
26258 #: ../fish/guestfish-actions.pod:2417
26260 "This call allows you to perform the L</lstat> operation on multiple files, "
26261 "where all files are in the directory C<path>. C<names> is the list of files "
26262 "from this directory."
26267 #: ../fish/guestfish-actions.pod:2426
26269 "This call is intended for programs that want to efficiently list a directory "
26270 "contents without making many round-trips. See also L</lxattrlist> for a "
26271 "similarly efficient call for getting extended attributes. Very long "
26272 "directory listings might cause the protocol message size to be exceeded, "
26273 "causing this call to fail. The caller must split up such requests into "
26274 "smaller groups of names."
26279 #: ../fish/guestfish-actions.pod:2434
26280 msgid "luks-add-key"
26285 #: ../fish/guestfish-actions.pod:2436
26288 " luks-add-key device keyslot\n"
26294 #: ../fish/guestfish-actions.pod:2443
26296 "Note that if C<keyslot> already contains a key, then this command will "
26297 "fail. You have to use L</luks-kill-slot> first to remove that key."
26302 #: ../fish/guestfish-actions.pod:2447 ../fish/guestfish-actions.pod:2469
26303 #: ../fish/guestfish-actions.pod:2482 ../fish/guestfish-actions.pod:2496
26304 #: ../fish/guestfish-actions.pod:2519 ../fish/guestfish-actions.pod:2529
26306 "This command has one or more key or passphrase parameters. Guestfish will "
26307 "prompt for these separately."
26312 #: ../fish/guestfish-actions.pod:2450
26318 #: ../fish/guestfish-actions.pod:2452
26321 " luks-close device\n"
26327 #: ../fish/guestfish-actions.pod:2454
26329 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
26330 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
26331 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
26337 #: ../fish/guestfish-actions.pod:2460
26338 msgid "luks-format"
26343 #: ../fish/guestfish-actions.pod:2462
26346 " luks-format device keyslot\n"
26352 #: ../fish/guestfish-actions.pod:2475
26353 msgid "luks-format-cipher"
26358 #: ../fish/guestfish-actions.pod:2477
26361 " luks-format-cipher device keyslot cipher\n"
26367 #: ../fish/guestfish-actions.pod:2479
26369 "This command is the same as L</luks-format> but it also allows you to set "
26370 "the C<cipher> used."
26375 #: ../fish/guestfish-actions.pod:2488
26376 msgid "luks-kill-slot"
26381 #: ../fish/guestfish-actions.pod:2490
26384 " luks-kill-slot device keyslot\n"
26390 #: ../fish/guestfish-actions.pod:2499
26396 #: ../fish/guestfish-actions.pod:2501
26399 " luks-open device mapname\n"
26405 #: ../fish/guestfish-actions.pod:2515
26407 "If this block device contains LVM volume groups, then calling L</vgscan> "
26408 "followed by L</vg-activate-all> will make them visible."
26413 #: ../fish/guestfish-actions.pod:2522
26414 msgid "luks-open-ro"
26419 #: ../fish/guestfish-actions.pod:2524
26422 " luks-open-ro device mapname\n"
26428 #: ../fish/guestfish-actions.pod:2526
26430 "This is the same as L</luks-open> except that a read-only mapping is created."
26435 #: ../fish/guestfish-actions.pod:2532
26441 #: ../fish/guestfish-actions.pod:2534
26444 " lvcreate logvol volgroup mbytes\n"
26450 #: ../fish/guestfish-actions.pod:2539
26451 msgid "lvm-canonical-lv-name"
26456 #: ../fish/guestfish-actions.pod:2541
26459 " lvm-canonical-lv-name lvname\n"
26465 #: ../fish/guestfish-actions.pod:2550
26466 msgid "See also L</is-lv>."
26471 #: ../fish/guestfish-actions.pod:2552
26472 msgid "lvm-clear-filter"
26477 #: ../fish/guestfish-actions.pod:2554
26480 " lvm-clear-filter\n"
26486 #: ../fish/guestfish-actions.pod:2556
26488 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
26494 #: ../fish/guestfish-actions.pod:2562
26495 msgid "lvm-remove-all"
26500 #: ../fish/guestfish-actions.pod:2564
26503 " lvm-remove-all\n"
26509 #: ../fish/guestfish-actions.pod:2572
26510 msgid "lvm-set-filter"
26515 #: ../fish/guestfish-actions.pod:2574
26518 " lvm-set-filter 'devices ...'\n"
26524 #: ../fish/guestfish-actions.pod:2599
26530 #: ../fish/guestfish-actions.pod:2601
26533 " lvremove device\n"
26539 #: ../fish/guestfish-actions.pod:2609
26545 #: ../fish/guestfish-actions.pod:2611
26548 " lvrename logvol newlogvol\n"
26554 #: ../fish/guestfish-actions.pod:2615
26560 #: ../fish/guestfish-actions.pod:2617
26563 " lvresize device mbytes\n"
26569 #: ../fish/guestfish-actions.pod:2623
26570 msgid "lvresize-free"
26575 #: ../fish/guestfish-actions.pod:2625
26578 " lvresize-free lv percent\n"
26584 #: ../fish/guestfish-actions.pod:2633
26590 #: ../fish/guestfish-actions.pod:2635
26599 #: ../fish/guestfish-actions.pod:2643
26600 msgid "See also L</lvs-full>, L</list-filesystems>."
26605 #: ../fish/guestfish-actions.pod:2645
26611 #: ../fish/guestfish-actions.pod:2647
26620 #: ../fish/guestfish-actions.pod:2652
26626 #: ../fish/guestfish-actions.pod:2654
26635 #: ../fish/guestfish-actions.pod:2658
26641 #: ../fish/guestfish-actions.pod:2660
26644 " lxattrlist path 'names ...'\n"
26650 #: ../fish/guestfish-actions.pod:2676
26652 "This call is intended for programs that want to efficiently list a directory "
26653 "contents without making many round-trips. See also L</lstatlist> for a "
26654 "similarly efficient call for getting standard stats. Very long directory "
26655 "listings might cause the protocol message size to be exceeded, causing this "
26656 "call to fail. The caller must split up such requests into smaller groups of "
26662 #: ../fish/guestfish-actions.pod:2684
26668 #: ../fish/guestfish-actions.pod:2686
26677 #: ../fish/guestfish-actions.pod:2690
26683 #: ../fish/guestfish-actions.pod:2692
26686 " mkdir-mode path mode\n"
26692 #: ../fish/guestfish-actions.pod:2701
26693 msgid "See also L</mkdir>, L</umask>"
26698 #: ../fish/guestfish-actions.pod:2703
26704 #: ../fish/guestfish-actions.pod:2705
26713 #: ../fish/guestfish-actions.pod:2710
26719 #: ../fish/guestfish-actions.pod:2712
26722 " mkdtemp template\n"
26728 #: ../fish/guestfish-actions.pod:2733
26734 #: ../fish/guestfish-actions.pod:2735
26737 " mke2fs-J fstype blocksize device journal\n"
26743 #: ../fish/guestfish-actions.pod:2743
26744 msgid "See also L</mke2journal>."
26749 #: ../fish/guestfish-actions.pod:2745
26755 #: ../fish/guestfish-actions.pod:2747
26758 " mke2fs-JL fstype blocksize device label\n"
26764 #: ../fish/guestfish-actions.pod:2752
26765 msgid "See also L</mke2journal-L>."
26770 #: ../fish/guestfish-actions.pod:2754
26776 #: ../fish/guestfish-actions.pod:2756
26779 " mke2fs-JU fstype blocksize device uuid\n"
26785 #: ../fish/guestfish-actions.pod:2761
26786 msgid "See also L</mke2journal-U>."
26791 #: ../fish/guestfish-actions.pod:2763
26792 msgid "mke2journal"
26797 #: ../fish/guestfish-actions.pod:2765
26800 " mke2journal blocksize device\n"
26806 #: ../fish/guestfish-actions.pod:2772
26807 msgid "mke2journal-L"
26812 #: ../fish/guestfish-actions.pod:2774
26815 " mke2journal-L blocksize label device\n"
26821 #: ../fish/guestfish-actions.pod:2778
26822 msgid "mke2journal-U"
26827 #: ../fish/guestfish-actions.pod:2780
26830 " mke2journal-U blocksize uuid device\n"
26836 #: ../fish/guestfish-actions.pod:2784
26842 #: ../fish/guestfish-actions.pod:2786
26845 " mkfifo mode path\n"
26851 #: ../fish/guestfish-actions.pod:2788
26853 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26854 "is just a convenient wrapper around L</mknod>."
26859 #: ../fish/guestfish-actions.pod:2794
26865 #: ../fish/guestfish-actions.pod:2796
26868 " mkfs fstype device\n"
26874 #: ../fish/guestfish-actions.pod:2802
26880 #: ../fish/guestfish-actions.pod:2804
26883 " mkfs-b fstype blocksize device\n"
26889 #: ../fish/guestfish-actions.pod:2806
26891 "This call is similar to L</mkfs>, but it allows you to control the block "
26892 "size of the resulting filesystem. Supported block sizes depend on the "
26893 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26898 #: ../fish/guestfish-actions.pod:2821
26904 #: ../fish/guestfish-actions.pod:2823
26907 " mkfs-opts fstype device [blocksize:..]\n"
26913 #: ../fish/guestfish-actions.pod:2847
26914 msgid "mkmountpoint"
26919 #: ../fish/guestfish-actions.pod:2849
26922 " mkmountpoint exemptpath\n"
26928 #: ../fish/guestfish-actions.pod:2851
26930 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
26931 "to create extra mountpoints before mounting the first filesystem."
26936 #: ../fish/guestfish-actions.pod:2875
26938 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26939 "unexpected errors if you try to mix these calls. It is safest to manually "
26940 "unmount filesystems and remove mountpoints after use."
26945 #: ../fish/guestfish-actions.pod:2879
26947 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26948 "for this to work for manual mountpoints, you must ensure that the innermost "
26949 "mountpoints have the longest pathnames, as in the example code above."
26954 #: ../fish/guestfish-actions.pod:2886
26956 "Autosync [see L</set-autosync>, this is set by default on handles] means "
26957 "that L</umount-all> is called when the handle is closed which can also "
26958 "trigger these issues."
26963 #: ../fish/guestfish-actions.pod:2890
26969 #: ../fish/guestfish-actions.pod:2892
26972 " mknod mode devmajor devminor path\n"
26978 #: ../fish/guestfish-actions.pod:2902
26980 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26981 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26982 "regular file). These constants are available in the standard Linux header "
26983 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26984 "wrappers around this command which bitwise OR in the appropriate constant "
26990 #: ../fish/guestfish-actions.pod:2912
26996 #: ../fish/guestfish-actions.pod:2914
26999 " mknod-b mode devmajor devminor path\n"
27005 #: ../fish/guestfish-actions.pod:2916
27007 "This call creates a block device node called C<path> with mode C<mode> and "
27008 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27009 "wrapper around L</mknod>."
27014 #: ../fish/guestfish-actions.pod:2922
27020 #: ../fish/guestfish-actions.pod:2924
27023 " mknod-c mode devmajor devminor path\n"
27029 #: ../fish/guestfish-actions.pod:2926
27031 "This call creates a char device node called C<path> with mode C<mode> and "
27032 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27033 "wrapper around L</mknod>."
27038 #: ../fish/guestfish-actions.pod:2932
27044 #: ../fish/guestfish-actions.pod:2934
27053 #: ../fish/guestfish-actions.pod:2938
27059 #: ../fish/guestfish-actions.pod:2940
27062 " mkswap-L label device\n"
27068 #: ../fish/guestfish-actions.pod:2948
27074 #: ../fish/guestfish-actions.pod:2950
27077 " mkswap-U uuid device\n"
27083 #: ../fish/guestfish-actions.pod:2954
27084 msgid "mkswap-file"
27089 #: ../fish/guestfish-actions.pod:2956
27092 " mkswap-file path\n"
27098 #: ../fish/guestfish-actions.pod:2960
27100 "This command just writes a swap file signature to an existing file. To "
27101 "create the file itself, use something like L</fallocate>."
27106 #: ../fish/guestfish-actions.pod:2963
27112 #: ../fish/guestfish-actions.pod:2965
27115 " modprobe modulename\n"
27121 #: ../fish/guestfish-actions.pod:2972
27127 #: ../fish/guestfish-actions.pod:2974
27130 " mount device mountpoint\n"
27136 #: ../fish/guestfish-actions.pod:2990
27138 "B<Important note:> When you use this call, the filesystem options C<sync> "
27139 "and C<noatime> are set implicitly. This was originally done because we "
27140 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27141 "very large negative performance impact and negligible effect on "
27142 "reliability. Therefore we recommend that you avoid using L</mount> in any "
27143 "code that needs performance, and instead use L</mount-options> (use an empty "
27144 "string for the first parameter if you don't want any options)."
27149 #: ../fish/guestfish-actions.pod:3000
27155 #: ../fish/guestfish-actions.pod:3002
27158 " mount-loop file mountpoint\n"
27164 #: ../fish/guestfish-actions.pod:3008
27165 msgid "mount-options"
27170 #: ../fish/guestfish-actions.pod:3010
27173 " mount-options options device mountpoint\n"
27179 #: ../fish/guestfish-actions.pod:3012
27181 "This is the same as the L</mount> command, but it allows you to set the "
27182 "mount options as for the L<mount(8)> I<-o> flag."
27187 #: ../fish/guestfish-actions.pod:3020
27193 #: ../fish/guestfish-actions.pod:3022
27196 " mount-ro device mountpoint\n"
27202 #: ../fish/guestfish-actions.pod:3024
27204 "This is the same as the L</mount> command, but it mounts the filesystem with "
27205 "the read-only (I<-o ro>) flag."
27210 #: ../fish/guestfish-actions.pod:3027
27216 #: ../fish/guestfish-actions.pod:3029
27219 " mount-vfs options vfstype device mountpoint\n"
27225 #: ../fish/guestfish-actions.pod:3031
27227 "This is the same as the L</mount> command, but it allows you to set both the "
27228 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
27233 #: ../fish/guestfish-actions.pod:3035
27234 msgid "mountpoints"
27239 #: ../fish/guestfish-actions.pod:3037
27248 #: ../fish/guestfish-actions.pod:3039
27250 "This call is similar to L</mounts>. That call returns a list of devices. "
27251 "This one returns a hash table (map) of device name to directory where the "
27252 "device is mounted."
27257 #: ../fish/guestfish-actions.pod:3043
27263 #: ../fish/guestfish-actions.pod:3045
27272 #: ../fish/guestfish-actions.pod:3052
27273 msgid "See also: L</mountpoints>"
27278 #: ../fish/guestfish-actions.pod:3054
27284 #: ../fish/guestfish-actions.pod:3056
27293 #: ../fish/guestfish-actions.pod:3061
27294 msgid "ntfs-3g-probe"
27299 #: ../fish/guestfish-actions.pod:3063
27302 " ntfs-3g-probe true|false device\n"
27308 #: ../fish/guestfish-actions.pod:3077
27314 #: ../fish/guestfish-actions.pod:3079
27317 " ntfsresize device\n"
27323 #: ../fish/guestfish-actions.pod:3094
27324 msgid "ntfsresize-size"
27329 #: ../fish/guestfish-actions.pod:3096
27332 " ntfsresize-size device size\n"
27338 #: ../fish/guestfish-actions.pod:3098
27340 "This command is the same as L</ntfsresize> except that it allows you to "
27341 "specify the new size (in bytes) explicitly."
27346 #: ../fish/guestfish-actions.pod:3101
27352 #: ../fish/guestfish-actions.pod:3103
27355 " part-add device prlogex startsect endsect\n"
27361 #: ../fish/guestfish-actions.pod:3105
27363 "This command adds a partition to C<device>. If there is no partition table "
27364 "on the device, call L</part-init> first."
27369 #: ../fish/guestfish-actions.pod:3117
27371 "Creating a partition which covers the whole disk is not so easy. Use L</"
27372 "part-disk> to do that."
27377 #: ../fish/guestfish-actions.pod:3120
27383 #: ../fish/guestfish-actions.pod:3122
27386 " part-del device partnum\n"
27392 #: ../fish/guestfish-actions.pod:3130
27398 #: ../fish/guestfish-actions.pod:3132
27401 " part-disk device parttype\n"
27407 #: ../fish/guestfish-actions.pod:3134
27409 "This command is simply a combination of L</part-init> followed by L</part-"
27410 "add> to create a single primary partition covering the whole disk."
27415 #: ../fish/guestfish-actions.pod:3138
27417 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27418 "possible values are described in L</part-init>."
27423 #: ../fish/guestfish-actions.pod:3144
27424 msgid "part-get-bootable"
27429 #: ../fish/guestfish-actions.pod:3146
27432 " part-get-bootable device partnum\n"
27438 #: ../fish/guestfish-actions.pod:3151
27439 msgid "See also L</part-set-bootable>."
27444 #: ../fish/guestfish-actions.pod:3153
27445 msgid "part-get-mbr-id"
27450 #: ../fish/guestfish-actions.pod:3155
27453 " part-get-mbr-id device partnum\n"
27459 #: ../fish/guestfish-actions.pod:3160 ../fish/guestfish-actions.pod:3298
27461 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27462 "undefined results for other partition table types (see L</part-get-"
27468 #: ../fish/guestfish-actions.pod:3164
27469 msgid "part-get-parttype"
27474 #: ../fish/guestfish-actions.pod:3166
27477 " part-get-parttype device\n"
27483 #: ../fish/guestfish-actions.pod:3171
27485 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27486 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27487 "possible, although unusual. See L</part-init> for a full list."
27492 #: ../fish/guestfish-actions.pod:3176
27498 #: ../fish/guestfish-actions.pod:3178
27501 " part-init device parttype\n"
27507 #: ../fish/guestfish-actions.pod:3184
27509 "Initially there are no partitions. Following this, you should call L</part-"
27510 "add> for each partition required."
27515 #: ../fish/guestfish-actions.pod:3247
27521 #: ../fish/guestfish-actions.pod:3249
27524 " part-list device\n"
27530 #: ../fish/guestfish-actions.pod:3264
27532 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27533 "the device's sector size, see L</blockdev-getss>."
27538 #: ../fish/guestfish-actions.pod:3277
27539 msgid "part-set-bootable"
27544 #: ../fish/guestfish-actions.pod:3279
27547 " part-set-bootable device partnum true|false\n"
27553 #: ../fish/guestfish-actions.pod:3288
27554 msgid "part-set-mbr-id"
27559 #: ../fish/guestfish-actions.pod:3290
27562 " part-set-mbr-id device partnum idbyte\n"
27568 #: ../fish/guestfish-actions.pod:3302
27569 msgid "part-set-name"
27574 #: ../fish/guestfish-actions.pod:3304
27577 " part-set-name device partnum name\n"
27583 #: ../fish/guestfish-actions.pod:3312
27584 msgid "part-to-dev"
27589 #: ../fish/guestfish-actions.pod:3314
27592 " part-to-dev partition\n"
27598 #: ../fish/guestfish-actions.pod:3320
27600 "The named partition must exist, for example as a string returned from L</"
27601 "list-partitions>."
27606 #: ../fish/guestfish-actions.pod:3323
27607 msgid "ping-daemon"
27612 #: ../fish/guestfish-actions.pod:3325
27621 #: ../fish/guestfish-actions.pod:3332
27627 #: ../fish/guestfish-actions.pod:3334
27630 " pread path count offset\n"
27636 #: ../fish/guestfish-actions.pod:3342
27637 msgid "See also L</pwrite>, L</pread-device>."
27642 #: ../fish/guestfish-actions.pod:3347
27643 msgid "pread-device"
27648 #: ../fish/guestfish-actions.pod:3349
27651 " pread-device device count offset\n"
27657 #: ../fish/guestfish-actions.pod:3357
27658 msgid "See also L</pread>."
27663 #: ../fish/guestfish-actions.pod:3362
27669 #: ../fish/guestfish-actions.pod:3364
27672 " pvcreate device\n"
27678 #: ../fish/guestfish-actions.pod:3370
27684 #: ../fish/guestfish-actions.pod:3372
27687 " pvremove device\n"
27693 #: ../fish/guestfish-actions.pod:3381
27699 #: ../fish/guestfish-actions.pod:3383
27702 " pvresize device\n"
27708 #: ../fish/guestfish-actions.pod:3388
27709 msgid "pvresize-size"
27714 #: ../fish/guestfish-actions.pod:3390
27717 " pvresize-size device size\n"
27723 #: ../fish/guestfish-actions.pod:3392
27725 "This command is the same as L</pvresize> except that it allows you to "
27726 "specify the new size (in bytes) explicitly."
27731 #: ../fish/guestfish-actions.pod:3395
27737 #: ../fish/guestfish-actions.pod:3397
27746 #: ../fish/guestfish-actions.pod:3405
27747 msgid "See also L</pvs-full>."
27752 #: ../fish/guestfish-actions.pod:3407
27758 #: ../fish/guestfish-actions.pod:3409
27767 #: ../fish/guestfish-actions.pod:3414
27773 #: ../fish/guestfish-actions.pod:3416
27782 #: ../fish/guestfish-actions.pod:3420
27788 #: ../fish/guestfish-actions.pod:3422
27791 " pwrite path content offset\n"
27797 #: ../fish/guestfish-actions.pod:3433
27798 msgid "See also L</pread>, L</pwrite-device>."
27803 #: ../fish/guestfish-actions.pod:3438
27804 msgid "pwrite-device"
27809 #: ../fish/guestfish-actions.pod:3440
27812 " pwrite-device device content offset\n"
27818 #: ../fish/guestfish-actions.pod:3450
27819 msgid "See also L</pwrite>."
27824 #: ../fish/guestfish-actions.pod:3455
27830 #: ../fish/guestfish-actions.pod:3457
27833 " read-file path\n"
27839 #: ../fish/guestfish-actions.pod:3462
27841 "Unlike L</cat>, this function can correctly handle files that contain "
27842 "embedded ASCII NUL characters. However unlike L</download>, this function "
27843 "is limited in the total size of file that can be handled."
27848 #: ../fish/guestfish-actions.pod:3470
27854 #: ../fish/guestfish-actions.pod:3472
27857 " read-lines path\n"
27863 #: ../fish/guestfish-actions.pod:3479
27865 "Note that this function cannot correctly handle binary files (specifically, "
27866 "files containing C<\\0> character which is treated as end of line). For "
27867 "those you need to use the L</read-file> function which has a more complex "
27873 #: ../fish/guestfish-actions.pod:3484
27879 #: ../fish/guestfish-actions.pod:3486
27888 #: ../fish/guestfish-actions.pod:3538
27890 "This function is primarily intended for use by programs. To get a simple "
27891 "list of names, use L</ls>. To get a printable directory for human "
27892 "consumption, use L</ll>."
27897 #: ../fish/guestfish-actions.pod:3542
27903 #: ../fish/guestfish-actions.pod:3544
27912 #: ../fish/guestfish-actions.pod:3548
27913 msgid "readlinklist"
27918 #: ../fish/guestfish-actions.pod:3550
27921 " readlinklist path 'names ...'\n"
27927 #: ../fish/guestfish-actions.pod:3574
27933 #: ../fish/guestfish-actions.pod:3576
27942 #: ../fish/guestfish-actions.pod:3581
27943 msgid "removexattr"
27948 #: ../fish/guestfish-actions.pod:3583
27951 " removexattr xattr path\n"
27957 #: ../fish/guestfish-actions.pod:3588
27958 msgid "See also: L</lremovexattr>, L<attr(5)>."
27963 #: ../fish/guestfish-actions.pod:3590
27969 #: ../fish/guestfish-actions.pod:3592
27972 " resize2fs device\n"
27978 #: ../fish/guestfish-actions.pod:3597
27980 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
27981 "before calling this command. For unknown reasons C<resize2fs> sometimes "
27982 "gives an error about this and sometimes not. In any case, it is always safe "
27983 "to call L</e2fsck-f> before calling this function."
27988 #: ../fish/guestfish-actions.pod:3603
27989 msgid "resize2fs-size"
27994 #: ../fish/guestfish-actions.pod:3605
27997 " resize2fs-size device size\n"
28003 #: ../fish/guestfish-actions.pod:3607
28005 "This command is the same as L</resize2fs> except that it allows you to "
28006 "specify the new size (in bytes) explicitly."
28011 #: ../fish/guestfish-actions.pod:3610
28017 #: ../fish/guestfish-actions.pod:3612
28026 #: ../fish/guestfish-actions.pod:3616
28032 #: ../fish/guestfish-actions.pod:3618
28041 #: ../fish/guestfish-actions.pod:3624
28047 #: ../fish/guestfish-actions.pod:3626
28056 #: ../fish/guestfish-actions.pod:3630
28057 msgid "rmmountpoint"
28062 #: ../fish/guestfish-actions.pod:3632
28065 " rmmountpoint exemptpath\n"
28071 #: ../fish/guestfish-actions.pod:3634
28073 "This calls removes a mountpoint that was previously created with L</"
28074 "mkmountpoint>. See L</mkmountpoint> for full details."
28079 #: ../fish/guestfish-actions.pod:3638
28080 msgid "scrub-device"
28085 #: ../fish/guestfish-actions.pod:3640
28088 " scrub-device device\n"
28094 #: ../fish/guestfish-actions.pod:3651
28100 #: ../fish/guestfish-actions.pod:3653
28103 " scrub-file file\n"
28109 #: ../fish/guestfish-actions.pod:3663
28110 msgid "scrub-freespace"
28115 #: ../fish/guestfish-actions.pod:3665
28118 " scrub-freespace dir\n"
28124 #: ../fish/guestfish-actions.pod:3667
28126 "This command creates the directory C<dir> and then fills it with files until "
28127 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
28128 "deletes them. The intention is to scrub any free space on the partition "
28129 "containing C<dir>."
28134 #: ../fish/guestfish-actions.pod:3676
28140 #: ../fish/guestfish-actions.pod:3678
28146 #: ../fish/guestfish-actions.pod:3680
28149 " set-append append\n"
28155 #: ../fish/guestfish-actions.pod:3691
28156 msgid "set-autosync"
28161 #: ../fish/guestfish-actions.pod:3693
28167 #: ../fish/guestfish-actions.pod:3695
28170 " set-autosync true|false\n"
28176 #: ../fish/guestfish-actions.pod:3697
28178 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
28179 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
28180 "closed (also if the program exits without closing handles)."
28185 #: ../fish/guestfish-actions.pod:3705
28191 #: ../fish/guestfish-actions.pod:3707
28197 #: ../fish/guestfish-actions.pod:3709
28200 " set-direct true|false\n"
28206 #: ../fish/guestfish-actions.pod:3715
28208 "One consequence of this is that log messages aren't caught by the library "
28209 "and handled by L</set-log-message-callback>, but go straight to stdout."
28214 #: ../fish/guestfish-actions.pod:3724
28215 msgid "set-e2label"
28220 #: ../fish/guestfish-actions.pod:3726
28223 " set-e2label device label\n"
28229 #: ../fish/guestfish-actions.pod:3732
28231 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
28232 "label on a filesystem."
28237 #: ../fish/guestfish-actions.pod:3735
28243 #: ../fish/guestfish-actions.pod:3737
28246 " set-e2uuid device uuid\n"
28252 #: ../fish/guestfish-actions.pod:3744
28254 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
28255 "UUID of a filesystem."
28260 #: ../fish/guestfish-actions.pod:3747
28261 msgid "set-memsize"
28266 #: ../fish/guestfish-actions.pod:3749
28272 #: ../fish/guestfish-actions.pod:3751
28275 " set-memsize memsize\n"
28281 #: ../fish/guestfish-actions.pod:3753
28283 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28284 "This only has any effect if called before L</launch>."
28289 #: ../fish/guestfish-actions.pod:3764
28290 msgid "set-network"
28295 #: ../fish/guestfish-actions.pod:3766
28301 #: ../fish/guestfish-actions.pod:3768
28304 " set-network true|false\n"
28310 #: ../fish/guestfish-actions.pod:3776
28312 "You must call this before calling L</launch>, otherwise it has no effect."
28317 #: ../fish/guestfish-actions.pod:3779
28323 #: ../fish/guestfish-actions.pod:3781
28329 #: ../fish/guestfish-actions.pod:3783
28332 " set-path searchpath\n"
28338 #: ../fish/guestfish-actions.pod:3792
28344 #: ../fish/guestfish-actions.pod:3794
28350 #: ../fish/guestfish-actions.pod:3796
28359 #: ../fish/guestfish-actions.pod:3816
28360 msgid "set-recovery-proc"
28365 #: ../fish/guestfish-actions.pod:3818
28366 msgid "recovery-proc"
28371 #: ../fish/guestfish-actions.pod:3820
28374 " set-recovery-proc true|false\n"
28380 #: ../fish/guestfish-actions.pod:3822
28382 "If this is called with the parameter C<false> then L</launch> does not "
28383 "create a recovery process. The purpose of the recovery process is to stop "
28384 "runaway qemu processes in the case where the main program aborts abruptly."
28389 #: ../fish/guestfish-actions.pod:3827
28391 "This only has any effect if called before L</launch>, and the default is "
28397 #: ../fish/guestfish-actions.pod:3836
28398 msgid "set-selinux"
28403 #: ../fish/guestfish-actions.pod:3838
28409 #: ../fish/guestfish-actions.pod:3840
28412 " set-selinux true|false\n"
28418 #: ../fish/guestfish-actions.pod:3851
28424 #: ../fish/guestfish-actions.pod:3853
28430 #: ../fish/guestfish-actions.pod:3855
28433 " set-trace true|false\n"
28439 #: ../fish/guestfish-actions.pod:3871
28440 msgid "set-verbose"
28445 #: ../fish/guestfish-actions.pod:3873
28451 #: ../fish/guestfish-actions.pod:3875
28454 " set-verbose true|false\n"
28460 #: ../fish/guestfish-actions.pod:3882
28466 #: ../fish/guestfish-actions.pod:3884
28469 " setcon context\n"
28475 #: ../fish/guestfish-actions.pod:3891
28481 #: ../fish/guestfish-actions.pod:3893
28484 " setxattr xattr val vallen path\n"
28490 #: ../fish/guestfish-actions.pod:3899
28491 msgid "See also: L</lsetxattr>, L<attr(5)>."
28496 #: ../fish/guestfish-actions.pod:3901
28502 #: ../fish/guestfish-actions.pod:3903
28505 " sfdisk device cyls heads sectors 'lines ...'\n"
28511 #: ../fish/guestfish-actions.pod:3925
28512 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
28517 #: ../fish/guestfish-actions.pod:3931
28523 #: ../fish/guestfish-actions.pod:3933
28526 " sfdiskM device 'lines ...'\n"
28532 #: ../fish/guestfish-actions.pod:3935
28534 "This is a simplified interface to the L</sfdisk> command, where partition "
28535 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
28536 "you don't need to specify the cyls, heads and sectors parameters which were "
28537 "rarely if ever used anyway."
28542 #: ../fish/guestfish-actions.pod:3941
28543 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
28548 #: ../fish/guestfish-actions.pod:3947
28554 #: ../fish/guestfish-actions.pod:3949
28557 " sfdisk-N device partnum cyls heads sectors line\n"
28563 #: ../fish/guestfish-actions.pod:3954
28565 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
28566 "cyls/heads/sectors parameters."
28571 #: ../fish/guestfish-actions.pod:3957
28572 msgid "See also: L</part-add>"
28577 #: ../fish/guestfish-actions.pod:3962
28578 msgid "sfdisk-disk-geometry"
28583 #: ../fish/guestfish-actions.pod:3964
28586 " sfdisk-disk-geometry device\n"
28592 #: ../fish/guestfish-actions.pod:3966
28594 "This displays the disk geometry of C<device> read from the partition table. "
28595 "Especially in the case where the underlying block device has been resized, "
28596 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
28597 "kernel-geometry>)."
28602 #: ../fish/guestfish-actions.pod:3974
28603 msgid "sfdisk-kernel-geometry"
28608 #: ../fish/guestfish-actions.pod:3976
28611 " sfdisk-kernel-geometry device\n"
28617 #: ../fish/guestfish-actions.pod:3983
28623 #: ../fish/guestfish-actions.pod:3985
28626 " sfdisk-l device\n"
28632 #: ../fish/guestfish-actions.pod:3991
28633 msgid "See also: L</part-list>"
28638 #: ../fish/guestfish-actions.pod:3993
28644 #: ../fish/guestfish-actions.pod:3995
28653 #: ../fish/guestfish-actions.pod:4000
28654 msgid "This is like L</command>, but passes the command to:"
28659 #: ../fish/guestfish-actions.pod:4008
28660 msgid "All the provisos about L</command> apply to this call."
28665 #: ../fish/guestfish-actions.pod:4010
28671 #: ../fish/guestfish-actions.pod:4012
28674 " sh-lines command\n"
28680 #: ../fish/guestfish-actions.pod:4014
28681 msgid "This is the same as L</sh>, but splits the result into a list of lines."
28686 #: ../fish/guestfish-actions.pod:4017
28687 msgid "See also: L</command-lines>"
28692 #: ../fish/guestfish-actions.pod:4019
28698 #: ../fish/guestfish-actions.pod:4021
28707 #: ../fish/guestfish-actions.pod:4025
28713 #: ../fish/guestfish-actions.pod:4027
28722 #: ../fish/guestfish-actions.pod:4033
28728 #: ../fish/guestfish-actions.pod:4035
28737 #: ../fish/guestfish-actions.pod:4043
28743 #: ../fish/guestfish-actions.pod:4045
28752 #: ../fish/guestfish-actions.pod:4053
28758 #: ../fish/guestfish-actions.pod:4055
28761 " strings-e encoding path\n"
28767 #: ../fish/guestfish-actions.pod:4057
28769 "This is like the L</strings> command, but allows you to specify the encoding "
28770 "of strings that are looked for in the source file C<path>."
28775 #: ../fish/guestfish-actions.pod:4067
28777 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28778 "ISO-8859-X (this is what L</strings> uses)."
28783 #: ../fish/guestfish-actions.pod:4099
28784 msgid "swapoff-device"
28789 #: ../fish/guestfish-actions.pod:4101
28792 " swapoff-device device\n"
28798 #: ../fish/guestfish-actions.pod:4103
28800 "This command disables the libguestfs appliance swap device or partition "
28801 "named C<device>. See L</swapon-device>."
28806 #: ../fish/guestfish-actions.pod:4107
28807 msgid "swapoff-file"
28812 #: ../fish/guestfish-actions.pod:4109
28815 " swapoff-file file\n"
28821 #: ../fish/guestfish-actions.pod:4113
28822 msgid "swapoff-label"
28827 #: ../fish/guestfish-actions.pod:4115
28830 " swapoff-label label\n"
28836 #: ../fish/guestfish-actions.pod:4120
28837 msgid "swapoff-uuid"
28842 #: ../fish/guestfish-actions.pod:4122
28845 " swapoff-uuid uuid\n"
28851 #: ../fish/guestfish-actions.pod:4127
28852 msgid "swapon-device"
28857 #: ../fish/guestfish-actions.pod:4129
28860 " swapon-device device\n"
28866 #: ../fish/guestfish-actions.pod:4131
28868 "This command enables the libguestfs appliance to use the swap device or "
28869 "partition named C<device>. The increased memory is made available for all "
28870 "commands, for example those run using L</command> or L</sh>."
28875 #: ../fish/guestfish-actions.pod:4143
28876 msgid "swapon-file"
28881 #: ../fish/guestfish-actions.pod:4145
28884 " swapon-file file\n"
28890 #: ../fish/guestfish-actions.pod:4147
28892 "This command enables swap to a file. See L</swapon-device> for other notes."
28897 #: ../fish/guestfish-actions.pod:4150
28898 msgid "swapon-label"
28903 #: ../fish/guestfish-actions.pod:4152
28906 " swapon-label label\n"
28912 #: ../fish/guestfish-actions.pod:4154
28914 "This command enables swap to a labeled swap partition. See L</swapon-"
28915 "device> for other notes."
28920 #: ../fish/guestfish-actions.pod:4157
28921 msgid "swapon-uuid"
28926 #: ../fish/guestfish-actions.pod:4159
28929 " swapon-uuid uuid\n"
28935 #: ../fish/guestfish-actions.pod:4161
28937 "This command enables swap to a swap partition with the given UUID. See L</"
28938 "swapon-device> for other notes."
28943 #: ../fish/guestfish-actions.pod:4164
28949 #: ../fish/guestfish-actions.pod:4166
28958 #: ../fish/guestfish-actions.pod:4174
28964 #: ../fish/guestfish-actions.pod:4176
28973 #: ../fish/guestfish-actions.pod:4184
28979 #: ../fish/guestfish-actions.pod:4186
28982 " tail-n nrlines path\n"
28988 #: ../fish/guestfish-actions.pod:4199
28994 #: ../fish/guestfish-actions.pod:4201
28997 " tar-in (tarfile|-) directory\n"
29003 #: ../fish/guestfish-actions.pod:4206
29004 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
29009 #: ../fish/guestfish-actions.pod:4211
29015 #: ../fish/guestfish-actions.pod:4213
29018 " tar-out directory (tarfile|-)\n"
29024 #: ../fish/guestfish-actions.pod:4218
29025 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
29030 #: ../fish/guestfish-actions.pod:4223
29036 #: ../fish/guestfish-actions.pod:4225
29039 " tgz-in (tarball|-) directory\n"
29045 #: ../fish/guestfish-actions.pod:4230
29046 msgid "To upload an uncompressed tarball, use L</tar-in>."
29051 #: ../fish/guestfish-actions.pod:4234
29057 #: ../fish/guestfish-actions.pod:4236
29060 " tgz-out directory (tarball|-)\n"
29066 #: ../fish/guestfish-actions.pod:4241
29067 msgid "To download an uncompressed tarball, use L</tar-out>."
29072 #: ../fish/guestfish-actions.pod:4245
29078 #: ../fish/guestfish-actions.pod:4247
29087 #: ../fish/guestfish-actions.pod:4256
29093 #: ../fish/guestfish-actions.pod:4258
29102 #: ../fish/guestfish-actions.pod:4263
29103 msgid "truncate-size"
29108 #: ../fish/guestfish-actions.pod:4265
29111 " truncate-size path size\n"
29117 #: ../fish/guestfish-actions.pod:4270
29119 "If the current file size is less than C<size> then the file is extended to "
29120 "the required size with zero bytes. This creates a sparse file (ie. disk "
29121 "blocks are not allocated for the file until you write to it). To create a "
29122 "non-sparse file of zeroes, use L</fallocate64> instead."
29127 #: ../fish/guestfish-actions.pod:4276
29133 #: ../fish/guestfish-actions.pod:4278
29136 " tune2fs-l device\n"
29142 #: ../fish/guestfish-actions.pod:4288
29148 #: ../fish/guestfish-actions.pod:4290
29151 " txz-in (tarball|-) directory\n"
29157 #: ../fish/guestfish-actions.pod:4297
29163 #: ../fish/guestfish-actions.pod:4299
29166 " txz-out directory (tarball|-)\n"
29172 #: ../fish/guestfish-actions.pod:4306
29178 #: ../fish/guestfish-actions.pod:4308
29187 #: ../fish/guestfish-actions.pod:4322
29188 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
29193 #: ../fish/guestfish-actions.pod:4327
29199 #: ../fish/guestfish-actions.pod:4329
29205 #: ../fish/guestfish-actions.pod:4331
29208 " umount pathordevice\n"
29214 #: ../fish/guestfish-actions.pod:4337
29220 #: ../fish/guestfish-actions.pod:4339
29221 msgid "unmount-all"
29226 #: ../fish/guestfish-actions.pod:4341
29235 #: ../fish/guestfish-actions.pod:4347
29241 #: ../fish/guestfish-actions.pod:4349
29244 " upload (filename|-) remotefilename\n"
29250 #: ../fish/guestfish-actions.pod:4356
29251 msgid "See also L</download>."
29256 #: ../fish/guestfish-actions.pod:4360
29257 msgid "upload-offset"
29262 #: ../fish/guestfish-actions.pod:4362
29265 " upload-offset (filename|-) remotefilename offset\n"
29271 #: ../fish/guestfish-actions.pod:4374
29273 "Note that there is no limit on the amount of data that can be uploaded with "
29274 "this call, unlike with L</pwrite>, and this call always writes the full "
29275 "amount unless an error occurs."
29280 #: ../fish/guestfish-actions.pod:4379
29281 msgid "See also L</upload>, L</pwrite>."
29286 #: ../fish/guestfish-actions.pod:4383
29292 #: ../fish/guestfish-actions.pod:4385
29295 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
29301 #: ../fish/guestfish-actions.pod:4404
29307 #: ../fish/guestfish-actions.pod:4406
29316 #: ../fish/guestfish-actions.pod:4433
29318 "I<Note:> Don't use this call to test for availability of features. In "
29319 "enterprise distributions we backport features from later versions into "
29320 "earlier versions, making this an unreliable way to test for features. Use "
29321 "L</available> instead."
29326 #: ../fish/guestfish-actions.pod:4439
29332 #: ../fish/guestfish-actions.pod:4441
29335 " vfs-label device\n"
29341 #: ../fish/guestfish-actions.pod:4448
29342 msgid "To find a filesystem from the label, use L</findfs-label>."
29347 #: ../fish/guestfish-actions.pod:4450
29353 #: ../fish/guestfish-actions.pod:4452
29356 " vfs-type device\n"
29362 #: ../fish/guestfish-actions.pod:4462
29368 #: ../fish/guestfish-actions.pod:4464
29371 " vfs-uuid device\n"
29377 #: ../fish/guestfish-actions.pod:4471
29378 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
29383 #: ../fish/guestfish-actions.pod:4473
29384 msgid "vg-activate"
29389 #: ../fish/guestfish-actions.pod:4475
29392 " vg-activate true|false 'volgroups ...'\n"
29398 #: ../fish/guestfish-actions.pod:4488
29399 msgid "vg-activate-all"
29404 #: ../fish/guestfish-actions.pod:4490
29407 " vg-activate-all true|false\n"
29413 #: ../fish/guestfish-actions.pod:4500
29419 #: ../fish/guestfish-actions.pod:4502
29422 " vgcreate volgroup 'physvols ...'\n"
29428 #: ../fish/guestfish-actions.pod:4507
29434 #: ../fish/guestfish-actions.pod:4509
29437 " vglvuuids vgname\n"
29443 #: ../fish/guestfish-actions.pod:4514
29445 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
29446 "logical volumes and volume groups."
29451 #: ../fish/guestfish-actions.pod:4517
29452 msgid "See also L</vgpvuuids>."
29457 #: ../fish/guestfish-actions.pod:4519
29463 #: ../fish/guestfish-actions.pod:4521
29466 " vgpvuuids vgname\n"
29472 #: ../fish/guestfish-actions.pod:4526
29474 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
29475 "physical volumes and volume groups."
29480 #: ../fish/guestfish-actions.pod:4529
29481 msgid "See also L</vglvuuids>."
29486 #: ../fish/guestfish-actions.pod:4531
29492 #: ../fish/guestfish-actions.pod:4533
29495 " vgremove vgname\n"
29501 #: ../fish/guestfish-actions.pod:4540
29507 #: ../fish/guestfish-actions.pod:4542
29510 " vgrename volgroup newvolgroup\n"
29516 #: ../fish/guestfish-actions.pod:4546
29522 #: ../fish/guestfish-actions.pod:4548
29531 #: ../fish/guestfish-actions.pod:4556
29532 msgid "See also L</vgs-full>."
29537 #: ../fish/guestfish-actions.pod:4558
29543 #: ../fish/guestfish-actions.pod:4560
29552 #: ../fish/guestfish-actions.pod:4565
29558 #: ../fish/guestfish-actions.pod:4567
29567 #: ../fish/guestfish-actions.pod:4572
29573 #: ../fish/guestfish-actions.pod:4574
29582 #: ../fish/guestfish-actions.pod:4578
29588 #: ../fish/guestfish-actions.pod:4580
29597 #: ../fish/guestfish-actions.pod:4585
29603 #: ../fish/guestfish-actions.pod:4587
29612 #: ../fish/guestfish-actions.pod:4592
29618 #: ../fish/guestfish-actions.pod:4594
29627 #: ../fish/guestfish-actions.pod:4599
29633 #: ../fish/guestfish-actions.pod:4601
29636 " write path content\n"
29642 #: ../fish/guestfish-actions.pod:4609
29648 #: ../fish/guestfish-actions.pod:4611
29651 " write-file path content size\n"
29657 #: ../fish/guestfish-actions.pod:4634
29663 #: ../fish/guestfish-actions.pod:4636
29666 " zegrep regex path\n"
29672 #: ../fish/guestfish-actions.pod:4644
29678 #: ../fish/guestfish-actions.pod:4646
29681 " zegrepi regex path\n"
29687 #: ../fish/guestfish-actions.pod:4654
29693 #: ../fish/guestfish-actions.pod:4656
29702 #: ../fish/guestfish-actions.pod:4664
29703 msgid "See also: L</zero-device>, L</scrub-device>."
29708 #: ../fish/guestfish-actions.pod:4666
29709 msgid "zero-device"
29714 #: ../fish/guestfish-actions.pod:4668
29717 " zero-device device\n"
29723 #: ../fish/guestfish-actions.pod:4670
29725 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
29726 "which just zeroes the first few blocks of a device."
29731 #: ../fish/guestfish-actions.pod:4677
29737 #: ../fish/guestfish-actions.pod:4679
29740 " zerofree device\n"
29746 #: ../fish/guestfish-actions.pod:4692
29752 #: ../fish/guestfish-actions.pod:4694
29755 " zfgrep pattern path\n"
29761 #: ../fish/guestfish-actions.pod:4702
29767 #: ../fish/guestfish-actions.pod:4704
29770 " zfgrepi pattern path\n"
29776 #: ../fish/guestfish-actions.pod:4712
29782 #: ../fish/guestfish-actions.pod:4714
29785 " zfile meth path\n"
29791 #: ../fish/guestfish-actions.pod:4721
29793 "Since 1.0.63, use L</file> instead which can now process compressed files."
29798 #: ../fish/guestfish-actions.pod:4731
29804 #: ../fish/guestfish-actions.pod:4733
29807 " zgrep regex path\n"
29813 #: ../fish/guestfish-actions.pod:4741
29819 #: ../fish/guestfish-actions.pod:4743
29822 " zgrepi regex path\n"
29828 #: ../fish/guestfish-commands.pod:1
29834 #: ../fish/guestfish-commands.pod:3
29840 #: ../fish/guestfish-commands.pod:5
29843 " alloc filename size\n"
29849 #: ../fish/guestfish-commands.pod:7
29851 "This creates an empty (zeroed) file of the given size, and then adds so it "
29852 "can be further examined."
29857 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
29858 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
29863 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
29864 msgid "Size can be specified using standard suffixes, eg. C<1M>."
29869 #: ../fish/guestfish-commands.pod:14
29871 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
29872 "image, see L</PREPARED DISK IMAGES>."
29877 #: ../fish/guestfish-commands.pod:17
29883 #: ../fish/guestfish-commands.pod:19
29886 " copy-in local [local ...] /remotedir\n"
29892 #: ../fish/guestfish-commands.pod:21
29894 "C<copy-in> copies local files or directories recursively into the disk "
29895 "image, placing them in the directory called C</remotedir> (which must "
29896 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
29897 "other commands as necessary."
29902 #: ../fish/guestfish-commands.pod:26
29904 "Multiple local files and directories can be specified, but the last "
29905 "parameter must always be a remote directory. Wildcards cannot be used."
29910 #: ../fish/guestfish-commands.pod:30
29916 #: ../fish/guestfish-commands.pod:32
29919 " copy-out remote [remote ...] localdir\n"
29925 #: ../fish/guestfish-commands.pod:34
29927 "C<copy-out> copies remote files or directories recursively out of the disk "
29928 "image, placing them on the host disk in a local directory called C<localdir> "
29929 "(which must exist). This guestfish meta-command turns into a sequence of L</"
29930 "download>, L</tar-out> and other commands as necessary."
29935 #: ../fish/guestfish-commands.pod:40
29937 "Multiple remote files and directories can be specified, but the last "
29938 "parameter must always be a local directory. To download to the current "
29939 "directory, use C<.> as in:"
29944 #: ../fish/guestfish-commands.pod:44
29947 " copy-out /home .\n"
29953 #: ../fish/guestfish-commands.pod:46
29955 "Wildcards cannot be used in the ordinary command, but you can use them with "
29956 "the help of L</glob> like this:"
29961 #: ../fish/guestfish-commands.pod:49
29964 " glob copy-out /home/* .\n"
29970 #: ../fish/guestfish-commands.pod:51
29976 #: ../fish/guestfish-commands.pod:53
29979 " echo [params ...]\n"
29985 #: ../fish/guestfish-commands.pod:55
29986 msgid "This echos the parameters to the terminal."
29991 #: ../fish/guestfish-commands.pod:57
29997 #: ../fish/guestfish-commands.pod:59
30003 #: ../fish/guestfish-commands.pod:61
30009 #: ../fish/guestfish-commands.pod:63
30018 #: ../fish/guestfish-commands.pod:65
30020 "This is used to edit a file. It downloads the file, edits it locally using "
30021 "your editor, then uploads the result."
30026 #: ../fish/guestfish-commands.pod:68
30028 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
30029 "or C<emacs> you will get those corresponding editors."
30034 #: ../fish/guestfish-commands.pod:72
30040 #: ../fish/guestfish-commands.pod:74
30043 " glob command args...\n"
30049 #: ../fish/guestfish-commands.pod:76
30051 "Expand wildcards in any paths in the args list, and run C<command> "
30052 "repeatedly on each matching path."
30057 #: ../fish/guestfish-commands.pod:79
30058 msgid "See L</WILDCARDS AND GLOBBING>."
30063 #: ../fish/guestfish-commands.pod:81
30069 #: ../fish/guestfish-commands.pod:83
30072 " hexedit <filename|device>\n"
30073 " hexedit <filename|device> <max>\n"
30074 " hexedit <filename|device> <start> <max>\n"
30080 #: ../fish/guestfish-commands.pod:87
30082 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
30088 #: ../fish/guestfish-commands.pod:90
30090 "This command works by downloading potentially the whole file or device, "
30091 "editing it locally, then uploading it. If the file or device is large, you "
30092 "have to specify which part you wish to edit by using C<max> and/or C<start> "
30093 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
30094 "usual modifiers allowed such as C<1M> (1 megabyte)."
30099 #: ../fish/guestfish-commands.pod:97
30100 msgid "For example to edit the first few sectors of a disk you might do:"
30105 #: ../fish/guestfish-commands.pod:100
30108 " hexedit /dev/sda 1M\n"
30114 #: ../fish/guestfish-commands.pod:102
30116 "which would allow you to edit anywhere within the first megabyte of the disk."
30121 #: ../fish/guestfish-commands.pod:105
30122 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
30127 #: ../fish/guestfish-commands.pod:107
30130 " hexedit /dev/sda1 0x400 0x400\n"
30136 #: ../fish/guestfish-commands.pod:109
30137 msgid "(assuming the superblock is in the standard location)."
30142 #: ../fish/guestfish-commands.pod:111
30144 "This command requires the external L<hexedit(1)> program. You can specify "
30145 "another program to use by setting the C<HEXEDITOR> environment variable."
30150 #: ../fish/guestfish-commands.pod:115
30151 msgid "See also L</hexdump>."
30156 #: ../fish/guestfish-commands.pod:117
30162 #: ../fish/guestfish-commands.pod:119
30171 #: ../fish/guestfish-commands.pod:121
30173 "Change the local directory, ie. the current directory of guestfish itself."
30178 #: ../fish/guestfish-commands.pod:124
30179 msgid "Note that C<!cd> won't do what you might expect."
30184 #: ../fish/guestfish-commands.pod:126
30190 #: ../fish/guestfish-commands.pod:128
30196 #: ../fish/guestfish-commands.pod:130
30205 #: ../fish/guestfish-commands.pod:132
30206 msgid "Opens the manual page for guestfish."
30211 #: ../fish/guestfish-commands.pod:134
30217 #: ../fish/guestfish-commands.pod:136
30223 #: ../fish/guestfish-commands.pod:138
30232 #: ../fish/guestfish-commands.pod:140
30241 #: ../fish/guestfish-commands.pod:142
30242 msgid "This is used to view a file."
30247 #: ../fish/guestfish-commands.pod:144
30249 "The default viewer is C<$PAGER>. However if you use the alternate command "
30250 "C<less> you will get the C<less> command specifically."
30255 #: ../fish/guestfish-commands.pod:147
30261 #: ../fish/guestfish-commands.pod:149
30270 #: ../fish/guestfish-commands.pod:151
30272 "Close and reopen the libguestfs handle. It is not necessary to use this "
30273 "normally, because the handle is closed properly when guestfish exits. "
30274 "However this is occasionally useful for testing."
30279 #: ../fish/guestfish-commands.pod:155
30285 #: ../fish/guestfish-commands.pod:157
30288 " sparse filename size\n"
30294 #: ../fish/guestfish-commands.pod:159
30296 "This creates an empty sparse file of the given size, and then adds so it can "
30297 "be further examined."
30302 #: ../fish/guestfish-commands.pod:162
30304 "In all respects it works the same as the L</alloc> command, except that the "
30305 "image file is allocated sparsely, which means that disk blocks are not "
30306 "assigned to the file until they are needed. Sparse disk files only use "
30307 "space when written to, but they are slower and there is a danger you could "
30308 "run out of real disk space during a write operation."
30313 #: ../fish/guestfish-commands.pod:172
30319 #: ../fish/guestfish-commands.pod:174
30328 #: ../fish/guestfish-commands.pod:176
30330 "This command returns a list of the optional groups known to the daemon, and "
30331 "indicates which ones are supported by this build of the libguestfs appliance."
30336 #: ../fish/guestfish-commands.pod:180
30337 msgid "See also L<guestfs(3)/AVAILABILITY>."
30342 #: ../fish/guestfish-commands.pod:182
30348 #: ../fish/guestfish-commands.pod:184
30351 " time command args...\n"
30357 #: ../fish/guestfish-commands.pod:186
30359 "Run the command as usual, but print the elapsed time afterwards. This can "
30360 "be useful for benchmarking operations."
30365 #: ../test-tool/libguestfs-test-tool.pod:5
30366 msgid "libguestfs-test-tool - End user tests for libguestfs"
30371 #: ../test-tool/libguestfs-test-tool.pod:9
30374 " libguestfs-test-tool [--options]\n"
30380 #: ../test-tool/libguestfs-test-tool.pod:13
30382 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
30383 "and developers, to allow them to check basic libguestfs functionality is "
30384 "working. This is needed because libguestfs occasionally breaks for reasons "
30385 "beyond our control: usually because of changes in the underlying qemu or "
30386 "kernel packages, or the host environment."
30391 #: ../test-tool/libguestfs-test-tool.pod:20
30392 msgid "If you suspect a problem in libguestfs, then just run:"
30397 #: ../test-tool/libguestfs-test-tool.pod:22
30400 " libguestfs-test-tool\n"
30406 #: ../test-tool/libguestfs-test-tool.pod:24
30407 msgid "It will print lots of diagnostic messages."
30412 #: ../test-tool/libguestfs-test-tool.pod:26
30413 msgid "If it runs to completion successfully, you will see this near the end:"
30418 #: ../test-tool/libguestfs-test-tool.pod:28
30421 " ===== TEST FINISHED OK =====\n"
30427 #: ../test-tool/libguestfs-test-tool.pod:30
30428 msgid "and the test tool will exit with code 0."
30433 #: ../test-tool/libguestfs-test-tool.pod:32
30435 "If it fails (and/or exits with non-zero error code), please paste the "
30436 "B<complete, unedited> output of the test tool into a bug report. More "
30437 "information about reporting bugs can be found on the L<http://libguestfs.org/"
30443 #: ../test-tool/libguestfs-test-tool.pod:41
30449 #: ../test-tool/libguestfs-test-tool.pod:43
30450 msgid "Display short usage information and exit."
30455 #: ../test-tool/libguestfs-test-tool.pod:45
30456 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
30461 #: ../test-tool/libguestfs-test-tool.pod:47
30463 "Pass an alternate name for the helper program. libguestfs-test-tool will "
30464 "normally look in the C<$libexec> directory that was configured when the tool "
30470 #: ../test-tool/libguestfs-test-tool.pod:51
30471 msgid "I<--qemu qemu_binary>"
30476 #: ../test-tool/libguestfs-test-tool.pod:53
30478 "If you have downloaded another qemu binary, point this option at the full "
30479 "path of the binary to try it."
30484 #: ../test-tool/libguestfs-test-tool.pod:56
30485 msgid "I<--qemudir qemu_source_dir>"
30490 #: ../test-tool/libguestfs-test-tool.pod:58
30492 "If you have compiled qemu from source, point this option at the source "
30493 "directory to try it."
30498 #: ../test-tool/libguestfs-test-tool.pod:61
30499 msgid "I<--timeout N>"
30504 #: ../test-tool/libguestfs-test-tool.pod:63
30506 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
30507 "does not usually need to be adjusted unless your machine is very slow."
30512 #: ../test-tool/libguestfs-test-tool.pod:69
30513 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
30518 #: ../test-tool/libguestfs-test-tool.pod:71
30520 "If you have compiled another version of qemu from source and would like to "
30521 "try that, then you can use the I<--qemudir> option to point to the qemu "
30522 "source directory."
30527 #: ../test-tool/libguestfs-test-tool.pod:75
30529 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
30530 "option to point to the binary."
30535 #: ../test-tool/libguestfs-test-tool.pod:78
30537 "When using an alternate qemu with libguestfs, usually you would need to "
30538 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
30539 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
30540 "use either of the I<--qemudir> or I<--qemu> options."
30545 #: ../test-tool/libguestfs-test-tool.pod:85
30547 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
30548 "I<1> if there was an error."
30553 #: ../test-tool/libguestfs-test-tool.pod:92
30554 msgid "/usr/libexec/libguestfs-test-tool-helper"
30559 #: ../test-tool/libguestfs-test-tool.pod:94
30561 "This helper program is run inside the appliance and provides additional "
30567 #: ../test-tool/libguestfs-test-tool.pod:97
30568 msgid "/usr/bin/mkisofs"
30573 #: ../test-tool/libguestfs-test-tool.pod:99
30575 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
30576 "which is used as part of the tests."
30581 #: ../test-tool/libguestfs-test-tool.pod:106
30583 "For the full list of environment variables which may affect libguestfs, "
30584 "please see the L<guestfs(3)> manual page."
30589 #: ../test-tool/libguestfs-test-tool.pod:111
30590 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
30595 #: ../test-tool/libguestfs-test-tool.pod:121
30596 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
30601 #: ../fuse/guestmount.pod:5
30603 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
30608 #: ../fuse/guestmount.pod:9
30611 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
30617 #: ../fuse/guestmount.pod:11
30620 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
30626 #: ../fuse/guestmount.pod:13
30629 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
30635 #: ../fuse/guestmount.pod:17
30637 "You must I<not> use C<guestmount> in read-write mode on live virtual "
30638 "machines. If you do this, you risk disk corruption in the VM."
30643 #: ../fuse/guestmount.pod:22
30645 "The guestmount program can be used to mount virtual machine filesystems and "
30646 "other disk images on the host. It uses libguestfs for access to the guest "
30647 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
30648 "a mountable device."
30653 #: ../fuse/guestmount.pod:27
30655 "Along with other options, you have to give at least one device (I<-a> "
30656 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
30657 "option) or use the I<-i> inspection option. How this works is better "
30658 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
30664 #: ../fuse/guestmount.pod:33
30666 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
30667 "by you, and the filesystem will not be visible to any other users unless you "
30668 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
30669 "the filesystem, use the C<fusermount -u> command."
30674 #: ../fuse/guestmount.pod:41
30676 "For a typical Windows guest which has its main filesystem on the first "
30682 #: ../fuse/guestmount.pod:44
30685 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
30691 #: ../fuse/guestmount.pod:46
30693 "For a typical Linux guest which has a /boot filesystem on the first "
30694 "partition, and the root filesystem on a logical volume:"
30699 #: ../fuse/guestmount.pod:49
30702 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
30708 #: ../fuse/guestmount.pod:51
30709 msgid "To get libguestfs to detect guest mountpoints for you:"
30714 #: ../fuse/guestmount.pod:53
30717 " guestmount -a guest.img -i --ro /mnt\n"
30723 #: ../fuse/guestmount.pod:55
30724 msgid "For a libvirt guest called \"Guest\" you could do:"
30729 #: ../fuse/guestmount.pod:57
30732 " guestmount -d Guest -i --ro /mnt\n"
30738 #: ../fuse/guestmount.pod:59
30740 "If you don't know what filesystems are contained in a guest or disk image, "
30741 "use L<virt-filesystems(1)> first:"
30746 #: ../fuse/guestmount.pod:62
30749 " virt-filesystems MyGuest\n"
30755 #: ../fuse/guestmount.pod:64
30757 "If you want to trace the libguestfs calls but without excessive debugging "
30758 "information, we recommend:"
30763 #: ../fuse/guestmount.pod:67
30766 " guestmount [...] --trace /mnt\n"
30772 #: ../fuse/guestmount.pod:69
30773 msgid "If you want to debug the program, we recommend:"
30778 #: ../fuse/guestmount.pod:71
30781 " guestmount [...] --trace --verbose /mnt\n"
30787 #: ../fuse/guestmount.pod:77
30788 msgid "B<-a image> | B<--add image>"
30793 #: ../fuse/guestmount.pod:79
30794 msgid "Add a block device or virtual machine image."
30799 #: ../fuse/guestmount.pod:84
30800 msgid "B<-c URI> | B<--connect URI>"
30805 #: ../fuse/guestmount.pod:90
30806 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
30811 #: ../fuse/guestmount.pod:96
30812 msgid "B<--dir-cache-timeout N>"
30817 #: ../fuse/guestmount.pod:98
30819 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
30820 "seconds. The readdir cache [actually, there are several semi-independent "
30821 "caches] is populated after a readdir(2) call with the stat and extended "
30822 "attributes of the files in the directory, in anticipation that they will be "
30823 "requested soon after."
30828 #: ../fuse/guestmount.pod:104
30830 "There is also a different attribute cache implemented by FUSE (see the FUSE "
30831 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
30832 "requests, only cache existing ones."
30837 #: ../fuse/guestmount.pod:115
30838 msgid "B<--format=raw|qcow2|..> | B<--format>"
30843 #: ../fuse/guestmount.pod:122
30845 "If you have untrusted raw-format guest disk images, you should use this "
30846 "option to specify the disk format. This avoids a possible security problem "
30847 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
30848 "guestfs_add_drive_opts>."
30853 #: ../fuse/guestmount.pod:127
30854 msgid "B<--fuse-help>"
30859 #: ../fuse/guestmount.pod:129
30860 msgid "Display help on special FUSE options (see I<-o> below)."
30865 #: ../fuse/guestmount.pod:133
30866 msgid "Display brief help and exit."
30871 #: ../fuse/guestmount.pod:135
30872 msgid "B<-i> | B<--inspector>"
30877 #: ../fuse/guestmount.pod:146
30878 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
30883 #: ../fuse/guestmount.pod:148
30885 "Mount the named partition or logical volume on the given mountpoint B<in the "
30886 "guest> (this has nothing to do with mountpoints in the host)."
30891 #: ../fuse/guestmount.pod:151
30893 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
30894 "something on C</>."
30899 #: ../fuse/guestmount.pod:154
30900 msgid "B<-n> | B<--no-sync>"
30905 #: ../fuse/guestmount.pod:156
30907 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
30908 "unmounted. If you specify this option, then we don't attempt to sync the "
30909 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
30914 #: ../fuse/guestmount.pod:161
30915 msgid "B<-o option> | B<--option option>"
30920 #: ../fuse/guestmount.pod:163
30921 msgid "Pass extra options to FUSE."
30926 #: ../fuse/guestmount.pod:165
30928 "To get a list of all the extra options supported by FUSE, use the command "
30929 "below. Note that only the FUSE I<-o> options can be passed, and only some "
30930 "of them are a good idea."
30935 #: ../fuse/guestmount.pod:169
30938 " guestmount --fuse-help\n"
30944 #: ../fuse/guestmount.pod:171
30945 msgid "Some potentially useful FUSE options:"
30950 #: ../fuse/guestmount.pod:175
30951 msgid "B<-o allow_other>"
30956 #: ../fuse/guestmount.pod:177
30957 msgid "Allow other users to see the filesystem."
30962 #: ../fuse/guestmount.pod:179
30963 msgid "B<-o attr_timeout=N>"
30968 #: ../fuse/guestmount.pod:181
30969 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
30974 #: ../fuse/guestmount.pod:183
30975 msgid "B<-o kernel_cache>"
30980 #: ../fuse/guestmount.pod:185
30982 "Allow the kernel to cache files (reduces the number of reads that have to go "
30983 "through the L<guestfs(3)> API). This is generally a good idea if you can "
30984 "afford the extra memory usage."
30989 #: ../fuse/guestmount.pod:189
30990 msgid "B<-o uid=N> B<-o gid=N>"
30995 #: ../fuse/guestmount.pod:191
30997 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
30998 "the chosen values."
31003 #: ../fuse/guestmount.pod:196
31004 msgid "B<-r> | B<--ro>"
31009 #: ../fuse/guestmount.pod:198
31011 "Add devices and mount everything read-only. Also disallow writes and make "
31012 "the disk appear read-only to FUSE."
31017 #: ../fuse/guestmount.pod:201
31019 "This is highly recommended if you are not going to edit the guest disk. If "
31020 "the guest is running and this option is I<not> supplied, then there is a "
31021 "strong risk of disk corruption in the guest. We try to prevent this from "
31022 "happening, but it is not always possible."
31027 #: ../fuse/guestmount.pod:206
31028 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
31033 #: ../fuse/guestmount.pod:210
31034 msgid "Enable SELinux support for the guest."
31039 #: ../fuse/guestmount.pod:212
31040 msgid "B<-v> | B<--verbose>"
31045 #: ../fuse/guestmount.pod:214
31046 msgid "Enable verbose messages from underlying libguestfs."
31051 #: ../fuse/guestmount.pod:216
31052 msgid "B<-V> | B<--version>"
31057 #: ../fuse/guestmount.pod:218
31058 msgid "Display the program version and exit."
31063 #: ../fuse/guestmount.pod:220
31064 msgid "B<-w> | B<--rw>"
31069 #: ../fuse/guestmount.pod:222
31071 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
31072 "FOR READ AND WRITE>."
31077 #: ../fuse/guestmount.pod:225
31078 msgid "B<-x> | B<--trace>"
31083 #: ../fuse/guestmount.pod:227
31084 msgid "Trace libguestfs calls and entry into each FUSE function."
31089 #: ../fuse/guestmount.pod:229
31090 msgid "This also stops the daemon from forking into the background."
31095 #: ../fuse/guestmount.pod:235
31097 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
31098 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
31103 #: ../tools/virt-edit.pl:34
31104 msgid "virt-edit - Edit a file in a virtual machine"
31108 #: ../tools/virt-edit.pl:38
31111 " virt-edit [--options] domname file\n"
31116 #: ../tools/virt-edit.pl:40
31119 " virt-edit [--options] disk.img [disk.img ...] file\n"
31124 #: ../tools/virt-edit.pl:42
31127 " virt-edit [domname|disk.img] file -e 'expr'\n"
31132 #: ../tools/virt-edit.pl:46
31134 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
31135 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
31136 "doing this, but doesn't catch all cases."
31140 #: ../tools/virt-edit.pl:52
31142 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
31143 "the named virtual machine (or disk image)."
31147 #: ../tools/virt-edit.pl:55
31148 msgid "If you want to just view a file, use L<virt-cat(1)>."
31152 #: ../tools/virt-edit.pl:57
31154 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
31155 "USING GUESTFISH> below)."
31159 #: ../tools/virt-edit.pl:60
31161 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
31162 "files. L<guestfish(1)> can do that and much more."
31166 #: ../tools/virt-edit.pl:65
31167 msgid "Edit the named files interactively:"
31171 #: ../tools/virt-edit.pl:67
31174 " virt-edit mydomain /boot/grub/grub.conf\n"
31179 #: ../tools/virt-edit.pl:69
31182 " virt-edit mydomain /etc/passwd\n"
31187 #: ../tools/virt-edit.pl:71
31189 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
31190 "below). To change the init default level to 5:"
31194 #: ../tools/virt-edit.pl:75
31197 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
31202 #: ../tools/virt-edit.pl:87 ../tools/virt-win-reg.pl:106
31203 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
31204 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
31205 msgid "Display brief help."
31209 #: ../tools/virt-edit.pl:95 ../tools/virt-win-reg.pl:114
31210 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
31211 #: ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171
31212 #: ../tools/virt-list-partitions.pl:72
31213 msgid "Display version number and exit."
31217 #: ../tools/virt-edit.pl:101
31218 msgid "B<--backup extension> | B<-b extension>"
31222 #: ../tools/virt-edit.pl:103
31224 "Create a backup of the original file I<in the guest disk image>. The backup "
31225 "has the original filename with C<extension> added."
31229 #: ../tools/virt-edit.pl:106
31231 "Usually the first character of C<extension> would be a dot C<.> so you would "
31236 #: ../tools/virt-edit.pl:109
31239 " virt-edit -b .orig [etc]\n"
31244 #: ../tools/virt-edit.pl:111
31245 msgid "By default, no backup file is made."
31249 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:128
31250 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
31251 #: ../tools/virt-list-partitions.pl:78
31252 msgid "B<--connect URI> | B<-c URI>"
31256 #: ../tools/virt-edit.pl:119 ../tools/virt-win-reg.pl:130
31257 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
31258 #: ../tools/virt-list-partitions.pl:80
31260 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
31261 "to the default libvirt hypervisor."
31265 #: ../tools/virt-edit.pl:122 ../tools/virt-win-reg.pl:133
31266 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
31267 #: ../tools/virt-list-partitions.pl:83
31269 "If you specify guest block devices directly, then libvirt is not used at all."
31273 #: ../tools/virt-edit.pl:129 ../tools/virt-win-reg.pl:140
31274 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
31275 #: ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
31276 msgid "B<--format> raw"
31280 #: ../tools/virt-edit.pl:131 ../tools/virt-win-reg.pl:142
31281 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
31282 #: ../tools/virt-list-partitions.pl:92
31284 "Specify the format of disk images given on the command line. If this is "
31285 "omitted then the format is autodetected from the content of the disk image."
31289 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:146
31290 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
31291 #: ../tools/virt-list-partitions.pl:96
31293 "If disk images are requested from libvirt, then this program asks libvirt "
31294 "for this information. In this case, the value of the format parameter is "
31299 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:150
31300 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
31301 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
31302 #: ../tools/virt-list-partitions.pl:100
31304 "If working with untrusted raw-format guest disk images, you should ensure "
31305 "the format is always specified."
31309 #: ../tools/virt-edit.pl:146
31310 msgid "B<--expr EXPR> | B<-e EXPR>"
31314 #: ../tools/virt-edit.pl:148
31316 "Instead of launching the external editor, non-interactively apply the Perl "
31317 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
31322 #: ../tools/virt-edit.pl:152
31324 "Be careful to properly quote the expression to prevent it from being altered "
31329 #: ../tools/virt-edit.pl:272
31330 msgid "NON-INTERACTIVE EDITING"
31334 #: ../tools/virt-edit.pl:274
31336 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
31337 "administrator can interactively edit the file."
31341 #: ../tools/virt-edit.pl:277
31343 "There are two ways also to use C<virt-edit> from scripts in order to make "
31344 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
31345 "like this, it's less error-prone to write scripts directly using the "
31346 "libguestfs API and Augeas for configuration file editing.)"
31350 #: ../tools/virt-edit.pl:283
31352 "The first method is to temporarily set C<$EDITOR> to any script or program "
31353 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
31354 "update C<tmpfile> in place however it likes."
31358 #: ../tools/virt-edit.pl:287
31360 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
31361 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
31362 "instances of C<foo> with C<bar> in a file:"
31366 #: ../tools/virt-edit.pl:291
31369 " virt-edit domname filename -e 's/foo/bar/'\n"
31374 #: ../tools/virt-edit.pl:293
31376 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
31377 "For example to delete root's password you could do:"
31381 #: ../tools/virt-edit.pl:296
31384 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
31389 #: ../tools/virt-edit.pl:298
31391 "What really happens is that the snippet is evaluated as a Perl expression "
31392 "for each line of the file. The line, including the final C<\\n>, is passed "
31393 "in C<$_> and the expression should update C<$_> or leave it unchanged."
31397 #: ../tools/virt-edit.pl:303
31399 "To delete a line, set C<$_> to the empty string. For example, to delete the "
31400 "C<apache> user account from the password file you can do:"
31404 #: ../tools/virt-edit.pl:306
31407 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
31412 #: ../tools/virt-edit.pl:308
31414 "To insert a line, prepend or append it to C<$_>. However appending lines to "
31415 "the end of the file is rather difficult this way since there is no concept "
31416 "of \"last line of the file\" - your expression just doesn't get called "
31417 "again. You might want to use the first method (setting C<$EDITOR>) if you "
31422 #: ../tools/virt-edit.pl:314
31424 "The variable C<$lineno> contains the current line number. As is "
31425 "traditional, the first line in the file is number C<1>."
31429 #: ../tools/virt-edit.pl:317
31431 "The return value from the expression is ignored, but the expression may call "
31432 "C<die> in order to abort the whole program, leaving the original file "
31437 #: ../tools/virt-edit.pl:321
31439 "Remember when matching the end of a line that C<$_> may contain the final C<"
31440 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
31441 "newline then neither of these. Thus to match or substitute some text at the "
31442 "end of a line, use this regular expression:"
31446 #: ../tools/virt-edit.pl:326
31449 " /some text(\\r?\\n)?$/\n"
31454 #: ../tools/virt-edit.pl:328
31456 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
31457 "$_> itself (since that would remove all newlines from the file):"
31461 #: ../tools/virt-edit.pl:332
31464 " my $m = $_; chomp $m; $m =~ /some text$/\n"
31469 #: ../tools/virt-edit.pl:334
31470 msgid "USING GUESTFISH"
31474 #: ../tools/virt-edit.pl:336
31476 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
31477 "C<virt-edit> doesn't work."
31481 #: ../tools/virt-edit.pl:339
31482 msgid "Using C<virt-edit> is approximately equivalent to doing:"
31486 #: ../tools/virt-edit.pl:341
31489 " guestfish --rw -i -d domname edit /file\n"
31494 #: ../tools/virt-edit.pl:343
31496 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
31497 "path to the file."
31501 #: ../tools/virt-edit.pl:346
31503 "The command above uses libguestfs's guest inspection feature and so does not "
31504 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
31505 "disk images that don't contain guests. To edit a file on a disk image "
31510 #: ../tools/virt-edit.pl:351
31513 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
31518 #: ../tools/virt-edit.pl:353
31520 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
31521 "the disk image to edit, and C</file> is the full path to the file."
31525 #: ../tools/virt-edit.pl:357
31527 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
31528 "C<write> or C<upload> instead:"
31532 #: ../tools/virt-edit.pl:360
31535 " guestfish --rw -i -d domname touch /newfile\n"
31540 #: ../tools/virt-edit.pl:362
31543 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
31548 #: ../tools/virt-edit.pl:364
31551 " guestfish --rw -i -d domname upload localfile /newfile\n"
31556 #: ../tools/virt-edit.pl:366
31558 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
31562 #: ../tools/virt-edit.pl:369
31565 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
31570 #: ../tools/virt-edit.pl:379
31575 #: ../tools/virt-edit.pl:381
31577 "If set, this string is used as the editor. It may contain arguments, eg. C<"
31582 #: ../tools/virt-edit.pl:384
31583 msgid "If not set, C<vi> is used."
31587 #: ../tools/virt-edit.pl:388 ../tools/virt-win-reg.pl:559
31588 #: ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182
31589 #: ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:532
31590 #: ../tools/virt-list-partitions.pl:250
31591 msgid "SHELL QUOTING"
31595 #: ../tools/virt-edit.pl:390 ../tools/virt-win-reg.pl:567
31596 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184
31597 #: ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:534
31598 #: ../tools/virt-list-partitions.pl:252
31600 "Libvirt guest names can contain arbitrary characters, some of which have "
31601 "meaning to the shell such as C<#> and space. You may need to quote or "
31602 "escape these characters on the command line. See the shell manual page L<sh"
31603 "(1)> for details."
31607 #: ../tools/virt-edit.pl:397
31609 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
31610 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
31615 #: ../tools/virt-edit.pl:407 ../tools/virt-win-reg.pl:598
31616 #: ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202
31617 #: ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:564
31618 #: ../tools/virt-list-partitions.pl:269
31623 #: ../tools/virt-edit.pl:409 ../tools/virt-win-reg.pl:600
31624 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204
31625 #: ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:566
31626 #: ../tools/virt-list-partitions.pl:271
31627 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
31631 #: ../tools/virt-edit.pl:413
31632 msgid "Copyright (C) 2009-2011 Red Hat Inc."
31636 #: ../tools/virt-win-reg.pl:37
31638 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
31642 #: ../tools/virt-win-reg.pl:41
31645 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
31650 #: ../tools/virt-win-reg.pl:43
31653 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
31658 #: ../tools/virt-win-reg.pl:45
31661 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
31666 #: ../tools/virt-win-reg.pl:47
31669 " virt-win-reg --merge domname [input.reg ...]\n"
31674 #: ../tools/virt-win-reg.pl:49
31677 " virt-win-reg [--options] disk.img ... # instead of domname\n"
31682 #: ../tools/virt-win-reg.pl:53
31684 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
31685 "virtual machines. If you do this, you I<will> get irreversible disk "
31686 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
31687 "but doesn't catch all cases."
31691 #: ../tools/virt-win-reg.pl:58
31693 "Modifying the Windows Registry is an inherently risky operation. The format "
31694 "is deliberately obscure and undocumented, and Registry changes can leave the "
31695 "system unbootable. Therefore when using the C<--merge> option, make sure "
31696 "you have a reliable backup first."
31700 #: ../tools/virt-win-reg.pl:65
31702 "This program can export and merge Windows Registry entries from a Windows "
31707 #: ../tools/virt-win-reg.pl:68
31709 "The first parameter is the libvirt guest name or the raw disk image of a "
31714 #: ../tools/virt-win-reg.pl:71
31716 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
31717 "exported (recursively). For example:"
31721 #: ../tools/virt-win-reg.pl:74
31724 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
31729 #: ../tools/virt-win-reg.pl:76
31731 "You can also display single values from within registry keys, for example:"
31735 #: ../tools/virt-win-reg.pl:79
31738 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
31739 " $ virt-win-reg Windows7 $cvkey ProductName\n"
31740 " Windows 7 Enterprise\n"
31745 #: ../tools/virt-win-reg.pl:83
31747 "With C<--merge>, you can merge a textual regedit file into the Windows "
31752 #: ../tools/virt-win-reg.pl:86
31755 " $ virt-win-reg --merge Windows7 changes.reg\n"
31760 #: ../tools/virt-win-reg.pl:88
31765 #: ../tools/virt-win-reg.pl:90
31767 "This program is only meant for simple access to the registry. If you want "
31768 "to do complicated things with the registry, we suggest you download the "
31769 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
31770 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
31771 "L<hivexregedit(1)>."
31775 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
31780 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
31781 msgid "Enable debugging messages."
31785 #: ../tools/virt-win-reg.pl:157
31790 #: ../tools/virt-win-reg.pl:159
31792 "In merge mode, this merges a textual regedit file into the Windows Registry "
31793 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
31794 "displays or exports Registry entries instead."
31798 #: ../tools/virt-win-reg.pl:163
31800 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
31801 "result in disk corruption. However exporting (without this flag) is always "
31806 #: ../tools/virt-win-reg.pl:171
31807 msgid "B<--encoding> UTF-16LE|ASCII"
31811 #: ../tools/virt-win-reg.pl:173
31813 "When merging (only), you may need to specify the encoding for strings to be "
31814 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
31815 "(3)/ENCODING STRINGS>."
31819 #: ../tools/virt-win-reg.pl:177
31821 "The default is to use UTF-16LE, which should work with recent versions of "
31826 #: ../tools/virt-win-reg.pl:402
31827 msgid "SUPPORTED SYSTEMS"
31831 #: ../tools/virt-win-reg.pl:404
31833 "The program currently supports Windows NT-derived guests starting with "
31834 "Windows XP through to at least Windows 7."
31838 #: ../tools/virt-win-reg.pl:407
31840 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
31841 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
31842 "and C<HKEY_USERS\\.DEFAULT>."
31846 #: ../tools/virt-win-reg.pl:411
31848 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
31853 #: ../tools/virt-win-reg.pl:414
31855 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
31860 #: ../tools/virt-win-reg.pl:417
31865 #: ../tools/virt-win-reg.pl:419
31867 "C<virt-win-reg> expects that regedit files have already been reencoded in "
31868 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
31869 "style line endings. Since Windows regedit files are often in UTF-16LE with "
31870 "Windows-style line endings, you may need to reencode the whole file before "
31871 "or after processing."
31875 #: ../tools/virt-win-reg.pl:425
31877 "To reencode a file from Windows format to Linux (before processing it with "
31878 "the C<--merge> option), you would do something like this:"
31882 #: ../tools/virt-win-reg.pl:428
31885 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
31890 #: ../tools/virt-win-reg.pl:430
31892 "To go in the opposite direction, after exporting and before sending the file "
31893 "to a Windows user, do something like this:"
31897 #: ../tools/virt-win-reg.pl:433
31900 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
31905 #: ../tools/virt-win-reg.pl:435
31906 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
31910 #: ../tools/virt-win-reg.pl:437
31912 "If you are unsure about the current encoding, use the L<file(1)> command. "
31913 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
31914 "style (CRLF) line endings, like this:"
31918 #: ../tools/virt-win-reg.pl:441
31921 " $ file software.reg\n"
31922 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
31923 " with CRLF line terminators\n"
31928 #: ../tools/virt-win-reg.pl:445
31929 msgid "This file would need conversion before you could C<--merge> it."
31933 #: ../tools/virt-win-reg.pl:447
31934 msgid "CurrentControlSet etc."
31938 #: ../tools/virt-win-reg.pl:449
31940 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
31941 "Registry at the level of the hive file, and therefore you cannot modify "
31946 #: ../tools/virt-win-reg.pl:453
31948 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
31949 "circumstances it might refer to another control set. The way to find out is "
31950 "to look at the C<HKLM\\SYSTEM\\Select> key:"
31954 #: ../tools/virt-win-reg.pl:457
31957 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
31958 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
31959 " \"Current\"=dword:00000001\n"
31960 " \"Default\"=dword:00000001\n"
31961 " \"Failed\"=dword:00000000\n"
31962 " \"LastKnownGood\"=dword:00000002\n"
31967 #: ../tools/virt-win-reg.pl:464
31968 msgid "\"Current\" is the one which Windows will choose when it boots."
31972 #: ../tools/virt-win-reg.pl:466
31974 "Similarly, other C<Current...> keys in the path may need to be replaced."
31978 #: ../tools/virt-win-reg.pl:469
31979 msgid "WINDOWS TIPS"
31983 #: ../tools/virt-win-reg.pl:471
31985 "Note that some of these tips modify the guest disk image. The guest I<must> "
31986 "be shut off, else you will get disk corruption."
31990 #: ../tools/virt-win-reg.pl:474
31991 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
31995 #: ../tools/virt-win-reg.pl:476
31997 "Prepare a DOS batch script, VBScript or executable. Upload this using "
31998 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
31999 "is uploaded into C<C:\\>:"
32003 #: ../tools/virt-win-reg.pl:480
32006 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
32011 #: ../tools/virt-win-reg.pl:482
32012 msgid "Prepare a regedit file containing the registry change:"
32016 #: ../tools/virt-win-reg.pl:484
32019 " cat > test.reg <<'EOF'\n"
32020 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
32021 " \"Test\"=\"c:\\\\test.bat\"\n"
32027 #: ../tools/virt-win-reg.pl:489
32029 "In this example we use the key C<RunOnce> which means that the script will "
32030 "run precisely once when the first user logs in. If you want it to run every "
32031 "time a user logs in, replace C<RunOnce> with C<Run>."
32035 #: ../tools/virt-win-reg.pl:493
32036 msgid "Now update the registry:"
32040 #: ../tools/virt-win-reg.pl:495
32043 " virt-win-reg --merge WindowsGuest test.reg\n"
32048 #: ../tools/virt-win-reg.pl:497
32049 msgid "INSTALLING A SERVICE"
32053 #: ../tools/virt-win-reg.pl:499
32055 "This section assumes you are familiar with Windows services, and you either "
32056 "have a program which handles the Windows Service Control Protocol directly "
32057 "or you want to run any program using a service wrapper like SrvAny or the "
32062 #: ../tools/virt-win-reg.pl:504
32064 "First upload the program and optionally the service wrapper. In this case "
32065 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
32069 #: ../tools/virt-win-reg.pl:508
32072 " guestfish -i -d WindowsGuest <<EOF\n"
32073 " upload rhsrvany.exe /rhsrvany.exe\n"
32074 " upload test.exe /test.exe\n"
32080 #: ../tools/virt-win-reg.pl:513
32082 "Prepare a regedit file containing the registry changes. In this example, "
32083 "the first registry change is needed for the service itself or the service "
32084 "wrapper (if used). The second registry change is only needed because I am "
32085 "using the RHSrvAny service wrapper."
32089 #: ../tools/virt-win-reg.pl:518
32092 " cat > service.reg <<'EOF'\n"
32093 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
32094 " \"Type\"=dword:00000010\n"
32095 " \"Start\"=dword:00000002\n"
32096 " \"ErrorControl\"=dword:00000001\n"
32097 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
32098 " \"DisplayName\"=\"RHSrvAny\"\n"
32099 " \"ObjectName\"=\"NetworkService\"\n"
32104 #: ../tools/virt-win-reg.pl:527
32107 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
32108 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
32109 " \"PWD\"=\"c:\\\\Temp\"\n"
32115 #: ../tools/virt-win-reg.pl:538
32117 "For use of C<ControlSet001> see the section above in this manual page. You "
32118 "may need to adjust this according to the control set that is in use by the "
32123 #: ../tools/virt-win-reg.pl:544
32125 "C<\"ObjectName\"> controls the privileges that the service will have. An "
32126 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
32127 "privileged account."
32131 #: ../tools/virt-win-reg.pl:550
32133 "For the meaning of the magic numbers, see this Microsoft KB article: "
32134 "L<http://support.microsoft.com/kb/103000>."
32138 #: ../tools/virt-win-reg.pl:555
32139 msgid "Update the registry:"
32143 #: ../tools/virt-win-reg.pl:557
32146 " virt-win-reg --merge WindowsGuest service.reg\n"
32151 #: ../tools/virt-win-reg.pl:561
32153 "Be careful when passing parameters containing C<\\> (backslash) in the "
32154 "shell. Usually you will have to use 'single quotes' or double backslashes "
32155 "(but not both) to protect them from the shell."
32159 #: ../tools/virt-win-reg.pl:565
32160 msgid "Paths and value names are case-insensitive."
32164 #: ../tools/virt-win-reg.pl:574
32166 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
32167 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
32168 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
32172 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
32174 "When reporting bugs, please enable debugging and capture the I<complete> "
32179 #: ../tools/virt-win-reg.pl:592
32182 " export LIBGUESTFS_DEBUG=1\n"
32183 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
32188 #: ../tools/virt-win-reg.pl:595
32190 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
32195 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510
32196 #: ../tools/virt-make-fs.pl:570
32197 msgid "Copyright (C) 2010 Red Hat Inc."
32201 #: ../tools/virt-resize.pl:42
32202 msgid "virt-resize - Resize a virtual machine disk"
32206 #: ../tools/virt-resize.pl:46
32209 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
32210 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
32211 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
32216 #: ../tools/virt-resize.pl:52
32218 "Virt-resize is a tool which can resize a virtual machine disk, making it "
32219 "larger or smaller overall, and resizing or deleting any partitions contained "
32224 #: ../tools/virt-resize.pl:56
32226 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
32227 "not> be used on live virtual machines - for consistent results, shut the "
32228 "virtual machine down before resizing it."
32232 #: ../tools/virt-resize.pl:60
32234 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
32235 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
32239 #: ../tools/virt-resize.pl:66
32241 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
32242 "fill the extra 5GB of space."
32246 #: ../tools/virt-resize.pl:69
32249 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
32250 " virt-filesystems --long -h --all -a olddisk\n"
32251 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
32252 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
32257 #: ../tools/virt-resize.pl:74
32259 "As above, but make the /boot partition 200MB bigger, while giving the "
32260 "remaining space to /dev/sda2:"
32264 #: ../tools/virt-resize.pl:77
32267 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
32272 #: ../tools/virt-resize.pl:79
32273 msgid "As above, but the output format will be uncompressed qcow2:"
32277 #: ../tools/virt-resize.pl:81
32280 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
32281 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
32286 #: ../tools/virt-resize.pl:84
32287 msgid "DETAILED USAGE"
32291 #: ../tools/virt-resize.pl:86
32292 msgid "EXPANDING A VIRTUAL MACHINE DISK"
32296 #: ../tools/virt-resize.pl:90
32297 msgid "1. Shut down the virtual machine"
32301 #: ../tools/virt-resize.pl:92
32302 msgid "2. Locate input disk image"
32306 #: ../tools/virt-resize.pl:94
32308 "Locate the input disk image (ie. the file or device on the host containing "
32309 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
32310 "dumpxml> like this to find the disk image name:"
32314 #: ../tools/virt-resize.pl:98
32317 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
32318 " Found 1 nodes:\n"
32320 " <source dev=\"/dev/vg/lv_guest\" />\n"
32325 #: ../tools/virt-resize.pl:103
32326 msgid "3. Look at current sizing"
32330 #: ../tools/virt-resize.pl:105
32331 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
32335 #: ../tools/virt-resize.pl:108
32338 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
32339 " Name Type Size Parent\n"
32340 " /dev/sda1 partition 101M /dev/sda\n"
32341 " /dev/sda2 partition 7.9G /dev/sda\n"
32342 " /dev/sda device 8.0G -\n"
32347 #: ../tools/virt-resize.pl:114
32349 "(This example is a virtual machine with an 8 GB disk which we would like to "
32350 "expand up to 10 GB)."
32354 #: ../tools/virt-resize.pl:117
32355 msgid "4. Create output disk"
32359 #: ../tools/virt-resize.pl:119
32361 "Virt-resize cannot do in-place disk modifications. You have to have space "
32362 "to store the resized output disk."
32366 #: ../tools/virt-resize.pl:122
32368 "To store the resized disk image in a file, create a file of a suitable size:"
32372 #: ../tools/virt-resize.pl:125
32375 " # rm -f outdisk\n"
32376 " # truncate -s 10G outdisk\n"
32381 #: ../tools/virt-resize.pl:128
32382 msgid "Or use L<lvcreate(1)> to create a logical volume:"
32386 #: ../tools/virt-resize.pl:130
32389 " # lvcreate -L 10G -n lv_name vg_name\n"
32394 #: ../tools/virt-resize.pl:132
32395 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
32399 #: ../tools/virt-resize.pl:134
32402 " # virsh pool-list\n"
32403 " # virsh vol-create-as poolname newvol 10G\n"
32408 #: ../tools/virt-resize.pl:137
32413 #: ../tools/virt-resize.pl:139
32415 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
32416 "file) and the output disk. The output disk is the one created in the "
32421 #: ../tools/virt-resize.pl:143
32424 " # virt-resize indisk outdisk\n"
32429 #: ../tools/virt-resize.pl:145
32431 "This command just copies disk image C<indisk> to disk image C<outdisk> "
32432 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
32433 "larger, then an extra, empty partition is created at the end of the disk "
32434 "covering the extra space. If C<outdisk> is smaller, then it will give an "
32439 #: ../tools/virt-resize.pl:151
32441 "More realistically you'd want to expand existing partitions in the disk "
32442 "image by passing extra options (for the full list see the L</OPTIONS> "
32447 #: ../tools/virt-resize.pl:155
32449 "L</--expand> is the most useful option. It expands the named partition "
32450 "within the disk to fill any extra space:"
32454 #: ../tools/virt-resize.pl:158
32457 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
32462 #: ../tools/virt-resize.pl:160
32464 "(In this case, an extra partition is I<not> created at the end of the disk, "
32465 "because there will be no unused space)."
32469 #: ../tools/virt-resize.pl:163
32471 "L</--resize> is the other commonly used option. The following would "
32472 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
32473 "rest of the available space:"
32477 #: ../tools/virt-resize.pl:167
32480 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
32481 " indisk outdisk\n"
32486 #: ../tools/virt-resize.pl:170
32488 "If the expanded partition in the image contains a filesystem or LVM PV, then "
32489 "if virt-resize knows how, it will resize the contents, the equivalent of "
32490 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
32491 ">. However virt-resize does not know how to resize some filesystems, so you "
32492 "would have to online resize them after booting the guest."
32496 #: ../tools/virt-resize.pl:177
32497 msgid "Other options are covered below."
32501 #: ../tools/virt-resize.pl:179
32506 #: ../tools/virt-resize.pl:181
32507 msgid "Thoroughly test the new disk image I<before> discarding the old one."
32511 #: ../tools/virt-resize.pl:183
32512 msgid "If you are using libvirt, edit the XML to point at the new disk:"
32516 #: ../tools/virt-resize.pl:185
32519 " # virsh edit guestname\n"
32524 #: ../tools/virt-resize.pl:187
32526 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
32527 "html#elementsDisks>"
32531 #: ../tools/virt-resize.pl:190
32532 msgid "Then start up the domain with the new, resized disk:"
32536 #: ../tools/virt-resize.pl:192
32539 " # virsh start guestname\n"
32544 #: ../tools/virt-resize.pl:194
32546 "and check that it still works. See also the L</NOTES> section below for "
32547 "additional information."
32551 #: ../tools/virt-resize.pl:197
32552 msgid "7. Resize LVs etc inside the guest"
32556 #: ../tools/virt-resize.pl:199
32557 msgid "(This can also be done offline using L<guestfish(1)>)"
32561 #: ../tools/virt-resize.pl:201
32563 "Once the guest has booted you should see the new space available, at least "
32564 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
32565 "may need to resize LVs inside PVs, and also resize filesystem types that "
32566 "virt-resize does not know how to expand."
32570 #: ../tools/virt-resize.pl:208
32571 msgid "SHRINKING A VIRTUAL MACHINE DISK"
32575 #: ../tools/virt-resize.pl:210
32577 "Shrinking is somewhat more complex than expanding, and only an overview is "
32582 #: ../tools/virt-resize.pl:213
32584 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
32585 "filesystems). The user has to shrink content before passing the disk image "
32586 "to virt-resize, and virt-resize will check that the content has been shrunk "
32591 #: ../tools/virt-resize.pl:218
32592 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
32596 #: ../tools/virt-resize.pl:220
32598 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
32599 "steps 3 and 4 above to allocate a new disk image."
32603 #: ../tools/virt-resize.pl:223
32605 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
32609 #: ../tools/virt-resize.pl:226
32610 msgid "IGNORING OR DELETING PARTITIONS"
32614 #: ../tools/virt-resize.pl:228
32616 "virt-resize also gives a convenient way to ignore or delete partitions when "
32617 "copying from the input disk to the output disk. Ignoring a partition speeds "
32618 "up the copy where you don't care about the existing contents of a "
32619 "partition. Deleting a partition removes it completely, but note that it "
32620 "also renumbers any partitions after the one which is deleted, which can "
32621 "leave some guests unbootable."
32625 #: ../tools/virt-resize.pl:235
32626 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
32630 #: ../tools/virt-resize.pl:237
32632 "If the input disk is in qcow2 format, then you may prefer that the output is "
32633 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
32634 "the fly. The output format is simply determined by the format of the empty "
32635 "output container that you provide. Thus to create qcow2 output, use:"
32639 #: ../tools/virt-resize.pl:243
32642 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
32647 #: ../tools/virt-resize.pl:245
32648 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
32652 #: ../tools/virt-resize.pl:247
32653 msgid "Similarly, to get non-sparse raw output use:"
32657 #: ../tools/virt-resize.pl:249
32660 " fallocate -l size outdisk\n"
32665 #: ../tools/virt-resize.pl:251
32667 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
32668 "dev/zero of=outdisk bs=1M count=..>)"
32672 #: ../tools/virt-resize.pl:264
32673 msgid "Display help."
32677 #: ../tools/virt-resize.pl:278
32678 msgid "B<--resize part=size>"
32682 #: ../tools/virt-resize.pl:280
32684 "Resize the named partition (expanding or shrinking it) so that it has the "
32689 #: ../tools/virt-resize.pl:283
32691 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
32692 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
32693 "Exabytes; or as a percentage of the current size; or as a relative number or "
32694 "percentage. For example:"
32698 #: ../tools/virt-resize.pl:288
32701 " --resize /dev/sda2=10G\n"
32706 #: ../tools/virt-resize.pl:290
32709 " --resize /dev/sda4=90%\n"
32714 #: ../tools/virt-resize.pl:292
32717 " --resize /dev/sda2=+1G\n"
32722 #: ../tools/virt-resize.pl:294
32725 " --resize /dev/sda2=-200M\n"
32730 #: ../tools/virt-resize.pl:296
32733 " --resize /dev/sda1=+128K\n"
32738 #: ../tools/virt-resize.pl:298
32741 " --resize /dev/sda1=+10%\n"
32746 #: ../tools/virt-resize.pl:300
32749 " --resize /dev/sda1=-10%\n"
32754 #: ../tools/virt-resize.pl:302
32756 "You can increase the size of any partition. Virt-resize will expand the "
32757 "direct content of the partition if it knows how (see C<--expand> below)."
32761 #: ../tools/virt-resize.pl:306
32763 "You can only I<decrease> the size of partitions that contain filesystems or "
32764 "PVs which have already been shrunk. Virt-resize will check this has been "
32765 "done before proceeding, or else will print an error (see also C<--resize-"
32770 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
32771 #: ../tools/virt-resize.pl:420
32772 msgid "You can give this option multiple times."
32776 #: ../tools/virt-resize.pl:317
32777 msgid "B<--resize-force part=size>"
32781 #: ../tools/virt-resize.pl:319
32783 "This is the same as C<--resize> except that it will let you decrease the "
32784 "size of any partition. Generally this means you will lose any data which "
32785 "was at the end of the partition you shrink, but you may not care about that "
32786 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
32787 "as a swap partition)."
32791 #: ../tools/virt-resize.pl:325
32792 msgid "See also the C<--ignore> option."
32796 #: ../tools/virt-resize.pl:331
32797 msgid "B<--expand part>"
32801 #: ../tools/virt-resize.pl:333
32803 "Expand the named partition so it uses up all extra space (space left over "
32804 "after any other resize changes that you request have been done)."
32808 #: ../tools/virt-resize.pl:336
32810 "If virt-resize knows how, it will expand the direct content of the "
32811 "partition. For example, if the partition is an LVM PV, it will expand the "
32812 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
32813 "content it doesn't know about alone."
32817 #: ../tools/virt-resize.pl:341
32818 msgid "Currently virt-resize can resize:"
32822 #: ../tools/virt-resize.pl:347
32824 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
32829 #: ../tools/virt-resize.pl:352
32831 "NTFS filesystems contained directly in a partition, if libguestfs was "
32832 "compiled with support for NTFS."
32836 #: ../tools/virt-resize.pl:355
32838 "The filesystem must have been shut down consistently last time it was used. "
32839 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
32840 "consistency check, so at the first boot after resizing Windows will check "
32845 #: ../tools/virt-resize.pl:362
32847 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
32848 "inside the PV, but see the C<--LV-expand> option. The user could also "
32849 "resize LVs as desired after boot."
32853 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
32854 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
32858 #: ../tools/virt-resize.pl:374
32859 msgid "B<--shrink part>"
32863 #: ../tools/virt-resize.pl:376
32865 "Shrink the named partition until the overall disk image fits in the "
32866 "destination. The named partition B<must> contain a filesystem or PV which "
32867 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
32868 "online tools). Virt-resize will check this and give an error if it has not "
32873 #: ../tools/virt-resize.pl:382
32875 "The amount by which the overall disk must be shrunk (after carrying out all "
32876 "other operations requested by the user) is called the \"deficit\". For "
32877 "example, a straight copy (assume no other operations) from a 5GB disk image "
32878 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
32879 "would give an error unless the user specified a partition to shrink and that "
32880 "partition had more than a gigabyte of free space."
32884 #: ../tools/virt-resize.pl:396
32885 msgid "B<--ignore part>"
32889 #: ../tools/virt-resize.pl:398
32891 "Ignore the named partition. Effectively this means the partition is "
32892 "allocated on the destination disk, but the content is not copied across from "
32893 "the source disk. The content of the partition will be blank (all zero "
32898 #: ../tools/virt-resize.pl:409
32899 msgid "B<--delete part>"
32903 #: ../tools/virt-resize.pl:411
32905 "Delete the named partition. It would be more accurate to describe this as "
32906 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
32907 "the original disk image is left intact."
32911 #: ../tools/virt-resize.pl:415
32913 "Note that when you delete a partition, then anything contained in the "
32914 "partition is also deleted. Furthermore, this causes any partitions that "
32915 "come after to be I<renumbered>, which can easily make your guest unbootable."
32919 #: ../tools/virt-resize.pl:426
32920 msgid "B<--LV-expand logvol>"
32924 #: ../tools/virt-resize.pl:428
32926 "This takes the logical volume and, as a final step, expands it to fill all "
32927 "the space available in its volume group. A typical usage, assuming a Linux "
32928 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
32929 "lv_root> would be:"
32933 #: ../tools/virt-resize.pl:433
32936 " virt-resize indisk outdisk \\\n"
32937 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
32942 #: ../tools/virt-resize.pl:436
32944 "This would first expand the partition (and PV), and then expand the root "
32945 "device to fill the extra space in the PV."
32949 #: ../tools/virt-resize.pl:439
32951 "The contents of the LV are also resized if virt-resize knows how to do "
32952 "that. You can stop virt-resize from trying to expand the content by using "
32953 "the option C<--no-expand-content>."
32957 #: ../tools/virt-resize.pl:443
32958 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
32962 #: ../tools/virt-resize.pl:446
32964 "You can give this option multiple times, I<but> it doesn't make sense to do "
32965 "this unless the logical volumes you specify are all in different volume "
32970 #: ../tools/virt-resize.pl:454
32971 msgid "B<--no-copy-boot-loader>"
32975 #: ../tools/virt-resize.pl:456
32977 "By default, virt-resize copies over some sectors at the start of the disk "
32978 "(up to the beginning of the first partition). Commonly these sectors "
32979 "contain the Master Boot Record (MBR) and the boot loader, and are required "
32980 "in order for the guest to boot correctly."
32984 #: ../tools/virt-resize.pl:461
32986 "If you specify this flag, then this initial copy is not done. You may need "
32987 "to reinstall the boot loader in this case."
32991 #: ../tools/virt-resize.pl:469
32992 msgid "B<--no-extra-partition>"
32996 #: ../tools/virt-resize.pl:471
32998 "By default, virt-resize creates an extra partition if there is any extra, "
32999 "unused space after all resizing has happened. Use this option to prevent "
33000 "the extra partition from being created. If you do this then the extra space "
33001 "will be inaccessible until you run fdisk, parted, or some other partitioning "
33002 "tool in the guest."
33006 #: ../tools/virt-resize.pl:477
33008 "Note that if the surplus space is smaller than 10 MB, no extra partition "
33013 #: ../tools/virt-resize.pl:484
33014 msgid "B<--no-expand-content>"
33018 #: ../tools/virt-resize.pl:486
33020 "By default, virt-resize will try to expand the direct contents of "
33021 "partitions, if it knows how (see C<--expand> option above)."
33025 #: ../tools/virt-resize.pl:489
33027 "If you give the C<--no-expand-content> option then virt-resize will not "
33032 #: ../tools/virt-resize.pl:496
33033 msgid "B<-d> | B<--debug>"
33037 #: ../tools/virt-resize.pl:504
33038 msgid "B<-n> | B<--dryrun>"
33042 #: ../tools/virt-resize.pl:506
33043 msgid "Print a summary of what would be done, but don't do anything."
33047 #: ../tools/virt-resize.pl:512
33048 msgid "B<-q> | B<--quiet>"
33052 #: ../tools/virt-resize.pl:514
33053 msgid "Don't print the summary."
33057 #: ../tools/virt-resize.pl:522
33059 "Specify the format of the input disk image. If this flag is not given then "
33060 "it is auto-detected from the image itself."
33064 #: ../tools/virt-resize.pl:528
33066 "Note that this option I<does not> affect the output format. See L</QCOW2 "
33067 "AND NON-SPARSE RAW FORMATS>."
33071 #: ../tools/virt-resize.pl:535
33072 msgid "B<--output-format> raw"
33076 #: ../tools/virt-resize.pl:537
33078 "Specify the format of the output disk image. If this flag is not given then "
33079 "it is auto-detected from the image itself."
33083 #: ../tools/virt-resize.pl:543
33085 "Note that you still need to create the output disk with the right format. "
33086 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
33090 #: ../tools/virt-resize.pl:1419
33095 #: ../tools/virt-resize.pl:1421
33096 msgid "\"Partition 1 does not end on cylinder boundary.\""
33100 #: ../tools/virt-resize.pl:1423
33102 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
33103 "means the partitions will not be aligned to the ancient CHS geometry. "
33104 "However CHS geometry is meaningless for disks manufactured since the early "
33105 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
33106 "cylinders is not required by any modern operating system."
33110 #: ../tools/virt-resize.pl:1430
33111 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
33115 #: ../tools/virt-resize.pl:1432
33117 "In Windows Vista and later versions, Microsoft switched to using a separate "
33118 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
33119 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
33120 "the boot partition. Doing so seems to break the guest completely. However "
33121 "expanding the second partition (ie. C: drive) should work."
33125 #: ../tools/virt-resize.pl:1439
33127 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
33128 "NTFS partitions have been expanded. This is just a safety check and (unless "
33129 "it find errors) is nothing to worry about."
33133 #: ../tools/virt-resize.pl:1443
33134 msgid "GUEST BOOT STUCK AT \"GRUB\""
33138 #: ../tools/virt-resize.pl:1445
33140 "If a Linux guest does not boot after resizing, and the boot is stuck after "
33141 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
33142 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
33143 "although we think is to do with partition alignment."
33147 #: ../tools/virt-resize.pl:1450
33150 " guestfish -i -a newdisk\n"
33151 " ><fs> cat /boot/grub/device.map\n"
33152 " # check the contents of this file are sensible or\n"
33153 " # edit the file if necessary\n"
33154 " ><fs> grub-install / /dev/vda\n"
33160 #: ../tools/virt-resize.pl:1457
33162 "For more flexible guest reconfiguration, including if you need to specify "
33163 "other parameters to grub-install, use L<virt-rescue(1)>."
33167 #: ../tools/virt-resize.pl:1460
33168 msgid "ALTERNATIVE TOOLS"
33172 #: ../tools/virt-resize.pl:1462
33174 "There are several proprietary tools for resizing partitions. We won't "
33175 "mention any here."
33179 #: ../tools/virt-resize.pl:1465
33181 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
33182 "operations on disk images. They can resize and move partitions, but I don't "
33183 "think they can do anything with the contents, and they certainly don't "
33188 #: ../tools/virt-resize.pl:1470
33190 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
33191 "but at a much lower level. You will probably end up hand-calculating sector "
33192 "offsets, which is something that virt-resize was designed to avoid. If you "
33193 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
33198 #: ../tools/virt-resize.pl:1485
33200 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
33201 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
33202 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
33203 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
33204 "libguestfs.org/>."
33208 #: ../tools/virt-list-filesystems.pl:32
33210 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33214 #: ../tools/virt-list-filesystems.pl:36
33217 " virt-list-filesystems [--options] domname\n"
33222 #: ../tools/virt-list-filesystems.pl:38
33225 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33230 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33232 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33237 #: ../tools/virt-list-filesystems.pl:45
33239 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33240 "are contained in a virtual machine or disk image."
33244 #: ../tools/virt-list-filesystems.pl:49
33246 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33247 "functionality. For more complex cases you should look at the L<guestfish(1)"
33252 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33253 msgid "B<-l> | B<--long>"
33257 #: ../tools/virt-list-filesystems.pl:108
33259 "With this option, C<virt-list-filesystems> displays the type of each "
33260 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33264 #: ../tools/virt-list-filesystems.pl:115
33265 msgid "B<-a> | B<--all>"
33269 #: ../tools/virt-list-filesystems.pl:117
33271 "Normally we only show mountable filesystems. If this option is given then "
33272 "swap devices are shown too."
33276 #: ../tools/virt-list-filesystems.pl:191
33278 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33279 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33280 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33284 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
33285 msgid "Copyright (C) 2009 Red Hat Inc."
33289 #: ../tools/virt-tar.pl:33
33290 msgid "virt-tar - Extract or upload files to a virtual machine"
33294 #: ../tools/virt-tar.pl:37
33297 " virt-tar [--options] -x domname directory tarball\n"
33302 #: ../tools/virt-tar.pl:39
33305 " virt-tar [--options] -u domname tarball directory\n"
33310 #: ../tools/virt-tar.pl:41
33313 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33318 #: ../tools/virt-tar.pl:43
33321 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33326 #: ../tools/virt-tar.pl:47
33327 msgid "Download C</home> from the VM into a local tarball:"
33331 #: ../tools/virt-tar.pl:49
33334 " virt-tar -x domname /home home.tar\n"
33339 #: ../tools/virt-tar.pl:51
33342 " virt-tar -zx domname /home home.tar.gz\n"
33347 #: ../tools/virt-tar.pl:53
33348 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33352 #: ../tools/virt-tar.pl:55
33355 " virt-tar -u domname uploadstuff.tar /tmp\n"
33360 #: ../tools/virt-tar.pl:57
33363 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
33368 #: ../tools/virt-tar.pl:61
33370 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
33371 "virtual machines. If you do this, you risk disk corruption in the VM. "
33372 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
33376 #: ../tools/virt-tar.pl:66
33378 "You can use C<-x> (extract) on live virtual machines, but you might get "
33379 "inconsistent results or errors if there is filesystem activity inside the "
33380 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
33381 "work, but the only way to guarantee consistent results is if the virtual "
33382 "machine is shut down."
33386 #: ../tools/virt-tar.pl:74
33388 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
33389 "parts of a guest filesystem. There are many possibilities: making backups, "
33390 "uploading data files, snooping on guest activity, fixing or customizing "
33395 #: ../tools/virt-tar.pl:79
33397 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
33398 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
33399 "should look at the L<guestfish(1)> tool."
33403 #: ../tools/virt-tar.pl:83
33405 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
33406 "its contents (recursively) from the virtual machine into a local tarball. "
33407 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
33408 "virtual machine. You cannot use these two options together."
33412 #: ../tools/virt-tar.pl:89
33414 "In addition, you may need to use the C<-z> (gZip) option to enable "
33415 "compression. When uploading, you have to specify C<-z> if the upload file "
33416 "is compressed because virt-tar won't detect this on its own."
33420 #: ../tools/virt-tar.pl:93
33422 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
33423 "example it cannot do PKZip files or bzip2 compression. If you want that "
33424 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
33425 "the L<libguestfs(3)> API)."
33429 #: ../tools/virt-tar.pl:151
33430 msgid "B<-x> | B<--extract> | B<--download>"
33434 #: ../tools/virt-tar.pl:153
33435 msgid "B<-u> | B<--upload>"
33439 #: ../tools/virt-tar.pl:155
33441 "Use C<-x> to extract (download) a directory from a virtual machine to a "
33446 #: ../tools/virt-tar.pl:158
33448 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
33449 "Please read the L</WARNING> section above before using this option."
33453 #: ../tools/virt-tar.pl:162
33454 msgid "You must specify exactly one of these options."
33458 #: ../tools/virt-tar.pl:168
33459 msgid "B<-z> | B<--gzip>"
33463 #: ../tools/virt-tar.pl:170
33464 msgid "Specify that the input or output tarball is gzip-compressed."
33468 #: ../tools/virt-tar.pl:283
33470 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
33471 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
33476 #: ../tools/virt-make-fs.pl:37
33477 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
33481 #: ../tools/virt-make-fs.pl:41
33484 " virt-make-fs [--options] input.tar output.img\n"
33489 #: ../tools/virt-make-fs.pl:43
33492 " virt-make-fs [--options] input.tar.gz output.img\n"
33497 #: ../tools/virt-make-fs.pl:45
33500 " virt-make-fs [--options] directory output.img\n"
33505 #: ../tools/virt-make-fs.pl:49
33507 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
33508 "archive or some files in a directory. It is similar to tools like L<mkisofs"
33509 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
33510 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
33511 "you want to attach these filesystems to existing virtual machines (eg. to "
33512 "import large amounts of read-only data to a VM)."
33516 #: ../tools/virt-make-fs.pl:57
33517 msgid "Basic usage is:"
33521 #: ../tools/virt-make-fs.pl:59
33524 " virt-make-fs input output\n"
33529 #: ../tools/virt-make-fs.pl:61
33531 "where C<input> is either a directory containing files that you want to add, "
33532 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
33533 "C<output> is a disk image. The input type is detected automatically. The "
33534 "output disk image defaults to a raw ext2 image unless you specify extra "
33535 "flags (see L</OPTIONS> below)."
33539 #: ../tools/virt-make-fs.pl:67
33540 msgid "EXTRA SPACE"
33544 #: ../tools/virt-make-fs.pl:69
33546 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
33547 "the files that it contains, but might have extra space. Depending on how "
33548 "you are going to use the output, you might think this extra space is wasted "
33549 "and want to minimize it, or you might want to leave space so that more files "
33550 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
33551 "but you can use the C<--size> flag to leave space in the filesystem if you "
33556 #: ../tools/virt-make-fs.pl:77
33558 "An alternative way to leave extra space but not make the output image any "
33559 "bigger is to use an alternative disk image format (instead of the default "
33560 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
33561 "image format (check your hypervisor supports this before using it). This "
33562 "allows you to choose a large C<--size> but the extra space won't actually be "
33563 "allocated in the image until you try to store something in it."
33567 #: ../tools/virt-make-fs.pl:85
33569 "Don't forget that you can also use local commands including L<resize2fs(8)> "
33570 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
33571 "to build another image from scratch."
33575 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
33576 #: ../tools/virt-make-fs.pl:142
33581 #: ../tools/virt-make-fs.pl:91
33584 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
33589 #: ../tools/virt-make-fs.pl:93
33590 msgid "FILESYSTEM TYPE"
33594 #: ../tools/virt-make-fs.pl:95
33596 "The default filesystem type is C<ext2>. Just about any filesystem type that "
33597 "libguestfs supports can be used (but I<not> read-only formats like "
33598 "ISO9660). Here are some of the more common choices:"
33602 #: ../tools/virt-make-fs.pl:101
33607 #: ../tools/virt-make-fs.pl:103
33609 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
33610 "you are not going to use the filesystem in a way that requires the journal, "
33611 "then this is just wasted overhead."
33615 #: ../tools/virt-make-fs.pl:107
33616 msgid "I<ntfs> or I<vfat>"
33620 #: ../tools/virt-make-fs.pl:109
33621 msgid "Useful if exporting data to a Windows guest."
33625 #: ../tools/virt-make-fs.pl:111
33627 "I<Note for vfat>: The tar archive or local directory must only contain files "
33628 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
33629 "program running within libguestfs is unable to change the ownership of non-"
33630 "root files, since vfat itself does not support this."
33634 #: ../tools/virt-make-fs.pl:116
33639 #: ../tools/virt-make-fs.pl:118
33641 "Lower overhead than C<ext2>, but certain limitations on filename length and "
33642 "total filesystem size."
33646 #: ../tools/virt-make-fs.pl:125
33649 " virt-make-fs --type=minix input minixfs.img\n"
33654 #: ../tools/virt-make-fs.pl:127
33655 msgid "TO PARTITION OR NOT TO PARTITION"
33659 #: ../tools/virt-make-fs.pl:129
33660 msgid "Optionally virt-make-fs can add a partition table to the output disk."
33664 #: ../tools/virt-make-fs.pl:131
33666 "Adding a partition can make the disk image more compatible with certain "
33667 "virtualized operating systems which don't expect to see a filesystem "
33668 "directly located on a block device (Linux doesn't care and will happily "
33669 "handle both types)."
33673 #: ../tools/virt-make-fs.pl:136
33675 "On the other hand, if you have a partition table then the output image is no "
33676 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
33677 "directly on a partitioned disk image. (However libguestfs tools such as "
33678 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
33682 #: ../tools/virt-make-fs.pl:144
33683 msgid "Add an MBR partition:"
33687 #: ../tools/virt-make-fs.pl:146
33690 " virt-make-fs --partition -- input disk.img\n"
33695 #: ../tools/virt-make-fs.pl:148
33697 "If the output disk image could be terabyte-sized or larger, it's better to "
33698 "use an EFI/GPT-compatible partition table:"
33702 #: ../tools/virt-make-fs.pl:151
33705 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
33710 #: ../tools/virt-make-fs.pl:179
33711 msgid "Enable debugging information."
33715 #: ../tools/virt-make-fs.pl:185
33716 msgid "B<--size=E<lt>NE<gt>>"
33720 #: ../tools/virt-make-fs.pl:187
33721 msgid "B<--size=+E<lt>NE<gt>>"
33725 #: ../tools/virt-make-fs.pl:189
33726 msgid "B<-s E<lt>NE<gt>>"
33730 #: ../tools/virt-make-fs.pl:191
33731 msgid "B<-s +E<lt>NE<gt>>"
33735 #: ../tools/virt-make-fs.pl:193
33737 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
33741 #: ../tools/virt-make-fs.pl:196
33743 "If this option is I<not> given, then the output image will be just large "
33744 "enough to contain all the files, with not much wasted space."
33748 #: ../tools/virt-make-fs.pl:199
33750 "To choose a fixed size output disk, specify an absolute number followed by b/"
33751 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33752 "Petabytes or Exabytes. This must be large enough to contain all the input "
33753 "files, else you will get an error."
33757 #: ../tools/virt-make-fs.pl:204
33759 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
33760 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33761 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
33762 "the input files, and (approximately) an extra 200 MB free space."
33766 #: ../tools/virt-make-fs.pl:210
33768 "Note that virt-make-fs estimates free space, and therefore will not produce "
33769 "filesystems containing precisely the free space requested. (It is much more "
33770 "expensive and time-consuming to produce a filesystem which has precisely the "
33771 "desired free space)."
33775 #: ../tools/virt-make-fs.pl:219
33776 msgid "B<--format=E<lt>fmtE<gt>>"
33780 #: ../tools/virt-make-fs.pl:221
33781 msgid "B<-F E<lt>fmtE<gt>>"
33785 #: ../tools/virt-make-fs.pl:223
33786 msgid "Choose the output disk image format."
33790 #: ../tools/virt-make-fs.pl:225
33791 msgid "The default is C<raw> (raw disk image)."
33795 #: ../tools/virt-make-fs.pl:227
33797 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
33798 "that would really make sense here is C<qcow2>."
33802 #: ../tools/virt-make-fs.pl:234
33803 msgid "B<--type=E<lt>fsE<gt>>"
33807 #: ../tools/virt-make-fs.pl:236
33808 msgid "B<-t E<lt>fsE<gt>>"
33812 #: ../tools/virt-make-fs.pl:238
33813 msgid "Choose the output filesystem type."
33817 #: ../tools/virt-make-fs.pl:240
33818 msgid "The default is C<ext2>."
33822 #: ../tools/virt-make-fs.pl:242
33824 "Any filesystem which is supported read-write by libguestfs can be used here."
33828 #: ../tools/virt-make-fs.pl:249
33829 msgid "B<--partition>"
33833 #: ../tools/virt-make-fs.pl:251
33834 msgid "B<--partition=E<lt>parttypeE<gt>>"
33838 #: ../tools/virt-make-fs.pl:253
33840 "If specified, this flag adds an MBR partition table to the output disk image."
33844 #: ../tools/virt-make-fs.pl:256
33846 "You can change the partition table type, eg. C<--partition=gpt> for large "
33851 #: ../tools/virt-make-fs.pl:259
33853 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
33854 "might consider the next parameter to be the partition type. For example:"
33858 #: ../tools/virt-make-fs.pl:263
33861 " virt-make-fs --partition input.tar ...\n"
33866 #: ../tools/virt-make-fs.pl:265
33868 "would cause virt-make-fs to think you wanted to use a partition type of "
33869 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
33870 "dash) between options and the input file argument:"
33874 #: ../tools/virt-make-fs.pl:269
33877 " virt-make-fs --partition -- input.tar ...\n"
33882 #: ../tools/virt-make-fs.pl:541
33884 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
33885 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
33886 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
33890 #: ../tools/virt-make-fs.pl:558
33893 " export LIBGUESTFS_DEBUG=1\n"
33894 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
33899 #: ../tools/virt-make-fs.pl:561
33901 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
33906 #: ../tools/virt-list-partitions.pl:32
33908 "virt-list-partitions - List partitions in a virtual machine or disk image"
33912 #: ../tools/virt-list-partitions.pl:36
33915 " virt-list-partitions [--options] domname\n"
33920 #: ../tools/virt-list-partitions.pl:38
33923 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
33928 #: ../tools/virt-list-partitions.pl:45
33930 "C<virt-list-partitions> is a command line tool to list the partitions that "
33931 "are contained in a virtual machine or disk image. It is mainly useful as a "
33932 "first step to using L<virt-resize(1)>."
33936 #: ../tools/virt-list-partitions.pl:50
33938 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
33939 "functionality. For more complex cases you should look at the L<guestfish(1)"
33944 #: ../tools/virt-list-partitions.pl:107
33945 msgid "B<-h> | B<--human-readable>"
33949 #: ../tools/virt-list-partitions.pl:109
33950 msgid "Show sizes in human-readable form (eg. \"1G\")."
33954 #: ../tools/virt-list-partitions.pl:117
33956 "With this option, C<virt-list-partitions> displays the type and size of each "
33957 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
33961 #: ../tools/virt-list-partitions.pl:124
33962 msgid "B<-t> | B<--total>"
33966 #: ../tools/virt-list-partitions.pl:126
33968 "Display the total size of each block device (as a separate row or rows)."
33972 #: ../tools/virt-list-partitions.pl:259
33974 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
33975 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
33976 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33980 #: ../tools/virt-list-partitions.pl:275
33981 msgid "Copyright (C) 2009-2010 Red Hat Inc."